@digitalbazaar/vc 1.0.0 → 3.0.0

package/README.md

@@ -48,7 +48,13 @@ the following:
 
 ## Install
 
-- Node.js 12+ required.
+- Browsers and Node.js 14+ are supported.
+
+To install from NPM:
+
+```
+npm install @digitalbazaar/vc
+```
 
 To install locally (for development):
 
@@ -106,7 +112,7 @@ const credential = {
   }
 };
 
-const signedVC = await vc.issue({credential, suite});
+const signedVC = await vc.issue({credential, suite, documentLoader});
 console.log(JSON.stringify(signedVC, null, 2));
 ```
 
@@ -227,7 +233,7 @@ const vp = await vc.signPresentation({
 const signedVC = await vc.issue({credential, suite, documentLoader});
 
 // or
-const result = await vc.verify({credential, suite, documentLoader});
+const result = await vc.verifyCredential({credential: signedVC, suite, documentLoader});
 
 ```
 
@@ -302,7 +308,7 @@ To verify a verifiable presentation:
 // challenge has been received from the requesting party - see 'challenge'
 // section below
 
-const result = await vc.verify({presentation, challenge, suite});
+const result = await vc.verify({presentation, challenge, suite, documentLoader});
 // {valid: true}
 ```
 
@@ -312,7 +318,7 @@ flag:
 
 ```js
 const result = await vc.verify({
-  presentation, suite, unsignedPresentation: true
+  presentation, suite, documentLoader, unsignedPresentation: true
 });
 // {valid: true}
 ```
@@ -345,7 +351,7 @@ Pre-requisites:
 To verify a verifiable credential:
 
 ```js
-const result = await vc.verifyCredential({credential, suite});
+const result = await vc.verifyCredential({credential, suite, documentLoader});
 // {valid: true}
 ```
 

package/lib/CredentialIssuancePurpose.js

@@ -1,16 +1,17 @@
 /*!
- * Copyright (c) 2019-2021 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
  */
-'use strict';
-const jsonld = require('jsonld');
-const {AssertionProofPurpose} = require('jsonld-signatures').purposes;
+import jsonld from 'jsonld';
+import jsigs from 'jsonld-signatures';
+
+const {purposes: {AssertionProofPurpose}} = jsigs;
 
 /**
  * Creates a proof purpose that will validate whether or not the verification
  * method in a proof was authorized by its declared controller for the
  * proof's purpose.
  */
-class CredentialIssuancePurpose extends AssertionProofPurpose {
+export class CredentialIssuancePurpose extends AssertionProofPurpose {
   /**
    * @param {object} options - The options to use.
    * @param {object} [options.controller] - The description of the controller,
@@ -77,5 +78,3 @@ class CredentialIssuancePurpose extends AssertionProofPurpose {
     }
   }
 }
-
-module.exports = CredentialIssuancePurpose;

package/lib/contexts/index.js

@@ -1,17 +1,23 @@
 /*!
- * Copyright (c) 2019-2021 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
  */
-'use strict';
+import {
+  contexts as credentialContexts
+} from 'credentials-context';
+import {
+  CONTEXT as vcExamplesV1Context,
+  CONTEXT_URL as vcExamplesV1ContextUrl
+} from './vc-examples-v1.js';
+import {
+  CONTEXT as odrlContext,
+  CONTEXT_URL as odrlContextUrl
+} from './odrl.js';
 
-const {contexts, constants: contextConstants} = require('credentials-context');
+export const contexts = {};
 
-const exportedContexts = module.exports = {
-  'https://www.w3.org/2018/credentials/examples/v1':
-    require('./vc-examples-v1'),
-  'https://www.w3.org/ns/odrl.jsonld': require('./odrl')
-};
+contexts[vcExamplesV1ContextUrl] = vcExamplesV1Context;
+contexts[odrlContextUrl] = odrlContext;
 
-for(const c in contextConstants) {
-  const contextUrl = contextConstants[c];
-  exportedContexts[contextUrl] = contexts.get(contextUrl);
+for(const [url, context] of credentialContexts.entries()) {
+  contexts[url] = context;
 }

package/lib/contexts/odrl.js

@@ -1,10 +1,10 @@
 /*!
- * Copyright (c) 2019-2021 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
  */
-'use strict';
 
+export const CONTEXT_URL = 'https://www.w3.org/ns/odrl.jsonld';
 /* eslint-disable quote-props, key-spacing, max-len */
-module.exports = {
+export const CONTEXT = {
   '@context': {
     'odrl':    'http://www.w3.org/ns/odrl/2/',
     'rdf':     'http://www.w3.org/1999/02/22-rdf-syntax-ns#',

package/lib/contexts/vc-examples-v1.js

@@ -1,9 +1,10 @@
 /*!
- * Copyright (c) 2019-2021 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
  */
 
+export const CONTEXT_URL = 'https://www.w3.org/2018/credentials/examples/v1';
 /* eslint-disable quote-props */
-module.exports = {
+export const CONTEXT = {
   '@context': [
     {
       '@version': 1.1
@@ -16,26 +17,44 @@ module.exports = {
 
       '3rdPartyCorrelation': 'ex:3rdPartyCorrelation',
       'AllVerifiers': 'ex:AllVerifiers',
+      'AlumniCredential': 'ex:AlumniCredential',
       'Archival': 'ex:Archival',
       'BachelorDegree': 'ex:BachelorDegree',
       'Child': 'ex:Child',
       'CLCredentialDefinition2019': 'ex:CLCredentialDefinition2019',
       'CLSignature2019': 'ex:CLSignature2019',
+      'DisputeCredential': 'ex:DisputeCredential',
       'IssuerPolicy': 'ex:IssuerPolicy',
       'HolderPolicy': 'ex:HolderPolicy',
       'Mother': 'ex:Mother',
+      'PrescriptionCredential': 'ex:PrescriptionCredential',
       'RelationshipCredential': 'ex:RelationshipCredential',
       'UniversityDegreeCredential': 'ex:UniversityDegreeCredential',
       'ZkpExampleSchema2018': 'ex:ZkpExampleSchema2018',
 
       'alumniOf': {'@id': 'schema:alumniOf', '@type': 'rdf:HTML'},
+      'attributes': 'ex:attributes',
       'child': {'@id': 'ex:child', '@type': '@id'},
+      'college': 'ex:college',
+      'currentStatus': 'ex:currentStatus',
       'degree': 'ex:degree',
+      'degreeSchool': 'ex:degreeSchool',
+      'degreeType': 'ex:degreeType',
+      'familyName': 'schema:familyName',
+      'givenName': 'schema:givenName',
+      'issuerData': 'ex:issuerData',
       'name': {'@id': 'schema:name', '@type': 'rdf:HTML'},
+      'nonRevocationProof': 'ex:nonRevocationProof',
       'parent': {'@id': 'ex:parent', '@type': '@id'},
+      'prescription': 'ex:prescription',
+      'primaryProof': 'ex:primaryProof',
       'referenceId': 'ex:referenceId',
       'documentPresence': 'ex:documentPresence',
       'evidenceDocument': 'ex:evidenceDocument',
+      'signature': 'ex:signature',
+      'signatureCorrectnessProof': 'ex:signatureCorrectnessProof',
+      'spouse': 'schema:spouse',
+      'statusReason': 'ex:statusReason',
       'subjectPresence': 'ex:subjectPresence',
       'verifier': {'@id': 'ex:verifier', '@type': '@id'},
     }

package/lib/documentLoader.js

@@ -1,12 +1,10 @@
 /*!
- * Copyright (c) 2019-2021 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
  */
-'use strict';
-
 // load locally embedded contexts
-const contexts = require('./contexts');
+import {contexts} from './contexts/index.js';
 
-module.exports = async function documentLoader(url) {
+export async function documentLoader(url) {
   const context = contexts[url];
   if(context !== undefined) {
     return {
@@ -16,4 +14,4 @@ module.exports = async function documentLoader(url) {
     };
   }
   throw new Error(`Document loader unable to load URL "${url}".`);
-};
+}