@sphereon/ssi-sdk.xstate-machine-persistence 0.32.1-next.54 → 0.33.1-feature.jose.vcdm.55

package/plugin.schema.json

@@ -3,6 +3,9 @@
     "components": {
       "schemas": {
         "MachineStateDeleteArgs": {
+          "$ref": "#/components/schemas/Pick<StoreMachineStateInfo,(\"instanceId\"|\"tenantId\")>"
+        },
+        "Pick<StoreMachineStateInfo,(\"instanceId\"|\"tenantId\")>": {
           "type": "object",
           "properties": {
             "instanceId": {
@@ -15,25 +18,15 @@
           },
           "required": [
             "instanceId"
-          ]
+          ],
+          "additionalProperties": false
         },
         "MachineStateGetArgs": {
-          "type": "object",
-          "properties": {
-            "instanceId": {
-              "type": "string",
-              "description": "Unique instance ID of the machine"
-            },
-            "tenantId": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "instanceId"
-          ]
+          "$ref": "#/components/schemas/Pick<StoreMachineStateInfo,(\"instanceId\"|\"tenantId\")>"
         },
         "MachineStateInfo": {
           "type": "object",
+          "additionalProperties": false,
           "properties": {
             "state": {
               "$ref": "#/components/schemas/SerializableState"
@@ -136,21 +129,13 @@
               "items": {}
             },
             "children": {
-              "type": "object"
+              "$ref": "#/components/schemas/Record<string,any>"
             },
             "done": {
               "type": "boolean"
             },
             "tags": {
-              "type": "object",
-              "properties": {
-                "size": {
-                  "type": "number"
-                }
-              },
-              "required": [
-                "size"
-              ]
+              "$ref": "#/components/schemas/Set<string>"
             },
             "machine": {}
           },
@@ -163,6 +148,7 @@
             "transitions",
             "children"
           ],
+          "additionalProperties": false,
           "description": "The configuration for the XState machine state. Simplified StateConfig object from XState so we have a minimal typed structure"
         },
         "StateValue": {
@@ -228,7 +214,8 @@
             "type",
             "data",
             "$$type"
-          ]
+          ],
+          "additionalProperties": false
         },
         "AnyEventObject": {
           "type": "object",
@@ -246,17 +233,7 @@
           "type": "object",
           "properties": {
             "states": {
-              "type": "object",
-              "additionalProperties": {
-                "anyOf": [
-                  {
-                    "$ref": "#/components/schemas/HistoryValue"
-                  },
-                  {
-                    "not": {}
-                  }
-                ]
-              }
+              "$ref": "#/components/schemas/Record<string,(interface-434048446-6094-6223-434048446-0-57488|undefined)>"
             },
             "current": {
               "$ref": "#/components/schemas/StateValue"
@@ -264,10 +241,40 @@
           },
           "required": [
             "states"
-          ]
+          ],
+          "additionalProperties": false
+        },
+        "Record<string,(interface-434048446-6094-6223-434048446-0-57488|undefined)>": {
+          "type": "object",
+          "additionalProperties": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/HistoryValue"
+              },
+              {
+                "not": {}
+              }
+            ]
+          }
+        },
+        "Record<string,any>": {
+          "type": "object"
+        },
+        "Set<string>": {
+          "type": "object",
+          "properties": {
+            "size": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "size"
+          ],
+          "additionalProperties": false
         },
         "InitMachineStateArgs": {
           "type": "object",
+          "additionalProperties": false,
           "properties": {
             "cleanupAllOtherInstances": {
               "type": "boolean"
@@ -279,16 +286,14 @@
               "type": "string"
             },
             "machineName": {
-              "type": "object",
-              "properties": {},
+              "type": "string",
               "description": "Machine name"
             },
             "tenantId": {
               "type": "string"
             },
             "createdAt": {
-              "type": "object",
-              "properties": {},
+              "type": "string",
               "description": "Represents the creation date"
             },
             "expiresAt": {
@@ -296,84 +301,26 @@
               "description": "Represents the expiration date"
             },
             "stateType": {
-              "anyOf": [
-                {
-                  "type": "object",
-                  "properties": {}
-                },
-                {
-                  "type": "object",
-                  "properties": {}
-                }
-              ]
+              "$ref": "#/components/schemas/MachineStateInitType"
             },
             "machineState": {
-              "type": "object",
-              "properties": {
-                "state": {
-                  "$ref": "#/components/schemas/SerializableState"
-                },
-                "instanceId": {
-                  "type": "string",
-                  "description": "Unique instance ID of the machine"
-                },
-                "sessionId": {
-                  "type": "string",
-                  "description": "Session Id of the machine. Not necessarily unique"
-                },
-                "machineName": {
-                  "type": "string",
-                  "description": "Machine name"
-                },
-                "latestStateName": {
-                  "type": "string",
-                  "description": "The latest state name. Can be empty for a newly initialize machine"
-                },
-                "latestEventType": {
-                  "type": "string",
-                  "description": "event types like SET_TOC, SET_FIRSTNAME, .... Will be xstate.init on a newly initialized machine"
-                },
-                "createdAt": {
-                  "type": "string",
-                  "description": "Represents the creation date"
-                },
-                "expiresAt": {
-                  "type": "string",
-                  "description": "Represents the expiration date"
-                },
-                "updatedAt": {
-                  "type": "string",
-                  "description": "Represents the update date"
-                },
-                "updatedCount": {
-                  "type": "number",
-                  "description": "Represents a counter for tracking updates."
-                },
-                "completedAt": {
-                  "type": "string",
-                  "format": "date-time"
-                },
-                "tenantId": {
-                  "type": "string"
-                }
-              },
-              "required": [
-                "createdAt",
-                "instanceId",
-                "latestEventType",
-                "machineName",
-                "state",
-                "updatedAt",
-                "updatedCount"
-              ]
+              "$ref": "#/components/schemas/MachineStateInfo"
             }
           },
           "required": [
             "machineName"
           ]
         },
+        "MachineStateInitType": {
+          "type": "string",
+          "enum": [
+            "new",
+            "existing"
+          ]
+        },
         "MachineStateInit": {
           "type": "object",
+          "additionalProperties": false,
           "properties": {
             "stateType": {
               "$ref": "#/components/schemas/MachineStateInitType"
@@ -382,21 +329,18 @@
               "$ref": "#/components/schemas/MachineStateInfo"
             },
             "instanceId": {
-              "type": "object",
-              "properties": {},
+              "type": "string",
               "description": "Unique instance ID of the machine"
             },
             "machineName": {
-              "type": "object",
-              "properties": {},
+              "type": "string",
               "description": "Machine name"
             },
             "tenantId": {
               "type": "string"
             },
             "createdAt": {
-              "type": "object",
-              "properties": {},
+              "type": "string",
               "description": "Represents the creation date"
             },
             "expiresAt": {
@@ -411,101 +355,26 @@
             "stateType"
           ]
         },
-        "MachineStateInitType": {
-          "type": "string",
-          "enum": [
-            "new",
-            "existing"
-          ]
-        },
         "MachineStatePersistArgs": {
           "type": "object",
+          "additionalProperties": false,
           "properties": {
             "cleanupOnFinalState": {
               "type": "boolean"
             },
             "updatedCount": {
-              "type": "object",
-              "properties": {},
+              "type": "number",
               "description": "Represents a counter for tracking updates."
             },
             "state": {
-              "type": "object",
-              "properties": {
-                "value": {
-                  "$ref": "#/components/schemas/StateValue"
-                },
-                "context": {},
-                "_event": {
-                  "$ref": "#/components/schemas/SCXML.Event<AnyEventObject>"
-                },
-                "_sessionid": {
-                  "type": [
-                    "string",
-                    "null"
-                  ]
-                },
-                "historyValue": {
-                  "$ref": "#/components/schemas/HistoryValue"
-                },
-                "history": {},
-                "actions": {
-                  "type": "array",
-                  "items": {}
-                },
-                "activities": {},
-                "meta": {},
-                "events": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/AnyEventObject"
-                  }
-                },
-                "configuration": {
-                  "type": "array",
-                  "items": {}
-                },
-                "transitions": {
-                  "type": "array",
-                  "items": {}
-                },
-                "children": {
-                  "type": "object"
-                },
-                "done": {
-                  "type": "boolean"
-                },
-                "tags": {
-                  "type": "object",
-                  "properties": {
-                    "size": {
-                      "type": "number"
-                    }
-                  },
-                  "required": [
-                    "size"
-                  ]
-                },
-                "machine": {}
-              },
-              "required": [
-                "_event",
-                "_sessionid",
-                "children",
-                "configuration",
-                "context",
-                "transitions",
-                "value"
-              ]
+              "$ref": "#/components/schemas/SerializableState"
             },
             "instanceId": {
-              "type": "object",
-              "properties": {},
+              "type": "string",
               "description": "Unique instance ID of the machine"
             },
             "machineName": {
-              "type": "object",
-              "properties": {},
+              "type": "string",
               "description": "Machine name"
             },
             "tenantId": {
@@ -516,76 +385,10 @@
               "description": "Represents the expiration date"
             },
             "stateType": {
-              "anyOf": [
-                {
-                  "type": "object",
-                  "properties": {}
-                },
-                {
-                  "type": "object",
-                  "properties": {}
-                }
-              ]
+              "$ref": "#/components/schemas/MachineStateInitType"
             },
             "machineState": {
-              "type": "object",
-              "properties": {
-                "state": {
-                  "$ref": "#/components/schemas/SerializableState"
-                },
-                "instanceId": {
-                  "type": "string",
-                  "description": "Unique instance ID of the machine"
-                },
-                "sessionId": {
-                  "type": "string",
-                  "description": "Session Id of the machine. Not necessarily unique"
-                },
-                "machineName": {
-                  "type": "string",
-                  "description": "Machine name"
-                },
-                "latestStateName": {
-                  "type": "string",
-                  "description": "The latest state name. Can be empty for a newly initialize machine"
-                },
-                "latestEventType": {
-                  "type": "string",
-                  "description": "event types like SET_TOC, SET_FIRSTNAME, .... Will be xstate.init on a newly initialized machine"
-                },
-                "createdAt": {
-                  "type": "string",
-                  "description": "Represents the creation date"
-                },
-                "expiresAt": {
-                  "type": "string",
-                  "description": "Represents the expiration date"
-                },
-                "updatedAt": {
-                  "type": "string",
-                  "description": "Represents the update date"
-                },
-                "updatedCount": {
-                  "type": "number",
-                  "description": "Represents a counter for tracking updates."
-                },
-                "completedAt": {
-                  "type": "string",
-                  "format": "date-time"
-                },
-                "tenantId": {
-                  "type": "string"
-                }
-              },
-              "required": [
-                "createdAt",
-                "instanceId",
-                "latestEventType",
-                "machineName",
-                "state",
-                "updatedAt",
-                "updatedCount"
-              ]
+              "$ref": "#/components/schemas/MachineStateInfo"
             }
           },
           "required": [
@@ -597,6 +400,10 @@
           "description": "Represents the arguments required to persist the machine state."
         },
         "DeleteExpiredStatesArgs": {
+          "$ref": "#/components/schemas/Pick<StoreMachineStateDeleteExpiredArgs,(\"deleteDoneStates\"|\"machineName\"|\"tenantId\")>",
+          "description": "Represents the arguments for deleting expired states from a machine."
+        },
+        "Pick<StoreMachineStateDeleteExpiredArgs,(\"deleteDoneStates\"|\"machineName\"|\"tenantId\")>": {
           "type": "object",
           "properties": {
             "deleteDoneStates": {
@@ -609,7 +416,7 @@
               "type": "string"
             }
           },
-          "description": "Represents the arguments for deleting expired states from a machine."
+          "additionalProperties": false
         },
         "DeleteStateResult": {
           "type": "number"
@@ -619,6 +426,9 @@
           "description": "Represents the arguments for finding active states of a store machine."
         },
         "StoreMachineStatesFindActiveArgs": {
+          "$ref": "#/components/schemas/Partial<Pick<StoreMachineStateInfo,(\"machineName\"|\"tenantId\"|\"instanceId\")>>"
+        },
+        "Partial<Pick<StoreMachineStateInfo,(\"machineName\"|\"tenantId\"|\"instanceId\")>>": {
           "type": "object",
           "properties": {
             "machineName": {
@@ -632,7 +442,8 @@
               "type": "string",
               "description": "Unique instance ID of the machine"
             }
-          }
+          },
+          "additionalProperties": false
         }
       },
       "methods": {

package/src/__tests__/localAgent.test.ts

@@ -2,6 +2,7 @@ import { DataSource } from 'typeorm'
 import { createObjects, getConfig } from '@sphereon/ssi-sdk.agent-config'
 
 import machineStatePersistenceAgentLogic from './shared/MachineStatePersistenceAgentLogic'
+import { describe } from 'vitest'
 
 let dbConnection: Promise<DataSource>
 let agent: any

package/src/__tests__/restAgent.test.ts

@@ -9,6 +9,7 @@ import { DataSource } from 'typeorm'
 import { createObjects, getConfig } from '@sphereon/ssi-sdk.agent-config'
 import { IMachineStatePersistence, MachineStatePersistence, MachineStatePersistEventType } from '../index'
 import xStatePersistenceAgentLogic from './shared/MachineStatePersistenceAgentLogic'
+import { describe } from 'vitest'
 
 const port = 6403
 const basePath = '/agent'
@@ -58,7 +59,9 @@ const setup = async (): Promise<boolean> => {
 
 const tearDown = async (): Promise<boolean> => {
   restServer?.close()
-  await (await dbConnection).destroy()
+  if (dbConnection) {
+    await (await dbConnection)?.destroy()
+  }
   return true
 }
 

package/src/__tests__/shared/MachineStatePersistenceAgentLogic.ts

@@ -12,6 +12,7 @@ import {
   TypegenDisabled,
 } from 'xstate'
 import { IMachineStatePersistence, interpreterStartOrResume, MachineStatePersistArgs, machineStatePersistRegistration } from '../../index'
+import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it } from 'vitest'
 
 type ConfiguredAgent = TAgent<IMachineStatePersistence>
 

package/dist/agent/MachineStatePersistence.d.ts

@@ -1,26 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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;AAK3C,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;YAyBhF,gBAAgB;YA2DhB,mBAAmB;YAiCnB,uBAAuB;YAWvB,0BAA0B;YAQ1B,eAAe;YASf,kBAAkB;CAOjC"}