@veramo/credential-status 3.1.6-next.157 → 3.1.6-next.160

package/build/types.d.ts

@@ -1,5 +1,5 @@
 import { IAgentContext, IPluginMethodMap, VerifiableCredential } from '@veramo/core';
-import { CredentialStatus } from 'credential-status';
+import { CredentialStatus as CredentialStatusVerification } from 'credential-status';
 import { DIDDocument } from 'did-resolver';
 /**
  * Arguments for calling {@link ICheckCredentialStatus.checkCredentialStatus | checkCredentialStatus}.
@@ -38,6 +38,6 @@ export interface ICheckCredentialStatus extends IPluginMethodMap {
      * @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>;
+    checkCredentialStatus(args: ICheckCredentialStatusArgs, context: IAgentContext<any>): Promise<CredentialStatusVerification>;
 }
 //# 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,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"}
+{"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,IAAI,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AACpF,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,4BAA4B,CAAC,CAAA;CACzC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@veramo/credential-status",
   "description": "Veramo plugin for resolving a credential status",
-  "version": "3.1.6-next.157+598c0e1e",
+  "version": "3.1.6-next.160+6fbd22fa",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
@@ -14,7 +14,7 @@
     }
   },
   "dependencies": {
-    "@veramo/core": "^3.1.6-next.157+598c0e1e",
+    "@veramo/core": "^3.1.6-next.160+6fbd22fa",
     "credential-status": "^2.0.3",
     "did-jwt": "^6.2.0",
     "did-resolver": "^3.2.2"
@@ -38,5 +38,5 @@
   "contributors": [],
   "license": "Apache-2.0",
   "keywords": [],
-  "gitHead": "598c0e1e3f37d1b30c865fa01b93b7657f43d795"
+  "gitHead": "6fbd22fa6ba7bb1d4092afbded0f95c0d841bd97"
 }

package/plugin.schema.json

@@ -122,7 +122,7 @@
               "type": "string"
             },
             "type": {
-              "type": "string"
+              "$ref": "#/components/schemas/CredentialStatusType"
             }
           },
           "required": [
@@ -131,6 +131,10 @@
           ],
           "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 }"
         },
+        "CredentialStatusType": {
+          "type": "string",
+          "description": "Expresses the credential status type (also referred to as the credential status method). It is expected that the value will provide enough information to determine the current status of the credential and that machine readable information needs to be retrievable from the URI. For example, the object could contain a link to an external document noting whether or not the credential is suspended or revoked."
+        },
         "DIDDocument": {
           "type": "object",
           "properties": {
@@ -368,6 +372,15 @@
             "type",
             "serviceEndpoint"
           ]
+        },
+        "CredentialStatusVerification": {
+          "type": "object",
+          "properties": {
+            "revoked": {
+              "type": "boolean"
+            }
+          },
+          "description": "Represents the result of a status check.\n\nImplementations should populate the `revoked` boolean property, but they can return additional metadata that is method specific."
         }
       },
       "methods": {
@@ -377,7 +390,7 @@
             "$ref": "#/components/schemas/ICheckCredentialStatusArgs"
           },
           "returnType": {
-            "$ref": "#/components/schemas/CredentialStatus"
+            "$ref": "#/components/schemas/CredentialStatusVerification"
           }
         }
       }

package/src/types.ts

@@ -1,5 +1,5 @@
 import { IAgentContext, IPluginMethodMap, VerifiableCredential } from '@veramo/core'
-import { CredentialStatus } from 'credential-status'
+import { CredentialStatus as CredentialStatusVerification } from 'credential-status'
 import { DIDDocument } from 'did-resolver'
 
 /**
@@ -44,5 +44,5 @@ export interface ICheckCredentialStatus extends IPluginMethodMap {
   checkCredentialStatus(
     args: ICheckCredentialStatusArgs,
     context: IAgentContext<any>,
-  ): Promise<CredentialStatus>
+  ): Promise<CredentialStatusVerification>
 }