node-jsonld v1.0.0

node-jsonld

NodeJS interface with JSON-LD library. Run compact, expand, flatten algorithms, etc., by reading from and writing to local files. Verbose error messages and help messages are built in. Uses jsonld.js as a peer dependency and requires Node 8 or higher.

Installation

You will need to install node-jsonld and three peer dependencies: jsonld (the main library), inversify and reflect-metadata (these latter two support the Inversion-of-Control-friendly code of node-jsonld). If programming in Typescript, it's also advisable to install the types for jsonld as a dev dependency.

npm install jsonld inversify reflect-metadata node-jsonld
npm install types/jsonld --save-dev

IMPORTANT: You need Python 2.x (2.7 recommended) in order to build jsonld. jsonld has the node-gyp library as a dependency. Building the node-gyp library requires Python 2.x; it does not work with Python 3.x. You do not need to know any Python to use this tool; the language is invisible after the build process.

Usage

JSON-LD Operations

You can either use the NodeJS require function, or ES6 import syntax, as follows.

import { nodeJsonLd } from 'node-jsonld';

const sourceFile = 'NameOfSourceFile.json';
const contextFile = 'NameOfContextFile.json';
const targetFile = 'NameOfTargetFile.json';

nodejsonLd.compact(sourceFile, contextFile, targetFile).then(res => console.log(res)); 

// res is 'successful' if the compact operation was successful
//     is an error message otherwise

If not specified, the default name for the target file is targetFile.json. Advanced users can specify options for the JSON-LD operations. If not specified, simple default options are used.

Help messages

Help messages are available for all operations. The messages closely follow the documentation of jsonld.js. You can use a getter to grab each help message as a string, and then display it however you wish, such as in a tooltip.

import { nodeJsonLd } from 'node-jsonld';

const compactHelpMessage = nodeJsonLd.getCompactHelpMessage(); // returns a string

Related

See also the JSON-LD NodeJS command line tool jldc, which uses related code. Both node-jsonld and jldc have as a peer dependency the official JSON-LD Javascript library jsonld.js, written and supported by DigitalBazaar. For Angular users, ngx-jsonld-provider is available, and Cory Rylan has written ngx-json-ld, which uses an Angular component (not a provider) to connect to JSON-LD operations.

API

JSON-LD Operations

All these operations are of type Promise<string>. If successful, they return the string 'successful'. If unsuccessful, they return an error code that usually specifies both the type of error and the file that caused the error. If not specified, the default name for the target file is targetFile.json.

Compact

compact(sourceFile: string, contextFile: string, targetFile?: string, options?: CompactOptions): Promise<string>

Runs the JSON-LD compact algorithm on the contents of sourceFile, using the context in contextFile, and writes the value to targetFile. Default value for options is {}.

Expand

expand(sourceFile: string, targetFile?: string, options?: ExpandOptions): Promise<string>

Run the JSON-LD expand algorithm on the contents of sourceFile. Write the result to targetFile. Default value for options is {}.

Flatten

flatten(sourceFile: string, targetFile?: string, options?: FlattenOptions): Promise<string>

Run the JSON-LD flatten algorithm on the contents of sourceFile. Write the result to targetFile. Default value for options is {}.

Frame

frame(sourceFile: string, frameFile: string, targetFile?: string, options?: FrameOptions): Promise<string>

Run the JSON-LD frame algorithm on the contents of sourceFile, using the frame in frameFile, then write the result to targetFile. Default value for options is {}.

Normalize

normalize(sourceFile: string, targetFile?: string, options?: NormalizeOptions): Promise<string>

Run the JSON-LD normalize algorithm (also called the canonize algorithm) on the contents of sourceFile. Default value for options is {format: 'application/n-quads'}.

Serialize

serialize(sourceFile: string, targetFile:?: string, options?: ToRdfOptions): Promise<string>

Converts the JSON-LD in sourceFile to an RDF string. Default value for options is {format: 'application/n-quads'}.

Help Message Getters

The following help message getters are available. Each returns a string that is based on the jsonld.js documentation.

getCompactHelpMessage(): string 
getDeserializeHelpMessage(): string
getExpandHelpMessage(): string 
getFlattenHelpMessage(): string 
getFrameHelpMessage(): string 
getNormalizeHelpMessage(): string 
getSerializeHelpMessage(): string