@fsai-flow/workflow 0.0.2 → 0.1.0

package/project.json

@@ -1,19 +0,0 @@
-{
-  "name": "workflow",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "libs/workflow/src",
-  "projectType": "library",
-  "tags": [],
-  "targets": {
-    "build": {
-      "executor": "@nx/js:tsc",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "libs/workflow/dist",
-        "main": "libs/workflow/src/index.ts",
-        "tsConfig": "libs/workflow/tsconfig.lib.json",
-        "assets": ["libs/workflow/*.md"]
-      }
-    }
-  }
-}

package/src/index.ts

@@ -1,33 +0,0 @@
-import * as LoggerProxy from './lib/LoggerProxy';
-import * as NodeHelpers from './lib/NodeHelpers';
-import * as ObservableObject from './lib/ObservableObject';
-
-export * from './lib/MetadataUtils';
-
-export * from './lib/errors'
-export * from './lib/DeferredPromise';
-export * from './lib/Interfaces';
-export * from './lib/Expression';
-export * from './lib/NodeErrors';
-export * from './lib/Constants';
-export * from './lib/NodeHelpers';
-export * as TelemetryHelpers from './lib/TelemetryHelpers';
-export * from './lib/RoutingNode';
-export * from './lib/Workflow';
-export * from './lib/TypeValidation';
-export * from './lib/WorkflowDataProxy';
-export * from './lib/WorkflowErrors';
-export * from './lib/WorkflowHooks';
-export * from './lib/result';
-export {
-    LoggerProxy,
-    NodeHelpers,
-    ObservableObject
-};
-export {
-    updateDisplayOptions,
-    randomInt,
-    jsonParse,
-    jsonStringify,
-    replaceCircularReferences,
-} from './lib/utils';

package/src/lib/Constants.ts

@@ -1,124 +0,0 @@
-import { NodeConnectionType, NodeConnectionTypes } from "./Interfaces";
-
-export const DIGITS = '0123456789';
-export const UPPERCASE_LETTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
-export const LOWERCASE_LETTERS = UPPERCASE_LETTERS.toLowerCase();
-export const ALPHABET = [DIGITS, UPPERCASE_LETTERS, LOWERCASE_LETTERS].join('');
-
-export const BINARY_ENCODING = 'base64';
-export const WAIT_INDEFINITELY = new Date('3000-01-01T00:00:00.000Z');
-
-export const LOG_LEVELS = ['silent', 'error', 'warn', 'info', 'debug'] as const;
-
-export const CODE_LANGUAGES = ['javaScript', 'python'] as const;
-export const CODE_EXECUTION_MODES = ['runOnceForAllItems', 'runOnceForEachItem'] as const;
-
-// Arbitrary value to represent an empty credential value
-export const CREDENTIAL_EMPTY_VALUE = '__n8n_EMPTY_VALUE_7b1af746-3729-4c60-9b9b-e08eb29e58da';
-
-export const FORM_TRIGGER_PATH_IDENTIFIER = 'n8n-form';
-
-export const UNKNOWN_ERROR_MESSAGE = 'There was an unknown issue while executing the node';
-export const UNKNOWN_ERROR_DESCRIPTION =
-	'Double-check the node configuration and the service it connects to. Check the error details below and refer to the <a href="https://docs.n8n.io" target="_blank">n8n documentation</a> to troubleshoot the issue.';
-export const UNKNOWN_ERROR_MESSAGE_CRED = 'UNKNOWN ERROR';
-
-//n8n-nodes-base
-export const STICKY_NODE_TYPE = 'n8n-nodes-base.stickyNote';
-export const NO_OP_NODE_TYPE = 'n8n-nodes-base.noOp';
-export const HTTP_REQUEST_NODE_TYPE = 'n8n-nodes-base.httpRequest';
-export const WEBHOOK_NODE_TYPE = 'n8n-nodes-base.webhook';
-export const MANUAL_TRIGGER_NODE_TYPE = 'n8n-nodes-base.manualTrigger';
-export const ERROR_TRIGGER_NODE_TYPE = 'n8n-nodes-base.errorTrigger';
-export const START_NODE_TYPE = 'n8n-nodes-base.start';
-export const EXECUTE_WORKFLOW_NODE_TYPE = 'n8n-nodes-base.executeWorkflow';
-export const EXECUTE_WORKFLOW_TRIGGER_NODE_TYPE = 'n8n-nodes-base.executeWorkflowTrigger';
-export const CODE_NODE_TYPE = 'n8n-nodes-base.code';
-export const FUNCTION_NODE_TYPE = 'n8n-nodes-base.function';
-export const FUNCTION_ITEM_NODE_TYPE = 'n8n-nodes-base.functionItem';
-export const MERGE_NODE_TYPE = 'n8n-nodes-base.merge';
-export const AI_TRANSFORM_NODE_TYPE = 'n8n-nodes-base.aiTransform';
-export const FORM_NODE_TYPE = 'n8n-nodes-base.form';
-export const FORM_TRIGGER_NODE_TYPE = 'n8n-nodes-base.formTrigger';
-export const CHAT_TRIGGER_NODE_TYPE = '@n8n/n8n-nodes-langchain.chatTrigger';
-export const WAIT_NODE_TYPE = 'n8n-nodes-base.wait';
-
-export const ConnectionTypeDisplayNames: { [key in NodeConnectionType]: string } = {
-	[NodeConnectionTypes.Main]: 'Main',
-	[NodeConnectionTypes.AiAgent]: 'IA Agent',
-	[NodeConnectionTypes.AiChain]: 'Chain',
-	[NodeConnectionTypes.AiDocument]: 'Document',
-	[NodeConnectionTypes.AiEmbedding]: 'Embedding',
-	[NodeConnectionTypes.AiLanguageModel]: 'Model',
-	[NodeConnectionTypes.AiMemory]: 'Memory',
-	[NodeConnectionTypes.AiOutputParser]: 'Output Parser',
-	[NodeConnectionTypes.AiRetriever]: 'Retriever',
-	[NodeConnectionTypes.AiTextSplitter]: 'Text Splitter',
-	[NodeConnectionTypes.AiTool]: 'Tool',
-	[NodeConnectionTypes.AiVectorStore]: 'Vector Store',
-};
-
-export const STARTING_NODE_TYPES = [
-	MANUAL_TRIGGER_NODE_TYPE,
-	EXECUTE_WORKFLOW_TRIGGER_NODE_TYPE,
-	ERROR_TRIGGER_NODE_TYPE,
-	START_NODE_TYPE,
-];
-
-export const SCRIPTING_NODE_TYPES = [
-	FUNCTION_NODE_TYPE,
-	FUNCTION_ITEM_NODE_TYPE,
-	CODE_NODE_TYPE,
-	AI_TRANSFORM_NODE_TYPE,
-];
-
-export const ADD_FORM_NOTICE = 'addFormPage';
-
-/**
- * Nodes whose parameter values may refer to other nodes without expressions.
- * Their content may need to be updated when the referenced node is renamed.
- */
-export const NODES_WITH_RENAMABLE_CONTENT = new Set([
-	CODE_NODE_TYPE,
-	FUNCTION_NODE_TYPE,
-	FUNCTION_ITEM_NODE_TYPE,
-	AI_TRANSFORM_NODE_TYPE,
-]);
-
-//@n8n/n8n-nodes-langchain
-export const MANUAL_CHAT_TRIGGER_LANGCHAIN_NODE_TYPE = '@n8n/n8n-nodes-langchain.manualChatTrigger';
-export const AGENT_LANGCHAIN_NODE_TYPE = '@n8n/n8n-nodes-langchain.agent';
-export const CHAIN_LLM_LANGCHAIN_NODE_TYPE = '@n8n/n8n-nodes-langchain.chainLlm';
-export const OPENAI_LANGCHAIN_NODE_TYPE = '@n8n/n8n-nodes-langchain.openAi';
-export const CHAIN_SUMMARIZATION_LANGCHAIN_NODE_TYPE =
-	'@n8n/n8n-nodes-langchain.chainSummarization';
-export const CODE_TOOL_LANGCHAIN_NODE_TYPE = '@n8n/n8n-nodes-langchain.toolCode';
-export const WORKFLOW_TOOL_LANGCHAIN_NODE_TYPE = '@n8n/n8n-nodes-langchain.toolWorkflow';
-export const HTTP_REQUEST_TOOL_LANGCHAIN_NODE_TYPE = '@n8n/n8n-nodes-langchain.toolHttpRequest';
-
-export const LANGCHAIN_CUSTOM_TOOLS = [
-	CODE_TOOL_LANGCHAIN_NODE_TYPE,
-	WORKFLOW_TOOL_LANGCHAIN_NODE_TYPE,
-	HTTP_REQUEST_TOOL_LANGCHAIN_NODE_TYPE,
-];
-
-export const SEND_AND_WAIT_OPERATION = 'sendAndWait';
-export const AI_TRANSFORM_CODE_GENERATED_FOR_PROMPT = 'codeGeneratedForPrompt';
-export const AI_TRANSFORM_JS_CODE = 'jsCode';
-
-/**
- * Key for an item standing in for a manual execution data item too large to be
- * sent live via pubsub. See {@link TRIMMED_TASK_DATA_CONNECTIONS} in constants
- * in `cli` package.
- */
-export const TRIMMED_TASK_DATA_CONNECTIONS_KEY = '__isTrimmedManualExecutionDataItem';
-
-export const OPEN_AI_API_CREDENTIAL_TYPE = 'openAiApi';
-export const FREE_AI_CREDITS_ERROR_TYPE = 'free_ai_credits_request_error';
-export const FREE_AI_CREDITS_USED_ALL_CREDITS_ERROR_CODE = 400;
-
-export const FROM_AI_AUTO_GENERATED_MARKER = '/*n8n-auto-generated-fromAI-override*/';
-
-export const PROJECT_ROOT = '0';
-
-export const WAITING_FORMS_EXECUTION_STATUS = 'n8n-execution-status';

package/src/lib/DeferredPromise.ts

@@ -1,14 +0,0 @@
-// From: https://gist.github.com/compulim/8b49b0a744a3eeb2205e2b9506201e50
-export interface IDeferredPromise<T> {
-	promise: () => Promise<T>;
-	reject: (error: Error) => void;
-	resolve: (result: T) => void;
-}
-
-export async function createDeferredPromise<T>(): Promise<IDeferredPromise<T>> {
-	return new Promise<IDeferredPromise<T>>((resolveCreate) => {
-		const promise = new Promise<T>((resolve, reject) => {
-			resolveCreate({ promise: async () => promise, resolve, reject });
-		});
-	});
-}

package/src/lib/Expression.ts

@@ -1,375 +0,0 @@
-// @ts-ignore
-import * as tmpl from 'riot-tmpl';
-import { DateTime, Duration, Interval } from 'luxon';
-
-// eslint-disable-next-line import/no-cycle
-import {
-	INode,
-	INodeExecutionData,
-	INodeParameters,
-	IRunExecutionData,
-	IWorkflowDataProxyAdditionalKeys,
-	NodeParameterValue,
-	Workflow,
-	WorkflowDataProxy,
-	WorkflowExecuteMode,
-} from '..';
-
-// @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 = () => { };
-
-export class Expression {
-	workflow: Workflow;
-
-	constructor(workflow: 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: object): string {
-		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: NodeParameterValue,
-		siblingParameters: INodeParameters,
-		runExecutionData: IRunExecutionData | null,
-		runIndex: number,
-		itemIndex: number,
-		activeNodeName: string,
-		connectionInputData: INodeExecutionData[],
-		mode: WorkflowExecuteMode,
-		additionalKeys: IWorkflowDataProxyAdditionalKeys,
-		returnObjectAsString = false,
-		selfData = {},
-	): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] {
-		// 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 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 = DateTime;
-		data['Interval'] = Interval;
-		data['Duration'] = 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 "()"');
-			} else 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: any) {
-			// eslint-disable-next-line @typescript-eslint/restrict-template-expressions, @typescript-eslint/no-unsafe-member-access
-			throw new Error(`Expression is not valid: ${e.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: INode,
-		parameterValue: string | boolean | undefined,
-		mode: WorkflowExecuteMode,
-		additionalKeys: IWorkflowDataProxyAdditionalKeys,
-		defaultValue?: boolean | number | string,
-	): boolean | number | string | undefined {
-		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: INodeExecutionData[] = [];
-		const runData: IRunExecutionData = {
-			resultData: {
-				runData: {},
-			},
-		};
-
-		return this.getParameterValue(
-			parameterValue,
-			runData,
-			runIndex,
-			itemIndex,
-			node.name,
-			connectionInputData,
-			mode,
-			additionalKeys,
-		) as boolean | number | string | undefined;
-	}
-
-	/**
-	 * 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: INode,
-		parameterValue: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[],
-		mode: WorkflowExecuteMode,
-		additionalKeys: IWorkflowDataProxyAdditionalKeys,
-		defaultValue:
-			| NodeParameterValue
-			| INodeParameters
-			| NodeParameterValue[]
-			| INodeParameters[]
-			| undefined = undefined,
-		selfData = {},
-	): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] | undefined {
-		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: INodeExecutionData[] = [];
-		const runData: IRunExecutionData = {
-			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: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[],
-		runExecutionData: IRunExecutionData | null,
-		runIndex: number,
-		itemIndex: number,
-		activeNodeName: string,
-		connectionInputData: INodeExecutionData[],
-		mode: WorkflowExecuteMode,
-		additionalKeys: IWorkflowDataProxyAdditionalKeys,
-		returnObjectAsString = false,
-		selfData = {},
-	): NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[] {
-		// Helper function which returns true when the parameter is a complex one or array
-		const isComplexParameter = (
-			value: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[],
-		) => {
-			return typeof value === 'object';
-		};
-
-		// Helper function which resolves a parameter value depending on if it is simply or not
-		const resolveParameterValue = (
-			value: NodeParameterValue | INodeParameters | NodeParameterValue[] | INodeParameters[],
-			siblingParameters: INodeParameters,
-		) => {
-			if (isComplexParameter(value)) {
-				return this.getParameterValue(
-					value,
-					runExecutionData,
-					runIndex,
-					itemIndex,
-					activeNodeName,
-					connectionInputData,
-					mode,
-					additionalKeys,
-					returnObjectAsString,
-					selfData,
-				);
-			}
-			return this.resolveSimpleParameterValue(
-				value as NodeParameterValue,
-				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 as NodeParameterValue,
-				{},
-				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 as NodeParameterValue[] | INodeParameters[];
-		}
-		if (parameterValue === null || parameterValue === undefined) {
-			return parameterValue;
-		}
-		// Data is an object
-		const returnData: INodeParameters = {};
-		// eslint-disable-next-line no-restricted-syntax
-		for (const key of Object.keys(parameterValue)) {
-			returnData[key] = resolveParameterValue(
-				(parameterValue as INodeParameters)[key],
-				parameterValue as INodeParameters,
-			);
-		}
-
-		if (returnObjectAsString && typeof returnData === 'object') {
-			return this.convertObjectValueToString(returnData);
-		}
-		return returnData;
-	}
-}