@n8n/blob-storage 1.0.0 → 1.2.0

package/dist/byte-store-registry.d.ts

@@ -0,0 +1,9 @@
+import type { ByteStore, StorageLocation } from './types';
+export declare class ByteStoreRegistry {
+    private readonly byteStores;
+    constructor(byteStores: Partial<Record<StorageLocation, ByteStore>>);
+    register(loc: StorageLocation, store: ByteStore): void;
+    has(loc: StorageLocation): boolean;
+    find(loc: StorageLocation): ByteStore | undefined;
+    get(loc: StorageLocation): ByteStore;
+}

package/dist/byte-store-registry.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ByteStoreRegistry = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+class ByteStoreRegistry {
+    constructor(byteStores) {
+        this.byteStores = new Map();
+        for (const [loc, store] of Object.entries(byteStores)) {
+            if (store)
+                this.byteStores.set(loc, store);
+        }
+    }
+    register(loc, store) {
+        this.byteStores.set(loc, store);
+    }
+    has(loc) {
+        return this.byteStores.has(loc);
+    }
+    find(loc) {
+        return this.byteStores.get(loc);
+    }
+    get(loc) {
+        const store = this.byteStores.get(loc);
+        if (!store) {
+            throw new n8n_workflow_1.UnexpectedError(`Byte store for location "${loc}" is not configured.`);
+        }
+        return store;
+    }
+}
+exports.ByteStoreRegistry = ByteStoreRegistry;
+//# sourceMappingURL=byte-store-registry.js.map

package/dist/byte-store-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"byte-store-registry.js","sourceRoot":"","sources":["../src/byte-store-registry.ts"],"names":[],"mappings":";;;AAAA,+CAA+C;AAS/C;IAGC,YAAY,UAAuD;QAFlD,eAAU,GAAG,IAAI,GAAG,EAA8B,CAAC;QAGnE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YACvD,IAAI,KAAK;gBAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAsB,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC;IACF,CAAC;IAED,QAAQ,CAAC,GAAoB,EAAE,KAAgB;QAC9C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,GAAG,CAAC,GAAoB;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IAGD,IAAI,CAAC,GAAoB;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IAGD,GAAG,CAAC,GAAoB;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEvC,IAAI,CAAC,KAAK,EAAE,CAAC;YACZ,MAAM,IAAI,8BAAe,CAAC,4BAA4B,GAAG,sBAAsB,CAAC,CAAC;QAClF,CAAC;QAED,OAAO,KAAK,CAAC;IACd,CAAC;CACD"}

package/dist/fs-byte-store.d.ts

@@ -0,0 +1,23 @@
+import type { Readable } from 'node:stream';
+import type { ByteStore, ByteStoreKey } from './types';
+export type FsByteStoreOptions = {
+    storagePath: string;
+    reportError: (error: unknown) => void;
+};
+export declare class FsByteStore implements ByteStore {
+    private readonly options;
+    constructor(options: FsByteStoreOptions);
+    init(): Promise<void>;
+    write(key: ByteStoreKey, body: Buffer | Readable): Promise<number>;
+    read(key: ByteStoreKey): Promise<NonSharedBuffer | null>;
+    readStream(key: ByteStoreKey, { chunkSize }?: {
+        chunkSize?: number;
+    }): Promise<import("fs").ReadStream | null>;
+    copy(sourceKey: ByteStoreKey, targetKey: ByteStoreKey): Promise<void>;
+    rename(oldKey: ByteStoreKey, newKey: ByteStoreKey): Promise<void>;
+    deletePrefix(prefix: string): Promise<void>;
+    delete(keys: ByteStoreKey[]): Promise<void>;
+    getAbsolutePath(key: ByteStoreKey): string;
+    private removeEmptyAncestors;
+    private isFileNotFound;
+}

package/dist/fs-byte-store.js

@@ -0,0 +1,120 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FsByteStore = void 0;
+const backend_common_1 = require("@n8n/backend-common");
+const n8n_workflow_1 = require("n8n-workflow");
+const node_crypto_1 = require("node:crypto");
+const promises_1 = __importDefault(require("node:fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+const stream_utils_1 = require("./stream-utils");
+class FsByteStore {
+    constructor(options) {
+        this.options = options;
+    }
+    async init() {
+        await (0, backend_common_1.assertDir)(this.options.storagePath);
+    }
+    async write(key, body) {
+        const writePath = this.getAbsolutePath(key);
+        await (0, backend_common_1.assertDir)(node_path_1.default.dirname(writePath));
+        const tempPath = `${writePath}.tmp.${process.pid}.${(0, node_crypto_1.randomUUID)()}`;
+        let success = false;
+        try {
+            await promises_1.default.writeFile(tempPath, body);
+            const bytesWritten = Buffer.isBuffer(body) ? body.length : (await promises_1.default.stat(tempPath)).size;
+            await promises_1.default.rename(tempPath, writePath);
+            success = true;
+            return bytesWritten;
+        }
+        finally {
+            if (!success) {
+                await promises_1.default.rm(tempPath, { force: true }).catch((error) => this.options.reportError(error));
+            }
+        }
+    }
+    async read(key) {
+        const readPath = this.getAbsolutePath(key);
+        try {
+            return await promises_1.default.readFile(readPath);
+        }
+        catch (error) {
+            if (this.isFileNotFound(error))
+                return null;
+            throw error;
+        }
+    }
+    async readStream(key, { chunkSize } = {}) {
+        if (chunkSize !== undefined)
+            (0, stream_utils_1.assertChunkSize)(chunkSize);
+        const readPath = this.getAbsolutePath(key);
+        let fileHandle;
+        try {
+            fileHandle = await promises_1.default.open(readPath, 'r');
+        }
+        catch (error) {
+            if (this.isFileNotFound(error))
+                return null;
+            throw error;
+        }
+        try {
+            return fileHandle.createReadStream(chunkSize ? { highWaterMark: chunkSize } : {});
+        }
+        catch (error) {
+            await fileHandle.close().catch(() => { });
+            throw error;
+        }
+    }
+    async copy(sourceKey, targetKey) {
+        const targetPath = this.getAbsolutePath(targetKey);
+        await (0, backend_common_1.assertDir)(node_path_1.default.dirname(targetPath));
+        await promises_1.default.copyFile(this.getAbsolutePath(sourceKey), targetPath);
+    }
+    async rename(oldKey, newKey) {
+        if (oldKey === newKey)
+            return;
+        const newPath = this.getAbsolutePath(newKey);
+        await (0, backend_common_1.assertDir)(node_path_1.default.dirname(newPath));
+        await promises_1.default.rename(this.getAbsolutePath(oldKey), newPath);
+    }
+    async deletePrefix(prefix) {
+        const dir = this.getAbsolutePath(prefix);
+        await promises_1.default.rm(dir, { recursive: true, force: true });
+        await this.removeEmptyAncestors(node_path_1.default.dirname(dir));
+    }
+    async delete(keys) {
+        const deletePaths = keys.map((key) => this.getAbsolutePath(key));
+        await Promise.all(deletePaths.map(async (p) => await promises_1.default.rm(p, { force: true })));
+        const dirs = [...new Set(deletePaths.map((p) => node_path_1.default.dirname(p)))];
+        await Promise.all(dirs.map(async (dir) => await this.removeEmptyAncestors(dir)));
+    }
+    getAbsolutePath(key) {
+        const storagePath = node_path_1.default.resolve(this.options.storagePath);
+        const resolvedPath = node_path_1.default.resolve(storagePath, key);
+        const relativePath = node_path_1.default.relative(storagePath, resolvedPath);
+        if (relativePath === '' || relativePath.startsWith('..') || node_path_1.default.isAbsolute(relativePath)) {
+            throw new n8n_workflow_1.UnexpectedError('Byte store key must resolve to a location inside the storage path');
+        }
+        return resolvedPath;
+    }
+    async removeEmptyAncestors(dir) {
+        const storagePath = node_path_1.default.resolve(this.options.storagePath);
+        let current = dir;
+        while (current.startsWith(storagePath) && current !== storagePath) {
+            try {
+                await promises_1.default.rmdir(current);
+            }
+            catch {
+                return;
+            }
+            current = node_path_1.default.dirname(current);
+        }
+    }
+    isFileNotFound(error) {
+        return (error !== null && typeof error === 'object' && 'code' in error && error.code === 'ENOENT');
+    }
+}
+exports.FsByteStore = FsByteStore;
+//# sourceMappingURL=fs-byte-store.js.map

package/dist/fs-byte-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs-byte-store.js","sourceRoot":"","sources":["../src/fs-byte-store.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgD;AAChD,+CAA+C;AAC/C,6CAAyC;AACzC,gEAAkC;AAClC,0DAA6B;AAG7B,iDAAiD;AAWjD;IACC,YAA6B,OAA2B;uBAA3B,OAAO;IAAuB,CAAC;IAE5D,KAAK,CAAC,IAAI;QACT,MAAM,IAAA,0BAAS,EAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAiB,EAAE,IAAuB;QACrD,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,IAAA,0BAAS,EAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAG,GAAG,SAAS,QAAQ,OAAO,CAAC,GAAG,IAAI,IAAA,wBAAU,GAAE,EAAE,CAAC;QAEnE,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,IAAI,CAAC;YACJ,MAAM,kBAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACnC,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,kBAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;YAC1F,MAAM,kBAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACrC,OAAO,GAAG,IAAI,CAAC;YACf,OAAO,YAAY,CAAC;QACrB,CAAC;gBAAS,CAAC;YACV,IAAI,CAAC,OAAO,EAAE,CAAC;gBACd,MAAM,kBAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1F,CAAC;QACF,CAAC;IACF,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAiB;QAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC;YACJ,OAAO,MAAM,kBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC5C,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAiB,EAAE,EAAE,SAAS,EAAE,GAA2B,EAAE;QAC7E,IAAI,SAAS,KAAK,SAAS;YAAE,IAAA,8BAAe,EAAC,SAAS,CAAC,CAAC;QACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,UAAU,CAAC;QACf,IAAI,CAAC;YACJ,UAAU,GAAG,MAAM,kBAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC5C,MAAM,KAAK,CAAC;QACb,CAAC;QACD,IAAI,CAAC;YACJ,OAAO,UAAU,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YACzC,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,SAAuB,EAAE,SAAuB;QAC1D,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QACnD,MAAM,IAAA,0BAAS,EAAC,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QAC1C,MAAM,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,CAAC;IAChE,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAoB,EAAE,MAAoB;QACtD,IAAI,MAAM,KAAK,MAAM;YAAE,OAAO;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,IAAA,0BAAS,EAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;QACvC,MAAM,kBAAE,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,MAAc;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,kBAAE,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,oBAAoB,CAAC,mBAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAoB;QAChC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC;QACjE,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,kBAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACjF,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnE,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC;IAGD,eAAe,CAAC,GAAiB;QAChC,MAAM,WAAW,GAAG,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAG,mBAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACpD,MAAM,YAAY,GAAG,mBAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAE9D,IAAI,YAAY,KAAK,EAAE,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,mBAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAC3F,MAAM,IAAI,8BAAe,CACxB,mEAAmE,CACnE,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAC;IACrB,CAAC;IAIO,KAAK,CAAC,oBAAoB,CAAC,GAAW;QAC7C,MAAM,WAAW,GAAG,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC3D,IAAI,OAAO,GAAG,GAAG,CAAC;QAClB,OAAO,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,OAAO,KAAK,WAAW,EAAE,CAAC;YACnE,IAAI,CAAC;gBACJ,MAAM,kBAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACzB,CAAC;YAAC,MAAM,CAAC;gBACR,OAAO;YACR,CAAC;YACD,OAAO,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;IACF,CAAC;IAEO,cAAc,CAAC,KAAc;QACpC,OAAO,CACN,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CACzF,CAAC;IACH,CAAC;CACD"}

package/dist/index.d.ts

@@ -1,4 +1,10 @@
-export type { BlobMetadata, PreWriteBlobMetadata } from './types';
+export type { BlobMetadata, PreWriteBlobMetadata, ByteStore, ByteStoreKey, StorageLocation, JsonEntry, Stored, JsonStoreOptions, } from './types';
+export { ByteStoreRegistry } from './byte-store-registry';
+export { FsByteStore, type FsByteStoreOptions } from './fs-byte-store';
+export { S3ByteStore } from './s3-byte-store.ee';
+export { AzureByteStore } from './azure-byte-store.ee';
+export { JsonStore } from './json-store';
+export { SkippedEntryDeletionError } from './skipped-entry-deletion.error';
 export { createFixedSizeChunker } from './stream-utils';
 export { ObjectStoreConfig } from './object-store/object-store.config';
 export type { MetadataResponseHeaders } from './object-store/types';

package/dist/index.js

@@ -1,6 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AzureBlobConfig = exports.ObjectStoreConfig = exports.createFixedSizeChunker = void 0;
+exports.AzureBlobConfig = exports.ObjectStoreConfig = exports.createFixedSizeChunker = exports.SkippedEntryDeletionError = exports.JsonStore = exports.AzureByteStore = exports.S3ByteStore = exports.FsByteStore = exports.ByteStoreRegistry = void 0;
+var byte_store_registry_1 = require("./byte-store-registry");
+Object.defineProperty(exports, "ByteStoreRegistry", { enumerable: true, get: function () { return byte_store_registry_1.ByteStoreRegistry; } });
+var fs_byte_store_1 = require("./fs-byte-store");
+Object.defineProperty(exports, "FsByteStore", { enumerable: true, get: function () { return fs_byte_store_1.FsByteStore; } });
+var s3_byte_store_ee_1 = require("./s3-byte-store.ee");
+Object.defineProperty(exports, "S3ByteStore", { enumerable: true, get: function () { return s3_byte_store_ee_1.S3ByteStore; } });
+var azure_byte_store_ee_1 = require("./azure-byte-store.ee");
+Object.defineProperty(exports, "AzureByteStore", { enumerable: true, get: function () { return azure_byte_store_ee_1.AzureByteStore; } });
+var json_store_1 = require("./json-store");
+Object.defineProperty(exports, "JsonStore", { enumerable: true, get: function () { return json_store_1.JsonStore; } });
+var skipped_entry_deletion_error_1 = require("./skipped-entry-deletion.error");
+Object.defineProperty(exports, "SkippedEntryDeletionError", { enumerable: true, get: function () { return skipped_entry_deletion_error_1.SkippedEntryDeletionError; } });
 var stream_utils_1 = require("./stream-utils");
 Object.defineProperty(exports, "createFixedSizeChunker", { enumerable: true, get: function () { return stream_utils_1.createFixedSizeChunker; } });
 var object_store_config_1 = require("./object-store/object-store.config");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,+CAAwD;AAA/C,sHAAA,sBAAsB,OAAA;AAC/B,0EAAuE;AAA9D,wHAAA,iBAAiB,OAAA;AAE1B,oEAAiE;AAAxD,oHAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAUA,6DAA0D;AAAjD,wHAAA,iBAAiB,OAAA;AAC1B,iDAAuE;AAA9D,4GAAA,WAAW,OAAA;AACpB,uDAAiD;AAAxC,+GAAA,WAAW,OAAA;AACpB,6DAAuD;AAA9C,qHAAA,cAAc,OAAA;AACvB,2CAAyC;AAAhC,uGAAA,SAAS,OAAA;AAClB,+EAA2E;AAAlE,yIAAA,yBAAyB,OAAA;AAClC,+CAAwD;AAA/C,sHAAA,sBAAsB,OAAA;AAC/B,0EAAuE;AAA9D,wHAAA,iBAAiB,OAAA;AAE1B,oEAAiE;AAAxD,oHAAA,eAAe,OAAA"}

package/dist/json-store.d.ts

@@ -0,0 +1,17 @@
+import type { ByteStore, JsonEntry, JsonStoreOptions, StorageLocation, Stored } from './types';
+export declare class JsonStore<Ref, Payload extends object> {
+    private readonly options;
+    private readonly byteStores;
+    constructor(options: JsonStoreOptions<Ref>);
+    registerByteStore(loc: StorageLocation, store: ByteStore): void;
+    hasLocation(loc: StorageLocation): boolean;
+    write(ref: Ref, payload: Payload, loc: StorageLocation): Promise<number>;
+    read(ref: Ref, loc: StorageLocation): Promise<JsonEntry<Payload> | null>;
+    readMany(refs: Array<Stored<Ref>>): Promise<Map<string, JsonEntry<Payload>>>;
+    delete(refs: Array<Stored<Ref>>): Promise<void>;
+    private groupByLocation;
+    private tryRead;
+    private parse;
+    private markCorrupt;
+    private isCorruptEntryError;
+}

package/dist/json-store.js

@@ -0,0 +1,118 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonStore = void 0;
+const chunk_1 = __importDefault(require("lodash/chunk"));
+const n8n_workflow_1 = require("n8n-workflow");
+const byte_store_registry_1 = require("./byte-store-registry");
+const skipped_entry_deletion_error_1 = require("./skipped-entry-deletion.error");
+const CORRUPT_ENTRY = Symbol('corruptEntry');
+const MAX_READ_CONCURRENCY = 50;
+class JsonStore {
+    constructor(options) {
+        this.options = options;
+        this.byteStores = new byte_store_registry_1.ByteStoreRegistry(options.byteStores);
+    }
+    registerByteStore(loc, store) {
+        this.byteStores.register(loc, store);
+    }
+    hasLocation(loc) {
+        return this.byteStores.has(loc);
+    }
+    async write(ref, payload, loc) {
+        const store = this.byteStores.get(loc);
+        if ('version' in payload) {
+            throw new n8n_workflow_1.UnexpectedError('Payload must not contain the reserved `version` key.');
+        }
+        try {
+            const body = Buffer.from((0, n8n_workflow_1.jsonStringify)({ ...payload, version: this.options.version }), 'utf-8');
+            return await store.write(this.options.key(ref), body, { mimeType: 'application/json' });
+        }
+        catch (error) {
+            throw this.options.createWriteError(ref, error);
+        }
+    }
+    async read(ref, loc) {
+        const store = this.byteStores.get(loc);
+        const key = this.options.key(ref);
+        const bytes = await store.read(key);
+        if (!bytes)
+            return null;
+        return this.parse(ref, bytes);
+    }
+    async readMany(refs) {
+        const entries = new Map();
+        if (refs.length === 0)
+            return entries;
+        await Promise.all([...this.groupByLocation(refs)].map(async ([loc, group]) => {
+            const store = this.byteStores.get(loc);
+            for (const batch of (0, chunk_1.default)(group, MAX_READ_CONCURRENCY)) {
+                const results = await Promise.all(batch.map(async (ref) => await this.tryRead(ref, store)));
+                results.forEach((entry, idx) => {
+                    if (entry)
+                        entries.set(this.options.getId(batch[idx]), entry);
+                });
+            }
+        }));
+        return entries;
+    }
+    async delete(refs) {
+        if (refs.length === 0)
+            return;
+        await Promise.all([...this.groupByLocation(refs)].map(async ([loc, group]) => {
+            const store = this.byteStores.find(loc);
+            if (!store) {
+                this.options.reportError(new skipped_entry_deletion_error_1.SkippedEntryDeletionError(loc, group.length));
+                return;
+            }
+            await store.delete(group.map((ref) => this.options.key(ref)));
+        }));
+    }
+    groupByLocation(refs) {
+        const groups = new Map();
+        for (const ref of refs) {
+            const group = groups.get(ref.storedAt) ?? [];
+            group.push(ref);
+            groups.set(ref.storedAt, group);
+        }
+        return groups;
+    }
+    async tryRead(ref, store) {
+        try {
+            const bytes = await store.read(this.options.key(ref));
+            if (!bytes)
+                return null;
+            return this.parse(ref, bytes);
+        }
+        catch (error) {
+            if (this.isCorruptEntryError(error)) {
+                this.options.reportError(error);
+                return null;
+            }
+            throw error;
+        }
+    }
+    parse(ref, bytes) {
+        try {
+            const entry = (0, n8n_workflow_1.jsonParse)(bytes.toString('utf-8'));
+            if (entry.version !== this.options.version) {
+                throw new Error(`Unsupported entry version: ${String(entry.version)}`);
+            }
+            return entry;
+        }
+        catch (error) {
+            throw this.markCorrupt(this.options.createCorruptedError(ref, error));
+        }
+    }
+    markCorrupt(error) {
+        Object.defineProperty(error, CORRUPT_ENTRY, { value: true });
+        return error;
+    }
+    isCorruptEntryError(error) {
+        return error instanceof Error && CORRUPT_ENTRY in error;
+    }
+}
+exports.JsonStore = JsonStore;
+//# sourceMappingURL=json-store.js.map

package/dist/json-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-store.js","sourceRoot":"","sources":["../src/json-store.ts"],"names":[],"mappings":";;;;;;AAAA,yDAAiC;AACjC,+CAAyE;AAEzE,+DAA0D;AAC1D,iFAA2E;AAG3E,MAAM,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;AAE7C,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAMhC;IAGC,YAA6B,OAA8B;uBAA9B,OAAO;QACnC,IAAI,CAAC,UAAU,GAAG,IAAI,uCAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7D,CAAC;IAED,iBAAiB,CAAC,GAAoB,EAAE,KAAgB;QACvD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IAED,WAAW,CAAC,GAAoB;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAQ,EAAE,OAAgB,EAAE,GAAoB;QAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,IAAI,8BAAe,CAAC,sDAAsD,CAAC,CAAC;QACnF,CAAC;QACD,IAAI,CAAC;YACJ,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CACvB,IAAA,4BAAa,EAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,EAC5D,OAAO,CACP,CAAC;YACF,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAC,CAAC;QACzF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC;IACF,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAQ,EAAE,GAAoB;QACxC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAwB;QACtC,MAAM,OAAO,GAAG,IAAI,GAAG,EAA8B,CAAC;QACtD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,OAAO,CAAC;QAEtC,MAAM,OAAO,CAAC,GAAG,CAChB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACvC,KAAK,MAAM,KAAK,IAAI,IAAA,eAAK,EAAC,KAAK,EAAE,oBAAoB,CAAC,EAAE,CAAC;gBACxD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CACxD,CAAC;gBACF,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;oBAC9B,IAAI,KAAK;wBAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBAC/D,CAAC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC,CACF,CAAC;QAEF,OAAO,OAAO,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAwB;QACpC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAE9B,MAAM,OAAO,CAAC,GAAG,CAChB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACZ,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,wDAAyB,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC3E,OAAO;YACR,CAAC;YACD,MAAM,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAC,CACF,CAAC;IACH,CAAC;IAIO,eAAe,CAAC,IAAwB;QAC/C,MAAM,MAAM,GAAG,IAAI,GAAG,EAA0B,CAAC;QACjD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChB,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,GAAQ,EAAE,KAAgB;QAC/C,IAAI,CAAC;YACJ,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YACtD,IAAI,CAAC,KAAK;gBAAE,OAAO,IAAI,CAAC;YACxB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBAChC,OAAO,IAAI,CAAC;YACb,CAAC;YACD,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;IAEO,KAAK,CAAC,GAAQ,EAAE,KAAa;QACpC,IAAI,CAAC;YACJ,MAAM,KAAK,GAAG,IAAA,wBAAS,EAAqB,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACrE,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBAC5C,MAAM,IAAI,KAAK,CAAC,8BAA8B,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACxE,CAAC;YACD,OAAO,KAAK,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QACvE,CAAC;IACF,CAAC;IAEO,WAAW,CAAkB,KAAQ;QAC5C,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,OAAO,KAAK,CAAC;IACd,CAAC;IAEO,mBAAmB,CAAC,KAAc;QACzC,OAAO,KAAK,YAAY,KAAK,IAAI,aAAa,IAAI,KAAK,CAAC;IACzD,CAAC;CACD"}

package/dist/s3-byte-store.ee.d.ts

@@ -0,0 +1,20 @@
+import type { Readable } from 'node:stream';
+import type { ObjectStoreService } from './object-store/object-store.service.ee';
+import type { BlobMetadata, ByteStore, ByteStoreKey, PreWriteBlobMetadata } from './types';
+export declare class S3ByteStore implements ByteStore {
+    private readonly objectStore;
+    constructor(objectStore: ObjectStoreService);
+    write(key: ByteStoreKey, body: Buffer | Readable, metadata?: PreWriteBlobMetadata): Promise<number>;
+    read(key: ByteStoreKey): Promise<Buffer<ArrayBufferLike> | null>;
+    readStream(key: ByteStoreKey, { chunkSize }?: {
+        chunkSize?: number;
+    }): Promise<Readable | null>;
+    copy(sourceKey: ByteStoreKey, targetKey: ByteStoreKey): Promise<void>;
+    rename(oldKey: ByteStoreKey, newKey: ByteStoreKey): Promise<void>;
+    delete(keys: ByteStoreKey[]): Promise<void>;
+    getMetadata(key: ByteStoreKey): Promise<BlobMetadata | null>;
+    private readNativeMetadata;
+    private isNoSuchKey;
+    private isHeadNotFound;
+    private errorName;
+}

package/dist/s3-byte-store.ee.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.S3ByteStore = void 0;
+const backend_network_1 = require("@n8n/backend-network");
+const ensure_error_1 = require("@n8n/utils/errors/ensure-error");
+const stream_utils_1 = require("./stream-utils");
+class S3ByteStore {
+    constructor(objectStore) {
+        this.objectStore = objectStore;
+    }
+    async write(key, body, metadata = {}) {
+        const buffer = Buffer.isBuffer(body) ? body : await (0, backend_network_1.binaryToBuffer)(body);
+        await this.objectStore.put(key, buffer, {
+            ...metadata,
+            mimeType: metadata.mimeType ?? 'application/octet-stream',
+        });
+        return buffer.length;
+    }
+    async read(key) {
+        try {
+            return await this.objectStore.get(key, { mode: 'buffer' });
+        }
+        catch (error) {
+            if (this.isNoSuchKey(error))
+                return null;
+            throw error;
+        }
+    }
+    async readStream(key, { chunkSize } = {}) {
+        if (chunkSize !== undefined)
+            (0, stream_utils_1.assertChunkSize)(chunkSize);
+        try {
+            return await this.objectStore.get(key, { mode: 'stream', chunkSize });
+        }
+        catch (error) {
+            if (this.isNoSuchKey(error))
+                return null;
+            throw error;
+        }
+    }
+    async copy(sourceKey, targetKey) {
+        const buffer = await this.objectStore.get(sourceKey, { mode: 'buffer' });
+        await this.objectStore.put(targetKey, buffer, await this.readNativeMetadata(sourceKey));
+    }
+    async rename(oldKey, newKey) {
+        if (oldKey === newKey)
+            return;
+        await this.copy(oldKey, newKey);
+        await this.objectStore.deleteOne(oldKey);
+    }
+    async delete(keys) {
+        if (keys.length === 0)
+            return;
+        await this.objectStore.deleteByKeys(keys);
+    }
+    async getMetadata(key) {
+        try {
+            const headers = await this.objectStore.getMetadata(key);
+            const metadata = { fileSize: Number(headers['content-length'] ?? 0) };
+            if (headers['content-type'])
+                metadata.mimeType = headers['content-type'];
+            if (headers['x-amz-meta-filename'])
+                metadata.fileName = headers['x-amz-meta-filename'];
+            return metadata;
+        }
+        catch (error) {
+            if (this.isHeadNotFound(error))
+                return null;
+            throw error;
+        }
+    }
+    async readNativeMetadata(key) {
+        const headers = await this.objectStore.getMetadata(key);
+        const metadata = {};
+        if (headers['content-type'])
+            metadata.mimeType = headers['content-type'];
+        if (headers['x-amz-meta-filename'])
+            metadata.fileName = headers['x-amz-meta-filename'];
+        return metadata;
+    }
+    isNoSuchKey(error) {
+        return this.errorName(error) === 'NoSuchKey';
+    }
+    isHeadNotFound(error) {
+        return this.errorName(error) === 'NotFound';
+    }
+    errorName(error) {
+        const original = (0, ensure_error_1.ensureError)(error).cause ?? error;
+        if (typeof original !== 'object' || original === null)
+            return undefined;
+        return 'name' in original ? original.name : undefined;
+    }
+}
+exports.S3ByteStore = S3ByteStore;
+//# sourceMappingURL=s3-byte-store.ee.js.map

package/dist/s3-byte-store.ee.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-byte-store.ee.js","sourceRoot":"","sources":["../src/s3-byte-store.ee.ts"],"names":[],"mappings":";;;AAAA,0DAAsD;AACtD,iEAA6D;AAI7D,iDAAiD;AAGjD;IACC,YAA6B,WAA+B;2BAA/B,WAAW;IAAuB,CAAC;IAEhE,KAAK,CAAC,KAAK,CAAC,GAAiB,EAAE,IAAuB,EAAE,QAAQ,GAAyB,EAAE;QAC1F,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,IAAA,gCAAc,EAAC,IAAI,CAAC,CAAC;QACzE,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE;YACvC,GAAG,QAAQ;YACX,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,0BAA0B;SACzD,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,GAAiB;QAC3B,IAAI,CAAC;YACJ,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YACzC,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAiB,EAAE,EAAE,SAAS,EAAE,GAA2B,EAAE;QAC7E,IAAI,SAAS,KAAK,SAAS;YAAE,IAAA,8BAAe,EAAC,SAAS,CAAC,CAAC;QACxD,IAAI,CAAC;YACJ,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACvE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YACzC,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,SAAuB,EAAE,SAAuB;QAC1D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACzE,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IACzF,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAoB,EAAE,MAAoB;QACtD,IAAI,MAAM,KAAK,MAAM;YAAE,OAAO;QAC9B,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAoB;QAChC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAC9B,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,GAAiB;QAClC,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACxD,MAAM,QAAQ,GAAiB,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACpF,IAAI,OAAO,CAAC,cAAc,CAAC;gBAAE,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;YACzE,IAAI,OAAO,CAAC,qBAAqB,CAAC;gBAAE,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;YACvF,OAAO,QAAQ,CAAC;QACjB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC5C,MAAM,KAAK,CAAC;QACb,CAAC;IACF,CAAC;IAIO,KAAK,CAAC,kBAAkB,CAAC,GAAiB;QACjD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACxD,MAAM,QAAQ,GAAyB,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,cAAc,CAAC;YAAE,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;QACzE,IAAI,OAAO,CAAC,qBAAqB,CAAC;YAAE,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACvF,OAAO,QAAQ,CAAC;IACjB,CAAC;IAGO,WAAW,CAAC,KAAc;QACjC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,WAAW,CAAC;IAC9C,CAAC;IAMO,cAAc,CAAC,KAAc;QACpC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,UAAU,CAAC;IAC7C,CAAC;IAEO,SAAS,CAAC,KAAc;QAC/B,MAAM,QAAQ,GAAG,IAAA,0BAAW,EAAC,KAAK,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC;QACnD,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI;YAAE,OAAO,SAAS,CAAC;QACxE,OAAO,MAAM,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IACvD,CAAC;CACD"}

package/dist/skipped-entry-deletion.error.d.ts

@@ -0,0 +1,5 @@
+import { OperationalError } from 'n8n-workflow';
+import type { StorageLocation } from './types';
+export declare class SkippedEntryDeletionError extends OperationalError {
+    constructor(loc: StorageLocation, count: number);
+}

package/dist/skipped-entry-deletion.error.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkippedEntryDeletionError = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
+class SkippedEntryDeletionError extends n8n_workflow_1.OperationalError {
+    constructor(loc, count) {
+        super(`Skipped deleting entries - "${loc}" store is not configured`, {
+            extra: { count },
+        });
+    }
+}
+exports.SkippedEntryDeletionError = SkippedEntryDeletionError;
+//# sourceMappingURL=skipped-entry-deletion.error.js.map

package/dist/skipped-entry-deletion.error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"skipped-entry-deletion.error.js","sourceRoot":"","sources":["../src/skipped-entry-deletion.error.ts"],"names":[],"mappings":";;;AAAA,+CAAgD;AAIhD,+BAAuC,SAAQ,+BAAgB;IAC9D,YAAY,GAAoB,EAAE,KAAa;QAC9C,KAAK,CAAC,+BAA+B,GAAG,2BAA2B,EAAE;YACpE,KAAK,EAAE,EAAE,KAAK,EAAE;SAChB,CAAC,CAAC;IACJ,CAAC;CACD"}

package/dist/stream-utils.d.ts

@@ -1,2 +1,3 @@
 import { Transform } from 'node:stream';
+export declare function assertChunkSize(chunkSize: number): void;
 export declare function createFixedSizeChunker(chunkSize: number): Transform;

package/dist/stream-utils.js

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertChunkSize = assertChunkSize;
 exports.createFixedSizeChunker = createFixedSizeChunker;
 const n8n_workflow_1 = require("n8n-workflow");
 const node_stream_1 = require("node:stream");
-function createFixedSizeChunker(chunkSize) {
-    if (chunkSize <= 0) {
-        throw new n8n_workflow_1.UnexpectedError(`createFixedSizeChunker requires chunkSize > 0, got ${chunkSize}`);
+function assertChunkSize(chunkSize) {
+    if (!Number.isInteger(chunkSize) || chunkSize <= 0) {
+        throw new n8n_workflow_1.UnexpectedError(`chunkSize must be a positive integer, got ${chunkSize}`);
     }
+}
+function createFixedSizeChunker(chunkSize) {
+    assertChunkSize(chunkSize);
     const queue = [];
     let queued = 0;
     const take = (size) => {

package/dist/stream-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"stream-utils.js","sourceRoot":"","sources":["../src/stream-utils.ts"],"names":[],"mappings":";;;AAAA,+CAA+C;AAC/C,6CAAwC;AAcxC,gCAAuC,SAAiB;IACvD,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,8BAAe,CAAC,sDAAsD,SAAS,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,MAAM,IAAI,GAAG,CAAC,IAAY,EAAU,EAAE;QACrC,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,OAAO,OAAO,GAAG,IAAI,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,MAAM,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC;YAC5B,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACxB,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC;gBACvB,KAAK,CAAC,KAAK,EAAE,CAAC;YACf,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACjC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC/B,OAAO,IAAI,IAAI,CAAC;YACjB,CAAC;QACF,CAAC;QACD,MAAM,IAAI,IAAI,CAAC;QACf,OAAO,GAAG,CAAC;IACZ,CAAC,CAAC;IAEF,OAAO,IAAI,uBAAS,CAAC;QACpB,SAAS,CAAC,KAAa,EAAE,SAAS,EAAE,IAAI;YACvC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;YACvB,OAAO,MAAM,IAAI,SAAS,EAAE,CAAC;gBAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YAC5B,CAAC;YACD,IAAI,EAAE,CAAC;QACR,CAAC;QACD,KAAK,CAAC,IAAI;YACT,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,CAAC;YACD,IAAI,EAAE,CAAC;QACR,CAAC;QACD,OAAO,CAAC,KAAK,EAAE,IAAI;YAClB,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;YACjB,MAAM,GAAG,CAAC,CAAC;YACX,IAAI,CAAC,KAAK,CAAC,CAAC;QACb,CAAC;KACD,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"stream-utils.js","sourceRoot":"","sources":["../src/stream-utils.ts"],"names":[],"mappings":";;;;AAAA,+CAA+C;AAC/C,6CAAwC;AAGxC,yBAAgC,SAAiB;IAChD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,8BAAe,CAAC,6CAA6C,SAAS,EAAE,CAAC,CAAC;IACrF,CAAC;AACF,CAAC;AAcD,gCAAuC,SAAiB;IACvD,eAAe,CAAC,SAAS,CAAC,CAAC;IAE3B,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,MAAM,IAAI,GAAG,CAAC,IAAY,EAAU,EAAE;QACrC,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,OAAO,OAAO,GAAG,IAAI,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,MAAM,IAAI,GAAG,IAAI,GAAG,OAAO,CAAC;YAC5B,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACxB,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC;gBACvB,KAAK,CAAC,KAAK,EAAE,CAAC;YACf,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACjC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC/B,OAAO,IAAI,IAAI,CAAC;YACjB,CAAC;QACF,CAAC;QACD,MAAM,IAAI,IAAI,CAAC;QACf,OAAO,GAAG,CAAC;IACZ,CAAC,CAAC;IAEF,OAAO,IAAI,uBAAS,CAAC;QACpB,SAAS,CAAC,KAAa,EAAE,SAAS,EAAE,IAAI;YACvC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC;YACvB,OAAO,MAAM,IAAI,SAAS,EAAE,CAAC;gBAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YAC5B,CAAC;YACD,IAAI,EAAE,CAAC;QACR,CAAC;QACD,KAAK,CAAC,IAAI;YACT,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YACzB,CAAC;YACD,IAAI,EAAE,CAAC;QACR,CAAC;QACD,OAAO,CAAC,KAAK,EAAE,IAAI;YAClB,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;YACjB,MAAM,GAAG,CAAC,CAAC;YACX,IAAI,CAAC,KAAK,CAAC,CAAC;QACb,CAAC;KACD,CAAC,CAAC;AACJ,CAAC"}

package/dist/types.d.ts

@@ -1,6 +1,38 @@
+import type { Readable } from 'node:stream';
 export type BlobMetadata = {
     fileName?: string;
     mimeType?: string;
     fileSize: number;
 };
 export type PreWriteBlobMetadata = Omit<BlobMetadata, 'fileSize'>;
+export type StorageLocation = 'fs' | 's3' | 'az';
+export type ByteStoreKey = string;
+export interface ByteStore {
+    init?(): Promise<void>;
+    write(key: ByteStoreKey, body: Buffer | Readable, metadata?: PreWriteBlobMetadata): Promise<number>;
+    read(key: ByteStoreKey): Promise<Buffer | null>;
+    readStream(key: ByteStoreKey, opts?: {
+        chunkSize?: number;
+    }): Promise<Readable | null>;
+    copy(sourceKey: ByteStoreKey, targetKey: ByteStoreKey): Promise<void>;
+    rename(oldKey: ByteStoreKey, newKey: ByteStoreKey): Promise<void>;
+    delete(keys: ByteStoreKey[]): Promise<void>;
+    getMetadata?(key: ByteStoreKey): Promise<BlobMetadata | null>;
+    getAbsolutePath?(key: ByteStoreKey): string;
+    deletePrefix?(prefix: string): Promise<void>;
+}
+export type JsonEntry<Payload extends object> = Payload & {
+    version: number;
+};
+export type Stored<Ref> = Ref & {
+    storedAt: StorageLocation;
+};
+export interface JsonStoreOptions<Ref> {
+    byteStores: Partial<Record<StorageLocation, ByteStore>>;
+    version: number;
+    key: (ref: Ref) => string;
+    getId: (ref: Ref) => string;
+    createWriteError: (ref: Ref, cause: unknown) => Error;
+    createCorruptedError: (ref: Ref, cause: unknown) => Error;
+    reportError: (error: unknown) => void;
+}