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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sphereon/ssi-sdk.data-store",
-  "version": "0.34.1-feature.SSISDK.17.bitstring.sl.2+0a0992f6",
+  "version": "0.34.1-feature.SSISDK.17.bitstring.sl.7+eb4b995a",
   "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.2+0a0992f6",
-    "@sphereon/ssi-sdk.core": "0.34.1-feature.SSISDK.17.bitstring.sl.2+0a0992f6",
-    "@sphereon/ssi-types": "0.34.1-feature.SSISDK.17.bitstring.sl.2+0a0992f6",
+    "@sphereon/ssi-sdk.agent-config": "0.34.1-feature.SSISDK.17.bitstring.sl.7+eb4b995a",
+    "@sphereon/ssi-sdk.core": "0.34.1-feature.SSISDK.17.bitstring.sl.7+eb4b995a",
+    "@sphereon/ssi-types": "0.34.1-feature.SSISDK.17.bitstring.sl.7+eb4b995a",
     "@veramo/core": "4.2.0",
     "@veramo/utils": "4.2.0",
     "blakejs": "^1.2.1",
@@ -65,5 +65,5 @@
     "PostgreSQL",
     "Contact Store"
   ],
-  "gitHead": "0a0992f6323610a12e82716b1d80a2eedf4b4669"
+  "gitHead": "eb4b995abb68a5aee39ad40c3ee996f2e1dff8da"
 }

package/src/__tests__/statusList.entities.test.ts

@@ -226,7 +226,7 @@ describe('Status list entities tests', () => {
     statusList.credentialIdMode = StatusListCredentialIdMode.ISSUANCE
     statusList.proofFormat = 'lds'
     statusList.statusPurpose = 'revocation'
-    statusList.statusSize = 1
+    statusList.bitsPerStatus = 1
     statusList.ttl = 3600000
     statusList.validFrom = new Date('2024-01-01T00:00:00Z')
     statusList.validUntil = new Date('2025-01-01T00:00:00Z')
@@ -236,7 +236,7 @@ describe('Status list entities tests', () => {
     expect(fromDb).toBeDefined()
     expect(fromDb.id).toEqual(statusList.id)
     expect(fromDb.statusPurpose).toEqual(statusList.statusPurpose)
-    expect(fromDb.statusSize).toEqual(statusList.statusSize)
+    expect(fromDb.bitsPerStatus).toEqual(statusList.bitsPerStatus)
     expect(fromDb.ttl).toEqual(statusList.ttl)
     expect(fromDb.validFrom).toEqual(statusList.validFrom)
     expect(fromDb.validUntil).toEqual(statusList.validUntil)
@@ -261,14 +261,14 @@ describe('Status list entities tests', () => {
     entry.credentialId = 'bitstring-credential-1'
     entry.credentialHash = 'bitstring-hash-1'
     entry.statusPurpose = 'revocation'
-    entry.statusSize = 1
+    entry.bitsPerStatus = 1
     entry.statusReference = 'https://example.org/status-ref'
 
     const fromDb = await dbConnection.getRepository(BitstringStatusListEntryEntity).save(entry)
     expect(fromDb).toBeDefined()
     expect(fromDb.statusListIndex).toEqual(entry.statusListIndex)
     expect(fromDb.statusPurpose).toEqual(entry.statusPurpose)
-    expect(fromDb.statusSize).toEqual(entry.statusSize)
+    expect(fromDb.bitsPerStatus).toEqual(entry.bitsPerStatus)
     expect(fromDb.statusReference).toEqual(entry.statusReference)
   })
 })

package/src/__tests__/statusList.store.test.ts

@@ -241,7 +241,7 @@ describe('Status list store tests', () => {
       type: StatusListType.BitstringStatusList,
       proofFormat: 'lds',
       statusPurpose: 'revocation',
-      statusSize: 1,
+      bitsPerStatus: 1,
       ttl: 3600000,
       validFrom: new Date('2024-01-01T00:00:00Z'),
       validUntil: new Date('2025-01-01T00:00:00Z'),

package/src/entities/statusList/BitstringStatusListEntryEntity.ts

@@ -2,8 +2,7 @@ import { Validate } from 'class-validator'
 import { BaseEntity, Column, Entity, JoinColumn, ManyToOne, PrimaryColumn } from 'typeorm'
 import { IsNonEmptyStringConstraint } from '../validators'
 import { BitstringStatusListEntity } from './StatusListEntities'
-import { BitstringStatusPurpose } from '@sphereon/ssi-types'
-import { BitstringStatus } from '../../types'
+import { BitstringStatus } from '../../types/statusList/bitstringTypes'
 
 @Entity('BitstringStatusListEntry')
 export class BitstringStatusListEntryEntity extends BaseEntity {
@@ -28,10 +27,10 @@ export class BitstringStatusListEntryEntity extends BaseEntity {
   entryCorrelationId?: string
 
   @Column({ type: 'varchar', name: 'statusPurpose', nullable: false })
-  statusPurpose!: BitstringStatusPurpose
+  statusPurpose!: string
 
-  @Column({ type: 'integer', name: 'statusSize', nullable: true, default: 1 })
-  statusSize?: number
+  @Column({ type: 'integer', name: 'bitsPerStatus', nullable: true, default: 1 })
+  bitsPerStatus?: number
 
   @Column({
     type: 'text',

package/src/entities/statusList/StatusListEntities.ts

@@ -1,5 +1,4 @@
 import {
-  BitstringStatusPurpose,
   type CredentialProofFormat,
   type IIssuer,
   type StatusListCredential,
@@ -127,13 +126,13 @@ export class BitstringStatusListEntity extends StatusListEntity {
     name: 'statusPurpose',
     nullable: false,
     transformer: {
-      from(value: string): BitstringStatusPurpose | BitstringStatusPurpose[] {
+      from(value: string): string | string[] {
         if (value?.includes(',')) {
-          return value.split(',').map((v) => v.trim() as BitstringStatusPurpose)
+          return value.split(',').map((v) => v.trim() as string)
         }
-        return value as BitstringStatusPurpose
+        return value as string
       },
-      to(value: BitstringStatusPurpose | BitstringStatusPurpose[]): string {
+      to(value: string | string[]): string {
         if (Array.isArray(value)) {
           return value.join(',')
         }
@@ -141,10 +140,10 @@ export class BitstringStatusListEntity extends StatusListEntity {
       },
     },
   })
-  statusPurpose!: BitstringStatusPurpose | BitstringStatusPurpose[]
+  statusPurpose!: string | string[]
 
-  @Column({ type: 'integer', name: 'statusSize', nullable: true, default: 1 })
-  statusSize?: number
+  @Column({ type: 'integer', name: 'bitsPerStatus', nullable: false })
+  bitsPerStatus?: number
 
   @Column({ name: 'validFrom', nullable: true, type: typeOrmDateTime() })
   validFrom?: Date

package/src/migrations/postgres/1741895823000-CreateBitstringStatusList.ts

@@ -5,7 +5,7 @@ export class CreateBitstringStatusListPG1741895823000 implements MigrationInterf
 
   public async up(queryRunner: QueryRunner): Promise<void> {
     // Add BitstringStatusList columns to StatusList table
-    await queryRunner.query(`ALTER TABLE "StatusList" ADD COLUMN "statusSize" integer DEFAULT 1`)
+    await queryRunner.query(`ALTER TABLE "StatusList" ADD COLUMN "bitsPerStatus" integer DEFAULT 1`)
     await queryRunner.query(`ALTER TABLE "StatusList" ADD COLUMN "ttl" integer`)
     await queryRunner.query(`ALTER TABLE "StatusList" ADD COLUMN "validFrom" TIMESTAMP`)
     await queryRunner.query(`ALTER TABLE "StatusList" ADD COLUMN "validUntil" TIMESTAMP`)
@@ -25,7 +25,7 @@ export class CreateBitstringStatusListPG1741895823000 implements MigrationInterf
         "credentialHash" character varying(128),
         "correlationId" character varying(255),
         "statusPurpose" character varying NOT NULL,
-        "statusSize" integer DEFAULT 1,
+        "bitsPerStatus" integer DEFAULT 1,
         "statusMessage" text,
         "statusReference" text,
         CONSTRAINT "PK_BitstringStatusListEntry" PRIMARY KEY ("statusListId", "statusListIndex")
@@ -49,6 +49,6 @@ export class CreateBitstringStatusListPG1741895823000 implements MigrationInterf
     await queryRunner.query(`ALTER TABLE "StatusList" DROP COLUMN "validUntil"`)
     await queryRunner.query(`ALTER TABLE "StatusList" DROP COLUMN "validFrom"`)
     await queryRunner.query(`ALTER TABLE "StatusList" DROP COLUMN "ttl"`)
-    await queryRunner.query(`ALTER TABLE "StatusList" DROP COLUMN "statusSize"`)
+    await queryRunner.query(`ALTER TABLE "StatusList" DROP COLUMN "bitsPerStatus"`)
   }
 }

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

@@ -18,9 +18,8 @@ export class CreateBitstringStatusListSqlite1741895823001 implements MigrationIn
         "indexingDirection" varchar CHECK( "indexingDirection" IN ('rightToLeft') ),
         "statusPurpose" varchar,
         "statusListCredential" text,
-        "bitsPerStatus" integer,
         "expiresAt" datetime,
-        "statusSize" integer DEFAULT (1),
+        "bitsPerStatus" integer DEFAULT (1),
         "ttl" integer,
         "validFrom" datetime,
         "validUntil" datetime,
@@ -53,7 +52,7 @@ export class CreateBitstringStatusListSqlite1741895823001 implements MigrationIn
         "credentialHash" varchar(128),
         "correlationId" varchar(255),
         "statusPurpose" varchar NOT NULL,
-        "statusSize" integer DEFAULT (1),
+        "bitsPerStatus" integer DEFAULT (1),
         "statusMessage" text,
         "statusReference" text,
         PRIMARY KEY ("statusListId", "statusListIndex")

package/src/statusList/StatusListStore.ts

@@ -45,7 +45,7 @@ export class StatusListStore implements IStatusListStore {
     const results = (
       await repo.find({
         where: {
-          statusList,
+          statusListId: statusList.id,
           statusListIndex: In(statusListIndex),
         },
       })

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,5 +1,4 @@
 import {
-  BitstringStatusPurpose,
   type CredentialProofFormat,
   IIssuer,
   RequireOneOf,
@@ -11,12 +10,7 @@ import {
   StatusPurpose2021,
 } from '@sphereon/ssi-types'
 import { StatusListEntity } from '../../entities/statusList/StatusListEntities'
-
-export type BitstringStatus = {
-  status: string
-  message?: string
-  [x: string]: any
-}
+import { BitstringStatusPurpose } from './bitstringTypes'
 
 export interface IStatusListEntity {
   id: string
@@ -28,6 +22,7 @@ export interface IStatusListEntity {
   type: StatusListType
   proofFormat: CredentialProofFormat
   statusListCredential?: StatusListCredential
+  bitsPerStatus?: number
 }
 
 export interface IStatusList2021Entity extends IStatusListEntity {
@@ -42,7 +37,7 @@ export interface IOAuthStatusListEntity extends IStatusListEntity {
 
 export interface IBitstringStatusListEntity extends IStatusListEntity {
   statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
-  statusSize?: number
+  bitsPerStatus?: number
   validFrom?: Date
   validUntil?: Date
   ttl?: number

package/src/utils/statusList/MappingUtils.ts

@@ -40,8 +40,12 @@ export const statusListEntityFrom = (args: IStatusListEntity): StatusListEntity
   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.statusSize = bitstringsl.statusSize
+    entity.bitsPerStatus = bitstringsl.bitsPerStatus
     entity.validFrom = bitstringsl.validFrom
     entity.validUntil = bitstringsl.validUntil
     entity.ttl = bitstringsl.ttl
@@ -83,7 +87,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,