@fsai-flow/workflow 0.0.2 → 0.1.0

package/dist/src/lib/Expression.js

@@ -0,0 +1,247 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Expression = void 0;
+const luxon_1 = require("luxon");
+// @ts-ignore
+const tmpl = __importStar(require("riot-tmpl"));
+// eslint-disable-next-line import/no-cycle
+const __1 = require("..");
+// @ts-ignore
+// Set it to use double curly brackets instead of single ones
+// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+tmpl.brackets.set("{{ }}");
+// Make sure that it does not always print an error when it could not resolve
+// a variable
+// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+tmpl.tmpl.errorHandler = () => { };
+class Expression {
+    workflow;
+    constructor(workflow) {
+        this.workflow = workflow;
+    }
+    /**
+     * Converts an object to a string in a way to make it clear that
+     * the value comes from an object
+     *
+     * @param {object} value
+     * @returns {string}
+     * @memberof Workflow
+     */
+    convertObjectValueToString(value) {
+        const typeName = Array.isArray(value) ? "Array" : "Object";
+        return `[${typeName}: ${JSON.stringify(value)}]`;
+    }
+    /**
+     * Resolves the paramter value.  If it is an expression it will execute it and
+     * return the result. For everything simply the supplied value will be returned.
+     *
+     * @param {NodeParameterValue} parameterValue
+     * @param {(IRunExecutionData | null)} runExecutionData
+     * @param {number} runIndex
+     * @param {number} itemIndex
+     * @param {string} activeNodeName
+     * @param {INodeExecutionData[]} connectionInputData
+     * @param {boolean} [returnObjectAsString=false]
+     * @returns {(NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[])}
+     * @memberof Workflow
+     */
+    resolveSimpleParameterValue(parameterValue, siblingParameters, runExecutionData, runIndex, itemIndex, activeNodeName, connectionInputData, mode, additionalKeys, returnObjectAsString = false, selfData = {}) {
+        // Check if it is an expression
+        if (typeof parameterValue !== "string" || parameterValue.charAt(0) !== "=") {
+            // Is no expression so return value
+            return parameterValue;
+        }
+        // Is an expression
+        // Remove the equal sign
+        // eslint-disable-next-line no-param-reassign
+        parameterValue = parameterValue.substr(1);
+        // Generate a data proxy which allows to query workflow data
+        const dataProxy = new __1.WorkflowDataProxy(this.workflow, runExecutionData, runIndex, itemIndex, activeNodeName, connectionInputData, siblingParameters, mode, additionalKeys, -1, selfData);
+        const data = dataProxy.getDataProxy();
+        // Support only a subset of process properties
+        // @ts-ignore
+        data.process = {
+            arch: process.arch,
+            env: process.env,
+            platform: process.platform,
+            pid: process.pid,
+            ppid: process.ppid,
+            release: process.release,
+            version: process.pid,
+            versions: process.versions,
+        };
+        // @ts-ignore
+        data.document = {};
+        // @ts-ignore
+        data.DateTime = luxon_1.DateTime;
+        data.Interval = luxon_1.Interval;
+        data.Duration = luxon_1.Duration;
+        // @ts-ignore
+        data.constructor = {};
+        // Execute the expression
+        try {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+            const returnValue = tmpl.tmpl(parameterValue, data);
+            if (typeof returnValue === "function") {
+                throw new Error('Expression resolved to a function. Please add "()"');
+            }
+            if (returnValue !== null && typeof returnValue === "object") {
+                if (returnObjectAsString) {
+                    return this.convertObjectValueToString(returnValue);
+                }
+            }
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            return returnValue;
+        }
+        catch (e) {
+            const message = e instanceof Error ? e.message : String(e);
+            throw new Error(`Expression is not valid: ${message}`);
+        }
+    }
+    /**
+     * Resolves value of parameter. But does not work for workflow-data.
+     *
+     * @param {INode} node
+     * @param {(string | undefined)} parameterValue
+     * @param {string} [defaultValue]
+     * @returns {(string | undefined)}
+     * @memberof Workflow
+     */
+    getSimpleParameterValue(node, parameterValue, mode, additionalKeys, defaultValue) {
+        if (parameterValue === undefined) {
+            // Value is not set so return the default
+            return defaultValue;
+        }
+        // Get the value of the node (can be an expression)
+        const runIndex = 0;
+        const itemIndex = 0;
+        const connectionInputData = [];
+        const runData = {
+            resultData: {
+                runData: {},
+            },
+        };
+        return this.getParameterValue(parameterValue, runData, runIndex, itemIndex, node.name, connectionInputData, mode, additionalKeys);
+    }
+    /**
+     * Resolves value of complex parameter. But does not work for workflow-data.
+     *
+     * @param {INode} node
+     * @param {(NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[])} parameterValue
+     * @param {(NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | undefined)} [defaultValue]
+     * @returns {(NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | undefined)}
+     * @memberof Workflow
+     */
+    getComplexParameterValue(node, parameterValue, mode, additionalKeys, defaultValue = undefined, selfData = {}) {
+        if (parameterValue === undefined) {
+            // Value is not set so return the default
+            return defaultValue;
+        }
+        // Get the value of the node (can be an expression)
+        const runIndex = 0;
+        const itemIndex = 0;
+        const connectionInputData = [];
+        const runData = {
+            resultData: {
+                runData: {},
+            },
+        };
+        // Resolve the "outer" main values
+        const returnData = this.getParameterValue(parameterValue, runData, runIndex, itemIndex, node.name, connectionInputData, mode, additionalKeys, false, selfData);
+        // Resolve the "inner" values
+        return this.getParameterValue(returnData, runData, runIndex, itemIndex, node.name, connectionInputData, mode, additionalKeys, false, selfData);
+    }
+    /**
+     * Returns the resolved node parameter value. If it is an expression it will execute it and
+     * return the result. If the value to resolve is an array or object it will do the same
+     * for all of the items and values.
+     *
+     * @param {(NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[])} parameterValue
+     * @param {(IRunExecutionData | null)} runExecutionData
+     * @param {number} runIndex
+     * @param {number} itemIndex
+     * @param {string} activeNodeName
+     * @param {INodeExecutionData[]} connectionInputData
+     * @param {boolean} [returnObjectAsString=false]
+     * @returns {(NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[])}
+     * @memberof Workflow
+     */
+    getParameterValue(parameterValue, runExecutionData, runIndex, itemIndex, activeNodeName, connectionInputData, mode, additionalKeys, returnObjectAsString = false, selfData = {}) {
+        // Helper function which returns true when the parameter is a complex one or array
+        const isComplexParameter = (value) => {
+            return typeof value === "object";
+        };
+        // Helper function which resolves a parameter value depending on if it is simply or not
+        const resolveParameterValue = (value, siblingParameters) => {
+            if (isComplexParameter(value)) {
+                return this.getParameterValue(value, runExecutionData, runIndex, itemIndex, activeNodeName, connectionInputData, mode, additionalKeys, returnObjectAsString, selfData);
+            }
+            return this.resolveSimpleParameterValue(value, siblingParameters, runExecutionData, runIndex, itemIndex, activeNodeName, connectionInputData, mode, additionalKeys, returnObjectAsString, selfData);
+        };
+        // Check if it value is a simple one that we can get it resolved directly
+        if (!isComplexParameter(parameterValue)) {
+            return this.resolveSimpleParameterValue(parameterValue, {}, runExecutionData, runIndex, itemIndex, activeNodeName, connectionInputData, mode, additionalKeys, returnObjectAsString, selfData);
+        }
+        // The parameter value is complex so resolve depending on type
+        if (Array.isArray(parameterValue)) {
+            // Data is an array
+            const returnData = [];
+            // eslint-disable-next-line no-restricted-syntax
+            for (const item of parameterValue) {
+                returnData.push(resolveParameterValue(item, {}));
+            }
+            if (returnObjectAsString && typeof returnData === "object") {
+                return this.convertObjectValueToString(returnData);
+            }
+            return returnData;
+        }
+        if (parameterValue === null || parameterValue === undefined) {
+            return parameterValue;
+        }
+        // Data is an object
+        const returnData = {};
+        // eslint-disable-next-line no-restricted-syntax
+        for (const key of Object.keys(parameterValue)) {
+            returnData[key] = resolveParameterValue(parameterValue[key], parameterValue);
+        }
+        if (returnObjectAsString && typeof returnData === "object") {
+            return this.convertObjectValueToString(returnData);
+        }
+        return returnData;
+    }
+}
+exports.Expression = Expression;
+//# sourceMappingURL=Expression.js.map

package/dist/src/lib/Expression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Expression.js","sourceRoot":"","sources":["../../../src/lib/Expression.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iCAAqD;AACrD,aAAa;AACb,gDAAkC;AAElC,2CAA2C;AAC3C,0BAUY;AAEZ,aAAa;AAEb,6DAA6D;AAC7D,yGAAyG;AACzG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAE3B,6EAA6E;AAC7E,aAAa;AACb,sEAAsE;AACtE,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;AAElC,MAAa,UAAU;IACtB,QAAQ,CAAW;IAEnB,YAAY,QAAkB;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC1B,CAAC;IAED;;;;;;;OAOG;IACH,0BAA0B,CAAC,KAAa;QACvC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC3D,OAAO,IAAI,QAAQ,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,2BAA2B,CAC1B,cAAkC,EAClC,iBAAkC,EAClC,gBAA0C,EAC1C,QAAgB,EAChB,SAAiB,EACjB,cAAsB,EACtB,mBAAyC,EACzC,IAAyB,EACzB,cAAgD,EAChD,oBAAoB,GAAG,KAAK,EAC5B,QAAQ,GAAG,EAAE;QAEb,+BAA+B;QAC/B,IAAI,OAAO,cAAc,KAAK,QAAQ,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YAC5E,mCAAmC;YACnC,OAAO,cAAc,CAAC;QACvB,CAAC;QAED,mBAAmB;QAEnB,wBAAwB;QACxB,6CAA6C;QAC7C,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAE1C,4DAA4D;QAC5D,MAAM,SAAS,GAAG,IAAI,qBAAiB,CACtC,IAAI,CAAC,QAAQ,EACb,gBAAgB,EAChB,QAAQ,EACR,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,IAAI,EACJ,cAAc,EACd,CAAC,CAAC,EACF,QAAQ,CACR,CAAC;QACF,MAAM,IAAI,GAAG,SAAS,CAAC,YAAY,EAAE,CAAC;QAEtC,8CAA8C;QAC9C,aAAa;QACb,IAAI,CAAC,OAAO,GAAG;YACd,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO,EAAE,OAAO,CAAC,GAAG;YACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC1B,CAAC;QAEF,aAAa;QACb,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QAEnB,aAAa;QACb,IAAI,CAAC,QAAQ,GAAG,gBAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,gBAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,gBAAQ,CAAC;QAEzB,aAAa;QACb,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QAEtB,yBAAyB;QACzB,IAAI,CAAC;YACJ,kJAAkJ;YAClJ,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YACpD,IAAI,OAAO,WAAW,KAAK,UAAU,EAAE,CAAC;gBACvC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;YACvE,CAAC;YACD,IAAI,WAAW,KAAK,IAAI,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAC7D,IAAI,oBAAoB,EAAE,CAAC;oBAC1B,OAAO,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;gBACrD,CAAC;YACF,CAAC;YACD,+DAA+D;YAC/D,OAAO,WAAW,CAAC;QACpB,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACrB,MAAM,OAAO,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAC;QACxD,CAAC;IACF,CAAC;IAED;;;;;;;;OAQG;IACH,uBAAuB,CACtB,IAAW,EACX,cAA4C,EAC5C,IAAyB,EACzB,cAAgD,EAChD,YAAwC;QAExC,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAClC,yCAAyC;YACzC,OAAO,YAAY,CAAC;QACrB,CAAC;QAED,mDAAmD;QACnD,MAAM,QAAQ,GAAG,CAAC,CAAC;QACnB,MAAM,SAAS,GAAG,CAAC,CAAC;QACpB,MAAM,mBAAmB,GAAyB,EAAE,CAAC;QACrD,MAAM,OAAO,GAAsB;YAClC,UAAU,EAAE;gBACX,OAAO,EAAE,EAAE;aACX;SACD,CAAC;QAEF,OAAO,IAAI,CAAC,iBAAiB,CAC5B,cAAc,EACd,OAAO,EACP,QAAQ,EACR,SAAS,EACT,IAAI,CAAC,IAAI,EACT,mBAAmB,EACnB,IAAI,EACJ,cAAc,CAC2B,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACH,wBAAwB,CACvB,IAAW,EACX,cAA+F,EAC/F,IAAyB,EACzB,cAAgD,EAChD,eAKe,SAAS,EACxB,QAAQ,GAAG,EAAE;QAEb,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAClC,yCAAyC;YACzC,OAAO,YAAY,CAAC;QACrB,CAAC;QAED,mDAAmD;QACnD,MAAM,QAAQ,GAAG,CAAC,CAAC;QACnB,MAAM,SAAS,GAAG,CAAC,CAAC;QACpB,MAAM,mBAAmB,GAAyB,EAAE,CAAC;QACrD,MAAM,OAAO,GAAsB;YAClC,UAAU,EAAE;gBACX,OAAO,EAAE,EAAE;aACX;SACD,CAAC;QAEF,kCAAkC;QAClC,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CACxC,cAAc,EACd,OAAO,EACP,QAAQ,EACR,SAAS,EACT,IAAI,CAAC,IAAI,EACT,mBAAmB,EACnB,IAAI,EACJ,cAAc,EACd,KAAK,EACL,QAAQ,CACR,CAAC;QAEF,6BAA6B;QAC7B,OAAO,IAAI,CAAC,iBAAiB,CAC5B,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,EACT,IAAI,CAAC,IAAI,EACT,mBAAmB,EACnB,IAAI,EACJ,cAAc,EACd,KAAK,EACL,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAChB,cAA+F,EAC/F,gBAA0C,EAC1C,QAAgB,EAChB,SAAiB,EACjB,cAAsB,EACtB,mBAAyC,EACzC,IAAyB,EACzB,cAAgD,EAChD,oBAAoB,GAAG,KAAK,EAC5B,QAAQ,GAAG,EAAE;QAEb,kFAAkF;QAClF,MAAM,kBAAkB,GAAG,CAC1B,KAAsF,EACrF,EAAE;YACH,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;QAClC,CAAC,CAAC;QAEF,uFAAuF;QACvF,MAAM,qBAAqB,GAAG,CAC7B,KAAsF,EACtF,iBAAkC,EACjC,EAAE;YACH,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC,iBAAiB,CAC5B,KAAK,EACL,gBAAgB,EAChB,QAAQ,EACR,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,IAAI,EACJ,cAAc,EACd,oBAAoB,EACpB,QAAQ,CACR,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC,2BAA2B,CACtC,KAA2B,EAC3B,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,EACR,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,IAAI,EACJ,cAAc,EACd,oBAAoB,EACpB,QAAQ,CACR,CAAC;QACH,CAAC,CAAC;QAEF,yEAAyE;QACzE,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,EAAE,CAAC;YACzC,OAAO,IAAI,CAAC,2BAA2B,CACtC,cAAoC,EACpC,EAAE,EACF,gBAAgB,EAChB,QAAQ,EACR,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,IAAI,EACJ,cAAc,EACd,oBAAoB,EACpB,QAAQ,CACR,CAAC;QACH,CAAC;QAED,8DAA8D;QAE9D,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YACnC,mBAAmB;YACnB,MAAM,UAAU,GAAG,EAAE,CAAC;YACtB,gDAAgD;YAChD,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;gBACnC,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;YAClD,CAAC;YAED,IAAI,oBAAoB,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;gBAC5D,OAAO,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC;YACpD,CAAC;YAED,OAAO,UAAsD,CAAC;QAC/D,CAAC;QACD,IAAI,cAAc,KAAK,IAAI,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAC7D,OAAO,cAAc,CAAC;QACvB,CAAC;QACD,oBAAoB;QACpB,MAAM,UAAU,GAAoB,EAAE,CAAC;QACvC,gDAAgD;QAChD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YAC/C,UAAU,CAAC,GAAG,CAAC,GAAG,qBAAqB,CACrC,cAAkC,CAAC,GAAG,CAAC,EACxC,cAAiC,CACjC,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YAC5D,OAAO,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,UAAU,CAAC;IACnB,CAAC;CACD;AA3VD,gCA2VC"}