@sphereon/ssi-sdk.data-store 0.19.1-next.24 → 0.19.1-unstable.63

package/dist/types/xstate/IAbstractXStateStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAbstractXStateStore.js","sourceRoot":"","sources":["../../../src/types/xstate/IAbstractXStateStore.ts"],"names":[],"mappings":""}

package/dist/xstate/IAbstractXStateStore.d.ts

@@ -0,0 +1,9 @@
+import { DeleteExpiredStateArgs, DeleteStateArgs, GetActiveStateArgs, GetStatesArgs, SaveStateArgs, State } from '../types';
+export declare abstract class IAbstractXStateStore {
+    abstract saveState(state: SaveStateArgs): Promise<State>;
+    abstract getActiveState(args: GetActiveStateArgs): Promise<State>;
+    abstract getStates(args?: GetStatesArgs): Promise<Array<State>>;
+    abstract deleteState(args: DeleteStateArgs): Promise<boolean>;
+    abstract deleteExpiredStates(args: DeleteExpiredStateArgs): Promise<boolean>;
+}
+//# sourceMappingURL=IAbstractXStateStore.d.ts.map

package/dist/xstate/IAbstractXStateStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAbstractXStateStore.d.ts","sourceRoot":"","sources":["../../src/xstate/IAbstractXStateStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE,kBAAkB,EAAE,aAAa,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAE3H,8BAAsB,oBAAoB;IACxC,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC;IACxD,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC;IACjE,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/D,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAC7D,QAAQ,CAAC,mBAAmB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC;CAC7E"}

package/dist/xstate/IAbstractXStateStore.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IAbstractXStateStore = void 0;
+class IAbstractXStateStore {
+}
+exports.IAbstractXStateStore = IAbstractXStateStore;
+//# sourceMappingURL=IAbstractXStateStore.js.map

package/dist/xstate/IAbstractXStateStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAbstractXStateStore.js","sourceRoot":"","sources":["../../src/xstate/IAbstractXStateStore.ts"],"names":[],"mappings":";;;AAEA,MAAsB,oBAAoB;CAMzC;AAND,oDAMC"}

package/dist/xstate/XStateStore.d.ts

@@ -0,0 +1,17 @@
+import { OrPromise } from '@sphereon/ssi-types';
+import { DataSource } from 'typeorm';
+import { StateEntity } from '../entities/xstate/StateEntity';
+import { DeleteExpiredStateArgs, DeleteStateArgs, GetActiveStateArgs, GetStatesArgs, SaveStateArgs, State } from '../types';
+import { IAbstractXStateStore } from './IAbstractXStateStore';
+export declare class XStateStore extends IAbstractXStateStore {
+    private readonly dbConnection;
+    constructor(dbConnection: OrPromise<DataSource>);
+    saveState(state: SaveStateArgs): Promise<State>;
+    getActiveState(args: GetActiveStateArgs): Promise<State>;
+    getStates(args?: GetStatesArgs): Promise<Array<State>>;
+    deleteState(args: DeleteStateArgs): Promise<boolean>;
+    deleteExpiredStates(args: DeleteExpiredStateArgs): Promise<boolean>;
+    static stateFrom: (stateEntity: StateEntity) => State;
+    static stateEntityFrom: (state: State | SaveStateArgs) => StateEntity;
+}
+//# sourceMappingURL=XStateStore.d.ts.map

package/dist/xstate/XStateStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"XStateStore.d.ts","sourceRoot":"","sources":["../../src/xstate/XStateStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAE/C,OAAO,EAAY,UAAU,EAA8B,MAAM,SAAS,CAAA;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAA;AAC5D,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE,kBAAkB,EAAE,aAAa,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAC3H,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAI7D,qBAAa,WAAY,SAAQ,oBAAoB;IACnD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuB;gBAExC,YAAY,EAAE,SAAS,CAAC,UAAU,CAAC;IAKzC,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC;IAM/C,cAAc,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC;IA+BxD,SAAS,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAUtD,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAepD,mBAAmB,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC;IAazE,OAAc,SAAS,gBAAiB,WAAW,KAAG,KAAK,CAK1D;IAED,OAAc,eAAe,UAAW,KAAK,GAAG,aAAa,KAAG,WAAW,CAK1E;CACF"}

package/dist/xstate/XStateStore.js

@@ -0,0 +1,110 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XStateStore = void 0;
+const debug_1 = __importDefault(require("debug"));
+const typeorm_1 = require("typeorm");
+const StateEntity_1 = require("../entities/xstate/StateEntity");
+const IAbstractXStateStore_1 = require("./IAbstractXStateStore");
+const debug = (0, debug_1.default)('sphereon:ssi-sdk:xstate');
+class XStateStore extends IAbstractXStateStore_1.IAbstractXStateStore {
+    constructor(dbConnection) {
+        super();
+        this.dbConnection = dbConnection;
+    }
+    saveState(state) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const connection = yield this.dbConnection;
+            debug(`Executing saveState with state: ${JSON.stringify(state)}`);
+            return connection.getRepository(StateEntity_1.StateEntity).save(XStateStore.stateEntityFrom(state));
+        });
+    }
+    getActiveState(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { tenantId, machineType } = args;
+            const connection = yield this.dbConnection;
+            debug(`Executing getActiveState query with machineType: ${machineType}, tenantId: ${tenantId}`);
+            const queryBuilder = connection
+                .getRepository(StateEntity_1.StateEntity)
+                .createQueryBuilder('state')
+                .where('state.completedAt IS NULL')
+                .andWhere(new typeorm_1.Brackets((qb) => {
+                qb.where('state.expiresAt IS NULL').orWhere('state.expiresAt > :now', { now: new Date() });
+            }))
+                .orderBy('state.updatedAt', 'DESC');
+            if (tenantId) {
+                queryBuilder.andWhere('state.tenantId = :tenantId', { tenantId });
+            }
+            if (machineType) {
+                queryBuilder.andWhere('state.machineType = :machineType', { machineType });
+            }
+            const result = yield queryBuilder.getOne();
+            if (!result) {
+                throw new Error(`No active state found for machineType: ${machineType}, tenantId: ${tenantId}`);
+            }
+            return XStateStore.stateFrom(result);
+        });
+    }
+    getStates(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const connection = yield this.dbConnection;
+            debug('Getting states', args);
+            const result = yield connection.getRepository(StateEntity_1.StateEntity).find(Object.assign({}, ((args === null || args === void 0 ? void 0 : args.filter) && { where: args === null || args === void 0 ? void 0 : args.filter })));
+            return result.map((event) => XStateStore.stateFrom(event));
+        });
+    }
+    deleteState(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!args.id) {
+                throw new Error('No id parameter is provided.');
+            }
+            try {
+                const connection = yield this.dbConnection;
+                debug(`Executing deleteState query with id: ${args.id}`);
+                const result = yield connection.getRepository(StateEntity_1.StateEntity).delete(args.id);
+                return result.affected != null && result.affected > 0;
+            }
+            catch (error) {
+                debug(`Error deleting state: ${error}`);
+                return false;
+            }
+        });
+    }
+    deleteExpiredStates(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const connection = yield this.dbConnection;
+                debug(`Executing deleteExpiredStates query with params: ${JSON.stringify(args)}`);
+                const deleteCriteria = Object.assign({ expiresAt: (0, typeorm_1.LessThan)(new Date()) }, (args.machineType && { type: args.machineType }));
+                const result = yield connection.getRepository(StateEntity_1.StateEntity).delete(deleteCriteria);
+                return result.affected != null && result.affected > 0;
+            }
+            catch (error) {
+                debug(`Error deleting state: ${error}`);
+                return false;
+            }
+        });
+    }
+}
+exports.XStateStore = XStateStore;
+XStateStore.stateFrom = (stateEntity) => {
+    return Object.assign(Object.assign({}, stateEntity), { state: JSON.parse(stateEntity.state) });
+};
+XStateStore.stateEntityFrom = (state) => {
+    const entity = new StateEntity_1.StateEntity();
+    Object.assign(entity, state);
+    entity.state = JSON.stringify(state.state);
+    return entity;
+};
+//# sourceMappingURL=XStateStore.js.map

package/dist/xstate/XStateStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XStateStore.js","sourceRoot":"","sources":["../../src/xstate/XStateStore.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,kDAAyB;AACzB,qCAA0E;AAE1E,gEAA4D;AAE5D,iEAA6D;AAE7D,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,yBAAyB,CAAC,CAAA;AAE9C,MAAa,WAAY,SAAQ,2CAAoB;IAGnD,YAAY,YAAmC;QAC7C,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IAClC,CAAC;IAEK,SAAS,CAAC,KAAoB;;YAClC,MAAM,UAAU,GAAe,MAAM,IAAI,CAAC,YAAY,CAAA;YACtD,KAAK,CAAC,mCAAmC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;YACjE,OAAO,UAAU,CAAC,aAAa,CAAC,yBAAW,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAA;QACvF,CAAC;KAAA;IAEK,cAAc,CAAC,IAAwB;;YAC3C,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,IAAI,CAAA;YACtC,MAAM,UAAU,GAAe,MAAM,IAAI,CAAC,YAAY,CAAA;YACtD,KAAK,CAAC,oDAAoD,WAAW,eAAe,QAAQ,EAAE,CAAC,CAAA;YAE/F,MAAM,YAAY,GAAG,UAAU;iBAC5B,aAAa,CAAC,yBAAW,CAAC;iBAC1B,kBAAkB,CAAC,OAAO,CAAC;iBAC3B,KAAK,CAAC,2BAA2B,CAAC;iBAClC,QAAQ,CACP,IAAI,kBAAQ,CAAC,CAAC,EAAE,EAAE,EAAE;gBAClB,EAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,GAAG,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAA;YAC5F,CAAC,CAAC,CACH;iBACA,OAAO,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAA;YAErC,IAAI,QAAQ,EAAE;gBACZ,YAAY,CAAC,QAAQ,CAAC,4BAA4B,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAA;aAClE;YACD,IAAI,WAAW,EAAE;gBACf,YAAY,CAAC,QAAQ,CAAC,kCAAkC,EAAE,EAAE,WAAW,EAAE,CAAC,CAAA;aAC3E;YAED,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE,CAAA;YAE1C,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,0CAA0C,WAAW,eAAe,QAAQ,EAAE,CAAC,CAAA;aAChG;YACD,OAAO,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;QACtC,CAAC;KAAA;IAEK,SAAS,CAAC,IAAoB;;YAClC,MAAM,UAAU,GAAe,MAAM,IAAI,CAAC,YAAY,CAAA;YACtD,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAA;YAC7B,MAAM,MAAM,GAAuB,MAAM,UAAU,CAAC,aAAa,CAAC,yBAAW,CAAC,CAAC,IAAI,mBAC9E,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,KAAI,EAAE,KAAK,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAAC,EAC5C,CAAA;YAEF,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;QACzE,CAAC;KAAA;IAEK,WAAW,CAAC,IAAqB;;YACrC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;gBACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;aAChD;YACD,IAAI;gBACF,MAAM,UAAU,GAAe,MAAM,IAAI,CAAC,YAAY,CAAA;gBACtD,KAAK,CAAC,wCAAwC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;gBACxD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,aAAa,CAAC,yBAAW,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBAC1E,OAAO,MAAM,CAAC,QAAQ,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAA;aACtD;YAAC,OAAO,KAAK,EAAE;gBACd,KAAK,CAAC,yBAAyB,KAAK,EAAE,CAAC,CAAA;gBACvC,OAAO,KAAK,CAAA;aACb;QACH,CAAC;KAAA;IAEK,mBAAmB,CAAC,IAA4B;;YACpD,IAAI;gBACF,MAAM,UAAU,GAAe,MAAM,IAAI,CAAC,YAAY,CAAA;gBACtD,KAAK,CAAC,oDAAoD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBACjF,MAAM,cAAc,mBAAoC,SAAS,EAAE,IAAA,kBAAQ,EAAC,IAAI,IAAI,EAAE,CAAC,IAAK,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAE,CAAA;gBAC9I,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,aAAa,CAAC,yBAAW,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;gBACjF,OAAO,MAAM,CAAC,QAAQ,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAA;aACtD;YAAC,OAAO,KAAK,EAAE;gBACd,KAAK,CAAC,yBAAyB,KAAK,EAAE,CAAC,CAAA;gBACvC,OAAO,KAAK,CAAA;aACb;QACH,CAAC;KAAA;;AAjFH,kCAgGC;AAbe,qBAAS,GAAG,CAAC,WAAwB,EAAS,EAAE;IAC5D,uCACK,WAAW,KACd,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,IACrC;AACH,CAAC,CAAA;AAEa,2BAAe,GAAG,CAAC,KAA4B,EAAe,EAAE;IAC5E,MAAM,MAAM,GAAG,IAAI,yBAAW,EAAE,CAAA;IAChC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IAC5B,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAC1C,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sphereon/ssi-sdk.data-store",
-  "version": "0.19.1-next.24+282b8def",
+  "version": "0.19.1-unstable.63+a98fb8b0",
   "source": "src/index.ts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,8 +13,8 @@
     "typeorm-postgres:migration:run": "pnpm run typeorm -- migration:run -c migration-postgres"
   },
   "dependencies": {
-    "@sphereon/ssi-sdk.core": "0.19.1-next.24+282b8def",
-    "@sphereon/ssi-types": "0.19.1-next.24+282b8def",
+    "@sphereon/ssi-sdk.core": "0.19.1-unstable.63+a98fb8b0",
+    "@sphereon/ssi-types": "0.19.1-unstable.63+a98fb8b0",
     "@veramo/core": "4.2.0",
     "@veramo/utils": "4.2.0",
     "class-validator": "^0.14.0",
@@ -44,5 +44,5 @@
     "PostgreSQL",
     "Contact Store"
   ],
-  "gitHead": "282b8def3880eeeb43edcb33ef463ad57342ac76"
+  "gitHead": "a98fb8b0055b8fcb78c3865770014c00ddd0dc2a"
 }

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

@@ -0,0 +1,47 @@
+import { DataSource } from 'typeorm'
+import { StateEntity } from '../entities/xstate/StateEntity'
+
+import { DataStoreXStateStoreEntities, DataStoreXStateStoreMigrations, SaveStateArgs, XStateStore } from '../index'
+
+describe('Database entities tests', (): void => {
+  let dbConnection: DataSource
+
+  beforeEach(async (): Promise<void> => {
+    dbConnection = await new DataSource({
+      type: 'sqlite',
+      database: ':memory:',
+      //logging: 'all',
+      migrationsRun: false,
+      migrations: DataStoreXStateStoreMigrations,
+      synchronize: false,
+      entities: [...DataStoreXStateStoreEntities],
+    }).initialize()
+    await dbConnection.runMigrations()
+    expect(await dbConnection.showMigrations()).toBeFalsy()
+  })
+
+  afterEach(async (): Promise<void> => {
+    await dbConnection.destroy()
+  })
+
+  it('should save xstate event to database', async (): Promise<void> => {
+    const expiresAt = new Date()
+    expiresAt.setTime(expiresAt.getTime() + 100000)
+    const xstateEvent: SaveStateArgs = {
+      stateName: 'acceptAgreement',
+      machineType: 'Onboarding',
+      xStateEventType: 'SET_TOC',
+      state: { myState: 'test_state' },
+      tenantId: 'test_tenant_id',
+      expiresAt,
+    }
+    const fromDb: StateEntity = await dbConnection.getRepository(StateEntity).save(XStateStore.stateEntityFrom(xstateEvent))
+
+    expect(fromDb).toBeDefined()
+    expect(fromDb?.id).not.toBeNull()
+    expect(fromDb?.machineType).toEqual(xstateEvent.machineType)
+    expect(JSON.parse(fromDb?.state)).toEqual(xstateEvent.state)
+    expect(fromDb?.tenantId).toEqual(xstateEvent.tenantId)
+    expect(fromDb?.completedAt).toBeNull()
+  })
+})

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

@@ -0,0 +1,158 @@
+import { DataSource } from 'typeorm'
+import {
+  DataStoreXStateStoreEntities,
+  GetActiveStateArgs,
+  NonPersistedXStateStoreEvent,
+  SaveStateArgs,
+  State,
+  XStateStore,
+} from '../index'
+import { DataStoreXStateStoreMigrations } from '../migrations'
+
+describe('Database entities tests', (): void => {
+  let dbConnection: DataSource
+  let xstateStore: XStateStore
+
+  beforeEach(async (): Promise<void> => {
+    dbConnection = await new DataSource({
+      type: 'sqlite',
+      database: ':memory:',
+      logging: 'all',
+      migrationsRun: false,
+      migrations: DataStoreXStateStoreMigrations,
+      synchronize: false,
+      entities: DataStoreXStateStoreEntities,
+    }).initialize()
+    await dbConnection.runMigrations()
+    expect(await dbConnection.showMigrations()).toBeFalsy()
+    xstateStore = new XStateStore(dbConnection)
+  })
+
+  afterEach(async (): Promise<void> => {
+    await dbConnection.destroy()
+  })
+
+  it('should store xstate event', async (): Promise<void> => {
+    const xstateEvent: NonPersistedXStateStoreEvent = {
+      stateName: 'enterPersonalDetails',
+      machineType: 'Onboarding',
+      xStateEventType: 'SET_PERSONAL_DATA',
+      state: 'test_state',
+      expiresAt: new Date(new Date().getDate() + 100000),
+      tenantId: 'test_tenant_id',
+    }
+
+    const savedXStoreEvent: State = await xstateStore.saveState(xstateEvent)
+    expect(savedXStoreEvent).toBeDefined()
+  })
+
+  it('should get all state events', async (): Promise<void> => {
+    const xstateEvent: NonPersistedXStateStoreEvent = {
+      stateName: 'enterPersonalDetails',
+      machineType: 'Onboarding',
+      xStateEventType: 'SET_PERSONAL_DATA',
+      state: 'test_state',
+      expiresAt: new Date(new Date().getDate() + 100000),
+      tenantId: 'test_tenant_id',
+    }
+
+    const stateEvent1: NonPersistedXStateStoreEvent = await xstateStore.saveState({ ...xstateEvent })
+    expect(stateEvent1).toBeDefined()
+
+    const stateEvent2: NonPersistedXStateStoreEvent = await xstateStore.saveState({ ...xstateEvent })
+    expect(stateEvent2).toBeDefined()
+
+    const result: Array<State> = await xstateStore.getStates()
+    expect(result).toHaveLength(2)
+  })
+
+  it('should retrieve an xstate event', async (): Promise<void> => {
+    const expiresAt = new Date()
+    expiresAt.setTime(expiresAt.getTime() + 100000)
+    const xstateEvent: SaveStateArgs = {
+      stateName: 'enterPersonalDetails',
+      machineType: 'Onboarding',
+      xStateEventType: 'SET_PERSONAL_DATA',
+      state: 'test_state',
+      expiresAt,
+      tenantId: 'test_tenant_id',
+    }
+
+    const savedXStoreEvent1: State = await xstateStore.saveState(xstateEvent)
+    expect(savedXStoreEvent1).toBeDefined()
+    const result: State = await xstateStore.getActiveState({ machineType: xstateEvent.machineType, tenantId: xstateEvent.tenantId })
+    expect(result).toBeDefined()
+  })
+
+  it('should delete an xstate event', async (): Promise<void> => {
+    const xstateEvent: NonPersistedXStateStoreEvent = {
+      stateName: 'enterPersonalDetails',
+      machineType: 'Onboarding',
+      xStateEventType: 'SET_PERSONAL_DATA',
+      state: 'test_state',
+      expiresAt: new Date(new Date().getDate() + 100000),
+      tenantId: 'test_tenant_id',
+    }
+
+    const savedXStoreEvent: State = await xstateStore.saveState(xstateEvent)
+    expect(savedXStoreEvent).toBeDefined()
+
+    const result: boolean = await xstateStore.deleteState({ id: savedXStoreEvent.id })
+    expect(result).toBeTruthy()
+  })
+
+  it('should return an error if type filter does not match', async (): Promise<void> => {
+    const args: GetActiveStateArgs = {
+      machineType: 'unknown_machine',
+    }
+
+    await expect(xstateStore.getActiveState(args)).rejects.toEqual(
+      Error('No active state found for machineType: unknown_machine, tenantId: undefined')
+    )
+  })
+
+  it('should delete the expired records', async () => {
+    const futureExpiresAt = new Date()
+    futureExpiresAt.setTime(futureExpiresAt.getTime() + 100000) // Future expiration
+
+    const pastExpiresAt = new Date()
+    pastExpiresAt.setTime(pastExpiresAt.getTime() - 100000) // Past expiration, already expired
+
+    const oldestXstateEvent: SaveStateArgs = {
+      stateName: 'acceptAgreement',
+      machineType: 'Onboarding1',
+      xStateEventType: 'SET_TOC',
+      state: 'test_state',
+      expiresAt: futureExpiresAt,
+      tenantId: 'test_tenant_id',
+    }
+    const middleXstateEvent: SaveStateArgs = {
+      stateName: 'acceptAgreement',
+      machineType: 'Onboarding2',
+      xStateEventType: 'SET_POLICY2',
+      state: 'test_state',
+      expiresAt: futureExpiresAt,
+      tenantId: 'test_tenant_id',
+    }
+    const newestXstateEvent: SaveStateArgs = {
+      stateName: 'enterPersonalDetails',
+      machineType: 'Onboarding3',
+      xStateEventType: 'SET_PERSONAL_DATA',
+      state: 'test_state',
+      expiresAt: pastExpiresAt, // This event should be already expired
+      tenantId: 'test_tenant_id',
+    }
+
+    await xstateStore.saveState(oldestXstateEvent)
+    await xstateStore.saveState(middleXstateEvent)
+    await xstateStore.saveState(newestXstateEvent)
+
+    await xstateStore.deleteExpiredStates({})
+
+    await expect(xstateStore.getActiveState({ machineType: 'Onboarding1' })).resolves.toBeDefined()
+    await expect(xstateStore.getActiveState({ machineType: 'Onboarding2' })).resolves.toBeDefined()
+    await expect(xstateStore.getActiveState({ machineType: 'Onboarding3' })).rejects.toEqual(
+      Error('No active state found for machineType: Onboarding3, tenantId: undefined')
+    )
+  })
+})

package/src/entities/xstate/StateEntity.ts

@@ -0,0 +1,34 @@
+import { BaseEntity, Column, CreateDateColumn, Entity, PrimaryGeneratedColumn, UpdateDateColumn } from 'typeorm'
+
+@Entity('StateEntity')
+export class StateEntity extends BaseEntity {
+  @PrimaryGeneratedColumn('uuid', { name: 'id' })
+  id!: string
+
+  @Column({ name: 'state_name', nullable: false })
+  stateName!: string
+
+  @Column({ name: 'machine_type', nullable: false })
+  machineType!: string
+
+  @Column({ name: 'xstate_event_type', nullable: false })
+  xStateEventType!: string
+
+  @Column({ name: 'state', nullable: false })
+  state!: string
+
+  @CreateDateColumn({ name: 'created_at', nullable: false })
+  createdAt!: Date
+
+  @UpdateDateColumn({ name: 'updated_at', nullable: false })
+  updatedAt!: Date
+
+  @Column({ name: 'expires_at', type: 'datetime', nullable: true })
+  expiresAt?: Date
+
+  @Column({ name: 'completed_at', type: 'datetime', nullable: true })
+  completedAt?: Date
+
+  @Column({ name: 'tenant_id', type: 'varchar', nullable: true })
+  tenantId?: string
+}

package/src/index.ts

@@ -18,6 +18,7 @@ import { IssuerBrandingEntity, issuerBrandingEntityFrom } from './entities/issua
 import { TextAttributesEntity, textAttributesEntityFrom } from './entities/issuanceBranding/TextAttributesEntity'
 import { StatusListEntity } from './entities/statusList2021/StatusList2021Entity'
 import { StatusListEntryEntity } from './entities/statusList2021/StatusList2021EntryEntity'
+import { StateEntity } from './entities/xstate/StateEntity'
 import { IStatusListEntity, IStatusListEntryEntity } from './types'
 import { PartyRelationshipEntity } from './entities/contact/PartyRelationshipEntity'
 import { PartyTypeEntity } from './entities/contact/PartyTypeEntity'
@@ -35,12 +36,16 @@ import { DigitalCredentialEntity } from './entities/digitalCredential/DigitalCre
 import { digitalCredentialFrom, digitalCredentialsFrom, nonPersistedDigitalCredentialEntityFromAddArgs } from './utils/digitalCredential/MappingUtils'
 export { AbstractEventLoggerStore } from './eventLogger/AbstractEventLoggerStore'
 export { EventLoggerStore } from './eventLogger/EventLoggerStore'
+export { IAbstractXStateStore } from './xstate/IAbstractXStateStore'
+export { XStateStore } from './xstate/XStateStore'
+
 export {
   DataStoreMigrations,
   DataStoreEventLoggerMigrations,
   DataStoreContactMigrations,
   DataStoreIssuanceBrandingMigrations,
   DataStoreStatusListMigrations,
+  DataStoreXStateStoreMigrations,
 } from './migrations'
 export * from './types'
 export * from './utils/contact/MappingUtils'
@@ -81,6 +86,8 @@ export const DataStoreEventLoggerEntities = [AuditEventEntity]
 
 export const DataStoreDigitalCredentialEntities = [DigitalCredentialEntity]
 
+export const DataStoreXStateStoreEntities = [StateEntity]
+
 // All entities combined if a party wants to enable them all at once
 export const DataStoreEntities = [
   ...DataStoreContactEntities,
@@ -88,6 +95,7 @@ export const DataStoreEntities = [
   ...DataStoreStatusListEntities,
   ...DataStoreEventLoggerEntities,
   ...DataStoreDigitalCredentialEntities,
+  ...DataStoreXStateStoreEntities,
 ]
 
 export {
@@ -128,4 +136,5 @@ export {
   digitalCredentialFrom,
   digitalCredentialsFrom,
   nonPersistedDigitalCredentialEntityFromAddArgs,
+  StateEntity,
 }

package/src/migrations/generic/7-CreateXStateStore.ts

@@ -0,0 +1,66 @@
+import { DatabaseType, MigrationInterface, QueryRunner } from 'typeorm'
+import Debug from 'debug'
+import { CreateXStateStore1708797018115 } from '../postgres/1708797018115-CreateXStateStore'
+import { CreateXStateStore1708796002272 } from '../sqlite/1708796002272-CreateXStateStore'
+
+const debug: Debug.Debugger = Debug('sphereon:ssi-sdk:migrations')
+
+export class CreateXStateStore1708098041262 implements MigrationInterface {
+  name = 'CreateXStateStore1708098041262'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    debug('migration: creating contacts tables')
+    const dbType: DatabaseType = queryRunner.connection.driver.options.type
+
+    switch (dbType) {
+      case 'postgres': {
+        debug('using postgres migration file')
+        const mig: CreateXStateStore1708797018115 = new CreateXStateStore1708797018115()
+        await mig.up(queryRunner)
+        debug('Migration statements executed')
+        return
+      }
+      case 'sqlite':
+      case 'expo':
+      case 'react-native': {
+        debug('using sqlite/react-native migration file')
+        const mig: CreateXStateStore1708796002272 = new CreateXStateStore1708796002272()
+        await mig.up(queryRunner)
+        debug('Migration statements executed')
+        return
+      }
+      default:
+        return Promise.reject(
+          `Migrations are currently only supported for sqlite, react-native, expo and postgres. Was ${dbType}. 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 contacts tables')
+    const dbType: DatabaseType = queryRunner.connection.driver.options.type
+
+    switch (dbType) {
+      case 'postgres': {
+        debug('using postgres migration file')
+        const mig: CreateXStateStore1708797018115 = new CreateXStateStore1708797018115()
+        await mig.down(queryRunner)
+        debug('Migration statements executed')
+        return
+      }
+      case 'sqlite':
+      case 'expo':
+      case 'react-native': {
+        debug('using sqlite/react-native migration file')
+        const mig: CreateXStateStore1708796002272 = new CreateXStateStore1708796002272()
+        await mig.down(queryRunner)
+        debug('Migration statements executed')
+        return
+      }
+      default:
+        return Promise.reject(
+          `Migrations are currently only supported for sqlite, react-native, expo and postgres. Was ${dbType}. Please run your database without migrations and with 'migrationsRun: false' and 'synchronize: true' for now`
+        )
+    }
+  }
+}

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 { CreateXStateStore1708098041262 } from './7-CreateXStateStore'
 
 /**
  * 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 DataStoreXStateStoreMigrations = [CreateXStateStore1708098041262]
 
 // All migrations together
 export const DataStoreMigrations = [
@@ -27,4 +29,5 @@ export const DataStoreMigrations = [
   ...DataStoreStatusListMigrations,
   ...DataStoreEventLoggerMigrations,
   ...DataStoreDigitalCredentialMigrations,
+  ...DataStoreXStateStoreMigrations,
 ]

package/src/migrations/index.ts

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

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

@@ -0,0 +1,29 @@
+import { enablePostgresUuidExtension } from '@sphereon/ssi-sdk.core'
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class CreateXStateStore1708797018115 implements MigrationInterface {
+  name = 'CreateXStateStore1708797018115'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await enablePostgresUuidExtension(queryRunner)
+    await queryRunner.query(`
+            CREATE TABLE "StateEntity" (
+                "id" uuid NOT NULL DEFAULT uuid_generate_v4(),
+                "state_name" character varying NOT NULL,
+                "machine_type" character varying NOT NULL,
+                "xstate_event_type" character varying NOT NULL,
+                "state" text NOT NULL,
+                "created_at" TIMESTAMP NOT NULL DEFAULT now(),
+                "updated_at" TIMESTAMP NOT NULL DEFAULT now(),
+                "expires_at" TIMESTAMP,
+                "completed_at" TIMESTAMP,
+                "tenant_id" character varying,
+                CONSTRAINT "PK_StateEntity_id" PRIMARY KEY ("id")
+            )
+        `)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "StateEntity"`)
+  }
+}

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

@@ -0,0 +1,26 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class CreateXStateStore1708796002272 implements MigrationInterface {
+  name = 'CreateXStateStore1708796002272'
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+            CREATE TABLE "StateEntity" (
+                "id" varchar PRIMARY KEY NOT NULL,
+                "state_name" varchar NOT NULL,
+                "machine_type" varchar NOT NULL,
+                "xstate_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')),
+                "expires_at" datetime,
+                "completed_at" datetime,
+                "tenant_id" varchar
+            )
+        `)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "StateEntity"`)
+  }
+}

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 './xstate/IAbstractXStateStore'