@sphereon/ssi-sdk.data-store 0.34.1-feature.SSISDK.17.bitstring.sl.10 → 0.34.1-feature.SSISDK.17.bitstring.sl.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sphereon/ssi-sdk.data-store",
-  "version": "0.34.1-feature.SSISDK.17.bitstring.sl.10+f36e76fe",
+  "version": "0.34.1-feature.SSISDK.17.bitstring.sl.11+b492941c",
   "source": "src/index.ts",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -30,9 +30,9 @@
     "@sphereon/pex": "5.0.0-unstable.28",
     "@sphereon/ssi-sdk-ext.did-utils": "0.29.0",
     "@sphereon/ssi-sdk-ext.identifier-resolution": "0.29.0",
-    "@sphereon/ssi-sdk.agent-config": "0.34.1-feature.SSISDK.17.bitstring.sl.10+f36e76fe",
-    "@sphereon/ssi-sdk.core": "0.34.1-feature.SSISDK.17.bitstring.sl.10+f36e76fe",
-    "@sphereon/ssi-types": "0.34.1-feature.SSISDK.17.bitstring.sl.10+f36e76fe",
+    "@sphereon/ssi-sdk.agent-config": "0.34.1-feature.SSISDK.17.bitstring.sl.11+b492941c",
+    "@sphereon/ssi-sdk.core": "0.34.1-feature.SSISDK.17.bitstring.sl.11+b492941c",
+    "@sphereon/ssi-types": "0.34.1-feature.SSISDK.17.bitstring.sl.11+b492941c",
     "@veramo/core": "4.2.0",
     "@veramo/utils": "4.2.0",
     "blakejs": "^1.2.1",
@@ -65,5 +65,5 @@
     "PostgreSQL",
     "Contact Store"
   ],
-  "gitHead": "f36e76fe5f4eb4e7303ddbe275e867144762b17c"
+  "gitHead": "b492941ccbdde19ae30ec024956ca9f6f336a699"
 }

package/src/statusList/IStatusListStore.ts

@@ -2,6 +2,8 @@ import { StatusListEntryEntity } from '../entities/statusList/StatusList2021Entr
 import type {
   IAddStatusListArgs,
   IAddStatusListEntryArgs,
+  IBitstringStatusListEntity,
+  IBitstringStatusListEntryEntity,
   IGetStatusListArgs,
   IGetStatusListEntriesArgs,
   IGetStatusListEntryByCredentialIdArgs,
@@ -15,21 +17,21 @@ import { IStatusListEntity, IStatusListEntryEntity } from '../types'
 import { BitstringStatusListEntryEntity } from '../entities/statusList/BitstringStatusListEntryEntity'
 
 export interface IStatusListStore {
-  getStatusList(args: IGetStatusListArgs): Promise<IStatusListEntity>
+  getStatusList(args: IGetStatusListArgs): Promise<IStatusListEntity | IBitstringStatusListEntity>
 
-  getStatusLists(args: IGetStatusListsArgs): Promise<Array<IStatusListEntity>>
+  getStatusLists(args: IGetStatusListsArgs): Promise<Array<IStatusListEntity | IBitstringStatusListEntity>>
 
   removeStatusList(args: IRemoveStatusListArgs): Promise<boolean>
 
-  addStatusList(args: IAddStatusListArgs): Promise<IStatusListEntity>
+  addStatusList(args: IAddStatusListArgs): Promise<IStatusListEntity | IBitstringStatusListEntity>
 
-  updateStatusList(args: IUpdateStatusListIndexArgs): Promise<IStatusListEntity>
+  updateStatusList(args: IUpdateStatusListIndexArgs): Promise<IStatusListEntity | IBitstringStatusListEntity>
 
   availableStatusListEntries(args: IStatusListEntryAvailableArgs): Promise<number[]>
 
-  addStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity>
+  addStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity | IBitstringStatusListEntryEntity>
 
-  updateStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity>
+  updateStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity | IBitstringStatusListEntryEntity>
 
   getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<StatusListEntryEntity | BitstringStatusListEntryEntity | undefined>
 
@@ -41,7 +43,5 @@ export interface IStatusListStore {
 
   removeStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<boolean>
 
-  getStatusListEntries(args: IGetStatusListEntriesArgs): Promise<IStatusListEntryEntity[]>
-
-  getStatusList(args: IGetStatusListArgs): Promise<IStatusListEntity>
+  getStatusListEntries(args: IGetStatusListEntriesArgs): Promise<Array<IStatusListEntryEntity | IBitstringStatusListEntryEntity>>
 }

package/src/statusList/StatusListStore.ts

@@ -4,9 +4,11 @@ import { DataSource, In, type Repository } from 'typeorm'
 import { BitstringStatusListEntity, OAuthStatusListEntity, StatusList2021Entity, StatusListEntity } from '../entities/statusList/StatusListEntities'
 import { StatusListEntryEntity } from '../entities/statusList/StatusList2021EntryEntity'
 import { BitstringStatusListEntryEntity } from '../entities/statusList/BitstringStatusListEntryEntity'
-import type {
+import {
   IAddStatusListArgs,
   IAddStatusListEntryArgs,
+  IBitstringStatusListEntity,
+  IBitstringStatusListEntryEntity,
   IGetStatusListArgs,
   IGetStatusListEntriesArgs,
   IGetStatusListEntryByCredentialIdArgs,
@@ -54,20 +56,28 @@ export class StatusListStore implements IStatusListStore {
     return statusListIndex.filter((index) => !results.includes(index))
   }
 
-  async addStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity> {
+  async addStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity | IBitstringStatusListEntryEntity> {
+    if (!args.statusListId) {
+      throw new Error('statusListId is required')
+    }
+
     const statusList = await this.getStatusList({ id: args.statusListId })
-    return (await this.getStatusListEntryRepo(statusList.type)).save(args)
+    const result = await (await this.getStatusListEntryRepo(statusList.type)).save(args)
+    return result as IStatusListEntryEntity | IBitstringStatusListEntryEntity
   }
 
-  async updateStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity> {
-    const statusListId = args.statusListId ?? args.statusList?.id
+  async updateStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity | IBitstringStatusListEntryEntity> {
+    const statusListId = args.statusListId
+    if (!statusListId) {
+      throw new Error('statusListId is required')
+    }
+
     const statusList = await this.getStatusList({ id: statusListId })
     const result = await this.getStatusListEntryByIndex({ ...args, statusListId, errorOnNotFound: false })
     const updatedEntry: Partial<IStatusListEntryEntity> = {
-      value: args.value,
-      correlationId: args.correlationId,
-      credentialHash: args.credentialHash,
-      credentialId: args.credentialId,
+      ...result,
+      ...args,
+      statusListId,
     }
 
     const updStatusListId = result?.statusListId ?? statusListId
@@ -82,7 +92,7 @@ export class StatusListStore implements IStatusListStore {
       ...args,
       statusListId: updStatusListId,
       errorOnNotFound: true,
-    })) as IStatusListEntryEntity
+    }))!
   }
 
   async getStatusListEntryByIndex({
@@ -197,13 +207,14 @@ export class StatusListStore implements IStatusListStore {
     return !error
   }
 
-  async getStatusListEntries(args: IGetStatusListEntriesArgs): Promise<StatusListEntryEntity[]> {
+  async getStatusListEntries(args: IGetStatusListEntriesArgs): Promise<Array<IStatusListEntryEntity | IBitstringStatusListEntryEntity>> {
     const statusList = await this.getStatusList({ id: args.statusListId })
-    return (await this.getStatusListEntryRepo(statusList.type)).find({ where: { ...args?.filter, statusList: args.statusListId } })
-  }
-
-  async getStatusList(args: IGetStatusListArgs): Promise<IStatusListEntity> {
-    return statusListFrom(await this.getStatusListEntity(args))
+    const results = await (
+      await this.getStatusListEntryRepo(statusList.type)
+    ).find({
+      where: { ...args?.filter, statusList: args.statusListId },
+    })
+    return results as Array<IStatusListEntryEntity | IBitstringStatusListEntryEntity>
   }
 
   private async getStatusListEntity(args: IGetStatusListArgs): Promise<StatusListEntity> {
@@ -223,7 +234,12 @@ export class StatusListStore implements IStatusListStore {
     return result
   }
 
-  async getStatusLists(args: IGetStatusListsArgs): Promise<Array<IStatusListEntity>> {
+  async getStatusList(args: IGetStatusListArgs): Promise<IStatusListEntity | IBitstringStatusListEntity> {
+    const entity = await this.getStatusListEntity(args)
+    return statusListFrom(entity) as IStatusListEntity | IBitstringStatusListEntity
+  }
+
+  async getStatusLists(args: IGetStatusListsArgs): Promise<Array<IStatusListEntity | IBitstringStatusListEntity>> {
     const result = await (
       await this.getStatusListRepo()
     ).find({
@@ -234,7 +250,7 @@ export class StatusListStore implements IStatusListStore {
       return []
     }
 
-    return result.map((entity) => statusListFrom(entity))
+    return result.map((entity) => statusListFrom(entity) as IStatusListEntity | IBitstringStatusListEntity)
   }
 
   async addStatusList(args: IAddStatusListArgs): Promise<IStatusListEntity> {
@@ -255,7 +271,7 @@ export class StatusListStore implements IStatusListStore {
     return statusListFrom(createdResult)
   }
 
-  async updateStatusList(args: IUpdateStatusListIndexArgs): Promise<IStatusListEntity> {
+  async updateStatusList(args: IUpdateStatusListIndexArgs): Promise<IStatusListEntity | IBitstringStatusListEntity> {
     const result = await this.getStatusList(args)
     debug('Updating status list', result)
     const entity = statusListEntityFrom(args)

package/src/types/statusList/IAbstractStatusListStore.ts

@@ -1,5 +1,16 @@
 import { FindOptionsWhere } from 'typeorm'
-import { IOAuthStatusListEntity, IStatusList2021Entity, IStatusListEntity, IStatusListEntryEntity } from './statusList'
+import { IBitstringStatusListEntryEntity, IOAuthStatusListEntity, IStatusList2021Entity, IStatusListEntryEntity } from './statusList'
+import {
+  CredentialProofFormat,
+  IIssuer,
+  StatusListCredential,
+  StatusListCredentialIdMode,
+  StatusListDriverType,
+  StatusListIndexingDirection,
+  StatusListType,
+  StatusPurpose2021,
+} from '@sphereon/ssi-types'
+import { BitstringStatusPurpose } from './bitstringTypes'
 
 export type FindStatusListArgs = FindOptionsWhere<IStatusList2021Entity | IOAuthStatusListEntity>[]
 export type FindStatusListEntryArgs = FindOptionsWhere<IStatusListEntryEntity>[] | FindOptionsWhere<IStatusListEntryEntity>
@@ -30,7 +41,7 @@ export interface IGetStatusListEntriesArgs {
   filter?: FindStatusListEntryArgs
 }
 
-export type IAddStatusListEntryArgs = IStatusListEntryEntity
+export type IAddStatusListEntryArgs = IStatusListEntryEntity | IBitstringStatusListEntryEntity
 
 export interface IGetStatusListArgs {
   id?: string
@@ -43,6 +54,30 @@ export interface IGetStatusListsArgs {
   filter?: FindStatusListArgs
 }
 
-export type IAddStatusListArgs = IStatusListEntity
+interface IBaseStatusListArgs {
+  id: string
+  correlationId: string
+  driverType: StatusListDriverType
+  credentialIdMode: StatusListCredentialIdMode
+  length: number
+  issuer: string | IIssuer
+  type: StatusListType
+  proofFormat: CredentialProofFormat
+  statusListCredential?: StatusListCredential
+  bitsPerStatus?: number
+}
+
+// Then extend for specific types when needed
+export type IAddStatusListArgs =
+  | (IBaseStatusListArgs & { type: StatusListType.StatusList2021; indexingDirection: StatusListIndexingDirection; statusPurpose: StatusPurpose2021 })
+  | (IBaseStatusListArgs & { type: StatusListType.OAuthStatusList; bitsPerStatus: number; expiresAt?: Date })
+  | (IBaseStatusListArgs & {
+      type: StatusListType.BitstringStatusList
+      statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
+      bitsPerStatus?: number
+      validFrom?: Date
+      validUntil?: Date
+      ttl?: number
+    })
 
-export type IUpdateStatusListIndexArgs = IStatusListEntity
+export type IUpdateStatusListIndexArgs = IAddStatusListArgs

package/src/types/statusList/statusList.ts

@@ -10,7 +10,7 @@ import {
   StatusPurpose2021,
 } from '@sphereon/ssi-types'
 import { StatusListEntity } from '../../entities/statusList/StatusListEntities'
-import { BitstringStatusPurpose } from './bitstringTypes'
+import { BitstringStatus, BitstringStatusPurpose } from './bitstringTypes'
 
 export interface IStatusListEntity {
   id: string
@@ -43,6 +43,18 @@ export interface IBitstringStatusListEntity extends IStatusListEntity {
   ttl?: number
 }
 
+export interface IBitstringStatusListEntryEntity {
+  statusListId: string
+  statusListIndex: number
+  credentialId?: string
+  credentialHash?: string
+  entryCorrelationId?: string
+  statusPurpose: string
+  bitsPerStatus?: number
+  statusMessage?: Array<BitstringStatus>
+  statusReference?: string | string[]
+}
+
 export type IStatusListEntryEntity = RequireOneOf<
   {
     statusList: StatusListEntity
@@ -52,7 +64,6 @@ export type IStatusListEntryEntity = RequireOneOf<
     credentialHash?: string
     credentialId?: string
     correlationId?: string
-    bitsPerStatus?: number
   },
   'statusList' | 'statusListId'
 >

package/src/utils/statusList/MappingUtils.ts

@@ -61,7 +61,7 @@ export const statusListEntityFrom = (args: IStatusListEntity): StatusListEntity
   throw new Error(`Invalid status list type ${args.type}`)
 }
 
-export const statusListFrom = (entity: StatusListEntity): IStatusListEntity => {
+export const statusListFrom = (entity: StatusListEntity): IStatusListEntity | IBitstringStatusListEntity => {
   if (entity instanceof StatusList2021Entity) {
     const result: IStatusList2021Entity = {
       ...getBaseFields(entity),