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

package/dist/index.d.cts

@@ -131,13 +131,6 @@ interface StatusListResult {
     statuslistContentType: string;
     correlationId?: string;
     driverType?: StatusListDriverType;
-    indexingDirection?: StatusListIndexingDirection;
-    statusPurpose?: StatusPurpose2021 | BitstringStatusPurpose | BitstringStatusPurpose[];
-    bitsPerStatus?: number;
-    expiresAt?: Date;
-    validFrom?: Date;
-    validUntil?: Date;
-    ttl?: number;
     statusList2021?: {
         indexingDirection: StatusListIndexingDirection;
         statusPurpose: StatusPurpose2021;
@@ -286,9 +279,19 @@ type SignedStatusListData = {
 type IRequiredPlugins = IVcdmCredentialPlugin & IIdentifierResolution;
 type IRequiredContext = IAgentContext<ICredentialIssuer & ICredentialVerifier & IIdentifierResolution & IKeyManager & IVcdmCredentialPlugin>;
 
+/**
+ * Fetches a status list credential from a URL
+ * @param args - Object containing the status list credential URL
+ * @returns Promise resolving to the fetched StatusListCredential
+ */
 declare function fetchStatusListCredential(args: {
     statusListCredential: string;
 }): Promise<StatusListCredential>;
+/**
+ * Creates a status checking function for credential-status plugin
+ * @param args - Configuration options for status verification
+ * @returns StatusMethod function for checking credential status
+ */
 declare function statusPluginStatusFunction(args: {
     documentLoader: any;
     suite: any;
@@ -299,7 +302,8 @@ declare function statusPluginStatusFunction(args: {
 }): StatusMethod;
 /**
  * Function that can be used together with @digitalbazar/vc and @digitialcredentials/vc
- * @param args
+ * @param args - Configuration options for status verification
+ * @returns Function for checking credential status
  */
 declare function vcLibCheckStatusFunction(args: {
     mandatoryCredentialStatus?: boolean;
@@ -314,6 +318,11 @@ declare function vcLibCheckStatusFunction(args: {
     verified: boolean;
     error?: any;
 }>;
+/**
+ * Checks the status of a credential using its credential status information
+ * @param args - Parameters for credential status verification
+ * @returns Promise resolving to verification result with error details if any
+ */
 declare function checkStatusForCredential(args: {
     credential: StatusListCredential;
     documentLoader: any;
@@ -333,6 +342,11 @@ declare function simpleCheckStatusFromStatusListUrl(args: {
     id?: string;
     statusListIndex: string;
 }): Promise<number | Status2021 | StatusOAuth>;
+/**
+ * Checks the status at a specific index in a status list credential
+ * @param args - Parameters including credential and index to check
+ * @returns Promise resolving to status value at the specified index
+ */
 declare function checkStatusIndexFromStatusListCredential(args: {
     statusListCredential: StatusListCredential;
     statusPurpose?: StatusPurpose2021 | string | string[];
@@ -342,16 +356,44 @@ declare function checkStatusIndexFromStatusListCredential(args: {
     bitsPerStatus?: number;
 }): Promise<number | Status2021 | StatusOAuth>;
 declare function createNewStatusList(args: CreateNewStatusListFuncArgs, context: IAgentContext<(IVcdmCredentialPlugin | any) & IIdentifierResolution>): Promise<StatusListResult>;
+/**
+ * Updates a status index in a status list credential
+ * @param args - Parameters for status update including credential and new value
+ * @param context - Agent context with required plugins
+ * @returns Promise resolving to updated status list details
+ */
 declare function updateStatusIndexFromStatusListCredential(args: UpdateStatusListIndexArgs, context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
+/**
+ * Extracts credential details from a status list credential
+ * @param statusListCredential - The status list credential to extract from
+ * @returns Promise resolving to extracted credential details
+ */
 declare function extractCredentialDetails(statusListCredential: StatusListCredential): Promise<IExtractedCredentialDetails>;
 declare function toStatusListDetails(args: IToDetailsFromCredentialArgs): Promise<StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)>;
 declare function toStatusListDetails(args: IMergeDetailsWithEntityArgs): Promise<StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)>;
+/**
+ * Creates a credential status object from status list and entry information
+ * @param args - Parameters including status list, entry, and index
+ * @returns Promise resolving to appropriate credential status type
+ */
 declare function createCredentialStatusFromStatusList(args: {
     statusList: StatusListEntity;
     statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity;
     statusListIndex: number;
 }): Promise<StatusList2021EntryCredentialStatus | StatusListOAuthEntryCredentialStatus | BitstringStatusListEntryCredentialStatus>;
+/**
+ * Updates a status list using a base64 encoded list of statuses
+ * @param args - Parameters including encoded list and update details
+ * @param context - Agent context with required plugins
+ * @returns Promise resolving to updated status list details
+ */
 declare function updateStatusListIndexFromEncodedList(args: UpdateStatusListFromEncodedListArgs, context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
+/**
+ * Converts a StatusList2021 to a verifiable credential
+ * @param args - Parameters for credential creation including issuer and encoded list
+ * @param context - Agent context with required plugins
+ * @returns Promise resolving to signed status list credential
+ */
 declare function statusList2021ToVerifiableCredential(args: StatusList2021ToVerifiableCredentialArgs, context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>): Promise<StatusListCredential>;
 
 declare function determineStatusListType(credential: StatusListCredential): StatusListType;

package/dist/index.d.ts

@@ -131,13 +131,6 @@ interface StatusListResult {
     statuslistContentType: string;
     correlationId?: string;
     driverType?: StatusListDriverType;
-    indexingDirection?: StatusListIndexingDirection;
-    statusPurpose?: StatusPurpose2021 | BitstringStatusPurpose | BitstringStatusPurpose[];
-    bitsPerStatus?: number;
-    expiresAt?: Date;
-    validFrom?: Date;
-    validUntil?: Date;
-    ttl?: number;
     statusList2021?: {
         indexingDirection: StatusListIndexingDirection;
         statusPurpose: StatusPurpose2021;
@@ -286,9 +279,19 @@ type SignedStatusListData = {
 type IRequiredPlugins = IVcdmCredentialPlugin & IIdentifierResolution;
 type IRequiredContext = IAgentContext<ICredentialIssuer & ICredentialVerifier & IIdentifierResolution & IKeyManager & IVcdmCredentialPlugin>;
 
+/**
+ * Fetches a status list credential from a URL
+ * @param args - Object containing the status list credential URL
+ * @returns Promise resolving to the fetched StatusListCredential
+ */
 declare function fetchStatusListCredential(args: {
     statusListCredential: string;
 }): Promise<StatusListCredential>;
+/**
+ * Creates a status checking function for credential-status plugin
+ * @param args - Configuration options for status verification
+ * @returns StatusMethod function for checking credential status
+ */
 declare function statusPluginStatusFunction(args: {
     documentLoader: any;
     suite: any;
@@ -299,7 +302,8 @@ declare function statusPluginStatusFunction(args: {
 }): StatusMethod;
 /**
  * Function that can be used together with @digitalbazar/vc and @digitialcredentials/vc
- * @param args
+ * @param args - Configuration options for status verification
+ * @returns Function for checking credential status
  */
 declare function vcLibCheckStatusFunction(args: {
     mandatoryCredentialStatus?: boolean;
@@ -314,6 +318,11 @@ declare function vcLibCheckStatusFunction(args: {
     verified: boolean;
     error?: any;
 }>;
+/**
+ * Checks the status of a credential using its credential status information
+ * @param args - Parameters for credential status verification
+ * @returns Promise resolving to verification result with error details if any
+ */
 declare function checkStatusForCredential(args: {
     credential: StatusListCredential;
     documentLoader: any;
@@ -333,6 +342,11 @@ declare function simpleCheckStatusFromStatusListUrl(args: {
     id?: string;
     statusListIndex: string;
 }): Promise<number | Status2021 | StatusOAuth>;
+/**
+ * Checks the status at a specific index in a status list credential
+ * @param args - Parameters including credential and index to check
+ * @returns Promise resolving to status value at the specified index
+ */
 declare function checkStatusIndexFromStatusListCredential(args: {
     statusListCredential: StatusListCredential;
     statusPurpose?: StatusPurpose2021 | string | string[];
@@ -342,16 +356,44 @@ declare function checkStatusIndexFromStatusListCredential(args: {
     bitsPerStatus?: number;
 }): Promise<number | Status2021 | StatusOAuth>;
 declare function createNewStatusList(args: CreateNewStatusListFuncArgs, context: IAgentContext<(IVcdmCredentialPlugin | any) & IIdentifierResolution>): Promise<StatusListResult>;
+/**
+ * Updates a status index in a status list credential
+ * @param args - Parameters for status update including credential and new value
+ * @param context - Agent context with required plugins
+ * @returns Promise resolving to updated status list details
+ */
 declare function updateStatusIndexFromStatusListCredential(args: UpdateStatusListIndexArgs, context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
+/**
+ * Extracts credential details from a status list credential
+ * @param statusListCredential - The status list credential to extract from
+ * @returns Promise resolving to extracted credential details
+ */
 declare function extractCredentialDetails(statusListCredential: StatusListCredential): Promise<IExtractedCredentialDetails>;
 declare function toStatusListDetails(args: IToDetailsFromCredentialArgs): Promise<StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)>;
 declare function toStatusListDetails(args: IMergeDetailsWithEntityArgs): Promise<StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)>;
+/**
+ * Creates a credential status object from status list and entry information
+ * @param args - Parameters including status list, entry, and index
+ * @returns Promise resolving to appropriate credential status type
+ */
 declare function createCredentialStatusFromStatusList(args: {
     statusList: StatusListEntity;
     statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity;
     statusListIndex: number;
 }): Promise<StatusList2021EntryCredentialStatus | StatusListOAuthEntryCredentialStatus | BitstringStatusListEntryCredentialStatus>;
+/**
+ * Updates a status list using a base64 encoded list of statuses
+ * @param args - Parameters including encoded list and update details
+ * @param context - Agent context with required plugins
+ * @returns Promise resolving to updated status list details
+ */
 declare function updateStatusListIndexFromEncodedList(args: UpdateStatusListFromEncodedListArgs, context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
+/**
+ * Converts a StatusList2021 to a verifiable credential
+ * @param args - Parameters for credential creation including issuer and encoded list
+ * @param context - Agent context with required plugins
+ * @returns Promise resolving to signed status list credential
+ */
 declare function statusList2021ToVerifiableCredential(args: StatusList2021ToVerifiableCredentialArgs, context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>): Promise<StatusListCredential>;
 
 declare function determineStatusListType(credential: StatusListCredential): StatusListType;

package/dist/index.js

@@ -297,6 +297,11 @@ var StatusList2021Implementation = class {
     const status = statusList.getStatus(typeof args.statusListIndex === "number" ? args.statusListIndex : parseInt(args.statusListIndex));
     return status ? Status2021.Invalid : Status2021.Valid;
   }
+  /**
+  * Performs the initial parsing of a StatusListCredential.
+  * This method handles expensive operations like JWT/CWT decoding once.
+  * It extracts all details available from the credential payload itself.
+  */
   async extractCredentialDetails(credential) {
     const uniform = CredentialMapper2.toUniformCredential(credential);
     const { issuer, credentialSubject } = uniform;
@@ -765,6 +770,11 @@ var OAuthStatusListImplementation = class {
     }
     return statusList.getStatus(index);
   }
+  /**
+  * Performs the initial parsing of a StatusListCredential.
+  * This method handles expensive operations like JWT/CWT decoding once.
+  * It extracts all details available from the credential payload itself.
+  */
   async extractCredentialDetails(credential) {
     if (typeof credential !== "string") {
       return Promise.reject("statusListCredential must be a JWT or CWT string");
@@ -1089,6 +1099,11 @@ var BitstringStatusListImplementation = class {
     }
     return statusList.getStatus(numIndex);
   }
+  /**
+  * Performs the initial parsing of a StatusListCredential.
+  * This method handles expensive operations like JWT/CWT decoding once.
+  * It extracts all details available from the credential payload itself.
+  */
   async extractCredentialDetails(credential) {
     const uniform = CredentialMapper3.toUniformCredential(credential);
     const { issuer, credentialSubject } = uniform;