@sphereon/ssi-sdk.vc-status-list-issuer-drivers 0.34.1-feature.SSISDK.17.bitstring.sl.2 → 0.34.1-feature.SSISDK.17.bitstring.sl.24

package/dist/index.d.cts

@@ -1,11 +1,34 @@
 import { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution';
-import { StatusListStore, IAddStatusListEntryArgs, IStatusListEntryEntity, IGetStatusListEntryByCredentialIdArgs, IGetStatusListEntryByIndexArgs } from '@sphereon/ssi-sdk.data-store';
-import { StatusListResult, StatusList2021EntryCredentialStatus, StatusListOAuthEntryCredentialStatus, BitstringStatusListEntryCredentialStatus, IStatusListPlugin } from '@sphereon/ssi-sdk.vc-status-list';
-import { StatusListDriverType, StatusListCredential, StatusListCredentialIdMode, StatusListType } from '@sphereon/ssi-types';
-import { IDataStoreORM, IDIDManager, IKeyManager, ICredentialIssuer, ICredentialVerifier, ICredentialPlugin, IResolver, IAgentContext } from '@veramo/core';
+import { StatusListStore, IAddStatusListEntryArgs, BitstringStatusListEntryCredentialStatus, IStatusListEntryEntity, IBitstringStatusListEntryEntity, IGetStatusListEntryByCredentialIdArgs, IGetStatusListEntryByIndexArgs } from '@sphereon/ssi-sdk.data-store';
+import { StatusListResult, StatusList2021EntryCredentialStatus, StatusListOAuthEntryCredentialStatus, IStatusListPlugin } from '@sphereon/ssi-sdk.vc-status-list';
+import { StatusListDriverType, StatusListType, StatusListCredential, StatusListCredentialIdMode } from '@sphereon/ssi-types';
+import { IDataStoreORM, IDIDManager, IKeyManager, ICredentialIssuer, ICredentialVerifier, IResolver, IAgentContext } from '@veramo/core';
 import { DataSources } from '@sphereon/ssi-sdk.agent-config';
 import { DataSource } from 'typeorm';
+import { IVcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm';
 
+/**
+ * StatusList Driver Implementation for TypeORM/Agent Data Sources
+ *
+ * This module provides the database-backed implementation of the IStatusListDriver interface,
+ * handling persistence and retrieval of status list credentials and entries using TypeORM.
+ * It delegates status list format-specific operations to the functions layer while managing
+ * database interactions, driver configuration, and entity lifecycle.
+ *
+ * Key responsibilities:
+ * - Database connection and store management
+ * - Status list CRUD operations
+ * - Status list entry management
+ * - Random index generation for new entries
+ * - Integration with multiple data sources
+ *
+ * @author Sphereon International B.V.
+ * @since 2024
+ */
+
+/**
+ * Configuration options for status list management
+ */
 interface StatusListManagementOptions {
     id?: string;
     correlationId?: string;
@@ -13,17 +36,33 @@ interface StatusListManagementOptions {
     driverOptions?: DriverOptions;
 }
 type DriverOptions = TypeORMOptions;
+/**
+ * TypeORM-specific configuration options
+ */
 interface TypeORMOptions {
     dbName?: string;
 }
+/**
+ * Filesystem-specific configuration options
+ */
 interface FilesystemOptions {
     path: string;
 }
+/**
+ * Creates status list management options for TypeORM driver
+ * @param args - Configuration parameters including id, correlationId, and database name
+ * @returns StatusListManagementOptions configured for TypeORM
+ */
 declare function getOptions(args: {
     id?: string;
     correlationId?: string;
     dbName: string;
 }): StatusListManagementOptions;
+/**
+ * Creates and initializes a status list driver instance
+ * @param args - Configuration parameters including database connection details
+ * @returns Promise resolving to initialized IStatusListDriver instance
+ */
 declare function getDriver(args: {
     id?: string;
     correlationId?: string;
@@ -31,55 +70,145 @@ declare function getDriver(args: {
     dataSource?: DataSource;
     dataSources?: DataSources;
 }): Promise<IStatusListDriver>;
+/**
+ * TypeORM-based implementation of the IStatusListDriver interface
+ *
+ * Manages status list credentials and entries using a TypeORM data source.
+ * Handles database operations while delegating format-specific logic to the functions layer.
+ */
 declare class AgentDataSourceStatusListDriver implements IStatusListDriver {
     private _dataSource;
     private _statusListStore;
     private options;
     private _statusListLength;
+    /**
+     * Creates a new AgentDataSourceStatusListDriver instance
+     * @param _dataSource - TypeORM DataSource for database operations
+     * @param _statusListStore - StatusListStore for data persistence
+     * @param options - Driver configuration options
+     */
     constructor(_dataSource: DataSource, _statusListStore: StatusListStore, options: StatusListManagementOptions);
+    /**
+     * Initializes and creates a new AgentDataSourceStatusListDriver instance
+     * @param options - Status list management configuration
+     * @param dbArgs - Database connection arguments
+     * @returns Promise resolving to initialized driver instance
+     */
     static init(options: StatusListManagementOptions, dbArgs?: {
         dataSources?: DataSources;
         dataSource?: DataSource;
     }): Promise<AgentDataSourceStatusListDriver>;
+    /**
+     * Gets the TypeORM DataSource instance
+     * @returns DataSource instance for database operations
+     */
     get dataSource(): DataSource;
+    /**
+     * Gets the StatusListStore instance
+     * @returns StatusListStore for data persistence operations
+     */
     get statusListStore(): StatusListStore;
+    /**
+     * Gets the driver configuration options
+     * @returns DriverOptions configuration
+     */
     getOptions(): DriverOptions;
+    /**
+     * Gets the driver type
+     * @returns StatusListDriverType enum value
+     */
     getType(): StatusListDriverType;
+    /**
+     * Creates a new status list credential and stores it in the database
+     * @param args - Status list creation parameters
+     * @returns Promise resolving to StatusListResult
+     */
     createStatusList(args: {
+        statusListType: StatusListType;
         statusListCredential: StatusListCredential;
         correlationId?: string;
         credentialIdMode?: StatusListCredentialIdMode;
+        bitsPerStatus?: number;
     }): Promise<StatusListResult>;
+    /**
+     * Updates an existing status list credential in the database
+     * @param args - Status list update parameters
+     * @returns Promise resolving to StatusListResult
+     */
     updateStatusList(args: {
         statusListCredential: StatusListCredential;
         correlationId: string;
-        type: StatusListType;
     }): Promise<StatusListResult>;
+    /**
+     * Deletes the status list from the database
+     * @returns Promise resolving to boolean indicating success
+     */
     deleteStatusList(): Promise<boolean>;
-    private isStatusList2021Entity;
-    private isOAuthStatusListEntity;
-    private isBitstringStatusListEntity;
+    /**
+     * Updates a status list entry and returns the credential status
+     * @param args - Status list entry update parameters
+     * @returns Promise resolving to credential status and entry
+     */
     updateStatusListEntry(args: IAddStatusListEntryArgs): Promise<{
         credentialStatus: StatusList2021EntryCredentialStatus | StatusListOAuthEntryCredentialStatus | BitstringStatusListEntryCredentialStatus;
-        statusListEntry: IStatusListEntryEntity;
+        statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity;
     }>;
-    getStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<IStatusListEntryEntity | undefined>;
-    getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<IStatusListEntryEntity | undefined>;
+    /**
+     * Retrieves a status list entry by credential ID
+     * @param args - Query parameters including credential ID
+     * @returns Promise resolving to status list entry or undefined
+     */
+    getStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<IStatusListEntryEntity | IBitstringStatusListEntryEntity | undefined>;
+    /**
+     * Retrieves a status list entry by index
+     * @param args - Query parameters including status list index
+     * @returns Promise resolving to status list entry or undefined
+     */
+    getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<IStatusListEntryEntity | IBitstringStatusListEntryEntity | undefined>;
+    /**
+     * Generates a random available index for new status list entries
+     * @param args - Optional correlation ID parameter
+     * @returns Promise resolving to available index number
+     */
     getRandomNewStatusListIndex(args?: {
         correlationId?: string;
     }): Promise<number>;
+    /**
+     * Implementation for generating random status list indices with retry logic
+     * @param tries - Number of attempts made
+     * @param args - Optional correlation ID parameter
+     * @returns Promise resolving to available index or -1 if none found
+     */
     private getRandomNewStatusListIndexImpl;
+    /**
+     * Gets the length of the status list
+     * @param args - Optional correlation ID parameter
+     * @returns Promise resolving to status list length
+     */
     getStatusListLength(args?: {
         correlationId?: string;
     }): Promise<number>;
+    /**
+     * Retrieves the status list details
+     * @param args - Optional correlation ID parameter
+     * @returns Promise resolving to StatusListResult
+     */
     getStatusList(args?: {
         correlationId?: string;
     }): Promise<StatusListResult>;
+    /**
+     * Retrieves all status lists
+     * @returns Promise resolving to array of StatusListResult
+     */
     getStatusLists(): Promise<Array<StatusListResult>>;
+    /**
+     * Checks if a status list index is currently in use
+     * @returns Promise resolving to boolean indicating usage status
+     */
     isStatusListIndexInUse(): Promise<boolean>;
 }
 
-type IRequiredPlugins = IDataStoreORM & IDIDManager & IKeyManager & IIdentifierResolution & ICredentialIssuer & ICredentialVerifier & ICredentialPlugin & IStatusListPlugin & IResolver;
+type IRequiredPlugins = IDataStoreORM & IDIDManager & IKeyManager & IIdentifierResolution & ICredentialIssuer & ICredentialVerifier & IVcdmCredentialPlugin & IStatusListPlugin & IResolver;
 type IRequiredContext = IAgentContext<IRequiredPlugins>;
 interface IStatusListDriver {
     statusListStore: StatusListStore;
@@ -89,8 +218,10 @@ interface IStatusListDriver {
         correlationId?: string;
     }): Promise<number>;
     createStatusList(args: {
+        statusListType: StatusListType;
         statusListCredential: StatusListCredential;
         correlationId?: string;
+        bitsPerStatus?: number;
     }): Promise<StatusListResult>;
     getStatusList(args?: {
         correlationId?: string;
@@ -104,6 +235,7 @@ interface IStatusListDriver {
     getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<IStatusListEntryEntity | undefined>;
     updateStatusList(args: {
         statusListCredential: StatusListCredential;
+        correlationId: string;
     }): Promise<StatusListResult>;
     deleteStatusList(): Promise<boolean>;
     getRandomNewStatusListIndex(args?: {

package/dist/index.d.ts

@@ -1,11 +1,34 @@
 import { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution';
-import { StatusListStore, IAddStatusListEntryArgs, IStatusListEntryEntity, IGetStatusListEntryByCredentialIdArgs, IGetStatusListEntryByIndexArgs } from '@sphereon/ssi-sdk.data-store';
-import { StatusListResult, StatusList2021EntryCredentialStatus, StatusListOAuthEntryCredentialStatus, BitstringStatusListEntryCredentialStatus, IStatusListPlugin } from '@sphereon/ssi-sdk.vc-status-list';
-import { StatusListDriverType, StatusListCredential, StatusListCredentialIdMode, StatusListType } from '@sphereon/ssi-types';
-import { IDataStoreORM, IDIDManager, IKeyManager, ICredentialIssuer, ICredentialVerifier, ICredentialPlugin, IResolver, IAgentContext } from '@veramo/core';
+import { StatusListStore, IAddStatusListEntryArgs, BitstringStatusListEntryCredentialStatus, IStatusListEntryEntity, IBitstringStatusListEntryEntity, IGetStatusListEntryByCredentialIdArgs, IGetStatusListEntryByIndexArgs } from '@sphereon/ssi-sdk.data-store';
+import { StatusListResult, StatusList2021EntryCredentialStatus, StatusListOAuthEntryCredentialStatus, IStatusListPlugin } from '@sphereon/ssi-sdk.vc-status-list';
+import { StatusListDriverType, StatusListType, StatusListCredential, StatusListCredentialIdMode } from '@sphereon/ssi-types';
+import { IDataStoreORM, IDIDManager, IKeyManager, ICredentialIssuer, ICredentialVerifier, IResolver, IAgentContext } from '@veramo/core';
 import { DataSources } from '@sphereon/ssi-sdk.agent-config';
 import { DataSource } from 'typeorm';
+import { IVcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm';
 
+/**
+ * StatusList Driver Implementation for TypeORM/Agent Data Sources
+ *
+ * This module provides the database-backed implementation of the IStatusListDriver interface,
+ * handling persistence and retrieval of status list credentials and entries using TypeORM.
+ * It delegates status list format-specific operations to the functions layer while managing
+ * database interactions, driver configuration, and entity lifecycle.
+ *
+ * Key responsibilities:
+ * - Database connection and store management
+ * - Status list CRUD operations
+ * - Status list entry management
+ * - Random index generation for new entries
+ * - Integration with multiple data sources
+ *
+ * @author Sphereon International B.V.
+ * @since 2024
+ */
+
+/**
+ * Configuration options for status list management
+ */
 interface StatusListManagementOptions {
     id?: string;
     correlationId?: string;
@@ -13,17 +36,33 @@ interface StatusListManagementOptions {
     driverOptions?: DriverOptions;
 }
 type DriverOptions = TypeORMOptions;
+/**
+ * TypeORM-specific configuration options
+ */
 interface TypeORMOptions {
     dbName?: string;
 }
+/**
+ * Filesystem-specific configuration options
+ */
 interface FilesystemOptions {
     path: string;
 }
+/**
+ * Creates status list management options for TypeORM driver
+ * @param args - Configuration parameters including id, correlationId, and database name
+ * @returns StatusListManagementOptions configured for TypeORM
+ */
 declare function getOptions(args: {
     id?: string;
     correlationId?: string;
     dbName: string;
 }): StatusListManagementOptions;
+/**
+ * Creates and initializes a status list driver instance
+ * @param args - Configuration parameters including database connection details
+ * @returns Promise resolving to initialized IStatusListDriver instance
+ */
 declare function getDriver(args: {
     id?: string;
     correlationId?: string;
@@ -31,55 +70,145 @@ declare function getDriver(args: {
     dataSource?: DataSource;
     dataSources?: DataSources;
 }): Promise<IStatusListDriver>;
+/**
+ * TypeORM-based implementation of the IStatusListDriver interface
+ *
+ * Manages status list credentials and entries using a TypeORM data source.
+ * Handles database operations while delegating format-specific logic to the functions layer.
+ */
 declare class AgentDataSourceStatusListDriver implements IStatusListDriver {
     private _dataSource;
     private _statusListStore;
     private options;
     private _statusListLength;
+    /**
+     * Creates a new AgentDataSourceStatusListDriver instance
+     * @param _dataSource - TypeORM DataSource for database operations
+     * @param _statusListStore - StatusListStore for data persistence
+     * @param options - Driver configuration options
+     */
     constructor(_dataSource: DataSource, _statusListStore: StatusListStore, options: StatusListManagementOptions);
+    /**
+     * Initializes and creates a new AgentDataSourceStatusListDriver instance
+     * @param options - Status list management configuration
+     * @param dbArgs - Database connection arguments
+     * @returns Promise resolving to initialized driver instance
+     */
     static init(options: StatusListManagementOptions, dbArgs?: {
         dataSources?: DataSources;
         dataSource?: DataSource;
     }): Promise<AgentDataSourceStatusListDriver>;
+    /**
+     * Gets the TypeORM DataSource instance
+     * @returns DataSource instance for database operations
+     */
     get dataSource(): DataSource;
+    /**
+     * Gets the StatusListStore instance
+     * @returns StatusListStore for data persistence operations
+     */
     get statusListStore(): StatusListStore;
+    /**
+     * Gets the driver configuration options
+     * @returns DriverOptions configuration
+     */
     getOptions(): DriverOptions;
+    /**
+     * Gets the driver type
+     * @returns StatusListDriverType enum value
+     */
     getType(): StatusListDriverType;
+    /**
+     * Creates a new status list credential and stores it in the database
+     * @param args - Status list creation parameters
+     * @returns Promise resolving to StatusListResult
+     */
     createStatusList(args: {
+        statusListType: StatusListType;
         statusListCredential: StatusListCredential;
         correlationId?: string;
         credentialIdMode?: StatusListCredentialIdMode;
+        bitsPerStatus?: number;
     }): Promise<StatusListResult>;
+    /**
+     * Updates an existing status list credential in the database
+     * @param args - Status list update parameters
+     * @returns Promise resolving to StatusListResult
+     */
     updateStatusList(args: {
         statusListCredential: StatusListCredential;
         correlationId: string;
-        type: StatusListType;
     }): Promise<StatusListResult>;
+    /**
+     * Deletes the status list from the database
+     * @returns Promise resolving to boolean indicating success
+     */
     deleteStatusList(): Promise<boolean>;
-    private isStatusList2021Entity;
-    private isOAuthStatusListEntity;
-    private isBitstringStatusListEntity;
+    /**
+     * Updates a status list entry and returns the credential status
+     * @param args - Status list entry update parameters
+     * @returns Promise resolving to credential status and entry
+     */
     updateStatusListEntry(args: IAddStatusListEntryArgs): Promise<{
         credentialStatus: StatusList2021EntryCredentialStatus | StatusListOAuthEntryCredentialStatus | BitstringStatusListEntryCredentialStatus;
-        statusListEntry: IStatusListEntryEntity;
+        statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity;
     }>;
-    getStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<IStatusListEntryEntity | undefined>;
-    getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<IStatusListEntryEntity | undefined>;
+    /**
+     * Retrieves a status list entry by credential ID
+     * @param args - Query parameters including credential ID
+     * @returns Promise resolving to status list entry or undefined
+     */
+    getStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<IStatusListEntryEntity | IBitstringStatusListEntryEntity | undefined>;
+    /**
+     * Retrieves a status list entry by index
+     * @param args - Query parameters including status list index
+     * @returns Promise resolving to status list entry or undefined
+     */
+    getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<IStatusListEntryEntity | IBitstringStatusListEntryEntity | undefined>;
+    /**
+     * Generates a random available index for new status list entries
+     * @param args - Optional correlation ID parameter
+     * @returns Promise resolving to available index number
+     */
     getRandomNewStatusListIndex(args?: {
         correlationId?: string;
     }): Promise<number>;
+    /**
+     * Implementation for generating random status list indices with retry logic
+     * @param tries - Number of attempts made
+     * @param args - Optional correlation ID parameter
+     * @returns Promise resolving to available index or -1 if none found
+     */
     private getRandomNewStatusListIndexImpl;
+    /**
+     * Gets the length of the status list
+     * @param args - Optional correlation ID parameter
+     * @returns Promise resolving to status list length
+     */
     getStatusListLength(args?: {
         correlationId?: string;
     }): Promise<number>;
+    /**
+     * Retrieves the status list details
+     * @param args - Optional correlation ID parameter
+     * @returns Promise resolving to StatusListResult
+     */
     getStatusList(args?: {
         correlationId?: string;
     }): Promise<StatusListResult>;
+    /**
+     * Retrieves all status lists
+     * @returns Promise resolving to array of StatusListResult
+     */
     getStatusLists(): Promise<Array<StatusListResult>>;
+    /**
+     * Checks if a status list index is currently in use
+     * @returns Promise resolving to boolean indicating usage status
+     */
     isStatusListIndexInUse(): Promise<boolean>;
 }
 
-type IRequiredPlugins = IDataStoreORM & IDIDManager & IKeyManager & IIdentifierResolution & ICredentialIssuer & ICredentialVerifier & ICredentialPlugin & IStatusListPlugin & IResolver;
+type IRequiredPlugins = IDataStoreORM & IDIDManager & IKeyManager & IIdentifierResolution & ICredentialIssuer & ICredentialVerifier & IVcdmCredentialPlugin & IStatusListPlugin & IResolver;
 type IRequiredContext = IAgentContext<IRequiredPlugins>;
 interface IStatusListDriver {
     statusListStore: StatusListStore;
@@ -89,8 +218,10 @@ interface IStatusListDriver {
         correlationId?: string;
     }): Promise<number>;
     createStatusList(args: {
+        statusListType: StatusListType;
         statusListCredential: StatusListCredential;
         correlationId?: string;
+        bitsPerStatus?: number;
     }): Promise<StatusListResult>;
     getStatusList(args?: {
         correlationId?: string;
@@ -104,6 +235,7 @@ interface IStatusListDriver {
     getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<IStatusListEntryEntity | undefined>;
     updateStatusList(args: {
         statusListCredential: StatusListCredential;
+        correlationId: string;
     }): Promise<StatusListResult>;
     deleteStatusList(): Promise<boolean>;
     getRandomNewStatusListIndex(args?: {