2019-06-23 03:35:23 -07:00
|
|
|
import { Workflow } from './Workflow';
|
2019-12-19 14:07:55 -08:00
|
|
|
import { WorkflowHooks } from './WorkflowHooks';
|
2019-09-19 05:14:37 -07:00
|
|
|
import * as express from 'express';
|
2019-06-23 03:35:23 -07:00
|
|
|
|
2020-01-13 18:46:58 -08:00
|
|
|
export type IAllExecuteFunctions = IExecuteFunctions | IExecuteSingleFunctions | IHookFunctions | ILoadOptionsFunctions | IPollFunctions | ITriggerFunctions | IWebhookFunctions;
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
export interface IBinaryData {
|
|
|
|
[key: string]: string | undefined;
|
|
|
|
data: string;
|
|
|
|
mimeType: string;
|
|
|
|
fileName?: string;
|
|
|
|
fileExtension?: string;
|
|
|
|
}
|
|
|
|
|
2020-07-25 10:58:38 -07:00
|
|
|
export interface IOAuth2Options {
|
|
|
|
includeCredentialsOnRefreshOnBody?: boolean;
|
|
|
|
property?: string;
|
|
|
|
tokenType?: string;
|
2020-09-16 00:16:06 -07:00
|
|
|
keepBearer?: boolean;
|
2020-07-25 10:58:38 -07:00
|
|
|
}
|
2019-06-23 03:35:23 -07:00
|
|
|
|
|
|
|
export interface IConnection {
|
|
|
|
// The node the connection is to
|
|
|
|
node: string;
|
|
|
|
|
|
|
|
// The type of the input on destination node (for example "main")
|
|
|
|
type: string;
|
|
|
|
|
|
|
|
// The output/input-index of destination node (if node has multiple inputs/outputs of the same type)
|
|
|
|
index: number;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface IExecutionError {
|
|
|
|
message: string;
|
|
|
|
node?: string;
|
|
|
|
stack?: string;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Get used to gives nodes access to credentials
|
|
|
|
export interface IGetCredentials {
|
|
|
|
get(type: string, name: string): Promise<ICredentialsEncrypted>;
|
|
|
|
}
|
|
|
|
|
2020-01-25 23:48:38 -08:00
|
|
|
export abstract class ICredentials {
|
|
|
|
name: string;
|
|
|
|
type: string;
|
|
|
|
data: string | undefined;
|
|
|
|
nodesAccess: ICredentialNodeAccess[];
|
|
|
|
|
|
|
|
constructor(name: string, type: string, nodesAccess: ICredentialNodeAccess[], data?: string) {
|
|
|
|
this.name = name;
|
|
|
|
this.type = type;
|
|
|
|
this.nodesAccess = nodesAccess;
|
|
|
|
this.data = data;
|
|
|
|
}
|
|
|
|
|
|
|
|
abstract getData(encryptionKey: string, nodeType?: string): ICredentialDataDecryptedObject;
|
|
|
|
abstract getDataKey(key: string, encryptionKey: string, nodeType?: string): CredentialInformation;
|
|
|
|
abstract getDataToSave(): ICredentialsEncrypted;
|
|
|
|
abstract hasNodeAccess(nodeType: string): boolean;
|
|
|
|
abstract setData(data: ICredentialDataDecryptedObject, encryptionKey: string): void;
|
|
|
|
abstract setDataKey(key: string, data: CredentialInformation, encryptionKey: string): void;
|
|
|
|
}
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
// Defines which nodes are allowed to access the credentials and
|
|
|
|
// when that access got grented from which user
|
|
|
|
export interface ICredentialNodeAccess {
|
|
|
|
nodeType: string;
|
|
|
|
user?: string;
|
2019-07-22 11:29:06 -07:00
|
|
|
date?: Date;
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
export interface ICredentialsDecrypted {
|
|
|
|
name: string;
|
|
|
|
type: string;
|
|
|
|
nodesAccess: ICredentialNodeAccess[];
|
|
|
|
data?: ICredentialDataDecryptedObject;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface ICredentialsEncrypted {
|
|
|
|
name: string;
|
|
|
|
type: string;
|
|
|
|
nodesAccess: ICredentialNodeAccess[];
|
|
|
|
data?: string;
|
|
|
|
}
|
|
|
|
|
2021-01-24 04:33:57 -08:00
|
|
|
export interface ICredentialsExpressionResolveValues {
|
|
|
|
connectionInputData: INodeExecutionData[];
|
|
|
|
itemIndex: number;
|
|
|
|
node: INode;
|
|
|
|
runExecutionData: IRunExecutionData | null;
|
|
|
|
runIndex: number;
|
|
|
|
workflow: Workflow;
|
|
|
|
}
|
|
|
|
|
2020-01-25 23:48:38 -08:00
|
|
|
export abstract class ICredentialsHelper {
|
|
|
|
encryptionKey: string;
|
|
|
|
workflowCredentials: IWorkflowCredentials;
|
|
|
|
|
|
|
|
constructor(workflowCredentials: IWorkflowCredentials, encryptionKey: string) {
|
|
|
|
this.encryptionKey = encryptionKey;
|
|
|
|
this.workflowCredentials = workflowCredentials;
|
|
|
|
}
|
|
|
|
|
|
|
|
abstract getCredentials(name: string, type: string): ICredentials;
|
2021-01-29 00:31:40 -08:00
|
|
|
abstract getDecrypted(name: string, type: string, mode: WorkflowExecuteMode, raw?: boolean, expressionResolveValues?: ICredentialsExpressionResolveValues): ICredentialDataDecryptedObject;
|
2020-01-25 23:48:38 -08:00
|
|
|
abstract updateCredentials(name: string, type: string, data: ICredentialDataDecryptedObject): Promise<void>;
|
|
|
|
}
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
export interface ICredentialType {
|
|
|
|
name: string;
|
|
|
|
displayName: string;
|
2020-01-13 18:46:58 -08:00
|
|
|
extends?: string[];
|
2019-06-23 03:35:23 -07:00
|
|
|
properties: INodeProperties[];
|
2020-08-17 02:58:36 -07:00
|
|
|
documentationUrl?: string;
|
2020-01-25 23:48:38 -08:00
|
|
|
__overwrittenProperties?: string[];
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
export interface ICredentialTypes {
|
|
|
|
credentialTypes?: {
|
|
|
|
[key: string]: ICredentialType
|
|
|
|
};
|
|
|
|
init(credentialTypes?: { [key: string]: ICredentialType }): Promise<void>;
|
|
|
|
getAll(): ICredentialType[];
|
|
|
|
getByName(credentialType: string): ICredentialType;
|
|
|
|
}
|
|
|
|
|
|
|
|
// The way the credentials get saved in the database (data encrypted)
|
|
|
|
export interface ICredentialData {
|
|
|
|
name: string;
|
|
|
|
data: string; // Contains the access data as encrypted JSON string
|
|
|
|
nodesAccess: ICredentialNodeAccess[];
|
|
|
|
}
|
|
|
|
|
|
|
|
// The encrypted credentials which the nodes can access
|
2020-01-13 18:46:58 -08:00
|
|
|
export type CredentialInformation = string | number | boolean | IDataObject;
|
2019-06-23 03:35:23 -07:00
|
|
|
|
|
|
|
|
|
|
|
// The encrypted credentials which the nodes can access
|
|
|
|
export interface ICredentialDataDecryptedObject {
|
|
|
|
[key: string]: CredentialInformation;
|
|
|
|
}
|
|
|
|
|
|
|
|
// First array index: The output/input-index (if node has multiple inputs/outputs of the same type)
|
|
|
|
// Second array index: The different connections (if one node is connected to multiple nodes)
|
|
|
|
export type NodeInputConnections = IConnection[][];
|
|
|
|
|
|
|
|
export interface INodeConnections {
|
|
|
|
// Input name
|
|
|
|
[key: string]: NodeInputConnections;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface IConnections {
|
|
|
|
// Node name
|
|
|
|
[key: string]: INodeConnections;
|
|
|
|
}
|
|
|
|
|
|
|
|
export type GenericValue = string | object | number | boolean | undefined | null;
|
|
|
|
|
|
|
|
export interface IDataObject {
|
|
|
|
[key: string]: GenericValue | IDataObject | GenericValue[] | IDataObject[];
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-12-31 12:19:37 -08:00
|
|
|
export interface IGetExecutePollFunctions {
|
|
|
|
(workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode): IPollFunctions;
|
|
|
|
}
|
|
|
|
|
2019-08-08 11:38:25 -07:00
|
|
|
export interface IGetExecuteTriggerFunctions {
|
|
|
|
(workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode): ITriggerFunctions;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface IGetExecuteFunctions {
|
|
|
|
(workflow: Workflow, runExecutionData: IRunExecutionData, runIndex: number, connectionInputData: INodeExecutionData[], inputData: ITaskDataConnections, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode): IExecuteFunctions;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface IGetExecuteSingleFunctions {
|
|
|
|
(workflow: Workflow, runExecutionData: IRunExecutionData, runIndex: number, connectionInputData: INodeExecutionData[], inputData: ITaskDataConnections, node: INode, itemIndex: number, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode): IExecuteSingleFunctions;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface IGetExecuteHookFunctions {
|
|
|
|
(workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode, isTest?: boolean, webhookData?: IWebhookData): IHookFunctions;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface IGetExecuteWebhookFunctions {
|
|
|
|
(workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode, webhookData: IWebhookData): IWebhookFunctions;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
export interface IExecuteData {
|
|
|
|
data: ITaskDataConnections;
|
|
|
|
node: INode;
|
|
|
|
}
|
|
|
|
|
|
|
|
export type IContextObject = {
|
|
|
|
[key: string]: any; // tslint:disable-line:no-any
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
export interface IExecuteContextData {
|
|
|
|
// Keys are: "flow" | "node:<NODE_NAME>"
|
|
|
|
[key: string]: IContextObject;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface IExecuteFunctions {
|
2020-03-17 05:18:04 -07:00
|
|
|
continueOnFail(): boolean;
|
2020-03-21 09:25:29 -07:00
|
|
|
evaluateExpression(expression: string, itemIndex: number): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[];
|
2020-01-02 15:13:53 -08:00
|
|
|
executeWorkflow(workflowInfo: IExecuteWorkflowInfo, inputData?: INodeExecutionData[]): Promise<any>; // tslint:disable-line:no-any
|
2019-06-23 03:35:23 -07:00
|
|
|
getContext(type: string): IContextObject;
|
2021-01-24 04:33:57 -08:00
|
|
|
getCredentials(type: string, itemIndex?: number): ICredentialDataDecryptedObject | undefined;
|
2019-06-23 03:35:23 -07:00
|
|
|
getInputData(inputIndex?: number, inputName?: string): INodeExecutionData[];
|
|
|
|
getMode(): WorkflowExecuteMode;
|
2020-02-15 17:07:01 -08:00
|
|
|
getNode(): INode;
|
2019-06-23 03:35:23 -07:00
|
|
|
getNodeParameter(parameterName: string, itemIndex: number, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object; //tslint:disable-line:no-any
|
2019-09-04 05:53:39 -07:00
|
|
|
getWorkflowDataProxy(itemIndex: number): IWorkflowDataProxyData;
|
2019-06-23 03:35:23 -07:00
|
|
|
getWorkflowStaticData(type: string): IDataObject;
|
2019-12-19 14:07:55 -08:00
|
|
|
getRestApiUrl(): string;
|
2019-06-23 03:35:23 -07:00
|
|
|
getTimezone(): string;
|
2020-04-11 01:30:50 -07:00
|
|
|
getWorkflow(): IWorkflowMetadata;
|
2019-06-23 03:35:23 -07:00
|
|
|
prepareOutputData(outputData: INodeExecutionData[], outputIndex?: number): Promise<INodeExecutionData[][]>;
|
|
|
|
helpers: {
|
|
|
|
[key: string]: (...args: any[]) => any //tslint:disable-line:no-any
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface IExecuteSingleFunctions {
|
2020-03-17 05:18:04 -07:00
|
|
|
continueOnFail(): boolean;
|
2020-03-21 09:25:29 -07:00
|
|
|
evaluateExpression(expression: string, itemIndex: number | undefined): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[];
|
2019-06-23 03:35:23 -07:00
|
|
|
getContext(type: string): IContextObject;
|
|
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined;
|
|
|
|
getInputData(inputIndex?: number, inputName?: string): INodeExecutionData;
|
|
|
|
getMode(): WorkflowExecuteMode;
|
2020-02-15 17:07:01 -08:00
|
|
|
getNode(): INode;
|
2019-06-23 03:35:23 -07:00
|
|
|
getNodeParameter(parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object; //tslint:disable-line:no-any
|
2019-12-19 14:07:55 -08:00
|
|
|
getRestApiUrl(): string;
|
2019-06-23 03:35:23 -07:00
|
|
|
getTimezone(): string;
|
2020-04-11 01:30:50 -07:00
|
|
|
getWorkflow(): IWorkflowMetadata;
|
2019-09-04 05:53:39 -07:00
|
|
|
getWorkflowDataProxy(): IWorkflowDataProxyData;
|
2019-06-23 03:35:23 -07:00
|
|
|
getWorkflowStaticData(type: string): IDataObject;
|
|
|
|
helpers: {
|
|
|
|
[key: string]: (...args: any[]) => any //tslint:disable-line:no-any
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2020-01-02 15:13:53 -08:00
|
|
|
export interface IExecuteWorkflowInfo {
|
|
|
|
code?: IWorkflowBase;
|
|
|
|
id?: string;
|
|
|
|
}
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
export interface ILoadOptionsFunctions {
|
|
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined;
|
2020-02-15 17:07:01 -08:00
|
|
|
getNode(): INode;
|
2019-06-23 03:35:23 -07:00
|
|
|
getNodeParameter(parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object; //tslint:disable-line:no-any
|
2019-10-20 12:42:34 -07:00
|
|
|
getCurrentNodeParameter(parameterName: string): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object | undefined;
|
|
|
|
getCurrentNodeParameters(): INodeParameters | undefined;
|
2019-06-23 03:35:23 -07:00
|
|
|
getTimezone(): string;
|
2019-12-19 14:07:55 -08:00
|
|
|
getRestApiUrl(): string;
|
2019-06-23 03:35:23 -07:00
|
|
|
helpers: {
|
|
|
|
[key: string]: ((...args: any[]) => any) | undefined; //tslint:disable-line:no-any
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface IHookFunctions {
|
|
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined;
|
|
|
|
getMode(): WorkflowExecuteMode;
|
2020-02-15 17:07:01 -08:00
|
|
|
getNode(): INode;
|
2019-06-23 03:35:23 -07:00
|
|
|
getNodeWebhookUrl: (name: string) => string | undefined;
|
|
|
|
getNodeParameter(parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object; //tslint:disable-line:no-any
|
|
|
|
getTimezone(): string;
|
|
|
|
getWebhookDescription(name: string): IWebhookDescription | undefined;
|
2019-07-12 02:33:18 -07:00
|
|
|
getWebhookName(): string;
|
2020-04-11 01:30:50 -07:00
|
|
|
getWorkflow(): IWorkflowMetadata;
|
2019-06-23 03:35:23 -07:00
|
|
|
getWorkflowStaticData(type: string): IDataObject;
|
|
|
|
helpers: {
|
|
|
|
[key: string]: (...args: any[]) => any //tslint:disable-line:no-any
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2019-12-31 12:19:37 -08:00
|
|
|
export interface IPollFunctions {
|
|
|
|
__emit(data: INodeExecutionData[][]): void;
|
|
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined;
|
|
|
|
getMode(): WorkflowExecuteMode;
|
2020-02-15 17:07:01 -08:00
|
|
|
getNode(): INode;
|
2019-12-31 12:19:37 -08:00
|
|
|
getNodeParameter(parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object; //tslint:disable-line:no-any
|
|
|
|
getRestApiUrl(): string;
|
|
|
|
getTimezone(): string;
|
2020-04-11 01:30:50 -07:00
|
|
|
getWorkflow(): IWorkflowMetadata;
|
2019-12-31 12:19:37 -08:00
|
|
|
getWorkflowStaticData(type: string): IDataObject;
|
|
|
|
helpers: {
|
|
|
|
[key: string]: (...args: any[]) => any //tslint:disable-line:no-any
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
export interface ITriggerFunctions {
|
|
|
|
emit(data: INodeExecutionData[][]): void;
|
|
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined;
|
|
|
|
getMode(): WorkflowExecuteMode;
|
2020-02-15 17:07:01 -08:00
|
|
|
getNode(): INode;
|
2019-06-23 03:35:23 -07:00
|
|
|
getNodeParameter(parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object; //tslint:disable-line:no-any
|
2019-12-19 14:07:55 -08:00
|
|
|
getRestApiUrl(): string;
|
2019-06-23 03:35:23 -07:00
|
|
|
getTimezone(): string;
|
2020-04-11 01:30:50 -07:00
|
|
|
getWorkflow(): IWorkflowMetadata;
|
2019-06-23 03:35:23 -07:00
|
|
|
getWorkflowStaticData(type: string): IDataObject;
|
|
|
|
helpers: {
|
|
|
|
[key: string]: (...args: any[]) => any //tslint:disable-line:no-any
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface IWebhookFunctions {
|
|
|
|
getBodyData(): IDataObject;
|
|
|
|
getCredentials(type: string): ICredentialDataDecryptedObject | undefined;
|
|
|
|
getHeaderData(): object;
|
|
|
|
getMode(): WorkflowExecuteMode;
|
2020-02-15 17:07:01 -08:00
|
|
|
getNode(): INode;
|
2019-06-23 03:35:23 -07:00
|
|
|
getNodeParameter(parameterName: string, fallbackValue?: any): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | object; //tslint:disable-line:no-any
|
2019-07-12 02:33:18 -07:00
|
|
|
getNodeWebhookUrl: (name: string) => string | undefined;
|
2021-01-23 11:00:32 -08:00
|
|
|
getParamsData(): object;
|
2019-06-23 03:35:23 -07:00
|
|
|
getQueryData(): object;
|
|
|
|
getRequestObject(): express.Request;
|
|
|
|
getResponseObject(): express.Response;
|
|
|
|
getTimezone(): string;
|
2019-07-12 02:33:18 -07:00
|
|
|
getWebhookName(): string;
|
2019-06-23 03:35:23 -07:00
|
|
|
getWorkflowStaticData(type: string): IDataObject;
|
2020-04-11 01:30:50 -07:00
|
|
|
getWorkflow(): IWorkflowMetadata;
|
2019-06-23 03:35:23 -07:00
|
|
|
prepareOutputData(outputData: INodeExecutionData[], outputIndex?: number): Promise<INodeExecutionData[][]>;
|
|
|
|
helpers: {
|
|
|
|
[key: string]: (...args: any[]) => any //tslint:disable-line:no-any
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface INodeCredentials {
|
|
|
|
[key: string]: string;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface INode {
|
|
|
|
name: string;
|
|
|
|
typeVersion: number;
|
|
|
|
type: string;
|
|
|
|
position: [number, number];
|
|
|
|
disabled?: boolean;
|
2020-05-05 08:34:12 -07:00
|
|
|
notesInFlow?: boolean;
|
2019-07-18 10:26:16 -07:00
|
|
|
retryOnFail?: boolean;
|
|
|
|
maxTries?: number;
|
|
|
|
waitBetweenTries?: number;
|
2020-04-12 10:58:30 -07:00
|
|
|
alwaysOutputData?: boolean;
|
2020-08-08 11:31:04 -07:00
|
|
|
executeOnce?: boolean;
|
2019-06-23 03:35:23 -07:00
|
|
|
continueOnFail?: boolean;
|
|
|
|
parameters: INodeParameters;
|
|
|
|
credentials?: INodeCredentials;
|
2020-06-10 07:17:16 -07:00
|
|
|
webhookId?: string;
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface INodes {
|
|
|
|
[key: string]: INode;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface IObservableObject {
|
|
|
|
[key: string]: any; // tslint:disable-line:no-any
|
|
|
|
__dataChanged: boolean;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface IBinaryKeyData {
|
|
|
|
[key: string]: IBinaryData;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface INodeExecutionData {
|
|
|
|
[key: string]: IDataObject | IBinaryKeyData | undefined;
|
|
|
|
// TODO: Rename this one as json does not really fit as it is not json (which is a string) it is actually a JS object
|
|
|
|
json: IDataObject;
|
|
|
|
// json: object;
|
|
|
|
// json?: object;
|
|
|
|
binary?: IBinaryKeyData;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface INodeExecuteFunctions {
|
2019-12-31 12:19:37 -08:00
|
|
|
getExecutePollFunctions: IGetExecutePollFunctions;
|
2019-08-08 11:38:25 -07:00
|
|
|
getExecuteTriggerFunctions: IGetExecuteTriggerFunctions;
|
|
|
|
getExecuteFunctions: IGetExecuteFunctions;
|
|
|
|
getExecuteSingleFunctions: IGetExecuteSingleFunctions;
|
|
|
|
getExecuteHookFunctions: IGetExecuteHookFunctions;
|
|
|
|
getExecuteWebhookFunctions: IGetExecuteWebhookFunctions;
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// The values a node property can have
|
2020-10-26 01:26:07 -07:00
|
|
|
export type NodeParameterValue = string | number | boolean | undefined | null;
|
2019-06-23 03:35:23 -07:00
|
|
|
|
|
|
|
export interface INodeParameters {
|
|
|
|
// TODO: Later also has to be possible to add multiple ones with the name name. So array has to be possible
|
2019-10-20 12:42:34 -07:00
|
|
|
[key: string]: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[];
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2020-02-09 13:33:40 -08:00
|
|
|
export type NodePropertyTypes = 'boolean' | 'collection' | 'color' | 'dateTime' | 'fixedCollection' | 'hidden' | 'json' | 'multiOptions' | 'number' | 'options' | 'string';
|
2019-06-23 03:35:23 -07:00
|
|
|
|
2019-09-04 09:22:06 -07:00
|
|
|
export type EditorTypes = 'code';
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
export interface INodePropertyTypeOptions {
|
|
|
|
alwaysOpenEditWindow?: boolean; // Supported by: string
|
2019-09-04 09:22:06 -07:00
|
|
|
editor?: EditorTypes; // Supported by: string
|
2020-01-04 20:28:09 -08:00
|
|
|
loadOptionsDependsOn?: string[]; // Supported by: options
|
2019-06-23 03:35:23 -07:00
|
|
|
loadOptionsMethod?: string; // Supported by: options
|
|
|
|
maxValue?: number; // Supported by: number
|
|
|
|
minValue?: number; // Supported by: number
|
|
|
|
multipleValues?: boolean; // Supported by: <All>
|
|
|
|
multipleValueButtonText?: string; // Supported when "multipleValues" set to true
|
|
|
|
numberPrecision?: number; // Supported by: number
|
|
|
|
numberStepSize?: number; // Supported by: number
|
|
|
|
password?: boolean; // Supported by: string
|
|
|
|
rows?: number; // Supported by: string
|
2020-11-09 02:26:46 -08:00
|
|
|
showAlpha?: boolean; // Supported by: color
|
2020-12-26 15:15:33 -08:00
|
|
|
sortable?: boolean; // Supported when "multipleValues" set to true
|
2020-01-04 20:28:09 -08:00
|
|
|
[key: string]: boolean | number | string | EditorTypes | undefined | string[];
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
export interface IDisplayOptions {
|
|
|
|
hide?: {
|
|
|
|
[key: string]: NodeParameterValue[];
|
|
|
|
};
|
|
|
|
show?: {
|
|
|
|
[key: string]: NodeParameterValue[];
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface INodeProperties {
|
|
|
|
displayName: string;
|
|
|
|
name: string;
|
|
|
|
type: NodePropertyTypes;
|
|
|
|
typeOptions?: INodePropertyTypeOptions;
|
|
|
|
default: NodeParameterValue | INodeParameters | INodeParameters[] | NodeParameterValue[];
|
|
|
|
description?: string;
|
|
|
|
displayOptions?: IDisplayOptions;
|
|
|
|
options?: Array<INodePropertyOptions | INodeProperties | INodePropertyCollection >;
|
|
|
|
placeholder?: string;
|
|
|
|
isNodeSetting?: boolean;
|
|
|
|
noDataExpression?: boolean;
|
|
|
|
required?: boolean;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface INodePropertyOptions {
|
|
|
|
name: string;
|
2019-11-21 15:07:38 -08:00
|
|
|
value: string | number;
|
2019-06-23 03:35:23 -07:00
|
|
|
description?: string;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface INodePropertyCollection {
|
|
|
|
displayName: string;
|
|
|
|
name: string;
|
|
|
|
values: INodeProperties[];
|
|
|
|
}
|
|
|
|
|
2019-07-13 10:50:41 -07:00
|
|
|
export interface IParameterDependencies {
|
|
|
|
[key: string]: string[];
|
|
|
|
}
|
|
|
|
|
2019-12-31 12:19:37 -08:00
|
|
|
export interface IPollResponse {
|
|
|
|
closeFunction?: () => Promise<void>;
|
|
|
|
}
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
export interface ITriggerResponse {
|
|
|
|
closeFunction?: () => Promise<void>;
|
|
|
|
// To manually trigger the run
|
|
|
|
manualTriggerFunction?: () => Promise<void>;
|
|
|
|
// Gets added automatically at manual workflow runs resolves with
|
|
|
|
// the first emitted data
|
|
|
|
manualTriggerResponse?: Promise<INodeExecutionData[][]>;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface INodeType {
|
|
|
|
description: INodeTypeDescription;
|
|
|
|
execute?(this: IExecuteFunctions): Promise<INodeExecutionData[][] | null>;
|
|
|
|
executeSingle?(this: IExecuteSingleFunctions): Promise<INodeExecutionData>;
|
2019-12-31 12:19:37 -08:00
|
|
|
poll?(this: IPollFunctions): Promise<INodeExecutionData[][] | null>;
|
2019-06-23 03:35:23 -07:00
|
|
|
trigger?(this: ITriggerFunctions): Promise<ITriggerResponse | undefined>;
|
2019-10-11 04:02:44 -07:00
|
|
|
webhook?(this: IWebhookFunctions): Promise<IWebhookResponseData>;
|
2019-06-23 03:35:23 -07:00
|
|
|
hooks?: {
|
|
|
|
[key: string]: (this: IHookFunctions) => Promise<boolean>;
|
|
|
|
};
|
|
|
|
methods?: {
|
|
|
|
loadOptions?: {
|
|
|
|
[key: string]: (this: ILoadOptionsFunctions) => Promise<INodePropertyOptions[]>;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
webhookMethods?: {
|
|
|
|
[key: string]: IWebhookSetupMethods;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
export type WebhookSetupMethodNames = 'checkExists' | 'create' | 'delete';
|
|
|
|
|
|
|
|
|
|
|
|
export interface IWebhookSetupMethods {
|
|
|
|
[key: string]: ((this: IHookFunctions) => Promise<boolean>) | undefined;
|
|
|
|
checkExists?: (this: IHookFunctions) => Promise<boolean>;
|
|
|
|
create?: (this: IHookFunctions) => Promise<boolean>;
|
|
|
|
delete?: (this: IHookFunctions) => Promise<boolean>;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface INodeCredentialDescription {
|
|
|
|
name: string;
|
|
|
|
required?: boolean;
|
|
|
|
displayOptions?: IDisplayOptions;
|
|
|
|
}
|
|
|
|
|
|
|
|
export type INodeIssueTypes = 'credentials' | 'execution' | 'parameters' | 'typeUnknown';
|
|
|
|
|
|
|
|
export interface INodeIssueObjectProperty {
|
|
|
|
[key: string]: string[];
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface INodeIssueData {
|
|
|
|
node: string;
|
|
|
|
type: INodeIssueTypes;
|
|
|
|
value: boolean | string | string[] | INodeIssueObjectProperty;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface INodeIssues {
|
|
|
|
execution?: boolean;
|
|
|
|
credentials?: INodeIssueObjectProperty;
|
|
|
|
parameters?: INodeIssueObjectProperty;
|
|
|
|
typeUnknown?: boolean;
|
|
|
|
[key: string]: undefined | boolean | INodeIssueObjectProperty;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface IWorfklowIssues {
|
|
|
|
[key: string]: INodeIssues;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface INodeTypeDescription {
|
|
|
|
displayName: string;
|
|
|
|
name: string;
|
|
|
|
icon?: string;
|
|
|
|
group: string[];
|
|
|
|
version: number;
|
|
|
|
description: string;
|
|
|
|
defaults: INodeParameters;
|
2020-11-09 03:23:53 -08:00
|
|
|
documentationUrl?: string;
|
2019-06-23 03:35:23 -07:00
|
|
|
inputs: string[];
|
2019-08-02 06:56:05 -07:00
|
|
|
inputNames?: string[];
|
2019-06-23 03:35:23 -07:00
|
|
|
outputs: string[];
|
|
|
|
outputNames?: string[];
|
|
|
|
properties: INodeProperties[];
|
|
|
|
credentials?: INodeCredentialDescription[];
|
|
|
|
maxNodes?: number; // How many nodes of that type can be created in a workflow
|
2019-12-31 12:19:37 -08:00
|
|
|
polling?: boolean;
|
2019-07-12 05:14:36 -07:00
|
|
|
subtitle?: string;
|
2019-06-23 03:35:23 -07:00
|
|
|
hooks?: {
|
|
|
|
[key: string]: INodeHookDescription[] | undefined;
|
|
|
|
activate?: INodeHookDescription[];
|
|
|
|
deactivate?: INodeHookDescription[];
|
|
|
|
};
|
|
|
|
webhooks?: IWebhookDescription[];
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface INodeHookDescription {
|
|
|
|
method: string;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface IWebhookData {
|
|
|
|
httpMethod: WebhookHttpMethod;
|
|
|
|
node: string;
|
|
|
|
path: string;
|
|
|
|
webhookDescription: IWebhookDescription;
|
2020-01-22 15:06:43 -08:00
|
|
|
workflowId: string;
|
2019-06-23 03:35:23 -07:00
|
|
|
workflowExecuteAdditionalData: IWorkflowExecuteAdditionalData;
|
2021-01-23 11:00:32 -08:00
|
|
|
webhookId?: string;
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
export interface IWebhookDescription {
|
2020-06-10 06:39:15 -07:00
|
|
|
[key: string]: WebhookHttpMethod | WebhookResponseMode | boolean | string | undefined;
|
2019-06-23 03:35:23 -07:00
|
|
|
httpMethod: WebhookHttpMethod | string;
|
2020-06-10 06:39:15 -07:00
|
|
|
isFullPath?: boolean;
|
2019-06-23 03:35:23 -07:00
|
|
|
name: string;
|
|
|
|
path: string;
|
|
|
|
responseBinaryPropertyName?: string;
|
2019-10-16 05:01:39 -07:00
|
|
|
responseContentType?: string;
|
|
|
|
responsePropertyName?: string;
|
2019-08-28 08:16:09 -07:00
|
|
|
responseMode?: WebhookResponseMode | string;
|
|
|
|
responseData?: WebhookResponseData | string;
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
2019-09-04 05:53:39 -07:00
|
|
|
export interface IWorkflowDataProxyData {
|
|
|
|
$binary: any; // tslint:disable-line:no-any
|
|
|
|
$data: any; // tslint:disable-line:no-any
|
|
|
|
$env: any; // tslint:disable-line:no-any
|
2020-03-21 09:25:29 -07:00
|
|
|
$evaluateExpression: any; // tslint:disable-line:no-any
|
|
|
|
$item: any; // tslint:disable-line:no-any
|
2020-04-12 09:42:29 -07:00
|
|
|
$items: any; // tslint:disable-line:no-any
|
2020-03-21 09:25:29 -07:00
|
|
|
$json: any; // tslint:disable-line:no-any
|
2019-09-04 05:53:39 -07:00
|
|
|
$node: any; // tslint:disable-line:no-any
|
|
|
|
$parameter: any; // tslint:disable-line:no-any
|
2020-03-21 09:25:29 -07:00
|
|
|
$workflow: any; // tslint:disable-line:no-any
|
2019-09-04 05:53:39 -07:00
|
|
|
}
|
|
|
|
|
2020-02-15 17:07:01 -08:00
|
|
|
export interface IWorkflowMetadata {
|
|
|
|
id?: number | string;
|
|
|
|
name?: string;
|
|
|
|
active: boolean;
|
|
|
|
}
|
|
|
|
|
2020-07-24 07:24:18 -07:00
|
|
|
export type WebhookHttpMethod = 'GET' | 'POST' | 'HEAD' | 'OPTIONS';
|
2019-06-23 03:35:23 -07:00
|
|
|
|
2019-10-11 04:02:44 -07:00
|
|
|
export interface IWebhookResponseData {
|
2019-06-23 03:35:23 -07:00
|
|
|
workflowData?: INodeExecutionData[][];
|
|
|
|
webhookResponse?: any; // tslint:disable-line:no-any
|
|
|
|
noWebhookResponse?: boolean;
|
|
|
|
}
|
|
|
|
|
|
|
|
export type WebhookResponseData = 'allEntries' | 'firstEntryJson' | 'firstEntryBinary';
|
|
|
|
export type WebhookResponseMode = 'onReceived' | 'lastNode';
|
|
|
|
|
|
|
|
export interface INodeTypes {
|
2019-08-08 11:38:25 -07:00
|
|
|
nodeTypes: INodeTypeData;
|
|
|
|
init(nodeTypes?: INodeTypeData): Promise<void>;
|
2019-06-23 03:35:23 -07:00
|
|
|
getAll(): INodeType[];
|
|
|
|
getByName(nodeType: string): INodeType | undefined;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-08-08 11:38:25 -07:00
|
|
|
export interface INodeTypeData {
|
|
|
|
[key: string]: {
|
|
|
|
type: INodeType;
|
|
|
|
sourcePath: string;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
export interface IRun {
|
|
|
|
data: IRunExecutionData;
|
|
|
|
finished?: boolean;
|
|
|
|
mode: WorkflowExecuteMode;
|
2019-07-22 11:29:06 -07:00
|
|
|
startedAt: Date;
|
2021-02-08 23:59:32 -08:00
|
|
|
stoppedAt?: Date;
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// Contains all the data which is needed to execute a workflow and so also to
|
|
|
|
// start restart it again after it did fail.
|
|
|
|
// The RunData, ExecuteData and WaitForExecution contain often the same data.
|
|
|
|
export interface IRunExecutionData {
|
|
|
|
startData?: {
|
|
|
|
destinationNode?: string;
|
|
|
|
runNodeFilter?: string[];
|
|
|
|
};
|
|
|
|
resultData: {
|
|
|
|
error?: IExecutionError;
|
|
|
|
runData: IRunData;
|
|
|
|
lastNodeExecuted?: string;
|
|
|
|
};
|
|
|
|
executionData?: {
|
|
|
|
contextData: IExecuteContextData;
|
|
|
|
nodeExecutionStack: IExecuteData[];
|
|
|
|
waitingExecution: IWaitingForExecution;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
export interface IRunData {
|
|
|
|
// node-name: result-data
|
|
|
|
[key: string]: ITaskData[];
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// The data that gets returned when a node runs
|
|
|
|
export interface ITaskData {
|
|
|
|
startTime: number;
|
|
|
|
executionTime: number;
|
|
|
|
data?: ITaskDataConnections;
|
|
|
|
error?: IExecutionError;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
// The data for al the different kind of connectons (like main) and all the indexes
|
|
|
|
export interface ITaskDataConnections {
|
|
|
|
// Key for each input type and because there can be multiple inputs of the same type it is an array
|
|
|
|
// null is also allowed because if we still need data for a later while executing the workflow set teompoary to null
|
|
|
|
// the nodes get as input TaskDataConnections which is identical to this one except that no null is allowed.
|
|
|
|
[key: string]: Array<INodeExecutionData[] | null>;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Keeps data while workflow gets executed and allows when provided to restart execution
|
|
|
|
export interface IWaitingForExecution {
|
|
|
|
// Node name
|
|
|
|
[key: string]: {
|
|
|
|
// Run index
|
|
|
|
[key: number]: ITaskDataConnections
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-12-19 14:07:55 -08:00
|
|
|
export interface IWorkflowBase {
|
|
|
|
id?: number | string | any; // tslint:disable-line:no-any
|
|
|
|
name: string;
|
|
|
|
active: boolean;
|
|
|
|
createdAt: Date;
|
|
|
|
updatedAt: Date;
|
|
|
|
nodes: INode[];
|
|
|
|
connections: IConnections;
|
|
|
|
settings?: IWorkflowSettings;
|
|
|
|
staticData?: IDataObject;
|
|
|
|
}
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
export interface IWorkflowCredentials {
|
|
|
|
// Credential type
|
|
|
|
[key: string]: {
|
|
|
|
// Name
|
|
|
|
[key: string]: ICredentialsEncrypted;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
2019-12-19 14:07:55 -08:00
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
export interface IWorkflowExecuteHooks {
|
2019-08-08 11:38:25 -07:00
|
|
|
[key: string]: Array<((...args: any[]) => Promise<void>)> | undefined; // tslint:disable-line:no-any
|
2021-02-08 23:59:32 -08:00
|
|
|
nodeExecuteAfter?: Array<((nodeName: string, data: ITaskData, executionData: IRunExecutionData) => Promise<void>)>;
|
2019-08-08 11:38:25 -07:00
|
|
|
nodeExecuteBefore?: Array<((nodeName: string) => Promise<void>)>;
|
|
|
|
workflowExecuteAfter?: Array<((data: IRun, newStaticData: IDataObject) => Promise<void>)>;
|
2020-11-13 14:31:27 -08:00
|
|
|
workflowExecuteBefore?: Array<((workflow: Workflow, data: IRunExecutionData) => Promise<void>)>;
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
export interface IWorkflowExecuteAdditionalData {
|
|
|
|
credentials: IWorkflowCredentials;
|
2020-01-25 23:48:38 -08:00
|
|
|
credentialsHelper: ICredentialsHelper;
|
2019-06-23 03:35:23 -07:00
|
|
|
encryptionKey: string;
|
2020-01-02 15:13:53 -08:00
|
|
|
executeWorkflow: (workflowInfo: IExecuteWorkflowInfo, additionalData: IWorkflowExecuteAdditionalData, inputData?: INodeExecutionData[]) => Promise<any>; // tslint:disable-line:no-any
|
2019-12-19 14:07:55 -08:00
|
|
|
// hooks?: IWorkflowExecuteHooks;
|
|
|
|
hooks?: WorkflowHooks;
|
2019-06-23 03:35:23 -07:00
|
|
|
httpResponse?: express.Response;
|
|
|
|
httpRequest?: express.Request;
|
2019-12-19 14:07:55 -08:00
|
|
|
restApiUrl: string;
|
2019-06-23 03:35:23 -07:00
|
|
|
timezone: string;
|
|
|
|
webhookBaseUrl: string;
|
|
|
|
webhookTestBaseUrl: string;
|
2020-05-04 21:07:19 -07:00
|
|
|
currentNodeParameters? : INodeParameters;
|
2019-06-23 03:35:23 -07:00
|
|
|
}
|
|
|
|
|
2019-12-19 14:07:55 -08:00
|
|
|
export type WorkflowExecuteMode = 'cli' | 'error' | 'integrated' | 'internal' | 'manual' | 'retry' | 'trigger' | 'webhook';
|
|
|
|
|
|
|
|
export interface IWorkflowHooksOptionalParameters {
|
|
|
|
parentProcessMode?: string;
|
|
|
|
retryOf?: string;
|
|
|
|
sessionId?: string;
|
|
|
|
}
|
|
|
|
|
2019-06-23 03:35:23 -07:00
|
|
|
|
|
|
|
export interface IWorkflowSettings {
|
|
|
|
[key: string]: IDataObject | string | number | boolean | undefined;
|
|
|
|
}
|