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

package/dist/index.js

@@ -15,7 +15,7 @@ var Status2021 = /* @__PURE__ */ function(Status20212) {
 }({});
 
 // src/functions.ts
-import { CredentialMapper as CredentialMapper4, DocumentFormat as DocumentFormat4, StatusListType as StatusListType6 } from "@sphereon/ssi-types";
+import { CredentialMapper as CredentialMapper4, StatusListType as StatusListType6 } from "@sphereon/ssi-types";
 import { checkStatus } from "@sphereon/vc-status-list";
 
 // src/utils.ts
@@ -76,7 +76,8 @@ var ValidProofTypeMap = /* @__PURE__ */ new Map([
   [
     StatusListType.BitstringStatusList,
     [
-      "lds"
+      "lds",
+      "vc+jwt"
     ]
   ]
 ]);
@@ -211,13 +212,14 @@ var StatusList2021Implementation = class {
       encodedList,
       proofFormat
     }, context);
+    if (!("statusPurpose" in credentialSubject)) {
+      return Promise.reject(Error("statusPurpose is required in credentialSubject for StatusList2021"));
+    }
     return {
       statusListCredential: updatedCredential,
       encodedList,
       statusList2021: {
-        ..."statusPurpose" in credentialSubject ? {
-          statusPurpose: credentialSubject.statusPurpose
-        } : {},
+        statusPurpose: credentialSubject.statusPurpose,
         indexingDirection: "rightToLeft"
       },
       length: statusList.length - 1,
@@ -282,10 +284,12 @@ var StatusList2021Implementation = class {
     const encodedList = getAssertedProperty("encodedList", credentialSubject);
     const proofFormat = CredentialMapper2.detectDocumentType(statusListPayload) === DocumentFormat2.JWT ? "jwt" : "lds";
     const statusPurpose = getAssertedProperty("statusPurpose", credentialSubject);
+    const indexingDirection = "rightToLeft";
     const list = await StatusList.decode({
       encodedList
     });
     return {
+      // Base implementation fields
       id,
       encodedList,
       issuer,
@@ -294,18 +298,36 @@ var StatusList2021Implementation = class {
       length: list.length,
       statusListCredential: statusListPayload,
       statuslistContentType: this.buildContentType(proofFormat),
+      correlationId: args.correlationId,
+      driverType: args.driverType,
+      // Flattened StatusList2021-specific fields
+      indexingDirection,
+      statusPurpose,
+      // Legacy nested structure for backward compatibility
       statusList2021: {
-        indexingDirection: "rightToLeft",
-        statusPurpose
-      },
-      ...args.correlationId && {
-        correlationId: args.correlationId
-      },
-      ...args.driverType && {
-        driverType: args.driverType
+        indexingDirection,
+        statusPurpose,
+        // Optional fields from args
+        ...args.correlationId && {
+          correlationId: args.correlationId
+        },
+        ...args.driverType && {
+          driverType: args.driverType
+        }
       }
     };
   }
+  async createCredentialStatus(args) {
+    const { statusList, statusListIndex } = args;
+    const statusList2021 = statusList;
+    return {
+      id: `${statusList.id}#${statusListIndex}`,
+      type: "StatusList2021Entry",
+      statusPurpose: statusList2021.statusPurpose ?? "revocation",
+      statusListIndex: "" + statusListIndex,
+      statusListCredential: statusList.id
+    };
+  }
   async createVerifiableCredential(args, context) {
     const identifier = await context.agent.identifierManagedGet({
       identifier: typeof args.issuer === "string" ? args.issuer : args.issuer.id,
@@ -682,9 +704,6 @@ var OAuthStatusListImplementation = class {
       statuslistContentType: this.buildContentType(proofFormat)
     };
   }
-  buildContentType(proofFormat) {
-    return `application/statuslist+${proofFormat === "cbor" ? "cwt" : "jwt"}`;
-  }
   async checkStatusIndex(args) {
     const { statusListCredential, statusListIndex } = args;
     if (typeof statusListCredential !== "string") {
@@ -703,7 +722,10 @@ var OAuthStatusListImplementation = class {
     const proofFormat = determineProofFormat(statusListPayload);
     const decoded = proofFormat === "jwt" ? decodeStatusListJWT(statusListPayload) : decodeStatusListCWT(statusListPayload);
     const { statusList, issuer, id, exp } = decoded;
+    const bitsPerStatus = statusList.getBitsPerStatus();
+    const expiresAt = exp ? new Date(exp * 1e3) : void 0;
     return {
+      // Base implementation fields
       id,
       encodedList: statusList.compressStatusList(),
       issuer,
@@ -712,12 +734,21 @@ var OAuthStatusListImplementation = class {
       length: statusList.statusList.length,
       statusListCredential: statusListPayload,
       statuslistContentType: this.buildContentType(proofFormat),
+      correlationId: args.correlationId,
+      driverType: args.driverType,
+      // Flattened OAuth-specific fields
+      bitsPerStatus,
+      ...expiresAt && {
+        expiresAt
+      },
+      // Legacy nested structure for backward compatibility
       oauthStatusList: {
-        bitsPerStatus: statusList.getBitsPerStatus(),
-        ...exp && {
-          expiresAt: new Date(exp * 1e3)
+        bitsPerStatus,
+        ...expiresAt && {
+          expiresAt
         }
       },
+      // Optional fields from args
       ...args.correlationId && {
         correlationId: args.correlationId
       },
@@ -726,6 +757,21 @@ var OAuthStatusListImplementation = class {
       }
     };
   }
+  async createCredentialStatus(args) {
+    const { statusList, statusListIndex } = args;
+    const oauthStatusList = statusList;
+    return {
+      id: `${statusList.id}#${statusListIndex}`,
+      type: "OAuthStatusListEntry",
+      bitsPerStatus: oauthStatusList.bitsPerStatus,
+      statusListIndex: "" + statusListIndex,
+      statusListCredential: statusList.id,
+      expiresAt: oauthStatusList.expiresAt
+    };
+  }
+  buildContentType(proofFormat) {
+    return `application/statuslist+${proofFormat === "cbor" ? "cwt" : "jwt"}`;
+  }
   async createSignedStatusList(proofFormat, context, statusList, issuerString, id, expiresAt, keyRef) {
     switch (proofFormat) {
       case "jwt": {
@@ -753,6 +799,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");
@@ -760,28 +813,34 @@ var BitstringStatusListImplementation = class {
     const length = args?.length ?? DEFAULT_LIST_LENGTH3;
     const proofFormat = args?.proofFormat ?? DEFAULT_PROOF_FORMAT3;
     assertValidProofType(StatusListType4.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 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
@@ -795,9 +854,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 = CredentialMapper3.toUniformCredential(credential);
@@ -816,27 +882,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 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
@@ -849,17 +920,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(StatusListType4.BitstringStatusList, proofFormat);
-    const veramoProofFormat = proofFormat;
     const { issuer, id } = getAssertedValues(args);
     const statusList = await BitstreamStatusList.decode({
       encodedList: args.encodedList,
@@ -867,29 +944,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 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: StatusListType4.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
       },
@@ -900,17 +982,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 = CredentialMapper3.toUniformCredential(args.statusListCredential);
     const { credentialSubject } = uniform;
     const encodedList = getAssertedProperty("encodedList", credentialSubject);
-    const statusSize = args.bitsPerStatus;
     const statusList = await BitstreamStatusList.decode({
       encodedList,
-      statusSize
+      statusSize: args.bitsPerStatus
     });
     const numIndex = typeof args.statusListIndex === "number" ? args.statusListIndex : parseInt(args.statusListIndex);
     if (statusList.getLength() <= numIndex) {
@@ -918,16 +1005,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 = CredentialMapper3.toUniformCredential(statusListPayload);
     const { issuer, credentialSubject } = uniform;
     const id = getAssertedValue("id", uniform.id);
     const encodedList = getAssertedProperty("encodedList", credentialSubject);
-    const proofFormat = CredentialMapper3.detectDocumentType(statusListPayload) === DocumentFormat3.JWT ? "jwt" : "lds";
+    const proofFormat = CredentialMapper3.detectDocumentType(statusListPayload) === DocumentFormat3.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;
@@ -935,6 +1028,7 @@ var BitstringStatusListImplementation = class {
     const ttl = credSubject.ttl;
     const statuslistLength = BitstreamStatusList.getStatusListLength(encodedList, bitsPerStatus);
     return {
+      // Base implementation fields
       id,
       encodedList,
       issuer,
@@ -943,13 +1037,35 @@ var BitstringStatusListImplementation = class {
       length: statuslistLength,
       statusListCredential: statusListPayload,
       statuslistContentType: this.buildContentType(proofFormat),
+      correlationId: args.correlationId,
+      driverType: args.driverType,
+      // Flattened Bitstring-specific fields
+      statusPurpose,
+      bitsPerStatus,
+      ...validFrom && {
+        validFrom
+      },
+      ...validUntil && {
+        validUntil
+      },
+      ...ttl && {
+        ttl
+      },
+      // Legacy nested structure for backward compatibility
       bitstringStatusList: {
         statusPurpose,
         bitsPerStatus,
-        validFrom,
-        validUntil,
-        ttl
+        ...validFrom && {
+          validFrom
+        },
+        ...validUntil && {
+          validUntil
+        },
+        ...ttl && {
+          ttl
+        }
       },
+      // Optional fields from args
       ...args.correlationId && {
         correlationId: args.correlationId
       },
@@ -958,27 +1074,66 @@ 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) => {
+      return "statusPurpose" in entry;
+    }, "isBitstringEntry");
+    if (!isBitstringEntry(statusListEntry)) {
+      throw new Error("Expected bitstring status list entry for bitstring status list");
+    }
+    const bitstringStatusList = statusList;
+    return {
+      id: `${statusList.id}#${statusListIndex}`,
+      type: "BitstringStatusListEntry",
+      statusPurpose: statusListEntry.statusPurpose,
+      statusListIndex: "" + statusListIndex,
+      statusListCredential: statusList.id,
+      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 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 CredentialMapper3.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:
@@ -1134,36 +1289,29 @@ 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 = CredentialMapper4.detectDocumentType(credential);
-  if (documentFormat === DocumentFormat4.JWT) {
-    const [header] = credential.split(".");
-    const decodedHeader = JSON.parse(Buffer.from(header, "base64").toString());
-    if (decodedHeader.typ === "statuslist+jwt") {
-      statusListType = StatusListType6.OAuthStatusList;
-    }
-  } else if (documentFormat === DocumentFormat4.MSO_MDOC) {
-    statusListType = StatusListType6.OAuthStatusList;
-  }
-  if (!statusListType) {
-    const uniform = CredentialMapper4.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);
-  return await implementation.toStatusListDetails({
+  const result = await implementation.toStatusListDetails({
     statusListPayload: credential,
     correlationId,
     driverType,
     bitsPerStatus
   });
+  return result;
 }
 __name(statusListCredentialToDetails, "statusListCredentialToDetails");
+async function createCredentialStatusFromStatusList(args) {
+  const { statusList, statusListEntry, statusListIndex } = args;
+  const statusListType = determineStatusListType(statusList.statusListCredential);
+  const implementation = getStatusListImplementation(statusListType);
+  return implementation.createCredentialStatus({
+    statusList,
+    statusListEntry,
+    statusListIndex
+  });
+}
+__name(createCredentialStatusFromStatusList, "createCredentialStatusFromStatusList");
 async function updateStatusListIndexFromEncodedList(args, context) {
   const { type } = getAssertedValue("type", args);
   const implementation = getStatusListImplementation(type);
@@ -1215,6 +1363,7 @@ export {
   StatusOAuth,
   checkStatusForCredential,
   checkStatusIndexFromStatusListCredential,
+  createCredentialStatusFromStatusList,
   createNewStatusList,
   fetchStatusListCredential,
   simpleCheckStatusFromStatusListUrl,