@veramo/credential-ld 6.0.1-next.9 → 6.0.1

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

@@ -2,23 +2,15 @@ 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 {
@@ -38,19 +30,25 @@ 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 handler that implements the {@link AbstractCredentialProvider} methods.
+ * A Veramo plugin that implements the {@link ICredentialIssuerLD} methods.
  *
  * @public
  */
-export class CredentialProviderLD implements AbstractCredentialProvider {
+export class CredentialIssuerLD implements IAgentPlugin {
+  readonly methods: ICredentialIssuerLD
+  readonly schema = schema.ICredentialIssuerLD
 
   private ldCredentialModule: LdCredentialModule
 
@@ -59,40 +57,20 @@ export class CredentialProviderLD implements AbstractCredentialProvider {
       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')
-  }
 
-  /** {@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
-      }
+    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),
     }
-
-    return false
   }
 
-  /** {@inheritdoc ICredentialIssuer.createVerifiablePresentationLD} */
-  async createVerifiablePresentation(
-    args: ICreateVerifiablePresentationArgs,
-    context: IssuerAgentContext,
+  /** {@inheritdoc ICredentialIssuerLD.createVerifiablePresentationLD} */
+  public async createVerifiablePresentationLD(
+    args: ICreateVerifiablePresentationLDArgs,
+    context: IRequiredContext,
   ): Promise<VerifiablePresentation> {
     const presentationContext = processEntryToArray(
       args?.presentation?.['@context'],
@@ -161,10 +139,10 @@ export class CredentialProviderLD implements AbstractCredentialProvider {
     }
   }
 
-  /** {@inheritdoc ICredentialIssuer.createVerifiableCredentialLD} */
-  async createVerifiableCredential(
-    args: ICreateVerifiableCredentialArgs,
-    context: IssuerAgentContext,
+  /** {@inheritdoc ICredentialIssuerLD.createVerifiableCredentialLD} */
+  public async createVerifiableCredentialLD(
+    args: ICreateVerifiableCredentialLDArgs,
+    context: IRequiredContext,
   ): Promise<VerifiableCredential> {
     const credentialContext = processEntryToArray(
       args?.credential?.['@context'],
@@ -215,26 +193,27 @@ export class CredentialProviderLD implements AbstractCredentialProvider {
     }
   }
 
-  /** {@inheritdoc ICredentialIssuer.verifyCredentialLD} */
-  async verifyCredential(args: IVerifyCredentialArgs, context: VerifierAgentContext): Promise<IVerifyResult> {
-    args.credential = args.credential as VerifiableCredential
+  /** {@inheritdoc ICredentialIssuerLD.verifyCredentialLD} */
+  public async verifyCredentialLD(
+    args: IVerifyCredentialLDArgs,
+    context: IRequiredContext,
+  ): Promise<boolean> {
     const credential = args.credential
 
-    let now = new Date()
-
-    if (args.policies?.now && typeof args.policies?.now === 'number') {
-      now = new Date(args.policies?.now * 1000)
+    let { now } = args
+    if (typeof now === 'number') {
+      now = new Date(now * 1000)
     }
 
     return this.ldCredentialModule.verifyCredential(credential, { ...args, now }, context)
   }
 
-  /** {@inheritdoc ICredentialVerifier.verifyPresentation} */
-  async verifyPresentation(
-    args: IVerifyPresentationArgs,
-    context: VerifierAgentContext,
-  ): Promise<IVerifyResult> {
-    const presentation = args.presentation as VerifiablePresentation
+  /** {@inheritdoc ICredentialIssuerLD.verifyPresentationLD} */
+  public async verifyPresentationLD(
+    args: IVerifyPresentationLDArgs,
+    context: IRequiredContext,
+  ): Promise<boolean> {
+    const presentation = args.presentation
     let { now } = args
     if (typeof now === 'number') {
       now = new Date(now * 1000)
@@ -292,7 +271,7 @@ export class CredentialProviderLD implements AbstractCredentialProvider {
    *
    * @internal
    */
-  matchKeyForLDSuite(k: IKey): boolean {
+  async matchKeyForLDSuite(k: IKey): Promise<boolean> {
     // prefilter based on key algorithms
     switch (k.type) {
       case 'Ed25519':

package/src/index.ts

@@ -1,7 +1,7 @@
 /**
- * Provides a {@link @veramo/credential-ld#CredentialProviderLD | handler} for the {@link @veramo/credential-w3c#CredentialPlugin} that
+ * Provides a {@link @veramo/credential-ld#CredentialIssuerLD | plugin} for the {@link @veramo/core#Agent} that
  * implements
- * {@link @veramo/core-types#AbstractCredentialProvider} interface.
+ * {@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
@@ -10,7 +10,7 @@
  *
  * @packageDocumentation
  */
-export { CredentialProviderLD } from './CredentialProviderLD.js'
+export { CredentialIssuerLD } from './action-handler.js'
 export * from './types.js'
 export { LdDefaultContexts } from './ld-default-contexts.js'
 export { VeramoLdSignature } from './ld-suites.js'
@@ -18,3 +18,4 @@ export * from './suites/EcdsaSecp256k1RecoverySignature2020.js'
 export * from './suites/Ed25519Signature2018.js'
 export * from './suites/Ed25519Signature2020.js'
 export * from './suites/JsonWebSignature2020.js'
+export { schema } from './plugin.schema.js'

package/src/ld-credential-module.ts

@@ -3,7 +3,6 @@ import {
   IAgentContext,
   IKey,
   IResolver,
-  IVerifyResult,
   PresentationPayload,
   UsingResolutionOptions,
   VerifiableCredential,
@@ -23,7 +22,7 @@ const debug = Debug('veramo:w3c:ld-credential-module')
 
 type ForwardedOptions = UsingResolutionOptions & {
   fetchRemoteContexts?: boolean // defaults to false
-  now?: Date // defaults to Date.now()
+  now?: number // defaults to Date.now()
 }
 
 export class LdCredentialModule {
@@ -171,7 +170,7 @@ export class LdCredentialModule {
     credential: VerifiableCredential,
     options: ForwardedOptions,
     context: IAgentContext<IResolver>,
-  ): Promise<IVerifyResult> {
+  ): Promise<boolean> {
     const fetchRemoteContexts = options.fetchRemoteContexts ?? false
     const result = await vc.verifyCredential({
       ...options,
@@ -196,7 +195,7 @@ export class LdCredentialModule {
     domain: string | undefined,
     options: ForwardedOptions,
     context: IAgentContext<IResolver>,
-  ): Promise<IVerifyResult> {
+  ): Promise<boolean> {
     const fetchRemoteContexts = options.fetchRemoteContexts ?? false
     const result = await vc.verify({
       ...options,

package/src/ld-default-contexts.ts

@@ -20,7 +20,7 @@ import schema_org from './contexts/schema.org.json' assert { type: 'json' }
  * 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#CredentialProviderLD | CredentialProviderLD} with these common context definitions.
+ * {@link @veramo/credential-ld#CredentialIssuerLD | CredentialIssuerLD} with these common context definitions.
  *
  * @beta This API may change without a BREAKING CHANGE notice.
  */

package/src/ld-suites.ts

@@ -25,8 +25,6 @@ export abstract class VeramoLdSignature {
 
   abstract getSupportedVerificationType(): string | string[]
 
-  abstract getSupportedProofType(): string
-
   abstract getSupportedVeramoKeyType(): TKeyType
 
   abstract getSuiteForSigning(