Verifiable Credentials Contexts for JavaScript
npm install @digitalbazaar/credentials-context


> A Verifiable Credentials Data Model
> contexts library for JavaScript
This project packages the contexts for the [Verifiable Credentials Data
Model][] specs for use with [Node.js][] and web apps.
- Background
- Security
- Install
- Usage
- API
- Status
- Developing
- Commercial Support
- License
See related specs:
- Verifiable Credentials Data Model
- VCDM v1.1
- VCDM v2.0
TBD
Requires [Node.js][] 18+
To install via [NPM][]:
```
npm install @digitalbazaar/credentials-context
`js`
import {contexts, metadata, named} from '@digitalbazaar/credentials-context';
// or
const {contexts, metadata, named} = require('@digitalbazaar/credentials-context');
The contexts [Map][] can be used to access individual contexts by id or loadmetadata
them into a JSON-LD document loader. The [Map][] contains
extra information about each context.
This package can be used with bundlers, such as [webpack][], in browser
applications.
The library exports the following properties:
- contexts: A [Map][] associating context URLs to context data.metadata
- : A [Map][] associating context URLs to context metadata.named
- : A [Map][] associating short package specific names to context
metadata.
Note that the metadata format is experimental and subject to change. The idnamed
field is expected to stay stable and can be used with the Map to get av2
context URL for a short name such as .
The context files are available in the published contexts/ directory. The
metadata has a URL for each context. Note that these files are semantically
equivalent to published spec contexts but the formatting may differ such that
strict file digests are not equivalent.
The following contexts are available as of mid-2024. They track the published
spec contexts.
- Verifiable Credentials v1.1 context
- URL: https://www.w3.org/2018/credentials/v1v1
- Short name: https://www.w3.org/ns/credentials/v2
- Status: stable
- Verifiable Credentials v2.0 context
- URL: v2
- Short name: https://www.w3.org/ns/credentials/undefined-terms/v2
- Status: under development
- Verifiable Credentials v2.0 undefined terms context
- URL: undefined-terms-v2
- Short name:
- Status: under development
Source is available at:
- https://github.com/digitalbazaar/credentials-context
WARNING: The .jsonld files in contexts/ are auto-generated by the npm
run build script each time the test suite is run.
DO NOT edit them directly since changes will be overwritten.
Make all context changes to lib/*.js`.
Commercial support for this library is available upon request from
Digital Bazaar: support@digitalbazaar.com
- Code: BSD 3-Clause © Digital Bazaar
- Contexts: W3C Software and Document License
- See the LICENSE file for details.
[Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map
[NPM]: https://www.npmjs.com/
[Node.js]: https://nodejs.org/
[Verifiable Credentials Data Model]: https://github.com/w3c/vc-data-model
[credentials-context]: https://github.com/digitalbazaar/credentials-context
[webpack]: https://webpack.js.org/