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

package/src/statusList/StatusListStore.ts

@@ -3,9 +3,12 @@ import Debug from 'debug'
 import { DataSource, In, type Repository } from 'typeorm'
 import { BitstringStatusListEntity, OAuthStatusListEntity, StatusList2021Entity, StatusListEntity } from '../entities/statusList/StatusListEntities'
 import { StatusListEntryEntity } from '../entities/statusList/StatusList2021EntryEntity'
-import type {
+import { BitstringStatusListEntryEntity } from '../entities/statusList/BitstringStatusListEntryEntity'
+import {
   IAddStatusListArgs,
   IAddStatusListEntryArgs,
+  IBitstringStatusListEntity,
+  IBitstringStatusListEntryEntity,
   IGetStatusListArgs,
   IGetStatusListEntriesArgs,
   IGetStatusListEntryByCredentialIdArgs,
@@ -41,11 +44,11 @@ export class StatusListStore implements IStatusListStore {
   async availableStatusListEntries(args: IStatusListEntryAvailableArgs): Promise<number[]> {
     const statusListIndex = Array.isArray(args.statusListIndex) ? args.statusListIndex : [args.statusListIndex]
     const statusList = await this.getStatusList({ ...args, id: args.statusListId })
-    const repo = await this.getStatusListEntryRepo()
+    const repo = await this.getStatusListEntryRepo(statusList.type)
     const results = (
       await repo.find({
         where: {
-          statusList,
+          statusListId: statusList.id,
           statusListIndex: In(statusListIndex),
         },
       })
@@ -53,33 +56,42 @@ export class StatusListStore implements IStatusListStore {
     return statusListIndex.filter((index) => !results.includes(index))
   }
 
-  async addStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity> {
-    return (await this.getStatusListEntryRepo()).save(args)
+  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 (await this.getStatusListEntryRepo(statusList.type)).save(args)
   }
 
-  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
     const updateResult = await (
-      await this.getStatusListEntryRepo()
+      await this.getStatusListEntryRepo(statusList.type)
     ).upsert(
       { ...(result ?? { statusListId: updStatusListId, statusListIndex: args.statusListIndex }), ...updatedEntry },
       { conflictPaths: ['statusList', 'statusListIndex'] },
     )
-    console.log(updateResult)
+    debug(updateResult)
     return (await this.getStatusListEntryByIndex({
       ...args,
       statusListId: updStatusListId,
       errorOnNotFound: true,
-    })) as IStatusListEntryEntity
+    }))!
   }
 
   async getStatusListEntryByIndex({
@@ -88,7 +100,7 @@ export class StatusListStore implements IStatusListStore {
     statusListIndex,
     entryCorrelationId,
     errorOnNotFound,
-  }: IGetStatusListEntryByIndexArgs): Promise<StatusListEntryEntity | undefined> {
+  }: IGetStatusListEntryByIndexArgs): Promise<StatusListEntryEntity | BitstringStatusListEntryEntity | undefined> {
     if (!statusListId && !statusListCorrelationId) {
       throw Error(`Cannot get statusList entry without either a statusList id or statusListCorrelationId`)
     }
@@ -97,8 +109,12 @@ export class StatusListStore implements IStatusListStore {
       throw Error(`Cannot get statusList entry without either a statusListIndex or entryCorrelationId`)
     }
 
+    const statusList = statusListId
+      ? await this.getStatusList({ id: statusListId })
+      : await this.getStatusList({ correlationId: statusListCorrelationId })
+
     const result = await (
-      await this.getStatusListEntryRepo()
+      await this.getStatusListEntryRepo(statusList.type)
     ).findOne({
       where: {
         ...(statusListId && { statusListId }),
@@ -118,7 +134,9 @@ export class StatusListStore implements IStatusListStore {
     return result ?? undefined
   }
 
-  async getStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<StatusListEntryEntity | undefined> {
+  async getStatusListEntryByCredentialId(
+    args: IGetStatusListEntryByCredentialIdArgs,
+  ): Promise<StatusListEntryEntity | BitstringStatusListEntryEntity | undefined> {
     const credentialId = args.credentialId
     if (!credentialId) {
       throw Error('Can only get a credential by credentialId when a credentialId is supplied')
@@ -132,8 +150,8 @@ export class StatusListStore implements IStatusListStore {
       ...(args.entryCorrelationId && { correlationId: args.entryCorrelationId }),
       credentialId,
     }
-    console.log(`Entries: ${JSON.stringify(await (await this.getStatusListEntryRepo()).find(), null, 2)}`)
-    const result = await (await this.getStatusListEntryRepo()).findOne({ where })
+    debug(`Entries: ${JSON.stringify(await (await this.getStatusListEntryRepo(statusList.type)).find(), null, 2)}`)
+    const result = await (await this.getStatusListEntryRepo(statusList.type)).findOne({ where })
 
     if (!result && args.errorOnNotFound) {
       throw Error(`Could not find status list credential id ${credentialId} for status list id ${statusList.id}`)
@@ -149,8 +167,12 @@ export class StatusListStore implements IStatusListStore {
       error = true
     }
     if (!error) {
+      const statusList = await this.getStatusList({
+        id: args.statusListId,
+        correlationId: args.statusListCorrelationId,
+      })
       const result = await (
-        await this.getStatusListEntryRepo()
+        await this.getStatusListEntryRepo(statusList.type)
       ).delete({
         ...(args.statusListId && { statusList: args.statusListId }),
         ...(args.entryCorrelationId && { correlationId: args.entryCorrelationId }),
@@ -169,10 +191,11 @@ export class StatusListStore implements IStatusListStore {
       error = true
     }
     if (error) {
-      console.log(`Could not delete statusList ${args.statusListId} entry by index ${args.statusListIndex}`)
+      console.error(`Could not delete statusList ${args.statusListId} entry by index ${args.statusListIndex}`)
     } else {
+      const statusList = await this.getStatusList({ id: args.statusListId })
       const result = await (
-        await this.getStatusListEntryRepo()
+        await this.getStatusListEntryRepo(statusList.type)
       ).delete({
         ...(args.statusListId && { statusList: args.statusListId }),
         ...(args.entryCorrelationId && { correlationId: args.entryCorrelationId }),
@@ -183,12 +206,14 @@ export class StatusListStore implements IStatusListStore {
     return !error
   }
 
-  async getStatusListEntries(args: IGetStatusListEntriesArgs): Promise<StatusListEntryEntity[]> {
-    return (await this.getStatusListEntryRepo()).find({ where: { ...args?.filter, statusList: args.statusListId } })
-  }
-
-  async getStatusList(args: IGetStatusListArgs): Promise<IStatusListEntity> {
-    return statusListFrom(await this.getStatusListEntity(args))
+  async getStatusListEntries(args: IGetStatusListEntriesArgs): Promise<Array<IStatusListEntryEntity | IBitstringStatusListEntryEntity>> {
+    const statusList = await this.getStatusList({ id: args.statusListId })
+    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> {
@@ -208,7 +233,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({
@@ -219,7 +249,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> {
@@ -240,7 +270,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)
@@ -251,7 +281,7 @@ export class StatusListStore implements IStatusListStore {
   async removeStatusList(args: IRemoveStatusListArgs): Promise<boolean> {
     const result = await this.getStatusListEntity(args)
 
-    await (await this.getStatusListEntryRepo()).delete({ statusListId: result.id })
+    await (await this.getStatusListEntryRepo(result.type)).delete({ statusListId: result.id })
     const deletedEntity = await (await this.getStatusListRepo()).remove(result)
 
     return Boolean(deletedEntity)
@@ -275,7 +305,13 @@ export class StatusListStore implements IStatusListStore {
     }
   }
 
-  async getStatusListEntryRepo(): Promise<Repository<StatusListEntryEntity>> {
-    return (await this.getDS()).getRepository(StatusListEntryEntity)
+  async getStatusListEntryRepo(type?: StatusListType): Promise<Repository<StatusListEntryEntity | BitstringStatusListEntryEntity>> {
+    const dataSource = await this.getDS()
+    switch (type) {
+      case StatusListType.BitstringStatusList:
+        return dataSource.getRepository(BitstringStatusListEntryEntity)
+      default:
+        return dataSource.getRepository(StatusListEntryEntity)
+    }
   }
 }

package/src/types/statusList/IAbstractStatusListStore.ts

@@ -1,5 +1,21 @@
 import { FindOptionsWhere } from 'typeorm'
-import { IOAuthStatusListEntity, IStatusList2021Entity, IStatusListEntity, IStatusListEntryEntity } from './statusList'
+import {
+  BitstringStatusPurpose,
+  IBitstringStatusListEntryEntity,
+  IOAuthStatusListEntity,
+  IStatusList2021Entity,
+  IStatusListEntryEntity,
+} from './statusList'
+import {
+  CredentialProofFormat,
+  IIssuer,
+  StatusListCredential,
+  StatusListCredentialIdMode,
+  StatusListDriverType,
+  StatusListIndexingDirection,
+  StatusListType,
+  StatusPurpose2021,
+} from '@sphereon/ssi-types'
 
 export type FindStatusListArgs = FindOptionsWhere<IStatusList2021Entity | IOAuthStatusListEntity>[]
 export type FindStatusListEntryArgs = FindOptionsWhere<IStatusListEntryEntity>[] | FindOptionsWhere<IStatusListEntryEntity>
@@ -30,7 +46,7 @@ export interface IGetStatusListEntriesArgs {
   filter?: FindStatusListEntryArgs
 }
 
-export type IAddStatusListEntryArgs = IStatusListEntryEntity
+export type IAddStatusListEntryArgs = IStatusListEntryEntity | IBitstringStatusListEntryEntity
 
 export interface IGetStatusListArgs {
   id?: string
@@ -43,6 +59,40 @@ 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
+}
+
+export type IStatusList2021Args = IBaseStatusListArgs & {
+  type: StatusListType.StatusList2021
+  indexingDirection: StatusListIndexingDirection
+  statusPurpose: StatusPurpose2021
+}
+
+export type IOAuthStatusListArgs = IBaseStatusListArgs & {
+  type: StatusListType.OAuthStatusList
+  bitsPerStatus: number
+  expiresAt?: Date
+}
+
+export type IBitstringStatusListArgs = IBaseStatusListArgs & {
+  type: StatusListType.BitstringStatusList
+  statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
+  bitsPerStatus?: number
+  validFrom?: Date
+  validUntil?: Date
+  ttl?: number
+}
+
+export type IAddStatusListArgs = IStatusList2021Args | IOAuthStatusListArgs | IBitstringStatusListArgs
 
-export type IUpdateStatusListIndexArgs = IStatusListEntity
+export type IUpdateStatusListIndexArgs = IAddStatusListArgs

package/src/types/statusList/statusList.ts

@@ -1,6 +1,6 @@
 import {
-  BitstringStatusPurpose,
   type CredentialProofFormat,
+  type ICredentialStatus,
   IIssuer,
   RequireOneOf,
   StatusListCredential,
@@ -12,12 +12,6 @@ import {
 } from '@sphereon/ssi-types'
 import { StatusListEntity } from '../../entities/statusList/StatusListEntities'
 
-export type BitstringStatus = {
-  status: string
-  message?: string
-  [x: string]: any
-}
-
 export interface IStatusListEntity {
   id: string
   correlationId: string
@@ -28,6 +22,7 @@ export interface IStatusListEntity {
   type: StatusListType
   proofFormat: CredentialProofFormat
   statusListCredential?: StatusListCredential
+  bitsPerStatus?: number
 }
 
 export interface IStatusList2021Entity extends IStatusListEntity {
@@ -41,8 +36,8 @@ export interface IOAuthStatusListEntity extends IStatusListEntity {
 }
 
 export interface IBitstringStatusListEntity extends IStatusListEntity {
-  statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
-  statusSize?: number
+  statusPurpose: BitstringStatusPurpose | Array<BitstringStatusPurpose>
+  bitsPerStatus?: number
   validFrom?: Date
   validUntil?: Date
   ttl?: number
@@ -60,3 +55,41 @@ export type IStatusListEntryEntity = RequireOneOf<
   },
   'statusList' | 'statusListId'
 >
+
+export type BitstringStatusPurpose = 'revocation' | 'suspension' | 'refresh' | 'message' | string // From vc-bitstring-status-lists without pulling in the whole dep for just this one type
+
+export type BitstringStatusMessage = {
+  status: string
+  message?: string
+  [x: string]: any
+}
+
+export interface BitstringStatusListEntryCredentialStatus extends ICredentialStatus {
+  type: 'BitstringStatusListEntry'
+  statusPurpose: BitstringStatusPurpose | Array<BitstringStatusPurpose>
+  statusListIndex: string
+  statusListCredential: string
+  bitsPerStatus?: number
+  statusMessage?: Array<BitstringStatusMessage>
+  statusReference?: string | Array<string>
+}
+
+export type BitstringStatusListArgs = {
+  statusPurpose: BitstringStatusPurpose
+  bitsPerStatus: number
+  ttl?: number
+  validFrom?: Date
+  validUntil?: Date
+}
+
+export interface IBitstringStatusListEntryEntity {
+  statusListId: string
+  statusListIndex: number
+  credentialId?: string
+  credentialHash?: string
+  entryCorrelationId?: string
+  statusPurpose: string
+  bitsPerStatus?: number
+  statusMessage?: Array<BitstringStatusMessage>
+  statusReference?: string | Array<string>
+}

package/src/utils/statusList/MappingUtils.ts

@@ -9,55 +9,62 @@ import { StatusListType } from '@sphereon/ssi-types'
 import { replaceNullWithUndefined } from '../FormattingUtils'
 
 export const statusListEntityFrom = (args: IStatusListEntity): StatusListEntity => {
-  if (args.type === StatusListType.StatusList2021) {
-    const entity = new StatusList2021Entity()
-    const sl2021 = args as IStatusList2021Entity
-    entity.indexingDirection = sl2021.indexingDirection
-    entity.statusPurpose = sl2021.statusPurpose
-    setBaseFields(entity, args)
-    Object.defineProperty(entity, 'type', {
-      value: StatusListType.StatusList2021,
-      enumerable: true,
-      configurable: true,
-    })
-    return entity
-  }
+  switch (args.type) {
+    case StatusListType.StatusList2021: {
+      const entity = new StatusList2021Entity()
+      const sl2021 = args as IStatusList2021Entity
+      entity.indexingDirection = sl2021.indexingDirection
+      entity.statusPurpose = sl2021.statusPurpose
+      setBaseFields(entity, args)
+      Object.defineProperty(entity, 'type', {
+        value: StatusListType.StatusList2021,
+        enumerable: true,
+        configurable: true,
+      })
+      return entity
+    }
 
-  if (args.type === StatusListType.OAuthStatusList) {
-    const entity = new OAuthStatusListEntity()
-    const oauthSl = args as IOAuthStatusListEntity
-    entity.bitsPerStatus = oauthSl.bitsPerStatus
-    entity.expiresAt = oauthSl.expiresAt
-    setBaseFields(entity, args)
-    Object.defineProperty(entity, 'type', {
-      value: StatusListType.OAuthStatusList,
-      enumerable: true,
-      configurable: true,
-    })
-    return entity
-  }
+    case StatusListType.OAuthStatusList: {
+      const entity = new OAuthStatusListEntity()
+      const oauthSl = args as IOAuthStatusListEntity
+      entity.bitsPerStatus = oauthSl.bitsPerStatus
+      entity.expiresAt = oauthSl.expiresAt
+      setBaseFields(entity, args)
+      Object.defineProperty(entity, 'type', {
+        value: StatusListType.OAuthStatusList,
+        enumerable: true,
+        configurable: true,
+      })
+      return entity
+    }
 
-  if (args.type === StatusListType.BitstringStatusList) {
-    const entity = new BitstringStatusListEntity()
-    const bitstringsl = args as IBitstringStatusListEntity
-    entity.statusPurpose = bitstringsl.statusPurpose
-    entity.statusSize = bitstringsl.statusSize
-    entity.validFrom = bitstringsl.validFrom
-    entity.validUntil = bitstringsl.validUntil
-    entity.ttl = bitstringsl.ttl
-    setBaseFields(entity, args)
-    Object.defineProperty(entity, 'type', {
-      value: StatusListType.BitstringStatusList,
-      enumerable: true,
-      configurable: true,
-    })
-    return entity
-  }
+    case StatusListType.BitstringStatusList: {
+      const entity = new BitstringStatusListEntity()
+      const bitstringsl = args as IBitstringStatusListEntity
+      if (!bitstringsl.bitsPerStatus) {
+        throw Error('bitsPerStatus must be set for BitstringStatusList')
+      }
 
-  throw new Error(`Invalid status list type ${args.type}`)
+      entity.statusPurpose = bitstringsl.statusPurpose
+      entity.bitsPerStatus = bitstringsl.bitsPerStatus
+      entity.validFrom = bitstringsl.validFrom
+      entity.validUntil = bitstringsl.validUntil
+      entity.ttl = bitstringsl.ttl
+      setBaseFields(entity, args)
+      Object.defineProperty(entity, 'type', {
+        value: StatusListType.BitstringStatusList,
+        enumerable: true,
+        configurable: true,
+      })
+      return entity
+    }
+
+    default:
+      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),
@@ -83,7 +90,7 @@ export const statusListFrom = (entity: StatusListEntity): IStatusListEntity => {
       ...getBaseFields(entity),
       type: StatusListType.BitstringStatusList,
       statusPurpose: entity.statusPurpose,
-      statusSize: entity.statusSize,
+      bitsPerStatus: entity.bitsPerStatus,
       validFrom: entity.validFrom,
       validUntil: entity.validUntil,
       ttl: entity.ttl,