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

package/build/credential-status.d.ts

@@ -1,6 +1,24 @@
 import { IAgentPlugin } from '@veramo/core';
 import { StatusMethod } from 'credential-status';
 import { ICheckCredentialStatus } from './types';
+/**
+ * This plugin implements the {@link @veramo/credential-status#ICheckCredentialStatus | ICheckCredentialStatus}
+ * interface.
+ *
+ * This aggregates some {@link credential-status#StatusMethod | credential status implementations} to provide a second
+ * layer of validation when verifying Verifiable Credentials.
+ *
+ * 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.
+ *
+ * The results provided by this plugin depend on whether the {@link credential-status#StatusMethod | StatusMethod}
+ * required by the credential is installed.
+ *
+ * @see {@link credential-status#Status}
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
 export declare class CredentialStatusPlugin implements IAgentPlugin {
     private readonly status;
     readonly methods: ICheckCredentialStatus;

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,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAU,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,EAAE,sBAAsB,EAA8B,MAAM,SAAS,CAAA;AAE5E,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,EAAiB,YAAY,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAU,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACxD,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"}

package/build/credential-status.js

@@ -11,6 +11,24 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CredentialStatusPlugin = void 0;
 const credential_status_1 = require("credential-status");
+/**
+ * This plugin implements the {@link @veramo/credential-status#ICheckCredentialStatus | ICheckCredentialStatus}
+ * interface.
+ *
+ * This aggregates some {@link credential-status#StatusMethod | credential status implementations} to provide a second
+ * layer of validation when verifying Verifiable Credentials.
+ *
+ * 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.
+ *
+ * The results provided by this plugin depend on whether the {@link credential-status#StatusMethod | StatusMethod}
+ * required by the credential is installed.
+ *
+ * @see {@link credential-status#Status}
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
 class CredentialStatusPlugin {
     constructor(registry = {}) {
         this.status = new credential_status_1.Status(registry);

package/build/credential-status.js.map

@@ -1 +1 @@
-{"version":3,"file":"credential-status.js","sourceRoot":"","sources":["../src/credential-status.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,yDAAwD;AAGxD,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":";;;;;;;;;;;;AACA,yDAAwD;AAGxD;;;;;;;;;;;;;;;;;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"}

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,15 +1,43 @@
-import { IAgentContext, IPluginMethodMap } from '@veramo/core';
-import { CredentialJwtOrJSON, CredentialStatus } from 'credential-status';
+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: CredentialJwtOrJSON;
+    credential: VerifiableCredential;
     didDoc: DIDDocument;
 }
-export interface ICheckCredentialStatusResult {
-    revoked: boolean;
-    [x: string]: any;
-}
+/**
+ * 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 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAC9D,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACzE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,mBAAmB,CAAA;IAC/B,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,OAAO,CAAA;IAGhB,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CACjB;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D,qBAAqB,CACnB,IAAI,EAAE,0BAA0B,EAChC,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAA;CAC7B"}
+{"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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@veramo/credential-status",
   "description": "Veramo plugin for resolving a credential status",
-  "version": "3.1.5-next.121+e3aedac7",
+  "version": "3.1.5-next.125+ea4966a6",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
@@ -14,14 +14,14 @@
     }
   },
   "dependencies": {
-    "@veramo/core": "^3.1.5-next.121+e3aedac7",
+    "@veramo/core": "^3.1.5-next.125+ea4966a6",
     "credential-status": "^2.0.2",
     "did-jwt": "^5.12.4",
     "did-resolver": "3.2.0"
   },
   "devDependencies": {
     "@types/debug": "4.1.7",
-    "typescript": "4.7.2"
+    "typescript": "4.7.3"
   },
   "files": [
     "build/**/*",
@@ -38,5 +38,5 @@
   "contributors": [],
   "license": "Apache-2.0",
   "keywords": [],
-  "gitHead": "e3aedac77ce9c7fd981f1621881ab823894a5514"
+  "gitHead": "ea4966a6b79dc4653a2aff9147c096ee22bb47df"
 }

package/plugin.schema.json

@@ -6,7 +6,7 @@
           "type": "object",
           "properties": {
             "credential": {
-              "$ref": "#/components/schemas/CredentialJwtOrJSON"
+              "$ref": "#/components/schemas/VerifiableCredential"
             },
             "didDoc": {
               "$ref": "#/components/schemas/DIDDocument"
@@ -15,39 +15,121 @@
           "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 }"
         },
-        "CredentialJwtOrJSON": {
-          "anyOf": [
-            {
+        "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": {
-                "credentialStatus": {
-                  "$ref": "#/components/schemas/StatusEntry"
+                "id": {
+                  "type": "string"
                 }
-              }
+              },
+              "required": [
+                "id"
+              ]
+            },
+            {
+              "type": "string"
             }
           ],
-          "description": "The Verifiable Credential or Presentation to be verified in either JSON/JSON-LD or JWT format."
+          "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 }"
         },
-        "StatusEntry": {
+        "CredentialSubject": {
           "type": "object",
           "properties": {
-            "type": {
+            "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": [
-            "type",
-            "id"
+            "id",
+            "type"
           ],
-          "description": "Represents a status method entry that could be embedded in a W3C Verifiable Credential. Normally, only credentials that list a status method would need to be verified by it.\n\nex: ```json credentialStatus: {   type: \"EthrStatusRegistry2019\",   id: \"rinkeby:0xregistryAddress\" } ``` See https://www.w3.org/TR/vc-data-model/#status"
+          "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",
@@ -286,23 +368,11 @@
             "type",
             "serviceEndpoint"
           ]
-        },
-        "CredentialStatus": {
-          "type": "object",
-          "properties": {
-            "id": {
-              "type": "string"
-            },
-            "type": {
-              "type": "string"
-            }
-          },
-          "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 }"
         }
       },
       "methods": {
         "checkCredentialStatus": {
-          "description": "",
+          "description": "Checks the status of a ",
           "arguments": {
             "$ref": "#/components/schemas/ICheckCredentialStatusArgs"
           },

package/src/credential-status.ts

@@ -2,6 +2,24 @@ import { IAgentContext, IAgentPlugin } from '@veramo/core'
 import { Status, StatusMethod } from 'credential-status'
 import { ICheckCredentialStatus, ICheckCredentialStatusArgs } from './types'
 
+/**
+ * This plugin implements the {@link @veramo/credential-status#ICheckCredentialStatus | ICheckCredentialStatus}
+ * interface.
+ *
+ * This aggregates some {@link credential-status#StatusMethod | credential status implementations} to provide a second
+ * layer of validation when verifying Verifiable Credentials.
+ *
+ * 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.
+ *
+ * The results provided by this plugin depend on whether the {@link credential-status#StatusMethod | StatusMethod}
+ * required by the credential is installed.
+ *
+ * @see {@link credential-status#Status}
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
 export class CredentialStatusPlugin implements IAgentPlugin {
   private readonly status: Status
   readonly methods: ICheckCredentialStatus

package/src/types.ts

@@ -1,20 +1,46 @@
-import { IAgentContext, IPluginMethodMap } from '@veramo/core'
-import { CredentialJwtOrJSON, CredentialStatus } from 'credential-status'
+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: CredentialJwtOrJSON
+  credential: VerifiableCredential
   didDoc: DIDDocument
 }
 
-export interface ICheckCredentialStatusResult {
-  revoked: boolean
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [x: string]: any
-}
-
+/**
+ * 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>,