@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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sphereon/ssi-sdk.vc-status-list",
   "description": "Sphereon SSI-SDK plugin for Status List management, like StatusList2021.",
-  "version": "0.34.1-feature.SSISDK.17.bitstring.sl.13+61bcf6d3",
+  "version": "0.34.1-feature.SSISDK.17.bitstring.sl.16+6964608d",
   "source": "src/index.ts",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -31,9 +31,9 @@
     "@sphereon/ssi-sdk-ext.did-utils": "0.29.0",
     "@sphereon/ssi-sdk-ext.identifier-resolution": "0.29.0",
     "@sphereon/ssi-sdk-ext.jwt-service": "0.29.0",
-    "@sphereon/ssi-sdk.credential-vcdm": "0.34.1-feature.SSISDK.17.bitstring.sl.13+61bcf6d3",
-    "@sphereon/ssi-sdk.data-store": "0.34.1-feature.SSISDK.17.bitstring.sl.13+61bcf6d3",
-    "@sphereon/ssi-types": "0.34.1-feature.SSISDK.17.bitstring.sl.13+61bcf6d3",
+    "@sphereon/ssi-sdk.credential-vcdm": "0.34.1-feature.SSISDK.17.bitstring.sl.16+6964608d",
+    "@sphereon/ssi-sdk.data-store": "0.34.1-feature.SSISDK.17.bitstring.sl.16+6964608d",
+    "@sphereon/ssi-types": "0.34.1-feature.SSISDK.17.bitstring.sl.16+6964608d",
     "@sphereon/vc-status-list": "7.0.0-next.0",
     "@veramo/core": "4.2.0",
     "@veramo/credential-status": "4.2.0",
@@ -72,5 +72,5 @@
     "SSI",
     "StatusList2021"
   ],
-  "gitHead": "61bcf6d37bcb3d77036b5415d72853c3ba3f9273"
+  "gitHead": "6964608dcd10f9cc0935ef31e7dec85fb4fe55fd"
 }

package/src/functions.ts

@@ -1,24 +1,22 @@
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
-import {
-  CredentialMapper,
-  type CredentialProofFormat,
-  type StatusListCredential,
-  StatusListDriverType,
-  StatusListType,
-  type StatusPurpose2021,
-} from '@sphereon/ssi-types'
+import { CredentialMapper, type CredentialProofFormat, type StatusListCredential, StatusListType, type StatusPurpose2021 } from '@sphereon/ssi-types'
 import type { CredentialStatus, DIDDocument, IAgentContext, ProofFormat as VeramoProofFormat } from '@veramo/core'
 
-import { IAddStatusListArgs, IBitstringStatusListEntryEntity, IStatusListEntryEntity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
+import {
+  BitstringStatusListEntryCredentialStatus,
+  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,
+  IMergeDetailsWithEntityArgs,
+  IToDetailsFromCredentialArgs,
   Status2021,
   StatusList2021EntryCredentialStatus,
   StatusList2021ToVerifiableCredentialArgs,
@@ -31,7 +29,18 @@ import {
 import { assertValidProofType, determineStatusListType, getAssertedValue, getAssertedValues } from './utils'
 import { getStatusListImplementation } from './impl/StatusListFactory'
 import { IVcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm'
+import {
+  IBitstringStatusListImplementationResult,
+  IExtractedCredentialDetails,
+  IOAuthStatusListImplementationResult,
+  IStatusList2021ImplementationResult,
+} from './impl/IStatusList'
 
+/**
+ * Fetches a status list credential from a URL
+ * @param args - Object containing the status list credential URL
+ * @returns Promise resolving to the fetched StatusListCredential
+ */
 export async function fetchStatusListCredential(args: { statusListCredential: string }): Promise<StatusListCredential> {
   const url = getAssertedValue('statusListCredential', args.statusListCredential)
   try {
@@ -50,6 +59,11 @@ export async function fetchStatusListCredential(args: { statusListCredential: st
   }
 }
 
+/**
+ * Creates a status checking function for credential-status plugin
+ * @param args - Configuration options for status verification
+ * @returns StatusMethod function for checking credential status
+ */
 export function statusPluginStatusFunction(args: {
   documentLoader: any
   suite: any
@@ -75,7 +89,8 @@ export function statusPluginStatusFunction(args: {
 
 /**
  * Function that can be used together with @digitalbazar/vc and @digitialcredentials/vc
- * @param args
+ * @param args - Configuration options for status verification
+ * @returns Function for checking credential status
  */
 export function vcLibCheckStatusFunction(args: {
   mandatoryCredentialStatus?: boolean
@@ -102,6 +117,11 @@ export function vcLibCheckStatusFunction(args: {
   }
 }
 
+/**
+ * Checks the status of a credential using its credential status information
+ * @param args - Parameters for credential status verification
+ * @returns Promise resolving to verification result with error details if any
+ */
 export async function checkStatusForCredential(args: {
   credential: StatusListCredential
   documentLoader: any
@@ -142,13 +162,18 @@ export async function simpleCheckStatusFromStatusListUrl(args: {
   type?: StatusListType | 'StatusList2021Entry'
   id?: string
   statusListIndex: string
-}): Promise<number | Status2021 | StatusOAuth | BitstringStatus> {
+}): Promise<number | Status2021 | StatusOAuth> {
   return checkStatusIndexFromStatusListCredential({
     ...args,
     statusListCredential: await fetchStatusListCredential(args),
   })
 }
 
+/**
+ * Checks the status at a specific index in a status list credential
+ * @param args - Parameters including credential and index to check
+ * @returns Promise resolving to status value at the specified index
+ */
 export async function checkStatusIndexFromStatusListCredential(args: {
   statusListCredential: StatusListCredential
   statusPurpose?: StatusPurpose2021 | string | string[]
@@ -156,7 +181,7 @@ export async function checkStatusIndexFromStatusListCredential(args: {
   id?: string
   statusListIndex: string | number
   bitsPerStatus?: number
-}): Promise<number | Status2021 | StatusOAuth | BitstringStatus> {
+}): Promise<number | Status2021 | StatusOAuth> {
   const statusListType: StatusListType = determineStatusListType(args.statusListCredential)
   const implementation = getStatusListImplementation(statusListType)
   return implementation.checkStatusIndex(args)
@@ -171,6 +196,12 @@ export async function createNewStatusList(
   return implementation.createNewStatusList(args, context)
 }
 
+/**
+ * Updates a status index in a status list credential
+ * @param args - Parameters for status update including credential and new value
+ * @param context - Agent context with required plugins
+ * @returns Promise resolving to updated status list details
+ */
 export async function updateStatusIndexFromStatusListCredential(
   args: UpdateStatusListIndexArgs,
   context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
@@ -181,33 +212,54 @@ export async function updateStatusIndexFromStatusListCredential(
   return implementation.updateStatusListIndex(args, context)
 }
 
-export async function statusListCredentialToDetails({
-  statusListType,
-  correlationId,
-  driverType,
-  statusListCredential,
-  bitsPerStatus,
-}: {
-  statusListType: StatusListType
-  statusListCredential: StatusListCredential
-  correlationId?: string
-  driverType?: StatusListDriverType
-  bitsPerStatus?: number
-}): Promise<StatusListResult & Partial<IAddStatusListArgs>> {
-  const credential = getAssertedValue('statusListCredential', statusListCredential)
+/**
+ * Extracts credential details from a status list credential
+ * @param statusListCredential - The status list credential to extract from
+ * @returns Promise resolving to extracted credential details
+ */
+export async function extractCredentialDetails(statusListCredential: StatusListCredential): Promise<IExtractedCredentialDetails> {
+  const statusListType = determineStatusListType(statusListCredential)
   const implementation = getStatusListImplementation(statusListType)
+  return implementation.extractCredentialDetails(statusListCredential)
+}
 
-  // 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,
-  })
+export async function toStatusListDetails(
+  args: IToDetailsFromCredentialArgs,
+): Promise<StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)>
+
+export async function toStatusListDetails(
+  args: IMergeDetailsWithEntityArgs,
+): Promise<StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)>
 
-  return result
+/**
+ * Converts credential and metadata into detailed status list information
+ * Handles both CREATE/READ and UPDATE contexts based on input arguments
+ * @param args - Either credential-based args or entity-based args for merging
+ * @returns Promise resolving to complete status list details
+ */
+export async function toStatusListDetails(
+  args: IToDetailsFromCredentialArgs | IMergeDetailsWithEntityArgs,
+): Promise<
+  StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)
+> {
+  if ('statusListCredential' in args) {
+    // CREATE/READ context
+    const statusListType = args.statusListType
+    const implementation = getStatusListImplementation(statusListType)
+    return implementation.toStatusListDetails(args)
+  } else {
+    // UPDATE context
+    const statusListType = args.statusListEntity.type
+    const implementation = getStatusListImplementation(statusListType)
+    return implementation.toStatusListDetails(args)
+  }
 }
 
+/**
+ * Creates a credential status object from status list and entry information
+ * @param args - Parameters including status list, entry, and index
+ * @returns Promise resolving to appropriate credential status type
+ */
 export async function createCredentialStatusFromStatusList(args: {
   statusList: StatusListEntity
   statusListEntry: IStatusListEntryEntity | IBitstringStatusListEntryEntity
@@ -227,6 +279,12 @@ export async function createCredentialStatusFromStatusList(args: {
   })
 }
 
+/**
+ * Updates a status list using a base64 encoded list of statuses
+ * @param args - Parameters including encoded list and update details
+ * @param context - Agent context with required plugins
+ * @returns Promise resolving to updated status list details
+ */
 export async function updateStatusListIndexFromEncodedList(
   args: UpdateStatusListFromEncodedListArgs,
   context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
@@ -236,6 +294,12 @@ export async function updateStatusListIndexFromEncodedList(
   return implementation.updateStatusListFromEncodedList(args, context)
 }
 
+/**
+ * Converts a StatusList2021 to a verifiable credential
+ * @param args - Parameters for credential creation including issuer and encoded list
+ * @param context - Agent context with required plugins
+ * @returns Promise resolving to signed status list credential
+ */
 export async function statusList2021ToVerifiableCredential(
   args: StatusList2021ToVerifiableCredentialArgs,
   context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,

package/src/impl/BitstringStatusListImplementation.ts

@@ -28,14 +28,13 @@ import {
   StatusListType,
 } from '@sphereon/ssi-types'
 
-import type { IBitstringStatusListImplementationResult, IStatusList } from './IStatusList'
+import type { IBitstringStatusListImplementationResult, IExtractedCredentialDetails, IStatusList } from './IStatusList'
 import {
-  BitstringStatus,
-  BitstringStatusListEntryCredentialStatus,
   CheckStatusIndexArgs,
   CreateStatusListArgs,
+  IMergeDetailsWithEntityArgs,
+  IToDetailsFromCredentialArgs,
   StatusListResult,
-  ToStatusListDetailsArgs,
   UpdateStatusListFromEncodedListArgs,
   UpdateStatusListIndexArgs,
 } from '../types'
@@ -48,11 +47,17 @@ import {
   BitstringStatusPurpose,
   createStatusListCredential,
 } from '@4sure-tech/vc-bitstring-status-lists'
-import { BitstringStatusListEntity, IBitstringStatusListEntryEntity, IStatusListEntryEntity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
+import {
+  BitstringStatusListEntity,
+  BitstringStatusListEntryCredentialStatus,
+  IBitstringStatusListEntryEntity,
+  IStatusListEntryEntity,
+  StatusListEntity,
+} from '@sphereon/ssi-sdk.data-store'
 import { IVcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm'
 
 export const DEFAULT_LIST_LENGTH = 131072 // W3C spec minimum
-export const DEFAULT_PROOF_FORMAT = 'lds' as CredentialProofFormat
+export const DEFAULT_PROOF_FORMAT = 'vc+jwt' as CredentialProofFormat
 export const DEFAULT_STATUS_PURPOSE: BitstringStatusPurpose = 'revocation'
 
 /**
@@ -148,9 +153,10 @@ export class BitstringStatusListImplementation implements IStatusList {
 
     const index = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
     const statusList: BitstreamStatusList = await BitstreamStatusList.decode({ encodedList: origEncodedList, statusSize: args.bitsPerStatus })
-    statusList.setStatus(index, args.value)
+    const bitstringStatusId = args.value as number
+    statusList.setStatus(index, bitstringStatusId)
 
-    const proofFormat = CredentialMapper.detectDocumentType(credential) === DocumentFormat.JWT ? 'jwt' : 'lds'
+    const proofFormat = CredentialMapper.detectDocumentType(credential) === DocumentFormat.JWT ? 'vc+jwt' : 'lds'
 
     const credSubject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject
 
@@ -275,7 +281,7 @@ export class BitstringStatusListImplementation implements IStatusList {
    * @param args - Check parameters including the status list credential and index
    * @returns Promise resolving to the status value at the specified index
    */
-  async checkStatusIndex(args: CheckStatusIndexArgs): Promise<BitstringStatus> {
+  async checkStatusIndex(args: CheckStatusIndexArgs): Promise<number> {
     if (!args.bitsPerStatus || args.bitsPerStatus < 1) {
       return Promise.reject(Error('bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (checkStatusIndex)'))
     }
@@ -293,61 +299,115 @@ export class BitstringStatusListImplementation implements IStatusList {
   }
 
   /**
-   * Converts a status list credential payload to detailed status list information
-   *
-   * @param args - Conversion parameters including the status list payload
-   * @returns Promise resolving to detailed status list information
+   * 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 toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult & IBitstringStatusListImplementationResult> {
-    const { statusListPayload, bitsPerStatus } = args
-    if (!bitsPerStatus || bitsPerStatus < 1) {
-      return Promise.reject(Error('bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (toStatusListDetails)'))
-    }
-
-    const uniform = CredentialMapper.toUniformCredential(statusListPayload)
+  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 ? 'vc+jwt' : 'lds'
-    const credSubject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject
-    const statusPurpose = getAssertedProperty('statusPurpose', credSubject)
-    const validFrom = uniform.validFrom ? new Date(uniform.validFrom) : undefined
-    const validUntil = uniform.validUntil ? new Date(uniform.validUntil) : undefined
-    const ttl = credSubject.ttl
-    const statuslistLength: number = BitstreamStatusList.getStatusListLength(encodedList, bitsPerStatus)
+    const subject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject
 
     return {
-      // Base implementation fields
-      id,
-      encodedList,
+      id: getAssertedValue('id', uniform.id),
       issuer,
-      type: StatusListType.BitstringStatusList,
-      proofFormat,
-      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 }),
+      encodedList: getAssertedProperty('encodedList', subject),
+    }
+  }
 
-      // Legacy nested structure for backward compatibility
-      bitstringStatusList: {
+  /**
+   * Converts a status list credential payload to detailed status list information
+   *
+   * @param args - Conversion parameters including the status list payload
+   * @returns Promise resolving to detailed status list information
+   */
+  // For CREATE and READ contexts
+  async toStatusListDetails(args: IToDetailsFromCredentialArgs): Promise<StatusListResult & IBitstringStatusListImplementationResult>
+  // For UPDATE contexts
+  async toStatusListDetails(args: IMergeDetailsWithEntityArgs): Promise<StatusListResult & IBitstringStatusListImplementationResult>
+  async toStatusListDetails(
+    args: IToDetailsFromCredentialArgs | IMergeDetailsWithEntityArgs,
+  ): Promise<StatusListResult & IBitstringStatusListImplementationResult> {
+    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 bitstring status lists and must be 1 or higher'))
+      }
+
+      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 validFrom = uniform.validFrom ? new Date(uniform.validFrom) : undefined
+      const validUntil = uniform.validUntil ? new Date(uniform.validUntil) : undefined
+      const ttl = subject.ttl
+      const proofFormat: CredentialProofFormat = CredentialMapper.detectDocumentType(statusListCredential) === DocumentFormat.JWT ? 'vc+jwt' : 'lds'
+      const statuslistLength = BitstreamStatusList.getStatusListLength(encodedList, bitsPerStatus)
+
+      return {
+        id,
+        encodedList,
+        issuer,
+        type: StatusListType.BitstringStatusList,
+        proofFormat,
+        length: statuslistLength,
+        statusListCredential,
+        statuslistContentType: this.buildContentType(proofFormat),
+        correlationId,
+        driverType,
         statusPurpose,
         bitsPerStatus,
         ...(validFrom && { validFrom }),
         ...(validUntil && { validUntil }),
         ...(ttl && { ttl }),
-      },
-
-      // Optional fields from args
-      ...(args.correlationId && { correlationId: args.correlationId }),
-      ...(args.driverType && { driverType: args.driverType }),
+        bitstringStatusList: {
+          statusPurpose,
+          bitsPerStatus,
+          ...(validFrom && { validFrom }),
+          ...(validUntil && { validUntil }),
+          ...(ttl && { ttl }),
+        },
+      }
+    } else {
+      // UPDATE context
+      const { extractedDetails, statusListEntity } = args
+      const bitstringEntity = statusListEntity as BitstringStatusListEntity
+      if (!bitstringEntity.bitsPerStatus) {
+        return Promise.reject(Error('bitsPerStatus must be present for a bitstring status list'))
+      }
+
+      const proofFormat: CredentialProofFormat =
+        CredentialMapper.detectDocumentType(statusListEntity.statusListCredential!) === DocumentFormat.JWT ? 'vc+jwt' : 'lds'
+      const statuslistLength = BitstreamStatusList.getStatusListLength(extractedDetails.encodedList, bitstringEntity.bitsPerStatus)
+
+      return {
+        id: extractedDetails.id,
+        encodedList: extractedDetails.encodedList,
+        issuer: extractedDetails.issuer,
+        type: StatusListType.BitstringStatusList,
+        proofFormat,
+        length: statuslistLength,
+        statusListCredential: statusListEntity.statusListCredential!,
+        statuslistContentType: this.buildContentType(proofFormat),
+        correlationId: statusListEntity.correlationId,
+        driverType: statusListEntity.driverType,
+        statusPurpose: bitstringEntity.statusPurpose,
+        bitsPerStatus: bitstringEntity.bitsPerStatus,
+        ...(bitstringEntity.validFrom && { validFrom: bitstringEntity.validFrom }),
+        ...(bitstringEntity.validUntil && { validUntil: bitstringEntity.validUntil }),
+        ...(bitstringEntity.ttl && { ttl: bitstringEntity.ttl }),
+        bitstringStatusList: {
+          statusPurpose: bitstringEntity.statusPurpose,
+          bitsPerStatus: bitstringEntity.bitsPerStatus,
+          ...(bitstringEntity.validFrom && { validFrom: bitstringEntity.validFrom }),
+          ...(bitstringEntity.validUntil && { validUntil: bitstringEntity.validUntil }),
+          ...(bitstringEntity.ttl && { ttl: bitstringEntity.ttl }),
+        },
+      }
     }
   }
 
@@ -364,25 +424,17 @@ export class BitstringStatusListImplementation implements IStatusList {
   }): 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
-
+    const bitstringStatusListEntry = statusListEntry as IBitstringStatusListEntryEntity
     return {
       id: `${statusList.id}#${statusListIndex}`,
       type: 'BitstringStatusListEntry',
-      statusPurpose: statusListEntry.statusPurpose,
+      statusPurpose: bitstringStatusListEntry.statusPurpose,
       statusListIndex: '' + statusListIndex,
       statusListCredential: statusList.id,
       bitsPerStatus: bitstringStatusList.bitsPerStatus,
+      statusMessage: bitstringStatusListEntry.statusMessage,
+      statusReference: bitstringStatusListEntry.statusReference,
     } satisfies BitstringStatusListEntryCredentialStatus
   }
 

package/src/impl/IStatusList.ts

@@ -1,16 +1,15 @@
 import type { IAgentContext } from '@veramo/core'
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import {
-  BitstringStatus,
-  BitstringStatusListEntryCredentialStatus,
   CheckStatusIndexArgs,
   CreateStatusListArgs,
+  IMergeDetailsWithEntityArgs,
+  IToDetailsFromCredentialArgs,
   Status2021,
   StatusList2021EntryCredentialStatus,
   StatusListOAuthEntryCredentialStatus,
   StatusListResult,
   StatusOAuth,
-  ToStatusListDetailsArgs,
   UpdateStatusListFromEncodedListArgs,
   UpdateStatusListIndexArgs,
 } from '../types'
@@ -24,8 +23,21 @@ import {
   StatusListType,
   StatusPurpose2021,
 } from '@sphereon/ssi-types'
-import { IBitstringStatusListEntryEntity, IStatusListEntryEntity, StatusListEntity } from '@sphereon/ssi-sdk.data-store'
+import {
+  BitstringStatusListEntryCredentialStatus,
+  IBitstringStatusListEntryEntity,
+  IStatusListEntryEntity,
+  StatusListEntity,
+} from '@sphereon/ssi-sdk.data-store'
 import { IVcdmCredentialPlugin } from '@sphereon/ssi-sdk.credential-vcdm'
+import { DecodedStatusListPayload } from './encoding/common'
+
+export interface IExtractedCredentialDetails {
+  id: string
+  issuer: string | IIssuer
+  encodedList: string
+  decodedPayload?: DecodedStatusListPayload
+}
 
 export interface IStatusList {
   /**
@@ -52,13 +64,29 @@ export interface IStatusList {
   /**
    * Checks the status at a given index in the status list
    */
-  checkStatusIndex(args: CheckStatusIndexArgs): Promise<number | Status2021 | StatusOAuth | BitstringStatus>
+  checkStatusIndex(args: CheckStatusIndexArgs): Promise<number | Status2021 | StatusOAuth>
+
+  /**
+   * 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.
+   */
+  extractCredentialDetails(credential: StatusListCredential): Promise<IExtractedCredentialDetails>
+
+  /**
+   * Converts a credential and its known metadata into a full StatusListResult.
+   */
+  toStatusListDetails(
+    args: IToDetailsFromCredentialArgs,
+  ): Promise<
+    StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)
+  >
 
   /**
-   * Collects the status list details - returns flattened entity data ready for storage
+   * Merges pre-parsed details from a new credential with an existing database entity.
    */
   toStatusListDetails(
-    args: ToStatusListDetailsArgs,
+    args: IMergeDetailsWithEntityArgs,
   ): Promise<
     StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)
   >