@lifi/sdk 2.3.1 → 3.0.0-alpha.10

package/dist/esm/execution/RouteExecutionManager.js

@@ -0,0 +1,268 @@
+import { ConfigService } from '../services/ConfigService.js';
+import { ValidationError } from '../utils/errors.js';
+import { StatusManager } from './StatusManager.js';
+import { prepareRestart } from './prepareRestart.js';
+export class RouteExecutionManager {
+    constructor(options) {
+        Object.defineProperty(this, "executionDictionary", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: {}
+        });
+        Object.defineProperty(this, "executionPromiseDictionary", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: {}
+        });
+        Object.defineProperty(this, "configService", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "providers", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Execute a route.
+         * @param route - The route that should be executed. Cannot be an active route.
+         * @param settings - An object containing settings and callbacks.
+         * @returns The executed route.
+         * @throws {LiFiError} Throws a LiFiError if the execution fails.
+         */
+        Object.defineProperty(this, "executeRoute", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: async (route, settings) => {
+                // Deep clone to prevent side effects
+                const clonedRoute = structuredClone(route);
+                let executionPromise = this.executionPromiseDictionary[clonedRoute.id];
+                // Check if route is already running
+                if (executionPromise) {
+                    return executionPromise;
+                }
+                executionPromise = this.executeSteps(clonedRoute, settings);
+                this.executionPromiseDictionary[clonedRoute.id] = executionPromise;
+                return executionPromise;
+            }
+        });
+        /**
+         * Resume the execution of a route that has been stopped or had an error while executing.
+         * @param route - The route that is to be executed. Cannot be an active route.
+         * @param settings - An object containing settings and callbacks.
+         * @returns The executed route.
+         * @throws {LiFiError} Throws a LiFiError if the execution fails.
+         */
+        Object.defineProperty(this, "resumeRoute", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: async (route, settings) => {
+                // Deep clone to prevent side effects
+                const clonedRoute = structuredClone(route);
+                const execution = this.executionDictionary[clonedRoute.id];
+                if (execution) {
+                    const executionHalted = execution.executors.some((executor) => !executor.allowExecution);
+                    if (!executionHalted) {
+                        // Check if we want to resume route execution in the background
+                        this.updateRouteExecution(route, {
+                            executeInBackground: settings?.executeInBackground,
+                        });
+                        const executionPromise = this.executionPromiseDictionary[clonedRoute.id];
+                        return executionPromise ?? clonedRoute;
+                    }
+                }
+                await prepareRestart(clonedRoute);
+                const executionPromise = this.executeSteps(clonedRoute, settings);
+                this.executionPromiseDictionary[clonedRoute.id] = executionPromise;
+                return executionPromise;
+            }
+        });
+        Object.defineProperty(this, "executeSteps", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: async (route, settings) => {
+                const config = this.configService.getConfig();
+                const execution = {
+                    route,
+                    executors: [],
+                    settings: { ...config.defaultExecutionSettings, ...settings },
+                };
+                this.executionDictionary[route.id] = execution;
+                const statusManager = new StatusManager(route, execution.settings, (route) => {
+                    if (this.executionDictionary[route.id]) {
+                        execution.route = route;
+                    }
+                });
+                // Loop over steps and execute them
+                for (let index = 0; index < route.steps.length; index++) {
+                    const execution = this.executionDictionary[route.id];
+                    // Check if execution has stopped in the meantime
+                    if (!execution) {
+                        break;
+                    }
+                    const step = route.steps[index];
+                    const previousStep = route.steps[index - 1];
+                    // Check if the step is already done
+                    //
+                    if (step.execution?.status === 'DONE') {
+                        continue;
+                    }
+                    // Update amount using output of previous execution. In the future this should be handled by calling `updateRoute`
+                    if (previousStep?.execution?.toAmount) {
+                        step.action.fromAmount = previousStep.execution.toAmount;
+                    }
+                    try {
+                        const provider = this.providers?.find((provider) => provider.isProviderStep(step));
+                        if (!provider) {
+                            throw new Error('SDK Execution Provider not found.');
+                        }
+                        const stepExecutor = await provider.getStepExecutor({
+                            statusManager,
+                            settings: execution.settings,
+                        });
+                        execution.executors.push(stepExecutor);
+                        // Check if we want to execute this step in the background
+                        this.updateRouteExecution(route, execution.settings);
+                        const executedStep = await stepExecutor.executeStep(step);
+                        // We may reach this point if user interaction isn't allowed. We want to stop execution until we resume it
+                        if (executedStep.execution?.status !== 'DONE') {
+                            this.stopExecution(route);
+                        }
+                        // Execution stopped during the current step, we don't want to continue to the next step so we return already
+                        if (stepExecutor.allowExecution) {
+                            return route;
+                        }
+                    }
+                    catch (e) {
+                        this.stopExecution(route);
+                        throw e;
+                    }
+                }
+                // Clean up after the execution
+                delete this.executionDictionary[route.id];
+                return route;
+            }
+        });
+        /**
+         * Updates route execution to background or foreground state.
+         * @param route - A route that is currently in execution.
+         * @param settings - An object with execution settings.
+         */
+        Object.defineProperty(this, "updateRouteExecution", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (route, settings) => {
+                const execution = this.executionDictionary[route.id];
+                if (!execution) {
+                    return;
+                }
+                for (const executor of execution.executors) {
+                    executor.setInteraction({
+                        allowInteraction: !settings.executeInBackground,
+                        allowUpdates: true,
+                    });
+                }
+                // Update active route settings so we know what the current state of execution is
+                execution.settings = {
+                    ...execution.settings,
+                    ...settings,
+                };
+            }
+        });
+        /**
+         * Update the ExecutionSettings for an active route.
+         * @param settings - An object with execution settings.
+         * @param route - The active route that gets the new execution settings.
+         * @throws {ValidationError} Throws a ValidationError if parameters are invalid.
+         */
+        Object.defineProperty(this, "updateExecutionSettings", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (settings, route) => {
+                const execution = this.executionDictionary[route.id];
+                if (!execution) {
+                    throw new ValidationError("Can't set ExecutionSettings for the inactive route.");
+                }
+                const config = this.configService.getConfig();
+                execution.settings = {
+                    ...config.defaultExecutionSettings,
+                    ...settings,
+                };
+            }
+        });
+        /**
+         * Stops the execution of an active route.
+         * @param route - A route that is currently in execution.
+         * @returns The stopped route.
+         */
+        Object.defineProperty(this, "stopExecution", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (route) => {
+                const execution = this.executionDictionary[route.id];
+                if (!execution) {
+                    return route;
+                }
+                for (const executor of execution.executors) {
+                    executor.setInteraction({
+                        allowInteraction: false,
+                        allowUpdates: false,
+                        allowExecution: false,
+                    });
+                }
+                delete this.executionDictionary[route.id];
+                return route;
+            }
+        });
+        /**
+         * Get the list of active routes.
+         * @returns A list of routes.
+         */
+        Object.defineProperty(this, "getActiveRoutes", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => {
+                return Object.values(this.executionDictionary)
+                    .map((dict) => dict?.route)
+                    .filter(Boolean);
+            }
+        });
+        /**
+         * Return the current route information for given route. The route has to be active.
+         * @param route - A route object.
+         * @returns The updated route.
+         */
+        Object.defineProperty(this, "getActiveRoute", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (route) => {
+                return this.executionDictionary[route.id]?.route;
+            }
+        });
+        Object.defineProperty(this, "getProvider", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (type) => {
+                return this.providers?.find((provider) => provider.type === type);
+            }
+        });
+        this.configService = ConfigService.getInstance();
+        this.configService.updateConfig(options);
+        this.providers = options.providers;
+    }
+}
+//# sourceMappingURL=RouteExecutionManager.js.map

package/dist/esm/execution/RouteExecutionManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RouteExecutionManager.js","sourceRoot":"","sources":["../../../src/execution/RouteExecutionManager.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAA;AAE5D,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAQpD,MAAM,OAAO,qBAAqB;IAMhC,YAAY,OAAmB;QALvB;;;;mBAAgD,EAAE;WAAA;QAClD;;;;mBAA8D,EAAE;WAAA;QAC9D;;;;;WAA4B;QAC9B;;;;;WAAyB;QAQjC;;;;;;WAMG;QACH;;;;mBAAe,KAAK,EAClB,KAAY,EACZ,QAA4B,EACZ,EAAE;gBAClB,qCAAqC;gBACrC,MAAM,WAAW,GAAG,eAAe,CAAQ,KAAK,CAAC,CAAA;gBAEjD,IAAI,gBAAgB,GAAG,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;gBACtE,oCAAoC;gBACpC,IAAI,gBAAgB,EAAE;oBACpB,OAAO,gBAAgB,CAAA;iBACxB;gBAED,gBAAgB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;gBAE3D,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAA;gBAElE,OAAO,gBAAgB,CAAA;YACzB,CAAC;WAAA;QAED;;;;;;WAMG;QACH;;;;mBAAc,KAAK,EACjB,KAAY,EACZ,QAA4B,EACZ,EAAE;gBAClB,qCAAqC;gBACrC,MAAM,WAAW,GAAG,eAAe,CAAQ,KAAK,CAAC,CAAA;gBAEjD,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;gBAE1D,IAAI,SAAS,EAAE;oBACb,MAAM,eAAe,GAAG,SAAS,CAAC,SAAS,CAAC,IAAI,CAC9C,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,cAAc,CACvC,CAAA;oBACD,IAAI,CAAC,eAAe,EAAE;wBACpB,+DAA+D;wBAC/D,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE;4BAC/B,mBAAmB,EAAE,QAAQ,EAAE,mBAAmB;yBACnD,CAAC,CAAA;wBACF,MAAM,gBAAgB,GAAG,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;wBACxE,OAAO,gBAAgB,IAAI,WAAW,CAAA;qBACvC;iBACF;gBAED,MAAM,cAAc,CAAC,WAAW,CAAC,CAAA;gBAEjC,MAAM,gBAAgB,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;gBAEjE,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAA;gBAElE,OAAO,gBAAgB,CAAA;YACzB,CAAC;WAAA;QAEO;;;;mBAAe,KAAK,EAC1B,KAAY,EACZ,QAA4B,EACZ,EAAE;gBAClB,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAA;gBAE7C,MAAM,SAAS,GAAuB;oBACpC,KAAK;oBACL,SAAS,EAAE,EAAE;oBACb,QAAQ,EAAE,EAAE,GAAG,MAAM,CAAC,wBAAwB,EAAE,GAAG,QAAQ,EAAE;iBAC9D,CAAA;gBAED,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;gBAE9C,MAAM,aAAa,GAAG,IAAI,aAAa,CACrC,KAAK,EACL,SAAS,CAAC,QAAQ,EAClB,CAAC,KAAY,EAAE,EAAE;oBACf,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE;wBACtC,SAAS,CAAC,KAAK,GAAG,KAAK,CAAA;qBACxB;gBACH,CAAC,CACF,CAAA;gBAED,mCAAmC;gBACnC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;oBACvD,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;oBACpD,iDAAiD;oBACjD,IAAI,CAAC,SAAS,EAAE;wBACd,MAAK;qBACN;oBAED,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;oBAC/B,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;oBAC3C,oCAAoC;oBACpC,EAAE;oBACF,IAAI,IAAI,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,EAAE;wBACrC,SAAQ;qBACT;oBAED,kHAAkH;oBAClH,IAAI,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE;wBACrC,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAA;qBACzD;oBAED,IAAI;wBACF,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACjD,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAC9B,CAAA;wBAED,IAAI,CAAC,QAAQ,EAAE;4BACb,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;yBACrD;wBAED,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,eAAe,CAAC;4BAClD,aAAa;4BACb,QAAQ,EAAE,SAAS,CAAC,QAAQ;yBAC7B,CAAC,CAAA;wBACF,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;wBAEtC,0DAA0D;wBAC1D,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAA;wBAEpD,MAAM,YAAY,GAAG,MAAM,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;wBAEzD,0GAA0G;wBAC1G,IAAI,YAAY,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,EAAE;4BAC7C,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;yBAC1B;wBAED,6GAA6G;wBAC7G,IAAI,YAAY,CAAC,cAAc,EAAE;4BAC/B,OAAO,KAAK,CAAA;yBACb;qBACF;oBAAC,OAAO,CAAC,EAAE;wBACV,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;wBACzB,MAAM,CAAC,CAAA;qBACR;iBACF;gBAED,+BAA+B;gBAC/B,OAAO,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBACzC,OAAO,KAAK,CAAA;YACd,CAAC;WAAA;QAED;;;;WAIG;QACH;;;;mBAAuB,CACrB,KAAY,EACZ,QAAwD,EAClD,EAAE;gBACR,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBACpD,IAAI,CAAC,SAAS,EAAE;oBACd,OAAM;iBACP;gBAED,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,SAAS,EAAE;oBAC1C,QAAQ,CAAC,cAAc,CAAC;wBACtB,gBAAgB,EAAE,CAAC,QAAQ,CAAC,mBAAmB;wBAC/C,YAAY,EAAE,IAAI;qBACnB,CAAC,CAAA;iBACH;gBACD,iFAAiF;gBACjF,SAAS,CAAC,QAAQ,GAAG;oBACnB,GAAG,SAAS,CAAC,QAAQ;oBACrB,GAAG,QAAQ;iBACZ,CAAA;YACH,CAAC;WAAA;QAED;;;;;WAKG;QACH;;;;mBAA0B,CACxB,QAA2B,EAC3B,KAAY,EACN,EAAE;gBACR,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBACpD,IAAI,CAAC,SAAS,EAAE;oBACd,MAAM,IAAI,eAAe,CACvB,qDAAqD,CACtD,CAAA;iBACF;gBAED,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAA;gBAE7C,SAAS,CAAC,QAAQ,GAAG;oBACnB,GAAG,MAAM,CAAC,wBAAwB;oBAClC,GAAG,QAAQ;iBACZ,CAAA;YACH,CAAC;WAAA;QAED;;;;WAIG;QACH;;;;mBAAgB,CAAC,KAAY,EAAS,EAAE;gBACtC,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBACpD,IAAI,CAAC,SAAS,EAAE;oBACd,OAAO,KAAK,CAAA;iBACb;gBAED,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,SAAS,EAAE;oBAC1C,QAAQ,CAAC,cAAc,CAAC;wBACtB,gBAAgB,EAAE,KAAK;wBACvB,YAAY,EAAE,KAAK;wBACnB,cAAc,EAAE,KAAK;qBACtB,CAAC,CAAA;iBACH;gBACD,OAAO,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBACzC,OAAO,KAAK,CAAA;YACd,CAAC;WAAA;QAED;;;WAGG;QACH;;;;mBAAkB,GAAY,EAAE;gBAC9B,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC;qBAC3C,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;qBAC1B,MAAM,CAAC,OAAO,CAAY,CAAA;YAC/B,CAAC;WAAA;QAED;;;;WAIG;QACH;;;;mBAAiB,CAAC,KAAY,EAAqB,EAAE;gBACnD,OAAO,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAA;YAClD,CAAC;WAAA;QAED;;;;mBAAc,CAAC,IAAkB,EAA2B,EAAE;gBAC5D,OAAO,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;YACnE,CAAC;WAAA;QA3PC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC,WAAW,EAAE,CAAA;QAChD,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QACxC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;IACpC,CAAC;CAyPF"}

package/dist/esm/execution/StatusManager.js

@@ -0,0 +1,216 @@
+import { emptyExecution } from '@lifi/types';
+import { getProcessMessage } from './utils.js';
+/**
+ * Manages status updates of a route and provides various functions for tracking processes
+ * @param {Route} route The route this StatusManger belongs to.
+ * @param {InternalExecutionSettings} settings The ExecutionSettings for this route.
+ * @param {InternalUpdateRouteCallback} internalUpdateRouteCallback Internal callback to propage route changes.
+ * @returns {StatusManager} An instance of StatusManager.
+ */
+export class StatusManager {
+    constructor(route, settings, internalUpdateRouteCallback) {
+        Object.defineProperty(this, "route", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "settings", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "internalUpdateRouteCallback", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "shouldUpdate", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        /**
+         * Initializes the execution object of a Step.
+         * @param step  The current step in execution
+         * @returns The initialized execution object for this step and a function to update this step
+         */
+        Object.defineProperty(this, "initExecutionObject", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (step) => {
+                const currentExecution = step.execution || structuredClone(emptyExecution);
+                if (!step.execution) {
+                    step.execution = currentExecution;
+                    step.execution.status = 'PENDING';
+                    this.updateStepInRoute(step);
+                }
+                // Change status to PENDING after resuming from FAILED
+                if (currentExecution.status === 'FAILED') {
+                    currentExecution.status = 'PENDING';
+                    this.updateStepInRoute(step);
+                }
+                return currentExecution;
+            }
+        });
+        /**
+         * Create and push a new process into the execution.
+         * @param step The step that should contain the new process.
+         * @param type Type of the process. Used to identify already existing processes.
+         * @param status By default created procces is set to the STARTED status. We can override new process with the needed status.
+         * @returns Returns process.
+         */
+        Object.defineProperty(this, "findOrCreateProcess", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (step, type, status) => {
+                if (!step.execution?.process) {
+                    throw new Error("Execution hasn't been initialized.");
+                }
+                const process = step.execution.process.find((p) => p.type === type);
+                if (process) {
+                    if (status && process.status !== status) {
+                        process.status = status;
+                        this.updateStepInRoute(step);
+                    }
+                    return process;
+                }
+                const newProcess = {
+                    type: type,
+                    startedAt: Date.now(),
+                    message: getProcessMessage(type, status ?? 'STARTED'),
+                    status: status ?? 'STARTED',
+                };
+                step.execution.process.push(newProcess);
+                this.updateStepInRoute(step);
+                return newProcess;
+            }
+        });
+        /**
+         * Update a process object.
+         * @param step The step where the process should be updated
+         * @param type  The process type to update
+         * @param status The status the process gets.
+         * @param [params]   Additional parameters to append to the process.
+         * @returns The update process
+         */
+        Object.defineProperty(this, "updateProcess", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (step, type, status, params) => {
+                if (!step.execution) {
+                    throw new Error("Can't update an empty step execution.");
+                }
+                const currentProcess = step?.execution?.process.find((p) => p.type === type);
+                if (!currentProcess) {
+                    throw new Error("Can't find a process for the given type.");
+                }
+                switch (status) {
+                    case 'CANCELLED':
+                        currentProcess.doneAt = Date.now();
+                        break;
+                    case 'FAILED':
+                        currentProcess.doneAt = Date.now();
+                        step.execution.status = 'FAILED';
+                        break;
+                    case 'DONE':
+                        currentProcess.doneAt = Date.now();
+                        break;
+                    case 'PENDING':
+                        step.execution.status = 'PENDING';
+                        break;
+                    case 'ACTION_REQUIRED':
+                        step.execution.status = 'ACTION_REQUIRED';
+                        break;
+                    default:
+                        break;
+                }
+                currentProcess.status = status;
+                currentProcess.message = getProcessMessage(type, status);
+                // set extra parameters or overwritte the standard params set in the switch statement
+                if (params) {
+                    for (const [key, value] of Object.entries(params)) {
+                        currentProcess[key] = value;
+                    }
+                }
+                // Sort processes, the ones with DONE status go first
+                step.execution.process = [
+                    ...step?.execution?.process.filter((process) => process.status === 'DONE'),
+                    ...step?.execution?.process.filter((process) => process.status !== 'DONE'),
+                ];
+                this.updateStepInRoute(step); // updates the step in the route
+                return currentProcess;
+            }
+        });
+        /**
+         * Remove a process from the execution
+         * @param step The step where the process should be removed from
+         * @param type  The process type to remove
+         */
+        Object.defineProperty(this, "removeProcess", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (step, type) => {
+                if (!step.execution) {
+                    throw new Error("Execution hasn't been initialized.");
+                }
+                const index = step.execution.process.findIndex((p) => p.type === type);
+                step.execution.process.splice(index, 1);
+                this.updateStepInRoute(step);
+            }
+        });
+        Object.defineProperty(this, "updateStepInRoute", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (step) => {
+                if (!this.shouldUpdate) {
+                    return step;
+                }
+                const stepIndex = this.route.steps.findIndex((routeStep) => routeStep.id === step.id);
+                if (stepIndex === -1) {
+                    throw new Error("Couldn't find a step to update.");
+                }
+                this.route.steps[stepIndex] = Object.assign(this.route.steps[stepIndex], step);
+                this.settings.updateRouteHook(this.route);
+                this.internalUpdateRouteCallback(this.route);
+                return this.route.steps[stepIndex];
+            }
+        });
+        this.route = route;
+        this.settings = settings;
+        this.internalUpdateRouteCallback = internalUpdateRouteCallback;
+    }
+    /**
+     * Updates the execution object of a Step.
+     * @param step  The current step in execution
+     * @param status  The status for the execution
+     * @param receipt Optional. Information about received tokens
+     * @returns       The step with the updated execution object
+     */
+    updateExecution(step, status, receipt) {
+        if (!step.execution) {
+            throw Error("Can't update empty execution.");
+        }
+        step.execution.status = status;
+        if (receipt) {
+            step.execution = {
+                ...step.execution,
+                ...receipt,
+            };
+        }
+        this.updateStepInRoute(step);
+        return step;
+    }
+    allowUpdates(value) {
+        this.shouldUpdate = value;
+    }
+}
+//# sourceMappingURL=StatusManager.js.map

package/dist/esm/execution/StatusManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatusManager.js","sourceRoot":"","sources":["../../../src/execution/StatusManager.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAE5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AA6B9C;;;;;;GAMG;AACH,MAAM,OAAO,aAAa;IAMxB,YACE,KAAY,EACZ,QAAmC,EACnC,2BAAwD;QARzC;;;;;WAAY;QACZ;;;;;WAAmC;QACnC;;;;;WAAwD;QACjE;;;;mBAAe,IAAI;WAAA;QAY3B;;;;WAIG;QACH;;;;mBAAsB,CAAC,IAAc,EAAa,EAAE;gBAClD,MAAM,gBAAgB,GACpB,IAAI,CAAC,SAAS,IAAI,eAAe,CAAY,cAAc,CAAC,CAAA;gBAE9D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;oBACnB,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAA;oBACjC,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,SAAS,CAAA;oBACjC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;iBAC7B;gBAED,sDAAsD;gBACtD,IAAI,gBAAgB,CAAC,MAAM,KAAK,QAAQ,EAAE;oBACxC,gBAAgB,CAAC,MAAM,GAAG,SAAS,CAAA;oBACnC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;iBAC7B;gBAED,OAAO,gBAAgB,CAAA;YACzB,CAAC;WAAA;QAwBD;;;;;;WAMG;QACH;;;;mBAAsB,CACpB,IAAc,EACd,IAAiB,EACjB,MAAe,EACN,EAAE;gBACX,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE;oBAC5B,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;iBACtD;gBAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;gBAEnE,IAAI,OAAO,EAAE;oBACX,IAAI,MAAM,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE;wBACvC,OAAO,CAAC,MAAM,GAAG,MAAM,CAAA;wBACvB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;qBAC7B;oBACD,OAAO,OAAO,CAAA;iBACf;gBAED,MAAM,UAAU,GAAY;oBAC1B,IAAI,EAAE,IAAI;oBACV,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;oBACrB,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,MAAM,IAAI,SAAS,CAAC;oBACrD,MAAM,EAAE,MAAM,IAAI,SAAS;iBAC5B,CAAA;gBAED,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;gBACvC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;gBAC5B,OAAO,UAAU,CAAA;YACnB,CAAC;WAAA;QAED;;;;;;;WAOG;QACH;;;;mBAAgB,CACd,IAAc,EACd,IAAiB,EACjB,MAAc,EACd,MAA2B,EAClB,EAAE;gBACX,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;oBACnB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;iBACzD;gBACD,MAAM,cAAc,GAAG,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;gBAE5E,IAAI,CAAC,cAAc,EAAE;oBACnB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;iBAC5D;gBAED,QAAQ,MAAM,EAAE;oBACd,KAAK,WAAW;wBACd,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;wBAClC,MAAK;oBACP,KAAK,QAAQ;wBACX,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;wBAClC,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,QAAQ,CAAA;wBAChC,MAAK;oBACP,KAAK,MAAM;wBACT,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;wBAClC,MAAK;oBACP,KAAK,SAAS;wBACZ,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,SAAS,CAAA;wBACjC,MAAK;oBACP,KAAK,iBAAiB;wBACpB,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,iBAAiB,CAAA;wBACzC,MAAK;oBACP;wBACE,MAAK;iBACR;gBAED,cAAc,CAAC,MAAM,GAAG,MAAM,CAAA;gBAC9B,cAAc,CAAC,OAAO,GAAG,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBACxD,qFAAqF;gBACrF,IAAI,MAAM,EAAE;oBACV,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;wBACjD,cAAc,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;qBAC5B;iBACF;gBACD,qDAAqD;gBACrD,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG;oBACvB,GAAG,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,MAAM,CAChC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM,CACvC;oBACD,GAAG,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,MAAM,CAChC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM,CACvC;iBACF,CAAA;gBACD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA,CAAC,gCAAgC;gBAC7D,OAAO,cAAc,CAAA;YACvB,CAAC;WAAA;QAED;;;;WAIG;QACH;;;;mBAAgB,CAAC,IAAc,EAAE,IAAiB,EAAQ,EAAE;gBAC1D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;oBACnB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;iBACtD;gBACD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;gBACtE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;gBACvC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;YAC9B,CAAC;WAAA;QAED;;;;mBAAoB,CAAC,IAAc,EAAY,EAAE;gBAC/C,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;oBACtB,OAAO,IAAI,CAAA;iBACZ;gBAED,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAC1C,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CACxC,CAAA;gBAED,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE;oBACpB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;iBACnD;gBAED,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,MAAM,CACzC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAC3B,IAAI,CACL,CAAA;gBAED,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBACzC,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBAC5C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;YACpC,CAAC;WAAA;QA7LC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,2BAA2B,GAAG,2BAA2B,CAAA;IAChE,CAAC;IA0BD;;;;;;OAMG;IACH,eAAe,CAAC,IAAc,EAAE,MAAc,EAAE,OAAiB;QAC/D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,MAAM,KAAK,CAAC,+BAA+B,CAAC,CAAA;SAC7C;QACD,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,MAAM,CAAA;QAC9B,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,SAAS,GAAG;gBACf,GAAG,IAAI,CAAC,SAAS;gBACjB,GAAG,OAAO;aACX,CAAA;SACF;QACD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC5B,OAAO,IAAI,CAAA;IACb,CAAC;IA8ID,YAAY,CAAC,KAAc;QACzB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;IAC3B,CAAC;CACF"}