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

package/dist/index.js

@@ -15,7 +15,7 @@ var Status2021 = /* @__PURE__ */ function(Status20212) {
 }({});
 
 // src/functions.ts
-import { CredentialMapper as CredentialMapper3, DocumentFormat as DocumentFormat3, StatusListType as StatusListType5 } from "@sphereon/ssi-types";
+import { CredentialMapper as CredentialMapper4, DocumentFormat as DocumentFormat4, StatusListType as StatusListType6 } from "@sphereon/ssi-types";
 import { checkStatus } from "@sphereon/vc-status-list";
 
 // src/utils.ts
@@ -25,7 +25,8 @@ function getAssertedStatusListType(type) {
   const assertedType = type ?? StatusListType.StatusList2021;
   if (![
     StatusListType.StatusList2021,
-    StatusListType.OAuthStatusList
+    StatusListType.OAuthStatusList,
+    StatusListType.BitstringStatusList
   ].includes(assertedType)) {
     throw Error(`StatusList type ${assertedType} is not supported (yet)`);
   }
@@ -62,8 +63,7 @@ var ValidProofTypeMap = /* @__PURE__ */ new Map([
     StatusListType.StatusList2021,
     [
       "jwt",
-      "lds",
-      "EthereumEip712Signature2021"
+      "lds"
     ]
   ],
   [
@@ -72,6 +72,12 @@ var ValidProofTypeMap = /* @__PURE__ */ new Map([
       "jwt",
       "cbor"
     ]
+  ],
+  [
+    StatusListType.BitstringStatusList,
+    [
+      "lds"
+    ]
   ]
 ]);
 function assertValidProofType(type, proofFormat) {
@@ -214,7 +220,7 @@ var StatusList2021Implementation = class {
       encodedList: args.encodedList
     });
     const index = typeof args.statusListIndex === "number" ? args.statusListIndex : parseInt(args.statusListIndex);
-    statusList.setStatus(index, args.value);
+    statusList.setStatus(index, args.value !== 0);
     const newEncodedList = await statusList.encode();
     const credential = await this.createVerifiableCredential({
       id,
@@ -606,6 +612,9 @@ var OAuthStatusListImplementation = class {
     if (index < 0 || index >= statusList.statusList.length) {
       throw new Error("Status list index out of bounds");
     }
+    if (typeof value !== "number") {
+      throw new Error("Status list values should be of type number");
+    }
     statusList.setStatus(index, value);
     const { statusListCredential: signedCredential, encodedList } = await this.createSignedStatusList(proofFormat, context, statusList, issuer, id, expiresAt, keyRef);
     return {
@@ -633,7 +642,7 @@ var OAuthStatusListImplementation = class {
     const issuerString = typeof issuer === "string" ? issuer : issuer.id;
     const listToUpdate = StatusList4.decompressStatusList(args.encodedList, bitsPerStatus ?? DEFAULT_BITS_PER_STATUS);
     const index = typeof args.statusListIndex === "number" ? args.statusListIndex : parseInt(args.statusListIndex);
-    listToUpdate.setStatus(index, args.value ? 1 : 0);
+    listToUpdate.setStatus(index, args.value);
     const { statusListCredential, encodedList } = await this.createSignedStatusList(proofFormat ?? DEFAULT_PROOF_FORMAT2, context, listToUpdate, issuerString, id, expiresAt, keyRef);
     return {
       encodedList,
@@ -662,7 +671,7 @@ var OAuthStatusListImplementation = class {
     const { statusList } = proofFormat === "jwt" ? decodeStatusListJWT(statusListCredential) : decodeStatusListCWT(statusListCredential);
     const index = typeof statusListIndex === "number" ? statusListIndex : parseInt(statusListIndex);
     if (index < 0 || index >= statusList.statusList.length) {
-      throw new Error("Status list index out of bounds");
+      throw new Error(`Status list index out of bounds, has ${statusList.statusList.length} items, requested ${index}`);
     }
     return statusList.getStatus(index);
   }
@@ -709,7 +718,253 @@ var OAuthStatusListImplementation = class {
 };
 
 // src/impl/StatusListFactory.ts
-import { StatusListType as StatusListType4 } from "@sphereon/ssi-types";
+import { StatusListType as StatusListType5 } from "@sphereon/ssi-types";
+
+// src/impl/BitstringStatusListImplementation.ts
+import { CredentialMapper as CredentialMapper3, DocumentFormat as DocumentFormat3, StatusListType as StatusListType4 } from "@sphereon/ssi-types";
+import { BitstreamStatusList, createStatusListCredential } from "@4sure-tech/vc-bitstring-status-lists";
+var DEFAULT_LIST_LENGTH3 = 131072;
+var DEFAULT_PROOF_FORMAT3 = "lds";
+var DEFAULT_STATUS_PURPOSE = "revocation";
+var BitstringStatusListImplementation = class {
+  static {
+    __name(this, "BitstringStatusListImplementation");
+  }
+  async createNewStatusList(args, context) {
+    if (!args.bitstringStatusList) {
+      throw new Error("BitstringStatusList options are required for type BitstringStatusList");
+    }
+    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,
+      statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
+      validFrom,
+      validUntil,
+      ttl
+    }, context);
+    return {
+      encodedList: statusListCredential.credentialSubject.encodedList,
+      statusListCredential,
+      bitstringStatusList: {
+        statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
+        ...statusListCredential.validFrom && {
+          validFrom: new Date(statusListCredential.validFrom)
+        },
+        ...statusListCredential.validUntil && {
+          validUntil: new Date(statusListCredential.validUntil)
+        },
+        ttl,
+        bitsPerStatus
+      },
+      length,
+      type: StatusListType4.BitstringStatusList,
+      proofFormat,
+      id,
+      correlationId,
+      issuer,
+      statuslistContentType: this.buildContentType(proofFormat)
+    };
+  }
+  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)");
+    }
+    const credential = args.statusListCredential;
+    const uniform = CredentialMapper3.toUniformCredential(credential);
+    const { issuer, credentialSubject } = uniform;
+    const id = getAssertedValue("id", uniform.id);
+    const origEncodedList = getAssertedProperty("encodedList", credentialSubject);
+    const index = typeof args.statusListIndex === "number" ? args.statusListIndex : parseInt(args.statusListIndex);
+    const statusList = await BitstreamStatusList.decode({
+      encodedList: origEncodedList,
+      statusSize: args.bitsPerStatus
+    });
+    statusList.setStatus(index, args.value);
+    const proofFormat = CredentialMapper3.detectDocumentType(credential) === DocumentFormat3.JWT ? "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;
+    const validUntil = uniform.validUntil ? new Date(uniform.validUntil) : void 0;
+    const ttl = credSubject.ttl;
+    const updatedCredential = await this.createVerifiableCredential({
+      ...args,
+      id,
+      issuer,
+      statusList,
+      proofFormat,
+      statusPurpose,
+      ttl,
+      validFrom,
+      validUntil
+    }, context);
+    return {
+      statusListCredential: updatedCredential,
+      encodedList: updatedCredential.credentialSubject.encodedList,
+      bitstringStatusList: {
+        statusPurpose,
+        ...updatedCredential.validFrom && {
+          validFrom: new Date(updatedCredential.validFrom)
+        },
+        ...updatedCredential.validUntil && {
+          validUntil: new Date(updatedCredential.validUntil)
+        },
+        bitsPerStatus: args.bitsPerStatus,
+        ttl
+      },
+      length: statusList.getLength(),
+      type: StatusListType4.BitstringStatusList,
+      proofFormat,
+      id,
+      issuer,
+      statuslistContentType: this.buildContentType(proofFormat)
+    };
+  }
+  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)");
+    }
+    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,
+      statusSize: bitsPerStatus
+    });
+    const index = typeof args.statusListIndex === "number" ? args.statusListIndex : parseInt(args.statusListIndex);
+    statusList.setStatus(index, args.value);
+    const credential = await this.createVerifiableCredential({
+      id,
+      issuer,
+      statusList,
+      proofFormat: veramoProofFormat,
+      keyRef: args.keyRef,
+      statusPurpose,
+      validFrom,
+      validUntil,
+      ttl
+    }, context);
+    return {
+      type: StatusListType4.BitstringStatusList,
+      statusListCredential: credential,
+      encodedList: credential.credentialSubject.encodedList,
+      bitstringStatusList: {
+        statusPurpose,
+        bitsPerStatus,
+        ...credential.validFrom && {
+          validFrom: new Date(credential.validFrom)
+        },
+        ...credential.validUntil && {
+          validUntil: new Date(credential.validUntil)
+        },
+        ttl
+      },
+      length: statusList.getLength(),
+      proofFormat: args.proofFormat ?? "lds",
+      id,
+      issuer,
+      statuslistContentType: this.buildContentType(proofFormat)
+    };
+  }
+  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)");
+    }
+    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
+    });
+    const numIndex = typeof args.statusListIndex === "number" ? args.statusListIndex : parseInt(args.statusListIndex);
+    if (statusList.getLength() <= numIndex) {
+      throw new Error(`Status list index out of bounds, has ${statusList.getLength()} entries, requested ${numIndex}`);
+    }
+    return statusList.getStatus(numIndex);
+  }
+  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)");
+    }
+    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 credSubject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject;
+    const statusPurpose = getAssertedProperty("statusPurpose", credSubject);
+    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 statuslistLength = BitstreamStatusList.getStatusListLength(encodedList, bitsPerStatus);
+    return {
+      id,
+      encodedList,
+      issuer,
+      type: StatusListType4.BitstringStatusList,
+      proofFormat,
+      length: statuslistLength,
+      statusListCredential: statusListPayload,
+      statuslistContentType: this.buildContentType(proofFormat),
+      bitstringStatusList: {
+        statusPurpose,
+        bitsPerStatus,
+        validFrom,
+        validUntil,
+        ttl
+      },
+      ...args.correlationId && {
+        correlationId: args.correlationId
+      },
+      ...args.driverType && {
+        driverType: args.driverType
+      }
+    };
+  }
+  async createVerifiableCredential(args, context) {
+    const identifier = await context.agent.identifierManagedGet({
+      identifier: typeof args.issuer === "string" ? args.issuer : args.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,
+      fetchRemoteContexts: true
+    });
+    return CredentialMapper3.toWrappedVerifiableCredential(verifiableCredential).original;
+  }
+  buildContentType(proofFormat) {
+    switch (proofFormat) {
+      case "jwt":
+        return `application/statuslist+jwt`;
+      case "cbor":
+        return `application/statuslist+cwt`;
+      case "lds":
+        return "application/statuslist+ld+json";
+      default:
+        throw Error(`Unsupported content type '${proofFormat}' for status lists`);
+    }
+  }
+};
+
+// src/impl/StatusListFactory.ts
 var StatusListFactory = class _StatusListFactory {
   static {
     __name(this, "StatusListFactory");
@@ -718,8 +973,9 @@ var StatusListFactory = class _StatusListFactory {
   implementations;
   constructor() {
     this.implementations = /* @__PURE__ */ new Map();
-    this.implementations.set(StatusListType4.StatusList2021, new StatusList2021Implementation());
-    this.implementations.set(StatusListType4.OAuthStatusList, new OAuthStatusListImplementation());
+    this.implementations.set(StatusListType5.StatusList2021, new StatusList2021Implementation());
+    this.implementations.set(StatusListType5.OAuthStatusList, new OAuthStatusListImplementation());
+    this.implementations.set(StatusListType5.BitstringStatusList, new BitstringStatusListImplementation());
   }
   static getInstance() {
     if (!_StatusListFactory.instance) {
@@ -792,7 +1048,7 @@ __name(vcLibCheckStatusFunction, "vcLibCheckStatusFunction");
 async function checkStatusForCredential(args) {
   const verifyStatusListCredential = args.verifyStatusListCredential ?? true;
   const verifyMatchingIssuers = args.verifyMatchingIssuers ?? true;
-  const uniform = CredentialMapper3.toUniformCredential(args.credential);
+  const uniform = CredentialMapper4.toUniformCredential(args.credential);
   if (!("credentialStatus" in uniform) || !uniform.credentialStatus) {
     if (args.mandatoryCredentialStatus) {
       const error = "No credential status object found in the Verifiable Credential and it is mandatory";
@@ -807,7 +1063,7 @@ async function checkStatusForCredential(args) {
     };
   }
   if ("credentialStatus" in uniform && uniform.credentialStatus) {
-    if (uniform.credentialStatus.type === "StatusList2021Entry") {
+    if (uniform.credentialStatus.type === "StatusList2021Entry" || uniform.credentialStatus.type === "BitstringStatusListEntry") {
       return checkStatus({
         ...args,
         verifyStatusListCredential,
@@ -855,22 +1111,22 @@ async function updateStatusIndexFromStatusListCredential(args, context) {
   return implementation.updateStatusListIndex(args, context);
 }
 __name(updateStatusIndexFromStatusListCredential, "updateStatusIndexFromStatusListCredential");
-async function statusListCredentialToDetails(args) {
-  const credential = getAssertedValue("statusListCredential", args.statusListCredential);
+async function statusListCredentialToDetails({ correlationId, driverType, statusListCredential, bitsPerStatus }) {
+  const credential = getAssertedValue("statusListCredential", statusListCredential);
   let statusListType;
-  const documentFormat = CredentialMapper3.detectDocumentType(credential);
-  if (documentFormat === DocumentFormat3.JWT) {
+  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 = StatusListType5.OAuthStatusList;
+      statusListType = StatusListType6.OAuthStatusList;
     }
-  } else if (documentFormat === DocumentFormat3.MSO_MDOC) {
-    statusListType = StatusListType5.OAuthStatusList;
+  } else if (documentFormat === DocumentFormat4.MSO_MDOC) {
+    statusListType = StatusListType6.OAuthStatusList;
   }
   if (!statusListType) {
-    const uniform = CredentialMapper3.toUniformCredential(credential);
-    const type = uniform.type.find((t) => t.includes("StatusList2021") || t.includes("OAuth2StatusList"));
+    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");
     }
@@ -879,8 +1135,9 @@ async function statusListCredentialToDetails(args) {
   const implementation = getStatusListImplementation(statusListType);
   return await implementation.toStatusListDetails({
     statusListPayload: credential,
-    correlationId: args.correlationId,
-    driverType: args.driverType
+    correlationId,
+    driverType,
+    bitsPerStatus
   });
 }
 __name(statusListCredentialToDetails, "statusListCredentialToDetails");
@@ -898,7 +1155,7 @@ async function statusList2021ToVerifiableCredential(args, context) {
     offlineWhenNoDIDRegistered: true
   });
   const proofFormat = args?.proofFormat ?? "lds";
-  assertValidProofType(StatusListType5.StatusList2021, proofFormat);
+  assertValidProofType(StatusListType6.StatusList2021, proofFormat);
   const veramoProofFormat = proofFormat;
   const encodedList = getAssertedValue("encodedList", args.encodedList);
   const statusPurpose = getAssertedValue("statusPurpose", args.statusPurpose);
@@ -927,7 +1184,7 @@ async function statusList2021ToVerifiableCredential(args, context) {
     proofFormat: veramoProofFormat,
     fetchRemoteContexts: true
   });
-  return CredentialMapper3.toWrappedVerifiableCredential(verifiableCredential).original;
+  return CredentialMapper4.toWrappedVerifiableCredential(verifiableCredential).original;
 }
 __name(statusList2021ToVerifiableCredential, "statusList2021ToVerifiableCredential");
 export {