@sphereon/ssi-sdk.xstate-machine-persistence 0.33.1-feature.vcdm2.4 → 0.33.1-feature.vcdm2.tsup.18

package/dist/types/IMachineStatePersistence.d.ts

@@ -1,62 +0,0 @@
-import { IPluginMethodMap } from '@veramo/core';
-import { DeleteExpiredStatesArgs, DeleteStateResult, FindActiveStatesArgs, MachineStateInfo, MachineStateInit, InitMachineStateArgs, RequiredContext, MachineStatePersistArgs, MachineStateGetArgs, MachineStateDeleteArgs } from './types';
-/**
- * The interface definition for a plugin that can issue and verify Verifiable Credentials and Presentations
- * that use JSON-LD format.
- *
- * @remarks Please see {@link https://www.w3.org/TR/vc-data-model | W3C Verifiable Credentials data model}
- *
- * @beta This API is likely to change without a BREAKING CHANGE notice
- */
-export interface IMachineStatePersistence extends IPluginMethodMap {
-    /**
-     * Loads the states of active xstate machines from the database.
-     *
-     * @param args FindActiveStatesArgs
-     * type of the event
-     *
-     * @returns state or null
-     *
-     * @beta This API is likely to change without a BREAKING CHANGE notice
-     */
-    machineStatesFindActive(args: FindActiveStatesArgs): Promise<Array<MachineStateInfo>>;
-    /**
-     * Deletes the state of an xstate machine in the database.
-     *
-     * @param args DeleteExpiredStatesArgs
-     * type: optional type of the machine
-     *
-     * @beta This API is likely to change without a BREAKING CHANGE notice
-     */
-    machineStatesDeleteExpired(args: DeleteExpiredStatesArgs): Promise<DeleteStateResult>;
-    /**
-     * Initializes a state object for a new machine. Does not persist anything
-     * @param args Requires a machineName, instanceId and tenantId are optional
-     */
-    machineStateInit(args: InitMachineStateArgs): Promise<MachineStateInit>;
-    /**
-     * Persists the state
-     * @param args MachineStatePersistArgs
-     *
-     * @param context
-     * @beta This API is likely to change without a BREAKING CHANGE notice
-     */
-    machineStatePersist(args: MachineStatePersistArgs, context: RequiredContext): Promise<MachineStateInfo>;
-    /**
-     * Get a particular machine state by instance id and tenant id
-     * @param args instance id and tenant id
-     *
-     * @param context
-     * @beta This API is likely to change without a BREAKING CHANGE notice
-     */
-    machineStateGet(args: MachineStateGetArgs, context: RequiredContext): Promise<MachineStateInfo>;
-    /**
-     * Delete a particular machine state by instance id and tenant id
-     * @param args instance id and tenant id
-     *
-     * @param context
-     * @beta This API is likely to change without a BREAKING CHANGE notice
-     */
-    machineStateDelete(args: MachineStateDeleteArgs, context: RequiredContext): Promise<boolean>;
-}
-//# sourceMappingURL=IMachineStatePersistence.d.ts.map

package/dist/types/IMachineStatePersistence.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"IMachineStatePersistence.d.ts","sourceRoot":"","sources":["../../src/types/IMachineStatePersistence.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAA;AAE/C,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,EACf,uBAAuB,EACvB,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,SAAS,CAAA;AAEhB;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE;;;;;;;;;OASG;IACH,uBAAuB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;IAErF;;;;;;;OAOG;IACH,0BAA0B,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAErF;;;OAGG;IACH,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAEvE;;;;;;OAMG;IACH,mBAAmB,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAEvG;;;;;;OAMG;IACH,eAAe,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE/F;;;;;;OAMG;IACH,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC7F"}

package/dist/types/IMachineStatePersistence.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=IMachineStatePersistence.js.map

package/dist/types/IMachineStatePersistence.js.map

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

package/dist/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './IMachineStatePersistence';
-export * from './types';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,SAAS,CAAA"}

package/dist/types/index.js

@@ -1,3 +0,0 @@
-export * from './IMachineStatePersistence';
-export * from './types';
-//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,SAAS,CAAA"}

package/dist/types/types.d.ts

@@ -1,173 +0,0 @@
-import { IAbstractMachineStateStore, StoreMachineStateDeleteExpiredArgs, StoreMachineStateInfo, StoreMachineStatesFindActiveArgs } from '@sphereon/ssi-sdk.data-store';
-import { IAgentContext } from '@veramo/core';
-import { AnyEventObject, DefaultContext, EventObject, HistoryValue, Interpreter, SCXML, StateSchema, StateValue, TypegenDisabled, Typestate } from 'xstate';
-import { IMachineStatePersistence } from './IMachineStatePersistence';
-/**
- * Represents the options for persisting machine state.
- *
- * @typedef {Object} MachineStatePersistOpts
- * @property {IAbstractMachineStateStore} store - The store used to persist the machine state.
- * @property {Array<string>} eventTypes - The types of events to be persisted.
- */
-export type MachineStatePersistOpts = {
-    store?: IAbstractMachineStateStore;
-    eventTypes: Array<string>;
-    isRESTClient?: boolean;
-};
-/**
- * Enum representing the types of machine state persist events.
- * @enum {string}
- */
-export declare enum MachineStatePersistEventType {
-    INIT = "INIT",
-    EVERY = "EVERY"
-}
-/**
- * Represents the arguments for deleting expired states from a machine.
- */
-export type DeleteExpiredStatesArgs = Pick<StoreMachineStateDeleteExpiredArgs, 'deleteDoneStates' | 'machineName' | 'tenantId'>;
-/**
- * Represents the arguments for finding active states of a store machine.
- */
-export type FindActiveStatesArgs = StoreMachineStatesFindActiveArgs;
-/**
- * Represents the result of a state deletion operation.
- *
- * @typedef {number} DeleteStateResult
- */
-export type DeleteStateResult = number;
-/**
- * Represents a machine state persist event.
- *
- * @typedef {Object} MachineStatePersistEvent
- * @property {MachineStatePersistEventType} type - The type of the persist event.
- * @property {MachineStatePersistArgs} data - The data associated with the persist event, along with additional properties `_eventCounter` and `_eventDate`.
- * @property {number} data._eventCounter - The counter for the persist event.
- * @property {Date} data._eventDate - The date and time the persist event occurred.
- */
-export type MachineStatePersistEvent = {
-    type: MachineStatePersistEventType;
-    data: Omit<MachineStatePersistArgs, 'machineState'> & {
-        _eventCounter: number;
-        _eventDate: Date;
-        _cleanupOnFinalState: boolean;
-    };
-};
-/**
- * Represents a RequiredContext class, which is a type definition for the context required by an agent.
- * It is used to enforce that the agent context implements the necessary interfaces.
- *
- * @typeparam T - The type of the machine state persistence.
- */
-export type RequiredContext = IAgentContext<IMachineStatePersistence>;
-/**
- * Represents the information about the current state of a machine.
- * @typedef {Object} MachineStateInfo
- * @property {string} id - The ID of the machine.
- * @property {SerializableState} state - The serializable state of the machine.
- * @property {string} description - The description of the machine state.
- */
-export type MachineStateInfo = Omit<StoreMachineStateInfo, 'state'> & {
-    state: SerializableState;
-};
-export type MachineStatePersistenceOpts = {
-    disablePersistence?: boolean;
-    customInstanceId?: string;
-    existingInstanceId?: string;
-    expireInMS?: number;
-    expiresAt?: Date;
-};
-export type MachineStateInitType = 'new' | 'existing';
-/**
- * Represents the initial state for a machine.
- *
- * @typedef {Object} MachineStateInit
- * @property {string} existingInstanceId - The unique identifier for the machine instance.
- * @property {string} machineName - The name of the machine.
- * @property {string} tenantId - The identifier for the tenant associated with the machine.
- * @property {Date} createdAt - The date and time when the machine was created.
- * @property {Date} expiresAt - The date and time when the machine's state expires.
- */
-export type MachineStateInit = Pick<MachineStateInfo, 'instanceId' | 'machineName' | 'tenantId' | 'createdAt' | 'expiresAt'> & {
-    stateType: MachineStateInitType;
-    machineState?: MachineStateInfo;
-};
-/**
- * Represents the arguments required to initialize the machine state.
- * @typedef {Object} InitMachineStateArgs
- * @property {string} machineName - The name of the machine.
- * @property {Partial<MachineStateInit>} [additionalArgs] - Additional initialization arguments for the machine state.
- */
-export type InitMachineStateArgs = Omit<Partial<MachineStateInit>, 'instanceId'> & Pick<MachineStateInfo, 'machineName'> & Pick<MachineStatePersistenceOpts, 'customInstanceId' | 'existingInstanceId'> & {
-    cleanupAllOtherInstances?: boolean;
-};
-/**
- * Represents the arguments required to persist the machine state.
- */
-export type MachineStatePersistArgs = Omit<MachineStateInit, 'createdAt'> & Pick<MachineStateInfo, 'state' | 'instanceId'> & Partial<Pick<MachineStateInfo, 'updatedCount'>> & {
-    cleanupOnFinalState?: boolean;
-};
-/**
- * Represents the arguments required to get machine state.
- * @typedef {Object} MachineStateGetArgs
- * @property {string} existingInstanceId - The ID of the machine instance.
- * @property {string} tenantId - The ID of the tenant the machine belongs to.
- */
-export type MachineStateGetArgs = Pick<StoreMachineStateInfo, 'instanceId' | 'tenantId'>;
-/**
- * Represents the arguments required for deleting a machine state.
- *
- * @typedef {object} MachineStateDeleteArgs
- * @property {string} existingInstanceId - The ID of the machine instance to delete the state for.
- * @property {string} tenantId - The ID of the tenant owning the machine instance.
- */
-export type MachineStateDeleteArgs = Pick<StoreMachineStateInfo, 'instanceId' | 'tenantId'>;
-/**
- * Represents the information for a started interpreter.
- *
- * @template TContext The type of the context object.
- * @template TStateSchema The type of the state schema.
- * @template TEvent The type of the event object.
- * @template TTypestate The type of the typestate object.
- * @template TResolvedTypesMeta The type of the resolved types meta object.
- */
-export type StartedInterpreterInfo<TContext = DefaultContext, TStateSchema extends StateSchema = any, TEvent extends EventObject = EventObject, TTypestate extends Typestate<TContext> = {
-    value: any;
-    context: TContext;
-}, TResolvedTypesMeta = TypegenDisabled> = {
-    interpreter: Interpreter<TContext, TStateSchema, TEvent, TTypestate, TResolvedTypesMeta>;
-    machineState?: MachineStateInfo;
-    init: MachineStateInit;
-};
-/**
- * Represents the serializable state of a machine.
- *
- * @typedef {Object} SerializableState
- * @property {XStateConfig<any, AnyEventObject>} config - The machine configuration.
- */
-export type SerializableState = XStateConfig<any, AnyEventObject>;
-/**
- * The configuration for the XState machine state. Simplified StateConfig object from XState so we have a minimal typed structure
- *
- * @template TContext - The context type for the state.
- * @template TEvent - The event type for the state.
- */
-export interface XStateConfig<TContext, TEvent extends EventObject> {
-    value: StateValue;
-    context: TContext;
-    _event: SCXML.Event<TEvent>;
-    _sessionid: string | null;
-    historyValue?: HistoryValue | undefined;
-    history?: any;
-    actions?: Array<any>;
-    activities?: any;
-    meta?: any;
-    events?: TEvent[];
-    configuration: Array<any>;
-    transitions: Array<any>;
-    children: Record<string, any>;
-    done?: boolean;
-    tags?: Set<string>;
-    machine?: any;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAC1B,kCAAkC,EAClC,qBAAqB,EACrB,gCAAgC,EACjC,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAC5C,OAAO,EACL,cAAc,EACd,cAAc,EACd,WAAW,EACX,YAAY,EACZ,WAAW,EACX,KAAK,EACL,WAAW,EACX,UAAU,EACV,eAAe,EACf,SAAS,EACV,MAAM,QAAQ,CAAA;AAEf,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAErE;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG;IAAE,KAAK,CAAC,EAAE,0BAA0B,CAAC;IAAC,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAAC,YAAY,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAE/H;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,kCAAkC,EAAE,kBAAkB,GAAG,aAAa,GAAG,UAAU,CAAC,CAAA;AAE/H;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,gCAAgC,CAAA;AAEnE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAA;AAEtC;;;;;;;;GAQG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,4BAA4B,CAAA;IAClC,IAAI,EAAE,IAAI,CAAC,uBAAuB,EAAE,cAAc,CAAC,GAAG;QACpD,aAAa,EAAE,MAAM,CAAA;QACrB,UAAU,EAAE,IAAI,CAAA;QAChB,oBAAoB,EAAE,OAAO,CAAA;KAC9B,CAAA;CACF,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,aAAa,CAAC,wBAAwB,CAAC,CAAA;AAErE;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,GAAG;IACpE,KAAK,EAAE,iBAAiB,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,IAAI,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,UAAU,CAAA;AAErD;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,EAAE,YAAY,GAAG,aAAa,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,CAAC,GAAG;IAC7H,SAAS,EAAE,oBAAoB,CAAA;IAC/B,YAAY,CAAC,EAAE,gBAAgB,CAAA;CAChC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,YAAY,CAAC,GAC9E,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC,GACrC,IAAI,CAAC,2BAA2B,EAAE,kBAAkB,GAAG,oBAAoB,CAAC,GAAG;IAAE,wBAAwB,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAEvH;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,gBAAgB,EAAE,WAAW,CAAC,GACvE,IAAI,CAAC,gBAAgB,EAAE,OAAO,GAAG,YAAY,CAAC,GAC9C,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC,GAAG;IAAE,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAErF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,qBAAqB,EAAE,YAAY,GAAG,UAAU,CAAC,CAAA;AAExF;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,qBAAqB,EAAE,YAAY,GAAG,UAAU,CAAC,CAAA;AAE3F;;;;;;;;GAQG;AACH,MAAM,MAAM,sBAAsB,CAChC,QAAQ,GAAG,cAAc,EACzB,YAAY,SAAS,WAAW,GAAG,GAAG,EACtC,MAAM,SAAS,WAAW,GAAG,WAAW,EACxC,UAAU,SAAS,SAAS,CAAC,QAAQ,CAAC,GAAG;IACvC,KAAK,EAAE,GAAG,CAAA;IACV,OAAO,EAAE,QAAQ,CAAA;CAClB,EACD,kBAAkB,GAAG,eAAe,IAClC;IACF,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAA;IACxF,YAAY,CAAC,EAAE,gBAAgB,CAAA;IAC/B,IAAI,EAAE,gBAAgB,CAAA;CACvB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,GAAG,EAAE,cAAc,CAAC,CAAA;AAEjE;;;;;GAKG;AACH,MAAM,WAAW,YAAY,CAAC,QAAQ,EAAE,MAAM,SAAS,WAAW;IAChE,KAAK,EAAE,UAAU,CAAA;IACjB,OAAO,EAAE,QAAQ,CAAA;IACjB,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAC3B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;IACvC,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,OAAO,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;IACpB,UAAU,CAAC,EAAE,GAAG,CAAA;IAChB,IAAI,CAAC,EAAE,GAAG,CAAA;IACV,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;IACzB,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAClB,OAAO,CAAC,EAAE,GAAG,CAAA;CACd"}

package/dist/types/types.js

@@ -1,10 +0,0 @@
-/**
- * Enum representing the types of machine state persist events.
- * @enum {string}
- */
-export var MachineStatePersistEventType;
-(function (MachineStatePersistEventType) {
-    MachineStatePersistEventType["INIT"] = "INIT";
-    MachineStatePersistEventType["EVERY"] = "EVERY";
-})(MachineStatePersistEventType || (MachineStatePersistEventType = {}));
-//# sourceMappingURL=types.js.map

package/dist/types/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AA+BA;;;GAGG;AACH,MAAM,CAAN,IAAY,4BAGX;AAHD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,+CAAe,CAAA;AACjB,CAAC,EAHW,4BAA4B,KAA5B,4BAA4B,QAGvC"}