@fsai-flow/workflow 0.0.2 → 0.1.0

package/dist/src/lib/NodeErrors.js

@@ -0,0 +1,284 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeApiError = exports.NodeOperationError = void 0;
+/* eslint-disable @typescript-eslint/no-shadow */
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable no-param-reassign */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+// eslint-disable-next-line max-classes-per-file
+const xml2js_1 = require("xml2js");
+/**
+ * Top-level properties where an error message can be found in an API response.
+ */
+const ERROR_MESSAGE_PROPERTIES = [
+    "cause",
+    "error",
+    "message",
+    "Message",
+    "msg",
+    "messages",
+    "description",
+    "reason",
+    "detail",
+    "details",
+    "errors",
+    "errorMessage",
+    "errorMessages",
+    "ErrorMessage",
+    "error_message",
+    "_error_message",
+    "errorDescription",
+    "error_description",
+    "error_summary",
+    "title",
+    "text",
+    "field",
+    "err",
+    "type",
+];
+/**
+ * Top-level properties where an HTTP error code can be found in an API response.
+ */
+const ERROR_STATUS_PROPERTIES = ["statusCode", "status", "code", "status_code", "errorCode", "error_code"];
+/**
+ * Properties where a nested object can be found in an API response.
+ */
+const ERROR_NESTING_PROPERTIES = ["error", "err", "response", "body", "data"];
+/**
+ * Base class for specific NodeError-types, with functionality for finding
+ * a value recursively inside an error object.
+ */
+class NodeError extends Error {
+    description;
+    cause;
+    node;
+    timestamp;
+    constructor(node, error) {
+        super();
+        this.name = this.constructor.name;
+        this.cause = error;
+        this.node = node;
+        this.timestamp = Date.now();
+        if (error.message) {
+            this.message = error.message;
+        }
+    }
+    /**
+     * Finds property through exploration based on potential keys and traversal keys.
+     * Depth-first approach.
+     *
+     * This method iterates over `potentialKeys` and, if the value at the key is a
+     * truthy value, the type of the value is checked:
+     * (1) if a string or number, the value is returned as a string; or
+     * (2) if an array,
+     * 		its string or number elements are collected as a long string,
+     * 		its object elements are traversed recursively (restart this function
+     *    with each object as a starting point), or
+     * (3) if it is an object, it traverses the object and nested ones recursively
+     * 		based on the `potentialKeys` and returns a string if found.
+     *
+     * If nothing found via `potentialKeys` this method iterates over `traversalKeys` and
+     * if the value at the key is a traversable object, it restarts with the object as the
+     * new starting point (recursion).
+     * If nothing found for any of the `traversalKeys`, exploration continues with remaining
+     * `traversalKeys`.
+     *
+     * Otherwise, if all the paths have been exhausted and no value is eligible, `null` is
+     * returned.
+     *
+     * @param {JsonObject} error
+     * @param {string[]} potentialKeys
+     * @param {string[]} traversalKeys
+     * @returns {string | null}
+     */
+    findProperty(error, potentialKeys, traversalKeys = []) {
+        // eslint-disable-next-line no-restricted-syntax
+        for (const key of potentialKeys) {
+            if (error[key]) {
+                if (typeof error[key] === "string")
+                    return error[key];
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                if (typeof error[key] === "number")
+                    return error[key].toString();
+                if (Array.isArray(error[key])) {
+                    // @ts-ignore
+                    const resolvedErrors = error[key]
+                        // @ts-ignore
+                        .map((error) => {
+                        if (typeof error === "string")
+                            return error;
+                        if (typeof error === "number")
+                            return error.toString();
+                        if (this.isTraversableObject(error)) {
+                            return this.findProperty(error, potentialKeys);
+                        }
+                        return null;
+                    })
+                        .filter((errorValue) => errorValue !== null);
+                    if (resolvedErrors.length === 0) {
+                        return null;
+                    }
+                    return resolvedErrors.join(" | ");
+                }
+                if (this.isTraversableObject(error[key])) {
+                    const property = this.findProperty(error[key], potentialKeys);
+                    if (property) {
+                        return property;
+                    }
+                }
+            }
+        }
+        // eslint-disable-next-line no-restricted-syntax
+        for (const key of traversalKeys) {
+            if (this.isTraversableObject(error[key])) {
+                const property = this.findProperty(error[key], potentialKeys, traversalKeys);
+                if (property) {
+                    return property;
+                }
+            }
+        }
+        return null;
+    }
+    /**
+     * Check if a value is an object with at least one key, i.e. it can be traversed.
+     */
+    isTraversableObject(value) {
+        return !!value && typeof value === "object" && !Array.isArray(value) && !!Object.keys(value).length;
+    }
+    /**
+     * Remove circular references from objects.
+     */
+    removeCircularRefs(obj, seen = new Set()) {
+        seen.add(obj);
+        Object.entries(obj).forEach(([key, value]) => {
+            if (this.isTraversableObject(value)) {
+                // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+                if (seen.has(value)) {
+                    obj[key] = { circularReference: true };
+                }
+                else {
+                    this.removeCircularRefs(value, seen);
+                }
+                return;
+            }
+            if (Array.isArray(value)) {
+                value.forEach((val, index) => {
+                    if (seen.has(val)) {
+                        value[index] = { circularReference: true };
+                        return;
+                    }
+                    if (this.isTraversableObject(val)) {
+                        this.removeCircularRefs(val, seen);
+                    }
+                });
+            }
+        });
+    }
+}
+/**
+ * Class for instantiating an operational error, e.g. an invalid credentials error.
+ */
+class NodeOperationError extends NodeError {
+    itemIndex;
+    functionality;
+    constructor(node, error, options) {
+        if (typeof error === "string") {
+            error = new Error(error);
+        }
+        super(node, error);
+        if (options?.description) {
+            this.description = options.description;
+        }
+        if (options?.itemIndex !== undefined) {
+            this.itemIndex = options.itemIndex;
+        }
+        if (options?.functionality) {
+            this.functionality = options.functionality;
+        }
+    }
+}
+exports.NodeOperationError = NodeOperationError;
+const STATUS_CODE_MESSAGES = {
+    "4XX": "Your request is invalid or could not be processed by the service",
+    "400": "Bad request - please check your parameters",
+    "401": "Authorization failed - please check your credentials",
+    "402": "Payment required - perhaps check your payment details?",
+    "403": "Forbidden - perhaps check your credentials?",
+    "404": "The resource you are requesting could not be found",
+    "405": "Method not allowed - please check you are using the right HTTP method",
+    "429": "The service is receiving too many requests from you! Perhaps take a break?",
+    "5XX": "The service failed to process your request",
+    "500": "The service was not able to process your request",
+    "502": "Bad gateway - the service failed to handle your request",
+    "503": "Service unavailable - perhaps try again later?",
+    "504": "Gateway timed out - perhaps try again later?",
+};
+const UNKNOWN_ERROR_MESSAGE = "UNKNOWN ERROR - check the detailed error for more information";
+/**
+ * Class for instantiating an error in an API response, e.g. a 404 Not Found response,
+ * with an HTTP error code, an error message and a description.
+ */
+class NodeApiError extends NodeError {
+    httpCode;
+    constructor(node, error, { message, description, httpCode, parseXml, } = {}) {
+        super(node, error);
+        if (error.error) {
+            // only for request library error
+            this.removeCircularRefs(error.error);
+        }
+        if (message) {
+            this.message = message;
+            this.description = description;
+            this.httpCode = httpCode ?? null;
+            return;
+        }
+        this.httpCode = this.findProperty(error, ERROR_STATUS_PROPERTIES, ERROR_NESTING_PROPERTIES);
+        this.setMessage();
+        if (parseXml) {
+            this.setDescriptionFromXml(error.error);
+            return;
+        }
+        this.description = this.findProperty(error, ERROR_MESSAGE_PROPERTIES, ERROR_NESTING_PROPERTIES);
+    }
+    setDescriptionFromXml(xml) {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        (0, xml2js_1.parseString)(xml, { explicitArray: false }, (_, result) => {
+            if (!result)
+                return;
+            const topLevelKey = Object.keys(result)[0];
+            this.description = this.findProperty(
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            result[topLevelKey], ERROR_MESSAGE_PROPERTIES, ["Error"].concat(ERROR_NESTING_PROPERTIES));
+        });
+    }
+    /**
+     * Set the error's message based on the HTTP status code.
+     *
+     * @returns {void}
+     */
+    setMessage() {
+        if (!this.httpCode) {
+            this.httpCode = null;
+            this.message = UNKNOWN_ERROR_MESSAGE;
+            return;
+        }
+        if (STATUS_CODE_MESSAGES[this.httpCode]) {
+            this.message = STATUS_CODE_MESSAGES[this.httpCode];
+            return;
+        }
+        switch (this.httpCode.charAt(0)) {
+            case "4":
+                this.message = STATUS_CODE_MESSAGES["4XX"];
+                break;
+            case "5":
+                this.message = STATUS_CODE_MESSAGES["5XX"];
+                break;
+            default:
+                this.message = UNKNOWN_ERROR_MESSAGE;
+        }
+    }
+}
+exports.NodeApiError = NodeApiError;
+//# sourceMappingURL=NodeErrors.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NodeErrors.js","sourceRoot":"","sources":["../../../src/lib/NodeErrors.ts"],"names":[],"mappings":";;;AAAA,iDAAiD;AACjD,sDAAsD;AACtD,sCAAsC;AACtC,+DAA+D;AAC/D,wDAAwD;AACxD,4DAA4D;AAC5D,gDAAgD;AAChD,mCAAqC;AAIrC;;GAEG;AACH,MAAM,wBAAwB,GAAG;IAChC,OAAO;IACP,OAAO;IACP,SAAS;IACT,SAAS;IACT,KAAK;IACL,UAAU;IACV,aAAa;IACb,QAAQ;IACR,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,cAAc;IACd,eAAe;IACf,cAAc;IACd,eAAe;IACf,gBAAgB;IAChB,kBAAkB;IAClB,mBAAmB;IACnB,eAAe;IACf,OAAO;IACP,MAAM;IACN,OAAO;IACP,KAAK;IACL,MAAM;CACN,CAAC;AAEF;;GAEG;AACH,MAAM,uBAAuB,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;AAE3G;;GAEG;AACH,MAAM,wBAAwB,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAE9E;;;GAGG;AACH,MAAe,SAAU,SAAQ,KAAK;IACrC,WAAW,CAA4B;IAE9B,KAAK,CAAqB;IAEnC,IAAI,CAAQ;IAEZ,SAAS,CAAS;IAElB,YAAY,IAAW,EAAE,KAAyB;QACjD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE5B,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAiB,CAAC;QACxC,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACO,YAAY,CAAC,KAAiB,EAAE,aAAuB,EAAE,gBAA0B,EAAE;QAC9F,gDAAgD;QAChD,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChB,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ;oBAAE,OAAO,KAAK,CAAC,GAAG,CAAW,CAAC;gBAChE,oEAAoE;gBACpE,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ;oBAAE,OAAO,KAAK,CAAC,GAAG,CAAE,CAAC,QAAQ,EAAE,CAAC;gBAClE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;oBAC/B,aAAa;oBACb,MAAM,cAAc,GAAa,KAAK,CAAC,GAAG,CAAC;wBAC1C,aAAa;yBACZ,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;wBACd,IAAI,OAAO,KAAK,KAAK,QAAQ;4BAAE,OAAO,KAAK,CAAC;wBAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ;4BAAE,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;wBACvD,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;4BACrC,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;wBAChD,CAAC;wBACD,OAAO,IAAI,CAAC;oBACb,CAAC,CAAC;yBACD,MAAM,CAAC,CAAC,UAAyB,EAAE,EAAE,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC;oBAE7D,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACjC,OAAO,IAAI,CAAC;oBACb,CAAC;oBACD,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnC,CAAC;gBACD,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;oBAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAe,EAAE,aAAa,CAAC,CAAC;oBAC5E,IAAI,QAAQ,EAAE,CAAC;wBACd,OAAO,QAAQ,CAAC;oBACjB,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;QAED,gDAAgD;QAChD,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;YACjC,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAe,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;gBAC3F,IAAI,QAAQ,EAAE,CAAC;oBACd,OAAO,QAAQ,CAAC;gBACjB,CAAC;YACF,CAAC;QACF,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACO,mBAAmB,CAAC,KAAc;QAC3C,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;IACrG,CAAC;IAED;;OAEG;IACO,kBAAkB,CAAC,GAAe,EAAE,IAAI,GAAG,IAAI,GAAG,EAAE;QAC7D,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC5C,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrC,oEAAoE;gBACpE,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;gBACxC,CAAC;qBAAM,CAAC;oBACP,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBACtC,CAAC;gBACD,OAAO;YACR,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;oBAC5B,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;wBACnB,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;wBAC3C,OAAO;oBACR,CAAC;oBACD,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;wBACnC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;oBACpC,CAAC;gBACF,CAAC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;CACD;AAED;;GAEG;AACH,MAAa,kBAAmB,SAAQ,SAAS;IAChD,SAAS,CAAU;IACnB,aAAa,CAAU;IACvB,YACC,IAAW,EACX,KAAqB,EACrB,OAA8E;QAE9E,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC/B,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;QACD,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAEnB,IAAI,OAAO,EAAE,WAAW,EAAE,CAAC;YAC1B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,EAAE,SAAS,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACpC,CAAC;QACD,IAAI,OAAO,EAAE,aAAa,EAAE,CAAC;YAC5B,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC5C,CAAC;IACF,CAAC;CACD;AAvBD,gDAuBC;AAED,MAAM,oBAAoB,GAAwB;IACjD,KAAK,EAAE,kEAAkE;IACzE,KAAK,EAAE,4CAA4C;IACnD,KAAK,EAAE,sDAAsD;IAC7D,KAAK,EAAE,wDAAwD;IAC/D,KAAK,EAAE,6CAA6C;IACpD,KAAK,EAAE,oDAAoD;IAC3D,KAAK,EAAE,uEAAuE;IAC9E,KAAK,EAAE,4EAA4E;IAEnF,KAAK,EAAE,4CAA4C;IACnD,KAAK,EAAE,kDAAkD;IACzD,KAAK,EAAE,yDAAyD;IAChE,KAAK,EAAE,gDAAgD;IACvD,KAAK,EAAE,8CAA8C;CACrD,CAAC;AAEF,MAAM,qBAAqB,GAAG,+DAA+D,CAAC;AAE9F;;;GAGG;AACH,MAAa,YAAa,SAAQ,SAAS;IAC1C,QAAQ,CAAgB;IAExB,YACC,IAAW,EACX,KAAiB,EACjB,EACC,OAAO,EACP,WAAW,EACX,QAAQ,EACR,QAAQ,MAC8E,EAAE;QAEzF,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACnB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACjB,iCAAiC;YACjC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,KAAmB,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACb,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;YAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,IAAI,IAAI,CAAC;YACjC,OAAO;QACR,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,uBAAuB,EAAE,wBAAwB,CAAC,CAAC;QAC5F,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,QAAQ,EAAE,CAAC;YACd,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,KAAe,CAAC,CAAC;YAClD,OAAO;QACR,CAAC;QAED,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,wBAAwB,EAAE,wBAAwB,CAAC,CAAC;IACjG,CAAC;IAEO,qBAAqB,CAAC,GAAW;QACxC,gEAAgE;QAChE,IAAA,oBAAW,EAAC,GAAG,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;YACxD,IAAI,CAAC,MAAM;gBAAE,OAAO;YAEpB,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY;YACnC,sEAAsE;YACtE,MAAM,CAAC,WAAW,CAAC,EACnB,wBAAwB,EACxB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAC1C,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACK,UAAU;QACjB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACpB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,OAAO,GAAG,qBAAqB,CAAC;YACrC,OAAO;QACR,CAAC;QAED,IAAI,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnD,OAAO;QACR,CAAC;QAED,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACjC,KAAK,GAAG;gBACP,IAAI,CAAC,OAAO,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBAC3C,MAAM;YACP,KAAK,GAAG;gBACP,IAAI,CAAC,OAAO,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBAC3C,MAAM;YACP;gBACC,IAAI,CAAC,OAAO,GAAG,qBAAqB,CAAC;QACvC,CAAC;IACF,CAAC;CACD;AA/ED,oCA+EC"}

package/dist/src/lib/NodeHelpers.d.ts

@@ -0,0 +1,199 @@
+import { type IContextObject, type INode, type INodeCredentialDescription, type INodeExecutionData, type INodeInputConfiguration, type INodeIssues, type INodeOutputConfiguration, type INodeParameters, type INodeProperties, type INodePropertyCollection, type INodeType, type INodeTypeDescription, type INodeVersionedType, type IParameterDependencies, type IRunExecutionData, type IWebhookData, type IWorkflowExecuteAdditionalData, type NodeConnectionType, type NodeParameterValue } from "./Interfaces";
+import type { Workflow } from "./Workflow";
+export declare function getConnectionTypes(connections: Array<NodeConnectionType | INodeInputConfiguration | INodeOutputConfiguration>): NodeConnectionType[];
+export declare const cronNodeOptions: INodePropertyCollection[];
+export declare function isSubNodeType(typeDescription: Pick<INodeTypeDescription, "outputs"> | null): boolean;
+/**
+ * Gets special parameters which should be added to nodeTypes depending
+ * on their type or configuration
+ *
+ * @export
+ * @param {INodeType} nodeType
+ * @returns
+ */
+export declare function getSpecialNodeParameters(nodeType: INodeType): INodeProperties[];
+/**
+ * Returns if the parameter should be displayed or not
+ *
+ * @export
+ * @param {INodeParameters} nodeValues The data on the node which decides if the parameter
+ *                                    should be displayed
+ * @param {(INodeProperties | INodeCredentialDescription)} parameter The parameter to check if it should be displayed
+ * @param {INodeParameters} [nodeValuesRoot] The root node-parameter-data
+ * @returns
+ */
+export declare function displayParameter(nodeValues: INodeParameters, parameter: INodeProperties | INodeCredentialDescription, nodeValuesRoot?: INodeParameters): boolean;
+/**
+ * Returns if the given parameter should be displayed or not considering the path
+ * to the properties
+ *
+ * @export
+ * @param {INodeParameters} nodeValues The data on the node which decides if the parameter
+ *                                    should be displayed
+ * @param {(INodeProperties | INodeCredentialDescription)} parameter The parameter to check if it should be displayed
+ * @param {string} path The path to the property
+ * @returns
+ */
+export declare function displayParameterPath(nodeValues: INodeParameters, parameter: INodeProperties | INodeCredentialDescription, path: string): boolean;
+/**
+ * Returns the context data
+ *
+ * @export
+ * @param {IRunExecutionData} runExecutionData The run execution data
+ * @param {string} type The data type. "node"/"flow"
+ * @param {INode} [node] If type "node" is set the node to return the context of has to be supplied
+ * @returns {IContextObject}
+ */
+export declare function getContext(runExecutionData: IRunExecutionData, type: string, node?: INode): IContextObject;
+/**
+ * Returns which parameters are dependent on which
+ *
+ * @export
+ * @param {INodeProperties[]} nodePropertiesArray
+ * @returns {IParameterDependencies}
+ */
+export declare function getParamterDependencies(nodePropertiesArray: INodeProperties[]): IParameterDependencies;
+/**
+ * Returns in which order the parameters should be resolved
+ * to have the parameters available they depend on
+ *
+ * @export
+ * @param {INodeProperties[]} nodePropertiesArray
+ * @param {IParameterDependencies} parameterDependencies
+ * @returns {number[]}
+ */
+export declare function getParamterResolveOrder(nodePropertiesArray: INodeProperties[], parameterDependencies: IParameterDependencies): number[];
+/**
+ * Returns the node parameter values. Depending on the settings it either just returns the none
+ * default values or it applies all the default values.
+ *
+ * @export
+ * @param {INodeProperties[]} nodePropertiesArray The properties which exist and their settings
+ * @param {INodeParameters} nodeValues The node parameter data
+ * @param {boolean} returnDefaults If default values get added or only none default values returned
+ * @param {boolean} returnNoneDisplayed If also values which should not be displayed should be returned
+ * @param {boolean} [onlySimpleTypes=false] If only simple types should be resolved
+ * @param {boolean} [dataIsResolved=false] If nodeValues are already fully resolved (so that all default values got added already)
+ * @param {INodeParameters} [nodeValuesRoot] The root node-parameter-data
+ * @returns {(INodeParameters | null)}
+ */
+export declare function getNodeParameters(nodePropertiesArray: INodeProperties[], nodeValues: INodeParameters, returnDefaults: boolean, returnNoneDisplayed: boolean, onlySimpleTypes?: boolean, dataIsResolved?: boolean, nodeValuesRoot?: INodeParameters, parentType?: string, parameterDependencies?: IParameterDependencies): INodeParameters | null;
+/**
+ * Brings the output data in a format that can be returned from a node
+ *
+ * @export
+ * @param {INodeExecutionData[]} outputData
+ * @param {number} [outputIndex=0]
+ * @returns {Promise<INodeExecutionData[][]>}
+ */
+export declare function prepareOutputData(outputData: INodeExecutionData[], outputIndex?: number): Promise<INodeExecutionData[][]>;
+/**
+ * Returns all the webhooks which should be created for the give node
+ *
+ * @export
+ *
+ * @param {INode} node
+ * @returns {IWebhookData[]}
+ */
+export declare function getNodeWebhooks(workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData, ignoreRestartWehbooks?: boolean): IWebhookData[];
+export declare function getNodeWebhooksBasic(workflow: Workflow, node: INode): IWebhookData[];
+/**
+ * Returns the webhook path
+ *
+ * @export
+ * @param {string} workflowId
+ * @param {string} nodeTypeName
+ * @param {string} path
+ * @returns {string}
+ */
+export declare function getNodeWebhookPath(workflowId: string, node: INode, path: string, isFullPath?: boolean, restartWebhook?: boolean): string;
+/**
+ * Returns the webhook URL
+ *
+ * @export
+ * @param {string} baseUrl
+ * @param {string} workflowId
+ * @param {string} nodeTypeName
+ * @param {string} path
+ * @param {boolean} isFullPath
+ * @returns {string}
+ */
+export declare function getNodeWebhookUrl(baseUrl: string, workflowId: string, node: INode, path: string, isFullPath?: boolean): string;
+/**
+ * Returns all the parameter-issues of the node
+ *
+ * @export
+ * @param {INodeProperties[]} nodePropertiesArray The properties of the node
+ * @param {INode} node The data of the node
+ * @returns {(INodeIssues | null)}
+ */
+export declare function getNodeParametersIssues(nodePropertiesArray: INodeProperties[], node: INode): INodeIssues | null;
+/**
+ * Returns the issues of the node as string
+ *
+ * @export
+ * @param {INodeIssues} issues The issues of the node
+ * @param {INode} node The node
+ * @returns {string[]}
+ */
+export declare function nodeIssuesToString(issues: INodeIssues, node?: INode): string[];
+/**
+ * Adds an issue if the parameter is not defined
+ *
+ * @export
+ * @param {INodeIssues} foundIssues The already found issues
+ * @param {INodeProperties} nodeProperties The properties of the node
+ * @param {NodeParameterValue} value The value of the parameter
+ */
+export declare function addToIssuesIfMissing(foundIssues: INodeIssues, nodeProperties: INodeProperties, value: NodeParameterValue): void;
+/**
+ * Returns the parameter value
+ *
+ * @export
+ * @param {INodeParameters} nodeValues The values of the node
+ * @param {string} parameterName The name of the parameter to return the value of
+ * @param {string} path The path to the properties
+ * @returns
+ */
+export declare function getParameterValueByPath(nodeValues: INodeParameters, parameterName: string, path: string): INodeParameters | NodeParameterValue | NodeParameterValue[] | INodeParameters[];
+/**
+ * Returns all the issues with the given node-values
+ *
+ * @export
+ * @param {INodeProperties} nodeProperties The properties of the node
+ * @param {INodeParameters} nodeValues The values of the node
+ * @param {string} path The path to the properties
+ * @returns {INodeIssues}
+ */
+export declare function getParameterIssues(nodeProperties: INodeProperties, nodeValues: INodeParameters, path: string): INodeIssues;
+/**
+ * Merges multiple NodeIssues together
+ *
+ * @export
+ * @param {INodeIssues} destination The issues to merge into
+ * @param {(INodeIssues | null)} source The issues to merge
+ * @returns
+ */
+export declare function mergeIssues(destination: INodeIssues, source: INodeIssues | null): void;
+/**
+ * Merges the given node properties
+ *
+ * @export
+ * @param {INodeProperties[]} mainProperties
+ * @param {INodeProperties[]} addProperties
+ */
+export declare function mergeNodeProperties(mainProperties: INodeProperties[], addProperties: INodeProperties[]): void;
+export declare function getVersionedNodeType(object: INodeVersionedType | INodeType, version?: number): INodeType;
+export declare function getVersionedNodeTypeAll(object: INodeVersionedType | INodeType): INodeType[];
+export declare function isNodeTypeVersioned(object: INodeVersionedType | INodeType): boolean;
+/**
+ * Returns the parameter value from the node parameters
+ *
+ * @export
+ * @param {INodeParameters} nodeParameters The node parameters
+ * @param {string} parameterName The name of the parameter to get
+ * @param {number} [index=0] The index of the parameter value if it's an array
+ * @returns {NodeParameterValue | undefined} The parameter value
+ */
+export declare function getParameterValue(nodeParameters: INodeParameters, parameterName: string, index?: number): NodeParameterValue | undefined;
+//# sourceMappingURL=NodeHelpers.d.ts.map

package/dist/src/lib/NodeHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeHelpers.d.ts","sourceRoot":"","sources":["../../../src/lib/NodeHelpers.ts"],"names":[],"mappings":"AAiBA,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,KAAK,EACV,KAAK,0BAA0B,EAC/B,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAE5B,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAC5B,KAAK,SAAS,EACd,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,8BAA8B,EACnC,KAAK,kBAAkB,EAEvB,KAAK,kBAAkB,EAEvB,MAAM,cAAc,CAAC;AAEtB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,wBAAgB,kBAAkB,CACjC,WAAW,EAAE,KAAK,CAAC,kBAAkB,GAAG,uBAAuB,GAAG,wBAAwB,CAAC,GACzF,kBAAkB,EAAE,CAStB;AAED,eAAO,MAAM,eAAe,EAAE,uBAAuB,EA6LpD,CAAC;AAEF,wBAAgB,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,GAAG,IAAI,GAAG,OAAO,CAMpG;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,SAAS,GAAG,eAAe,EAAE,CAiN/E;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC/B,UAAU,EAAE,eAAe,EAC3B,SAAS,EAAE,eAAe,GAAG,0BAA0B,EACvD,cAAc,CAAC,EAAE,eAAe,WA+DhC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CACnC,UAAU,EAAE,eAAe,EAC3B,SAAS,EAAE,eAAe,GAAG,0BAA0B,EACvD,IAAI,EAAE,MAAM,WAcZ;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,GAAG,cAAc,CAwB1G;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,mBAAmB,EAAE,eAAe,EAAE,GAAG,sBAAsB,CAyBtG;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACtC,mBAAmB,EAAE,eAAe,EAAE,EACtC,qBAAqB,EAAE,sBAAsB,GAC3C,MAAM,EAAE,CAwDV;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,iBAAiB,CAChC,mBAAmB,EAAE,eAAe,EAAE,EACtC,UAAU,EAAE,eAAe,EAC3B,cAAc,EAAE,OAAO,EACvB,mBAAmB,EAAE,OAAO,EAC5B,eAAe,UAAQ,EACvB,cAAc,UAAQ,EACtB,cAAc,CAAC,EAAE,eAAe,EAChC,UAAU,CAAC,EAAE,MAAM,EACnB,qBAAqB,CAAC,EAAE,sBAAsB,GAC5C,eAAe,GAAG,IAAI,CA6OxB;AAED;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CACtC,UAAU,EAAE,kBAAkB,EAAE,EAChC,WAAW,SAAI,GACb,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAWjC;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC9B,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,KAAK,EACX,cAAc,EAAE,8BAA8B,EAC9C,qBAAqB,UAAQ,GAC3B,YAAY,EAAE,CAuFhB;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,GAAG,YAAY,EAAE,CAkEpF;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CACjC,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,OAAO,EACpB,cAAc,CAAC,EAAE,OAAO,GACtB,MAAM,CAcR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAChC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,OAAO,GAClB,MAAM,CASR;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,mBAAmB,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,KAAK,GAAG,WAAW,GAAG,IAAI,CAmB/G;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,EAAE,CA8B9E;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CACnC,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,eAAe,EAC/B,KAAK,EAAE,kBAAkB,QAkBzB;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,mFAEvG;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CACjC,cAAc,EAAE,eAAe,EAC/B,UAAU,EAAE,eAAe,EAC3B,IAAI,EAAE,MAAM,GACV,WAAW,CAyGb;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,GAAG,IAAI,QAoC/E;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,cAAc,EAAE,eAAe,EAAE,EAAE,aAAa,EAAE,eAAe,EAAE,GAAG,IAAI,CAa7G;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,kBAAkB,GAAG,SAAS,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAKxG;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,kBAAkB,GAAG,SAAS,GAAG,SAAS,EAAE,CAQ3F;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,kBAAkB,GAAG,SAAS,GAAG,OAAO,CAEnF;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAChC,cAAc,EAAE,eAAe,EAC/B,aAAa,EAAE,MAAM,EACrB,KAAK,SAAI,GACP,kBAAkB,GAAG,SAAS,CAYhC"}