@veramo/credential-status 3.1.6-next.158 → 3.1.6-next.163

package/build/credential-status.d.ts

@@ -1,8 +1,7 @@
-import { IAgentPlugin } from '@veramo/core';
+import { IAgentPlugin, ICredentialStatusVerifier } from '@veramo/core';
 import { StatusMethod } from 'credential-status';
-import { ICheckCredentialStatus } from './types';
 /**
- * This plugin implements the {@link @veramo/credential-status#ICheckCredentialStatus | ICheckCredentialStatus}
+ * This plugin implements the {@link @veramo/core#ICredentialStatusVerifier | ICredentialStatusVerifier}
  * interface.
  *
  * This aggregates some {@link credential-status#StatusMethod | credential status implementations} to provide a second
@@ -21,7 +20,7 @@ import { ICheckCredentialStatus } from './types';
  */
 export declare class CredentialStatusPlugin implements IAgentPlugin {
     private readonly status;
-    readonly methods: ICheckCredentialStatus;
+    readonly methods: ICredentialStatusVerifier;
     constructor(registry?: Record<string, StatusMethod>);
     private checkCredentialStatus;
 }

package/build/credential-status.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"credential-status.d.ts","sourceRoot":"","sources":["../src/credential-status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,YAAY,EAAwB,MAAM,cAAc,CAAA;AAChF,OAAO,EAA4B,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAC1E,OAAO,EAAE,sBAAsB,EAA8B,MAAM,SAAS,CAAA;AAE5E;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,sBAAuB,YAAW,YAAY;IACzD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAA;gBAE5B,QAAQ,GAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAM;YAOzC,qBAAqB;CAGpC"}
+{"version":3,"file":"credential-status.d.ts","sourceRoot":"","sources":["../src/credential-status.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,EAEZ,yBAAyB,EAE1B,MAAM,cAAc,CAAA;AAErB,OAAO,EAAU,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAExD;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,sBAAuB,YAAW,YAAY;IACzD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,QAAQ,CAAC,OAAO,EAAE,yBAAyB,CAAA;gBAE/B,QAAQ,GAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAM;YAOzC,qBAAqB;CAmBpC"}

package/build/credential-status.js

@@ -10,9 +10,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CredentialStatusPlugin = void 0;
+const utils_1 = require("@veramo/utils");
 const credential_status_1 = require("credential-status");
 /**
- * This plugin implements the {@link @veramo/credential-status#ICheckCredentialStatus | ICheckCredentialStatus}
+ * This plugin implements the {@link @veramo/core#ICredentialStatusVerifier | ICredentialStatusVerifier}
  * interface.
  *
  * This aggregates some {@link credential-status#StatusMethod | credential status implementations} to provide a second
@@ -38,7 +39,16 @@ class CredentialStatusPlugin {
     }
     checkCredentialStatus(args, context) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.status.checkStatus(args.credential, args.didDoc);
+            let didDoc = args.didDocumentOverride;
+            if (!didDoc) {
+                const issuerDid = (0, utils_1.extractIssuer)(args.credential);
+                didDoc = yield (0, utils_1.resolveDidOrThrow)(issuerDid, context);
+            }
+            const statusCheck = (yield this.status.checkStatus(args.credential, didDoc));
+            if (!(0, utils_1.isDefined)(statusCheck.revoked)) {
+                throw new Error(`invalid_result: 'revoked' property missing. The Credential Status verification resulted in an ambiguous result: ${JSON.stringify(statusCheck)}`);
+            }
+            return statusCheck;
         });
     }
 }

package/build/credential-status.js.map

@@ -1 +1 @@
-{"version":3,"file":"credential-status.js","sourceRoot":"","sources":["../src/credential-status.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,yDAA0E;AAG1E;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,sBAAsB;IAIjC,YAAY,WAAyC,EAAE;QACrD,IAAI,CAAC,MAAM,GAAG,IAAI,0BAAM,CAAC,QAAQ,CAAC,CAAA;QAClC,IAAI,CAAC,OAAO,GAAG;YACb,qBAAqB,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC7D,CAAA;IACH,CAAC;IAEa,qBAAqB,CAAC,IAAgC,EAAE,OAA2B;;YAC/F,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAC9D,CAAC;KAAA;CACF;AAdD,wDAcC"}
+{"version":3,"file":"credential-status.js","sourceRoot":"","sources":["../src/credential-status.ts"],"names":[],"mappings":";;;;;;;;;;;;AAQA,yCAA2E;AAC3E,yDAAwD;AAExD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,sBAAsB;IAIjC,YAAY,WAAyC,EAAE;QACrD,IAAI,CAAC,MAAM,GAAG,IAAI,0BAAM,CAAC,QAAQ,CAAC,CAAA;QAClC,IAAI,CAAC,OAAO,GAAG;YACb,qBAAqB,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC;SAC7D,CAAA;IACH,CAAC;IAEa,qBAAqB,CAAC,IAAgC,EAAE,OAAiC;;YACrG,IAAI,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAA;YACrC,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,SAAS,GAAG,IAAA,qBAAa,EAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBAChD,MAAM,GAAG,MAAM,IAAA,yBAAiB,EAAC,SAAS,EAAE,OAAO,CAAC,CAAA;aACrD;YACD,MAAM,WAAW,GAAqB,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAClE,IAAI,CAAC,UAAU,EACf,MAAM,CACP,CAAqB,CAAA;YACtB,IAAI,CAAC,IAAA,iBAAS,EAAC,WAAW,CAAC,OAAO,CAAC,EAAE;gBACnC,MAAM,IAAI,KAAK,CACb,mHAAmH,IAAI,CAAC,SAAS,CAC/H,WAAW,CACZ,EAAE,CACJ,CAAA;aACF;YACD,OAAO,WAAW,CAAA;QACpB,CAAC;KAAA;CACF;AA9BD,wDA8BC"}

package/build/index.d.ts

@@ -1,3 +1,2 @@
 export { CredentialStatusPlugin } from './credential-status';
-export * from './types';
 //# 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":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAC5D,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA"}

package/build/index.js

@@ -1,22 +1,7 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CredentialStatusPlugin = void 0;
 /* istanbul ignore file */
 var credential_status_1 = require("./credential-status");
 Object.defineProperty(exports, "CredentialStatusPlugin", { enumerable: true, get: function () { return credential_status_1.CredentialStatusPlugin; } });
-__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,0BAA0B;AAC1B,yDAA4D;AAAnD,2HAAA,sBAAsB,OAAA;AAC/B,0CAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,0BAA0B;AAC1B,yDAA4D;AAAnD,2HAAA,sBAAsB,OAAA"}

package/package.json

@@ -1,20 +1,16 @@
 {
   "name": "@veramo/credential-status",
   "description": "Veramo plugin for resolving a credential status",
-  "version": "3.1.6-next.158+5c340b52",
+  "version": "3.1.6-next.163+a110e966",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "generate-plugin-schema": "yarn veramo dev generate-plugin-schema"
-  },
-  "veramo": {
-    "pluginInterfaces": {
-      "ICheckCredentialStatus": "./src/types.ts"
-    }
+    "extract-api": "yarn veramo dev extract-api"
   },
   "dependencies": {
-    "@veramo/core": "^3.1.6-next.158+5c340b52",
+    "@veramo/core": "^3.1.6-next.163+a110e966",
+    "@veramo/utils": "^3.1.6-next.163+a110e966",
     "credential-status": "^2.0.3",
     "did-jwt": "^6.2.0",
     "did-resolver": "^3.2.2"
@@ -38,5 +34,5 @@
   "contributors": [],
   "license": "Apache-2.0",
   "keywords": [],
-  "gitHead": "5c340b524ef1153c3e7ff05e5f71006fbdca02fe"
+  "gitHead": "a110e96655c940bc8432c040c078a295e5a1fc79"
 }

package/src/__tests__/credential-status.test.ts

@@ -1,40 +1,80 @@
-import { createAgent } from '../../../core/src'
+import { createAgent, ICredentialStatusVerifier, VerifiableCredential } from '../../../core/src'
+import { DIDResolverPlugin } from '../../../did-resolver/src'
 import { CredentialStatusPlugin } from '../credential-status'
-import { DIDDocument } from 'did-resolver'
+import { DIDDocument, DIDResolutionOptions, DIDResolutionResult, Resolvable } from 'did-resolver'
 
 describe('@veramo/credential-status', () => {
-  const referenceCredential = {
+  const referenceDoc: DIDDocument = { id: 'did:example:1234' }
+  const referenceCredential: VerifiableCredential = {
+    '@context': [],
+    issuanceDate: new Date().toISOString(),
+    proof: {},
+    issuer: referenceDoc.id,
+    credentialSubject: {},
     credentialStatus: {
       type: 'ExoticStatusMethod2022',
       id: 'some-exotic-id',
     },
   }
-  const referenceDoc = {} as DIDDocument
 
   it('should check the credential status', async () => {
-    expect.assertions(3);
-    const expectedResult = {}
+    expect.assertions(3)
+    const expectedResult = { revoked: false }
     const checkStatus = jest.fn(async () => expectedResult)
+    const agent = createAgent<ICredentialStatusVerifier>({
+      plugins: [
+        new CredentialStatusPlugin({
+          ExoticStatusMethod2022: checkStatus,
+        }),
+      ],
+    })
+
+    const result = await agent.checkCredentialStatus({
+      credential: referenceCredential,
+      didDocumentOverride: referenceDoc,
+    })
+
+    expect(result).toStrictEqual(expectedResult)
+    expect(checkStatus).toBeCalledTimes(1)
+    expect(checkStatus).toBeCalledWith(referenceCredential, referenceDoc)
+  })
+
+  it('should check the credential status using DID resolver to get the issuer doc', async () => {
+    expect.assertions(4)
+    const expectedResult = { revoked: false }
+    const checkStatus = jest.fn(async () => expectedResult)
+    const fakeResolver: Resolvable = {
+      resolve: jest.fn(
+        async (didUrl: string, options?: DIDResolutionOptions): Promise<DIDResolutionResult> => {
+          return {
+            didDocument: { id: didUrl },
+            didResolutionMetadata: {},
+            didDocumentMetadata: {},
+          }
+        },
+      ),
+    }
     const agent = createAgent({
       plugins: [
         new CredentialStatusPlugin({
           ExoticStatusMethod2022: checkStatus,
         }),
+        new DIDResolverPlugin({ resolver: fakeResolver }),
       ],
     })
 
     const result = await agent.checkCredentialStatus({
       credential: referenceCredential,
-      didDoc: referenceDoc,
     })
 
     expect(result).toStrictEqual(expectedResult)
     expect(checkStatus).toBeCalledTimes(1)
     expect(checkStatus).toBeCalledWith(referenceCredential, referenceDoc)
+    expect(fakeResolver.resolve).toBeCalledTimes(1)
   })
 
   it('should not perform status check if no `credentialStatus` present', async () => {
-    expect.assertions(2);
+    expect.assertions(2)
     const checkStatus = jest.fn()
     const agent = createAgent({
       plugins: [
@@ -46,7 +86,7 @@ describe('@veramo/credential-status', () => {
 
     const result = await agent.checkCredentialStatus({
       credential: {},
-      didDoc: referenceDoc,
+      didDocumentOverride: referenceDoc,
     })
 
     expect(result).toEqual({
@@ -57,17 +97,22 @@ describe('@veramo/credential-status', () => {
   })
 
   it('should throw if unknown status check was provided', async () => {
-    expect.assertions(1);
+    expect.assertions(1)
     const agent = createAgent({
       plugins: [
         new CredentialStatusPlugin({
-          NotCalled: jest.fn()
-        })
+          NotCalled: jest.fn(),
+        }),
       ],
     })
 
-    await expect(agent.checkCredentialStatus({
-      credential: referenceCredential
-    })).rejects.toThrow(`unknown_method: credentialStatus method ExoticStatusMethod2022 unknown. Validity can not be determined.`)
+    await expect(
+      agent.checkCredentialStatus({
+        credential: referenceCredential,
+        didDocumentOverride: referenceDoc,
+      }),
+    ).rejects.toThrow(
+      `unknown_method: credentialStatus method ExoticStatusMethod2022 unknown. Validity can not be determined.`,
+    )
   })
 })

package/src/credential-status.ts

@@ -1,9 +1,16 @@
-import { IAgentContext, IAgentPlugin, VerifiableCredential } from '@veramo/core'
-import { CredentialStatus, Status, StatusMethod } from 'credential-status'
-import { ICheckCredentialStatus, ICheckCredentialStatusArgs } from './types'
+import {
+  CredentialStatus,
+  IAgentContext,
+  IAgentPlugin,
+  ICheckCredentialStatusArgs,
+  ICredentialStatusVerifier,
+  IResolver,
+} from '@veramo/core'
+import { extractIssuer, isDefined, resolveDidOrThrow } from '@veramo/utils'
+import { Status, StatusMethod } from 'credential-status'
 
 /**
- * This plugin implements the {@link @veramo/credential-status#ICheckCredentialStatus | ICheckCredentialStatus}
+ * This plugin implements the {@link @veramo/core#ICredentialStatusVerifier | ICredentialStatusVerifier}
  * interface.
  *
  * This aggregates some {@link credential-status#StatusMethod | credential status implementations} to provide a second
@@ -22,7 +29,7 @@ import { ICheckCredentialStatus, ICheckCredentialStatusArgs } from './types'
  */
 export class CredentialStatusPlugin implements IAgentPlugin {
   private readonly status: Status
-  readonly methods: ICheckCredentialStatus
+  readonly methods: ICredentialStatusVerifier
 
   constructor(registry: Record<string, StatusMethod> = {}) {
     this.status = new Status(registry)
@@ -31,8 +38,23 @@ export class CredentialStatusPlugin implements IAgentPlugin {
     }
   }
 
-  private async checkCredentialStatus(args: ICheckCredentialStatusArgs, context: IAgentContext<any>) {
-    return this.status.checkStatus(args.credential, args.didDoc)
+  private async checkCredentialStatus(args: ICheckCredentialStatusArgs, context: IAgentContext<IResolver>) {
+    let didDoc = args.didDocumentOverride
+    if (!didDoc) {
+      const issuerDid = extractIssuer(args.credential)
+      didDoc = await resolveDidOrThrow(issuerDid, context)
+    }
+    const statusCheck: CredentialStatus = (await this.status.checkStatus(
+      args.credential,
+      didDoc,
+    )) as CredentialStatus
+    if (!isDefined(statusCheck.revoked)) {
+      throw new Error(
+        `invalid_result: 'revoked' property missing. The Credential Status verification resulted in an ambiguous result: ${JSON.stringify(
+          statusCheck,
+        )}`,
+      )
+    }
+    return statusCheck
   }
 }
-

package/src/index.ts

@@ -1,3 +1,2 @@
 /* istanbul ignore file */
 export { CredentialStatusPlugin } from './credential-status'
-export * from './types'

package/build/types.d.ts

@@ -1,43 +0,0 @@
-import { IAgentContext, IPluginMethodMap, VerifiableCredential } from '@veramo/core';
-import { CredentialStatus } from 'credential-status';
-import { DIDDocument } from 'did-resolver';
-/**
- * Arguments for calling {@link ICheckCredentialStatus.checkCredentialStatus | checkCredentialStatus}.
- *
- * The credential whose status should be checked and the DID document of the credential issuer.
- *
- * See {@link https://www.w3.org/TR/vc-data-model/#status | Credential Status}
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export interface ICheckCredentialStatusArgs {
-    credential: VerifiableCredential;
-    didDoc: DIDDocument;
-}
-/**
- * This interface defines a plugin that can check the {@link https://www.w3.org/TR/vc-data-model/#status | status} of a
- * {@link @veramo/core#VerifiableCredential | Verifiable Credential}.
- *
- * This is 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.
- *
- * The result provided by implementations of this plugin depend on whether the implementation of the StatusMethod is
- * available.
- *
- * @see {@link https://www.w3.org/TR/vc-data-model/#status | Credential Status} for data model documentation.
- * @see {@link @veramo/credential-status#CredentialStatusPlugin | CredentialStatusPlugin } for an implementation.
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export interface ICheckCredentialStatus extends IPluginMethodMap {
-    /**
-     * Checks the status of a {@link @veramo/core#VerifiableCredential | Verifiable Credential}.
-     *
-     * @param args - The credential to be checked, along with the DID document of the issuer.
-     * @param context - *RESERVED* This is filled by the framework when the method is called.
-     */
-    checkCredentialStatus(args: ICheckCredentialStatusArgs, context: IAgentContext<any>): Promise<CredentialStatus>;
-}
-//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAA;AACpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C;;;;;;;;GAQG;AACH,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,oBAAoB,CAAA;IAChC,MAAM,EAAE,WAAW,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAE9D;;;;;OAKG;IACH,qBAAqB,CACnB,IAAI,EAAE,0BAA0B,EAChC,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAA;CAC7B"}

package/build/types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/plugin.schema.json

@@ -1,386 +0,0 @@
-{
-  "ICheckCredentialStatus": {
-    "components": {
-      "schemas": {
-        "ICheckCredentialStatusArgs": {
-          "type": "object",
-          "properties": {
-            "credential": {
-              "$ref": "#/components/schemas/VerifiableCredential"
-            },
-            "didDoc": {
-              "$ref": "#/components/schemas/DIDDocument"
-            }
-          },
-          "required": [
-            "credential",
-            "didDoc"
-          ],
-          "description": "Arguments for calling  {@link  ICheckCredentialStatus.checkCredentialStatus | checkCredentialStatus } .\n\nThe credential whose status should be checked and the DID document of the credential issuer.\n\nSee  {@link  https://www.w3.org/TR/vc-data-model/#status | Credential Status }"
-        },
-        "VerifiableCredential": {
-          "type": "object",
-          "properties": {
-            "proof": {
-              "$ref": "#/components/schemas/ProofType"
-            },
-            "issuer": {
-              "$ref": "#/components/schemas/IssuerType"
-            },
-            "credentialSubject": {
-              "$ref": "#/components/schemas/CredentialSubject"
-            },
-            "type": {
-              "anyOf": [
-                {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                },
-                {
-                  "type": "string"
-                }
-              ]
-            },
-            "@context": {
-              "anyOf": [
-                {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                },
-                {
-                  "type": "string"
-                }
-              ]
-            },
-            "issuanceDate": {
-              "type": "string"
-            },
-            "expirationDate": {
-              "type": "string"
-            },
-            "credentialStatus": {
-              "$ref": "#/components/schemas/CredentialStatus"
-            },
-            "id": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "@context",
-            "credentialSubject",
-            "issuanceDate",
-            "issuer",
-            "proof"
-          ],
-          "description": "Represents a signed Verifiable Credential payload (includes proof), using a JSON representation. See  {@link  https://www.w3.org/TR/vc-data-model/#credentials | VC data model }"
-        },
-        "ProofType": {
-          "type": "object",
-          "properties": {
-            "type": {
-              "type": "string"
-            }
-          },
-          "description": "A proof property of a Verifiable Credential or Presentation"
-        },
-        "IssuerType": {
-          "anyOf": [
-            {
-              "type": "object",
-              "properties": {
-                "id": {
-                  "type": "string"
-                }
-              },
-              "required": [
-                "id"
-              ]
-            },
-            {
-              "type": "string"
-            }
-          ],
-          "description": "The issuer of a Credential or the holder of a Presentation.\n\nThe value of the issuer property MUST be either a URI or an object containing an id property. It is RECOMMENDED that the URI in the issuer or its id be one which, if de-referenced, results in a document containing machine-readable information about the issuer that can be used to verify the information expressed in the credential.\n\nSee  {@link  https://www.w3.org/TR/vc-data-model/#issuer | Issuer data model }"
-        },
-        "CredentialSubject": {
-          "type": "object",
-          "properties": {
-            "id": {
-              "type": "string"
-            }
-          },
-          "description": "The value of the credentialSubject property is defined as a set of objects that contain one or more properties that are each related to a subject of the verifiable credential. Each object MAY contain an id.\n\nSee  {@link  https://www.w3.org/TR/vc-data-model/#credential-subject | Credential Subject }"
-        },
-        "CredentialStatus": {
-          "type": "object",
-          "properties": {
-            "id": {
-              "type": "string"
-            },
-            "type": {
-              "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 }"
-        },
-        "DIDDocument": {
-          "type": "object",
-          "properties": {
-            "authentication": {
-              "type": "array",
-              "items": {
-                "anyOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "$ref": "#/components/schemas/VerificationMethod"
-                  }
-                ]
-              }
-            },
-            "assertionMethod": {
-              "type": "array",
-              "items": {
-                "anyOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "$ref": "#/components/schemas/VerificationMethod"
-                  }
-                ]
-              }
-            },
-            "keyAgreement": {
-              "type": "array",
-              "items": {
-                "anyOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "$ref": "#/components/schemas/VerificationMethod"
-                  }
-                ]
-              }
-            },
-            "capabilityInvocation": {
-              "type": "array",
-              "items": {
-                "anyOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "$ref": "#/components/schemas/VerificationMethod"
-                  }
-                ]
-              }
-            },
-            "capabilityDelegation": {
-              "type": "array",
-              "items": {
-                "anyOf": [
-                  {
-                    "type": "string"
-                  },
-                  {
-                    "$ref": "#/components/schemas/VerificationMethod"
-                  }
-                ]
-              }
-            },
-            "@context": {
-              "anyOf": [
-                {
-                  "type": "string",
-                  "const": "https://www.w3.org/ns/did/v1"
-                },
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                }
-              ]
-            },
-            "id": {
-              "type": "string"
-            },
-            "alsoKnownAs": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            "controller": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                }
-              ]
-            },
-            "verificationMethod": {
-              "type": "array",
-              "items": {
-                "$ref": "#/components/schemas/VerificationMethod"
-              }
-            },
-            "service": {
-              "type": "array",
-              "items": {
-                "$ref": "#/components/schemas/ServiceEndpoint"
-              }
-            },
-            "publicKey": {
-              "type": "array",
-              "items": {
-                "$ref": "#/components/schemas/VerificationMethod"
-              },
-              "deprecated": true
-            }
-          },
-          "required": [
-            "id"
-          ]
-        },
-        "VerificationMethod": {
-          "type": "object",
-          "properties": {
-            "id": {
-              "type": "string"
-            },
-            "type": {
-              "type": "string"
-            },
-            "controller": {
-              "type": "string"
-            },
-            "publicKeyBase58": {
-              "type": "string"
-            },
-            "publicKeyBase64": {
-              "type": "string"
-            },
-            "publicKeyJwk": {
-              "$ref": "#/components/schemas/JsonWebKey"
-            },
-            "publicKeyHex": {
-              "type": "string"
-            },
-            "publicKeyMultibase": {
-              "type": "string"
-            },
-            "blockchainAccountId": {
-              "type": "string"
-            },
-            "ethereumAddress": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "id",
-            "type",
-            "controller"
-          ]
-        },
-        "JsonWebKey": {
-          "type": "object",
-          "properties": {
-            "alg": {
-              "type": "string"
-            },
-            "crv": {
-              "type": "string"
-            },
-            "e": {
-              "type": "string"
-            },
-            "ext": {
-              "type": "boolean"
-            },
-            "key_ops": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            "kid": {
-              "type": "string"
-            },
-            "kty": {
-              "type": "string"
-            },
-            "n": {
-              "type": "string"
-            },
-            "use": {
-              "type": "string"
-            },
-            "x": {
-              "type": "string"
-            },
-            "y": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "kty"
-          ],
-          "description": "Encapsulates a JSON web key type that includes only the public properties that can be used in DID documents.\n\nThe private properties are intentionally omitted to discourage the use (and accidental disclosure) of private keys in DID documents."
-        },
-        "ServiceEndpoint": {
-          "type": "object",
-          "properties": {
-            "id": {
-              "type": "string"
-            },
-            "type": {
-              "type": "string"
-            },
-            "serviceEndpoint": {
-              "type": "string"
-            },
-            "description": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "id",
-            "type",
-            "serviceEndpoint"
-          ]
-        }
-      },
-      "methods": {
-        "checkCredentialStatus": {
-          "description": "Checks the status of a ",
-          "arguments": {
-            "$ref": "#/components/schemas/ICheckCredentialStatusArgs"
-          },
-          "returnType": {
-            "$ref": "#/components/schemas/CredentialStatus"
-          }
-        }
-      }
-    }
-  }
-}

package/src/types.ts

@@ -1,48 +0,0 @@
-import { IAgentContext, IPluginMethodMap, VerifiableCredential } from '@veramo/core'
-import { CredentialStatus } from 'credential-status'
-import { DIDDocument } from 'did-resolver'
-
-/**
- * Arguments for calling {@link ICheckCredentialStatus.checkCredentialStatus | checkCredentialStatus}.
- *
- * The credential whose status should be checked and the DID document of the credential issuer.
- *
- * See {@link https://www.w3.org/TR/vc-data-model/#status | Credential Status}
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export interface ICheckCredentialStatusArgs {
-  credential: VerifiableCredential
-  didDoc: DIDDocument
-}
-
-/**
- * This interface defines a plugin that can check the {@link https://www.w3.org/TR/vc-data-model/#status | status} of a
- * {@link @veramo/core#VerifiableCredential | Verifiable Credential}.
- *
- * This is 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.
- *
- * The result provided by implementations of this plugin depend on whether the implementation of the StatusMethod is
- * available.
- *
- * @see {@link https://www.w3.org/TR/vc-data-model/#status | Credential Status} for data model documentation.
- * @see {@link @veramo/credential-status#CredentialStatusPlugin | CredentialStatusPlugin } for an implementation.
- *
- * @beta This API may change without a BREAKING CHANGE notice.
- */
-export interface ICheckCredentialStatus extends IPluginMethodMap {
-
-  /**
-   * Checks the status of a {@link @veramo/core#VerifiableCredential | Verifiable Credential}.
-   *
-   * @param args - The credential to be checked, along with the DID document of the issuer.
-   * @param context - *RESERVED* This is filled by the framework when the method is called.
-   */
-  checkCredentialStatus(
-    args: ICheckCredentialStatusArgs,
-    context: IAgentContext<any>,
-  ): Promise<CredentialStatus>
-}