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

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.11+b492941c",
+  "version": "0.34.1-feature.SSISDK.17.bitstring.sl.14+35c8ca99",
   "source": "src/index.ts",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -31,8 +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.data-store": "0.34.1-feature.SSISDK.17.bitstring.sl.11+b492941c",
-    "@sphereon/ssi-types": "0.34.1-feature.SSISDK.17.bitstring.sl.11+b492941c",
+    "@sphereon/ssi-sdk.credential-vcdm": "0.34.1-feature.SSISDK.17.bitstring.sl.14+35c8ca99",
+    "@sphereon/ssi-sdk.data-store": "0.34.1-feature.SSISDK.17.bitstring.sl.14+35c8ca99",
+    "@sphereon/ssi-types": "0.34.1-feature.SSISDK.17.bitstring.sl.14+35c8ca99",
     "@sphereon/vc-status-list": "7.0.0-next.0",
     "@veramo/core": "4.2.0",
     "@veramo/credential-status": "4.2.0",
@@ -71,5 +72,5 @@
     "SSI",
     "StatusList2021"
   ],
-  "gitHead": "b492941ccbdde19ae30ec024956ca9f6f336a699"
+  "gitHead": "35c8ca99b499927dfffd929ae709750a7337b017"
 }

package/src/functions.ts

@@ -1,25 +1,22 @@
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
-import {
-  CredentialMapper,
-  type CredentialProofFormat,
-  DocumentFormat,
-  type StatusListCredential,
-  StatusListDriverType,
-  StatusListType,
-  type StatusPurpose2021,
-} from '@sphereon/ssi-types'
-import type { CredentialStatus, DIDDocument, IAgentContext, ICredentialPlugin, ProofFormat as VeramoProofFormat } from '@veramo/core'
+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,6 +28,13 @@ import {
 } from './types'
 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'
 
 export async function fetchStatusListCredential(args: { statusListCredential: string }): Promise<StatusListCredential> {
   const url = getAssertedValue('statusListCredential', args.statusListCredential)
@@ -142,7 +146,7 @@ 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),
@@ -156,7 +160,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)
@@ -164,7 +168,7 @@ export async function checkStatusIndexFromStatusListCredential(args: {
 
 export async function createNewStatusList(
   args: CreateNewStatusListFuncArgs,
-  context: IAgentContext<(ICredentialPlugin | any) /*IvcdMCredentialPlugin is not available*/ & IIdentifierResolution>,
+  context: IAgentContext<(IVcdmCredentialPlugin | any) /*IvcdMCredentialPlugin is not available*/ & IIdentifierResolution>,
 ): Promise<StatusListResult> {
   const { type } = getAssertedValues(args)
   const implementation = getStatusListImplementation(type)
@@ -173,7 +177,7 @@ export async function createNewStatusList(
 
 export async function updateStatusIndexFromStatusListCredential(
   args: UpdateStatusListIndexArgs,
-  context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
 ): Promise<StatusListResult> {
   const credential = getAssertedValue('statusListCredential', args.statusListCredential)
   const statusListType: StatusListType = determineStatusListType(credential)
@@ -181,52 +185,36 @@ export async function updateStatusIndexFromStatusListCredential(
   return implementation.updateStatusListIndex(args, context)
 }
 
-export async function statusListCredentialToDetails({
-  correlationId,
-  driverType,
-  statusListCredential,
-  bitsPerStatus,
-}: {
-  statusListCredential: StatusListCredential
-  correlationId?: string
-  driverType?: StatusListDriverType
-  bitsPerStatus?: number
-}): Promise<StatusListResult & Partial<IAddStatusListArgs>> {
-  const credential = getAssertedValue('statusListCredential', statusListCredential)
-
-  let statusListType: StatusListType | undefined
-  const documentFormat = CredentialMapper.detectDocumentType(credential)
-  if (documentFormat === DocumentFormat.JWT) {
-    const [header] = credential.split('.')
-    const decodedHeader = JSON.parse(Buffer.from(header, 'base64').toString())
-
-    if (decodedHeader.typ === 'statuslist+jwt') {
-      statusListType = StatusListType.OAuthStatusList
-    }
-  } else if (documentFormat === DocumentFormat.MSO_MDOC) {
-    statusListType = StatusListType.OAuthStatusList
-    // TODO check CBOR content?
-  }
-  if (!statusListType) {
-    const uniform = CredentialMapper.toUniformCredential(credential)
-    const type = uniform.type.find((t) => t.includes('StatusList2021') || t.includes('OAuth2StatusList') || t.includes('BitstringStatusList'))
-    if (!type) {
-      throw new Error('Invalid status list credential type')
-    }
-    statusListType = type.replace('Credential', '') as StatusListType
-  }
-
+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)>
 
-  return result
+export async function toStatusListDetails(
+  args: IMergeDetailsWithEntityArgs,
+): Promise<StatusListResult & (IStatusList2021ImplementationResult | IOAuthStatusListImplementationResult | IBitstringStatusListImplementationResult)>
+
+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)
+  }
 }
 
 export async function createCredentialStatusFromStatusList(args: {
@@ -250,7 +238,7 @@ export async function createCredentialStatusFromStatusList(args: {
 
 export async function updateStatusListIndexFromEncodedList(
   args: UpdateStatusListFromEncodedListArgs,
-  context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
 ): Promise<StatusListResult> {
   const { type } = getAssertedValue('type', args)
   const implementation = getStatusListImplementation(type!)
@@ -259,7 +247,7 @@ export async function updateStatusListIndexFromEncodedList(
 
 export async function statusList2021ToVerifiableCredential(
   args: StatusList2021ToVerifiableCredentialArgs,
-  context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  context: IAgentContext<IVcdmCredentialPlugin & IIdentifierResolution>,
 ): Promise<StatusListCredential> {
   const { issuer, id, type } = getAssertedValues(args)
   const identifier = await context.agent.identifierManagedGet({