@moostjs/event-wf 0.2.34

package/README.md

@@ -0,0 +1 @@
+# @moostjs/event-wf

package/dist/index.cjs

@@ -0,0 +1,156 @@
+'use strict';
+
+var moost = require('moost');
+var eventWf = require('@wooksjs/event-wf');
+var eventCore = require('@wooksjs/event-core');
+require('wooks');
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise */
+
+
+function __awaiter(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());
+    });
+}
+
+function getWfMate() {
+    return moost.getMoostMate();
+}
+
+const LOGGER_TITLE = 'moost-wf';
+const CONTEXT_TYPE = 'WF';
+class MoostWf {
+    constructor(opts) {
+        this.opts = opts;
+        const wfAppOpts = opts === null || opts === void 0 ? void 0 : opts.wooksWf;
+        if (wfAppOpts && wfAppOpts instanceof eventWf.WooksWf) {
+            this.wfApp = wfAppOpts;
+        }
+        else if (wfAppOpts) {
+            this.wfApp = eventWf.createWfApp(wfAppOpts);
+        }
+        else {
+            this.wfApp = eventWf.createWfApp();
+        }
+        if (!(opts === null || opts === void 0 ? void 0 : opts.debug)) {
+            moost.getMoostInfact().silent(true);
+        }
+    }
+    onNotFound() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield moost.defineMoostEventHandler({
+                loggerTitle: LOGGER_TITLE,
+                getIterceptorHandler: () => { var _a; return (_a = this.moost) === null || _a === void 0 ? void 0 : _a.getGlobalInterceptorHandler(); },
+                getControllerInstance: () => this.moost,
+                callControllerMethod: () => undefined,
+                logErrors: (_a = this.opts) === null || _a === void 0 ? void 0 : _a.debug,
+            })();
+            return response;
+        });
+    }
+    onInit(moost) {
+        this.moost = moost;
+    }
+    start(schemaId, inputContext, input) {
+        return this.wfApp.start(schemaId, inputContext, input, () => {
+            const scopeId = eventCore.useEventId().getId();
+            moost.getMoostInfact().unregisterScope(scopeId);
+        });
+    }
+    resume(schemaId, inputContext, indexes, input) {
+        return this.wfApp.resume(schemaId, inputContext, indexes, input, () => {
+            const scopeId = eventCore.useEventId().getId();
+            moost.getMoostInfact().unregisterScope(scopeId);
+        });
+    }
+    bindHandler(opts) {
+        var _a, _b;
+        let fn;
+        for (const handler of opts.handlers) {
+            if (!(['WF_STEP', 'WF_FLOW'].includes(handler.type)))
+                continue;
+            const schemaId = handler.path;
+            const path = typeof schemaId === 'string'
+                ? schemaId
+                : typeof opts.method === 'string'
+                    ? opts.method
+                    : '';
+            const targetPath = `${opts.prefix || ''}/${path}`.replace(/\/\/+/g, '/') + `${path.endsWith('//') ? '/' : ''}`; // explicit double slash "//" -> force url to end with slash
+            if (!fn) {
+                fn = moost.defineMoostEventHandler({
+                    contextType: CONTEXT_TYPE,
+                    loggerTitle: LOGGER_TITLE,
+                    getIterceptorHandler: opts.getIterceptorHandler,
+                    getControllerInstance: opts.getInstance,
+                    controllerMethod: opts.method,
+                    resolveArgs: opts.resolveArgs,
+                    manualUnscope: true,
+                });
+            }
+            let routerBinding;
+            if (handler.type === 'WF_STEP') {
+                routerBinding = this.wfApp.step(targetPath, {
+                    handler: fn,
+                });
+            }
+            else {
+                const mate = getWfMate();
+                let wfSchema = (_a = mate.read(opts.fakeInstance, opts.method)) === null || _a === void 0 ? void 0 : _a.wfSchema;
+                if (!wfSchema) {
+                    wfSchema = (_b = mate.read(opts.fakeInstance)) === null || _b === void 0 ? void 0 : _b.wfSchema;
+                }
+                routerBinding = this.wfApp.flow(targetPath, wfSchema || []);
+            }
+            opts.logHandler(`${''}(${handler.type})${''}${targetPath}`);
+            const args = routerBinding.getArgs();
+            const params = {};
+            args.forEach(a => params[a] = `{${a}}`);
+            opts.register(handler, routerBinding.getPath(params), args);
+        }
+    }
+}
+
+function WfStep(path) {
+    return getWfMate().decorate('handlers', { path, type: 'WF_STEP' }, true);
+}
+function WfFlow(path) {
+    return getWfMate().decorate('handlers', { path, type: 'WF_STEP' }, true);
+}
+function WfSchema(schema) {
+    return getWfMate().decorate('wfSchema', schema);
+}
+
+/**
+ * Wrapper on top of useEventContext that provides
+ * proper context types for CLI event
+ * @returns set of hooks { getCtx, restoreCtx, clearCtx, hookStore, getStore, setStore }
+ */
+function useCliContext() {
+    return eventCore.useEventContext('CLI');
+}
+
+exports.MoostWf = MoostWf;
+exports.WfFlow = WfFlow;
+exports.WfSchema = WfSchema;
+exports.WfStep = WfStep;
+exports.useCliContext = useCliContext;

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+import { Moost } from 'moost';
+import { TFlowOutput } from '@prostojs/wf';
+import { TMoostAdapter } from 'moost';
+import { TMoostAdapterOptions } from 'moost';
+import { TWooksWfOptions } from '@wooksjs/event-wf';
+import { TWorkflowSchema } from '@prostojs/wf';
+import { useCliContext } from '@wooksjs/event-cli';
+import { WooksWf } from '@wooksjs/event-wf';
+
+export declare class MoostWf<T> implements TMoostAdapter<TWfHandlerMeta> {
+    protected opts?: TMoostWfOpts<T> | undefined;
+    protected wfApp: WooksWf<T>;
+    constructor(opts?: TMoostWfOpts<T> | undefined);
+    onNotFound(): Promise<unknown>;
+    protected moost?: Moost;
+    onInit(moost: Moost): void;
+    start<I>(schemaId: string, inputContext: T, input?: I): Promise<TFlowOutput<T, I>>;
+    resume<I>(schemaId: string, inputContext: T, indexes: number[], input?: I): Promise<TFlowOutput<T, I>>;
+    bindHandler<T extends object = object>(opts: TMoostAdapterOptions<TWfHandlerMeta, T>): void;
+}
+
+export declare interface TMoostWfOpts<T> {
+    /**
+     * wooksWf options or instance
+     */
+    wooksWf?: WooksWf<T> | TWooksWfOptions;
+    /**
+     * more internal logs are printed when true
+     */
+    debug?: boolean;
+}
+
+export declare interface TWfHandlerMeta {
+    path: string;
+}
+
+export { useCliContext }
+
+export declare function WfFlow(path?: string): MethodDecorator;
+
+export declare function WfSchema<T>(schema: TWorkflowSchema<T>): MethodDecorator;
+
+export declare function WfStep(path?: string): MethodDecorator;
+
+export { }

package/dist/index.mjs

@@ -0,0 +1,150 @@
+import { getMoostMate, getMoostInfact, defineMoostEventHandler } from 'moost';
+import { WooksWf, createWfApp } from '@wooksjs/event-wf';
+import { useEventId, useEventContext } from '@wooksjs/event-core';
+import 'wooks';
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise */
+
+
+function __awaiter(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());
+    });
+}
+
+function getWfMate() {
+    return getMoostMate();
+}
+
+const LOGGER_TITLE = 'moost-wf';
+const CONTEXT_TYPE = 'WF';
+class MoostWf {
+    constructor(opts) {
+        this.opts = opts;
+        const wfAppOpts = opts === null || opts === void 0 ? void 0 : opts.wooksWf;
+        if (wfAppOpts && wfAppOpts instanceof WooksWf) {
+            this.wfApp = wfAppOpts;
+        }
+        else if (wfAppOpts) {
+            this.wfApp = createWfApp(wfAppOpts);
+        }
+        else {
+            this.wfApp = createWfApp();
+        }
+        if (!(opts === null || opts === void 0 ? void 0 : opts.debug)) {
+            getMoostInfact().silent(true);
+        }
+    }
+    onNotFound() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield defineMoostEventHandler({
+                loggerTitle: LOGGER_TITLE,
+                getIterceptorHandler: () => { var _a; return (_a = this.moost) === null || _a === void 0 ? void 0 : _a.getGlobalInterceptorHandler(); },
+                getControllerInstance: () => this.moost,
+                callControllerMethod: () => undefined,
+                logErrors: (_a = this.opts) === null || _a === void 0 ? void 0 : _a.debug,
+            })();
+            return response;
+        });
+    }
+    onInit(moost) {
+        this.moost = moost;
+    }
+    start(schemaId, inputContext, input) {
+        return this.wfApp.start(schemaId, inputContext, input, () => {
+            const scopeId = useEventId().getId();
+            getMoostInfact().unregisterScope(scopeId);
+        });
+    }
+    resume(schemaId, inputContext, indexes, input) {
+        return this.wfApp.resume(schemaId, inputContext, indexes, input, () => {
+            const scopeId = useEventId().getId();
+            getMoostInfact().unregisterScope(scopeId);
+        });
+    }
+    bindHandler(opts) {
+        var _a, _b;
+        let fn;
+        for (const handler of opts.handlers) {
+            if (!(['WF_STEP', 'WF_FLOW'].includes(handler.type)))
+                continue;
+            const schemaId = handler.path;
+            const path = typeof schemaId === 'string'
+                ? schemaId
+                : typeof opts.method === 'string'
+                    ? opts.method
+                    : '';
+            const targetPath = `${opts.prefix || ''}/${path}`.replace(/\/\/+/g, '/') + `${path.endsWith('//') ? '/' : ''}`; // explicit double slash "//" -> force url to end with slash
+            if (!fn) {
+                fn = defineMoostEventHandler({
+                    contextType: CONTEXT_TYPE,
+                    loggerTitle: LOGGER_TITLE,
+                    getIterceptorHandler: opts.getIterceptorHandler,
+                    getControllerInstance: opts.getInstance,
+                    controllerMethod: opts.method,
+                    resolveArgs: opts.resolveArgs,
+                    manualUnscope: true,
+                });
+            }
+            let routerBinding;
+            if (handler.type === 'WF_STEP') {
+                routerBinding = this.wfApp.step(targetPath, {
+                    handler: fn,
+                });
+            }
+            else {
+                const mate = getWfMate();
+                let wfSchema = (_a = mate.read(opts.fakeInstance, opts.method)) === null || _a === void 0 ? void 0 : _a.wfSchema;
+                if (!wfSchema) {
+                    wfSchema = (_b = mate.read(opts.fakeInstance)) === null || _b === void 0 ? void 0 : _b.wfSchema;
+                }
+                routerBinding = this.wfApp.flow(targetPath, wfSchema || []);
+            }
+            opts.logHandler(`${''}(${handler.type})${''}${targetPath}`);
+            const args = routerBinding.getArgs();
+            const params = {};
+            args.forEach(a => params[a] = `{${a}}`);
+            opts.register(handler, routerBinding.getPath(params), args);
+        }
+    }
+}
+
+function WfStep(path) {
+    return getWfMate().decorate('handlers', { path, type: 'WF_STEP' }, true);
+}
+function WfFlow(path) {
+    return getWfMate().decorate('handlers', { path, type: 'WF_STEP' }, true);
+}
+function WfSchema(schema) {
+    return getWfMate().decorate('wfSchema', schema);
+}
+
+/**
+ * Wrapper on top of useEventContext that provides
+ * proper context types for CLI event
+ * @returns set of hooks { getCtx, restoreCtx, clearCtx, hookStore, getStore, setStore }
+ */
+function useCliContext() {
+    return useEventContext('CLI');
+}
+
+export { MoostWf, WfFlow, WfSchema, WfStep, useCliContext };

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@moostjs/event-wf",
+  "version": "0.2.34",
+  "description": "@moostjs/event-wf",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moostjs/moostjs.git",
+    "directory": "packages/event-wf"
+  },
+  "keywords": [
+    "moost",
+    "moostjs",
+    "composables",
+    "framework",
+    "wooksjs",
+    "prostojs"
+  ],
+  "author": "Artem Maltsev",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/moostjs/moostjs/issues"
+  },
+  "peerDependencies": {},
+  "dependencies": {
+    "moost": "0.2.34",
+    "wooks": "^0.3.11",
+    "@wooksjs/event-core": "^0.3.11",
+    "@wooksjs/event-wf": "^0.3.11"
+  },
+  "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/event-wf#readme"
+}