@veramo/credential-ld 6.0.1-next.5 → 6.0.1-next.52

package/build/types.d.ts

@@ -1,223 +1,3 @@
-import { CredentialPayload, IAgentContext, IDIDManager, IKey, IKeyManager, IPluginMethodMap, IResolver, PresentationPayload, UsingResolutionOptions, VerifiableCredential, VerifiablePresentation } from '@veramo/core-types';
-/**
- * The interface definition for a plugin that can issue and verify Verifiable Credentials and Presentations
- * 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 may change without a BREAKING CHANGE notice.
- */
-export interface ICredentialIssuerLD extends IPluginMethodMap {
-    /**
-     * Creates a Verifiable Presentation.
-     * The payload, signer and format are chosen based on the `args` parameter.
-     *
-     * @param args - Arguments necessary to create the Presentation.
-     * @param context - This reserved param is automatically added and handled by the framework, *do not override*
-     *
-     * @returns - a promise that resolves to the {@link @veramo/core-types#VerifiablePresentation} that was requested or
-     *   rejects with an error if there was a problem with the input or while getting the key to sign
-     *
-     * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#presentations | Verifiable Presentation data model
-     *   }
-     *
-     * @beta This API may change without a BREAKING CHANGE notice.
-     */
-    createVerifiablePresentationLD(args: ICreateVerifiablePresentationLDArgs, context: IRequiredContext): Promise<VerifiablePresentation>;
-    /**
-     * Creates a Verifiable Credential.
-     * The payload, signer and format are chosen based on the `args` parameter.
-     *
-     * @param args - Arguments necessary to create the Presentation.
-     * @param context - This reserved param is automatically added and handled by the framework, *do not override*
-     *
-     * @returns - a promise that resolves to the {@link @veramo/core-types#VerifiableCredential} that was requested or
-     *   rejects with an error if there was a problem with the input or while getting the key to sign
-     *
-     * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#credentials | Verifiable Credential data model}
-     *
-     * @beta This API may change without a BREAKING CHANGE notice.
-     */
-    createVerifiableCredentialLD(args: ICreateVerifiableCredentialLDArgs, context: IRequiredContext): Promise<VerifiableCredential>;
-    /**
-     * Verifies a Verifiable Credential JWT or LDS Format.
-     *
-     * @param args - Arguments necessary to verify a VerifiableCredential
-     * @param context - This reserved param is automatically added and handled by the framework, *do not override*
-     *
-     * @returns - a promise that resolves to the boolean true on successful verification or rejects on error
-     *
-     * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#credentials | Verifiable Credential data model}
-     *
-     * @beta This API may change without a BREAKING CHANGE notice.
-     */
-    verifyCredentialLD(args: IVerifyCredentialLDArgs, context: IRequiredContext): Promise<boolean>;
-    /**
-     * Verifies a Verifiable Presentation JWT or LDS Format.
-     *
-     * @param args - Arguments necessary to verify a VerifiableCredential
-     * @param context - This reserved param is automatically added and handled by the framework, *do not override*
-     *
-     * @returns - a promise that resolves to the boolean true on successful verification or rejects on error
-     *
-     * @remarks Please see {@link https://www.w3.org/TR/vc-data-model/#presentations | Verifiable Credential data model}
-     *
-     * @beta This API may change without a BREAKING CHANGE notice.
-     */
-    verifyPresentationLD(args: IVerifyPresentationLDArgs, context: IRequiredContext): Promise<boolean>;
-    /**
-     * Returns true if the key is supported by any of the installed LD Signature suites
-     * @param key - the key to verify
-     * @param context - This reserved param is automatically added and handled by the framework, *do not override*
-     *
-     * @internal
-     */
-    matchKeyForLDSuite(key: IKey, context: IAgentContext<{}>): Promise<boolean>;
-}
-/**
- * Encapsulates the parameters required to create a
- * {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Verifiable Presentation}
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export interface ICreateVerifiablePresentationLDArgs extends UsingResolutionOptions {
-    /**
-     * The json payload of the Presentation according to the
-     * {@link https://www.w3.org/TR/vc-data-model/#presentations | canonical model}.
-     *
-     * 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.
-     */
-    presentation: PresentationPayload;
-    /**
-     * Optional (only JWT) string challenge parameter to add to the verifiable presentation.
-     */
-    challenge?: string;
-    /**
-     * Optional string domain parameter to add to the verifiable presentation.
-     */
-    domain?: string;
-    /**
-     * Optional. The key handle ({@link @veramo/core-types#IKey.kid | IKey.kid}) from the internal database.
-     */
-    keyRef?: string;
-    /**
-     * Set this to true if you want the `@context` URLs to be fetched in case they are not preloaded.
-     *
-     * Defaults to `false`
-     */
-    fetchRemoteContexts?: boolean;
-    /**
-     * Any other options that can be forwarded to the lower level libraries
-     */
-    [x: string]: any;
-}
-/**
- * Encapsulates the parameters required to create a
- * {@link https://www.w3.org/TR/vc-data-model/#credentials | W3C Verifiable Credential}
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export interface ICreateVerifiableCredentialLDArgs extends UsingResolutionOptions {
-    /**
-     * The json payload of the Credential according to the
-     * {@link https://www.w3.org/TR/vc-data-model/#credentials | canonical model}
-     *
-     * 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
-     */
-    credential: CredentialPayload;
-    /**
-     * Optional. The key handle ({@link @veramo/core-types#IKey.kid | IKey.kid}) from the internal database.
-     */
-    keyRef?: string;
-    /**
-     * Set this to true if you want the `@context` URLs to be fetched in case they are not preloaded.
-     *
-     * Defaults to `false`
-     */
-    fetchRemoteContexts?: boolean;
-    /**
-     * Any other options that can be forwarded to the lower level libraries
-     */
-    [x: string]: any;
-}
-/**
- * Encapsulates the parameters required to verify a
- * {@link https://www.w3.org/TR/vc-data-model/#credentials | W3C Verifiable Credential}
- *
- * @beta This API may change without a BREAKING CHANGE notice
- */
-export interface IVerifyCredentialLDArgs extends UsingResolutionOptions {
-    /**
-     * The json payload of the Credential according to the
-     * {@link https://www.w3.org/TR/vc-data-model/#credentials | canonical model}
-     *
-     * The signer of the Credential is chosen based on the `issuer.id` property
-     * of the `credential`
-     *
-     */
-    credential: VerifiableCredential;
-    /**
-     * Set this to true if you want the `@context` URLs to be fetched in case they are not preloaded.
-     *
-     * Defaults to `false`
-     */
-    fetchRemoteContexts?: boolean;
-    /**
-     * Any other options that can be forwarded to the lower level libraries
-     */
-    [x: string]: any;
-}
-/**
- * Encapsulates the parameters required to verify a
- * {@link https://www.w3.org/TR/vc-data-model/#presentations | W3C Verifiable Presentation}
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export interface IVerifyPresentationLDArgs extends UsingResolutionOptions {
-    /**
-     * The json payload of the Credential according to the
-     * {@link https://www.w3.org/TR/vc-data-model/#credentials | canonical model}
-     *
-     * The signer of the Credential is chosen based on the `issuer.id` property
-     * of the `credential`
-     *
-     */
-    presentation: VerifiablePresentation;
-    /**
-     * Optional (only for JWT) string challenge parameter to verify the verifiable presentation against
-     */
-    challenge?: string;
-    /**
-     * Optional (only for JWT) string domain parameter to verify the verifiable presentation against
-     */
-    domain?: string;
-    /**
-     * Set this to true if you want the `@context` URLs to be fetched in case they are not preloaded.
-     *
-     * Defaults to `false`
-     */
-    fetchRemoteContexts?: boolean;
-    /**
-     * Any other options that can be forwarded to the lower level libraries
-     */
-    [x: string]: any;
-}
-/**
- * Represents the requirements that this plugin has.
- * The agent that is using this plugin is expected to provide these methods.
- *
- * This interface can be used for static type checks, to make sure your application is properly initialized.
- *
- * @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.
  *

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,EACX,IAAI,EACJ,WAAW,EACX,gBAAgB,EAChB,SAAS,EACT,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,oBAAoB,CAAA;AAE3B;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;;;;;;;;;;;;;OAcG;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;IAElG;;;;;;OAMG;IACH,kBAAkB,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC5E;AAED;;;;;GAKG;AACH,MAAM,WAAW,mCAAoC,SAAQ,sBAAsB;IACjF;;;;;;;;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;IAEf;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,iCAAkC,SAAQ,sBAAsB;IAC/E;;;;;;;;OAQG;IACH,UAAU,EAAE,iBAAiB,CAAA;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACrE;;;;;;;OAOG;IACH,UAAU,EAAE,oBAAoB,CAAA;IAEhC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAA0B,SAAQ,sBAAsB;IACvE;;;;;;;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;IAE7B;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,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,MAAM,MAAM,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;;;;GAIG;AACH,MAAM,MAAM,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": "6.0.1-next.5+034afc430",
+  "version": "6.0.1-next.52+94da414f0",
   "main": "build/index.js",
   "exports": {
     ".": "./build/index.js"
@@ -9,12 +9,7 @@
   "types": "build/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "generate-plugin-schema": "node ../cli/bin/veramo.js dev generate-plugin-schema"
-  },
-  "veramo": {
-    "pluginInterfaces": {
-      "ICredentialIssuerLD": "./src/action-handler.ts"
-    }
+    "extract-api": "node ../cli/bin/veramo.js dev extract-api"
   },
   "dependencies": {
     "@digitalcredentials/ed25519-signature-2020": "^4.0.0",
@@ -26,20 +21,21 @@
     "@transmute/ed25519-signature-2018": "^0.7.0-unstable.81",
     "@transmute/json-web-signature": "^0.7.0-unstable.81",
     "@veramo-community/lds-ecdsa-secp256k1-recovery2020": "uport-project/EcdsaSecp256k1RecoverySignature2020",
-    "@veramo/core-types": "^6.0.1-next.5+034afc430",
-    "@veramo/utils": "^6.0.1-next.5+034afc430",
+    "@veramo/core-types": "^6.0.1-next.52+94da414f0",
+    "@veramo/credential-w3c": "^6.0.1-next.52+94da414f0",
+    "@veramo/utils": "^6.0.1-next.52+94da414f0",
     "cross-fetch": "^4.0.0",
     "debug": "^4.3.3",
     "did-resolver": "^4.1.0"
   },
   "resolutions": {
-    "@types/react": "18.2.20",
+    "@types/react": "19.0.8",
     "jsonld": "npm:@digitalcredentials/jsonld@^6.0.0"
   },
   "devDependencies": {
     "@types/debug": "4.1.8",
     "borc": "3.0.0",
-    "typescript": "5.3.3"
+    "typescript": "5.7.3"
   },
   "files": [
     "build/**/*",
@@ -81,5 +77,5 @@
     "node_modules",
     "src"
   ],
-  "gitHead": "034afc430225aef98ecdf93214b75d049ebcb9d7"
+  "gitHead": "94da414f0b1a9fe7b837faf01749191176826af1"
 }

package/src/{action-handler.ts → CredentialProviderLD.ts}

@@ -2,15 +2,23 @@ import {
   CredentialPayload,
   IAgentContext,
   IAgentPlugin,
+  ICanIssueCredentialTypeArgs,
+  ICreateVerifiableCredentialArgs,
+  ICreateVerifiablePresentationArgs,
   IIdentifier,
   IKey,
   IResolver,
+  IssuerAgentContext,
+  IVerifyCredentialArgs,
+  IVerifyPresentationArgs,
+  IVerifyResult,
   PresentationPayload,
   VerifiableCredential,
   VerifiablePresentation,
+  VerifierAgentContext,
+  ICanVerifyDocumentTypeArgs,
 } from '@veramo/core-types'
 import { VeramoLdSignature } from './index.js'
-import { schema } from './plugin.schema.js'
 import Debug from 'debug'
 import { LdContextLoader } from './ld-context-loader.js'
 import {
@@ -30,25 +38,19 @@ import { LdCredentialModule } from './ld-credential-module.js'
 import { LdSuiteLoader } from './ld-suite-loader.js'
 import {
   ContextDoc,
-  ICreateVerifiableCredentialLDArgs,
-  ICreateVerifiablePresentationLDArgs,
-  ICredentialIssuerLD,
-  IRequiredContext,
-  IVerifyCredentialLDArgs,
-  IVerifyPresentationLDArgs,
 } from './types.js'
 import { DIDResolutionOptions } from 'did-resolver'
 
+import { AbstractCredentialProvider } from '@veramo/credential-w3c'
+
 const debug = Debug('veramo:credential-ld:action-handler')
 
 /**
- * A Veramo plugin that implements the {@link ICredentialIssuerLD} methods.
+ * A handler that implements the {@link AbstractCredentialProvider} methods.
  *
  * @public
  */
-export class CredentialIssuerLD implements IAgentPlugin {
-  readonly methods: ICredentialIssuerLD
-  readonly schema = schema.ICredentialIssuerLD
+export class CredentialProviderLD implements AbstractCredentialProvider {
 
   private ldCredentialModule: LdCredentialModule
 
@@ -57,20 +59,40 @@ export class CredentialIssuerLD implements IAgentPlugin {
       ldContextLoader: new LdContextLoader({ contextsPaths: options.contextMaps }),
       ldSuiteLoader: new LdSuiteLoader({ veramoLdSignatures: options.suites }),
     })
+  }
+
+  /** {@inheritdoc @veramo/credential-w3c#AbstractCredentialProvider.matchKeyForType} */
+  matchKeyForType(key: IKey): boolean {
+    return this.matchKeyForLDSuite(key)
+  }
+
+  /** {@inheritdoc @veramo/credential-w3c#AbstractCredentialProvider.getTypeProofFormat} */
+  getTypeProofFormat(): string {
+    return 'lds'
+  }
+
+  /** {@inheritdoc @veramo/credential-w3c#AbstractCredentialProvider.canIssueCredentialType} */
+  canIssueCredentialType(args: ICanIssueCredentialTypeArgs): boolean {
+    return (args.proofFormat === 'lds')
+  }
 
-    this.methods = {
-      createVerifiablePresentationLD: this.createVerifiablePresentationLD.bind(this),
-      createVerifiableCredentialLD: this.createVerifiableCredentialLD.bind(this),
-      verifyCredentialLD: this.verifyCredentialLD.bind(this),
-      verifyPresentationLD: this.verifyPresentationLD.bind(this),
-      matchKeyForLDSuite: this.matchKeyForLDSuite.bind(this),
+  /** {@inheritdoc @veramo/credential-w3c#AbstractCredentialProvider.canVerifyDocumentType */
+  canVerifyDocumentType(args: ICanVerifyDocumentTypeArgs): boolean {
+    const { document } = args
+
+    for (const suite of this.ldCredentialModule.ldSuiteLoader.getAllSignatureSuites()) {
+      if (suite.getSupportedProofType() === (<VerifiableCredential>document)?.proof?.type || '') {
+        return true
+      }
     }
+
+    return false
   }
 
-  /** {@inheritdoc ICredentialIssuerLD.createVerifiablePresentationLD} */
-  public async createVerifiablePresentationLD(
-    args: ICreateVerifiablePresentationLDArgs,
-    context: IRequiredContext,
+  /** {@inheritdoc ICredentialIssuer.createVerifiablePresentationLD} */
+  async createVerifiablePresentation(
+    args: ICreateVerifiablePresentationArgs,
+    context: IssuerAgentContext,
   ): Promise<VerifiablePresentation> {
     const presentationContext = processEntryToArray(
       args?.presentation?.['@context'],
@@ -139,10 +161,10 @@ export class CredentialIssuerLD implements IAgentPlugin {
     }
   }
 
-  /** {@inheritdoc ICredentialIssuerLD.createVerifiableCredentialLD} */
-  public async createVerifiableCredentialLD(
-    args: ICreateVerifiableCredentialLDArgs,
-    context: IRequiredContext,
+  /** {@inheritdoc ICredentialIssuer.createVerifiableCredentialLD} */
+  async createVerifiableCredential(
+    args: ICreateVerifiableCredentialArgs,
+    context: IssuerAgentContext,
   ): Promise<VerifiableCredential> {
     const credentialContext = processEntryToArray(
       args?.credential?.['@context'],
@@ -193,27 +215,26 @@ export class CredentialIssuerLD implements IAgentPlugin {
     }
   }
 
-  /** {@inheritdoc ICredentialIssuerLD.verifyCredentialLD} */
-  public async verifyCredentialLD(
-    args: IVerifyCredentialLDArgs,
-    context: IRequiredContext,
-  ): Promise<boolean> {
+  /** {@inheritdoc ICredentialIssuer.verifyCredentialLD} */
+  async verifyCredential(args: IVerifyCredentialArgs, context: VerifierAgentContext): Promise<IVerifyResult> {
+    args.credential = args.credential as VerifiableCredential
     const credential = args.credential
 
-    let { now } = args
-    if (typeof now === 'number') {
-      now = new Date(now * 1000)
+    let now = new Date()
+
+    if (args.policies?.now && typeof args.policies?.now === 'number') {
+      now = new Date(args.policies?.now * 1000)
     }
 
     return this.ldCredentialModule.verifyCredential(credential, { ...args, now }, context)
   }
 
-  /** {@inheritdoc ICredentialIssuerLD.verifyPresentationLD} */
-  public async verifyPresentationLD(
-    args: IVerifyPresentationLDArgs,
-    context: IRequiredContext,
-  ): Promise<boolean> {
-    const presentation = args.presentation
+  /** {@inheritdoc ICredentialVerifier.verifyPresentation} */
+  async verifyPresentation(
+    args: IVerifyPresentationArgs,
+    context: VerifierAgentContext,
+  ): Promise<IVerifyResult> {
+    const presentation = args.presentation as VerifiablePresentation
     let { now } = args
     if (typeof now === 'number') {
       now = new Date(now * 1000)
@@ -271,7 +292,7 @@ export class CredentialIssuerLD implements IAgentPlugin {
    *
    * @internal
    */
-  async matchKeyForLDSuite(k: IKey): Promise<boolean> {
+  matchKeyForLDSuite(k: IKey): boolean {
     // prefilter based on key algorithms
     switch (k.type) {
       case 'Ed25519':