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

package/dist/index.d.cts

@@ -5,6 +5,7 @@ import { DataSource } from 'typeorm';
 import { BitsPerStatus } from '@sd-jwt/jwt-status-list';
 import { SdJwtVcPayload } from '@sd-jwt/sd-jwt-vc';
 import { StatusListOpts } from '@sphereon/oid4vci-common';
+import { BitstringStatusPurpose } from '@4sure-tech/vc-bitstring-status-lists';
 import { StatusMethod } from 'credential-status';
 
 declare enum StatusOAuth {
@@ -16,6 +17,7 @@ declare enum Status2021 {
     Valid = 0,
     Invalid = 1
 }
+type BitstringStatus = number;
 type StatusList2021Args = {
     indexingDirection: StatusListIndexingDirection;
     statusPurpose?: StatusPurpose2021;
@@ -24,6 +26,13 @@ type OAuthStatusListArgs = {
     bitsPerStatus?: BitsPerStatus;
     expiresAt?: Date;
 };
+type BitstringStatusListArgs = {
+    statusPurpose: BitstringStatusPurpose;
+    bitsPerStatus: number;
+    ttl?: number;
+    validFrom?: Date;
+    validUntil?: Date;
+};
 type BaseCreateNewStatusListArgs = {
     type: StatusListType;
     id: string;
@@ -34,6 +43,7 @@ type BaseCreateNewStatusListArgs = {
     keyRef?: string;
     statusList2021?: StatusList2021Args;
     oauthStatusList?: OAuthStatusListArgs;
+    bitstringStatusList?: BitstringStatusListArgs;
     driverType?: StatusListDriverType;
 };
 type UpdateStatusList2021Args = {
@@ -43,10 +53,17 @@ type UpdateOAuthStatusListArgs = {
     bitsPerStatus: BitsPerStatus;
     expiresAt?: Date;
 };
+type UpdateBitstringStatusListArgs = {
+    statusPurpose: BitstringStatusPurpose;
+    bitsPerStatus: number;
+    validFrom?: Date;
+    validUntil?: Date;
+    ttl?: number;
+};
 interface UpdateStatusListFromEncodedListArgs {
     type?: StatusListType;
     statusListIndex: number | string;
-    value: boolean;
+    value: number;
     proofFormat?: CredentialProofFormat;
     keyRef?: string;
     correlationId?: string;
@@ -55,12 +72,13 @@ interface UpdateStatusListFromEncodedListArgs {
     id: string;
     statusList2021?: UpdateStatusList2021Args;
     oauthStatusList?: UpdateOAuthStatusListArgs;
+    bitstringStatusList?: UpdateBitstringStatusListArgs;
 }
 interface UpdateStatusListFromStatusListCredentialArgs {
     statusListCredential: StatusListCredential;
     keyRef?: string;
     statusListIndex: number | string;
-    value: number | Status2021 | StatusOAuth;
+    value: number | Status2021 | StatusOAuth | BitstringStatus;
 }
 interface StatusListResult {
     encodedList: string;
@@ -73,6 +91,7 @@ interface StatusListResult {
     issuer: string | IIssuer;
     statusList2021?: StatusList2021Details;
     oauthStatusList?: OAuthStatusDetails;
+    bitstringStatusList?: BitstringStatusDetails;
     correlationId?: string;
     driverType?: StatusListDriverType;
     credentialIdMode?: StatusListCredentialIdMode;
@@ -85,6 +104,13 @@ interface OAuthStatusDetails {
     bitsPerStatus?: BitsPerStatus;
     expiresAt?: Date;
 }
+interface BitstringStatusDetails {
+    statusPurpose: BitstringStatusPurpose;
+    bitsPerStatus: number;
+    validFrom?: Date;
+    validUntil?: Date;
+    ttl?: number;
+}
 interface StatusList2021EntryCredentialStatus extends ICredentialStatus {
     type: 'StatusList2021Entry';
     statusPurpose: StatusPurpose2021;
@@ -98,6 +124,15 @@ interface StatusListOAuthEntryCredentialStatus extends ICredentialStatus {
     statusListCredential: string;
     expiresAt?: Date;
 }
+interface BitstringStatusListEntryCredentialStatus extends ICredentialStatus {
+    type: 'BitstringStatusListEntry';
+    statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[];
+    statusListIndex: string;
+    statusListCredential: string;
+    bitsPerStatus?: number;
+    statusMessage?: Array<BitstringStatus>;
+    statusReference?: string | string[];
+}
 interface StatusList2021ToVerifiableCredentialArgs {
     issuer: string | IIssuer;
     id: string;
@@ -116,22 +151,26 @@ interface CreateStatusListArgs {
     length?: number;
     statusList2021?: StatusList2021Args;
     oauthStatusList?: OAuthStatusListArgs;
+    bitstringStatusList?: BitstringStatusListArgs;
 }
 interface UpdateStatusListIndexArgs {
     statusListCredential: StatusListCredential;
     statusListIndex: number | string;
-    value: number | Status2021 | StatusOAuth;
+    value: number | Status2021 | StatusOAuth | BitstringStatus;
+    bitsPerStatus?: number;
     keyRef?: string;
     expiresAt?: Date;
 }
 interface CheckStatusIndexArgs {
     statusListCredential: StatusListCredential;
     statusListIndex: string | number;
+    bitsPerStatus?: number;
 }
 interface ToStatusListDetailsArgs {
     statusListPayload: StatusListCredential;
     correlationId?: string;
     driverType?: StatusListDriverType;
+    bitsPerStatus?: number;
 }
 /**
  * The interface definition for a plugin that can add statuslist info to a credential
@@ -254,22 +293,24 @@ declare function simpleCheckStatusFromStatusListUrl(args: {
     type?: StatusListType | 'StatusList2021Entry';
     id?: string;
     statusListIndex: string;
-}): Promise<number | Status2021 | StatusOAuth>;
+}): Promise<number | Status2021 | StatusOAuth | BitstringStatus>;
 declare function checkStatusIndexFromStatusListCredential(args: {
     statusListCredential: StatusListCredential;
     statusPurpose?: StatusPurpose2021;
-    type?: StatusListType | 'StatusList2021Entry';
+    type?: StatusListType | 'StatusList2021Entry' | 'BitstringStatusListEntry';
     id?: string;
     statusListIndex: string | number;
-}): Promise<number | Status2021 | StatusOAuth>;
+    bitsPerStatus?: number;
+}): Promise<number | Status2021 | StatusOAuth | BitstringStatus>;
 declare function createNewStatusList(args: CreateNewStatusListFuncArgs, context: IAgentContext<(ICredentialPlugin | any) & IIdentifierResolution>): Promise<StatusListResult>;
 declare function updateStatusIndexFromStatusListCredential(args: UpdateStatusListIndexArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
-declare function statusListCredentialToDetails(args: {
+declare function statusListCredentialToDetails({ correlationId, driverType, statusListCredential, bitsPerStatus, }: {
     statusListCredential: StatusListCredential;
     correlationId?: string;
     driverType?: StatusListDriverType;
+    bitsPerStatus?: number;
 }): Promise<StatusListResult>;
 declare function updateStatusListIndexFromEncodedList(args: UpdateStatusListFromEncodedListArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
 declare function statusList2021ToVerifiableCredential(args: StatusList2021ToVerifiableCredentialArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListCredential>;
 
-export { type BaseCreateNewStatusListArgs, type CheckStatusIndexArgs, type CreateNewStatusListArgs, type CreateNewStatusListFuncArgs, type CreateStatusListArgs, type CredentialWithStatusSupport, type GetStatusListArgs, type IAddStatusToCredentialArgs, type IAddStatusToSdJwtCredentialArgs, type IIssueCredentialStatusOpts, type IRequiredContext, type IRequiredPlugins, type IStatusListPlugin, type OAuthStatusListArgs, type SignedStatusListData, Status2021, type StatusList2021Args, type StatusList2021EntryCredentialStatus, type StatusList2021ToVerifiableCredentialArgs, type StatusListOAuthEntryCredentialStatus, type StatusListResult, StatusOAuth, type ToStatusListDetailsArgs, type UpdateOAuthStatusListArgs, type UpdateStatusList2021Args, type UpdateStatusListFromEncodedListArgs, type UpdateStatusListFromStatusListCredentialArgs, type UpdateStatusListIndexArgs, checkStatusForCredential, checkStatusIndexFromStatusListCredential, createNewStatusList, fetchStatusListCredential, simpleCheckStatusFromStatusListUrl, statusList2021ToVerifiableCredential, statusListCredentialToDetails, statusPluginStatusFunction, updateStatusIndexFromStatusListCredential, updateStatusListIndexFromEncodedList, vcLibCheckStatusFunction };
+export { type BaseCreateNewStatusListArgs, type BitstringStatus, type BitstringStatusListArgs, type BitstringStatusListEntryCredentialStatus, type CheckStatusIndexArgs, type CreateNewStatusListArgs, type CreateNewStatusListFuncArgs, type CreateStatusListArgs, type CredentialWithStatusSupport, type GetStatusListArgs, type IAddStatusToCredentialArgs, type IAddStatusToSdJwtCredentialArgs, type IIssueCredentialStatusOpts, type IRequiredContext, type IRequiredPlugins, type IStatusListPlugin, type OAuthStatusListArgs, type SignedStatusListData, Status2021, type StatusList2021Args, type StatusList2021EntryCredentialStatus, type StatusList2021ToVerifiableCredentialArgs, type StatusListOAuthEntryCredentialStatus, type StatusListResult, StatusOAuth, type ToStatusListDetailsArgs, type UpdateBitstringStatusListArgs, type UpdateOAuthStatusListArgs, type UpdateStatusList2021Args, type UpdateStatusListFromEncodedListArgs, type UpdateStatusListFromStatusListCredentialArgs, type UpdateStatusListIndexArgs, checkStatusForCredential, checkStatusIndexFromStatusListCredential, createNewStatusList, fetchStatusListCredential, simpleCheckStatusFromStatusListUrl, statusList2021ToVerifiableCredential, statusListCredentialToDetails, statusPluginStatusFunction, updateStatusIndexFromStatusListCredential, updateStatusListIndexFromEncodedList, vcLibCheckStatusFunction };

package/dist/index.d.ts

@@ -5,6 +5,7 @@ import { DataSource } from 'typeorm';
 import { BitsPerStatus } from '@sd-jwt/jwt-status-list';
 import { SdJwtVcPayload } from '@sd-jwt/sd-jwt-vc';
 import { StatusListOpts } from '@sphereon/oid4vci-common';
+import { BitstringStatusPurpose } from '@4sure-tech/vc-bitstring-status-lists';
 import { StatusMethod } from 'credential-status';
 
 declare enum StatusOAuth {
@@ -16,6 +17,7 @@ declare enum Status2021 {
     Valid = 0,
     Invalid = 1
 }
+type BitstringStatus = number;
 type StatusList2021Args = {
     indexingDirection: StatusListIndexingDirection;
     statusPurpose?: StatusPurpose2021;
@@ -24,6 +26,13 @@ type OAuthStatusListArgs = {
     bitsPerStatus?: BitsPerStatus;
     expiresAt?: Date;
 };
+type BitstringStatusListArgs = {
+    statusPurpose: BitstringStatusPurpose;
+    bitsPerStatus: number;
+    ttl?: number;
+    validFrom?: Date;
+    validUntil?: Date;
+};
 type BaseCreateNewStatusListArgs = {
     type: StatusListType;
     id: string;
@@ -34,6 +43,7 @@ type BaseCreateNewStatusListArgs = {
     keyRef?: string;
     statusList2021?: StatusList2021Args;
     oauthStatusList?: OAuthStatusListArgs;
+    bitstringStatusList?: BitstringStatusListArgs;
     driverType?: StatusListDriverType;
 };
 type UpdateStatusList2021Args = {
@@ -43,10 +53,17 @@ type UpdateOAuthStatusListArgs = {
     bitsPerStatus: BitsPerStatus;
     expiresAt?: Date;
 };
+type UpdateBitstringStatusListArgs = {
+    statusPurpose: BitstringStatusPurpose;
+    bitsPerStatus: number;
+    validFrom?: Date;
+    validUntil?: Date;
+    ttl?: number;
+};
 interface UpdateStatusListFromEncodedListArgs {
     type?: StatusListType;
     statusListIndex: number | string;
-    value: boolean;
+    value: number;
     proofFormat?: CredentialProofFormat;
     keyRef?: string;
     correlationId?: string;
@@ -55,12 +72,13 @@ interface UpdateStatusListFromEncodedListArgs {
     id: string;
     statusList2021?: UpdateStatusList2021Args;
     oauthStatusList?: UpdateOAuthStatusListArgs;
+    bitstringStatusList?: UpdateBitstringStatusListArgs;
 }
 interface UpdateStatusListFromStatusListCredentialArgs {
     statusListCredential: StatusListCredential;
     keyRef?: string;
     statusListIndex: number | string;
-    value: number | Status2021 | StatusOAuth;
+    value: number | Status2021 | StatusOAuth | BitstringStatus;
 }
 interface StatusListResult {
     encodedList: string;
@@ -73,6 +91,7 @@ interface StatusListResult {
     issuer: string | IIssuer;
     statusList2021?: StatusList2021Details;
     oauthStatusList?: OAuthStatusDetails;
+    bitstringStatusList?: BitstringStatusDetails;
     correlationId?: string;
     driverType?: StatusListDriverType;
     credentialIdMode?: StatusListCredentialIdMode;
@@ -85,6 +104,13 @@ interface OAuthStatusDetails {
     bitsPerStatus?: BitsPerStatus;
     expiresAt?: Date;
 }
+interface BitstringStatusDetails {
+    statusPurpose: BitstringStatusPurpose;
+    bitsPerStatus: number;
+    validFrom?: Date;
+    validUntil?: Date;
+    ttl?: number;
+}
 interface StatusList2021EntryCredentialStatus extends ICredentialStatus {
     type: 'StatusList2021Entry';
     statusPurpose: StatusPurpose2021;
@@ -98,6 +124,15 @@ interface StatusListOAuthEntryCredentialStatus extends ICredentialStatus {
     statusListCredential: string;
     expiresAt?: Date;
 }
+interface BitstringStatusListEntryCredentialStatus extends ICredentialStatus {
+    type: 'BitstringStatusListEntry';
+    statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[];
+    statusListIndex: string;
+    statusListCredential: string;
+    bitsPerStatus?: number;
+    statusMessage?: Array<BitstringStatus>;
+    statusReference?: string | string[];
+}
 interface StatusList2021ToVerifiableCredentialArgs {
     issuer: string | IIssuer;
     id: string;
@@ -116,22 +151,26 @@ interface CreateStatusListArgs {
     length?: number;
     statusList2021?: StatusList2021Args;
     oauthStatusList?: OAuthStatusListArgs;
+    bitstringStatusList?: BitstringStatusListArgs;
 }
 interface UpdateStatusListIndexArgs {
     statusListCredential: StatusListCredential;
     statusListIndex: number | string;
-    value: number | Status2021 | StatusOAuth;
+    value: number | Status2021 | StatusOAuth | BitstringStatus;
+    bitsPerStatus?: number;
     keyRef?: string;
     expiresAt?: Date;
 }
 interface CheckStatusIndexArgs {
     statusListCredential: StatusListCredential;
     statusListIndex: string | number;
+    bitsPerStatus?: number;
 }
 interface ToStatusListDetailsArgs {
     statusListPayload: StatusListCredential;
     correlationId?: string;
     driverType?: StatusListDriverType;
+    bitsPerStatus?: number;
 }
 /**
  * The interface definition for a plugin that can add statuslist info to a credential
@@ -254,22 +293,24 @@ declare function simpleCheckStatusFromStatusListUrl(args: {
     type?: StatusListType | 'StatusList2021Entry';
     id?: string;
     statusListIndex: string;
-}): Promise<number | Status2021 | StatusOAuth>;
+}): Promise<number | Status2021 | StatusOAuth | BitstringStatus>;
 declare function checkStatusIndexFromStatusListCredential(args: {
     statusListCredential: StatusListCredential;
     statusPurpose?: StatusPurpose2021;
-    type?: StatusListType | 'StatusList2021Entry';
+    type?: StatusListType | 'StatusList2021Entry' | 'BitstringStatusListEntry';
     id?: string;
     statusListIndex: string | number;
-}): Promise<number | Status2021 | StatusOAuth>;
+    bitsPerStatus?: number;
+}): Promise<number | Status2021 | StatusOAuth | BitstringStatus>;
 declare function createNewStatusList(args: CreateNewStatusListFuncArgs, context: IAgentContext<(ICredentialPlugin | any) & IIdentifierResolution>): Promise<StatusListResult>;
 declare function updateStatusIndexFromStatusListCredential(args: UpdateStatusListIndexArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
-declare function statusListCredentialToDetails(args: {
+declare function statusListCredentialToDetails({ correlationId, driverType, statusListCredential, bitsPerStatus, }: {
     statusListCredential: StatusListCredential;
     correlationId?: string;
     driverType?: StatusListDriverType;
+    bitsPerStatus?: number;
 }): Promise<StatusListResult>;
 declare function updateStatusListIndexFromEncodedList(args: UpdateStatusListFromEncodedListArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>;
 declare function statusList2021ToVerifiableCredential(args: StatusList2021ToVerifiableCredentialArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListCredential>;
 
-export { type BaseCreateNewStatusListArgs, type CheckStatusIndexArgs, type CreateNewStatusListArgs, type CreateNewStatusListFuncArgs, type CreateStatusListArgs, type CredentialWithStatusSupport, type GetStatusListArgs, type IAddStatusToCredentialArgs, type IAddStatusToSdJwtCredentialArgs, type IIssueCredentialStatusOpts, type IRequiredContext, type IRequiredPlugins, type IStatusListPlugin, type OAuthStatusListArgs, type SignedStatusListData, Status2021, type StatusList2021Args, type StatusList2021EntryCredentialStatus, type StatusList2021ToVerifiableCredentialArgs, type StatusListOAuthEntryCredentialStatus, type StatusListResult, StatusOAuth, type ToStatusListDetailsArgs, type UpdateOAuthStatusListArgs, type UpdateStatusList2021Args, type UpdateStatusListFromEncodedListArgs, type UpdateStatusListFromStatusListCredentialArgs, type UpdateStatusListIndexArgs, checkStatusForCredential, checkStatusIndexFromStatusListCredential, createNewStatusList, fetchStatusListCredential, simpleCheckStatusFromStatusListUrl, statusList2021ToVerifiableCredential, statusListCredentialToDetails, statusPluginStatusFunction, updateStatusIndexFromStatusListCredential, updateStatusListIndexFromEncodedList, vcLibCheckStatusFunction };
+export { type BaseCreateNewStatusListArgs, type BitstringStatus, type BitstringStatusListArgs, type BitstringStatusListEntryCredentialStatus, type CheckStatusIndexArgs, type CreateNewStatusListArgs, type CreateNewStatusListFuncArgs, type CreateStatusListArgs, type CredentialWithStatusSupport, type GetStatusListArgs, type IAddStatusToCredentialArgs, type IAddStatusToSdJwtCredentialArgs, type IIssueCredentialStatusOpts, type IRequiredContext, type IRequiredPlugins, type IStatusListPlugin, type OAuthStatusListArgs, type SignedStatusListData, Status2021, type StatusList2021Args, type StatusList2021EntryCredentialStatus, type StatusList2021ToVerifiableCredentialArgs, type StatusListOAuthEntryCredentialStatus, type StatusListResult, StatusOAuth, type ToStatusListDetailsArgs, type UpdateBitstringStatusListArgs, type UpdateOAuthStatusListArgs, type UpdateStatusList2021Args, type UpdateStatusListFromEncodedListArgs, type UpdateStatusListFromStatusListCredentialArgs, type UpdateStatusListIndexArgs, checkStatusForCredential, checkStatusIndexFromStatusListCredential, createNewStatusList, fetchStatusListCredential, simpleCheckStatusFromStatusListUrl, statusList2021ToVerifiableCredential, statusListCredentialToDetails, statusPluginStatusFunction, updateStatusIndexFromStatusListCredential, updateStatusListIndexFromEncodedList, vcLibCheckStatusFunction };