@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/src/impl/IStatusList.ts

@@ -1,34 +1,52 @@
-import type { IAgentContext, ICredentialPlugin } from '@veramo/core'
+import type { IAgentContext } from '@veramo/core'
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import {
   BitstringStatus,
+  BitstringStatusListEntryCredentialStatus,
   CheckStatusIndexArgs,
   CreateStatusListArgs,
   Status2021,
+  StatusList2021EntryCredentialStatus,
+  StatusListOAuthEntryCredentialStatus,
   StatusListResult,
   StatusOAuth,
   ToStatusListDetailsArgs,
   UpdateStatusListFromEncodedListArgs,
   UpdateStatusListIndexArgs,
 } from '../types'
+import { BitstringStatusPurpose } from '@4sure-tech/vc-bitstring-status-lists'
+import {
+  CredentialProofFormat,
+  IIssuer,
+  StatusListCredential,
+  StatusListDriverType,
+  StatusListIndexingDirection,
+  StatusListType,
+  StatusPurpose2021,
+} from '@sphereon/ssi-types'
+import { IBitstringStatusListEntryEntity, IStatusListEntryEntity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
+import { IVcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm'
 
 export interface IStatusList {
   /**
    * Creates a new status list of the specific type
    */
-  createNewStatusList(args: CreateStatusListArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>
+  createNewStatusList(args: CreateStatusListArgs, context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>
 
   /**
    * Updates a status at the given index in the status list
    */
-  updateStatusListIndex(args: UpdateStatusListIndexArgs, context: IAgentContext<ICredentialPlugin & IIdentifierResolution>): Promise<StatusListResult>
+  updateStatusListIndex(
+    args: UpdateStatusListIndexArgs,
+    context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
+  ): Promise<StatusListResult>
 
   /**
    * Updates a status list using a base64 encoded list of statuses
    */
   updateStatusListFromEncodedList(
     args: UpdateStatusListFromEncodedListArgs,
-    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+    context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
   ): Promise<StatusListResult>
 
   /**
@@ -37,7 +55,54 @@ export interface IStatusList {
   checkStatusIndex(args: CheckStatusIndexArgs): Promise<number | Status2021 | StatusOAuth | BitstringStatus>
 
   /**
-   * Collects the status list details
+   * Collects the status list details - returns flattened entity data ready for storage
    */
-  toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult>
+  toStatusListDetails(
+    args: ToStatusListDetailsArgs,
+  ): Promise<
+    StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)
+  >
+
+  /**
+   * Creates a credential status object from a status list and entry
+   */
+  createCredentialStatus(args: {
+    statusList: StatusListEntity
+    statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity
+    statusListIndex: number
+  }): Promise<StatusList2021EntryCredentialStatus | StatusListOAuthEntryCredentialStatus | BitstringStatusListEntryCredentialStatus>
+}
+
+export interface IStatusListImplementationResult {
+  id: string
+  encodedList: string
+  issuer: string | IIssuer
+  type: StatusListType
+  proofFormat: CredentialProofFormat
+  length: number
+  statusListCredential: StatusListCredential
+  statuslistContentType: string
+  correlationId?: string
+  driverType?: StatusListDriverType
+}
+
+export interface IStatusList2021ImplementationResult extends IStatusListImplementationResult {
+  type: StatusListType.StatusList2021
+  indexingDirection: StatusListIndexingDirection
+  statusPurpose: StatusPurpose2021
+}
+
+export interface IOAuthStatusListImplementationResult extends IStatusListImplementationResult {
+  type: StatusListType.OAuthStatusList
+  bitsPerStatus: number
+  expiresAt?: Date
+}
+
+export interface IBitstringStatusListImplementationResult extends IStatusListImplementationResult {
+  type: StatusListType.BitstringStatusList
+  statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
+  bitsPerStatus?: number
+  validFrom?: Date
+  validUntil?: Date
+  ttl?: number
 }

package/src/impl/OAuthStatusList.ts

@@ -1,9 +1,10 @@
-import type { IAgentContext, ICredentialPlugin, IKeyManager } from '@veramo/core'
+import type { IAgentContext, IKeyManager } from '@veramo/core'
 import { type CompactJWT, type CredentialProofFormat, type CWT, StatusListType } from '@sphereon/ssi-types'
 import type {
   CheckStatusIndexArgs,
   CreateStatusListArgs,
   SignedStatusListData,
+  StatusListOAuthEntryCredentialStatus,
   StatusListResult,
   StatusOAuth,
   ToStatusListDetailsArgs,
@@ -11,14 +12,16 @@ import type {
   UpdateStatusListIndexArgs,
 } from '../types'
 import { determineProofFormat, ensureDate, getAssertedValue, getAssertedValues } from '../utils'
-import type { IStatusList } from './IStatusList'
+import type { IOAuthStatusListImplementationResult, IStatusList } from './IStatusList'
 import { StatusList } from '@sd-jwt/jwt-status-list'
 import type { IJwtService } from '@sphereon/ssi-sdk-ext.jwt-service'
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import { createSignedJwt, decodeStatusListJWT } from './encoding/jwt'
 import { createSignedCbor, decodeStatusListCWT } from './encoding/cbor'
+import { IBitstringStatusListEntryEntity, IStatusListEntryEntity, OAuthStatusListEntity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
+import { IVcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm'
 
-type IRequiredContext = IAgentContext<ICredentialPlugin & IJwtService & IIdentifierResolution & IKeyManager>
+type IRequiredContext = IAgentContext<IVcdmCredentialPlugin & IJwtService & IIdentifierResolution & IKeyManager>
 
 export const DEFAULT_BITS_PER_STATUS = 1 // 1 bit is sufficient for 0x00 - "VALID" 0x01 - "INVALID" saving space in the process
 export const DEFAULT_LIST_LENGTH = 250000
@@ -144,10 +147,6 @@ export class OAuthStatusListImplementation implements IStatusList {
     }
   }
 
-  private buildContentType(proofFormat: CredentialProofFormat | undefined) {
-    return `application/statuslist+${proofFormat === 'cbor' ? 'cwt' : 'jwt'}`
-  }
-
   async checkStatusIndex(args: CheckStatusIndexArgs): Promise<number | StatusOAuth> {
     const { statusListCredential, statusListIndex } = args
     if (typeof statusListCredential !== 'string') {
@@ -165,13 +164,17 @@ export class OAuthStatusListImplementation implements IStatusList {
     return statusList.getStatus(index)
   }
 
-  async toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult> {
+  async toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult & IOAuthStatusListImplementationResult> {
     const { statusListPayload } = args as { statusListPayload: CompactJWT | CWT }
     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 * 1000) : undefined
+
     return {
+      // Base implementation fields
       id,
       encodedList: statusList.compressStatusList(),
       issuer,
@@ -180,18 +183,52 @@ export class OAuthStatusListImplementation implements IStatusList {
       length: statusList.statusList.length,
       statusListCredential: statusListPayload,
       statuslistContentType: this.buildContentType(proofFormat),
+      correlationId: args.correlationId, // FIXME these do not need to be inside the impl
+      driverType: args.driverType, // FIXME these do not need to be inside the impl
+
+      // Flattened OAuth-specific fields
+      bitsPerStatus,
+      ...(expiresAt && { expiresAt }),
+
+      // Legacy nested structure for backward compatibility
       oauthStatusList: {
-        bitsPerStatus: statusList.getBitsPerStatus(),
-        ...(exp && { expiresAt: new Date(exp * 1000) }),
+        bitsPerStatus,
+        ...(expiresAt && { expiresAt }),
       },
+
+      // Optional fields from args
       ...(args.correlationId && { correlationId: args.correlationId }),
       ...(args.driverType && { driverType: args.driverType }),
     }
   }
 
+  async createCredentialStatus(args: {
+    statusList: StatusListEntity
+    statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity
+    statusListIndex: number
+  }): Promise<StatusListOAuthEntryCredentialStatus> {
+    const { statusList, statusListIndex } = args
+
+    // Cast to OAuthStatusListEntity to access specific properties
+    const oauthStatusList = statusList as OAuthStatusListEntity
+
+    return {
+      id: `${statusList.id}#${statusListIndex}`,
+      type: 'OAuthStatusListEntry',
+      bitsPerStatus: oauthStatusList.bitsPerStatus,
+      statusListIndex: '' + statusListIndex,
+      statusListCredential: statusList.id,
+      expiresAt: oauthStatusList.expiresAt,
+    }
+  }
+
+  private buildContentType(proofFormat: CredentialProofFormat | undefined) {
+    return `application/statuslist+${proofFormat === 'cbor' ? 'cwt' : 'jwt'}`
+  }
+
   private async createSignedStatusList(
     proofFormat: CredentialProofFormat,
-    context: IAgentContext<ICredentialPlugin & IJwtService & IIdentifierResolution & IKeyManager>,
+    context: IAgentContext<IVcdmCredentialPlugin & IJwtService & IIdentifierResolution & IKeyManager>,
     statusList: StatusList,
     issuerString: string,
     id: string,

package/src/impl/StatusList2021.ts

@@ -1,16 +1,16 @@
-import type { IAgentContext, ICredentialPlugin, ProofFormat as VeramoProofFormat } from '@veramo/core'
+import type { IAgentContext, ProofFormat as VeramoProofFormat } from '@veramo/core'
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import {
   CredentialMapper,
+  type CredentialProofFormat,
   DocumentFormat,
   type IIssuer,
-  type CredentialProofFormat,
   type StatusListCredential,
   StatusListType,
 } from '@sphereon/ssi-types'
 
 import { StatusList } from '@sphereon/vc-status-list'
-import type { IStatusList } from './IStatusList'
+import type { IStatusList, IStatusList2021ImplementationResult } from './IStatusList'
 import type {
   CheckStatusIndexArgs,
   CreateStatusListArgs,
@@ -19,9 +19,10 @@ import type {
   UpdateStatusListFromEncodedListArgs,
   UpdateStatusListIndexArgs,
 } from '../types'
-
-import { Status2021 } from '../types'
+import { Status2021, StatusList2021EntryCredentialStatus } from '../types'
 import { assertValidProofType, getAssertedProperty, getAssertedValue, getAssertedValues } from '../utils'
+import { IBitstringStatusListEntryEntity, IStatusListEntryEntity, StatusList2021Entity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
+import { IVcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm'
 
 export const DEFAULT_LIST_LENGTH = 250000
 export const DEFAULT_PROOF_FORMAT = 'lds' as CredentialProofFormat
@@ -29,7 +30,7 @@ export const DEFAULT_PROOF_FORMAT = 'lds' as CredentialProofFormat
 export class StatusList2021Implementation implements IStatusList {
   async createNewStatusList(
     args: CreateStatusListArgs,
-    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+    context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
   ): Promise<StatusListResult> {
     const length = args?.length ?? DEFAULT_LIST_LENGTH
     const proofFormat: CredentialProofFormat = args?.proofFormat ?? DEFAULT_PROOF_FORMAT
@@ -71,7 +72,7 @@ export class StatusList2021Implementation implements IStatusList {
 
   async updateStatusListIndex(
     args: UpdateStatusListIndexArgs,
-    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+    context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
   ): Promise<StatusListResult> {
     const credential = args.statusListCredential
     const uniform = CredentialMapper.toUniformCredential(credential)
@@ -96,11 +97,15 @@ export class StatusList2021Implementation implements IStatusList {
       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,
@@ -114,7 +119,7 @@ export class StatusList2021Implementation implements IStatusList {
 
   async updateStatusListFromEncodedList(
     args: UpdateStatusListFromEncodedListArgs,
-    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+    context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
   ): Promise<StatusListResult> {
     if (!args.statusList2021) {
       throw new Error('statusList2021 options required for type StatusList2021')
@@ -166,7 +171,7 @@ export class StatusList2021Implementation implements IStatusList {
     return status ? Status2021.Invalid : Status2021.Valid
   }
 
-  async toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult> {
+  async toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult & IStatusList2021ImplementationResult> {
     const { statusListPayload } = args
     const uniform = CredentialMapper.toUniformCredential(statusListPayload)
     const { issuer, credentialSubject } = uniform
@@ -175,9 +180,11 @@ export class StatusList2021Implementation implements IStatusList {
     const proofFormat: CredentialProofFormat = CredentialMapper.detectDocumentType(statusListPayload) === DocumentFormat.JWT ? 'jwt' : 'lds'
 
     const statusPurpose = getAssertedProperty('statusPurpose', credentialSubject)
+    const indexingDirection = 'rightToLeft'
     const list = await StatusList.decode({ encodedList })
 
     return {
+      // Base implementation fields
       id,
       encodedList,
       issuer,
@@ -186,12 +193,41 @@ export class StatusList2021Implementation implements IStatusList {
       length: list.length,
       statusListCredential: statusListPayload,
       statuslistContentType: this.buildContentType(proofFormat),
+      correlationId: args.correlationId, // FIXME these do not need to be inside the impl
+      driverType: args.driverType, // FIXME these do not need to be inside the impl
+
+      // Flattened StatusList2021-specific fields
+      indexingDirection,
+      statusPurpose,
+
+      // Legacy nested structure for backward compatibility
       statusList2021: {
-        indexingDirection: 'rightToLeft',
+        indexingDirection,
         statusPurpose,
+
+        // Optional fields from args
+        ...(args.correlationId && { correlationId: args.correlationId }),
+        ...(args.driverType && { driverType: args.driverType }),
       },
-      ...(args.correlationId && { correlationId: args.correlationId }),
-      ...(args.driverType && { driverType: args.driverType }),
+    }
+  }
+
+  async createCredentialStatus(args: {
+    statusList: StatusListEntity
+    statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity
+    statusListIndex: number
+  }): Promise<StatusList2021EntryCredentialStatus> {
+    const { statusList, statusListIndex } = args
+
+    // Cast to StatusList2021Entity to access specific properties
+    const statusList2021 = statusList as StatusList2021Entity
+
+    return {
+      id: `${statusList.id}#${statusListIndex}`,
+      type: 'StatusList2021Entry',
+      statusPurpose: statusList2021.statusPurpose ?? 'revocation',
+      statusListIndex: '' + statusListIndex,
+      statusListCredential: statusList.id,
     }
   }
 
@@ -203,7 +239,7 @@ export class StatusList2021Implementation implements IStatusList {
       proofFormat: VeramoProofFormat
       keyRef?: string
     },
-    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+    context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
   ): Promise<StatusListCredential> {
     const identifier = await context.agent.identifierManagedGet({
       identifier: typeof args.issuer === 'string' ? args.issuer : args.issuer.id,

package/src/types/index.ts

@@ -7,26 +7,18 @@ import {
   type IVerifiableCredential,
   type OrPromise,
   type StatusListCredential,
-  StatusListCredentialIdMode,
   StatusListDriverType,
   type StatusListIndexingDirection,
   StatusListType,
   type StatusPurpose2021,
 } from '@sphereon/ssi-types'
-import type {
-  CredentialPayload,
-  IAgentContext,
-  ICredentialIssuer,
-  ICredentialPlugin,
-  ICredentialVerifier,
-  IKeyManager,
-  IPluginMethodMap,
-} from '@veramo/core'
+import type { CredentialPayload, IAgentContext, ICredentialIssuer, ICredentialVerifier, IKeyManager, IPluginMethodMap } from '@veramo/core'
 import { DataSource } from 'typeorm'
 import type { BitsPerStatus } from '@sd-jwt/jwt-status-list'
 import type { SdJwtVcPayload } from '@sd-jwt/sd-jwt-vc'
 import type { StatusListOpts } from '@sphereon/oid4vci-common'
 import { BitstringStatusPurpose } from '@4sure-tech/vc-bitstring-status-lists'
+import { IVcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm'
 
 export enum StatusOAuth {
   Valid = 0,
@@ -48,7 +40,7 @@ export type StatusList2021Args = {
 }
 
 export type OAuthStatusListArgs = {
-  bitsPerStatus?: BitsPerStatus
+  bitsPerStatus: BitsPerStatus
   expiresAt?: Date
 }
 
@@ -114,40 +106,46 @@ export interface UpdateStatusListFromStatusListCredentialArgs {
 }
 
 export interface StatusListResult {
+  id: string
   encodedList: string
-  statusListCredential: StatusListCredential
-  length: number
+  issuer: string | IIssuer
   type: StatusListType
   proofFormat: CredentialProofFormat
-  id: string
+  length: number
+  statusListCredential: StatusListCredential
   statuslistContentType: string
-  issuer: string | IIssuer
-  statusList2021?: StatusList2021Details
-  oauthStatusList?: OAuthStatusDetails
-  bitstringStatusList?: BitstringStatusDetails
-
-  // These cannot be deduced from the VC, so they are present when callers pass in these values as params
   correlationId?: string
   driverType?: StatusListDriverType
-  credentialIdMode?: StatusListCredentialIdMode
-}
 
-interface StatusList2021Details {
-  indexingDirection: StatusListIndexingDirection
-  statusPurpose?: StatusPurpose2021
-}
+  // Flattened StatusList2021 fields
+  indexingDirection?: StatusListIndexingDirection
+  statusPurpose?: StatusPurpose2021 | BitstringStatusPurpose | BitstringStatusPurpose[]
 
-interface OAuthStatusDetails {
-  bitsPerStatus?: BitsPerStatus
+  // Flattened OAuth fields
+  bitsPerStatus?: number
   expiresAt?: Date
-}
 
-interface BitstringStatusDetails {
-  statusPurpose: BitstringStatusPurpose
-  bitsPerStatus: number
+  // Flattened Bitstring fields
   validFrom?: Date
   validUntil?: Date
   ttl?: number
+
+  // Legacy nested structures for backward compatibility
+  statusList2021?: {
+    indexingDirection: StatusListIndexingDirection
+    statusPurpose: StatusPurpose2021
+  }
+  oauthStatusList?: {
+    bitsPerStatus: number
+    expiresAt?: Date
+  }
+  bitstringStatusList?: {
+    statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
+    bitsPerStatus?: number
+    validFrom?: Date
+    validUntil?: Date
+    ttl?: number
+  }
 }
 
 export interface StatusList2021EntryCredentialStatus extends ICredentialStatus {
@@ -304,5 +302,5 @@ export type SignedStatusListData = {
   encodedList: string
 }
 
-export type IRequiredPlugins = ICredentialPlugin & IIdentifierResolution
-export type IRequiredContext = IAgentContext<ICredentialIssuer & ICredentialVerifier & IIdentifierResolution & IKeyManager & ICredentialPlugin>
+export type IRequiredPlugins = IVcdmCredentialPlugin & IIdentifierResolution
+export type IRequiredContext = IAgentContext<ICredentialIssuer & ICredentialVerifier & IIdentifierResolution & IKeyManager & IVcdmCredentialPlugin>

package/src/utils.ts

@@ -41,7 +41,7 @@ export function getAssertedProperty<T extends object>(propertyName: string, obj:
 const ValidProofTypeMap = new Map<StatusListType, CredentialProofFormat[]>([
   [StatusListType.StatusList2021, ['jwt', 'lds']],
   [StatusListType.OAuthStatusList, ['jwt', 'cbor']],
-  [StatusListType.BitstringStatusList, ['lds']],
+  [StatusListType.BitstringStatusList, ['lds', 'vc+jwt']],
 ])
 
 export function assertValidProofType(type: StatusListType, proofFormat: CredentialProofFormat) {