n8n-workflow 1.98.0 → 1.99.0

package/dist/{node-helpers.d.ts → cjs/node-helpers.d.ts}

@@ -1,9 +1,38 @@
 import type { IContextObject, INode, INodeCredentialDescription, INodeIssues, INodeParameters, INodeProperties, INodePropertyCollection, INodeType, IParameterDependencies, IRunExecutionData, IVersionedNodeType, INodeTypeDescription, INodeOutputConfiguration, INodeInputConfiguration, NodeConnectionType } from './interfaces';
 import type { Workflow } from './workflow';
 export declare const cronNodeOptions: INodePropertyCollection[];
+/**
+ * Determines if the provided node type has any output types other than the main connection type.
+ * @param typeDescription The node's type description to check.
+ */
 export declare function isSubNodeType(typeDescription: Pick<INodeTypeDescription, 'outputs'> | null): boolean;
-export declare function displayParameter(nodeValues: INodeParameters, parameter: INodeProperties | INodeCredentialDescription, node: Pick<INode, 'typeVersion'> | null, nodeTypeDescription: INodeTypeDescription | null, nodeValuesRoot?: INodeParameters, displayKey?: 'displayOptions' | 'disabledOptions'): boolean;
+/**
+ * Returns if the parameter should be displayed or not
+ *
+ * @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
+ */
+export declare function displayParameter(nodeValues: INodeParameters, parameter: INodeProperties | INodeCredentialDescription, node: Pick<INode, 'typeVersion'> | null, // Allow null as it does also get used by credentials and they do not have versioning yet
+nodeTypeDescription: INodeTypeDescription | null, nodeValuesRoot?: INodeParameters, displayKey?: 'displayOptions' | 'disabledOptions'): boolean;
+/**
+ * Returns if the given parameter should be displayed or not considering the path
+ * to the properties
+ *
+ * @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
+ */
 export declare function displayParameterPath(nodeValues: INodeParameters, parameter: INodeProperties | INodeCredentialDescription, path: string, node: Pick<INode, 'typeVersion'> | null, nodeTypeDescription: INodeTypeDescription | null, displayKey?: 'displayOptions' | 'disabledOptions'): boolean;
+/**
+ * Returns the context data
+ *
+ * @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
+ */
 export declare function getContext(runExecutionData: IRunExecutionData, type: string, node?: INode): IContextObject;
 type GetNodeParametersOptions = {
     onlySimpleTypes?: boolean;
@@ -12,26 +41,105 @@ type GetNodeParametersOptions = {
     parentType?: string;
     parameterDependencies?: IParameterDependencies;
 };
+/**
+ * Returns the node parameter values. Depending on the settings it either just returns the none
+ * default values or it applies all the default values.
+ *
+ * @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 {GetNodeParametersOptions} options Optional properties
+ */
 export declare function getNodeParameters(nodePropertiesArray: INodeProperties[], nodeValues: INodeParameters | null, returnDefaults: boolean, returnNoneDisplayed: boolean, node: Pick<INode, 'typeVersion'> | null, nodeTypeDescription: INodeTypeDescription | null, options?: GetNodeParametersOptions): INodeParameters | null;
+/**
+ * Returns the webhook path
+ */
 export declare function getNodeWebhookPath(workflowId: string, node: INode, path: string, isFullPath?: boolean, restartWebhook?: boolean): string;
+/**
+ * Returns the webhook URL
+ */
 export declare function getNodeWebhookUrl(baseUrl: string, workflowId: string, node: INode, path: string, isFullPath?: boolean): string;
 export declare function getConnectionTypes(connections: Array<NodeConnectionType | INodeInputConfiguration | INodeOutputConfiguration>): NodeConnectionType[];
 export declare function getNodeInputs(workflow: Workflow, node: INode, nodeTypeData: INodeTypeDescription): Array<NodeConnectionType | INodeInputConfiguration>;
 export declare function getNodeOutputs(workflow: Workflow, node: INode, nodeTypeData: INodeTypeDescription): Array<NodeConnectionType | INodeOutputConfiguration>;
+/**
+ * Returns all the parameter-issues of the node
+ *
+ * @param {INodeProperties[]} nodePropertiesArray The properties of the node
+ * @param {INode} node The data of the node
+ */
 export declare function getNodeParametersIssues(nodePropertiesArray: INodeProperties[], node: INode, nodeTypeDescription: INodeTypeDescription | null, pinDataNodeNames?: string[]): INodeIssues | null;
+/**
+ * Returns the parameter value
+ *
+ * @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
+ */
 export declare function getParameterValueByPath(nodeValues: INodeParameters, parameterName: string, path: string): import("./interfaces").NodeParameterValueType;
+/**
+ * Returns all the issues with the given node-values
+ *
+ * @param {INodeProperties} nodeProperties The properties of the node
+ * @param {INodeParameters} nodeValues The values of the node
+ * @param {string} path The path to the properties
+ */
 export declare function getParameterIssues(nodeProperties: INodeProperties, nodeValues: INodeParameters, path: string, node: INode, nodeTypeDescription: INodeTypeDescription | null): INodeIssues;
+/**
+ * Merges multiple NodeIssues together
+ *
+ * @param {INodeIssues} destination The issues to merge into
+ * @param {(INodeIssues | null)} source The issues to merge
+ */
 export declare function mergeIssues(destination: INodeIssues, source: INodeIssues | null): void;
+/**
+ * Merges the given node properties
+ */
 export declare function mergeNodeProperties(mainProperties: INodeProperties[], addProperties: INodeProperties[]): void;
 export declare function getVersionedNodeType(object: IVersionedNodeType | INodeType, version?: number): INodeType;
 export declare function isTriggerNode(nodeTypeData: INodeTypeDescription): boolean;
 export declare function isExecutable(workflow: Workflow, node: INode, nodeTypeData: INodeTypeDescription): boolean;
 export declare function isNodeWithWorkflowSelector(node: INode): boolean;
+/**
+ * Generates a human-readable description for a node based on its parameters and type definition.
+ *
+ * This function creates a descriptive string that represents what the node does,
+ * based on its resource, operation, and node type information. The description is
+ * formatted in one of the following ways:
+ *
+ * 1. "{action} in {displayName}" if the operation has a defined action
+ * 2. "{operation} {resource} in {displayName}" if resource and operation exist
+ * 3. The node type's description field as a fallback
+ */
 export declare function makeDescription(nodeParameters: INodeParameters, nodeTypeDescription: INodeTypeDescription): string;
 export declare function isTool(nodeTypeDescription: INodeTypeDescription, parameters: INodeParameters): boolean;
+/**
+ * Generates a resource and operation aware node name.
+ *
+ * Appends `in {nodeTypeDisplayName}` if nodeType is a tool
+ *
+ * 1. "{action}" if the operation has a defined action
+ * 2. "{operation} {resource}" if resource and operation exist
+ * 3. The node type's defaults.name field or displayName as a fallback
+ */
 export declare function makeNodeName(nodeParameters: INodeParameters, nodeTypeDescription: INodeTypeDescription): string;
+/**
+ * Returns true if the node name is of format `<defaultNodeName>\d*` , which includes auto-renamed nodes
+ */
 export declare function isDefaultNodeName(name: string, nodeType: INodeTypeDescription, parameters: INodeParameters): boolean;
+/**
+ * Determines whether a tool description should be updated and returns the new description if needed.
+ * Returns undefined if no update is needed.
+ */
 export declare const getUpdatedToolDescription: (currentNodeType: INodeTypeDescription | null, newParameters: INodeParameters | null, currentParameters?: INodeParameters) => string | undefined;
+/**
+ * Generates a tool description for a given node based on its parameters and type.
+ */
 export declare function getToolDescriptionForNode(node: INode, nodeType: INodeType): string;
+/**
+ * Attempts to retrieve the ID of a subworkflow from a execute workflow node.
+ */
 export declare function getSubworkflowId(node: INode): string | undefined;
 export {};
+//# sourceMappingURL=node-helpers.d.ts.map

package/dist/cjs/node-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-helpers.d.ts","sourceRoot":"","sources":["../../src/node-helpers.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAEX,cAAc,EACd,KAAK,EACL,0BAA0B,EAE1B,WAAW,EAEX,eAAe,EACf,eAAe,EACf,uBAAuB,EAKvB,SAAS,EACT,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EAGlB,oBAAoB,EACpB,wBAAwB,EACxB,uBAAuB,EAGvB,kBAAkB,EAClB,MAAM,cAAc,CAAC;AAWtB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,eAAO,MAAM,eAAe,EAAE,uBAAuB,EAyLpD,CAAC;AAEF;;;GAGG;AACH,wBAAgB,aAAa,CAC5B,eAAe,EAAE,IAAI,CAAC,oBAAoB,EAAE,SAAS,CAAC,GAAG,IAAI,GAC3D,OAAO,CAQT;AA4FD;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC/B,UAAU,EAAE,eAAe,EAC3B,SAAS,EAAE,eAAe,GAAG,0BAA0B,EACvD,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,IAAI,EAAE,yFAAyF;AAClI,mBAAmB,EAAE,oBAAoB,GAAG,IAAI,EAChD,cAAc,CAAC,EAAE,eAAe,EAChC,UAAU,GAAE,gBAAgB,GAAG,iBAAoC,WAiDnE;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CACnC,UAAU,EAAE,eAAe,EAC3B,SAAS,EAAE,eAAe,GAAG,0BAA0B,EACvD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,IAAI,EACvC,mBAAmB,EAAE,oBAAoB,GAAG,IAAI,EAChD,UAAU,GAAE,gBAAgB,GAAG,iBAAoC,WAqBnE;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACzB,gBAAgB,EAAE,iBAAiB,EACnC,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,KAAK,GACV,cAAc,CA4BhB;AAsGD,KAAK,wBAAwB,GAAG;IAC/B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,cAAc,CAAC,EAAE,eAAe,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qBAAqB,CAAC,EAAE,sBAAsB,CAAC;CAC/C,CAAC;AAEF;;;;;;;;;GASG;AAEH,wBAAgB,iBAAiB,CAChC,mBAAmB,EAAE,eAAe,EAAE,EACtC,UAAU,EAAE,eAAe,GAAG,IAAI,EAClC,cAAc,EAAE,OAAO,EACvB,mBAAmB,EAAE,OAAO,EAC5B,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,IAAI,EACvC,mBAAmB,EAAE,oBAAoB,GAAG,IAAI,EAChD,OAAO,CAAC,EAAE,wBAAwB,GAChC,eAAe,GAAG,IAAI,CA4UxB;AAED;;GAEG;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,UAoBxB;AAED;;GAEG;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,wBAAgB,kBAAkB,CACjC,WAAW,EAAE,KAAK,CAAC,kBAAkB,GAAG,uBAAuB,GAAG,wBAAwB,CAAC,GACzF,kBAAkB,EAAE,CAStB;AAED,wBAAgB,aAAa,CAC5B,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,KAAK,EACX,YAAY,EAAE,oBAAoB,GAChC,KAAK,CAAC,kBAAkB,GAAG,uBAAuB,CAAC,CAiBrD;AAED,wBAAgB,cAAc,CAC7B,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,KAAK,EACX,YAAY,EAAE,oBAAoB,GAChC,KAAK,CAAC,kBAAkB,GAAG,wBAAwB,CAAC,CA2CtD;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACtC,mBAAmB,EAAE,eAAe,EAAE,EACtC,IAAI,EAAE,KAAK,EACX,mBAAmB,EAAE,oBAAoB,GAAG,IAAI,EAChD,gBAAgB,CAAC,EAAE,MAAM,EAAE,GACzB,WAAW,GAAG,IAAI,CAyBpB;AAkID;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,eAAe,EAC3B,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,MAAM,iDAGZ;AAMD;;;;;;GAMG;AAEH,wBAAgB,kBAAkB,CACjC,cAAc,EAAE,eAAe,EAC/B,UAAU,EAAE,eAAe,EAC3B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,KAAK,EACX,mBAAmB,EAAE,oBAAoB,GAAG,IAAI,GAC9C,WAAW,CAqMb;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,GAAG,IAAI,QAoC/E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAClC,cAAc,EAAE,eAAe,EAAE,EACjC,aAAa,EAAE,eAAe,EAAE,GAC9B,IAAI,CAeN;AAED,wBAAgB,oBAAoB,CACnC,MAAM,EAAE,kBAAkB,GAAG,SAAS,EACtC,OAAO,CAAC,EAAE,MAAM,GACd,SAAS,CAKX;AAED,wBAAgB,aAAa,CAAC,YAAY,EAAE,oBAAoB,WAE/D;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,oBAAoB,WAQ/F;AAED,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,KAAK,WAErD;AA+BD;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC9B,cAAc,EAAE,eAAe,EAC/B,mBAAmB,EAAE,oBAAoB,GACvC,MAAM,CAeR;AAED,wBAAgB,MAAM,CACrB,mBAAmB,EAAE,oBAAoB,EACzC,UAAU,EAAE,eAAe,GACzB,OAAO,CAiBT;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC3B,cAAc,EAAE,eAAe,EAC/B,mBAAmB,EAAE,oBAAoB,GACvC,MAAM,CAoBR;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAChC,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,oBAAoB,EAC9B,UAAU,EAAE,eAAe,GACzB,OAAO,CAQT;AAED;;;GAGG;AAEH,eAAO,MAAM,yBAAyB,GACrC,iBAAiB,oBAAoB,GAAG,IAAI,EAC5C,eAAe,eAAe,GAAG,IAAI,EACrC,oBAAoB,eAAe,uBAkBnC,CAAC;AAEF;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,GAAG,MAAM,CAalF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS,CAKhE"}