@digitalbazaar/data-integrity-context
v2.0.1
Published
A Data Integrity context library for JavaScript.
Downloads
1,509
Keywords
Readme
Data Integrity Context for JavaScript (@digitalbazaar/data-integrity-context)
A Data Integrity context library for JavaScript.
Table of Contents
Background
See also (related specs):
Install
Requires Node.js 18+
To install via NPM:
npm install @digitalbazaar/data-integrity-context
Usage
import dataIntegrity from '@digitalbazaar/data-integrity-context';
dataIntegrity.CONTEXT_URL
// 'https://w3id.org/security/data-integrity/v2'
// Codec term map value for CBOR-LD
dataIntegrity.constants.CBORLD_VALUE_V1
// 0x30
dataIntegrity.constants.CBORLD_VALUE
// 0x33
// get context data for a specific context
dataIntegrity.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 constantCONTEXT_URL
may be updated from time to time to the latest context location.contexts
: AMap
that maps URLs to full context data.appContextMap
: For use withcborld
library.DATA_INTEGRITY_CONTEXT_V1_URL
DATA_INTEGRITY_CONTEXT_V2_URL
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: [email protected]
License
- BSD 3-Clause © Digital Bazaar
- See the LICENSE file for details.