@sphereon/ssi-sdk.xstate-machine-persistence 0.19.1-next.75

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this fragment.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2021] [Sphereon BV]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,181 @@
+<!--suppress HtmlDeprecatedAttribute -->
+<h1 align="center">
+  <br>
+  <a href="https://www.sphereon.com"><img src="https://sphereon.com/content/themes/sphereon/assets/img/logo.svg" alt="Sphereon" width="400"></a>
+  <br>XState Machine Persistence
+  <br>Allows to continue xstate machine at a later point in time
+
+  <br>
+</h1>
+
+The XState Persistence Plugin is designed to manage and persist XState machine states, allowing for durable, long-term
+storage of state machines.
+This enables applications to save, load, and delete state machine instances, facilitating seamless state management and
+recovery across sessions.
+
+Features:
+
+- Load State: Retrieve the current state of an XState machine from persistent storage.
+- Delete Expired States: Automatically remove state instances that have exceeded their lifespan, or are finished
+  ensuring efficient use of storage.
+- Persist Machine Snapshot: Save snapshots of XState machine states, allowing for recovery and resumption of stateful
+  processes. This can be done manually or it can be automatically registered with any xstate interpreter instance
+
+Installation
+
+To add the XState Persistence Plugin to your project, run:
+
+```shell
+yarn add @sphereon/ssi-sdk.xstate-machine-persistence
+```
+
+Or if you prefer using npm:
+
+```shell
+npm install @sphereon/ssi-sdk.xstate-machine-persistence
+```
+
+# Usage
+
+Configuring the Plugin with Veramo
+
+First, ensure you have Veramo set up in your project. Then, integrate the XState Persistence Plugin as follows:
+
+```typescript
+import { createAgent } from '@veramo/core'
+import { MachineStatePersistence, DataStoreMachineStateMigrations, DataStoreMachineStateEntities } from '@sphereon/ssi-sdk.xstate-machine-persistence'
+
+const dbConnection = await new DataSource({
+  type: 'sqlite',
+  database: ':memory:',
+  logging: 'all',
+  migrationsRun: false,
+  migrations: DataStoreMachineStateMigrations, // Database migrations for the data store, specific for state machines
+  synchronize: false,
+  entities: DataStoreMachineStateEntities, // All the entities needed for the data store, related to state machines
+}).initialize()
+
+const agent = createAgent({
+  plugins: [
+    new MachineStatePersistence({
+      eventTypes: ['EVERY'], // Enables listening to 'EVERY' events to persist the state on every state change
+      store: new MachineStateStore(dbConnection),
+    }),
+  ],
+})
+```
+
+## Automatic registration of state change persistence
+
+You can use a simple method on an Xstate machine interpreter to automatically persist the latest state on every state
+change of the machine, allowing for later continuation of the machine.
+
+```typescript
+import { createMachine, interpret } from 'xstate'
+import { machineStatePersistRegistration } from '@sphereon/ssi-sdk.xstate-machine-persistence'
+
+const context = { ...agent.context, agent }
+export const exampleMachine = createMachine({
+  predictableActionArguments: true,
+  id: 'example',
+  context: {},
+  initial: 'init',
+  states: {
+    init: {
+      id: 'init',
+      on: {
+        finalize: {
+          target: 'final',
+        },
+      },
+    },
+    final: {
+      id: 'final',
+      type: 'final',
+    },
+  },
+})
+
+const instance = interpret(exampleMachine).start()
+
+/**
+ *  - instance is the Xstate Machine interpreter instance
+ *  - context is the agent context
+ *  - machineName is optional. It will be deduced from the machine if not provided. If you use a different name, be sure to use that for any future methods as well
+ *  - instanceId is optional. Allows you to provide your own unique Id. If not provided a random uuid will be generated
+ */
+const registration = await machineStatePersistRegistration({ instance, context, machineName: exampleMachine.id })
+console.log(JSON.stringify(registration))
+/**
+ * {
+ *   "machineName": "example",
+ *   "instanceId": "585b72e3-0655-4aee-a575-1234873ea7b0",
+ *   "createdAt": "2024-03-07T22:47:45.445Z"
+ * }
+ */
+
+// That is all. From this point on the machine will persist the state on every state change. You can use the instanceId value if you want to do anything with the persisted object at a later point in time
+```
+
+## Retrieving machine state info.
+
+You can retrieve machine state info in 2 ways. If you know the instanceId, you can directly get it. Otherwise you can query for the active, read not finalized or cleaned up, instances of machine states.
+
+Getting a single machine state info object by instance id:
+
+```typescript
+const machineStateInfo = await agent.machineStateGet({ instanceId })
+console.log(JSON.stringify(machineStateInfo, null, 2))
+/**
+ * {
+ *      "instanceId": "585b72e3-0655-4aee-a575-1234873ea7b0",
+ *      "sessionId": "x:1",             <=== The xtsate session id. Please note that this is only unique for a single xstate instance in memory and will be lost accross restarts
+ *      "machineName": "example",
+ *      "latestStateName": "init",      <=== The latest state of the xstate machine for easy access
+ *      "latestEventType": "increment", <=== The latest event of the xstate machine for easy access
+ *      "state": {                      <=== This is the actual Xstate state
+ *          "actions": [],
+ *          "activities": {},
+ *          "meta": {},
+ *          ....
+ *      },
+ *      "createdAt": "2024-03-07T23:00:11.438Z",
+ *      "updatedAt": "2024-03-07T23:00:11.543Z",
+ *      "updatedCount": 1,              <=== The amount of updates applied to the persisted state (the amount of events/statechanges)
+ *      "expiresAt": null,              <=== If this date-time is set, the machine state will not be used anymore
+ *      "completedAt": null             <=== The date-time the instance reached a final state
+ * }
+ */
+```
+
+Getting active machine state info objects by machine name:
+
+```typescript
+const machineStateInfos = await agent.machineStatesFindActive({ machineName: 'example' })
+console.log(JSON.stringify(machineStateInfos[0], null, 2))
+// See console.log example in previous code block
+```
+
+## Manual persistence and cleanup methods
+
+Persisting a Machine Snapshot
+
+To save the current state of an XState machine:
+
+```typescript
+await agent.machineStatePersist({
+  instanceId: 'your-state-instanceId',
+  state: 'You Xstate here',
+})
+```
+
+Deleting Expired States
+
+To clean up expired states from the storage:
+
+```typescript
+await agent.machineStatesDeleteExpired({
+  deleteDoneStates: false, // Optional: If true, will delete any states that are completed. If false, will delete any expired states, no matter whether they are done or not
+  machineName: 'example', // Optional: Only delete istances for machines named 'example'
+})
+```

package/dist/agent/MachineStatePersistence.d.ts

@@ -0,0 +1,26 @@
+import { IAbstractMachineStateStore } from '@sphereon/ssi-sdk.data-store';
+import { IAgentPlugin } from '@veramo/core';
+import { IMachineStatePersistence, MachineStatePersistEvent, MachineStatePersistOpts, RequiredContext } from '../index';
+/**
+ * This class implements the IMachineStatePersistence interface using a datastore.
+ *
+ * This allows you to store and retrieve the State of a state machine/application by their types.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
+export declare class MachineStatePersistence implements IAgentPlugin {
+    readonly schema: any;
+    readonly methods: IMachineStatePersistence | {};
+    readonly eventTypes: Array<string>;
+    private readonly _store?;
+    get store(): IAbstractMachineStateStore;
+    constructor(opts: MachineStatePersistOpts);
+    onEvent(event: MachineStatePersistEvent, context: RequiredContext): Promise<void>;
+    private machineStateInit;
+    private machineStatePersist;
+    private machineStatesFindActive;
+    private machineStatesDeleteExpired;
+    private machineStateGet;
+    private machineStateDelete;
+}
+//# sourceMappingURL=MachineStatePersistence.d.ts.map

package/dist/agent/MachineStatePersistence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MachineStatePersistence.d.ts","sourceRoot":"","sources":["../../src/agent/MachineStatePersistence.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAyB,MAAM,8BAA8B,CAAA;AAChG,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAM3C,OAAO,EAIL,wBAAwB,EAOxB,wBAAwB,EAExB,uBAAuB,EACvB,eAAe,EAEhB,MAAM,UAAU,CAAA;AAIjB;;;;;;GAMG;AACH,qBAAa,uBAAwB,YAAW,YAAY;IAC1D,QAAQ,CAAC,MAAM,MAAkC;IACjD,QAAQ,CAAC,OAAO,EAAE,wBAAwB,GAAG,EAAE,CAAA;IAC/C,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IAClC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAA4B;IAEpD,IAAI,KAAK,IAAI,0BAA0B,CAKtC;gBAEW,IAAI,EAAE,uBAAuB;IAqB5B,OAAO,CAAC,KAAK,EAAE,wBAAwB,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;YAwBhF,gBAAgB;YA8BhB,mBAAmB;YAcnB,uBAAuB;YAWvB,0BAA0B;YAQ1B,eAAe;YASf,kBAAkB;CAOjC"}

package/dist/agent/MachineStatePersistence.js

@@ -0,0 +1,194 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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.MachineStatePersistence = void 0;
+const console = __importStar(require("console"));
+const debug_1 = __importDefault(require("debug"));
+const uuid_1 = require("uuid");
+const functions_1 = require("../functions");
+const index_1 = require("../index");
+const debug = (0, debug_1.default)('sphereon:ssi-sdk:machine-state:xstate-persistence');
+/**
+ * This class implements the IMachineStatePersistence interface using a datastore.
+ *
+ * This allows you to store and retrieve the State of a state machine/application by their types.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
+class MachineStatePersistence {
+    get store() {
+        if (!this._store) {
+            throw Error('No store available in options');
+        }
+        return this._store;
+    }
+    constructor(opts) {
+        this.schema = index_1.schema.IMachineStatePersistence;
+        const { store, eventTypes, isRESTClient } = opts;
+        this.eventTypes = eventTypes;
+        this.methods = {
+            machineStatesFindActive: this.machineStatesFindActive.bind(this),
+            machineStatesDeleteExpired: this.machineStatesDeleteExpired.bind(this),
+            machineStateInit: this.machineStateInit.bind(this),
+            machineStatePersist: this.machineStatePersist.bind(this),
+            machineStateGet: this.machineStateGet.bind(this),
+            machineStateDelete: this.machineStateDelete.bind(this),
+        };
+        this._store = store;
+        if (isRESTClient) {
+            // Methods are delegated to the REMOTE Agent. We need the above eventTypes however, to ensure the local eventBus works
+            // We do set the store, because we might have some local and some remote methods
+            return;
+        }
+        else if (!store) {
+            throw Error('No store available in options');
+        }
+    }
+    onEvent(event, context) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            debug(`Received machine state persistence event '${event.type}' counter: ${event.data._eventCounter}`);
+            if (!this.eventTypes.includes(event.type)) {
+                console.log(`event type ${event.type} not registered for agent. Registered: ${JSON.stringify(this.eventTypes)}`);
+                return;
+            }
+            // Below we are calling the context of the agent instead of this to make sure the REST client is called when configured
+            switch (event.type) {
+                case index_1.MachineStatePersistEventType.INIT:
+                    yield context.agent.machineStateInit(Object.assign({}, event.data));
+                    break;
+                case index_1.MachineStatePersistEventType.EVERY:
+                    if (event.data.state.done) {
+                        // TODO: Cleanup on done
+                    }
+                    // We are keeping track of the update counter in the events, ensuring we do not process out of order
+                    yield context.agent.machineStatePersist(Object.assign(Object.assign({}, event.data), { updatedCount: (_a = event.data._eventCounter) !== null && _a !== void 0 ? _a : event.data.updatedCount }));
+                    break;
+                default:
+                    return Promise.reject(Error('Event type not supported'));
+            }
+        });
+    }
+    machineStateInit(args) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { tenantId, machineName, expiresAt, customInstanceId, existingInstanceId } = args;
+            debug(`machineStateInit for machine name ${machineName}, tenant ${tenantId}, custom instance ${customInstanceId}, existing id ${existingInstanceId}`);
+            let machineInit = undefined;
+            if (customInstanceId && existingInstanceId) {
+                return Promise.reject(new Error(`Cannot have both a custom and existing instance id at the same time`));
+            }
+            else if (existingInstanceId) {
+                // An instanceId is provided. First lookup whether this id is persisted, if not an error is thrown
+                debug(`machineStateInit is using a previously persisted instance id (${existingInstanceId})`);
+                const state = yield this.store.getMachineState({ tenantId, instanceId: existingInstanceId });
+                machineInit = (0, functions_1.storeInfoToMachineInit)(Object.assign(Object.assign({}, state), { stateType: 'existing' }));
+            }
+            else if (customInstanceId) {
+                // An custom instanceId is provided.
+                debug(`machineStateInit is using a custom instance id (${existingInstanceId})`);
+            }
+            if (!machineInit) {
+                machineInit = {
+                    machineName,
+                    tenantId,
+                    expiresAt,
+                    instanceId: customInstanceId !== null && customInstanceId !== void 0 ? customInstanceId : (0, uuid_1.v4)(),
+                    createdAt: (_a = args.createdAt) !== null && _a !== void 0 ? _a : new Date(),
+                    stateType: 'new',
+                };
+            }
+            debug(`machineStateInit result: ${JSON.stringify(machineInit)}`);
+            return machineInit;
+        });
+    }
+    machineStatePersist(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { instanceId, tenantId, machineName, updatedCount } = args;
+            debug(`machineStatePersist for machine name ${machineName}, updateCount: ${updatedCount}, instance ${instanceId} and tenant ${tenantId}...`);
+            const queriedStates = yield this.store.findMachineStates({ filter: [{ instanceId, tenantId }] });
+            const existingState = queriedStates.length === 1 ? queriedStates[0] : undefined;
+            const storeInfoArgs = (0, functions_1.machineStateToStoreInfo)(args, existingState);
+            const storedState = yield this.store.persistMachineState(storeInfoArgs);
+            const machineStateInfo = Object.assign(Object.assign({}, storedState), { state: (0, functions_1.deserializeMachineState)(storedState.state) });
+            debug(`machineStatePersist success for machine name ${machineName}, instance ${instanceId}, update count ${machineStateInfo.updatedCount}, tenant ${tenantId}, last event: ${machineStateInfo.latestEventType}, last state: ${machineStateInfo.latestStateName}`);
+            return machineStateInfo;
+        });
+    }
+    machineStatesFindActive(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { machineName, tenantId } = args;
+            debug(`machineStateFindActive for machine name ${machineName} and tenant ${tenantId}...`);
+            const storedStates = yield this.store.findActiveMachineStates(args);
+            const machineStateInfos = storedStates.map((storedState) => {
+                return Object.assign(Object.assign({}, storedState), { state: (0, functions_1.deserializeMachineState)(storedState.state) });
+            });
+            debug(`machineStateFindActive returned ${machineStateInfos.length} results for machine name ${machineName} and tenant ${tenantId}`);
+            return machineStateInfos;
+        });
+    }
+    machineStatesDeleteExpired(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { machineName, tenantId } = args;
+            debug(`machineStatesDeleteExpired for machine name ${machineName} and tenant ${tenantId}...`);
+            const deleteResult = yield this.store.deleteExpiredMachineStates(args);
+            debug(`machineStatesDeleteExpired result for machine name ${machineName} and tenant ${tenantId}: ${deleteResult}`);
+            return deleteResult;
+        });
+    }
+    machineStateGet(args, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { instanceId, tenantId } = args;
+            debug(`machineStateGet for machine instance ${instanceId} and tenant ${tenantId}...`);
+            const storedState = yield this.store.getMachineState(args);
+            const machineInfo = Object.assign(Object.assign({}, storedState), { state: (0, functions_1.deserializeMachineState)(storedState.state) });
+            debug(`machineStateGet result for machine instance ${instanceId} and tenant ${tenantId}: ${machineInfo}`);
+            return machineInfo;
+        });
+    }
+    machineStateDelete(args, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { instanceId, tenantId } = args;
+            debug(`machineStateDelete for machine instance ${instanceId} and tenant ${tenantId}...`);
+            const deleteResult = yield this.store.deleteMachineState(args);
+            debug(`machineStateDelete result for machine instance ${instanceId} and tenant ${tenantId}: ${deleteResult}`);
+            return deleteResult;
+        });
+    }
+}
+exports.MachineStatePersistence = MachineStatePersistence;
+//# sourceMappingURL=MachineStatePersistence.js.map

package/dist/agent/MachineStatePersistence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MachineStatePersistence.js","sourceRoot":"","sources":["../../src/agent/MachineStatePersistence.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,iDAAkC;AAClC,kDAAyB;AACzB,+BAAmC;AACnC,4CAAuG;AAEvG,oCAgBiB;AAEjB,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,mDAAmD,CAAC,CAAA;AAExE;;;;;;GAMG;AACH,MAAa,uBAAuB;IAMlC,IAAI,KAAK;QACP,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,MAAM,KAAK,CAAC,+BAA+B,CAAC,CAAA;SAC7C;QACD,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;IAED,YAAY,IAA6B;QAZhC,WAAM,GAAG,cAAM,CAAC,wBAAwB,CAAA;QAa/C,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;QAChD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG;YACb,uBAAuB,EAAE,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC;YAChE,0BAA0B,EAAE,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC;YACtE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;YAClD,mBAAmB,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC;YACxD,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC;YAChD,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;SACvD,CAAA;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,YAAY,EAAE;YAChB,sHAAsH;YACtH,gFAAgF;YAChF,OAAM;SACP;aAAM,IAAI,CAAC,KAAK,EAAE;YACjB,MAAM,KAAK,CAAC,+BAA+B,CAAC,CAAA;SAC7C;IACH,CAAC;IAEY,OAAO,CAAC,KAA+B,EAAE,OAAwB;;;YAC5E,KAAK,CAAC,6CAA6C,KAAK,CAAC,IAAI,cAAc,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAA;YACtG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBACzC,OAAO,CAAC,GAAG,CAAC,cAAc,KAAK,CAAC,IAAI,0CAA0C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;gBAChH,OAAM;aACP;YAED,uHAAuH;YACvH,QAAQ,KAAK,CAAC,IAAI,EAAE;gBAClB,KAAK,oCAA4B,CAAC,IAAI;oBACpC,MAAM,OAAO,CAAC,KAAK,CAAC,gBAAgB,mBAAM,KAAK,CAAC,IAAI,EAAG,CAAA;oBACvD,MAAK;gBACP,KAAK,oCAA4B,CAAC,KAAK;oBACrC,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;wBACzB,wBAAwB;qBACzB;oBACD,oGAAoG;oBACpG,MAAM,OAAO,CAAC,KAAK,CAAC,mBAAmB,iCAAM,KAAK,CAAC,IAAI,KAAE,YAAY,EAAE,MAAA,KAAK,CAAC,IAAI,CAAC,aAAa,mCAAI,KAAK,CAAC,IAAI,CAAC,YAAY,IAAG,CAAA;oBAC7H,MAAK;gBACP;oBACE,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAA;aAC3D;;KACF;IAEa,gBAAgB,CAAC,IAA0B;;;YACvD,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAA;YACvF,KAAK,CACH,qCAAqC,WAAW,YAAY,QAAQ,qBAAqB,gBAAgB,iBAAiB,kBAAkB,EAAE,CAC/I,CAAA;YACD,IAAI,WAAW,GAAiC,SAAS,CAAA;YACzD,IAAI,gBAAgB,IAAI,kBAAkB,EAAE;gBAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC,CAAA;aACxG;iBAAM,IAAI,kBAAkB,EAAE;gBAC7B,kGAAkG;gBAClG,KAAK,CAAC,iEAAiE,kBAAkB,GAAG,CAAC,CAAA;gBAC7F,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,kBAAkB,EAAE,CAAC,CAAA;gBAC5F,WAAW,GAAG,IAAA,kCAAsB,kCAAM,KAAK,KAAE,SAAS,EAAE,UAAU,IAAG,CAAA;aAC1E;iBAAM,IAAI,gBAAgB,EAAE;gBAC3B,oCAAoC;gBACpC,KAAK,CAAC,mDAAmD,kBAAkB,GAAG,CAAC,CAAA;aAChF;YACD,IAAI,CAAC,WAAW,EAAE;gBAChB,WAAW,GAAG;oBACZ,WAAW;oBACX,QAAQ;oBACR,SAAS;oBACT,UAAU,EAAE,gBAAgB,aAAhB,gBAAgB,cAAhB,gBAAgB,GAAI,IAAA,SAAM,GAAE;oBACxC,SAAS,EAAE,MAAA,IAAI,CAAC,SAAS,mCAAI,IAAI,IAAI,EAAE;oBACvC,SAAS,EAAE,KAAK;iBACjB,CAAA;aACF;YACD,KAAK,CAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;YAChE,OAAO,WAAW,CAAA;;KACnB;IACa,mBAAmB,CAAC,IAA6B;;YAC7D,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,IAAI,CAAA;YAChE,KAAK,CAAC,wCAAwC,WAAW,kBAAkB,YAAY,cAAc,UAAU,eAAe,QAAQ,KAAK,CAAC,CAAA;YAC5I,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAA;YAChG,MAAM,aAAa,GAAG,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;YAC/E,MAAM,aAAa,GAAG,IAAA,mCAAuB,EAAC,IAAI,EAAE,aAAa,CAAC,CAAA;YAClE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAA;YACvE,MAAM,gBAAgB,mCAAQ,WAAW,KAAE,KAAK,EAAE,IAAA,mCAAuB,EAAC,WAAW,CAAC,KAAK,CAAC,GAAE,CAAA;YAC9F,KAAK,CACH,gDAAgD,WAAW,cAAc,UAAU,kBAAkB,gBAAgB,CAAC,YAAY,YAAY,QAAQ,iBAAiB,gBAAgB,CAAC,eAAe,iBAAiB,gBAAgB,CAAC,eAAe,EAAE,CAC3P,CAAA;YACD,OAAO,gBAAgB,CAAA;QACzB,CAAC;KAAA;IAEa,uBAAuB,CAAC,IAA0B;;YAC9D,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;YACtC,KAAK,CAAC,2CAA2C,WAAW,eAAe,QAAQ,KAAK,CAAC,CAAA;YACzF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAA;YACnE,MAAM,iBAAiB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,WAAkC,EAAE,EAAE;gBAChF,uCAAY,WAAW,KAAE,KAAK,EAAE,IAAA,mCAAuB,EAAC,WAAW,CAAC,KAAK,CAAC,IAAE;YAC9E,CAAC,CAAC,CAAA;YACF,KAAK,CAAC,mCAAmC,iBAAiB,CAAC,MAAM,6BAA6B,WAAW,eAAe,QAAQ,EAAE,CAAC,CAAA;YACnI,OAAO,iBAAiB,CAAA;QAC1B,CAAC;KAAA;IAEa,0BAA0B,CAAC,IAA6B;;YACpE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;YACtC,KAAK,CAAC,+CAA+C,WAAW,eAAe,QAAQ,KAAK,CAAC,CAAA;YAC7F,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,0BAA0B,CAAC,IAAI,CAAC,CAAA;YACtE,KAAK,CAAC,sDAAsD,WAAW,eAAe,QAAQ,KAAK,YAAY,EAAE,CAAC,CAAA;YAClH,OAAO,YAAY,CAAA;QACrB,CAAC;KAAA;IAEa,eAAe,CAAC,IAAyB,EAAE,OAAwB;;YAC/E,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;YACrC,KAAK,CAAC,wCAAwC,UAAU,eAAe,QAAQ,KAAK,CAAC,CAAA;YACrF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;YAC1D,MAAM,WAAW,mCAAQ,WAAW,KAAE,KAAK,EAAE,IAAA,mCAAuB,EAAC,WAAW,CAAC,KAAK,CAAC,GAAE,CAAA;YACzF,KAAK,CAAC,+CAA+C,UAAU,eAAe,QAAQ,KAAK,WAAW,EAAE,CAAC,CAAA;YACzG,OAAO,WAAW,CAAA;QACpB,CAAC;KAAA;IAEa,kBAAkB,CAAC,IAA4B,EAAE,OAAwB;;YACrF,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;YACrC,KAAK,CAAC,2CAA2C,UAAU,eAAe,QAAQ,KAAK,CAAC,CAAA;YACxF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;YAC9D,KAAK,CAAC,kDAAkD,UAAU,eAAe,QAAQ,KAAK,YAAY,EAAE,CAAC,CAAA;YAC7G,OAAO,YAAY,CAAA;QACrB,CAAC;KAAA;CACF;AAzID,0DAyIC"}

package/dist/functions/index.d.ts

@@ -0,0 +1,4 @@
+export * from './machineRegistration';
+export * from './stateMapper';
+export * from './stateEventEmitter';
+//# sourceMappingURL=index.d.ts.map

package/dist/functions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/functions/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,eAAe,CAAA;AAC7B,cAAc,qBAAqB,CAAA"}

package/dist/functions/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./machineRegistration"), exports);
+__exportStar(require("./stateMapper"), exports);
+__exportStar(require("./stateEventEmitter"), exports);
+//# sourceMappingURL=index.js.map

package/dist/functions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/functions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAqC;AACrC,gDAA6B;AAC7B,sDAAmC"}