Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

zcap-context

digitalbazaar283BSD-3-Clausedeprecated1.2.1

This package has been renamed to @digitalbazaar/zcap-context. Install using @digitalbazaar/zcap-context instead.

An Authorization Capability (zCap) JSON-LD context for JavaScript.

readme

Authorization Capabilities (zCap) Context Repository (zcap-context)

Build status Coverage status NPM Version

An Authorization Capability (zCap) JSON-LD context for JavaScript.

Table of Contents

Background

See also (related specs):

Install

Requires Node.js 12+

To install via NPM:

npm install zcap-context

Usage

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

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

// Codec term map value for CBOR-LD
zcap.constants.CBORLD_CODEC_VALUE
// 0x1A

// get context data for a specific context
zcap.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

  • BSD 3-Clause © Digital Bazaar
  • See the LICENSE file for details.

changelog

zcap-context ChangeLog

1.2.1 - 2021-04-27

Fix

  • Fix @id for expires.

1.2.0 - 2021-04-27

Added

  • Add definition for the expires term.

1.1.0 - 2021-04-21

Added

  • Add definition for the proof term.

1.0.0 - 2021-04-15

Initial version.