@digitalcredentials/dcc-context

DCC Context and Schema Repo (@digitalcredentials/dcc-context)

DCC core artifacts: contexts and schemas.

Table of Contents

• Background
• Install
• Usage
• Developing
• Commercial Support
• License

Background

An NPM module and JSON-LD source file for the DCC context:

https://w3id.org/dcc/v1

See also (related specs):

• https://github.com/digitalcredentials/docs

Install

Requires Node.js 12+

To install via NPM, add the following to your package.json dependencies:

"@digitalcredentials/dcc-context": "^1.0.0"

Usage

import dccCtx from '@digitalcredentials/dcc-context';
// or
const dccCtx = require('@digitalcredentials/dcc-context');
const {contexts, constants, appContextMap} = dccCtx;

dccCtx.CONTEXT_URL_V1
// 'https://w3id.org/dcc/v1'

// get context data for a specific context
dccCtx.CONTEXT_V1
// 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_V1 and CONTEXT_V1.
• appContextMap: For use with cborld library.

Developing

WARNING: The .json file in v1/ 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.

License

• MIT LICENSE.

Changelog

1.0.0 - 2022-01-19

Initial version (see Github commit history for details).