@sphereon/ssi-sdk.vc-status-list 0.34.1-feature.SSISDK.17.bitstring.sl.11 → 0.34.1-feature.SSISDK.17.bitstring.sl.13

package/dist/index.cjs

@@ -123,7 +123,8 @@ var ValidProofTypeMap = /* @__PURE__ */ new Map([
   [
     import_ssi_types.StatusListType.BitstringStatusList,
     [
-      "lds"
+      "lds",
+      "vc+jwt"
     ]
   ]
 ]);
@@ -845,6 +846,13 @@ var BitstringStatusListImplementation = class {
   static {
     __name(this, "BitstringStatusListImplementation");
   }
+  /**
+  * Creates a new bitstring status list with the specified configuration
+  *
+  * @param args - Configuration for the new status list including issuer, purpose, and size
+  * @param context - Veramo agent context for credential operations
+  * @returns Promise resolving to the created status list details
+  */
   async createNewStatusList(args, context) {
     if (!args.bitstringStatusList) {
       throw new Error("BitstringStatusList options are required for type BitstringStatusList");
@@ -852,28 +860,34 @@ var BitstringStatusListImplementation = class {
     const length = args?.length ?? DEFAULT_LIST_LENGTH3;
     const proofFormat = args?.proofFormat ?? DEFAULT_PROOF_FORMAT3;
     assertValidProofType(import_ssi_types5.StatusListType.BitstringStatusList, proofFormat);
-    const veramoProofFormat = proofFormat;
     const { issuer, id } = args;
     const correlationId = getAssertedValue("correlationId", args.correlationId);
     const { statusPurpose, bitsPerStatus, validFrom, validUntil, ttl } = args.bitstringStatusList;
-    const statusListCredential = await this.createVerifiableCredential({
-      ...args,
-      proofFormat: veramoProofFormat,
+    const unsignedCredential = await (0, import_vc_bitstring_status_lists.createStatusListCredential)({
+      id,
+      issuer,
       statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
       validFrom: ensureDate(validFrom),
       validUntil: ensureDate(validUntil),
       ttl
+    });
+    const statusListCredential = await this.createVerifiableCredential({
+      unsignedCredential,
+      id,
+      issuer,
+      proofFormat,
+      keyRef: args.keyRef
     }, context);
     return {
-      encodedList: statusListCredential.credentialSubject.encodedList,
+      encodedList: unsignedCredential.credentialSubject.encodedList,
       statusListCredential,
       bitstringStatusList: {
         statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
-        ...statusListCredential.validFrom && {
-          validFrom: new Date(statusListCredential.validFrom)
+        ...unsignedCredential.validFrom && {
+          validFrom: new Date(unsignedCredential.validFrom)
         },
-        ...statusListCredential.validUntil && {
-          validUntil: new Date(statusListCredential.validUntil)
+        ...unsignedCredential.validUntil && {
+          validUntil: new Date(unsignedCredential.validUntil)
         },
         ttl,
         bitsPerStatus
@@ -887,9 +901,16 @@ var BitstringStatusListImplementation = class {
       statuslistContentType: this.buildContentType(proofFormat)
     };
   }
+  /**
+  * Updates the status of a specific credential in an existing status list
+  *
+  * @param args - Update parameters including the status list credential, index, and new value
+  * @param context - Veramo agent context for credential operations
+  * @returns Promise resolving to the updated status list details
+  */
   async updateStatusListIndex(args, context) {
     if (!args.bitsPerStatus || args.bitsPerStatus < 1) {
-      return Promise.reject("bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (updateStatusListIndex)");
+      return Promise.reject(Error("bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (updateStatusListIndex)"));
     }
     const credential = args.statusListCredential;
     const uniform = import_ssi_types5.CredentialMapper.toUniformCredential(credential);
@@ -908,27 +929,32 @@ var BitstringStatusListImplementation = class {
     const validFrom = uniform.validFrom ? new Date(uniform.validFrom) : void 0;
     const validUntil = uniform.validUntil ? new Date(uniform.validUntil) : void 0;
     const ttl = credSubject.ttl;
-    const updatedCredential = await this.createVerifiableCredential({
-      ...args,
+    const unsignedCredential = await (0, import_vc_bitstring_status_lists.createStatusListCredential)({
       id,
       issuer,
       statusList,
+      statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
+      validFrom: ensureDate(validFrom),
+      validUntil: ensureDate(validUntil),
+      ttl
+    });
+    const updatedCredential = await this.createVerifiableCredential({
+      unsignedCredential,
+      id,
+      issuer,
       proofFormat,
-      statusPurpose,
-      ttl,
-      validFrom,
-      validUntil
+      keyRef: args.keyRef
     }, context);
     return {
       statusListCredential: updatedCredential,
-      encodedList: updatedCredential.credentialSubject.encodedList,
+      encodedList: unsignedCredential.credentialSubject.encodedList,
       bitstringStatusList: {
         statusPurpose,
-        ...updatedCredential.validFrom && {
-          validFrom: new Date(updatedCredential.validFrom)
+        ...unsignedCredential.validFrom && {
+          validFrom: new Date(unsignedCredential.validFrom)
         },
-        ...updatedCredential.validUntil && {
-          validUntil: new Date(updatedCredential.validUntil)
+        ...unsignedCredential.validUntil && {
+          validUntil: new Date(unsignedCredential.validUntil)
         },
         bitsPerStatus: args.bitsPerStatus,
         ttl
@@ -941,17 +967,23 @@ var BitstringStatusListImplementation = class {
       statuslistContentType: this.buildContentType(proofFormat)
     };
   }
+  /**
+  * Updates a status list by decoding an encoded list, modifying it, and re-encoding
+  *
+  * @param args - Update parameters including encoded list, index, and new value
+  * @param context - Veramo agent context for credential operations
+  * @returns Promise resolving to the updated status list details
+  */
   async updateStatusListFromEncodedList(args, context) {
     if (!args.bitstringStatusList) {
       throw new Error("bitstringStatusList options required for type BitstringStatusList");
     }
     if (args.bitstringStatusList.bitsPerStatus < 1) {
-      return Promise.reject("bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (updateStatusListFromEncodedList)");
+      return Promise.reject(Error("bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (updateStatusListFromEncodedList)"));
     }
     const { statusPurpose, bitsPerStatus, ttl, validFrom, validUntil } = args.bitstringStatusList;
     const proofFormat = args?.proofFormat ?? DEFAULT_PROOF_FORMAT3;
     assertValidProofType(import_ssi_types5.StatusListType.BitstringStatusList, proofFormat);
-    const veramoProofFormat = proofFormat;
     const { issuer, id } = getAssertedValues(args);
     const statusList = await import_vc_bitstring_status_lists.BitstreamStatusList.decode({
       encodedList: args.encodedList,
@@ -959,29 +991,34 @@ var BitstringStatusListImplementation = class {
     });
     const index = typeof args.statusListIndex === "number" ? args.statusListIndex : parseInt(args.statusListIndex);
     statusList.setStatus(index, args.value);
-    const credential = await this.createVerifiableCredential({
+    const unsignedCredential = await (0, import_vc_bitstring_status_lists.createStatusListCredential)({
       id,
       issuer,
       statusList,
-      proofFormat: veramoProofFormat,
-      keyRef: args.keyRef,
-      statusPurpose,
+      statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
       validFrom: ensureDate(validFrom),
       validUntil: ensureDate(validUntil),
       ttl
+    });
+    const credential = await this.createVerifiableCredential({
+      unsignedCredential,
+      id,
+      issuer,
+      proofFormat,
+      keyRef: args.keyRef
     }, context);
     return {
       type: import_ssi_types5.StatusListType.BitstringStatusList,
       statusListCredential: credential,
-      encodedList: credential.credentialSubject.encodedList,
+      encodedList: unsignedCredential.credentialSubject.encodedList,
       bitstringStatusList: {
         statusPurpose,
         bitsPerStatus,
-        ...credential.validFrom && {
-          validFrom: new Date(credential.validFrom)
+        ...unsignedCredential.validFrom && {
+          validFrom: new Date(unsignedCredential.validFrom)
         },
-        ...credential.validUntil && {
-          validUntil: new Date(credential.validUntil)
+        ...unsignedCredential.validUntil && {
+          validUntil: new Date(unsignedCredential.validUntil)
         },
         ttl
       },
@@ -992,17 +1029,22 @@ var BitstringStatusListImplementation = class {
       statuslistContentType: this.buildContentType(proofFormat)
     };
   }
+  /**
+  * Checks the status of a specific credential by its index in the status list
+  *
+  * @param args - Check parameters including the status list credential and index
+  * @returns Promise resolving to the status value at the specified index
+  */
   async checkStatusIndex(args) {
     if (!args.bitsPerStatus || args.bitsPerStatus < 1) {
-      return Promise.reject("bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (checkStatusIndex)");
+      return Promise.reject(Error("bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (checkStatusIndex)"));
     }
     const uniform = import_ssi_types5.CredentialMapper.toUniformCredential(args.statusListCredential);
     const { credentialSubject } = uniform;
     const encodedList = getAssertedProperty("encodedList", credentialSubject);
-    const statusSize = args.bitsPerStatus;
     const statusList = await import_vc_bitstring_status_lists.BitstreamStatusList.decode({
       encodedList,
-      statusSize
+      statusSize: args.bitsPerStatus
     });
     const numIndex = typeof args.statusListIndex === "number" ? args.statusListIndex : parseInt(args.statusListIndex);
     if (statusList.getLength() <= numIndex) {
@@ -1010,16 +1052,22 @@ var BitstringStatusListImplementation = class {
     }
     return statusList.getStatus(numIndex);
   }
+  /**
+  * Converts a status list credential payload to detailed status list information
+  *
+  * @param args - Conversion parameters including the status list payload
+  * @returns Promise resolving to detailed status list information
+  */
   async toStatusListDetails(args) {
     const { statusListPayload, bitsPerStatus } = args;
     if (!bitsPerStatus || bitsPerStatus < 1) {
-      return Promise.reject("bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (toStatusListDetails)");
+      return Promise.reject(Error("bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (toStatusListDetails)"));
     }
     const uniform = import_ssi_types5.CredentialMapper.toUniformCredential(statusListPayload);
     const { issuer, credentialSubject } = uniform;
     const id = getAssertedValue("id", uniform.id);
     const encodedList = getAssertedProperty("encodedList", credentialSubject);
-    const proofFormat = import_ssi_types5.CredentialMapper.detectDocumentType(statusListPayload) === import_ssi_types5.DocumentFormat.JWT ? "jwt" : "lds";
+    const proofFormat = import_ssi_types5.CredentialMapper.detectDocumentType(statusListPayload) === import_ssi_types5.DocumentFormat.JWT ? "vc+jwt" : "lds";
     const credSubject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject;
     const statusPurpose = getAssertedProperty("statusPurpose", credSubject);
     const validFrom = uniform.validFrom ? new Date(uniform.validFrom) : void 0;
@@ -1073,6 +1121,12 @@ var BitstringStatusListImplementation = class {
       }
     };
   }
+  /**
+  * Creates a credential status entry for a specific credential in a status list
+  *
+  * @param args - Parameters including the status list, entry details, and index
+  * @returns Promise resolving to the credential status entry
+  */
   async createCredentialStatus(args) {
     const { statusList, statusListEntry, statusListIndex } = args;
     const isBitstringEntry = /* @__PURE__ */ __name((entry) => {
@@ -1091,27 +1145,42 @@ var BitstringStatusListImplementation = class {
       bitsPerStatus: bitstringStatusList.bitsPerStatus
     };
   }
+  /**
+  * Creates a signed verifiable credential from an unsigned status list credential
+  *
+  * @param args - Parameters including the unsigned credential and signing details
+  * @param context - Veramo agent context for credential operations
+  * @returns Promise resolving to the signed credential
+  */
   async createVerifiableCredential(args, context) {
+    const { unsignedCredential, issuer, proofFormat, keyRef } = args;
     const identifier = await context.agent.identifierManagedGet({
-      identifier: typeof args.issuer === "string" ? args.issuer : args.issuer.id,
+      identifier: typeof issuer === "string" ? issuer : issuer.id,
       vmRelationship: "assertionMethod",
       offlineWhenNoDIDRegistered: true
     });
-    const unsignedCredential = await (0, import_vc_bitstring_status_lists.createStatusListCredential)(args);
     const verifiableCredential = await context.agent.createVerifiableCredential({
       credential: unsignedCredential,
-      keyRef: args.keyRef ?? identifier.kmsKeyRef,
-      proofFormat: args.proofFormat,
+      keyRef: keyRef ?? identifier.kmsKeyRef,
+      proofFormat,
       fetchRemoteContexts: true
     });
     return import_ssi_types5.CredentialMapper.toWrappedVerifiableCredential(verifiableCredential).original;
   }
+  /**
+  * Builds the appropriate content type string for a given proof format
+  *
+  * @param proofFormat - The proof format to build content type for
+  * @returns The corresponding content type string
+  */
   buildContentType(proofFormat) {
     switch (proofFormat) {
       case "jwt":
-        return `application/statuslist+jwt`;
+        return "application/statuslist+jwt";
       case "cbor":
-        return `application/statuslist+cwt`;
+        return "application/statuslist+cwt";
+      case "vc+jwt":
+        return "application/statuslist+vc+jwt";
       case "lds":
         return "application/statuslist+ld+json";
       default:
@@ -1267,27 +1336,8 @@ async function updateStatusIndexFromStatusListCredential(args, context) {
   return implementation.updateStatusListIndex(args, context);
 }
 __name(updateStatusIndexFromStatusListCredential, "updateStatusIndexFromStatusListCredential");
-async function statusListCredentialToDetails({ correlationId, driverType, statusListCredential, bitsPerStatus }) {
+async function statusListCredentialToDetails({ statusListType, correlationId, driverType, statusListCredential, bitsPerStatus }) {
   const credential = getAssertedValue("statusListCredential", statusListCredential);
-  let statusListType;
-  const documentFormat = import_ssi_types7.CredentialMapper.detectDocumentType(credential);
-  if (documentFormat === import_ssi_types7.DocumentFormat.JWT) {
-    const [header] = credential.split(".");
-    const decodedHeader = JSON.parse(Buffer.from(header, "base64").toString());
-    if (decodedHeader.typ === "statuslist+jwt") {
-      statusListType = import_ssi_types7.StatusListType.OAuthStatusList;
-    }
-  } else if (documentFormat === import_ssi_types7.DocumentFormat.MSO_MDOC) {
-    statusListType = import_ssi_types7.StatusListType.OAuthStatusList;
-  }
-  if (!statusListType) {
-    const uniform = import_ssi_types7.CredentialMapper.toUniformCredential(credential);
-    const type = uniform.type.find((t) => t.includes("StatusList2021") || t.includes("OAuth2StatusList") || t.includes("BitstringStatusList"));
-    if (!type) {
-      throw new Error("Invalid status list credential type");
-    }
-    statusListType = type.replace("Credential", "");
-  }
   const implementation = getStatusListImplementation(statusListType);
   const result = await implementation.toStatusListDetails({
     statusListPayload: credential,