@sphereon/ssi-sdk.vc-status-list 0.34.1-next.7 → 0.34.1-next.85

package/src/types/index.ts

@@ -1,31 +1,26 @@
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import {
+  type CredentialProofFormat,
   type ICredential,
   type ICredentialStatus,
   type IIssuer,
   type IVerifiableCredential,
   type OrPromise,
-  type CredentialProofFormat,
   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,
@@ -45,7 +40,7 @@ export type StatusList2021Args = {
 }
 
 export type OAuthStatusListArgs = {
-  bitsPerStatus?: BitsPerStatus
+  bitsPerStatus: BitsPerStatus
   expiresAt?: Date
 }
 
@@ -59,6 +54,7 @@ export type BaseCreateNewStatusListArgs = {
   keyRef?: string
   statusList2021?: StatusList2021Args
   oauthStatusList?: OAuthStatusListArgs
+  bitstringStatusList?: BitstringStatusListArgs
   driverType?: StatusListDriverType
 }
 
@@ -71,10 +67,18 @@ export type UpdateOAuthStatusListArgs = {
   expiresAt?: Date
 }
 
+export type UpdateBitstringStatusListArgs = {
+  statusPurpose: BitstringStatusPurpose
+  bitsPerStatus: number
+  validFrom?: Date
+  validUntil?: Date
+  ttl?: number
+}
+
 export interface UpdateStatusListFromEncodedListArgs {
   type?: StatusListType
   statusListIndex: number | string
-  value: boolean
+  value: number
   proofFormat?: CredentialProofFormat
   keyRef?: string
   correlationId?: string
@@ -83,6 +87,7 @@ export interface UpdateStatusListFromEncodedListArgs {
   id: string
   statusList2021?: UpdateStatusList2021Args
   oauthStatusList?: UpdateOAuthStatusListArgs
+  bitstringStatusList?: UpdateBitstringStatusListArgs
 }
 
 export interface UpdateStatusListFromStatusListCredentialArgs {
@@ -93,31 +98,32 @@ 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
-
-  // 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
+  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 {
@@ -154,12 +160,14 @@ export interface CreateStatusListArgs {
   length?: number
   statusList2021?: StatusList2021Args
   oauthStatusList?: OAuthStatusListArgs
+  bitstringStatusList?: BitstringStatusListArgs
 }
 
 export interface UpdateStatusListIndexArgs {
   statusListCredential: StatusListCredential // | CompactJWT
   statusListIndex: number | string
   value: number | Status2021 | StatusOAuth
+  bitsPerStatus?: number
   keyRef?: string
   expiresAt?: Date
 }
@@ -167,14 +175,27 @@ export interface UpdateStatusListIndexArgs {
 export interface CheckStatusIndexArgs {
   statusListCredential: StatusListCredential // | CompactJWT
   statusListIndex: string | number
+  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
 }
 
+// For the UPDATE context
+export interface IMergeDetailsWithEntityArgs {
+  extractedDetails: IExtractedCredentialDetails
+  statusListEntity: IStatusListEntity
+}
+
 /**
  * The interface definition for a plugin that can add statuslist info to a credential
  *
@@ -260,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

@@ -11,7 +11,7 @@ import { jwtDecode } from 'jwt-decode'
 
 export function getAssertedStatusListType(type?: StatusListType) {
   const assertedType = type ?? StatusListType.StatusList2021
-  if (![StatusListType.StatusList2021, StatusListType.OAuthStatusList].includes(assertedType)) {
+  if (![StatusListType.StatusList2021, StatusListType.OAuthStatusList, StatusListType.BitstringStatusList].includes(assertedType)) {
     throw Error(`StatusList type ${assertedType} is not supported (yet)`)
   }
   return assertedType
@@ -39,8 +39,9 @@ export function getAssertedProperty<T extends object>(propertyName: string, obj:
 }
 
 const ValidProofTypeMap = new Map<StatusListType, CredentialProofFormat[]>([
-  [StatusListType.StatusList2021, ['jwt', 'lds', 'EthereumEip712Signature2021']],
+  [StatusListType.StatusList2021, ['jwt', 'lds']],
   [StatusListType.OAuthStatusList, ['jwt', 'cbor']],
+  [StatusListType.BitstringStatusList, ['lds', 'vc+jwt']],
 ])
 
 export function assertValidProofType(type: StatusListType, proofFormat: CredentialProofFormat) {
@@ -52,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 {
@@ -93,3 +123,35 @@ export function determineProofFormat(credential: StatusListCredential): Credenti
       throw Error('Cannot determine credential payload type')
   }
 }
+
+/**
+ * Ensures a value is converted to a Date object if it's a valid date string,
+ * otherwise returns the original value or undefined
+ *
+ * @param value - The value to convert to Date (can be Date, string, or undefined)
+ * @returns Date object, undefined, or the original value if conversion fails
+ */
+export function ensureDate(value: Date | string | undefined): Date | undefined {
+  if (value === undefined || value === null) {
+    return undefined
+  }
+
+  if (value instanceof Date) {
+    return value
+  }
+
+  if (typeof value === 'string') {
+    if (value.trim() === '') {
+      return undefined
+    }
+
+    const date = new Date(value)
+    // Check if the date is valid
+    if (isNaN(date.getTime())) {
+      return undefined
+    }
+    return date
+  }
+
+  return undefined
+}