@atom8n/n8n-core 2.2.0

package/README.md

@@ -0,0 +1,13 @@
+![n8n.io - Workflow Automation](https://user-images.githubusercontent.com/65276001/173571060-9f2f6d7b-bac0-43b6-bdb2-001da9694058.png)
+
+# n8n-core
+
+Core components for n8n
+
+```
+npm install n8n-core
+```
+
+## License
+
+You can find the license information [here](https://github.com/n8n-io/n8n/blob/master/README.md#license)

package/bin/common.js

@@ -0,0 +1,19 @@
+const path = require('path');
+const { mkdir, writeFile } = require('fs/promises');
+
+const packageDir = process.cwd();
+const distDir = path.join(packageDir, 'dist');
+
+const writeJSON = async (file, data) => {
+	const filePath = path.resolve(distDir, file);
+	await mkdir(path.dirname(filePath), { recursive: true });
+	const payload = Array.isArray(data)
+		? `[\n${data.map((entry) => JSON.stringify(entry)).join(',\n')}\n]`
+		: JSON.stringify(data, null, 2);
+	await writeFile(filePath, payload, { encoding: 'utf-8' });
+};
+
+module.exports = {
+	packageDir,
+	writeJSON,
+};

package/bin/copy-static-files

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+const glob = require('fast-glob');
+const pLimit = require('p-limit');
+const { cp } = require('fs/promises');
+const { packageDir } = require('./common');
+
+const limiter = pLimit(20);
+const staticFiles = glob.sync(
+	['{nodes,credentials}/**/*.{png,svg}', 'nodes/**/__schema__/**/*.json'],
+	{
+		cwd: packageDir,
+	},
+);
+
+(async () => {
+	await Promise.all(
+		staticFiles.map((path) =>
+			limiter(() => {
+				return cp(path, `dist/${path}`, { recursive: true });
+			}),
+		),
+	);
+})();

package/bin/generate-metadata

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+
+const { LoggerProxy } = require('n8n-workflow');
+const { PackageDirectoryLoader } = require('../dist/nodes-loader/package-directory-loader');
+const { packageDir, writeJSON } = require('./common');
+
+LoggerProxy.init(console);
+
+function findReferencedMethods(obj, refs = {}, latestName = '') {
+	for (const key in obj) {
+		if (key === 'name' && 'group' in obj) {
+			latestName = obj[key];
+		}
+
+		if (typeof obj[key] === 'object') {
+			findReferencedMethods(obj[key], refs, latestName);
+		}
+
+		if (key === 'loadOptionsMethod') {
+			refs[latestName] = refs[latestName]
+				? [...new Set([...refs[latestName], obj[key]])]
+				: [obj[key]];
+		}
+	}
+
+	return refs;
+}
+
+(async () => {
+	const loader = new PackageDirectoryLoader(packageDir);
+	await loader.loadAll();
+
+	const loaderNodeTypes = Object.values(loader.nodeTypes);
+
+	const definedMethods = loaderNodeTypes.reduce((acc, cur) => {
+		loader.getVersionedNodeTypeAll(cur.type).forEach((type) => {
+			const methods = type.description?.__loadOptionsMethods;
+
+			if (!methods) return;
+
+			const { name } = type.description;
+
+			if (acc[name]) {
+				acc[name] = [...new Set([...acc[name], ...methods])];
+				return;
+			}
+
+			acc[name] = methods;
+		});
+
+		return acc;
+	}, {});
+
+	const nodeTypes = loaderNodeTypes
+		.map(({ type }) => type)
+		.flatMap((nodeType) =>
+			loader.getVersionedNodeTypeAll(nodeType).map((item) => {
+				const { __loadOptionsMethods, ...rest } = item.description;
+				return rest;
+			}),
+		);
+
+	const knownCredentials = loader.known.credentials;
+	const credentialTypes = Object.values(loader.credentialTypes).map(({ type }) => type);
+	const referencedMethods = findReferencedMethods(nodeTypes);
+
+	await Promise.all([
+		writeJSON('known/nodes.json', loader.known.nodes),
+		writeJSON('known/credentials.json', loader.known.credentials),
+		writeJSON('types/credentials.json', credentialTypes),
+		writeJSON('types/nodes.json', nodeTypes),
+		writeJSON('methods/defined.json', definedMethods),
+		writeJSON('methods/referenced.json', referencedMethods),
+	]);
+})();

package/bin/generate-translations

@@ -0,0 +1,99 @@
+#!/usr/bin/env node
+
+const {
+	existsSync,
+	promises: { writeFile },
+} = require('fs');
+const path = require('path');
+const { packageDir } = require('./common');
+
+const ALLOWED_HEADER_KEYS = ['displayName', 'description'];
+const PURPLE_ANSI_COLOR_CODE = 35;
+
+function getNodeTranslationPaths() {
+	const nodeDistPaths = require(`${packageDir}/package.json`).n8n.nodes;
+	const { N8N_DEFAULT_LOCALE: locale } = process.env;
+
+	return nodeDistPaths.reduce((acc, cur) => {
+		const nodeTranslationPath = path.join(
+			packageDir,
+			cur.split('/').slice(1, -1).join('/'),
+			'translations',
+			locale,
+			toTranslationFile(cur),
+		);
+
+		if (existsSync(nodeTranslationPath)) {
+			acc.push(nodeTranslationPath);
+		}
+
+		return acc;
+	}, []);
+}
+
+function getHeaders(nodeTranslationPaths) {
+	return nodeTranslationPaths.reduce((acc, cur) => {
+		const { header } = require(cur);
+		const nodeType = cur.split('/').pop().replace('.json', '');
+
+		if (isValidHeader(header, ALLOWED_HEADER_KEYS)) {
+			acc[nodeType] = header;
+		}
+
+		return acc;
+	}, {});
+}
+
+// ----------------------------------
+//             helpers
+// ----------------------------------
+
+function toTranslationFile(distPath) {
+	const raw = distPath.split('/').pop().replace('.node', '') + 'on';
+	return raw.charAt(0).toLowerCase() + raw.slice(1);
+}
+
+function isValidHeader(header, allowedHeaderKeys) {
+	if (!header) return false;
+
+	const headerKeys = Object.keys(header);
+
+	return headerKeys.length > 0 && headerKeys.every((key) => allowedHeaderKeys.includes(key));
+}
+
+function writeDistFile(data, distPath) {
+	writeFile(distPath, `module.exports = ${JSON.stringify(data, null, 2)}`);
+}
+
+const log = (string, { bulletPoint } = { bulletPoint: false }) => {
+	if (bulletPoint) {
+		process.stdout.write(colorize(PURPLE_ANSI_COLOR_CODE, `- ${string}\n`));
+		return;
+	}
+
+	process.stdout.write(`${string}\n`);
+};
+
+const colorize = (ansiColorCode, string) =>
+	['\033[', ansiColorCode, 'm', string, '\033[0m'].join('');
+
+/**
+ * Write node translation headers to single file at `/dist/nodes/headers.js`.
+ */
+const { N8N_DEFAULT_LOCALE: locale } = process.env;
+
+log(`Default locale set to: ${colorize(PURPLE_ANSI_COLOR_CODE, locale || 'en')}`);
+
+if (!locale || locale === 'en') {
+	log('No translation required - Skipping translations build...');
+	return;
+}
+
+const nodeTranslationPaths = getNodeTranslationPaths();
+const headers = getHeaders(nodeTranslationPaths);
+const headersDistPath = path.join(packageDir, 'dist', 'nodes', 'headers.js');
+
+writeDistFile(headers, headersDistPath);
+
+log('Headers file written to:');
+log(headersDistPath, { bulletPoint: true });

package/dist/binary-data/binary-data.config.d.ts

@@ -0,0 +1,15 @@
+import { ExecutionsConfig } from '@n8n/config';
+import { z } from 'zod';
+import { InstanceSettings } from '../instance-settings';
+export declare const BINARY_DATA_MODES: readonly ["default", "filesystem", "s3", "database"];
+declare const binaryDataModesSchema: z.ZodEnum<["default", "filesystem", "s3", "database"]>;
+declare const availableModesSchema: z.ZodPipeline<z.ZodEffects<z.ZodString, string[], string>, z.ZodArray<z.ZodEnum<["default", "filesystem", "s3", "database"]>, "many">>;
+export declare class BinaryDataConfig {
+    availableModes: z.infer<typeof availableModesSchema>;
+    mode: z.infer<typeof binaryDataModesSchema>;
+    localStoragePath: string;
+    signingSecret: string;
+    dbMaxFileSize: number;
+    constructor({ encryptionKey, n8nFolder }: InstanceSettings, executionsConfig: ExecutionsConfig);
+}
+export {};

package/dist/binary-data/binary-data.config.js

@@ -0,0 +1,62 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BinaryDataConfig = exports.BINARY_DATA_MODES = void 0;
+const config_1 = require("@n8n/config");
+const node_crypto_1 = require("node:crypto");
+const node_path_1 = __importDefault(require("node:path"));
+const zod_1 = require("zod");
+const instance_settings_1 = require("../instance-settings");
+exports.BINARY_DATA_MODES = ['default', 'filesystem', 's3', 'database'];
+const binaryDataModesSchema = zod_1.z.enum(exports.BINARY_DATA_MODES);
+const availableModesSchema = zod_1.z
+    .string()
+    .transform((value) => value.split(','))
+    .pipe(binaryDataModesSchema.array());
+const dbMaxFileSizeSchema = zod_1.z
+    .number()
+    .max(1024, 'Binary data max file size in `database` mode cannot exceed 1024 MiB');
+let BinaryDataConfig = class BinaryDataConfig {
+    constructor({ encryptionKey, n8nFolder }, executionsConfig) {
+        this.availableModes = ['filesystem', 's3', 'database'];
+        this.dbMaxFileSize = 512;
+        this.localStoragePath = node_path_1.default.join(n8nFolder, 'binaryData');
+        this.signingSecret = (0, node_crypto_1.createHash)('sha256')
+            .update(`url-signing:${encryptionKey}`)
+            .digest('base64');
+        this.mode ??= executionsConfig.mode === 'queue' ? 'database' : 'filesystem';
+    }
+};
+exports.BinaryDataConfig = BinaryDataConfig;
+__decorate([
+    (0, config_1.Env)('N8N_DEFAULT_BINARY_DATA_MODE', binaryDataModesSchema),
+    __metadata("design:type", void 0)
+], BinaryDataConfig.prototype, "mode", void 0);
+__decorate([
+    (0, config_1.Env)('N8N_BINARY_DATA_STORAGE_PATH'),
+    __metadata("design:type", String)
+], BinaryDataConfig.prototype, "localStoragePath", void 0);
+__decorate([
+    (0, config_1.Env)('N8N_BINARY_DATA_SIGNING_SECRET'),
+    __metadata("design:type", String)
+], BinaryDataConfig.prototype, "signingSecret", void 0);
+__decorate([
+    (0, config_1.Env)('N8N_BINARY_DATA_DATABASE_MAX_FILE_SIZE', dbMaxFileSizeSchema),
+    __metadata("design:type", Number)
+], BinaryDataConfig.prototype, "dbMaxFileSize", void 0);
+exports.BinaryDataConfig = BinaryDataConfig = __decorate([
+    config_1.Config,
+    __metadata("design:paramtypes", [instance_settings_1.InstanceSettings, config_1.ExecutionsConfig])
+], BinaryDataConfig);
+//# sourceMappingURL=binary-data.config.js.map

package/dist/binary-data/binary-data.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary-data.config.js","sourceRoot":"","sources":["../../src/binary-data/binary-data.config.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,wCAA4D;AAC5D,6CAAyC;AACzC,0DAA6B;AAC7B,6BAAwB;AAExB,2DAAuD;AAE1C,QAAA,iBAAiB,GAAG,CAAC,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,CAAU,CAAC;AAEtF,MAAM,qBAAqB,GAAG,OAAC,CAAC,IAAI,CAAC,yBAAiB,CAAC,CAAC;AAExD,MAAM,oBAAoB,GAAG,OAAC;KAC5B,MAAM,EAAE;KACR,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KACtC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC,CAAC;AAEtC,MAAM,mBAAmB,GAAG,OAAC;KAC3B,MAAM,EAAE;KACR,GAAG,CAAC,IAAI,EAAE,qEAAqE,CAAC,CAAC;AAG5E,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAuB5B,YAAY,EAAE,aAAa,EAAE,SAAS,EAAoB,EAAE,gBAAkC;QArB9F,mBAAc,GAAyC,CAAC,YAAY,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAmBxF,kBAAa,GAAW,GAAG,CAAC;QAG3B,IAAI,CAAC,gBAAgB,GAAG,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa,GAAG,IAAA,wBAAU,EAAC,QAAQ,CAAC;aACvC,MAAM,CAAC,eAAe,aAAa,EAAE,CAAC;aACtC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEnB,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC;IAC7E,CAAC;CACD,CAAA;AA/BY,4CAAgB;AAM5B;IADC,IAAA,YAAG,EAAC,8BAA8B,EAAE,qBAAqB,CAAC;;8CACd;AAI7C;IADC,IAAA,YAAG,EAAC,8BAA8B,CAAC;;0DACX;AAOzB;IADC,IAAA,YAAG,EAAC,gCAAgC,CAAC;;uDAChB;AAItB;IADC,IAAA,YAAG,EAAC,wCAAwC,EAAE,mBAAmB,CAAC;;uDACvC;2BArBhB,gBAAgB;IAD5B,eAAM;qCAwBoC,oCAAgB,EAAoB,yBAAgB;GAvBlF,gBAAgB,CA+B5B"}

package/dist/binary-data/binary-data.service.d.ts

@@ -0,0 +1,32 @@
+import { Logger } from '@n8n/backend-common';
+import type { StringValue as TimeUnitValue } from 'ms';
+import type { INodeExecutionData, IBinaryData } from 'n8n-workflow';
+import type { Readable } from 'stream';
+import { ErrorReporter } from '../errors';
+import { BinaryDataConfig } from './binary-data.config';
+import type { BinaryData } from './types';
+export declare class BinaryDataService {
+    private readonly config;
+    private readonly errorReporter;
+    private readonly logger;
+    private mode;
+    private managers;
+    constructor(config: BinaryDataConfig, errorReporter: ErrorReporter, logger: Logger);
+    setManager(mode: BinaryData.ServiceMode, manager: BinaryData.Manager): void;
+    init(): Promise<void>;
+    createSignedToken(binaryData: IBinaryData, expiresIn?: TimeUnitValue): string;
+    validateSignedToken(token: string): string;
+    copyBinaryFile(location: BinaryData.FileLocation, binaryData: IBinaryData, filePath: string): Promise<IBinaryData>;
+    store(location: BinaryData.FileLocation, bufferOrStream: Buffer | Readable, binaryData: IBinaryData): Promise<IBinaryData>;
+    getAsStream(binaryDataId: string, chunkSize?: number): Promise<Readable>;
+    getAsBuffer(binaryData: IBinaryData): Promise<Buffer<ArrayBufferLike>>;
+    getPath(binaryDataId: string): string;
+    getMetadata(binaryDataId: string): Promise<BinaryData.Metadata>;
+    deleteMany(locations: BinaryData.FileLocation[]): Promise<void>;
+    deleteManyByBinaryDataId(ids: string[]): Promise<void>;
+    duplicateBinaryData(location: BinaryData.FileLocation, inputData: Array<INodeExecutionData[] | null>): Promise<INodeExecutionData[][]>;
+    rename(oldFileId: string, newFileId: string): Promise<void>;
+    private createBinaryDataId;
+    private duplicateBinaryDataInExecData;
+    private getManager;
+}

package/dist/binary-data/binary-data.service.js

@@ -0,0 +1,243 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BinaryDataService = void 0;
+const backend_common_1 = require("@n8n/backend-common");
+const di_1 = require("@n8n/di");
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const n8n_workflow_1 = require("n8n-workflow");
+const promises_1 = require("node:fs/promises");
+const pretty_bytes_1 = __importDefault(require("pretty-bytes"));
+const errors_1 = require("../errors");
+const binary_data_config_1 = require("./binary-data.config");
+const utils_1 = require("./utils");
+const invalid_manager_error_1 = require("../errors/invalid-manager.error");
+let BinaryDataService = class BinaryDataService {
+    constructor(config, errorReporter, logger) {
+        this.config = config;
+        this.errorReporter = errorReporter;
+        this.logger = logger;
+        this.mode = 'filesystem-v2';
+        this.managers = {};
+    }
+    setManager(mode, manager) {
+        this.managers[mode] = manager;
+    }
+    async init() {
+        const { config } = this;
+        this.mode = config.mode === 'filesystem' ? 'filesystem-v2' : config.mode;
+        const { FileSystemManager } = await Promise.resolve().then(() => __importStar(require('./file-system.manager')));
+        this.managers.filesystem = new FileSystemManager(config.localStoragePath, this.errorReporter);
+        this.managers['filesystem-v2'] = this.managers.filesystem;
+        await this.managers.filesystem.init();
+    }
+    createSignedToken(binaryData, expiresIn = '1 day') {
+        if (!binaryData.id) {
+            throw new n8n_workflow_1.UnexpectedError('URL signing is not available in memory mode');
+        }
+        const signingPayload = {
+            id: binaryData.id,
+        };
+        const { signingSecret } = this.config;
+        return jsonwebtoken_1.default.sign(signingPayload, signingSecret, { expiresIn });
+    }
+    validateSignedToken(token) {
+        const { signingSecret } = this.config;
+        const signedPayload = jsonwebtoken_1.default.verify(token, signingSecret);
+        return signedPayload.id;
+    }
+    async copyBinaryFile(location, binaryData, filePath) {
+        const manager = this.managers[this.mode];
+        if (!manager) {
+            const { size } = await (0, promises_1.stat)(filePath);
+            binaryData.fileSize = (0, pretty_bytes_1.default)(size);
+            binaryData.data = await (0, promises_1.readFile)(filePath, { encoding: n8n_workflow_1.BINARY_ENCODING });
+            return binaryData;
+        }
+        const metadata = {
+            fileName: binaryData.fileName,
+            mimeType: binaryData.mimeType,
+        };
+        const { fileId, fileSize } = await manager.copyByFilePath(location, filePath, metadata);
+        binaryData.id = this.createBinaryDataId(fileId);
+        binaryData.fileSize = (0, pretty_bytes_1.default)(fileSize);
+        binaryData.data = this.mode;
+        return binaryData;
+    }
+    async store(location, bufferOrStream, binaryData) {
+        const manager = this.managers[this.mode];
+        if (!manager) {
+            const buffer = await (0, utils_1.binaryToBuffer)(bufferOrStream);
+            binaryData.data = buffer.toString(n8n_workflow_1.BINARY_ENCODING);
+            binaryData.fileSize = (0, pretty_bytes_1.default)(buffer.length);
+            return binaryData;
+        }
+        const metadata = {
+            fileName: binaryData.fileName,
+            mimeType: binaryData.mimeType,
+        };
+        const { fileId, fileSize } = await manager.store(location, bufferOrStream, metadata);
+        binaryData.id = this.createBinaryDataId(fileId);
+        binaryData.fileSize = (0, pretty_bytes_1.default)(fileSize);
+        binaryData.data = this.mode;
+        return binaryData;
+    }
+    async getAsStream(binaryDataId, chunkSize) {
+        const [mode, fileId] = binaryDataId.split(':');
+        return await this.getManager(mode).getAsStream(fileId, chunkSize);
+    }
+    async getAsBuffer(binaryData) {
+        if (binaryData.id) {
+            const [mode, fileId] = binaryData.id.split(':');
+            return await this.getManager(mode).getAsBuffer(fileId);
+        }
+        return Buffer.from(binaryData.data, n8n_workflow_1.BINARY_ENCODING);
+    }
+    getPath(binaryDataId) {
+        const [mode, fileId] = binaryDataId.split(':');
+        return this.getManager(mode).getPath(fileId);
+    }
+    async getMetadata(binaryDataId) {
+        const [mode, fileId] = binaryDataId.split(':');
+        return await this.getManager(mode).getMetadata(fileId);
+    }
+    async deleteMany(locations) {
+        const manager = this.managers[this.mode];
+        if (!manager)
+            return;
+        if (manager.deleteMany)
+            await manager.deleteMany(locations);
+    }
+    async deleteManyByBinaryDataId(ids) {
+        const fileIdsByMode = new Map();
+        for (const attachmentId of ids) {
+            const [mode, fileId] = attachmentId.split(':');
+            if (!fileId) {
+                continue;
+            }
+            const entry = fileIdsByMode.get(mode) ?? [];
+            fileIdsByMode.set(mode, entry.concat([fileId]));
+        }
+        for (const [mode, fileIds] of fileIdsByMode) {
+            const manager = this.managers[mode];
+            if (!manager) {
+                this.logger.info(`File manager of mode ${mode} is missing. Skip deleting these files: ${fileIds.join(', ')}`);
+                continue;
+            }
+            await manager.deleteManyByFileId?.(fileIds);
+        }
+    }
+    async duplicateBinaryData(location, inputData) {
+        if (inputData && this.managers[this.mode]) {
+            const returnInputData = inputData.map(async (executionDataArray) => {
+                if (executionDataArray) {
+                    return await Promise.all(executionDataArray.map(async (executionData) => {
+                        if (executionData.binary) {
+                            return await this.duplicateBinaryDataInExecData(location, executionData);
+                        }
+                        return executionData;
+                    }));
+                }
+                return executionDataArray;
+            });
+            return await Promise.all(returnInputData);
+        }
+        return inputData;
+    }
+    async rename(oldFileId, newFileId) {
+        const manager = this.getManager(this.mode);
+        if (!manager)
+            return;
+        await manager.rename(oldFileId, newFileId);
+    }
+    createBinaryDataId(fileId) {
+        return `${this.mode}:${fileId}`;
+    }
+    async duplicateBinaryDataInExecData(location, executionData) {
+        const manager = this.managers[this.mode];
+        if (executionData.binary) {
+            const binaryDataKeys = Object.keys(executionData.binary);
+            const bdPromises = binaryDataKeys.map(async (key) => {
+                if (!executionData.binary) {
+                    return { key, newId: undefined };
+                }
+                const binaryDataId = executionData.binary[key].id;
+                if (!binaryDataId) {
+                    return { key, newId: undefined };
+                }
+                const [_mode, fileId] = binaryDataId.split(':');
+                return await manager?.copyByFileId(location, fileId).then((newFileId) => ({
+                    newId: this.createBinaryDataId(newFileId),
+                    key,
+                }));
+            });
+            return await Promise.all(bdPromises).then((b) => {
+                return b.reduce((acc, curr) => {
+                    if (acc.binary && curr) {
+                        acc.binary[curr.key].id = curr.newId;
+                    }
+                    return acc;
+                }, executionData);
+            });
+        }
+        return executionData;
+    }
+    getManager(mode) {
+        const manager = this.managers[mode];
+        if (manager)
+            return manager;
+        throw new invalid_manager_error_1.InvalidManagerError(mode);
+    }
+};
+exports.BinaryDataService = BinaryDataService;
+exports.BinaryDataService = BinaryDataService = __decorate([
+    (0, di_1.Service)(),
+    __metadata("design:paramtypes", [binary_data_config_1.BinaryDataConfig,
+        errors_1.ErrorReporter,
+        backend_common_1.Logger])
+], BinaryDataService);
+//# sourceMappingURL=binary-data.service.js.map

package/dist/binary-data/binary-data.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary-data.service.js","sourceRoot":"","sources":["../../src/binary-data/binary-data.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wDAA6C;AAC7C,gCAAkC;AAClC,gEAA+B;AAE/B,+CAAgE;AAEhE,+CAAkD;AAClD,gEAAuC;AAGvC,qCAAyC;AAEzC,6DAAwD;AAExD,mCAAyC;AACzC,2EAAsE;AAG/D,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAK7B,YACkB,MAAwB,EACxB,aAA4B,EAC5B,MAAc;QAFd,WAAM,GAAN,MAAM,CAAkB;QACxB,kBAAa,GAAb,aAAa,CAAe;QAC5B,WAAM,GAAN,MAAM,CAAQ;QAPxB,SAAI,GAA2B,eAAe,CAAC;QAE/C,aAAQ,GAAuC,EAAE,CAAC;IAMvD,CAAC;IAEJ,UAAU,CAAC,IAA4B,EAAE,OAA2B;QACnE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,IAAI;QACT,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAExB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QAEzE,MAAM,EAAE,iBAAiB,EAAE,GAAG,wDAAa,uBAAuB,GAAC,CAAC;QACpE,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,IAAI,iBAAiB,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;QAC1D,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;IAGvC,CAAC;IAED,iBAAiB,CAAC,UAAuB,EAAE,YAA2B,OAAO;QAC5E,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;YACpB,MAAM,IAAI,8BAAe,CAAC,6CAA6C,CAAC,CAAC;QAC1E,CAAC;QAED,MAAM,cAAc,GAA8B;YACjD,EAAE,EAAE,UAAU,CAAC,EAAE;SACjB,CAAC;QAEF,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QACtC,OAAO,sBAAG,CAAC,IAAI,CAAC,cAAc,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,mBAAmB,CAAC,KAAa;QAChC,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QACtC,MAAM,aAAa,GAAG,sBAAG,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAA8B,CAAC;QACpF,OAAO,aAAa,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,cAAc,CACnB,QAAiC,EACjC,UAAuB,EACvB,QAAgB;QAEhB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEzC,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAA,eAAI,EAAC,QAAQ,CAAC,CAAC;YACtC,UAAU,CAAC,QAAQ,GAAG,IAAA,sBAAW,EAAC,IAAI,CAAC,CAAC;YACxC,UAAU,CAAC,IAAI,GAAG,MAAM,IAAA,mBAAQ,EAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,8BAAe,EAAE,CAAC,CAAC;YAE1E,OAAO,UAAU,CAAC;QACnB,CAAC;QAED,MAAM,QAAQ,GAAG;YAChB,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,QAAQ,EAAE,UAAU,CAAC,QAAQ;SAC7B,CAAC;QAEF,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAExF,UAAU,CAAC,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAChD,UAAU,CAAC,QAAQ,GAAG,IAAA,sBAAW,EAAC,QAAQ,CAAC,CAAC;QAC5C,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAE5B,OAAO,UAAU,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,KAAK,CACV,QAAiC,EACjC,cAAiC,EACjC,UAAuB;QAEvB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEzC,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAc,EAAC,cAAc,CAAC,CAAC;YACpD,UAAU,CAAC,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,8BAAe,CAAC,CAAC;YACnD,UAAU,CAAC,QAAQ,GAAG,IAAA,sBAAW,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAEjD,OAAO,UAAU,CAAC;QACnB,CAAC;QAED,MAAM,QAAQ,GAAG;YAChB,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,QAAQ,EAAE,UAAU,CAAC,QAAQ;SAC7B,CAAC;QAEF,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;QAErF,UAAU,CAAC,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAChD,UAAU,CAAC,QAAQ,GAAG,IAAA,sBAAW,EAAC,QAAQ,CAAC,CAAC;QAC5C,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAE5B,OAAO,UAAU,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,YAAoB,EAAE,SAAkB;QACzD,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE/C,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,UAAuB;QACxC,IAAI,UAAU,CAAC,EAAE,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEhD,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QACxD,CAAC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,8BAAe,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,CAAC,YAAoB;QAC3B,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,YAAoB;QACrC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE/C,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,SAAoC;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEzC,IAAI,CAAC,OAAO;YAAE,OAAO;QAErB,IAAI,OAAO,CAAC,UAAU;YAAE,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,wBAAwB,CAAC,GAAa;QAC3C,MAAM,aAAa,GAAG,IAAI,GAAG,EAAoB,CAAC;QAElD,KAAK,MAAM,YAAY,IAAI,GAAG,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAE/C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACb,SAAS;YACV,CAAC;YAED,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAE5C,aAAa,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC;QAED,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,aAAa,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAEpC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACd,IAAI,CAAC,MAAM,CAAC,IAAI,CACf,wBAAwB,IAAI,2CAA2C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC3F,CAAC;gBACF,SAAS;YACV,CAAC;YAED,MAAM,OAAO,CAAC,kBAAkB,EAAE,CAAC,OAAO,CAAC,CAAC;QAC7C,CAAC;IACF,CAAC;IAED,KAAK,CAAC,mBAAmB,CACxB,QAAiC,EACjC,SAA6C;QAE7C,IAAI,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,eAAe,GAAI,SAAoC,CAAC,GAAG,CAChE,KAAK,EAAE,kBAAkB,EAAE,EAAE;gBAC5B,IAAI,kBAAkB,EAAE,CAAC;oBACxB,OAAO,MAAM,OAAO,CAAC,GAAG,CACvB,kBAAkB,CAAC,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;wBAC9C,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;4BAC1B,OAAO,MAAM,IAAI,CAAC,6BAA6B,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;wBAC1E,CAAC;wBAED,OAAO,aAAa,CAAC;oBACtB,CAAC,CAAC,CACF,CAAC;gBACH,CAAC;gBAED,OAAO,kBAAkB,CAAC;YAC3B,CAAC,CACD,CAAC;YAEF,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC3C,CAAC;QAED,OAAO,SAAmC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,SAAiB;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE3C,IAAI,CAAC,OAAO;YAAE,OAAO;QAErB,MAAM,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC5C,CAAC;IAMO,kBAAkB,CAAC,MAAc;QACxC,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,MAAM,EAAE,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,6BAA6B,CAC1C,QAAiC,EACjC,aAAiC;QAEjC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEzC,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;YAC1B,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YACzD,MAAM,UAAU,GAAG,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,GAAW,EAAE,EAAE;gBAC3D,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;oBAC3B,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;gBAClC,CAAC;gBAED,MAAM,YAAY,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBAClD,IAAI,CAAC,YAAY,EAAE,CAAC;oBACnB,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;gBAClC,CAAC;gBAED,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAEhD,OAAO,MAAM,OAAO,EAAE,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;oBACzE,KAAK,EAAE,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC;oBACzC,GAAG;iBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;gBAC/C,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;oBAC7B,IAAI,GAAG,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;wBACxB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;oBACtC,CAAC;oBAED,OAAO,GAAG,CAAC;gBACZ,CAAC,EAAE,aAAa,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,aAAa,CAAC;IACtB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEpC,IAAI,OAAO;YAAE,OAAO,OAAO,CAAC;QAE5B,MAAM,IAAI,2CAAmB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;CACD,CAAA;AAtQY,8CAAiB;4BAAjB,iBAAiB;IAD7B,IAAA,YAAO,GAAE;qCAOiB,qCAAgB;QACT,sBAAa;QACpB,uBAAM;GARpB,iBAAiB,CAsQ7B"}

package/dist/binary-data/file-system.manager.d.ts

@@ -0,0 +1,31 @@
+import type { Readable } from 'stream';
+import type { ErrorReporter } from '../errors';
+import type { BinaryData } from './types';
+export declare class FileSystemManager implements BinaryData.Manager {
+    private storagePath;
+    private readonly errorReporter;
+    constructor(storagePath: string, errorReporter: ErrorReporter);
+    init(): Promise<void>;
+    store(location: BinaryData.FileLocation, bufferOrStream: Buffer | Readable, { mimeType, fileName }: BinaryData.PreWriteMetadata): Promise<{
+        fileId: string;
+        fileSize: number;
+    }>;
+    getPath(fileId: string): string;
+    getAsStream(fileId: string, chunkSize?: number): Promise<import("fs").ReadStream>;
+    getAsBuffer(fileId: string): Promise<Buffer<ArrayBufferLike>>;
+    getMetadata(fileId: string): Promise<BinaryData.Metadata>;
+    deleteMany(locations: BinaryData.FileLocation[]): Promise<void>;
+    copyByFilePath(targetLocation: BinaryData.FileLocation, sourcePath: string, { mimeType, fileName }: BinaryData.PreWriteMetadata): Promise<{
+        fileId: string;
+        fileSize: number;
+    }>;
+    copyByFileId(targetLocation: BinaryData.FileLocation, sourceFileId: string): Promise<string>;
+    rename(oldFileId: string, newFileId: string): Promise<void>;
+    deleteManyByFileId(ids: string[]): Promise<void>;
+    private toFileId;
+    private toRelativePath;
+    private parseFileId;
+    private resolvePath;
+    private storeMetadata;
+    private getSize;
+}