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

package/src/impl/OAuthStatusList.ts

@@ -3,16 +3,17 @@ import { type CompactJWT, type CredentialProofFormat, type CWT, StatusListType }
 import type {
   CheckStatusIndexArgs,
   CreateStatusListArgs,
+  IMergeDetailsWithEntityArgs,
+  IToDetailsFromCredentialArgs,
   SignedStatusListData,
   StatusListOAuthEntryCredentialStatus,
   StatusListResult,
   StatusOAuth,
-  ToStatusListDetailsArgs,
   UpdateStatusListFromEncodedListArgs,
   UpdateStatusListIndexArgs,
 } from '../types'
 import { determineProofFormat, ensureDate, getAssertedValue, getAssertedValues } from '../utils'
-import type { IOAuthStatusListImplementationResult, IStatusList } from './IStatusList'
+import type { IExtractedCredentialDetails, 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'
@@ -164,41 +165,92 @@ export class OAuthStatusListImplementation implements IStatusList {
     return statusList.getStatus(index)
   }
 
-  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
+  /**
+   * 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: CompactJWT | CWT): Promise<IExtractedCredentialDetails> {
+    if (typeof credential !== 'string') {
+      return Promise.reject('statusListCredential must be a JWT or CWT string')
+    }
 
-    const bitsPerStatus = statusList.getBitsPerStatus()
-    const expiresAt = exp ? new Date(exp * 1000) : undefined
+    const proofFormat = determineProofFormat(credential)
+    const decoded = proofFormat === 'jwt' ? decodeStatusListJWT(credential) : decodeStatusListCWT(credential)
 
     return {
-      // Base implementation fields
-      id,
-      encodedList: statusList.compressStatusList(),
-      issuer,
-      type: StatusListType.OAuthStatusList,
-      proofFormat,
-      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
+      id: decoded.id,
+      issuer: decoded.issuer,
+      encodedList: decoded.statusList.compressStatusList(),
+      decodedPayload: decoded,
+    }
+  }
 
-      // Flattened OAuth-specific fields
-      bitsPerStatus,
-      ...(expiresAt && { expiresAt }),
+  // For CREATE and READ contexts
+  async toStatusListDetails(args: IToDetailsFromCredentialArgs): Promise<StatusListResult & IOAuthStatusListImplementationResult>
+  // For UPDATE contexts
+  async toStatusListDetails(args: IMergeDetailsWithEntityArgs): Promise<StatusListResult & IOAuthStatusListImplementationResult>
+  async toStatusListDetails(
+    args: IToDetailsFromCredentialArgs | IMergeDetailsWithEntityArgs,
+  ): Promise<StatusListResult & IOAuthStatusListImplementationResult> {
+    if ('statusListCredential' in args) {
+      // CREATE/READ context
+      const { statusListCredential, bitsPerStatus, correlationId, driverType } = args
+      if (!bitsPerStatus || bitsPerStatus < 1) {
+        return Promise.reject(Error('bitsPerStatus must be set for OAuth status lists and must be 1 or higher'))
+      }
 
-      // Legacy nested structure for backward compatibility
-      oauthStatusList: {
+      const proofFormat = determineProofFormat(statusListCredential as string)
+      const decoded =
+        proofFormat === 'jwt' ? decodeStatusListJWT(statusListCredential as string) : decodeStatusListCWT(statusListCredential as string)
+      const { statusList, issuer, id, exp } = decoded
+      const expiresAt = exp ? new Date(exp * 1000) : undefined
+
+      return {
+        id,
+        encodedList: statusList.compressStatusList(),
+        issuer,
+        type: StatusListType.OAuthStatusList,
+        proofFormat,
+        length: statusList.statusList.length,
+        statusListCredential: statusListCredential as CompactJWT | CWT,
+        statuslistContentType: this.buildContentType(proofFormat),
+        correlationId,
+        driverType,
         bitsPerStatus,
         ...(expiresAt && { expiresAt }),
-      },
-
-      // Optional fields from args
-      ...(args.correlationId && { correlationId: args.correlationId }),
-      ...(args.driverType && { driverType: args.driverType }),
+        oauthStatusList: {
+          bitsPerStatus,
+          ...(expiresAt && { expiresAt }),
+        },
+      }
+    } else {
+      // UPDATE context
+      const { extractedDetails, statusListEntity } = args
+      const oauthEntity = statusListEntity as OAuthStatusListEntity
+      const decoded = extractedDetails.decodedPayload as { statusList: StatusList; exp?: number }
+
+      const proofFormat = determineProofFormat(statusListEntity.statusListCredential as string)
+      const expiresAt = decoded.exp ? new Date(decoded.exp * 1000) : undefined
+
+      return {
+        id: extractedDetails.id,
+        encodedList: extractedDetails.encodedList,
+        issuer: extractedDetails.issuer,
+        type: StatusListType.OAuthStatusList,
+        proofFormat,
+        length: decoded.statusList.statusList.length,
+        statusListCredential: statusListEntity.statusListCredential!,
+        statuslistContentType: this.buildContentType(proofFormat),
+        correlationId: statusListEntity.correlationId,
+        driverType: statusListEntity.driverType,
+        bitsPerStatus: oauthEntity.bitsPerStatus,
+        ...(expiresAt && { expiresAt }),
+        oauthStatusList: {
+          bitsPerStatus: oauthEntity.bitsPerStatus,
+          ...(expiresAt && { expiresAt }),
+        },
+      }
     }
   }
 

package/src/impl/StatusList2021.ts

@@ -10,12 +10,13 @@ import {
 } from '@sphereon/ssi-types'
 
 import { StatusList } from '@sphereon/vc-status-list'
-import type { IStatusList, IStatusList2021ImplementationResult } from './IStatusList'
+import type { IExtractedCredentialDetails, IStatusList, IStatusList2021ImplementationResult } from './IStatusList'
 import type {
   CheckStatusIndexArgs,
   CreateStatusListArgs,
+  IMergeDetailsWithEntityArgs,
+  IToDetailsFromCredentialArgs,
   StatusListResult,
-  ToStatusListDetailsArgs,
   UpdateStatusListFromEncodedListArgs,
   UpdateStatusListIndexArgs,
 } from '../types'
@@ -171,44 +172,87 @@ export class StatusList2021Implementation implements IStatusList {
     return status ? Status2021.Invalid : Status2021.Valid
   }
 
-  async toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult & IStatusList2021ImplementationResult> {
-    const { statusListPayload } = args
-    const uniform = CredentialMapper.toUniformCredential(statusListPayload)
+  /**
+   * 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: StatusListCredential): Promise<IExtractedCredentialDetails> {
+    const uniform = CredentialMapper.toUniformCredential(credential)
     const { issuer, credentialSubject } = uniform
-    const id = getAssertedValue('id', uniform.id)
-    const encodedList = getAssertedProperty('encodedList', credentialSubject)
-    const proofFormat: CredentialProofFormat = CredentialMapper.detectDocumentType(statusListPayload) === DocumentFormat.JWT ? 'jwt' : 'lds'
-
-    const statusPurpose = getAssertedProperty('statusPurpose', credentialSubject)
-    const indexingDirection = 'rightToLeft'
-    const list = await StatusList.decode({ encodedList })
+    const subject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject
 
     return {
-      // Base implementation fields
-      id,
-      encodedList,
+      id: getAssertedValue('id', uniform.id),
       issuer,
-      type: StatusListType.StatusList2021,
-      proofFormat,
-      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,
+      encodedList: getAssertedProperty('encodedList', subject),
+    }
+  }
 
-      // Legacy nested structure for backward compatibility
-      statusList2021: {
-        indexingDirection,
+  async toStatusListDetails(args: IToDetailsFromCredentialArgs): Promise<StatusListResult & IStatusList2021ImplementationResult>
+  // For UPDATE contexts
+  async toStatusListDetails(args: IMergeDetailsWithEntityArgs): Promise<StatusListResult & IStatusList2021ImplementationResult>
+  async toStatusListDetails(
+    args: IToDetailsFromCredentialArgs | IMergeDetailsWithEntityArgs,
+  ): Promise<StatusListResult & IStatusList2021ImplementationResult> {
+    if ('statusListCredential' in args) {
+      // CREATE/READ context
+      const { statusListCredential, correlationId, driverType } = args
+      const uniform = CredentialMapper.toUniformCredential(statusListCredential)
+      const { issuer, credentialSubject } = uniform
+      const subject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject
+
+      const id = getAssertedValue('id', uniform.id)
+      const encodedList = getAssertedProperty('encodedList', subject)
+      const statusPurpose = getAssertedProperty('statusPurpose', subject)
+      const proofFormat: CredentialProofFormat = CredentialMapper.detectDocumentType(statusListCredential) === DocumentFormat.JWT ? 'jwt' : 'lds'
+      const list = await StatusList.decode({ encodedList })
+
+      return {
+        id,
+        encodedList,
+        issuer,
+        type: StatusListType.StatusList2021,
+        proofFormat,
+        length: list.length,
+        statusListCredential,
+        statuslistContentType: this.buildContentType(proofFormat),
+        correlationId,
+        driverType,
+        indexingDirection: 'rightToLeft',
         statusPurpose,
-
-        // Optional fields from args
-        ...(args.correlationId && { correlationId: args.correlationId }),
-        ...(args.driverType && { driverType: args.driverType }),
-      },
+        statusList2021: {
+          indexingDirection: 'rightToLeft',
+          statusPurpose,
+        },
+      }
+    } else {
+      // UPDATE context
+      const { extractedDetails, statusListEntity } = args
+      const statusList2021Entity = statusListEntity as StatusList2021Entity
+
+      const proofFormat: CredentialProofFormat =
+        CredentialMapper.detectDocumentType(statusListEntity.statusListCredential!) === DocumentFormat.JWT ? 'jwt' : 'lds'
+      const list = await StatusList.decode({ encodedList: extractedDetails.encodedList })
+
+      return {
+        id: extractedDetails.id,
+        encodedList: extractedDetails.encodedList,
+        issuer: extractedDetails.issuer,
+        type: StatusListType.StatusList2021,
+        proofFormat,
+        length: list.length,
+        statusListCredential: statusListEntity.statusListCredential!,
+        statuslistContentType: this.buildContentType(proofFormat),
+        correlationId: statusListEntity.correlationId,
+        driverType: statusListEntity.driverType,
+        indexingDirection: statusList2021Entity.indexingDirection,
+        statusPurpose: statusList2021Entity.statusPurpose,
+        statusList2021: {
+          indexingDirection: statusList2021Entity.indexingDirection,
+          statusPurpose: statusList2021Entity.statusPurpose,
+        },
+      }
     }
   }
 

package/src/index.ts

@@ -3,3 +3,4 @@
 
 export * from './types'
 export * from './functions'
+export { determineStatusListType } from './utils'

package/src/types/index.ts

@@ -19,6 +19,8 @@ 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'
+import { IExtractedCredentialDetails } from '../impl/IStatusList'
+import { BitstringStatusListArgs, IStatusListEntity } from '@sphereon/ssi-sdk.data-store'
 
 export enum StatusOAuth {
   Valid = 0,
@@ -31,8 +33,6 @@ export enum Status2021 {
   Invalid = 1,
 }
 
-export type BitstringStatus = number
-
 export type StatusList2021Args = {
   indexingDirection: StatusListIndexingDirection
   statusPurpose?: StatusPurpose2021
@@ -44,14 +44,6 @@ export type OAuthStatusListArgs = {
   expiresAt?: Date
 }
 
-export type BitstringStatusListArgs = {
-  statusPurpose: BitstringStatusPurpose
-  bitsPerStatus: number
-  ttl?: number
-  validFrom?: Date
-  validUntil?: Date
-}
-
 export type BaseCreateNewStatusListArgs = {
   type: StatusListType
   id: string
@@ -102,7 +94,7 @@ export interface UpdateStatusListFromStatusListCredentialArgs {
   statusListCredential: StatusListCredential // | CompactJWT
   keyRef?: string
   statusListIndex: number | string
-  value: number | Status2021 | StatusOAuth | BitstringStatus
+  value: number | Status2021 | StatusOAuth
 }
 
 export interface StatusListResult {
@@ -117,20 +109,6 @@ export interface StatusListResult {
   correlationId?: string
   driverType?: StatusListDriverType
 
-  // Flattened StatusList2021 fields
-  indexingDirection?: StatusListIndexingDirection
-  statusPurpose?: StatusPurpose2021 | BitstringStatusPurpose | BitstringStatusPurpose[]
-
-  // Flattened OAuth fields
-  bitsPerStatus?: number
-  expiresAt?: Date
-
-  // Flattened Bitstring fields
-  validFrom?: Date
-  validUntil?: Date
-  ttl?: number
-
-  // Legacy nested structures for backward compatibility
   statusList2021?: {
     indexingDirection: StatusListIndexingDirection
     statusPurpose: StatusPurpose2021
@@ -163,16 +141,6 @@ export interface StatusListOAuthEntryCredentialStatus extends ICredentialStatus
   expiresAt?: Date
 }
 
-export interface BitstringStatusListEntryCredentialStatus extends ICredentialStatus {
-  type: 'BitstringStatusListEntry'
-  statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
-  statusListIndex: string
-  statusListCredential: string
-  bitsPerStatus?: number
-  statusMessage?: Array<BitstringStatus>
-  statusReference?: string | string[]
-}
-
 export interface StatusList2021ToVerifiableCredentialArgs {
   issuer: string | IIssuer
   id: string
@@ -198,7 +166,7 @@ export interface CreateStatusListArgs {
 export interface UpdateStatusListIndexArgs {
   statusListCredential: StatusListCredential // | CompactJWT
   statusListIndex: number | string
-  value: number | Status2021 | StatusOAuth | BitstringStatus
+  value: number | Status2021 | StatusOAuth
   bitsPerStatus?: number
   keyRef?: string
   expiresAt?: Date
@@ -210,11 +178,22 @@ export interface CheckStatusIndexArgs {
   bitsPerStatus?: number
 }
 
-export interface ToStatusListDetailsArgs {
-  statusListPayload: StatusListCredential
+// For the CREATE and READ contexts
+export interface IToDetailsFromCredentialArgs {
+  // The source credential we are converting
+  statusListCredential: StatusListCredential
+
+  // The required metadata that is NOT in the credential itself
+  statusListType: StatusListType
+  bitsPerStatus?: number
   correlationId?: string
   driverType?: StatusListDriverType
-  bitsPerStatus?: number
+}
+
+// For the UPDATE context
+export interface IMergeDetailsWithEntityArgs {
+  extractedDetails: IExtractedCredentialDetails
+  statusListEntity: IStatusListEntity
 }
 
 /**

package/src/utils.ts

@@ -53,31 +53,60 @@ export function assertValidProofType(type: StatusListType, proofFormat: Credenti
 
 export function determineStatusListType(credential: StatusListCredential): StatusListType {
   const proofFormat = determineProofFormat(credential)
+
   switch (proofFormat) {
     case 'jwt':
-      const payload: StatusListCredential = jwtDecode(credential as string)
-      const keys = Object.keys(payload)
-      if (keys.includes('status_list')) {
-        return StatusListType.OAuthStatusList
-      } else if (keys.includes('vc')) {
-        return StatusListType.StatusList2021
-      }
-      break
+      return determineJwtStatusListType(credential as string)
     case 'lds':
-      const uniform = CredentialMapper.toUniformCredential(credential)
-      const type = uniform.type.find((t) => {
-        return Object.values(StatusListType).some((statusType) => t.includes(statusType))
-      })
-      if (!type) {
-        throw new Error('Invalid status list credential type')
-      }
-      return type.replace('Credential', '') as StatusListType
-
+      return determineLdsStatusListType(credential)
     case 'cbor':
       return StatusListType.OAuthStatusList
+    default:
+      throw new Error('Cannot determine status list type from credential payload')
+  }
+}
+
+function determineJwtStatusListType(credential: string): StatusListType {
+  const payload: any = jwtDecode(credential)
+
+  // OAuth status list format
+  if ('status_list' in payload) {
+    return StatusListType.OAuthStatusList
+  }
+
+  // Direct credential subject
+  if ('credentialSubject' in payload) {
+    return getStatusListTypeFromSubject(payload.credentialSubject)
+  }
+
+  // Wrapped VC format
+  if ('vc' in payload && 'credentialSubject' in payload.vc) {
+    return getStatusListTypeFromSubject(payload.vc.credentialSubject)
+  }
+
+  throw new Error('Invalid status list credential: credentialSubject not found')
+}
+
+function determineLdsStatusListType(credential: StatusListCredential): StatusListType {
+  const uniform = CredentialMapper.toUniformCredential(credential)
+  const statusListType = uniform.type.find((type) => Object.values(StatusListType).some((statusType) => type.includes(statusType)))
+
+  if (!statusListType) {
+    throw new Error('Invalid status list credential type')
   }
 
-  throw new Error('Cannot determine status list type from credential payload')
+  return statusListType.replace('Credential', '') as StatusListType
+}
+
+function getStatusListTypeFromSubject(credentialSubject: any): StatusListType {
+  switch (credentialSubject.type) {
+    case 'StatusList2021':
+      return StatusListType.StatusList2021
+    case 'BitstringStatusList':
+      return StatusListType.BitstringStatusList
+    default:
+      throw new Error(`Unknown credential subject type: ${credentialSubject.type}`)
+  }
 }
 
 export function determineProofFormat(credential: StatusListCredential): CredentialProofFormat {