@sphereon/ssi-sdk.data-store 0.34.1-feature.SSISDK.17.bitstring.sl.9 → 0.34.1-feature.merge.crypto.extensions.modules.33

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,5 +1,6 @@
 import {
   type CredentialProofFormat,
+  type ICredentialStatus,
   IIssuer,
   RequireOneOf,
   StatusListCredential,
@@ -10,7 +11,6 @@ import {
   StatusPurpose2021,
 } from '@sphereon/ssi-types'
 import { StatusListEntity } from '../../entities/statusList/StatusListEntities'
-import { BitstringStatusPurpose } from './bitstringTypes'
 
 export interface IStatusListEntity {
   id: string
@@ -36,7 +36,7 @@ export interface IOAuthStatusListEntity extends IStatusListEntity {
 }
 
 export interface IBitstringStatusListEntity extends IStatusListEntity {
-  statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
+  statusPurpose: BitstringStatusPurpose | Array<BitstringStatusPurpose>
   bitsPerStatus?: number
   validFrom?: Date
   validUntil?: Date
@@ -55,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,59 +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
+    }
+
+    case StatusListType.BitstringStatusList: {
+      const entity = new BitstringStatusListEntity()
+      const bitstringsl = args as IBitstringStatusListEntity
+      if (!bitstringsl.bitsPerStatus) {
+        throw Error('bitsPerStatus must be set for BitstringStatusList')
+      }
 
-  if (args.type === StatusListType.BitstringStatusList) {
-    const entity = new BitstringStatusListEntity()
-    const bitstringsl = args as IBitstringStatusListEntity
-    if (!bitstringsl.bitsPerStatus) {
-      throw Error('bitsPerStatus must be set for BitstringStatusList')
+      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
     }
 
-    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}`)
   }
-
-  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),

package/src/types/statusList/bitstringTypes.ts

@@ -1,7 +0,0 @@
-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 BitstringStatus = {
-  status: string
-  message?: string
-  [x: string]: any
-}