@typetron/framework 0.5.31 → 0.5.32

package/build/Storage/File.js

@@ -1,61 +1,43 @@
 "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 __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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.File = void 0;
-const path = __importStar(require("path"));
+const node_path_1 = __importDefault(require("node:path"));
 class File {
-    name;
-    directory;
-    // content?: string | Buffer
+    key;
+    disk;
     originalName;
     saved = false;
-    constructor(name, directory) {
-        this.name = name;
-        this.directory = directory;
+    size;
+    lastModified;
+    mimeType;
+    etag;
+    metadata;
+    visibility;
+    constructor(key, disk, metadata = {}) {
+        this.key = key;
+        this.disk = disk;
+        Object.assign(this, metadata);
     }
-    get extension() {
-        return this.guessExtension();
+    get name() {
+        return node_path_1.default.posix.basename(this.key.replaceAll('\\', '/'));
+    }
+    get directory() {
+        const directory = node_path_1.default.posix.dirname(this.key.replaceAll('\\', '/'));
+        return directory === '.' ? '' : directory;
     }
+    /** The logical storage key. Kept as an alias for existing file consumers. */
     get path() {
-        return path.join(this.directory || '', this.name);
+        return this.key;
+    }
+    get extension() {
+        const extension = node_path_1.default.posix.extname(this.name);
+        return extension ? extension.slice(1) : undefined;
     }
     guessExtension() {
-        const fileParts = this.name.split('.');
-        if (fileParts.length >= 1) {
-            return fileParts.pop();
-        }
+        return this.extension;
     }
     toString() {
         return this.name;

package/build/Storage/File.js.map

@@ -1 +1 @@
-{"version":3,"file":"File.js","sourceRoot":"","sources":["../../Storage/File.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA4B;AAE5B,MAAa,IAAI;IAMM;IAAqB;IALxC,4BAA4B;IAC5B,YAAY,CAAS;IAErB,KAAK,GAAG,KAAK,CAAA;IAEb,YAAmB,IAAY,EAAS,SAAkB;QAAvC,SAAI,GAAJ,IAAI,CAAQ;QAAS,cAAS,GAAT,SAAS,CAAS;IAC1D,CAAC;IAED,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,cAAc,EAAE,CAAA;IAChC,CAAC;IAED,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;IACrD,CAAC;IAED,cAAc;QACV,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACtC,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC,GAAG,EAAE,CAAA;QAC1B,CAAC;IACL,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,IAAI,CAAA;IACpB,CAAC;CACJ;AA3BD,oBA2BC"}
+{"version":3,"file":"File.js","sourceRoot":"","sources":["../../Storage/File.ts"],"names":[],"mappings":";;;;;;AAAA,0DAA4B;AAG5B,MAAa,IAAI;IAWF;IACA;IAXX,YAAY,CAAS;IACrB,KAAK,GAAG,KAAK,CAAA;IACb,IAAI,CAAS;IACb,YAAY,CAAO;IACnB,QAAQ,CAAS;IACjB,IAAI,CAAS;IACb,QAAQ,CAAyB;IACjC,UAAU,CAAa;IAEvB,YACW,GAAW,EACX,IAAa,EACpB,WAAkC,EAAE;QAF7B,QAAG,GAAH,GAAG,CAAQ;QACX,SAAI,GAAJ,IAAI,CAAS;QAGpB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;IACjC,CAAC;IAED,IAAI,IAAI;QACJ,OAAO,mBAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAA;IAC9D,CAAC;IAED,IAAI,SAAS;QACT,MAAM,SAAS,GAAG,mBAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAA;QACpE,OAAO,SAAS,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;IAC7C,CAAC;IAED,6EAA6E;IAC7E,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,GAAG,CAAA;IACnB,CAAC;IAED,IAAI,SAAS;QACT,MAAM,SAAS,GAAG,mBAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC/C,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACrD,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,SAAS,CAAA;IACzB,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,IAAI,CAAA;IACpB,CAAC;CACJ;AA5CD,oBA4CC"}

package/build/Storage/Filesystem.d.ts

@@ -0,0 +1,31 @@
+import * as fileSystem from 'node:fs/promises';
+import { File } from './File';
+/**
+ * Typetron's internal access to the host operating-system filesystem.
+ *
+ * Framework bootstrap uses this service before application storage configuration
+ * is available. It accepts real OS paths so Typetron can discover configuration,
+ * controllers, entities, migrations, seeders, static assets, and file-cache data.
+ * Application code should use `Storage` and its configured disks instead.
+ *
+ * This is deliberately separate from `LocalDriver`: a local storage disk is
+ * constrained to its configured root and works with portable logical keys,
+ * while this service works with framework-owned host paths.
+ *
+ * @internal
+ */
+export declare class Filesystem {
+    /**
+     * Lists files synchronously because framework modules are currently loaded
+     * synchronously during bootstrap. Application storage listings are async.
+     */
+    files(directory: string, recursively?: boolean): File[];
+    read(filePath: string): Promise<Buffer>;
+    exists(filePath: string): Promise<boolean>;
+    save(file: File, destination: string, name?: string | number): Promise<File>;
+    put(filePath: string, content: string | Buffer, options?: Parameters<typeof fileSystem.writeFile>[2]): Promise<File>;
+    makeDirectory(directory: string): Promise<void>;
+    deleteDirectory(directory: string): Promise<void>;
+    delete(filePath: string): Promise<void>;
+}
+//# sourceMappingURL=Filesystem.d.ts.map

package/build/Storage/Filesystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Filesystem.d.ts","sourceRoot":"","sources":["../../Storage/Filesystem.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,UAAU,MAAM,kBAAkB,CAAA;AAE9C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE7B;;;;;;;;;;;;;GAaG;AACH,qBAAa,UAAU;IACnB;;;OAGG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,UAAQ,GAAG,IAAI,EAAE;IAc/C,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvC,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS1C,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5E,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAMpH,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjD,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAShD"}

package/build/Storage/Filesystem.js

@@ -0,0 +1,121 @@
+"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 __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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Filesystem = void 0;
+const node_fs_1 = __importDefault(require("node:fs"));
+const fileSystem = __importStar(require("node:fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+const File_1 = require("./File");
+/**
+ * Typetron's internal access to the host operating-system filesystem.
+ *
+ * Framework bootstrap uses this service before application storage configuration
+ * is available. It accepts real OS paths so Typetron can discover configuration,
+ * controllers, entities, migrations, seeders, static assets, and file-cache data.
+ * Application code should use `Storage` and its configured disks instead.
+ *
+ * This is deliberately separate from `LocalDriver`: a local storage disk is
+ * constrained to its configured root and works with portable logical keys,
+ * while this service works with framework-owned host paths.
+ *
+ * @internal
+ */
+class Filesystem {
+    /**
+     * Lists files synchronously because framework modules are currently loaded
+     * synchronously during bootstrap. Application storage listings are async.
+     */
+    files(directory, recursively = false) {
+        return node_fs_1.default.readdirSync(directory).reduce((files, name) => {
+            const filePath = node_path_1.default.join(directory, name);
+            const stats = node_fs_1.default.statSync(filePath);
+            if (stats.isFile()) {
+                files.push(new File_1.File(filePath));
+            }
+            if (recursively && stats.isDirectory()) {
+                files.push(...this.files(filePath, true));
+            }
+            return files;
+        }, []);
+    }
+    async read(filePath) {
+        return fileSystem.readFile(filePath);
+    }
+    async exists(filePath) {
+        try {
+            await fileSystem.access(filePath);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    async save(file, destination, name) {
+        const stats = await fileSystem.stat(destination).catch(() => undefined);
+        const destinationPath = stats?.isDirectory()
+            ? node_path_1.default.join(destination, String(name ?? file.name))
+            : destination;
+        await fileSystem.mkdir(node_path_1.default.dirname(destinationPath), { recursive: true });
+        await fileSystem.copyFile(file.path, destinationPath);
+        return new File_1.File(destinationPath);
+    }
+    async put(filePath, content, options) {
+        await fileSystem.mkdir(node_path_1.default.dirname(filePath), { recursive: true });
+        await fileSystem.writeFile(filePath, content, options);
+        return new File_1.File(filePath);
+    }
+    async makeDirectory(directory) {
+        await fileSystem.mkdir(directory, { recursive: true });
+    }
+    async deleteDirectory(directory) {
+        if (await this.exists(directory)) {
+            await fileSystem.rm(directory, { recursive: true });
+        }
+    }
+    async delete(filePath) {
+        if (!(await this.exists(filePath))) {
+            return;
+        }
+        if ((await fileSystem.stat(filePath)).isDirectory()) {
+            throw new Error('Can not delete because this path leads to a directory and not a file.');
+        }
+        await fileSystem.unlink(filePath);
+    }
+}
+exports.Filesystem = Filesystem;
+//# sourceMappingURL=Filesystem.js.map

package/build/Storage/Filesystem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Filesystem.js","sourceRoot":"","sources":["../../Storage/Filesystem.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAAwB;AACxB,6DAA8C;AAC9C,0DAA4B;AAC5B,iCAA6B;AAE7B;;;;;;;;;;;;;GAaG;AACH,MAAa,UAAU;IACnB;;;OAGG;IACH,KAAK,CAAC,SAAiB,EAAE,WAAW,GAAG,KAAK;QACxC,OAAO,iBAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACpD,MAAM,QAAQ,GAAG,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;YAC3C,MAAM,KAAK,GAAG,iBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YACnC,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;gBACjB,KAAK,CAAC,IAAI,CAAC,IAAI,WAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;YAClC,CAAC;YACD,IAAI,WAAW,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;gBACrC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;YAC7C,CAAC;YACD,OAAO,KAAK,CAAA;QAChB,CAAC,EAAE,EAAY,CAAC,CAAA;IACpB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,QAAgB;QACvB,OAAO,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACxC,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAgB;QACzB,IAAI,CAAC;YACD,MAAM,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YACjC,OAAO,IAAI,CAAA;QACf,CAAC;QAAC,MAAM,CAAC;YACL,OAAO,KAAK,CAAA;QAChB,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAU,EAAE,WAAmB,EAAE,IAAsB;QAC9D,MAAM,KAAK,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAA;QACvE,MAAM,eAAe,GAAG,KAAK,EAAE,WAAW,EAAE;YACxC,CAAC,CAAC,mBAAI,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC,CAAC,WAAW,CAAA;QACjB,MAAM,UAAU,CAAC,KAAK,CAAC,mBAAI,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAA;QACxE,MAAM,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,CAAA;QACrD,OAAO,IAAI,WAAI,CAAC,eAAe,CAAC,CAAA;IACpC,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,QAAgB,EAAE,OAAwB,EAAE,OAAoD;QACtG,MAAM,UAAU,CAAC,KAAK,CAAC,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAA;QACjE,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;QACtD,OAAO,IAAI,WAAI,CAAC,QAAQ,CAAC,CAAA;IAC7B,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,SAAiB;QACjC,MAAM,UAAU,CAAC,KAAK,CAAC,SAAS,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAA;IACxD,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,SAAiB;QACnC,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/B,MAAM,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAA;QACrD,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAgB;QACzB,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YACjC,OAAM;QACV,CAAC;QACD,IAAI,CAAC,MAAM,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAA;QAC5F,CAAC;QACD,MAAM,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IACrC,CAAC;CACJ;AAnED,gCAmEC"}

package/build/Storage/PathPrefixer.d.ts

@@ -0,0 +1,9 @@
+export declare class PathPrefixer {
+    private readonly prefixValue;
+    constructor(prefix?: string);
+    normalize(key: string, allowEmpty?: boolean): string;
+    prefix(key: string, allowEmpty?: boolean): string;
+    stripPrefix(key: string): string;
+    resolve(root: string, key: string): string;
+}
+//# sourceMappingURL=PathPrefixer.d.ts.map

package/build/Storage/PathPrefixer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathPrefixer.d.ts","sourceRoot":"","sources":["../../Storage/PathPrefixer.ts"],"names":[],"mappings":"AAGA,qBAAa,YAAY;IACrB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;gBAExB,MAAM,SAAK;IAIvB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,UAAQ,GAAG,MAAM;IAalD,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,UAAQ,GAAG,MAAM;IAK/C,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAchC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;CAS7C"}

package/build/Storage/PathPrefixer.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathPrefixer = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const errors_1 = require("./errors");
+class PathPrefixer {
+    prefixValue;
+    constructor(prefix = '') {
+        this.prefixValue = this.normalize(prefix, true);
+    }
+    normalize(key, allowEmpty = false) {
+        if (key.includes('\0')) {
+            throw new errors_1.InvalidStorageKey(key);
+        }
+        const normalized = key.replaceAll('\\', '/').replace(/^\/+|\/+$/g, '').replace(/\/{2,}/g, '/');
+        const segments = normalized.split('/');
+        if (segments.includes('..') || (!allowEmpty && !normalized)) {
+            throw new errors_1.InvalidStorageKey(key);
+        }
+        return normalized;
+    }
+    prefix(key, allowEmpty = false) {
+        const normalized = this.normalize(key, allowEmpty);
+        return [this.prefixValue, normalized].filter(Boolean).join('/');
+    }
+    stripPrefix(key) {
+        const normalized = this.normalize(key, true);
+        if (!this.prefixValue) {
+            return normalized;
+        }
+        if (normalized === this.prefixValue) {
+            return '';
+        }
+        if (!normalized.startsWith(`${this.prefixValue}/`)) {
+            throw new errors_1.InvalidStorageKey(key);
+        }
+        return normalized.slice(this.prefixValue.length + 1);
+    }
+    resolve(root, key) {
+        const normalized = this.prefix(key);
+        const resolvedRoot = node_path_1.default.resolve(root);
+        const resolved = node_path_1.default.resolve(resolvedRoot, ...normalized.split('/'));
+        if (resolved !== resolvedRoot && !resolved.startsWith(`${resolvedRoot}${node_path_1.default.sep}`)) {
+            throw new errors_1.InvalidStorageKey(key);
+        }
+        return resolved;
+    }
+}
+exports.PathPrefixer = PathPrefixer;
+//# sourceMappingURL=PathPrefixer.js.map

package/build/Storage/PathPrefixer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathPrefixer.js","sourceRoot":"","sources":["../../Storage/PathPrefixer.ts"],"names":[],"mappings":";;;;;;AAAA,0DAA4B;AAC5B,qCAA4C;AAE5C,MAAa,YAAY;IACJ,WAAW,CAAQ;IAEpC,YAAY,MAAM,GAAG,EAAE;QACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACnD,CAAC;IAED,SAAS,CAAC,GAAW,EAAE,UAAU,GAAG,KAAK;QACrC,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,0BAAiB,CAAC,GAAG,CAAC,CAAA;QACpC,CAAC;QAED,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;QAC9F,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACtC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,0BAAiB,CAAC,GAAG,CAAC,CAAA;QACpC,CAAC;QACD,OAAO,UAAU,CAAA;IACrB,CAAC;IAED,MAAM,CAAC,GAAW,EAAE,UAAU,GAAG,KAAK;QAClC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QAClD,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACnE,CAAC;IAED,WAAW,CAAC,GAAW;QACnB,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;QAC5C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACpB,OAAO,UAAU,CAAA;QACrB,CAAC;QACD,IAAI,UAAU,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;YAClC,OAAO,EAAE,CAAA;QACb,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,WAAW,GAAG,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,0BAAiB,CAAC,GAAG,CAAC,CAAA;QACpC,CAAC;QACD,OAAO,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACxD,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,GAAW;QAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACnC,MAAM,YAAY,GAAG,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACvC,MAAM,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;QACrE,IAAI,QAAQ,KAAK,YAAY,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,YAAY,GAAG,mBAAI,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;YAClF,MAAM,IAAI,0BAAiB,CAAC,GAAG,CAAC,CAAA;QACpC,CAAC;QACD,OAAO,QAAQ,CAAA;IACnB,CAAC;CACJ;AAhDD,oCAgDC"}

package/build/Storage/Storage.d.ts

@@ -1,13 +1,41 @@
+import { Readable } from 'node:stream';
 import { File } from './File';
+import { StorageDisk } from './StorageDisk';
+import { StorageDriver } from './StorageDriver';
+import { UploadedFile } from './UploadedFile';
+import { ListOptions, StorageConfiguration, StorageContent, StorageDiskConfig, TemporaryUrlOptions, Visibility, WriteOptions } from './types';
+export type StorageDriverFactory = (config: StorageDiskConfig, name: string, storage: Storage) => StorageDriver;
 export declare class Storage {
-    files(directory: string, recursively?: boolean): File[];
-    read(filePath: string): Promise<Buffer>;
-    exists(filePath: string): Promise<boolean>;
-    save(file: File, directory?: string, name?: string | number): Promise<File>;
-    put(filePath: string, content: string | Buffer, options?: any): Promise<File>;
-    makeDirectory(directory: string): Promise<void>;
-    deleteDirectory(directory: string): Promise<void>;
-    delete(filePath: string): Promise<void>;
-    private generateRandomFileName;
+    readonly config: StorageConfiguration;
+    private readonly disks;
+    private readonly factories;
+    private readonly resolving;
+    constructor(config?: StorageConfiguration);
+    disk(name?: string): StorageDisk;
+    build(config: StorageDiskConfig, name?: string): StorageDisk;
+    extend(driver: string, factory: StorageDriverFactory): this;
+    set(name: string, disk: StorageDisk): this;
+    forget(name: string): this;
+    fake(name?: string): StorageDisk;
+    put(key: string, content: StorageContent, options?: WriteOptions): Promise<File>;
+    putFile(key: string, file: UploadedFile, options?: WriteOptions): Promise<File>;
+    read(key: string): Promise<Buffer>;
+    get(key: string): Promise<Buffer>;
+    readStream(key: string): Promise<Readable>;
+    json<T>(key: string): Promise<T>;
+    exists(key: string): Promise<boolean>;
+    missing(key: string): Promise<boolean>;
+    stat(key: string): Promise<File>;
+    list(prefix?: string, options?: ListOptions): AsyncIterable<import("./types").StorageEntry>;
+    files(prefix?: string, options?: ListOptions): Promise<File[]>;
+    directories(prefix?: string): Promise<string[]>;
+    delete(key: string): Promise<void>;
+    deleteDirectory(prefix: string): Promise<void>;
+    copy(source: string, destination: string): Promise<File>;
+    move(source: string, destination: string): Promise<File>;
+    visibility(key: string): Promise<Visibility>;
+    setVisibility(key: string, visibility: Visibility): Promise<void>;
+    url(key: string): string;
+    temporaryUrl(key: string, expiresInSeconds: number, options?: TemporaryUrlOptions): Promise<string>;
 }
 //# sourceMappingURL=Storage.d.ts.map

package/build/Storage/Storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Storage.d.ts","sourceRoot":"","sources":["../../Storage/Storage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAI7B,qBAAa,OAAO;IAChB,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,UAAQ,GAAG,IAAI,EAAE;IAmB/C,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvC,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS1C,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,GAAE,MAAW,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB/E,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAY7E,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjD,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY7C,OAAO,CAAC,sBAAsB;CAOjC"}
+{"version":3,"file":"Storage.d.ts","sourceRoot":"","sources":["../../Storage/Storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAMtC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,EACH,WAAW,EACX,oBAAoB,EACpB,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,UAAU,EACV,YAAY,EACf,MAAM,SAAS,CAAA;AAEhB,MAAM,MAAM,oBAAoB,GAAG,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,aAAa,CAAA;AAO/G,qBAAa,OAAO;aAKY,MAAM,EAAE,oBAAoB;IAJxD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiC;IACvD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0C;IACpE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;gBAElB,MAAM,GAAE,oBAA2C;IAc/E,IAAI,CAAC,IAAI,SAAsB,GAAG,WAAW;IAsB7C,KAAK,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,SAAa,GAAG,WAAW;IAQhE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAK3D,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,IAAI;IAK1C,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK1B,IAAI,CAAC,IAAI,SAAsB,GAAG,WAAW;IAM7C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhF,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/E,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAElC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAEjC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAE1C,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAEhC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAErC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAEtC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhC,IAAI,CAAC,MAAM,SAAK,EAAE,OAAO,CAAC,EAAE,WAAW;IAEvC,KAAK,CAAC,MAAM,SAAK,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAE1D,WAAW,CAAC,MAAM,SAAK,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAE3C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAElC,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAE9C,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAExD,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAExD,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAE5C,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAEjE,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAExB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtG"}

package/build/Storage/Storage.js

@@ -1,119 +1,103 @@
 "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 __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;
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Storage = void 0;
-const fileSystemDeprecated = __importStar(require("fs"));
-const File_1 = require("./File");
-const path = __importStar(require("path"));
-const fileSystem = __importStar(require("node:fs/promises"));
+const LocalDriver_1 = require("./Drivers/LocalDriver");
+const MemoryDriver_1 = require("./Drivers/MemoryDriver");
+const ReadOnlyDriver_1 = require("./Drivers/ReadOnlyDriver");
+const S3Driver_1 = require("./Drivers/S3Driver");
+const ScopedDriver_1 = require("./Drivers/ScopedDriver");
+const StorageDisk_1 = require("./StorageDisk");
+const errors_1 = require("./errors");
+const defaultConfiguration = {
+    default: 'local',
+    disks: { local: { driver: 'local', root: 'storage/app' } },
+};
 class Storage {
-    files(directory, recursively = false) {
-        return fileSystemDeprecated
-            .readdirSync(directory) // TODO make this async
-            .reduce((files, name) => {
-            const filePath = path.join(directory, name);
-            const stats = fileSystemDeprecated.statSync(filePath);
-            if (stats.isFile()) {
-                const file = new File_1.File(name);
-                file.directory = directory;
-                files.push(file);
-            }
-            if (recursively && stats.isDirectory()) {
-                files = files.concat(this.files(filePath));
-            }
-            return files;
-        }, []);
-    }
-    async read(filePath) {
-        return fileSystem.readFile(filePath);
+    config;
+    disks = new Map();
+    factories = new Map();
+    resolving = new Set();
+    constructor(config = defaultConfiguration) {
+        this.config = config;
+        this.extend('local', config => new LocalDriver_1.LocalDriver(config));
+        this.extend('memory', config => new MemoryDriver_1.MemoryDriver(config));
+        this.extend('s3', config => new S3Driver_1.S3Driver(config));
+        this.extend('scoped', config => {
+            const scoped = config;
+            return new ScopedDriver_1.ScopedDriver(this.disk(scoped.disk).driver(), scoped.prefix);
+        });
+        this.extend('read-only', config => {
+            const readOnly = config;
+            return new ReadOnlyDriver_1.ReadOnlyDriver(this.disk(readOnly.disk).driver());
+        });
     }
-    async exists(filePath) {
-        try {
-            await fileSystem.access(filePath);
-            return true;
+    disk(name = this.config.default) {
+        const cached = this.disks.get(name);
+        if (cached) {
+            return cached;
         }
-        catch (error) {
-            return false;
+        const config = this.config.disks[name];
+        if (!config) {
+            throw new errors_1.StorageDiskNotFound(name);
         }
-    }
-    async save(file, directory = '', name) {
-        const newPath = path.join(directory, file.name);
-        if (!file.name) {
-            file.name = String(name || this.generateRandomFileName() + '.' + file.extension);
+        if (this.resolving.has(name)) {
+            throw new Error(`Circular storage disk configuration detected at '${name}'.`);
         }
-        if (directory && !(await this.exists(directory))) {
-            await this.makeDirectory(directory);
+        this.resolving.add(name);
+        try {
+            const disk = this.build(config, name);
+            this.disks.set(name, disk);
+            return disk;
+        }
+        finally {
+            this.resolving.delete(name);
         }
-        return new Promise(async (resolve, reject) => {
-            fileSystemDeprecated
-                .createReadStream(file.path)
-                .on('error', reject)
-                .pipe(fileSystemDeprecated.createWriteStream(newPath))
-                .on('finish', () => resolve(file))
-                .on('error', reject);
-        });
     }
-    async put(filePath, content, options) {
-        const file = new File_1.File(path.basename(filePath));
-        file.directory = path.dirname(filePath);
-        if (file.directory && !(await this.exists(file.directory))) {
-            await this.makeDirectory(file.directory);
+    build(config, name = 'ondemand') {
+        const factory = this.factories.get(config.driver);
+        if (!factory) {
+            throw new errors_1.StorageDriverNotSupported(config.driver);
         }
-        await fileSystem.writeFile(filePath, content, options);
-        return file;
+        return new StorageDisk_1.StorageDisk(name, factory(config, name, this));
     }
-    async makeDirectory(directory) {
-        await fileSystem.mkdir(directory, { recursive: true });
+    extend(driver, factory) {
+        this.factories.set(driver, factory);
+        return this;
     }
-    async deleteDirectory(directory) {
-        if (await this.exists(directory)) {
-            await fileSystem.rm(directory, { recursive: true });
-        }
+    set(name, disk) {
+        this.disks.set(name, disk);
+        return this;
     }
-    async delete(filePath) {
-        if (!(await this.exists(filePath))) {
-            return;
-        }
-        if ((await fileSystem.stat(filePath)).isDirectory()) {
-            throw new Error('Can not delete because this path leads to a directory and not a file.');
-        }
-        await fileSystem.unlink(filePath);
+    forget(name) {
+        this.disks.delete(name);
+        return this;
+    }
+    fake(name = this.config.default) {
+        const disk = new StorageDisk_1.StorageDisk(name, new MemoryDriver_1.MemoryDriver({ driver: 'memory' }));
+        this.set(name, disk);
+        return disk;
     }
-    generateRandomFileName() {
-        const stringDomain = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890';
-        return (String.random(13, stringDomain) + '-' + new Date().getTime().toString());
+    put(key, content, options) { return this.disk().put(key, content, options); }
+    putFile(key, file, options) { return this.disk().putFile(key, file, options); }
+    read(key) { return this.disk().read(key); }
+    get(key) { return this.disk().get(key); }
+    readStream(key) { return this.disk().readStream(key); }
+    json(key) { return this.disk().json(key); }
+    exists(key) { return this.disk().exists(key); }
+    missing(key) { return this.disk().missing(key); }
+    stat(key) { return this.disk().stat(key); }
+    list(prefix = '', options) { return this.disk().list(prefix, options); }
+    files(prefix = '', options) { return this.disk().files(prefix, options); }
+    directories(prefix = '') { return this.disk().directories(prefix); }
+    delete(key) { return this.disk().delete(key); }
+    deleteDirectory(prefix) { return this.disk().deleteDirectory(prefix); }
+    copy(source, destination) { return this.disk().copy(source, destination); }
+    move(source, destination) { return this.disk().move(source, destination); }
+    visibility(key) { return this.disk().visibility(key); }
+    setVisibility(key, visibility) { return this.disk().setVisibility(key, visibility); }
+    url(key) { return this.disk().url(key); }
+    temporaryUrl(key, expiresInSeconds, options) {
+        return this.disk().temporaryUrl(key, expiresInSeconds, options);
     }
 }
 exports.Storage = Storage;