@atom8n/n8n-workflow 2.2.0

package/dist/cjs/workflow.d.ts

@@ -0,0 +1,155 @@
+import { Expression } from './expression';
+import type { IConnections, INode, INodeExecutionData, INodes, INodeType, INodeTypes, IPinData, IWorkflowSettings, IConnection, IConnectedNode, IDataObject, INodeConnection, NodeParameterValueType, NodeConnectionType } from './interfaces';
+export interface WorkflowParameters {
+    id?: string;
+    name?: string;
+    nodes: INode[];
+    connections: IConnections;
+    active: boolean;
+    nodeTypes: INodeTypes;
+    staticData?: IDataObject;
+    settings?: IWorkflowSettings;
+    pinData?: IPinData;
+}
+export declare class Workflow {
+    id: string;
+    name: string | undefined;
+    nodes: INodes;
+    connectionsBySourceNode: IConnections;
+    connectionsByDestinationNode: IConnections;
+    nodeTypes: INodeTypes;
+    expression: Expression;
+    active: boolean;
+    settings: IWorkflowSettings;
+    readonly timezone: string;
+    staticData: IDataObject;
+    testStaticData: IDataObject | undefined;
+    pinData?: IPinData;
+    constructor(parameters: WorkflowParameters);
+    setNodes(nodes: INode[]): void;
+    setConnections(connections: IConnections): void;
+    setPinData(pinData: IPinData | undefined): void;
+    setSettings(settings: IWorkflowSettings): void;
+    overrideStaticData(staticData?: IDataObject): void;
+    static getConnectionsByDestination(connections: IConnections): IConnections;
+    /**
+     * Returns the static data of the workflow.
+     * It gets saved with the workflow and will be the same for
+     * all workflow-executions.
+     *
+     * @param {string} type The type of data to return ("global"|"node")
+     * @param {INode} [node] If type is set to "node" then the node has to be provided
+     */
+    getStaticData(type: string, node?: INode): IDataObject;
+    setTestStaticData(testStaticData: IDataObject): void;
+    /**
+     * Returns all the trigger nodes in the workflow.
+     *
+     */
+    getTriggerNodes(): INode[];
+    /**
+     * Returns all the poll nodes in the workflow
+     *
+     */
+    getPollNodes(): INode[];
+    /**
+     * Returns all the nodes in the workflow for which the given
+     * checkFunction return true
+     *
+     * @param {(nodeType: INodeType) => boolean} checkFunction
+     */
+    queryNodes(checkFunction: (nodeType: INodeType) => boolean): INode[];
+    /**
+     * Returns the node with the given name if it exists else null
+     *
+     * @param {string} nodeName Name of the node to return
+     */
+    getNode(nodeName: string): INode | null;
+    /**
+     * Returns the nodes with the given names if they exist.
+     * If a node cannot be found it will be ignored, meaning the returned array
+     * of nodes can be smaller than the array of names.
+     */
+    getNodes(nodeNames: string[]): INode[];
+    /**
+     * Returns the pinData of the node with the given name if it exists
+     *
+     * @param {string} nodeName Name of the node to return the pinData of
+     */
+    getPinDataOfNode(nodeName: string): INodeExecutionData[] | undefined;
+    renameNodeInParameterValue(parameterValue: NodeParameterValueType, currentName: string, newName: string, { hasRenamableContent }?: {
+        hasRenamableContent: boolean;
+    }): NodeParameterValueType;
+    /**
+     * Rename a node in the workflow
+     *
+     * @param {string} currentName The current name of the node
+     * @param {string} newName The new name
+     */
+    renameNode(currentName: string, newName: string): void;
+    /**
+     * Finds the highest parent nodes of the node with the given name
+     *
+     * @param {NodeConnectionType} [type='main']
+     */
+    getHighestNode(nodeName: string, nodeConnectionIndex?: number, checkedNodes?: string[]): string[];
+    /**
+     * Returns all the after the given one
+     *
+     * @param {string} [type='main']
+     * @param {*} [depth=-1]
+     */
+    getChildNodes(nodeName: string, type?: NodeConnectionType | 'ALL' | 'ALL_NON_MAIN', depth?: number): string[];
+    /**
+     * Returns all the nodes before the given one
+     *
+     * @param {NodeConnectionType} [type='main']
+     * @param {*} [depth=-1]
+     */
+    getParentNodes(nodeName: string, type?: NodeConnectionType | 'ALL' | 'ALL_NON_MAIN', depth?: number): string[];
+    /**
+     * Gets all the nodes which are connected nodes starting from
+     * the given one
+     *
+     * @param {NodeConnectionType} [type='main']
+     * @param {*} [depth=-1]
+     */
+    getConnectedNodes(connections: IConnections, nodeName: string, connectionType?: NodeConnectionType | 'ALL' | 'ALL_NON_MAIN', depth?: number, checkedNodesIncoming?: string[]): string[];
+    /**
+     * Returns all the nodes before the given one
+     *
+     * @param {*} [maxDepth=-1]
+     */
+    getParentNodesByDepth(nodeName: string, maxDepth?: number): IConnectedNode[];
+    /**
+     * Gets all the nodes which are connected nodes starting from
+     * the given one
+     * Uses BFS traversal
+     *
+     * @param {*} [maxDepth=-1]
+     */
+    searchNodesBFS(connections: IConnections, sourceNode: string, maxDepth?: number): IConnectedNode[];
+    getParentMainInputNode(node: INode): INode;
+    /**
+     * Returns via which output of the parent-node and index the current node
+     * they are connected
+     *
+     * @param {string} nodeName The node to check how it is connected with parent node
+     * @param {string} parentNodeName The parent node to get the output index of
+     * @param {string} [type='main']
+     */
+    getNodeConnectionIndexes(nodeName: string, parentNodeName: string, type?: NodeConnectionType): INodeConnection | undefined;
+    /**
+     * Returns from which of the given nodes the workflow should get started from
+     *
+     * @param {string[]} nodeNames The potential start nodes
+     */
+    __getStartNode(nodeNames: string[]): INode | undefined;
+    /**
+     * Returns the start node to start the workflow from
+     *
+     */
+    getStartNode(destinationNode?: string): INode | undefined;
+    getConnectionsBetweenNodes(sources: string[], targets: string[]): Array<[IConnection, IConnection]>;
+}
+//# sourceMappingURL=workflow.d.ts.map

package/dist/cjs/workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../src/workflow.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,KAAK,EACX,YAAY,EACZ,KAAK,EACL,kBAAkB,EAElB,MAAM,EACN,SAAS,EACT,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,WAAW,EACX,cAAc,EACd,WAAW,EACX,eAAe,EAEf,sBAAsB,EACtB,kBAAkB,EAClB,MAAM,cAAc,CAAC;AAQtB,MAAM,WAAW,kBAAkB;IAClC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,EAAE,CAAC;IACf,WAAW,EAAE,YAAY,CAAC;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,UAAU,CAAC;IACtB,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,OAAO,CAAC,EAAE,QAAQ,CAAC;CACnB;AAED,qBAAa,QAAQ;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzB,KAAK,EAAE,MAAM,CAAM;IAEnB,uBAAuB,EAAE,YAAY,CAAM;IAE3C,4BAA4B,EAAE,YAAY,CAAM;IAEhD,SAAS,EAAE,UAAU,CAAC;IAEtB,UAAU,EAAE,UAAU,CAAC;IAEvB,MAAM,EAAE,OAAO,CAAC;IAEhB,QAAQ,EAAE,iBAAiB,CAAM;IAEjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAI1B,UAAU,EAAE,WAAW,CAAC;IAExB,cAAc,EAAE,WAAW,GAAG,SAAS,CAAC;IAExC,OAAO,CAAC,EAAE,QAAQ,CAAC;gBAEP,UAAU,EAAE,kBAAkB;IAkD1C,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE;IAOvB,cAAc,CAAC,WAAW,EAAE,YAAY;IAKxC,UAAU,CAAC,OAAO,EAAE,QAAQ,GAAG,SAAS;IAIxC,WAAW,CAAC,QAAQ,EAAE,iBAAiB;IAIvC,kBAAkB,CAAC,UAAU,CAAC,EAAE,WAAW;IAO3C,MAAM,CAAC,2BAA2B,CAAC,WAAW,EAAE,YAAY,GAAG,YAAY;IA6C3E;;;;;;;OAOG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,KAAK,GAAG,WAAW;IA4BtD,iBAAiB,CAAC,cAAc,EAAE,WAAW;IAI7C;;;OAGG;IACH,eAAe,IAAI,KAAK,EAAE;IAI1B;;;OAGG;IACH,YAAY,IAAI,KAAK,EAAE;IAIvB;;;;;OAKG;IACH,UAAU,CAAC,aAAa,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,OAAO,GAAG,KAAK,EAAE;IAwBpE;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI;IAIvC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE;IAgBtC;;;;OAIG;IACH,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,EAAE,GAAG,SAAS;IAIpE,0BAA0B,CACzB,cAAc,EAAE,sBAAsB,EACtC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,EAAE,mBAAmB,EAAE;;KAAiC,GACtD,sBAAsB;IA6CzB;;;;;OAKG;IACH,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAgG/C;;;;OAIG;IACH,cAAc,CACb,QAAQ,EAAE,MAAM,EAChB,mBAAmB,CAAC,EAAE,MAAM,EAC5B,YAAY,CAAC,EAAE,MAAM,EAAE,GACrB,MAAM,EAAE;IA0EX;;;;;OAKG;IACH,aAAa,CACZ,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,kBAAkB,GAAG,KAAK,GAAG,cAAyC,EAC5E,KAAK,SAAK,GACR,MAAM,EAAE;IAIX;;;;;OAKG;IACH,cAAc,CACb,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,kBAAkB,GAAG,KAAK,GAAG,cAAyC,EAC5E,KAAK,SAAK,GACR,MAAM,EAAE;IAIX;;;;;;OAMG;IACH,iBAAiB,CAChB,WAAW,EAAE,YAAY,EACzB,QAAQ,EAAE,MAAM,EAChB,cAAc,GAAE,kBAAkB,GAAG,KAAK,GAAG,cAAyC,EACtF,KAAK,SAAK,EACV,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAC7B,MAAM,EAAE;IAIX;;;;OAIG;IACH,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,SAAK,GAAG,cAAc,EAAE;IAIxE;;;;;;OAMG;IACH,cAAc,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,SAAK,GAAG,cAAc,EAAE;IAwD9F,sBAAsB,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK;IAmD1C;;;;;;;OAOG;IACH,wBAAwB,CACvB,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,EACtB,IAAI,GAAE,kBAA6C,GACjD,eAAe,GAAG,SAAS;IA8D9B;;;;OAIG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,SAAS;IA8CtD;;;OAGG;IACH,YAAY,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAyBzD,0BAA0B,CACzB,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,MAAM,EAAE,GACf,KAAK,CAAC,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;CA8BpC"}