@sphereon/ssi-sdk.vc-status-list 0.34.1-feature.SSISDK.17.bitstring.sl.9 → 0.34.1-next.29

package/src/types/index.ts

@@ -7,26 +7,20 @@ 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'
+import { IExtractedCredentialDetails } from '../impl/IStatusList'
+import { BitstringStatusListArgs, IStatusListEntity } from '@sphereon/ssi-sdk.data-store'
 
 export enum StatusOAuth {
   Valid = 0,
@@ -39,8 +33,6 @@ export enum Status2021 {
   Invalid = 1,
 }
 
-export type BitstringStatus = number
-
 export type StatusList2021Args = {
   indexingDirection: StatusListIndexingDirection
   statusPurpose?: StatusPurpose2021
@@ -48,18 +40,10 @@ export type StatusList2021Args = {
 }
 
 export type OAuthStatusListArgs = {
-  bitsPerStatus?: BitsPerStatus
+  bitsPerStatus: BitsPerStatus
   expiresAt?: Date
 }
 
-export type BitstringStatusListArgs = {
-  statusPurpose: BitstringStatusPurpose
-  bitsPerStatus: number
-  ttl?: number
-  validFrom?: Date
-  validUntil?: Date
-}
-
 export type BaseCreateNewStatusListArgs = {
   type: StatusListType
   id: string
@@ -110,44 +94,36 @@ export interface UpdateStatusListFromStatusListCredentialArgs {
   statusListCredential: StatusListCredential // | CompactJWT
   keyRef?: string
   statusListIndex: number | string
-  value: number | Status2021 | StatusOAuth | BitstringStatus
+  value: number | Status2021 | StatusOAuth
 }
 
 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
-}
 
-interface OAuthStatusDetails {
-  bitsPerStatus?: BitsPerStatus
-  expiresAt?: Date
-}
-
-interface BitstringStatusDetails {
-  statusPurpose: BitstringStatusPurpose
-  bitsPerStatus: number
-  validFrom?: Date
-  validUntil?: Date
-  ttl?: number
+  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 {
@@ -165,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
@@ -200,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
@@ -212,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
 }
 
 /**
@@ -304,5 +281,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) {
@@ -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 {