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

package/src/functions.ts

@@ -10,15 +10,20 @@ import {
 } from '@sphereon/ssi-types'
 import type { CredentialStatus, DIDDocument, IAgentContext, ICredentialPlugin, ProofFormat as VeramoProofFormat } from '@veramo/core'
 
+import { IAddStatusListArgs, IBitstringStatusListEntryEntity, IStatusListEntryEntity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
+
 import { checkStatus } from '@sphereon/vc-status-list'
 
 // @ts-ignore
 import { CredentialJwtOrJSON, StatusMethod } from 'credential-status'
 import {
   BitstringStatus,
+  BitstringStatusListEntryCredentialStatus,
   CreateNewStatusListFuncArgs,
   Status2021,
+  StatusList2021EntryCredentialStatus,
   StatusList2021ToVerifiableCredentialArgs,
+  StatusListOAuthEntryCredentialStatus,
   StatusListResult,
   StatusOAuth,
   UpdateStatusListFromEncodedListArgs,
@@ -146,7 +151,7 @@ export async function simpleCheckStatusFromStatusListUrl(args: {
 
 export async function checkStatusIndexFromStatusListCredential(args: {
   statusListCredential: StatusListCredential
-  statusPurpose?: StatusPurpose2021
+  statusPurpose?: StatusPurpose2021 | string | string[]
   type?: StatusListType | 'StatusList2021Entry' | 'BitstringStatusListEntry'
   id?: string
   statusListIndex: string | number
@@ -176,7 +181,6 @@ export async function updateStatusIndexFromStatusListCredential(
   return implementation.updateStatusListIndex(args, context)
 }
 
-// Keeping helper function for backward compatibility
 export async function statusListCredentialToDetails({
   correlationId,
   driverType,
@@ -187,7 +191,7 @@ export async function statusListCredentialToDetails({
   correlationId?: string
   driverType?: StatusListDriverType
   bitsPerStatus?: number
-}): Promise<StatusListResult> {
+}): Promise<StatusListResult & Partial<IAddStatusListArgs>> {
   const credential = getAssertedValue('statusListCredential', statusListCredential)
 
   let statusListType: StatusListType | undefined
@@ -213,12 +217,35 @@ export async function statusListCredentialToDetails({
   }
 
   const implementation = getStatusListImplementation(statusListType)
-  return await implementation.toStatusListDetails({
+
+  // The implementation should now return all the type-specific fields needed for the entity
+  const result = await implementation.toStatusListDetails({
     statusListPayload: credential,
     correlationId: correlationId,
     driverType: driverType,
     bitsPerStatus: bitsPerStatus,
   })
+
+  return result
+}
+
+export async function createCredentialStatusFromStatusList(args: {
+  statusList: StatusListEntity
+  statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity
+  statusListIndex: number
+}): Promise<StatusList2021EntryCredentialStatus | StatusListOAuthEntryCredentialStatus | BitstringStatusListEntryCredentialStatus> {
+  const { statusList, statusListEntry, statusListIndex } = args
+
+  // Determine the status list type and delegate to appropriate implementation
+  const statusListType = determineStatusListType(statusList.statusListCredential!)
+  const implementation = getStatusListImplementation(statusListType)
+
+  // Each implementation should have a method to create credential status
+  return implementation.createCredentialStatus({
+    statusList,
+    statusListEntry,
+    statusListIndex,
+  })
 }
 
 export async function updateStatusListIndexFromEncodedList(

package/src/impl/BitstringStatusListImplementation.ts

@@ -1,5 +1,6 @@
 import type { IAgentContext, ICredentialPlugin, ProofFormat as VeramoProofFormat } from '@veramo/core'
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
+
 import {
   CredentialMapper,
   type CredentialProofFormat,
@@ -9,9 +10,10 @@ import {
   StatusListType,
 } from '@sphereon/ssi-types'
 
-import type { IStatusList } from './IStatusList'
+import type { IBitstringStatusListImplementationResult, IStatusList } from './IStatusList'
 import {
   BitstringStatus,
+  BitstringStatusListEntryCredentialStatus,
   CheckStatusIndexArgs,
   CreateStatusListArgs,
   StatusListResult,
@@ -23,6 +25,7 @@ import {
 import { assertValidProofType, ensureDate, getAssertedProperty, getAssertedValue, getAssertedValues } from '../utils'
 import { BitstringStatusListCredential } from '../types/BitstringStatusList'
 import { BitstreamStatusList, BitstringStatusPurpose, createStatusListCredential } from '@4sure-tech/vc-bitstring-status-lists'
+import { BitstringStatusListEntity, IBitstringStatusListEntryEntity, IStatusListEntryEntity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
 
 export const DEFAULT_LIST_LENGTH = 131072 // W3C spec minimum
 export const DEFAULT_PROOF_FORMAT = 'lds' as CredentialProofFormat
@@ -215,7 +218,7 @@ export class BitstringStatusListImplementation implements IStatusList {
     return statusList.getStatus(numIndex)
   }
 
-  async toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult> {
+  async toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult & IBitstringStatusListImplementationResult> {
     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)')
@@ -234,6 +237,7 @@ export class BitstringStatusListImplementation implements IStatusList {
     const statuslistLength: number = BitstreamStatusList.getStatusListLength(encodedList, bitsPerStatus)
 
     return {
+      // Base implementation fields
       id,
       encodedList,
       issuer,
@@ -242,18 +246,60 @@ export class BitstringStatusListImplementation implements IStatusList {
       length: statuslistLength,
       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 Bitstring-specific fields
+      statusPurpose,
+      bitsPerStatus,
+      ...(validFrom && { validFrom }),
+      ...(validUntil && { validUntil }),
+      ...(ttl && { ttl }),
+
+      // Legacy nested structure for backward compatibility
       bitstringStatusList: {
         statusPurpose,
         bitsPerStatus,
-        validFrom,
-        validUntil,
-        ttl,
+        ...(validFrom && { validFrom }),
+        ...(validUntil && { validUntil }),
+        ...(ttl && { ttl }),
       },
+
+      // 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<BitstringStatusListEntryCredentialStatus> {
+    const { statusList, statusListEntry, statusListIndex } = args
+
+    // Type guard to ensure we have a bitstring entry
+    const isBitstringEntry = (entry: IStatusListEntryEntity | IBitstringStatusListEntryEntity): entry is IBitstringStatusListEntryEntity => {
+      return 'statusPurpose' in entry
+    }
+
+    if (!isBitstringEntry(statusListEntry)) {
+      throw new Error('Expected bitstring status list entry for bitstring status list')
+    }
+
+    // Cast to BitstringStatusListEntity to access specific properties
+    const bitstringStatusList = statusList as BitstringStatusListEntity
+
+    return {
+      id: `${statusList.id}#${statusListIndex}`,
+      type: 'BitstringStatusListEntry',
+      statusPurpose: statusListEntry.statusPurpose,
+      statusListIndex: '' + statusListIndex,
+      statusListCredential: statusList.id,
+      bitsPerStatus: bitstringStatusList.bitsPerStatus,
+    } satisfies BitstringStatusListEntryCredentialStatus
+  }
+
   private async createVerifiableCredential(
     args: {
       id: string

package/src/impl/IStatusList.ts

@@ -2,15 +2,29 @@ import type { IAgentContext, ICredentialPlugin } 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'
 
 export interface IStatusList {
   /**
@@ -37,7 +51,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 & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)
+  >
+
+  /**
+   * Creates a credential status object from a status list and entry
    */
-  toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult>
+  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

@@ -4,6 +4,7 @@ import type {
   CheckStatusIndexArgs,
   CreateStatusListArgs,
   SignedStatusListData,
+  StatusListOAuthEntryCredentialStatus,
   StatusListResult,
   StatusOAuth,
   ToStatusListDetailsArgs,
@@ -11,12 +12,13 @@ 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'
 
 type IRequiredContext = IAgentContext<ICredentialPlugin & IJwtService & IIdentifierResolution & IKeyManager>
 
@@ -144,10 +146,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 +163,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,15 +182,49 @@ 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>,

package/src/impl/StatusList2021.ts

@@ -2,15 +2,15 @@ import type { IAgentContext, ICredentialPlugin, ProofFormat as VeramoProofFormat
 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,9 @@ 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'
 
 export const DEFAULT_LIST_LENGTH = 250000
 export const DEFAULT_PROOF_FORMAT = 'lds' as CredentialProofFormat
@@ -96,11 +96,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,
@@ -166,7 +170,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 +179,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 +192,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,
     }
   }
 

package/src/types/index.ts

@@ -7,7 +7,6 @@ import {
   type IVerifiableCredential,
   type OrPromise,
   type StatusListCredential,
-  StatusListCredentialIdMode,
   StatusListDriverType,
   type StatusListIndexingDirection,
   StatusListType,
@@ -48,7 +47,7 @@ export type StatusList2021Args = {
 }
 
 export type OAuthStatusListArgs = {
-  bitsPerStatus?: BitsPerStatus
+  bitsPerStatus: BitsPerStatus
   expiresAt?: Date
 }
 
@@ -114,40 +113,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 {