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

package/src/migrations/sqlite/1741895823001-CreateBitstringStatusList.ts

@@ -0,0 +1,145 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class CreateBitstringStatusListSqlite1741895823001 implements MigrationInterface {
+  name = 'CreateBitstringStatusList1741895823000'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    // Update StatusList table to include BitstringStatusList type and columns
+    await queryRunner.query(`
+      CREATE TABLE "temporary_StatusList" (
+        "id" varchar PRIMARY KEY NOT NULL,
+        "correlationId" varchar NOT NULL,
+        "length" integer NOT NULL,
+        "issuer" text NOT NULL,
+        "type" varchar CHECK( "type" IN ('StatusList2021', 'OAuthStatusList', 'BitstringStatusList') ) NOT NULL DEFAULT ('StatusList2021'),
+        "driverType" varchar CHECK( "driverType" IN ('agent_typeorm','agent_kv_store','github','agent_filesystem') ) NOT NULL DEFAULT ('agent_typeorm'),
+        "credentialIdMode" varchar CHECK( "credentialIdMode" IN ('ISSUANCE','PERSISTENCE','NEVER') ) NOT NULL DEFAULT ('ISSUANCE'),
+        "proofFormat" varchar CHECK( "proofFormat" IN ('lds','jwt') ) NOT NULL DEFAULT ('lds'),
+        "indexingDirection" varchar CHECK( "indexingDirection" IN ('rightToLeft') ),
+        "statusPurpose" varchar,
+        "statusListCredential" text,
+        "expiresAt" datetime,
+        "bitsPerStatus" integer DEFAULT (1),
+        "ttl" integer,
+        "validFrom" datetime,
+        "validUntil" datetime,
+        CONSTRAINT "UQ_correlationId" UNIQUE ("correlationId")
+      )
+    `)
+
+    await queryRunner.query(`
+      INSERT INTO "temporary_StatusList"(
+        "id", "correlationId", "length", "issuer", "type", "driverType",
+        "credentialIdMode", "proofFormat", "indexingDirection", "statusPurpose",
+        "statusListCredential", "bitsPerStatus", "expiresAt"
+      )
+      SELECT 
+        "id", "correlationId", "length", "issuer", "type", "driverType",
+        "credentialIdMode", "proofFormat", "indexingDirection", "statusPurpose",
+        "statusListCredential", "bitsPerStatus", "expiresAt"
+      FROM "StatusList"
+    `)
+
+    await queryRunner.query(`DROP TABLE "StatusList"`)
+    await queryRunner.query(`ALTER TABLE "temporary_StatusList" RENAME TO "StatusList"`)
+
+    // Update StatusListEntry table with inheritance and bitstring columns
+    await queryRunner.query(`
+      CREATE TABLE "temporary_StatusListEntry" (
+        "statusListId" varchar NOT NULL,
+        "statusListIndex" integer NOT NULL,
+        "credentialId" text,
+        "credentialHash" varchar(128),
+        "correlationId" varchar(255),
+        "value" varchar(50),
+        "type" varchar CHECK( "type" IN ('StatusListEntryEntity', 'bitstring') ) NOT NULL DEFAULT ('StatusListEntryEntity'),
+        "statusPurpose" varchar,
+        "bitsPerStatus" integer DEFAULT (1),
+        "statusMessage" text,
+        "statusReference" text,
+        PRIMARY KEY ("statusListId", "statusListIndex")
+      )
+    `)
+
+    await queryRunner.query(`
+      INSERT INTO "temporary_StatusListEntry"(
+        "statusListId", "statusListIndex", "credentialId", "credentialHash", 
+        "correlationId", "value", "type"
+      )
+      SELECT 
+        "statusListId", "statusListIndex", "credentialId", "credentialHash",
+        "correlationId", "value", 'StatusListEntryEntity'
+      FROM "StatusListEntry"
+    `)
+
+    await queryRunner.query(`DROP TABLE "StatusListEntry"`)
+    await queryRunner.query(`ALTER TABLE "temporary_StatusListEntry" RENAME TO "StatusListEntry"`)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    // Revert StatusListEntry table changes
+    await queryRunner.query(`
+      CREATE TABLE "temporary_StatusListEntry" (
+        "statusListId" varchar NOT NULL,
+        "statusListIndex" integer NOT NULL,
+        "credentialId" text,
+        "credentialHash" varchar(128),
+        "correlationId" varchar(255),
+        "value" varchar(50),
+        PRIMARY KEY ("statusListId", "statusListIndex")
+      )
+    `)
+
+    await queryRunner.query(`
+      INSERT INTO "temporary_StatusListEntry"(
+        "statusListId", "statusListIndex", "credentialId", "credentialHash",
+        "correlationId", "value"
+      )
+      SELECT 
+        "statusListId", "statusListIndex", "credentialId", "credentialHash",
+        "correlationId", "value"
+      FROM "StatusListEntry"
+      WHERE "type" = 'StatusListEntryEntity'
+    `)
+
+    await queryRunner.query(`DROP TABLE "StatusListEntry"`)
+    await queryRunner.query(`ALTER TABLE "temporary_StatusListEntry" RENAME TO "StatusListEntry"`)
+
+    // Revert StatusList table changes
+    await queryRunner.query(`
+      CREATE TABLE "temporary_StatusList" (
+        "id" varchar PRIMARY KEY NOT NULL,
+        "correlationId" varchar NOT NULL,
+        "length" integer NOT NULL,
+        "issuer" text NOT NULL,
+        "type" varchar CHECK( "type" IN ('StatusList2021', 'OAuthStatusList') ) NOT NULL DEFAULT ('StatusList2021'),
+        "driverType" varchar CHECK( "driverType" IN ('agent_typeorm','agent_kv_store','github','agent_filesystem') ) NOT NULL DEFAULT ('agent_typeorm'),
+        "credentialIdMode" varchar CHECK( "credentialIdMode" IN ('ISSUANCE','PERSISTENCE','NEVER') ) NOT NULL DEFAULT ('ISSUANCE'),
+        "proofFormat" varchar CHECK( "proofFormat" IN ('lds','jwt') ) NOT NULL DEFAULT ('lds'),
+        "indexingDirection" varchar CHECK( "indexingDirection" IN ('rightToLeft') ),
+        "statusPurpose" varchar,
+        "statusListCredential" text,
+        "bitsPerStatus" integer,
+        "expiresAt" datetime,
+        CONSTRAINT "UQ_correlationId" UNIQUE ("correlationId")
+      )
+    `)
+
+    await queryRunner.query(`
+      INSERT INTO "temporary_StatusList"(
+        "id", "correlationId", "length", "issuer", "type", "driverType",
+        "credentialIdMode", "proofFormat", "indexingDirection", "statusPurpose",
+        "statusListCredential", "bitsPerStatus", "expiresAt"
+      )
+      SELECT 
+        "id", "correlationId", "length", "issuer", 
+        CASE WHEN "type" = 'BitstringStatusList' THEN 'StatusList2021' ELSE "type" END,
+        "driverType", "credentialIdMode", "proofFormat", "indexingDirection",
+        "statusPurpose", "statusListCredential", "bitsPerStatus", "expiresAt"
+      FROM "StatusList"
+    `)
+
+    await queryRunner.query(`DROP TABLE "StatusList"`)
+    await queryRunner.query(`ALTER TABLE "temporary_StatusList" RENAME TO "StatusList"`)
+  }
+}

package/src/statusList/IStatusListStore.ts

@@ -12,6 +12,7 @@ import type {
   IUpdateStatusListIndexArgs,
 } from '../types'
 import { IStatusListEntity, IStatusListEntryEntity } from '../types'
+import { BitstringStatusListEntryEntity } from '../entities/statusList/BitstringStatusListEntryEntity'
 
 export interface IStatusListStore {
   getStatusList(args: IGetStatusListArgs): Promise<IStatusListEntity>
@@ -30,9 +31,11 @@ export interface IStatusListStore {
 
   updateStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity>
 
-  getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<StatusListEntryEntity | undefined>
+  getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<StatusListEntryEntity | BitstringStatusListEntryEntity | undefined>
 
-  getStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<StatusListEntryEntity | undefined>
+  getStatusListEntryByCredentialId(
+    args: IGetStatusListEntryByCredentialIdArgs,
+  ): Promise<StatusListEntryEntity | BitstringStatusListEntryEntity | undefined>
 
   removeStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<boolean>
 

package/src/statusList/StatusListStore.ts

@@ -1,8 +1,9 @@
 import { type OrPromise, StatusListType } from '@sphereon/ssi-types'
 import Debug from 'debug'
 import { DataSource, In, type Repository } from 'typeorm'
-import { OAuthStatusListEntity, StatusList2021Entity, StatusListEntity } from '../entities/statusList/StatusListEntities'
+import { BitstringStatusListEntity, OAuthStatusListEntity, StatusList2021Entity, StatusListEntity } from '../entities/statusList/StatusListEntities'
 import { StatusListEntryEntity } from '../entities/statusList/StatusList2021EntryEntity'
+import { BitstringStatusListEntryEntity } from '../entities/statusList/BitstringStatusListEntryEntity'
 import type {
   IAddStatusListArgs,
   IAddStatusListEntryArgs,
@@ -41,11 +42,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),
         },
       })
@@ -54,11 +55,13 @@ export class StatusListStore implements IStatusListStore {
   }
 
   async addStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity> {
-    return (await this.getStatusListEntryRepo()).save(args)
+    const statusList = await this.getStatusList({ id: args.statusListId })
+    return (await this.getStatusListEntryRepo(statusList.type)).save(args)
   }
 
   async updateStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity> {
     const statusListId = args.statusListId ?? args.statusList?.id
+    const statusList = await this.getStatusList({ id: statusListId })
     const result = await this.getStatusListEntryByIndex({ ...args, statusListId, errorOnNotFound: false })
     const updatedEntry: Partial<IStatusListEntryEntity> = {
       value: args.value,
@@ -69,7 +72,7 @@ export class StatusListStore implements IStatusListStore {
 
     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'] },
@@ -88,7 +91,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 +100,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 +125,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 +141,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 })
+    console.log(`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 +158,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 }),
@@ -171,8 +184,9 @@ export class StatusListStore implements IStatusListStore {
     if (error) {
       console.log(`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 }),
@@ -184,7 +198,8 @@ export class StatusListStore implements IStatusListStore {
   }
 
   async getStatusListEntries(args: IGetStatusListEntriesArgs): Promise<StatusListEntryEntity[]> {
-    return (await this.getStatusListEntryRepo()).find({ where: { ...args?.filter, statusList: args.statusListId } })
+    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> {
@@ -251,7 +266,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)
@@ -268,12 +283,20 @@ export class StatusListStore implements IStatusListStore {
         return dataSource.getRepository(StatusList2021Entity)
       case StatusListType.OAuthStatusList:
         return dataSource.getRepository(OAuthStatusListEntity)
+      case StatusListType.BitstringStatusList:
+        return dataSource.getRepository(BitstringStatusListEntity)
       default:
         return dataSource.getRepository(StatusListEntity)
     }
   }
 
-  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/index.ts

@@ -6,6 +6,7 @@ export * from './presentationDefinition/presentationDefinition'
 export * from './presentationDefinition/IAbstractPDStore'
 export * from './validation/validation'
 export * from './statusList/statusList'
+export * from './statusList/bitstringTypes'
 export * from './statusList/IAbstractStatusListStore'
 export * from './eventLogger/IAbstractEventLoggerStore'
 export * from './eventLogger/eventLogger'

package/src/types/statusList/bitstringTypes.ts

@@ -0,0 +1,7 @@
+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
+}

package/src/types/statusList/statusList.ts

@@ -1,15 +1,16 @@
 import {
+  type CredentialProofFormat,
   IIssuer,
+  RequireOneOf,
   StatusListCredential,
   StatusListCredentialIdMode,
   StatusListDriverType,
   StatusListIndexingDirection,
   StatusListType,
   StatusPurpose2021,
-  type CredentialProofFormat,
-  RequireOneOf,
 } from '@sphereon/ssi-types'
 import { StatusListEntity } from '../../entities/statusList/StatusListEntities'
+import { BitstringStatusPurpose } from './bitstringTypes'
 
 export interface IStatusListEntity {
   id: string
@@ -21,6 +22,7 @@ export interface IStatusListEntity {
   type: StatusListType
   proofFormat: CredentialProofFormat
   statusListCredential?: StatusListCredential
+  bitsPerStatus?: number
 }
 
 export interface IStatusList2021Entity extends IStatusListEntity {
@@ -33,6 +35,14 @@ export interface IOAuthStatusListEntity extends IStatusListEntity {
   expiresAt?: Date
 }
 
+export interface IBitstringStatusListEntity extends IStatusListEntity {
+  statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
+  bitsPerStatus?: number
+  validFrom?: Date
+  validUntil?: Date
+  ttl?: number
+}
+
 export type IStatusListEntryEntity = RequireOneOf<
   {
     statusList: StatusListEntity
@@ -42,6 +52,7 @@ export type IStatusListEntryEntity = RequireOneOf<
     credentialHash?: string
     credentialId?: string
     correlationId?: string
+    bitsPerStatus?: number
   },
   'statusList' | 'statusListId'
 >

package/src/utils/statusList/MappingUtils.ts

@@ -1,5 +1,10 @@
-import { IOAuthStatusListEntity, IStatusList2021Entity, IStatusListEntity } from '../../types'
-import { OAuthStatusListEntity, StatusList2021Entity, StatusListEntity } from '../../entities/statusList/StatusListEntities'
+import { IBitstringStatusListEntity, IOAuthStatusListEntity, IStatusList2021Entity, IStatusListEntity } from '../../types'
+import {
+  BitstringStatusListEntity,
+  OAuthStatusListEntity,
+  StatusList2021Entity,
+  StatusListEntity,
+} from '../../entities/statusList/StatusListEntities'
 import { StatusListType } from '@sphereon/ssi-types'
 import { replaceNullWithUndefined } from '../FormattingUtils'
 
@@ -32,6 +37,27 @@ export const statusListEntityFrom = (args: IStatusListEntity): StatusListEntity
     return entity
   }
 
+  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
+  }
+
   throw new Error(`Invalid status list type ${args.type}`)
 }
 
@@ -56,6 +82,18 @@ export const statusListFrom = (entity: StatusListEntity): IStatusListEntity => {
     return replaceNullWithUndefined(result)
   }
 
+  if (entity instanceof BitstringStatusListEntity) {
+    const result: IBitstringStatusListEntity = {
+      ...getBaseFields(entity),
+      type: StatusListType.BitstringStatusList,
+      statusPurpose: entity.statusPurpose,
+      bitsPerStatus: entity.bitsPerStatus,
+      validFrom: entity.validFrom,
+      validUntil: entity.validUntil,
+      ttl: entity.ttl,
+    }
+    return replaceNullWithUndefined(result)
+  }
   throw new Error(`Invalid status list type ${typeof entity}`)
 }