@sphereon/ssi-sdk.data-store 0.18.2-unstable.98 → 0.19.1-next.100

package/src/migrations/generic/index.ts

@@ -4,6 +4,7 @@ import { CreateContacts1690925872318 } from './3-CreateContacts'
 import { CreateStatusList1693866470000 } from './4-CreateStatusList'
 import { CreateAuditEvents1701635835330 } from './5-CreateAuditEvents'
 import { CreateDigitalCredential1708525189000 } from './6-CreateDigitalCredential'
+import { CreateMachineStateStore1708098041262 } from './7-CreateMachineStateStore'
 
 /**
  * The migrations array that SHOULD be used when initializing a TypeORM database connection.
@@ -19,6 +20,7 @@ export const DataStoreIssuanceBrandingMigrations = [CreateIssuanceBranding165946
 export const DataStoreStatusListMigrations = [CreateStatusList1693866470000]
 export const DataStoreEventLoggerMigrations = [CreateAuditEvents1701635835330]
 export const DataStoreDigitalCredentialMigrations = [CreateDigitalCredential1708525189000]
+export const DataStoreMachineStateMigrations = [CreateMachineStateStore1708098041262]
 
 // All migrations together
 export const DataStoreMigrations = [
@@ -27,4 +29,5 @@ export const DataStoreMigrations = [
   ...DataStoreStatusListMigrations,
   ...DataStoreEventLoggerMigrations,
   ...DataStoreDigitalCredentialMigrations,
+  ...DataStoreMachineStateMigrations,
 ]

package/src/migrations/index.ts

@@ -5,4 +5,5 @@ export {
   DataStoreIssuanceBrandingMigrations,
   DataStoreStatusListMigrations,
   DataStoreDigitalCredentialMigrations,
+  DataStoreMachineStateMigrations,
 } from './generic'

package/src/migrations/postgres/1708797018115-CreateMachineStateStore.ts

@@ -0,0 +1,29 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class CreateMachineStateStore1708797018115 implements MigrationInterface {
+  name = 'CreateMachineStateStore1708797018115'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+            CREATE TABLE "MachineStateInfoEntity" (
+                "instance_id" text NOT NULL,
+                "session_id" text,
+                "latest_state_name" text,
+                "machine_name" text NOT NULL,
+                "latest_event_type" text NOT NULL,
+                "state" text NOT NULL,
+                "created_at" TIMESTAMP NOT NULL DEFAULT now(),
+                "updated_at" TIMESTAMP NOT NULL DEFAULT now(),
+                "updated_count" integer NOT NULL DEFAULT 0,
+                "expires_at" TIMESTAMP,
+                "completed_at" TIMESTAMP,
+                "tenant_id" text,
+                CONSTRAINT "PK_MachineStateInfoEntity_id" PRIMARY KEY ("instance_id")
+            )
+        `)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "MachineStateInfoEntity"`)
+  }
+}

package/src/migrations/sqlite/1708796002272-CreateMachineStateStore.ts

@@ -0,0 +1,28 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class CreateMachineStateStore1708796002272 implements MigrationInterface {
+  name = 'CreateMachineStateStore1708796002272'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+            CREATE TABLE "MachineStateInfoEntity" (
+                "instance_id" varchar PRIMARY KEY NOT NULL,
+                "session_id" varchar,
+                "machine_name" varchar NOT NULL,
+                "latest_state_name" varchar,
+                "latest_event_type" varchar NOT NULL,
+                "state" text NOT NULL,
+                "created_at" datetime NOT NULL DEFAULT (datetime('now')),
+                "updated_at" datetime NOT NULL DEFAULT (datetime('now')),
+                "updated_count" integer NOT NULL DEFAULT 0,
+                "expires_at" datetime,
+                "completed_at" datetime,
+                "tenant_id" varchar
+            )
+        `)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "MachineStateInfoEntity"`)
+  }
+}

package/src/types/contact/contact.ts

@@ -15,7 +15,16 @@ export type Party = {
 }
 export type NonPersistedParty = Omit<
   Party,
-  'id' | 'identities' | 'electronicAddresses' | 'physicalAddresses' | 'contact' | 'roles' | 'partyType' | 'relationships' | 'createdAt' | 'lastUpdatedAt'
+  | 'id'
+  | 'identities'
+  | 'electronicAddresses'
+  | 'physicalAddresses'
+  | 'contact'
+  | 'roles'
+  | 'partyType'
+  | 'relationships'
+  | 'createdAt'
+  | 'lastUpdatedAt'
 > & {
   identities?: Array<NonPersistedIdentity>
   electronicAddresses?: Array<NonPersistedElectronicAddress>
@@ -24,7 +33,9 @@ export type NonPersistedParty = Omit<
   partyType: NonPersistedPartyType
   relationships?: Array<NonPersistedPartyRelationship>
 }
-export type PartialParty = Partial<Omit<Party, 'identities' | 'electronicAddresses' | 'physicalAddresses' | 'contact' | 'partyType' | 'relationships'>> & {
+export type PartialParty = Partial<
+  Omit<Party, 'identities' | 'electronicAddresses' | 'physicalAddresses' | 'contact' | 'partyType' | 'relationships'>
+> & {
   identities?: PartialIdentity
   electronicAddresses?: PartialElectronicAddress
   physicalAddresses?: PartialPhysicalAddress

package/src/types/index.ts

@@ -7,3 +7,4 @@ export * from './statusList/statusList'
 export * from './statusList/IAbstractStatusListStore'
 export * from './eventLogger/IAbstractEventLoggerStore'
 export * from './eventLogger/eventLogger'
+export * from './machineState/IAbstractMachineStateStore'

package/src/types/machineState/IAbstractMachineStateStore.ts

@@ -0,0 +1,68 @@
+export type StoreMachineStatePersistArgs = Omit<StoreMachineStateInfo, 'createdAt' | 'updatedAt'>
+
+export type StoreMachineStatesFindActiveArgs = Partial<Pick<StoreMachineStateInfo, 'machineName' | 'tenantId' | 'instanceId'>>
+
+export type FindMachineStatesFilterArgs = Array<Partial<Omit<StoreMachineStateInfo, 'state'>>>
+
+export type StoreFindMachineStatesArgs = {
+  filter: FindMachineStatesFilterArgs
+}
+
+export type StoreMachineStateGetArgs = Pick<StoreMachineStateInfo, 'instanceId' | 'tenantId'>
+
+export type StoreMachineStateDeleteArgs = StoreMachineStateGetArgs
+export type StoreMachineStateDeleteExpiredArgs = { machineName?: string; tenantId?: string; deleteDoneStates?: boolean }
+
+export interface StoreMachineStateInfo {
+  /**
+   * Unique instance ID of the machine
+   */
+  instanceId: string
+
+  /**
+   * Session Id of the machine. Not necessarily unique
+   */
+  sessionId?: string
+
+  /**
+   * Machine name
+   */
+  machineName: string
+
+  /**
+   * The latest state name. Can be empty for a newly initialize machine
+   */
+  latestStateName?: string
+
+  /**
+   * event types like SET_TOC, SET_FIRSTNAME, .... Will be xstate.init on a newly initialized machine
+   */
+  latestEventType: string
+
+  /**
+   * Serialized Machine state
+   */
+  state: string
+
+  /**
+   * Represents the creation date
+   */
+  createdAt: Date
+
+  /**
+   * Represents the expiration date
+   */
+  expiresAt?: Date
+
+  /**
+   * Represents the update date
+   */
+  updatedAt: Date
+
+  /**
+   * Represents a counter for tracking updates.
+   */
+  updatedCount: number
+  completedAt?: Date
+  tenantId?: string
+}