@veramo/credential-ld 3.1.5-next.121 → 3.1.5-next.125

package/build/index.d.ts

@@ -1,7 +1,13 @@
 /**
- * Provides a {@link @veramo/credential-ld#CredentialIssuerLD | plugin} for the {@link @veramo/core#Agent} that implements
+ * Provides a {@link @veramo/credential-ld#CredentialIssuerLD | plugin} for the {@link @veramo/core#Agent} that
+ * implements
  * {@link @veramo/credential-ld#ICredentialIssuerLD} interface.
  *
+ * This plugin adds support for working with JSON-LD credentials.
+ * When installed, this plugin will be automatically used by
+ * {@link @veramo/credential-w3c#CredentialIssuer | CredentialIssuer} if the user requests the credential to be signed
+ * by one of the installed signature suites.
+ *
  * @packageDocumentation
  */
 export { CredentialIssuerLD } from './action-handler';
@@ -10,6 +16,12 @@ export { LdDefaultContexts } from './ld-default-contexts';
 export { VeramoLdSignature } from './ld-suites';
 export * from './suites/EcdsaSecp256k1RecoverySignature2020';
 export * from './suites/Ed25519Signature2018';
+/**
+ * The parameter and return types schemas for the {@link @veramo/credential-ld#CredentialIssuerLD | CredentialIssuerLD}
+ * plugin methods.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
 declare const schema: any;
 export { schema };
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrD,cAAc,SAAS,CAAA;AACvB,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,cAAc,8CAA8C,CAAA;AAC5D,cAAc,+BAA+B,CAAA;AAC7C,QAAA,MAAM,MAAM,KAAmC,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrD,cAAc,SAAS,CAAA;AACvB,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,cAAc,8CAA8C,CAAA;AAC5D,cAAc,+BAA+B,CAAA;AAE7C;;;;;GAKG;AACH,QAAA,MAAM,MAAM,KAAmC,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,CAAA"}

package/build/index.js

@@ -16,9 +16,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.schema = exports.VeramoLdSignature = exports.LdDefaultContexts = exports.CredentialIssuerLD = void 0;
 /**
- * Provides a {@link @veramo/credential-ld#CredentialIssuerLD | plugin} for the {@link @veramo/core#Agent} that implements
+ * Provides a {@link @veramo/credential-ld#CredentialIssuerLD | plugin} for the {@link @veramo/core#Agent} that
+ * implements
  * {@link @veramo/credential-ld#ICredentialIssuerLD} interface.
  *
+ * This plugin adds support for working with JSON-LD credentials.
+ * When installed, this plugin will be automatically used by
+ * {@link @veramo/credential-w3c#CredentialIssuer | CredentialIssuer} if the user requests the credential to be signed
+ * by one of the installed signature suites.
+ *
  * @packageDocumentation
  */
 var action_handler_1 = require("./action-handler");
@@ -30,6 +36,12 @@ var ld_suites_1 = require("./ld-suites");
 Object.defineProperty(exports, "VeramoLdSignature", { enumerable: true, get: function () { return ld_suites_1.VeramoLdSignature; } });
 __exportStar(require("./suites/EcdsaSecp256k1RecoverySignature2020"), exports);
 __exportStar(require("./suites/Ed25519Signature2018"), exports);
+/**
+ * The parameter and return types schemas for the {@link @veramo/credential-ld#CredentialIssuerLD | CredentialIssuerLD}
+ * plugin methods.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
 const schema = require('../plugin.schema.json');
 exports.schema = schema;
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA;;;;;GAKG;AACH,mDAAqD;AAA5C,oHAAA,kBAAkB,OAAA;AAC3B,0CAAuB;AACvB,6DAAyD;AAAhD,wHAAA,iBAAiB,OAAA;AAC1B,yCAA+C;AAAtC,8GAAA,iBAAiB,OAAA;AAC1B,+EAA4D;AAC5D,gEAA6C;AAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAA;AACtC,wBAAM"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;GAWG;AACH,mDAAqD;AAA5C,oHAAA,kBAAkB,OAAA;AAC3B,0CAAuB;AACvB,6DAAyD;AAAhD,wHAAA,iBAAiB,OAAA;AAC1B,yCAA+C;AAAtC,8GAAA,iBAAiB,OAAA;AAC1B,+EAA4D;AAC5D,gEAA6C;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAA;AACtC,wBAAM"}

package/build/ld-default-contexts.d.ts

@@ -1,6 +1,11 @@
 import { ContextDoc } from './types';
 /**
- * Provides a hardcoded map of common context definitions
+ * Provides a hardcoded map of common Linked Data `@context` definitions.
+ *
+ * You can use this to bootstrap the `@context` definitions used by
+ * {@link @veramo/credential-ld#CredentialIssuerLD | CredentialIssuerLD} with these common context definitions.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export declare const LdDefaultContexts: Map<string, Promise<ContextDoc>>;
 //# sourceMappingURL=ld-default-contexts.d.ts.map

package/build/ld-default-contexts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ld-default-contexts.d.ts","sourceRoot":"","sources":["../src/ld-default-contexts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAMpC;;GAEG;AACH,eAAO,MAAM,iBAAiB,kCAkB5B,CAAA"}
+{"version":3,"file":"ld-default-contexts.d.ts","sourceRoot":"","sources":["../src/ld-default-contexts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAMpC;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,kCAkB5B,CAAA"}

package/build/ld-default-contexts.js

@@ -39,7 +39,12 @@ function _read(_path) {
     });
 }
 /**
- * Provides a hardcoded map of common context definitions
+ * Provides a hardcoded map of common Linked Data `@context` definitions.
+ *
+ * You can use this to bootstrap the `@context` definitions used by
+ * {@link @veramo/credential-ld#CredentialIssuerLD | CredentialIssuerLD} with these common context definitions.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 exports.LdDefaultContexts = new Map([
     ['https://www.w3.org/2018/credentials/v1', _read('www.w3.org_2018_credentials_v1.json')],

package/build/ld-default-contexts.js.map

@@ -1 +1 @@
-{"version":3,"file":"ld-default-contexts.js","sourceRoot":"","sources":["../src/ld-default-contexts.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,SAAe,KAAK,CAAC,KAAa;;QAChC,OAAO,wDAAa,aAAa,GAAG,KAAK,GAAC,CAAC;IAC7C,CAAC;CAAA;AAED;;GAEG;AACU,QAAA,iBAAiB,GAAG,IAAI,GAAG,CAAC;IACvC,CAAC,wCAAwC,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACxF,CAAC,8BAA8B,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACpE,CAAC,8BAA8B,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACpE,CAAC,8BAA8B,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACpE,CAAC,uCAAuC,EAAE,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACtF,CAAC,kDAAkD,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;IAC5G,CAAC,iDAAiD,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAC1G,2DAA2D;IAC3D,+EAA+E;IAC/E,+DAA+D;IAC/D,CAAC,uCAAuC,EAAE,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACtF,kEAAkE;IAClE,CAAC,6GAA6G,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;IACnK,CAAC,6GAA6G,EAAE,KAAK,CAAC,yDAAyD,CAAC,CAAC;IACjL,CAAC,4DAA4D,EAAE,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAChI,iGAAiG;IACjG,gGAAgG;CACjG,CAAC,CAAA"}
+{"version":3,"file":"ld-default-contexts.js","sourceRoot":"","sources":["../src/ld-default-contexts.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,SAAe,KAAK,CAAC,KAAa;;QAChC,OAAO,wDAAa,aAAa,GAAG,KAAK,GAAC,CAAC;IAC7C,CAAC;CAAA;AAED;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG,IAAI,GAAG,CAAC;IACvC,CAAC,wCAAwC,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACxF,CAAC,8BAA8B,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACpE,CAAC,8BAA8B,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACpE,CAAC,8BAA8B,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IACpE,CAAC,uCAAuC,EAAE,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACtF,CAAC,kDAAkD,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;IAC5G,CAAC,iDAAiD,EAAE,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAC1G,2DAA2D;IAC3D,+EAA+E;IAC/E,+DAA+D;IAC/D,CAAC,uCAAuC,EAAE,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACtF,kEAAkE;IAClE,CAAC,6GAA6G,EAAE,KAAK,CAAC,2CAA2C,CAAC,CAAC;IACnK,CAAC,6GAA6G,EAAE,KAAK,CAAC,yDAAyD,CAAC,CAAC;IACjL,CAAC,4DAA4D,EAAE,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAChI,iGAAiG;IACjG,gGAAgG;CACjG,CAAC,CAAA"}

package/build/ld-suites.d.ts

@@ -1,6 +1,11 @@
 import { CredentialPayload, IAgentContext, IKey, IKeyManager, IResolver, PresentationPayload, TKeyType } from '@veramo/core';
-import { DIDDocument } from 'did-resolver/src/resolver';
+import { DIDDocument } from 'did-resolver';
 export declare type RequiredAgentMethods = IResolver & Pick<IKeyManager, 'keyManagerGet' | 'keyManagerSign'>;
+/**
+ * Base class for Veramo adapters of LinkedDataSignature suites.
+ *
+ * @alpha This API is experimental and is very likely to change or disappear in future releases without notice.
+ */
 export declare abstract class VeramoLdSignature {
     abstract getSupportedVerificationType(): string;
     abstract getSupportedVeramoKeyType(): TKeyType;

package/build/ld-suites.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ld-suites.d.ts","sourceRoot":"","sources":["../src/ld-suites.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,IAAI,EACJ,WAAW,EACX,SAAS,EACT,mBAAmB,EACnB,QAAQ,EACT,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAA;AAEvD,oBAAY,oBAAoB,GAAG,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,eAAe,GAAG,gBAAgB,CAAC,CAAA;AAEpG,8BAAsB,iBAAiB;IAMrC,QAAQ,CAAC,4BAA4B,IAAI,MAAM;IAE/C,QAAQ,CAAC,yBAAyB,IAAI,QAAQ;IAE9C,QAAQ,CAAC,kBAAkB,CACzB,GAAG,EAAE,IAAI,EACT,SAAS,EAAE,MAAM,EACjB,oBAAoB,EAAE,MAAM,EAC5B,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAC3C,GAAG;IAEN,QAAQ,CAAC,uBAAuB,IAAI,GAAG;IAEvC,QAAQ,CAAC,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,IAAI;IAEhF,QAAQ,CAAC,0BAA0B,CAAC,UAAU,EAAE,iBAAiB,GAAG,IAAI;IAExE,0BAA0B,CAAC,YAAY,EAAE,mBAAmB,GAAG,IAAI;CAQpE"}
+{"version":3,"file":"ld-suites.d.ts","sourceRoot":"","sources":["../src/ld-suites.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,IAAI,EACJ,WAAW,EACX,SAAS,EACT,mBAAmB,EACnB,QAAQ,EACT,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C,oBAAY,oBAAoB,GAAG,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,eAAe,GAAG,gBAAgB,CAAC,CAAA;AAEpG;;;;GAIG;AACH,8BAAsB,iBAAiB;IAMrC,QAAQ,CAAC,4BAA4B,IAAI,MAAM;IAE/C,QAAQ,CAAC,yBAAyB,IAAI,QAAQ;IAE9C,QAAQ,CAAC,kBAAkB,CACzB,GAAG,EAAE,IAAI,EACT,SAAS,EAAE,MAAM,EACjB,oBAAoB,EAAE,MAAM,EAC5B,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAC3C,GAAG;IAEN,QAAQ,CAAC,uBAAuB,IAAI,GAAG;IAEvC,QAAQ,CAAC,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,IAAI;IAEhF,QAAQ,CAAC,0BAA0B,CAAC,UAAU,EAAE,iBAAiB,GAAG,IAAI;IAExE,0BAA0B,CAAC,YAAY,EAAE,mBAAmB,GAAG,IAAI;CAQpE"}

package/build/ld-suites.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VeramoLdSignature = void 0;
+/**
+ * Base class for Veramo adapters of LinkedDataSignature suites.
+ *
+ * @alpha This API is experimental and is very likely to change or disappear in future releases without notice.
+ */
 class VeramoLdSignature {
     preSigningPresModification(presentation) {
         var _a;

package/build/ld-suites.js.map

@@ -1 +1 @@
-{"version":3,"file":"ld-suites.js","sourceRoot":"","sources":["../src/ld-suites.ts"],"names":[],"mappings":";;;AAaA,MAAsB,iBAAiB;IAuBrC,0BAA0B,CAAC,YAAiC;;QAC1D,mGAAmG;QACnG,gEAAgE;QAChE,MAAM,qBAAqB,GAAG,YAAmB,CAAA;QACjD,IAAI,CAAA,MAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,QAAQ,0CAAE,MAAM,KAAI,CAAC,EAAE;YAChD,OAAO,qBAAqB,CAAC,QAAQ,CAAA;SACtC;IACH,CAAC;CACF;AA/BD,8CA+BC"}
+{"version":3,"file":"ld-suites.js","sourceRoot":"","sources":["../src/ld-suites.ts"],"names":[],"mappings":";;;AAaA;;;;GAIG;AACH,MAAsB,iBAAiB;IAuBrC,0BAA0B,CAAC,YAAiC;;QAC1D,mGAAmG;QACnG,gEAAgE;QAChE,MAAM,qBAAqB,GAAG,YAAmB,CAAA;QACjD,IAAI,CAAA,MAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,QAAQ,0CAAE,MAAM,KAAI,CAAC,EAAE;YAChD,OAAO,qBAAqB,CAAC,QAAQ,CAAA;SACtC;IACH,CAAC;CACF;AA/BD,8CA+BC"}

package/build/suites/EcdsaSecp256k1RecoverySignature2020.d.ts

@@ -1,5 +1,10 @@
 import { RequiredAgentMethods, VeramoLdSignature } from '../ld-suites';
 import { CredentialPayload, DIDDocument, IAgentContext, IKey, TKeyType } from '@veramo/core';
+/**
+ * Veramo wrapper for the EcdsaSecp256k1RecoverySignature2020 suite by Transmute Industries
+ *
+ * @alpha This API is experimental and is very likely to change or disappear in future releases without notice.
+ */
 export declare class VeramoEcdsaSecp256k1RecoverySignature2020 extends VeramoLdSignature {
     getSupportedVerificationType(): string;
     getSupportedVeramoKeyType(): TKeyType;

package/build/suites/EcdsaSecp256k1RecoverySignature2020.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EcdsaSecp256k1RecoverySignature2020.d.ts","sourceRoot":"","sources":["../../src/suites/EcdsaSecp256k1RecoverySignature2020.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACtE,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAS5F,qBAAa,yCAA0C,SAAQ,iBAAiB;IAC9E,4BAA4B,IAAI,MAAM;IAItC,yBAAyB,IAAI,QAAQ;IAIrC,kBAAkB,CAChB,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,MAAM,EACX,kBAAkB,EAAE,MAAM,EAC1B,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAC3C,GAAG;IAyCN,uBAAuB,IAAI,GAAG;IAI9B,0BAA0B,CAAC,UAAU,EAAE,iBAAiB,GAAG,IAAI;IAG/D,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,IAAI;IAmBvE,UAAU,IAAI,MAAM;CAGrB"}
+{"version":3,"file":"EcdsaSecp256k1RecoverySignature2020.d.ts","sourceRoot":"","sources":["../../src/suites/EcdsaSecp256k1RecoverySignature2020.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACtE,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAS5F;;;;GAIG;AACH,qBAAa,yCAA0C,SAAQ,iBAAiB;IAC9E,4BAA4B,IAAI,MAAM;IAItC,yBAAyB,IAAI,QAAQ;IAIrC,kBAAkB,CAChB,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,MAAM,EACX,kBAAkB,EAAE,MAAM,EAC1B,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAC3C,GAAG;IAyCN,uBAAuB,IAAI,GAAG;IAI9B,0BAA0B,CAAC,UAAU,EAAE,iBAAiB,GAAG,IAAI;IAG/D,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,IAAI;IAmBvE,UAAU,IAAI,MAAM;CAGrB"}

package/build/suites/EcdsaSecp256k1RecoverySignature2020.js

@@ -37,6 +37,11 @@ const ld_suites_1 = require("../ld-suites");
 const lds_ecdsa_secp256k1_recovery2020_1 = require("@transmute/lds-ecdsa-secp256k1-recovery2020");
 const u8a = __importStar(require("uint8arrays"));
 const utils_1 = require("@veramo/utils");
+/**
+ * Veramo wrapper for the EcdsaSecp256k1RecoverySignature2020 suite by Transmute Industries
+ *
+ * @alpha This API is experimental and is very likely to change or disappear in future releases without notice.
+ */
 class VeramoEcdsaSecp256k1RecoverySignature2020 extends ld_suites_1.VeramoLdSignature {
     getSupportedVerificationType() {
         return 'EcdsaSecp256k1RecoveryMethod2020';

package/build/suites/EcdsaSecp256k1RecoverySignature2020.js.map

@@ -1 +1 @@
-{"version":3,"file":"EcdsaSecp256k1RecoverySignature2020.js","sourceRoot":"","sources":["../../src/suites/EcdsaSecp256k1RecoverySignature2020.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAsE;AAEtE,kGAGoD;AAEpD,iDAAkC;AAClC,yCAAuD;AAEvD,MAAa,yCAA0C,SAAQ,6BAAiB;IAC9E,4BAA4B;QAC1B,OAAO,kCAAkC,CAAA;IAC3C,CAAC;IAED,yBAAyB;QACvB,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,kBAAkB,CAChB,GAAS,EACT,GAAW,EACX,kBAA0B,EAC1B,OAA4C;QAE5C,MAAM,UAAU,GAAG,GAAG,CAAA;QACtB,MAAM,MAAM,GAAG;YACb,wBAAwB;YACxB,IAAI,EAAE,CAAO,IAA0B,EAAmB,EAAE;gBAC1D,MAAM,MAAM,GAAG;oBACb,GAAG,EAAE,UAAU;oBACf,GAAG,EAAE,KAAK;oBACV,IAAI,EAAE,CAAC,KAAK,CAAC;iBACd,CAAA;gBACD,MAAM,YAAY,GAAG,IAAA,sBAAc,EAAC,MAAM,CAAC,CAAA;gBAC3C,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,YAAY,GAAG,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;gBAC1F,MAAM,aAAa,GAAG,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;gBAC3D,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC;oBACnD,MAAM,EAAE,GAAG,CAAC,GAAG;oBACf,SAAS,EAAE,UAAU;oBACrB,IAAI,EAAE,aAAa;oBACnB,QAAQ,EAAE,QAAQ;iBACnB,CAAC,CAAA;gBACF,OAAO,GAAG,YAAY,KAAK,SAAS,EAAE,CAAA;YACxC,CAAC,CAAA;SACF,CAAA;QAED,MAAM,KAAK,GAAG,IAAI,sEAAmC,CAAC;YACpD,UAAU;YACV,GAAG,EAAE,IAAI,mEAAgC,CAAC;gBACxC,YAAY,EAAE,GAAG,CAAC,YAAY;gBAC9B,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM;gBACpB,IAAI,EAAE,IAAI,CAAC,4BAA4B,EAAE;gBACzC,UAAU;gBACV,EAAE,EAAE,kBAAkB;aACvB,CAAC;SACH,CAAC,CAAA;QAEF,KAAK,CAAC,kBAAkB,GAAG,CAAC,EAAE,QAAQ,EAA+C,EAAE,EAAE;YACvF,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,IAAA,eAAO,EAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QACpF,CAAC,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED,uBAAuB;QACrB,OAAO,IAAI,sEAAmC,EAAE,CAAA;IAClD,CAAC;IAED,0BAA0B,CAAC,UAA6B;IACxD,CAAC;IAED,4BAA4B,CAAC,MAAc,EAAE,MAAmB;;QAClE,cAAc;QACV,MAAM,GAAG,GAAG,CAAA,MAAA,MAAM,CAAC,UAAU,CAAC,0CAAE,OAAO,CAAC,6GAA6G,CAAC,KAAI,CAAC,CAAC,CAAA;QAC5J,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE;YACnD,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,CAAA;SAC5C;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC/C,oFAAoF;YACpF,MAAA,MAAM,CAAC,kBAAkB,0CAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBACvC,IAAI,CAAC,CAAC,mBAAmB,EAAE;oBACzB,IAAI,CAAC,CAAC,mBAAmB,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE;wBACxD,MAAM,CAAE,OAAO,EAAE,KAAK,CAAE,GAAG,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;wBAClE,CAAC,CAAC,mBAAmB,GAAG,UAAU,KAAK,IAAI,OAAO,EAAE,CAAA;qBACrD;iBACF;YACH,CAAC,CAAC,CAAA;SACH;IACH,CAAC;IACD,UAAU;QACR,OAAO,4DAA4D,CAAA;IACrE,CAAC;CACF;AApFD,8FAoFC"}
+{"version":3,"file":"EcdsaSecp256k1RecoverySignature2020.js","sourceRoot":"","sources":["../../src/suites/EcdsaSecp256k1RecoverySignature2020.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAsE;AAEtE,kGAGoD;AAEpD,iDAAkC;AAClC,yCAAuD;AAEvD;;;;GAIG;AACH,MAAa,yCAA0C,SAAQ,6BAAiB;IAC9E,4BAA4B;QAC1B,OAAO,kCAAkC,CAAA;IAC3C,CAAC;IAED,yBAAyB;QACvB,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,kBAAkB,CAChB,GAAS,EACT,GAAW,EACX,kBAA0B,EAC1B,OAA4C;QAE5C,MAAM,UAAU,GAAG,GAAG,CAAA;QACtB,MAAM,MAAM,GAAG;YACb,wBAAwB;YACxB,IAAI,EAAE,CAAO,IAA0B,EAAmB,EAAE;gBAC1D,MAAM,MAAM,GAAG;oBACb,GAAG,EAAE,UAAU;oBACf,GAAG,EAAE,KAAK;oBACV,IAAI,EAAE,CAAC,KAAK,CAAC;iBACd,CAAA;gBACD,MAAM,YAAY,GAAG,IAAA,sBAAc,EAAC,MAAM,CAAC,CAAA;gBAC3C,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,YAAY,GAAG,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;gBAC1F,MAAM,aAAa,GAAG,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;gBAC3D,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC;oBACnD,MAAM,EAAE,GAAG,CAAC,GAAG;oBACf,SAAS,EAAE,UAAU;oBACrB,IAAI,EAAE,aAAa;oBACnB,QAAQ,EAAE,QAAQ;iBACnB,CAAC,CAAA;gBACF,OAAO,GAAG,YAAY,KAAK,SAAS,EAAE,CAAA;YACxC,CAAC,CAAA;SACF,CAAA;QAED,MAAM,KAAK,GAAG,IAAI,sEAAmC,CAAC;YACpD,UAAU;YACV,GAAG,EAAE,IAAI,mEAAgC,CAAC;gBACxC,YAAY,EAAE,GAAG,CAAC,YAAY;gBAC9B,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM;gBACpB,IAAI,EAAE,IAAI,CAAC,4BAA4B,EAAE;gBACzC,UAAU;gBACV,EAAE,EAAE,kBAAkB;aACvB,CAAC;SACH,CAAC,CAAA;QAEF,KAAK,CAAC,kBAAkB,GAAG,CAAC,EAAE,QAAQ,EAA+C,EAAE,EAAE;YACvF,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,IAAA,eAAO,EAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QACpF,CAAC,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED,uBAAuB;QACrB,OAAO,IAAI,sEAAmC,EAAE,CAAA;IAClD,CAAC;IAED,0BAA0B,CAAC,UAA6B;IACxD,CAAC;IAED,4BAA4B,CAAC,MAAc,EAAE,MAAmB;;QAClE,cAAc;QACV,MAAM,GAAG,GAAG,CAAA,MAAA,MAAM,CAAC,UAAU,CAAC,0CAAE,OAAO,CAAC,6GAA6G,CAAC,KAAI,CAAC,CAAC,CAAA;QAC5J,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE;YACnD,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,CAAA;SAC5C;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC/C,oFAAoF;YACpF,MAAA,MAAM,CAAC,kBAAkB,0CAAE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBACvC,IAAI,CAAC,CAAC,mBAAmB,EAAE;oBACzB,IAAI,CAAC,CAAC,mBAAmB,CAAC,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE;wBACxD,MAAM,CAAE,OAAO,EAAE,KAAK,CAAE,GAAG,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;wBAClE,CAAC,CAAC,mBAAmB,GAAG,UAAU,KAAK,IAAI,OAAO,EAAE,CAAA;qBACrD;iBACF;YACH,CAAC,CAAC,CAAA;SACH;IACH,CAAC;IACD,UAAU;QACR,OAAO,4DAA4D,CAAA;IACrE,CAAC;CACF;AApFD,8FAoFC"}

package/build/suites/Ed25519Signature2018.d.ts

@@ -1,5 +1,10 @@
 import { RequiredAgentMethods, VeramoLdSignature } from '../ld-suites';
 import { CredentialPayload, DIDDocument, IAgentContext, IKey, TKeyType } from '@veramo/core';
+/**
+ * Veramo wrapper for the Ed25519Signature2018 suite by Transmute Industries
+ *
+ * @alpha This API is experimental and is very likely to change or disappear in future releases without notice.
+ */
 export declare class VeramoEd25519Signature2018 extends VeramoLdSignature {
     getSupportedVerificationType(): string;
     getSupportedVeramoKeyType(): TKeyType;

package/build/suites/Ed25519Signature2018.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Ed25519Signature2018.d.ts","sourceRoot":"","sources":["../../src/suites/Ed25519Signature2018.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACtE,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAI5F,qBAAa,0BAA2B,SAAQ,iBAAiB;IAC/D,4BAA4B,IAAI,MAAM;IAItC,yBAAyB,IAAI,QAAQ;IAIrC,kBAAkB,CAChB,GAAG,EAAE,IAAI,EACT,SAAS,EAAE,MAAM,EACjB,oBAAoB,EAAE,MAAM,EAC5B,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAC3C,GAAG;IA2CN,uBAAuB,IAAI,GAAG;IAI9B,0BAA0B,CAAC,UAAU,EAAE,iBAAiB,GAAG,IAAI;IAI/D,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,IAAI;CAGxE"}
+{"version":3,"file":"Ed25519Signature2018.d.ts","sourceRoot":"","sources":["../../src/suites/Ed25519Signature2018.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACtE,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAI5F;;;;GAIG;AACH,qBAAa,0BAA2B,SAAQ,iBAAiB;IAC/D,4BAA4B,IAAI,MAAM;IAItC,yBAAyB,IAAI,QAAQ;IAIrC,kBAAkB,CAChB,GAAG,EAAE,IAAI,EACT,SAAS,EAAE,MAAM,EACjB,oBAAoB,EAAE,MAAM,EAC5B,OAAO,EAAE,aAAa,CAAC,oBAAoB,CAAC,GAC3C,GAAG;IA2CN,uBAAuB,IAAI,GAAG;IAI9B,0BAA0B,CAAC,UAAU,EAAE,iBAAiB,GAAG,IAAI;IAI/D,4BAA4B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,IAAI;CAGxE"}

package/build/suites/Ed25519Signature2018.js

@@ -37,6 +37,11 @@ const utils_1 = require("@veramo/utils");
 const ld_suites_1 = require("../ld-suites");
 const u8a = __importStar(require("uint8arrays"));
 const ed25519_signature_2018_1 = require("@transmute/ed25519-signature-2018");
+/**
+ * Veramo wrapper for the Ed25519Signature2018 suite by Transmute Industries
+ *
+ * @alpha This API is experimental and is very likely to change or disappear in future releases without notice.
+ */
 class VeramoEd25519Signature2018 extends ld_suites_1.VeramoLdSignature {
     getSupportedVerificationType() {
         return 'Ed25519VerificationKey2018';

package/build/suites/Ed25519Signature2018.js.map

@@ -1 +1 @@
-{"version":3,"file":"Ed25519Signature2018.js","sourceRoot":"","sources":["../../src/suites/Ed25519Signature2018.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA8C;AAC9C,4CAAsE;AAEtE,iDAAkC;AAClC,8EAAoG;AAEpG,MAAa,0BAA2B,SAAQ,6BAAiB;IAC/D,4BAA4B;QAC1B,OAAO,4BAA4B,CAAA;IACrC,CAAC;IAED,yBAAyB;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,kBAAkB,CAChB,GAAS,EACT,SAAiB,EACjB,oBAA4B,EAC5B,OAA4C;QAE5C,MAAM,UAAU,GAAG,SAAS,CAAA;QAE5B,aAAa;QACb,IAAI,EAAE,GAAG,oBAAoB,CAAA;QAE7B,MAAM,MAAM,GAAG;YACb,yBAAyB;YACzB,IAAI,EAAE,CAAO,IAA0B,EAAmB,EAAE;gBAC1D,MAAM,MAAM,GAAG;oBACb,GAAG,EAAE,OAAO;oBACZ,GAAG,EAAE,KAAK;oBACV,IAAI,EAAE,CAAC,KAAK,CAAC;iBACd,CAAA;gBACD,MAAM,YAAY,GAAG,IAAA,sBAAc,EAAC,MAAM,CAAC,CAAA;gBAC3C,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,YAAY,GAAG,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;gBAC1F,MAAM,aAAa,GAAG,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;gBAC3D,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC;oBACnD,MAAM,EAAE,GAAG,CAAC,GAAG;oBACf,SAAS,EAAE,OAAO;oBAClB,IAAI,EAAE,aAAa;oBACnB,QAAQ,EAAE,QAAQ;iBACnB,CAAC,CAAA;gBACF,OAAO,GAAG,YAAY,KAAK,SAAS,EAAE,CAAA;YACxC,CAAC,CAAA;SACF,CAAA;QAED,MAAM,eAAe,GAAG,IAAI,mDAA0B,CAAC;YACrD,EAAE;YACF,UAAU;YACV,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC;YACrD,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM;YACpB,IAAI,EAAE,IAAI,CAAC,4BAA4B,EAAE;SAC1C,CAAC,CAAA;QACF,2GAA2G;QAC3G,eAAe,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,MAAa,CAAA;QAE5C,OAAO,IAAI,6CAAoB,CAAC;YAC9B,GAAG,EAAE,eAAe;YACpB,MAAM,EAAE,MAAM;SACf,CAAC,CAAA;IACJ,CAAC;IAED,uBAAuB;QACrB,OAAO,IAAI,6CAAoB,EAAE,CAAA;IACnC,CAAC;IAED,0BAA0B,CAAC,UAA6B;QACtD,qBAAqB;IACvB,CAAC;IAED,4BAA4B,CAAC,MAAc,EAAE,MAAmB;QAC9D,qBAAqB;IACvB,CAAC;CACF;AApED,gEAoEC"}
+{"version":3,"file":"Ed25519Signature2018.js","sourceRoot":"","sources":["../../src/suites/Ed25519Signature2018.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA8C;AAC9C,4CAAsE;AAEtE,iDAAkC;AAClC,8EAAoG;AAEpG;;;;GAIG;AACH,MAAa,0BAA2B,SAAQ,6BAAiB;IAC/D,4BAA4B;QAC1B,OAAO,4BAA4B,CAAA;IACrC,CAAC;IAED,yBAAyB;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,kBAAkB,CAChB,GAAS,EACT,SAAiB,EACjB,oBAA4B,EAC5B,OAA4C;QAE5C,MAAM,UAAU,GAAG,SAAS,CAAA;QAE5B,aAAa;QACb,IAAI,EAAE,GAAG,oBAAoB,CAAA;QAE7B,MAAM,MAAM,GAAG;YACb,yBAAyB;YACzB,IAAI,EAAE,CAAO,IAA0B,EAAmB,EAAE;gBAC1D,MAAM,MAAM,GAAG;oBACb,GAAG,EAAE,OAAO;oBACZ,GAAG,EAAE,KAAK;oBACV,IAAI,EAAE,CAAC,KAAK,CAAC;iBACd,CAAA;gBACD,MAAM,YAAY,GAAG,IAAA,sBAAc,EAAC,MAAM,CAAC,CAAA;gBAC3C,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,YAAY,GAAG,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;gBAC1F,MAAM,aAAa,GAAG,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;gBAC3D,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC;oBACnD,MAAM,EAAE,GAAG,CAAC,GAAG;oBACf,SAAS,EAAE,OAAO;oBAClB,IAAI,EAAE,aAAa;oBACnB,QAAQ,EAAE,QAAQ;iBACnB,CAAC,CAAA;gBACF,OAAO,GAAG,YAAY,KAAK,SAAS,EAAE,CAAA;YACxC,CAAC,CAAA;SACF,CAAA;QAED,MAAM,eAAe,GAAG,IAAI,mDAA0B,CAAC;YACrD,EAAE;YACF,UAAU;YACV,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC;YACrD,MAAM,EAAE,GAAG,EAAE,CAAC,MAAM;YACpB,IAAI,EAAE,IAAI,CAAC,4BAA4B,EAAE;SAC1C,CAAC,CAAA;QACF,2GAA2G;QAC3G,eAAe,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,MAAa,CAAA;QAE5C,OAAO,IAAI,6CAAoB,CAAC;YAC9B,GAAG,EAAE,eAAe;YACpB,MAAM,EAAE,MAAM;SACf,CAAC,CAAA;IACJ,CAAC;IAED,uBAAuB;QACrB,OAAO,IAAI,6CAAoB,EAAE,CAAA;IACnC,CAAC;IAED,0BAA0B,CAAC,UAA6B;QACtD,qBAAqB;IACvB,CAAC;IAED,4BAA4B,CAAC,MAAc,EAAE,MAAmB;QAC9D,qBAAqB;IACvB,CAAC;CACF;AApED,gEAoEC"}

package/build/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.23.1"
+      "packageVersion": "7.24.2"
     }
   ]
 }

package/build/types.d.ts

@@ -1,11 +1,12 @@
 import { CredentialPayload, IAgentContext, IDIDManager, IKeyManager, IPluginMethodMap, IResolver, PresentationPayload, VerifiableCredential, VerifiablePresentation } from '@veramo/core';
 /**
  * The interface definition for a plugin that can issue and verify Verifiable Credentials and Presentations
- * that use JSON-LD format.
+ * that use JSON-LD format (also called Data Integrity Proofs).
  *
  * @remarks Please see {@link https://www.w3.org/TR/vc-data-model | W3C Verifiable Credentials data model}
+ * @see {@link https://www.w3.org/TR/vc-data-model/#data-integrity-proofs | Data Integrity proofs}
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export interface ICredentialIssuerLD extends IPluginMethodMap {
     /**
@@ -20,7 +21,7 @@ export interface ICredentialIssuerLD extends IPluginMethodMap {
      *
      * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#presentations | Verifiable Presentation data model }
      *
-     * @beta This API is likely to change without a BREAKING CHANGE notice
+     * @beta This API may change without a BREAKING CHANGE notice.
      */
     createVerifiablePresentationLD(args: ICreateVerifiablePresentationLDArgs, context: IRequiredContext): Promise<VerifiablePresentation>;
     /**
@@ -35,7 +36,7 @@ export interface ICredentialIssuerLD extends IPluginMethodMap {
      *
      * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#credentials | Verifiable Credential data model}
      *
-     * @beta This API is likely to change without a BREAKING CHANGE notice
+     * @beta This API may change without a BREAKING CHANGE notice.
      */
     createVerifiableCredentialLD(args: ICreateVerifiableCredentialLDArgs, context: IRequiredContext): Promise<VerifiableCredential>;
     /**
@@ -48,7 +49,7 @@ export interface ICredentialIssuerLD extends IPluginMethodMap {
      *
      * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#credentials | Verifiable Credential data model}
      *
-     * @beta This API is likely to change without a BREAKING CHANGE notice
+     * @beta This API may change without a BREAKING CHANGE notice.
      */
     verifyCredentialLD(args: IVerifyCredentialLDArgs, context: IRequiredContext): Promise<boolean>;
     /**
@@ -61,7 +62,7 @@ export interface ICredentialIssuerLD extends IPluginMethodMap {
      *
      * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#presentations | Verifiable Credential data model}
      *
-     * @beta This API is likely to change without a BREAKING CHANGE notice
+     * @beta This API may change without a BREAKING CHANGE notice.
      */
     verifyPresentationLD(args: IVerifyPresentationLDArgs, context: IRequiredContext): Promise<boolean>;
 }
@@ -69,7 +70,7 @@ export interface ICredentialIssuerLD extends IPluginMethodMap {
  * Encapsulates the parameters required to create a
  * {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Verifiable Presentation}
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export interface ICreateVerifiablePresentationLDArgs {
     /**
@@ -79,7 +80,7 @@ export interface ICreateVerifiablePresentationLDArgs {
      * The signer of the Presentation is chosen based on the `holder` property
      * of the `presentation`
      *
-     * '@context', 'type' and 'issuanceDate' will be added automatically if omitted
+     * `@context`, `type` and `issuanceDate` will be added automatically if omitted.
      */
     presentation: PresentationPayload;
     /**
@@ -99,7 +100,7 @@ export interface ICreateVerifiablePresentationLDArgs {
  * Encapsulates the parameters required to create a
  * {@link https://www.w3.org/TR/vc-data-model/#credentials | W3C Verifiable Credential}
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export interface ICreateVerifiableCredentialLDArgs {
     /**
@@ -109,7 +110,7 @@ export interface ICreateVerifiableCredentialLDArgs {
      * The signer of the Credential is chosen based on the `issuer.id` property
      * of the `credential`
      *
-     * '@context', 'type' and 'issuanceDate' will be added automatically if omitted
+     * `@context`, `type` and `issuanceDate` will be added automatically if omitted
      */
     credential: CredentialPayload;
     /**
@@ -121,7 +122,7 @@ export interface ICreateVerifiableCredentialLDArgs {
  * Encapsulates the parameters required to verify a
  * {@link https://www.w3.org/TR/vc-data-model/#credentials | W3C Verifiable Credential}
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice
  */
 export interface IVerifyCredentialLDArgs {
     /**
@@ -134,9 +135,9 @@ export interface IVerifyCredentialLDArgs {
      */
     credential: VerifiableCredential;
     /**
-     * Set this to true if you want the '@context' URLs to be fetched in case they are not pre-loaded.
+     * Set this to true if you want the `@context` URLs to be fetched in case they are not pre-loaded.
      *
-     * @default false
+     * Defaults to `false`
      */
     fetchRemoteContexts?: boolean;
 }
@@ -144,7 +145,7 @@ export interface IVerifyCredentialLDArgs {
  * Encapsulates the parameters required to verify a
  * {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Verifiable Presentation}
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export interface IVerifyPresentationLDArgs {
     /**
@@ -165,9 +166,9 @@ export interface IVerifyPresentationLDArgs {
      */
     domain?: string;
     /**
-     * Set this to true if you want the '@context' URLs to be fetched in case they are not pre-loaded.
+     * Set this to true if you want the `@context` URLs to be fetched in case they are not pre-loaded.
      *
-     * @default false
+     * Defaults to `false`
      */
     fetchRemoteContexts?: boolean;
 }
@@ -177,9 +178,14 @@ export interface IVerifyPresentationLDArgs {
  *
  * This interface can be used for static type checks, to make sure your application is properly initialized.
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export declare type IRequiredContext = IAgentContext<IResolver & Pick<IDIDManager, 'didManagerGet'> & Pick<IKeyManager, 'keyManagerGet' | 'keyManagerSign'>>;
+/**
+ * Describes a document with a `@context` property.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
 export declare type ContextDoc = {
     '@context': Record<string, any>;
 };

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,WAAW,EAEX,WAAW,EACX,gBAAgB,EAChB,SAAS,EACT,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,cAAc,CAAA;AAErB;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;;;;;;;;;;;;OAaG;IACH,8BAA8B,CAC5B,IAAI,EAAE,mCAAmC,EACzC,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;;;OAaG;IACH,4BAA4B,CAC1B,IAAI,EAAE,iCAAiC,EACvC,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE9F;;;;;;;;;;;OAWG;IACH,oBAAoB,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACnG;AAED;;;;;GAKG;AACH,MAAM,WAAW,mCAAmC;IAClD;;;;;;;;OAQG;IACH,YAAY,EAAE,mBAAmB,CAAA;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;;;;;;OAQG;IACH,UAAU,EAAE,iBAAiB,CAAA;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;;;;OAOG;IACH,UAAU,EAAE,oBAAoB,CAAA;IAEhC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;;;OAOG;IACH,YAAY,EAAE,sBAAsB,CAAA;IAEpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED;;;;;;;GAOG;AACH,oBAAY,gBAAgB,GAAG,aAAa,CAC1C,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,eAAe,GAAG,gBAAgB,CAAC,CACvG,CAAA;AAED,oBAAY,UAAU,GAAG;IACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAChC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,WAAW,EACX,WAAW,EACX,gBAAgB,EAChB,SAAS,EACT,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,cAAc,CAAA;AAErB;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;;;;;;;;;;;;OAaG;IACH,8BAA8B,CAC5B,IAAI,EAAE,mCAAmC,EACzC,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;;;OAaG;IACH,4BAA4B,CAC1B,IAAI,EAAE,iCAAiC,EACvC,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAE9F;;;;;;;;;;;OAWG;IACH,oBAAoB,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CACnG;AAED;;;;;GAKG;AACH,MAAM,WAAW,mCAAmC;IAClD;;;;;;;;OAQG;IACH,YAAY,EAAE,mBAAmB,CAAA;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;;;;;;OAQG;IACH,UAAU,EAAE,iBAAiB,CAAA;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;;;;OAOG;IACH,UAAU,EAAE,oBAAoB,CAAA;IAEhC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;;;OAOG;IACH,YAAY,EAAE,sBAAsB,CAAA;IAEpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED;;;;;;;GAOG;AACH,oBAAY,gBAAgB,GAAG,aAAa,CAC1C,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,eAAe,GAAG,gBAAgB,CAAC,CACvG,CAAA;AAED;;;;GAIG;AACH,oBAAY,UAAU,GAAG;IACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAChC,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@veramo/credential-ld",
   "description": "Veramo plugin for working with W3C JSON-LD Verifiable Credentials & Presentations.",
-  "version": "3.1.5-next.121+e3aedac7",
+  "version": "3.1.5-next.125+ea4966a6",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
@@ -20,9 +20,9 @@
     "@transmute/credentials-context": "^0.7.0-unstable.60",
     "@transmute/ed25519-signature-2018": "^0.7.0-unstable.60",
     "@transmute/lds-ecdsa-secp256k1-recovery2020": "decentralized-identity/EcdsaSecp256k1RecoverySignature2020",
-    "@veramo/core": "^3.1.5-next.121+e3aedac7",
-    "@veramo/did-resolver": "^3.1.5-next.121+e3aedac7",
-    "@veramo/utils": "^3.1.5-next.121+e3aedac7",
+    "@veramo/core": "^3.1.5-next.125+ea4966a6",
+    "@veramo/did-resolver": "^3.1.5-next.125+ea4966a6",
+    "@veramo/utils": "^3.1.5-next.125+ea4966a6",
     "debug": "^4.3.3",
     "did-resolver": "3.2.0",
     "uint8arrays": "^3.0.0"
@@ -30,7 +30,7 @@
   "devDependencies": {
     "@types/debug": "4.1.7",
     "borc": "3.0.0",
-    "typescript": "4.7.2"
+    "typescript": "4.7.3"
   },
   "files": [
     "build/**/*",
@@ -47,5 +47,5 @@
   "author": "Mircea Nistor <mircea.nistor@mesh.xyz>",
   "license": "Apache-2.0",
   "keywords": [],
-  "gitHead": "e3aedac77ce9c7fd981f1621881ab823894a5514"
+  "gitHead": "ea4966a6b79dc4653a2aff9147c096ee22bb47df"
 }

package/plugin.schema.json

@@ -7,7 +7,7 @@
           "properties": {
             "credential": {
               "$ref": "#/components/schemas/CredentialPayload",
-              "description": "The json payload of the Credential according to the\n {@link  https://www.w3.org/TR/vc-data-model/#credentials | canonical model } \n\nThe signer of the Credential is chosen based on the `issuer.id` property of the `credential`\n\n'@context', 'type' and 'issuanceDate' will be added automatically if omitted"
+              "description": "The json payload of the Credential according to the\n {@link  https://www.w3.org/TR/vc-data-model/#credentials | canonical model } \n\nThe signer of the Credential is chosen based on the `issuer.id` property of the `credential`\n\n`@context`, `type` and `issuanceDate` will be added automatically if omitted"
             },
             "keyRef": {
               "type": "string",
@@ -100,6 +100,10 @@
               "type": "string"
             }
           },
+          "required": [
+            "id",
+            "type"
+          ],
           "description": "Used for the discovery of information about the current status of a verifiable credential, such as whether it is suspended or revoked. The precise contents of the credential status information is determined by the specific `credentialStatus` type definition, and varies depending on factors such as whether it is simple to implement or if it is privacy-enhancing.\n\nSee  {@link  https://www.w3.org/TR/vc-data-model/#status | Credential Status }"
         },
         "VerifiableCredential": {
@@ -176,7 +180,7 @@
           "properties": {
             "presentation": {
               "$ref": "#/components/schemas/PresentationPayload",
-              "description": "The json payload of the Presentation according to the\n {@link  https://www.w3.org/TR/vc-data-model/#presentations | canonical model } .\n\nThe signer of the Presentation is chosen based on the `holder` property of the `presentation`\n\n'@context', 'type' and 'issuanceDate' will be added automatically if omitted"
+              "description": "The json payload of the Presentation according to the\n {@link  https://www.w3.org/TR/vc-data-model/#presentations | canonical model } .\n\nThe signer of the Presentation is chosen based on the `holder` property of the `presentation`\n\n`@context`, `type` and `issuanceDate` will be added automatically if omitted."
             },
             "challenge": {
               "type": "string",
@@ -329,8 +333,7 @@
             },
             "fetchRemoteContexts": {
               "type": "boolean",
-              "description": "Set this to true if you want the '@context' URLs to be fetched in case they are not pre-loaded.",
-              "default": false
+              "description": "Set this to true if you want the `@context` URLs to be fetched in case they are not pre-loaded.\n\nDefaults to `false`"
             }
           },
           "required": [
@@ -355,8 +358,7 @@
             },
             "fetchRemoteContexts": {
               "type": "boolean",
-              "description": "Set this to true if you want the '@context' URLs to be fetched in case they are not pre-loaded.",
-              "default": false
+              "description": "Set this to true if you want the `@context` URLs to be fetched in case they are not pre-loaded.\n\nDefaults to `false`"
             }
           },
           "required": [

package/src/index.ts

@@ -1,7 +1,13 @@
 /**
- * Provides a {@link @veramo/credential-ld#CredentialIssuerLD | plugin} for the {@link @veramo/core#Agent} that implements
+ * Provides a {@link @veramo/credential-ld#CredentialIssuerLD | plugin} for the {@link @veramo/core#Agent} that
+ * implements
  * {@link @veramo/credential-ld#ICredentialIssuerLD} interface.
  *
+ * This plugin adds support for working with JSON-LD credentials.
+ * When installed, this plugin will be automatically used by
+ * {@link @veramo/credential-w3c#CredentialIssuer | CredentialIssuer} if the user requests the credential to be signed
+ * by one of the installed signature suites.
+ *
  * @packageDocumentation
  */
 export { CredentialIssuerLD } from './action-handler'
@@ -10,5 +16,12 @@ export { LdDefaultContexts } from './ld-default-contexts'
 export { VeramoLdSignature } from './ld-suites'
 export * from './suites/EcdsaSecp256k1RecoverySignature2020'
 export * from './suites/Ed25519Signature2018'
+
+/**
+ * The parameter and return types schemas for the {@link @veramo/credential-ld#CredentialIssuerLD | CredentialIssuerLD}
+ * plugin methods.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
 const schema = require('../plugin.schema.json')
 export { schema }

package/src/ld-default-contexts.ts

@@ -5,7 +5,12 @@ async function _read(_path: string): Promise<ContextDoc> {
 }
 
 /**
- * Provides a hardcoded map of common context definitions
+ * Provides a hardcoded map of common Linked Data `@context` definitions.
+ *
+ * You can use this to bootstrap the `@context` definitions used by
+ * {@link @veramo/credential-ld#CredentialIssuerLD | CredentialIssuerLD} with these common context definitions.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export const LdDefaultContexts = new Map([
   ['https://www.w3.org/2018/credentials/v1', _read('www.w3.org_2018_credentials_v1.json')],

package/src/ld-suites.ts

@@ -7,10 +7,15 @@ import {
   PresentationPayload,
   TKeyType,
 } from '@veramo/core'
-import { DIDDocument } from 'did-resolver/src/resolver'
+import { DIDDocument } from 'did-resolver'
 
 export type RequiredAgentMethods = IResolver & Pick<IKeyManager, 'keyManagerGet' | 'keyManagerSign'>
 
+/**
+ * Base class for Veramo adapters of LinkedDataSignature suites.
+ *
+ * @alpha This API is experimental and is very likely to change or disappear in future releases without notice.
+ */
 export abstract class VeramoLdSignature {
   // LinkedDataSignature Suites according to
   // https://github.com/digitalbazaar/jsonld-signatures/blob/main/lib/suites/LinkedDataSignature.js

package/src/suites/EcdsaSecp256k1RecoverySignature2020.ts

@@ -8,6 +8,11 @@ import {
 import * as u8a from 'uint8arrays'
 import { asArray, encodeJoseBlob } from '@veramo/utils'
 
+/**
+ * Veramo wrapper for the EcdsaSecp256k1RecoverySignature2020 suite by Transmute Industries
+ *
+ * @alpha This API is experimental and is very likely to change or disappear in future releases without notice.
+ */
 export class VeramoEcdsaSecp256k1RecoverySignature2020 extends VeramoLdSignature {
   getSupportedVerificationType(): string {
     return 'EcdsaSecp256k1RecoveryMethod2020'

package/src/suites/Ed25519Signature2018.ts

@@ -4,6 +4,11 @@ import { CredentialPayload, DIDDocument, IAgentContext, IKey, TKeyType } from '@
 import * as u8a from 'uint8arrays'
 import { Ed25519Signature2018, Ed25519VerificationKey2018 } from '@transmute/ed25519-signature-2018'
 
+/**
+ * Veramo wrapper for the Ed25519Signature2018 suite by Transmute Industries
+ *
+ * @alpha This API is experimental and is very likely to change or disappear in future releases without notice.
+ */
 export class VeramoEd25519Signature2018 extends VeramoLdSignature {
   getSupportedVerificationType(): string {
     return 'Ed25519VerificationKey2018'

package/src/types.ts

@@ -2,7 +2,6 @@ import {
   CredentialPayload,
   IAgentContext,
   IDIDManager,
-  IKey,
   IKeyManager,
   IPluginMethodMap,
   IResolver,
@@ -13,11 +12,12 @@ import {
 
 /**
  * The interface definition for a plugin that can issue and verify Verifiable Credentials and Presentations
- * that use JSON-LD format.
+ * that use JSON-LD format (also called Data Integrity Proofs).
  *
  * @remarks Please see {@link https://www.w3.org/TR/vc-data-model | W3C Verifiable Credentials data model}
+ * @see {@link https://www.w3.org/TR/vc-data-model/#data-integrity-proofs | Data Integrity proofs}
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export interface ICredentialIssuerLD extends IPluginMethodMap {
   /**
@@ -32,7 +32,7 @@ export interface ICredentialIssuerLD extends IPluginMethodMap {
    *
    * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#presentations | Verifiable Presentation data model }
    *
-   * @beta This API is likely to change without a BREAKING CHANGE notice
+   * @beta This API may change without a BREAKING CHANGE notice.
    */
   createVerifiablePresentationLD(
     args: ICreateVerifiablePresentationLDArgs,
@@ -51,7 +51,7 @@ export interface ICredentialIssuerLD extends IPluginMethodMap {
    *
    * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#credentials | Verifiable Credential data model}
    *
-   * @beta This API is likely to change without a BREAKING CHANGE notice
+   * @beta This API may change without a BREAKING CHANGE notice.
    */
   createVerifiableCredentialLD(
     args: ICreateVerifiableCredentialLDArgs,
@@ -68,7 +68,7 @@ export interface ICredentialIssuerLD extends IPluginMethodMap {
    *
    * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#credentials | Verifiable Credential data model}
    *
-   * @beta This API is likely to change without a BREAKING CHANGE notice
+   * @beta This API may change without a BREAKING CHANGE notice.
    */
   verifyCredentialLD(args: IVerifyCredentialLDArgs, context: IRequiredContext): Promise<boolean>
 
@@ -82,7 +82,7 @@ export interface ICredentialIssuerLD extends IPluginMethodMap {
    *
    * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#presentations | Verifiable Credential data model}
    *
-   * @beta This API is likely to change without a BREAKING CHANGE notice
+   * @beta This API may change without a BREAKING CHANGE notice.
    */
   verifyPresentationLD(args: IVerifyPresentationLDArgs, context: IRequiredContext): Promise<boolean>
 }
@@ -91,7 +91,7 @@ export interface ICredentialIssuerLD extends IPluginMethodMap {
  * Encapsulates the parameters required to create a
  * {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Verifiable Presentation}
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export interface ICreateVerifiablePresentationLDArgs {
   /**
@@ -101,7 +101,7 @@ export interface ICreateVerifiablePresentationLDArgs {
    * The signer of the Presentation is chosen based on the `holder` property
    * of the `presentation`
    *
-   * '@context', 'type' and 'issuanceDate' will be added automatically if omitted
+   * `@context`, `type` and `issuanceDate` will be added automatically if omitted.
    */
   presentation: PresentationPayload
 
@@ -125,7 +125,7 @@ export interface ICreateVerifiablePresentationLDArgs {
  * Encapsulates the parameters required to create a
  * {@link https://www.w3.org/TR/vc-data-model/#credentials | W3C Verifiable Credential}
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export interface ICreateVerifiableCredentialLDArgs {
   /**
@@ -135,7 +135,7 @@ export interface ICreateVerifiableCredentialLDArgs {
    * The signer of the Credential is chosen based on the `issuer.id` property
    * of the `credential`
    *
-   * '@context', 'type' and 'issuanceDate' will be added automatically if omitted
+   * `@context`, `type` and `issuanceDate` will be added automatically if omitted
    */
   credential: CredentialPayload
 
@@ -149,7 +149,7 @@ export interface ICreateVerifiableCredentialLDArgs {
  * Encapsulates the parameters required to verify a
  * {@link https://www.w3.org/TR/vc-data-model/#credentials | W3C Verifiable Credential}
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice
  */
 export interface IVerifyCredentialLDArgs {
   /**
@@ -163,9 +163,9 @@ export interface IVerifyCredentialLDArgs {
   credential: VerifiableCredential
 
   /**
-   * Set this to true if you want the '@context' URLs to be fetched in case they are not pre-loaded.
+   * Set this to true if you want the `@context` URLs to be fetched in case they are not pre-loaded.
    *
-   * @default false
+   * Defaults to `false`
    */
   fetchRemoteContexts?: boolean
 }
@@ -174,7 +174,7 @@ export interface IVerifyCredentialLDArgs {
  * Encapsulates the parameters required to verify a
  * {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Verifiable Presentation}
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export interface IVerifyPresentationLDArgs {
   /**
@@ -198,9 +198,9 @@ export interface IVerifyPresentationLDArgs {
   domain?: string
 
   /**
-   * Set this to true if you want the '@context' URLs to be fetched in case they are not pre-loaded.
+   * Set this to true if you want the `@context` URLs to be fetched in case they are not pre-loaded.
    *
-   * @default false
+   * Defaults to `false`
    */
   fetchRemoteContexts?: boolean
 }
@@ -211,12 +211,17 @@ export interface IVerifyPresentationLDArgs {
  *
  * This interface can be used for static type checks, to make sure your application is properly initialized.
  *
- * @beta This API is likely to change without a BREAKING CHANGE notice
+ * @beta This API may change without a BREAKING CHANGE notice.
  */
 export type IRequiredContext = IAgentContext<
   IResolver & Pick<IDIDManager, 'didManagerGet'> & Pick<IKeyManager, 'keyManagerGet' | 'keyManagerSign'>
 >
 
+/**
+ * Describes a document with a `@context` property.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
 export type ContextDoc = {
   '@context': Record<string, any>
 }