Package Exports

@digitalbazaar/webkms-context
@digitalbazaar/webkms-context/js/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@digitalbazaar/webkms-context) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

WebKMS Context Repository (webkms-context)

A WebKMS context library for JavaScript.

Background
Install
Usage
Commercial Support
License

Background

Install

Requires Node.js 12+

To install via NPM:

npm install webkms-context

Usage

const webkms = require('webkms-context');

webkms.CONTEXT_URL
// 'https://w3id.org/webkms/v1'

// Codec term map value for CBOR-LD
webkms.constants.CBORLD_CODEC_VALUE
// 0x19

// get context data for a specific context
webkms.CONTEXT
// full context object

This package can be used with bundlers, such as webpack, in browser applications.

API

The library exports the following properties:

CONTEXT_URL
CONTEXT
constants: A Object that maps constants to well-known context URLs. The main constant CONTEXT_URL may be updated from time to time to the latest context location.
contexts: A Map that maps URLs to full context data.
appContextMap: For use with cborld library.

Developing

WARNING: The .jsonld in contexts/ is auto-generated by the npm run build script, each time you run the test suite.

DO NOT edit it directly (or your changes will be quickly overwritten). Instead, make all context changes to js/context.js.

Commercial Support

Commercial support for this library is available upon request from Digital Bazaar: support@digitalbazaar.com

License

See the LICENSE file for details.

@digitalbazaar/webkms-context