@sphereon/ssi-sdk.data-store 0.15.2-next.33 → 0.15.2-next.39

package/src/entities/statusList2021/StatusList2021Entity.ts

@@ -0,0 +1,95 @@
+import {
+  IIssuer,
+  OriginalVerifiableCredential,
+  StatusListCredentialIdMode,
+  StatusListDriverType,
+  StatusListIndexingDirection,
+  StatusListType,
+  StatusPurpose2021,
+} from '@sphereon/ssi-types'
+import { ProofFormat } from '@veramo/core'
+import { BaseEntity, Column, Entity, OneToMany, PrimaryColumn, Unique } from 'typeorm'
+import { StatusListEntryEntity } from './StatusList2021EntryEntity'
+
+@Entity('StatusList')
+@Unique('UQ_correlationId', ['correlationId'])
+export class StatusListEntity extends BaseEntity {
+  @PrimaryColumn({ name: 'id', type: 'varchar' })
+  id!: string
+
+  @Column({ name: 'correlationId', type: 'varchar', nullable: false })
+  correlationId!: string
+
+  @Column({ name: 'length', nullable: false, unique: false })
+  length!: number
+
+  @Column({
+    name: 'issuer',
+    type: 'text',
+    nullable: false,
+    unique: false,
+    transformer: {
+      from(value: string): string | IIssuer {
+        if (value?.trim()?.startsWith('{')) {
+          return JSON.parse(value)
+        }
+        return value
+      },
+      to(value: string | IIssuer): string {
+        if (typeof value === 'string') {
+          return value
+        }
+        return JSON.stringify(value)
+      },
+    },
+  })
+  issuer!: string | IIssuer
+
+  @Column('simple-enum', { name: 'type', enum: StatusListType, nullable: false, default: StatusListType.StatusList2021 })
+  type!: StatusListType
+
+  @Column('simple-enum', { name: 'driverType', enum: StatusListDriverType, nullable: false, default: StatusListDriverType.AGENT_TYPEORM })
+  driverType!: StatusListDriverType
+
+  @Column('simple-enum', {
+    name: 'credentialIdMode',
+    enum: StatusListCredentialIdMode,
+    nullable: false,
+    default: StatusListCredentialIdMode.ISSUANCE,
+  })
+  credentialIdMode!: StatusListCredentialIdMode
+
+  @Column({ type: 'varchar', name: 'proofFormat', enum: ['lds', 'jwt'], nullable: false, default: 'lds' })
+  proofFormat!: ProofFormat
+
+  @Column({ type: 'varchar', name: 'indexingDirection', enum: ['rightToLeft'], nullable: false, default: 'rightToLeft' })
+  indexingDirection!: StatusListIndexingDirection
+
+  @Column({ type: 'varchar', name: 'statusPurpose', nullable: false, default: 'revocation' })
+  statusPurpose!: StatusPurpose2021
+
+  @Column({
+    name: 'statusListCredential',
+    type: 'text',
+    nullable: true,
+    unique: false,
+    transformer: {
+      from(value: string): OriginalVerifiableCredential {
+        if (value?.startsWith('ey')) {
+          return value
+        }
+        return JSON.parse(value)
+      },
+      to(value: OriginalVerifiableCredential): string {
+        if (typeof value === 'string') {
+          return value
+        }
+        return JSON.stringify(value)
+      },
+    },
+  })
+  statusListCredential?: OriginalVerifiableCredential
+
+  @OneToMany((type) => StatusListEntryEntity, (entry) => entry.statusList)
+  statusListEntries!: StatusListEntryEntity[]
+}

package/src/entities/statusList2021/StatusList2021EntryEntity.ts

@@ -0,0 +1,29 @@
+import { Validate } from 'class-validator'
+import { BaseEntity, Column, Entity, ManyToOne, PrimaryColumn } from 'typeorm'
+import { IsNonEmptyStringConstraint } from '../validators'
+import { StatusListEntity } from './StatusList2021Entity'
+
+@Entity('StatusListEntry')
+// @Unique('uq_credential_statuslist', ['statusList', 'credentialId']) // disabled because one prop can be null
+// @Unique('uq_credentialHash_statuslistId', ['statusList', 'credentialHash']) // disabled because one prop can be null
+export class StatusListEntryEntity extends BaseEntity {
+  @PrimaryColumn({ name: 'statusListId', type: 'varchar' })
+  @ManyToOne(() => StatusListEntity, (statusList) => statusList.statusListEntries)
+  statusList!: StatusListEntity
+
+  @PrimaryColumn({ name: 'statusListIndex', nullable: false, unique: false })
+  @Validate(IsNonEmptyStringConstraint, { message: 'Status list index is required' })
+  statusListIndex!: number
+
+  @Column({ name: 'credentialId', nullable: true })
+  credentialId?: string
+
+  @Column({ name: 'credentialHash', length: 128, nullable: true, unique: false })
+  credentialHash?: string
+
+  @Column({ name: 'correlationId', length: 255, nullable: true, unique: false })
+  correlationId?: string
+
+  @Column({ name: 'value', length: 50, nullable: true, unique: false })
+  value?: string
+}

package/src/index.ts

@@ -15,11 +15,15 @@ import { ImageDimensionsEntity, imageDimensionsEntityFrom } from './entities/iss
 import { IssuerLocaleBrandingEntity, issuerLocaleBrandingEntityFrom } from './entities/issuanceBranding/IssuerLocaleBrandingEntity'
 import { IssuerBrandingEntity, issuerBrandingEntityFrom } from './entities/issuanceBranding/IssuerBrandingEntity'
 import { TextAttributesEntity, textAttributesEntityFrom } from './entities/issuanceBranding/TextAttributesEntity'
+import { StatusListEntity } from './entities/statusList2021/StatusList2021Entity'
+import { StatusListEntryEntity } from './entities/statusList2021/StatusList2021EntryEntity'
+import { IStatusListEntity, IStatusListEntryEntity } from './types'
 
 export { ContactStore } from './contact/ContactStore'
 export { AbstractContactStore } from './contact/AbstractContactStore'
 export { AbstractIssuanceBrandingStore } from './issuanceBranding/AbstractIssuanceBrandingStore'
 export { IssuanceBrandingStore } from './issuanceBranding/IssuanceBrandingStore'
+export { StatusListStore } from './statusList/StatusListStore'
 export { DataStoreMigrations } from './migrations'
 export * from './types'
 
@@ -46,6 +50,11 @@ export const DataStoreIssuanceBrandingEntities = [
   IssuerLocaleBrandingEntity,
 ]
 
+export const DataStoreStatusListEntities = [StatusListEntity, StatusListEntryEntity]
+
+// All entities combined if a party wants to enable them all at once
+export const DataStoreEntities = [...DataStoreContactEntities, ...DataStoreIssuanceBrandingEntities, ...DataStoreStatusListEntities]
+
 export {
   BaseConfigEntity,
   ConnectionEntity,
@@ -79,4 +88,8 @@ export {
   textAttributesEntityFrom,
   issuerLocaleBrandingEntityFrom,
   credentialLocaleBrandingEntityFrom,
+  IStatusListEntity,
+  IStatusListEntryEntity,
+  StatusListEntity,
+  StatusListEntryEntity,
 }

package/src/migrations/generic/3-CreateStatusList.ts

@@ -0,0 +1,54 @@
+import Debug from 'debug'
+import { MigrationInterface, QueryRunner } from 'typeorm'
+import { CreateStatusList1693866470001 } from '../postgres/CreateStatusList1693866470001-CreateStatusList'
+import { CreateStatusList1693866470002 } from '../sqlite/1693866470000-CreateStatusList'
+
+const debug = Debug('sphereon:ssi-sdk:migrations')
+
+export class CreateStatusList1693866470000 implements MigrationInterface {
+  name = 'CreateStatusList1693866470000'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    debug('migration: creating issuance branding tables')
+    const dbType = queryRunner.connection.driver.options.type
+    if (dbType === 'postgres') {
+      debug('using postgres migration file')
+      const mig = new CreateStatusList1693866470001()
+      const up = await mig.up(queryRunner)
+      debug('Migration statements executed')
+      return up
+    } else if (dbType === 'sqlite' || 'react-native') {
+      debug('using sqlite/react-native migration file')
+      const mig = new CreateStatusList1693866470002()
+      const up = await mig.up(queryRunner)
+      debug('Migration statements executed')
+      return up
+    } else {
+      return Promise.reject(
+        "Migrations are currently only supported for sqlite, react-native and postgres. Please run your database without migrations and with 'migrationsRun: false' and 'synchronize: true' for now"
+      )
+    }
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    debug('migration: reverting issuance branding tables')
+    const dbType = queryRunner.connection.driver.options.type
+    if (dbType === 'postgres') {
+      debug('using postgres migration file')
+      const mig = new CreateStatusList1693866470002()
+      const down = await mig.down(queryRunner)
+      debug('Migration statements executed')
+      return down
+    } else if (dbType === 'sqlite' || 'react-native') {
+      debug('using sqlite/react-native migration file')
+      const mig = new CreateStatusList1693866470002()
+      const down = await mig.down(queryRunner)
+      debug('Migration statements executed')
+      return down
+    } else {
+      return Promise.reject(
+        "Migrations are currently only supported for sqlite, react-native and postgres. Please run your database without migrations and with 'migrationsRun: false' and 'synchronize: true' for now"
+      )
+    }
+  }
+}

package/src/migrations/generic/index.ts

@@ -1,5 +1,6 @@
 import { CreateContacts1659463079429 } from './1-CreateContacts'
-import { CreateIssuanceBranding1659463079429 } from './1-CreateIssuanceBranding'
+import { CreateIssuanceBranding1659463079429 } from './2-CreateIssuanceBranding'
+import { CreateStatusList1693866470000 } from './3-CreateStatusList'
 
 /**
  * The migrations array that SHOULD be used when initializing a TypeORM database connection.
@@ -8,4 +9,11 @@ import { CreateIssuanceBranding1659463079429 } from './1-CreateIssuanceBranding'
  *
  * @public
  */
-export const DataStoreMigrations = [CreateContacts1659463079429, CreateIssuanceBranding1659463079429]
+
+// Individual migrations per purpose. Allows parties to not run migrations and thus create/update tables if they are not using a particular feature (yet)
+export const DataStoreContactMigrations = [CreateContacts1659463079429]
+export const DataStoreIssuanceBrandingMigrations = [CreateIssuanceBranding1659463079429]
+export const DataStoreStatusListMigrations = [CreateStatusList1693866470000]
+
+// All migrations together
+export const DataStoreMigrations = [CreateContacts1659463079429, CreateIssuanceBranding1659463079429, CreateStatusList1693866470000]

package/src/migrations/postgres/1659463079428-CreateContacts.ts

@@ -1,9 +1,11 @@
 import { MigrationInterface, QueryRunner } from 'typeorm'
+import { enableUuidv4 } from './uuid'
 
 export class CreateContacts1659463079428 implements MigrationInterface {
   name = 'CreateContacts1659463079428'
 
   public async up(queryRunner: QueryRunner): Promise<void> {
+    await enableUuidv4(queryRunner)
     await queryRunner.query(
       `CREATE TABLE "BaseConfigEntity" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "client_id" character varying(255), "client_secret" character varying(255), "scopes" text, "issuer" character varying(255), "redirect_url" text, "dangerously_allow_insecure_http_requests" boolean, "client_auth_method" text, "identifier" character varying(255), "session_id" character varying(255), "type" character varying NOT NULL, "connectionId" uuid, CONSTRAINT "REL_BaseConfig_connectionId" UNIQUE ("connectionId"), CONSTRAINT "PK_BaseConfigEntity_id" PRIMARY KEY ("id"))`
     )
@@ -13,13 +15,13 @@ export class CreateContacts1659463079428 implements MigrationInterface {
       `CREATE TABLE "CorrelationIdentifier" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "type" "public"."CorrelationIdentifier_type_enum" NOT NULL, "correlation_id" text NOT NULL, "identityId" uuid, CONSTRAINT "UQ_Correlation_id" UNIQUE ("correlation_id"), CONSTRAINT "REL_CorrelationIdentifier_identityId" UNIQUE ("identityId"), CONSTRAINT "PK_CorrelationIdentifier_id" PRIMARY KEY ("id"))`
     )
     await queryRunner.query(
-      `CREATE TABLE "Contact" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "name" character varying(255) NOT NULL, "alias" character varying(255) NOT NULL, "uri" character varying(255) NOT NULL, "created_at" TIMESTAMP NOT NULL DEFAULT now(), "last_updated_at" TIMESTAMP NOT NULL DEFAULT now(), CONSTRAINT "UQ_Name" UNIQUE ("name"), CONSTRAINT "UQ_Alias" UNIQUE ("alias"), CONSTRAINT "PK_Contact_id" PRIMARY KEY ("id"))`
+      `CREATE TABLE "Contact" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "name" character varying(255) NOT NULL, "alias" character varying(255) NOT NULL, "uri" character varying(255) NOT NULL, "created_at" TIMESTAMP NOT NULL DEFAULT now(), "last_updated_at" TIMESTAMP NOT NULL DEFAULT now(), CONSTRAINT "UQ_Name" UNIQUE ("name"), CONSTRAINT "UQ_Contact_Alias" UNIQUE ("alias"), CONSTRAINT "PK_Contact_id" PRIMARY KEY ("id"))`
     )
     await queryRunner.query(
       `CREATE TABLE "IdentityMetadata" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "label" character varying(255) NOT NULL, "value" character varying(255) NOT NULL, "identityId" uuid, CONSTRAINT "PK_IdentityMetadata_id" PRIMARY KEY ("id"))`
     )
     await queryRunner.query(
-      `CREATE TABLE "Identity" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "alias" character varying(255) NOT NULL, "roles" text, "created_at" TIMESTAMP NOT NULL DEFAULT now(), "last_updated_at" TIMESTAMP NOT NULL DEFAULT now(), "contactId" uuid, CONSTRAINT "UQ_Alias" UNIQUE ("alias"), CONSTRAINT "PK_Identity_id" PRIMARY KEY ("id"))`
+      `CREATE TABLE "Identity" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "alias" character varying(255) NOT NULL, "roles" text, "created_at" TIMESTAMP NOT NULL DEFAULT now(), "last_updated_at" TIMESTAMP NOT NULL DEFAULT now(), "contactId" uuid, CONSTRAINT "UQ_Identity_Alias" UNIQUE ("alias"), CONSTRAINT "PK_Identity_id" PRIMARY KEY ("id"))`
     )
     await queryRunner.query(`CREATE TYPE "public"."Connection_type_enum" AS ENUM('OIDC', 'SIOPv2', 'SIOPv2+OpenID4VP')`)
     await queryRunner.query(

package/src/migrations/postgres/1685628974232-CreateIssuanceBranding.ts

@@ -1,9 +1,11 @@
 import { MigrationInterface, QueryRunner } from 'typeorm'
+import { enableUuidv4 } from './uuid'
 
 export class CreateIssuanceBranding1685628974232 implements MigrationInterface {
   name = 'CreateIssuanceBranding1685628974232'
 
   public async up(queryRunner: QueryRunner): Promise<void> {
+    await enableUuidv4(queryRunner)
     await queryRunner.query(
       `CREATE TABLE "ImageDimensions" ("id" uuid NOT NULL DEFAULT uuid_generate_v4(), "width" integer NOT NULL, "height" integer NOT NULL, CONSTRAINT "PK_ImageDimensions_id" PRIMARY KEY ("id"))`
     )

package/src/migrations/postgres/CreateStatusList1693866470001-CreateStatusList.ts

@@ -0,0 +1,24 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class CreateStatusList1693866470001 implements MigrationInterface {
+  name = 'CreateStatusList1693866470001'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE "StatusListEntry" ("statusListId" character varying NOT NULL, "statusListIndex" integer NOT NULL, "credentialId" character varying, "credentialHash" character varying(128), "correlationId" character varying(255), "value" character varying(50), CONSTRAINT "PK_68704d2d13857360c6b44a3d1d0" PRIMARY KEY ("statusListId", "statusListIndex"))`
+    )
+    await queryRunner.query(`CREATE TYPE "public"."StatusList_type_enum" AS ENUM('StatusList2021')`)
+    await queryRunner.query(
+      `CREATE TYPE "public"."StatusList_drivertype_enum" AS ENUM('agent_typeorm', 'agent_kv_store', 'github', 'agent_filesystem')`
+    )
+    await queryRunner.query(`CREATE TYPE "public"."StatusList_credentialidmode_enum" AS ENUM('ISSUANCE', 'PERSISTENCE', 'NEVER')`)
+    await queryRunner.query(
+      `CREATE TABLE "StatusList" ("id" character varying NOT NULL, "correlationId" character varying NOT NULL, "length" integer NOT NULL, "issuer" text NOT NULL, "type" "public"."StatusList_type_enum" NOT NULL DEFAULT 'StatusList2021', "driverType" "public"."StatusList_drivertype_enum" NOT NULL DEFAULT 'agent_typeorm', "credentialIdMode" "public"."StatusList_credentialidmode_enum" NOT NULL DEFAULT 'ISSUANCE', "proofFormat" character varying NOT NULL DEFAULT 'lds', "indexingDirection" character varying NOT NULL DEFAULT 'rightToLeft', "statusPurpose" character varying NOT NULL DEFAULT 'revocation', "statusListCredential" text, CONSTRAINT "UQ_correlationId" UNIQUE ("correlationId"), CONSTRAINT "PK_StatusList_Id" PRIMARY KEY ("id"))`
+    )
+    await queryRunner.query(
+      `ALTER TABLE "StatusListEntry" ADD CONSTRAINT "FK_statusListEntry_statusListId" FOREIGN KEY ("statusListId") REFERENCES "StatusList"("id") ON DELETE NO ACTION ON UPDATE NO ACTION`
+    )
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {}
+}

package/src/migrations/postgres/uuid.ts

@@ -0,0 +1,12 @@
+import { QueryRunner } from 'typeorm'
+
+export async function enableUuidv4(queryRunner: QueryRunner) {
+  try {
+    await queryRunner.query(`CREATE EXTENSION IF NOT EXISTS "uuid-ossp";`)
+  } catch (error) {
+    console.log(
+      `Please enable the uuid-ossp.control extension in your postgresql installation. It enables generating V4 UUID and can be found in the postgresql-contrib package`
+    )
+    throw error
+  }
+}

package/src/migrations/sqlite/1693866470000-CreateStatusList.ts

@@ -0,0 +1,24 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class CreateStatusList1693866470002 implements MigrationInterface {
+  name = 'CreateStatusList1693866470002'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE "StatusListEntry" ("statusListId" varchar NOT NULL, "statusListIndex" integer NOT NULL, "credentialId" varchar, "credentialHash" varchar(128), "correlationId" varchar(255), "value" varchar(50), PRIMARY KEY ("statusListId", "statusListIndex"))`
+    )
+    await queryRunner.query(
+      `CREATE TABLE "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') ) 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') ) NOT NULL DEFAULT ('rightToLeft'), "statusPurpose" varchar NOT NULL DEFAULT ('revocation'), "statusListCredential" text, CONSTRAINT "UQ_correlationId" UNIQUE ("correlationId"))`
+    )
+    await queryRunner.query(
+      `CREATE TABLE "temporary_StatusListEntry" ("statusListId" varchar NOT NULL, "statusListIndex" integer NOT NULL, "credentialId" varchar, "credentialHash" varchar(128), "correlationId" varchar(255), "value" varchar(50), CONSTRAINT "FK_statusListEntry_statusListId" FOREIGN KEY ("statusListId") REFERENCES "StatusList" ("id") ON DELETE NO ACTION ON UPDATE NO ACTION, 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"`
+    )
+    await queryRunner.query(`DROP TABLE "StatusListEntry"`)
+    await queryRunner.query(`ALTER TABLE "temporary_StatusListEntry" RENAME TO "StatusListEntry"`)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {}
+}

package/src/statusList/IStatusListStore.ts

@@ -0,0 +1,44 @@
+import { StatusListEntryEntity } from '../entities/statusList2021/StatusList2021EntryEntity'
+import {
+  IAddStatusListArgs,
+  IAddStatusListEntryArgs,
+  IGetStatusListArgs,
+  IGetStatusListEntriesArgs,
+  IGetStatusListEntryByCredentialIdArgs,
+  IGetStatusListEntryByIndexArgs,
+  IGetStatusListsArgs,
+  IRemoveStatusListArgs,
+  IStatusListEntryAvailableArgs,
+  IUpdateStatusListIndexArgs,
+} from '../types/statusList/IAbstractStatusListStore'
+import { IStatusListEntity, IStatusListEntryEntity } from '../types/statusList/statusList'
+
+export interface IStatusListStore {
+  getStatusList(args: IGetStatusListArgs): Promise<IStatusListEntity>
+
+  getStatusLists(args: IGetStatusListsArgs): Promise<Array<IStatusListEntity>>
+
+  removeStatusList(args: IRemoveStatusListArgs): Promise<void>
+
+  addStatusList(args: IAddStatusListArgs): Promise<IStatusListEntity>
+
+  updateStatusList(args: IUpdateStatusListIndexArgs): Promise<IStatusListEntity>
+
+  availableStatusListEntries(args: IStatusListEntryAvailableArgs): Promise<number[]>
+
+  addStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity>
+
+  updateStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity>
+
+  getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<StatusListEntryEntity | undefined>
+
+  getStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<StatusListEntryEntity | undefined>
+
+  removeStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<boolean>
+
+  removeStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<boolean>
+
+  getStatusListEntries(args: IGetStatusListEntriesArgs): Promise<IStatusListEntryEntity[]>
+
+  getStatusList(args: IGetStatusListArgs): Promise<IStatusListEntity>
+}

package/src/statusList/StatusListStore.ts

@@ -0,0 +1,237 @@
+import { OrPromise } from '@sphereon/ssi-types'
+import Debug from 'debug'
+import { DataSource, In, Repository } from 'typeorm'
+import { StatusListEntity } from '../entities/statusList2021/StatusList2021Entity'
+import { StatusListEntryEntity } from '../entities/statusList2021/StatusList2021EntryEntity'
+import {
+  IAddStatusListArgs,
+  IAddStatusListEntryArgs,
+  IGetStatusListArgs,
+  IGetStatusListEntriesArgs,
+  IGetStatusListEntryByCredentialIdArgs,
+  IGetStatusListEntryByIndexArgs,
+  IGetStatusListsArgs,
+  IRemoveStatusListArgs,
+  IStatusListEntryAvailableArgs,
+  IUpdateStatusListIndexArgs,
+  IStatusListEntity,
+  IStatusListEntryEntity,
+} from '../types'
+import { IStatusListStore } from './IStatusListStore'
+
+const debug = Debug('sphereon:ssi-sdk:data-store:status-list')
+
+export class StatusListStore implements IStatusListStore {
+  private readonly _dbConnection: OrPromise<DataSource>
+
+  constructor(dbConnection: OrPromise<DataSource>) {
+    this._dbConnection = dbConnection
+  }
+
+  /**
+   * Get's the available status list indices from the provided indices. Meaning it will filter out any index that is already known.
+   *
+   * The idea is that the caller provides a set of random status list indices. We can relatively easy check against the DB in an optimized way.
+   * If the status list is large it is probably best ot also provide at least a good number of indices. So something like 10 or 20 values.
+   * Callers are also expected to call this function multiple times if it does not yield results
+   *
+   * @param args
+   */
+  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 results = (
+      await repo.find({
+        where: {
+          statusList,
+          statusListIndex: In(statusListIndex),
+        },
+      })
+    ).map((index) => index.statusListIndex)
+    return statusListIndex.filter((index) => !results.includes(index))
+  }
+
+  async addStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity> {
+    return (await this.getStatusListEntryRepo()).save(args)
+  }
+
+  async updateStatusListEntry(args: IAddStatusListEntryArgs): Promise<IStatusListEntryEntity> {
+    const statusListId = typeof args.statusList === 'string' ? args.statusList : args.statusList.id
+    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,
+    }
+
+    const updateResult = await (
+      await this.getStatusListEntryRepo()
+    ).upsert(
+      { ...(result ?? { statusList: args.statusList, statusListIndex: args.statusListIndex }), ...updatedEntry },
+      { conflictPaths: ['statusList', 'statusListIndex'] }
+    )
+    console.log(updateResult)
+    return (await this.getStatusListEntryByIndex({ ...args, statusListId, errorOnNotFound: true })) as IStatusListEntryEntity
+  }
+
+  async getStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<StatusListEntryEntity | undefined> {
+    if (!args.statusListId && !args.correlationId) {
+      throw Error(`Cannot get statusList entry if not either a statusList id or correlationId is provided`)
+    }
+    const result = await (
+      await this.getStatusListEntryRepo()
+    ).findOne({
+      where: {
+        ...(args.statusListId && { statusList: args.statusListId }),
+        ...(args.correlationId && { correlationId: args.correlationId }),
+        statusListIndex: args.statusListIndex,
+      },
+    })
+
+    if (!result && args.errorOnNotFound) {
+      throw Error(`Could not find status list index ${args.statusListIndex} for status list id ${args.statusListId}`)
+    }
+    return result ?? undefined
+  }
+
+  async removeStatusListEntryByIndex(args: IGetStatusListEntryByIndexArgs): Promise<boolean> {
+    let error = false
+    try {
+      await this.getStatusListEntryByIndex(args) // only used to check it exists
+    } catch (error) {
+      error = true
+    }
+    if (error) {
+      console.log(`Could not delete statusList ${args.statusListId} entry by index ${args.statusListIndex}`)
+    } else {
+      const result = await (
+        await this.getStatusListEntryRepo()
+      ).delete({
+        ...(args.statusListId && { statusList: args.statusListId }),
+        ...(args.correlationId && { correlationId: args.correlationId }),
+        statusListIndex: args.statusListIndex,
+      })
+      error = !result.affected || result.affected !== 1
+    }
+    return !error
+  }
+
+  async getStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<StatusListEntryEntity | undefined> {
+    const credentialId = args.credentialId
+    if (!credentialId) {
+      throw Error('Can only get a credential by credentialId when a credentialId is supplied')
+    }
+    const statusList = await this.getStatusList({ id: args.statusListId, correlationId: args.statusListCorrelationId })
+    const where = {
+      statusList: statusList.id,
+      ...(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 })
+
+    if (!result && args.errorOnNotFound) {
+      throw Error(`Could not find status list credential id ${credentialId} for status list id ${statusList.id}`)
+    }
+    return result ?? undefined
+  }
+
+  async removeStatusListEntryByCredentialId(args: IGetStatusListEntryByCredentialIdArgs): Promise<boolean> {
+    let error = false
+    try {
+      await this.getStatusListEntryByCredentialId(args) // only used to check it exists
+    } catch (error) {
+      error = true
+    }
+    if (!error) {
+      const result = await (
+        await this.getStatusListEntryRepo()
+      ).delete({
+        ...(args.statusListId && { statusList: args.statusListId }),
+        ...(args.entryCorrelationId && { correlationId: args.entryCorrelationId }),
+        credentialId: args.credentialId,
+      })
+      error = !result.affected || result.affected !== 1
+    }
+    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> {
+    if (!args.id && !args.correlationId) {
+      throw Error(`At least and 'id' or 'correlationId' needs to be provided to lookup a status list`)
+    }
+    const where = []
+    if (args.id) {
+      where.push({ id: args.id })
+    }
+    if (args.correlationId) {
+      where.push({ correlationId: args.correlationId })
+    }
+    const result = await (await this.getStatusListRepo()).findOne({ where })
+    if (!result) {
+      throw Error(`No status list found for id ${args.id}`)
+    }
+    return result
+  }
+
+  async getStatusLists(args: IGetStatusListsArgs): Promise<Array<IStatusListEntity>> {
+    const result = await (
+      await this.getStatusListRepo()
+    ).find({
+      where: args.filter,
+    })
+
+    if (!result) {
+      return []
+    }
+    return result
+  }
+
+  async addStatusList(args: IAddStatusListArgs): Promise<IStatusListEntity> {
+    const { id, correlationId } = args
+
+    const result = await (
+      await this.getStatusListRepo()
+    ).findOne({
+      where: [{ id }, { correlationId }],
+    })
+    if (result) {
+      throw Error(`Status list for id ${id}, correlationId ${correlationId} already exists`)
+    }
+
+    debug('Adding status list ', id)
+    const createdResult = await (await this.getStatusListRepo()).save(args)
+
+    return createdResult
+  }
+
+  async updateStatusList(args: IUpdateStatusListIndexArgs): Promise<IStatusListEntity> {
+    const result = await this.getStatusList(args)
+    debug('Updating status list', result)
+    const updatedResult = await (await this.getStatusListRepo()).save(args, { transaction: true })
+    return updatedResult
+  }
+
+  async removeStatusList(args: IRemoveStatusListArgs): Promise<void> {
+    const result = await this.getStatusList(args)
+    await (await this.getStatusListRepo()).delete(result)
+  }
+
+  private async getDS(): Promise<DataSource> {
+    return await this._dbConnection
+  }
+
+  async getStatusListRepo(): Promise<Repository<StatusListEntity>> {
+    return (await this.getDS()).getRepository(StatusListEntity)
+  }
+
+  async getStatusListEntryRepo(): Promise<Repository<StatusListEntryEntity>> {
+    return (await this.getDS()).getRepository(StatusListEntryEntity)
+  }
+}

package/src/types/index.ts

@@ -2,3 +2,5 @@ export * from './issuanceBranding/issuanceBranding'
 export * from './issuanceBranding/IAbstractIssuanceBrandingStore'
 export * from './contact/contact'
 export * from './contact/IAbstractContactStore'
+export * from './statusList/statusList'
+export * from './statusList/IAbstractStatusListStore'