@daiso-tech/core 0.48.5 → 0.49.0

package/dist/file-storage/implementations/derivables/file-storage/file-serde-transformer.js

@@ -0,0 +1,87 @@
+/**
+ * @module FileStorage
+ */
+import {} from "../../../../event-bus/contracts/_module.js";
+import {} from "../../../../file-storage/contracts/_module.js";
+import { File, } from "../../../../file-storage/implementations/derivables/file-storage/file.js";
+import {} from "../../../../namespace/contracts/_module.js";
+import {} from "../../../../serde/contracts/_module.js";
+import { getConstructorName, } from "../../../../utilities/_module.js";
+/**
+ * @internal
+ */
+export class FileSerdeTransformer {
+    onlyLowercase;
+    keyValidator;
+    originalAdapter;
+    adapter;
+    namespace;
+    eventBus;
+    serdeTransformerName;
+    defaultContentType;
+    defaultContentDisposition;
+    defaultContentEncoding;
+    defaultCacheControl;
+    defaultContentLanguage;
+    constructor(settings) {
+        const { onlyLowercase, keyValidator, adapter, namespace, eventBus, serdeTransformerName, defaultContentType, defaultCacheControl, defaultContentDisposition, defaultContentEncoding, defaultContentLanguage, originalAdapter, } = settings;
+        this.onlyLowercase = onlyLowercase;
+        this.keyValidator = keyValidator;
+        this.originalAdapter = originalAdapter;
+        this.adapter = adapter;
+        this.namespace = namespace;
+        this.eventBus = eventBus;
+        this.serdeTransformerName = serdeTransformerName;
+        this.defaultContentType = defaultContentType;
+        this.defaultCacheControl = defaultCacheControl;
+        this.defaultContentDisposition = defaultContentDisposition;
+        this.defaultContentEncoding = defaultContentEncoding;
+        this.defaultContentLanguage = defaultContentLanguage;
+    }
+    get name() {
+        return [
+            "file",
+            this.serdeTransformerName,
+            getConstructorName(this.originalAdapter),
+            this.namespace.toString(),
+        ].filter((str) => str !== "");
+    }
+    isApplicable(value) {
+        const isFile = value instanceof File && getConstructorName(value) === File.name;
+        if (!isFile) {
+            return false;
+        }
+        const isSerdTransformerNameMathcing = this.serdeTransformerName ===
+            value._internal_getSerdeTransformerName();
+        const isNamespaceMatching = this.namespace.toString() ===
+            value._internal_getNamespace().toString();
+        const isAdapterMatching = getConstructorName(this.originalAdapter) ===
+            getConstructorName(value._internal_getAdapter());
+        return (isSerdTransformerNameMathcing &&
+            isNamespaceMatching &&
+            isAdapterMatching);
+    }
+    deserialize(serializedValue) {
+        const { key } = serializedValue;
+        const keyObj = this.namespace.create(key);
+        return new File({
+            onlyLowercase: this.onlyLowercase,
+            keyValidator: this.keyValidator,
+            originalAdapter: this.originalAdapter,
+            defaultContentType: this.defaultContentType,
+            defaultCacheControl: this.defaultCacheControl,
+            defaultContentDisposition: this.defaultContentDisposition,
+            defaultContentEncoding: this.defaultContentEncoding,
+            defaultContentLanguage: this.defaultContentLanguage,
+            eventDispatcher: this.eventBus,
+            adapter: this.adapter,
+            key: keyObj,
+            serdeTransformerName: this.serdeTransformerName,
+            namespace: this.namespace,
+        });
+    }
+    serialize(deserializedValue) {
+        return File._internal_serialize(deserializedValue);
+    }
+}
+//# sourceMappingURL=file-serde-transformer.js.map

package/dist/file-storage/implementations/derivables/file-storage/file-serde-transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-serde-transformer.js","sourceRoot":"","sources":["../../../../../src/file-storage/implementations/derivables/file-storage/file-serde-transformer.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAkB,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAIN,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACH,IAAI,GAEP,MAAM,gEAAgE,CAAC;AACxE,OAAO,EAAmB,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAA0B,MAAM,8BAA8B,CAAC;AACtE,OAAO,EACH,kBAAkB,GAGrB,MAAM,wBAAwB,CAAC;AAoBhC;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAGZ,aAAa,CAAU;IACvB,YAAY,CAA4C;IACxD,eAAe,CAA6B;IAC5C,OAAO,CAA4B;IACnC,SAAS,CAAa;IACtB,QAAQ,CAA0B;IAClC,oBAAoB,CAAS;IAC7B,kBAAkB,CAAS;IAC3B,yBAAyB,CAAgB;IACzC,sBAAsB,CAAgB;IACtC,mBAAmB,CAAgB;IACnC,sBAAsB,CAAgB;IAEvD,YAAY,QAAsC;QAC9C,MAAM,EACF,aAAa,EACb,YAAY,EACZ,OAAO,EACP,SAAS,EACT,QAAQ,EACR,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,yBAAyB,EACzB,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,GAClB,GAAG,QAAQ,CAAC;QAEb,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC/C,IAAI,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;QAC3D,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;QACrD,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;IACzD,CAAC;IAED,IAAI,IAAI;QACJ,OAAO;YACH,MAAM;YACN,IAAI,CAAC,oBAAoB;YACzB,kBAAkB,CAAC,IAAI,CAAC,eAAe,CAAC;YACxC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;SAC5B,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,YAAY,CAAC,KAAc;QACvB,MAAM,MAAM,GACR,KAAK,YAAY,IAAI,IAAI,kBAAkB,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC;QACrE,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,6BAA6B,GAC/B,IAAI,CAAC,oBAAoB;YACzB,KAAK,CAAC,iCAAiC,EAAE,CAAC;QAE9C,MAAM,mBAAmB,GACrB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;YACzB,KAAK,CAAC,sBAAsB,EAAE,CAAC,QAAQ,EAAE,CAAC;QAE9C,MAAM,iBAAiB,GACnB,kBAAkB,CAAC,IAAI,CAAC,eAAe,CAAC;YACxC,kBAAkB,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC,CAAC;QAErD,OAAO,CACH,6BAA6B;YAC7B,mBAAmB;YACnB,iBAAiB,CACpB,CAAC;IACN,CAAC;IAED,WAAW,CAAC,eAAgC;QACxC,MAAM,EAAE,GAAG,EAAE,GAAG,eAAe,CAAC;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE1C,OAAO,IAAI,IAAI,CAAC;YACZ,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;YACzD,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,eAAe,EAAE,IAAI,CAAC,QAAQ;YAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,MAAM;YACX,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CAAC,CAAC;IACP,CAAC;IAED,SAAS,CAAC,iBAAuB;QAC7B,OAAO,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;IACvD,CAAC;CACJ"}

package/dist/file-storage/implementations/derivables/file-storage/file-storage.d.ts

@@ -0,0 +1,163 @@
+/**
+ * @module FileStorage
+ */
+import { type IEventBus } from "../../../../event-bus/contracts/_module.js";
+import { type FileStorageAdapterVariants, type IFile, type IFileListenable, type IFileStorage, type IFileUrlAdapter } from "../../../../file-storage/contracts/_module.js";
+import { type INamespace } from "../../../../namespace/contracts/_module.js";
+import { type ISerderRegister } from "../../../../serde/contracts/_module.js";
+import { type ITask } from "../../../../task/contracts/_module.js";
+import { type InvokableFn, type OneOrMore } from "../../../../utilities/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage"`
+ * @group Derivables
+ */
+export declare function defaultKeyValidator(key: string): string | null;
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage"`
+ * @group Derivables
+ */
+export type FileKeyValidator = InvokableFn<[key: string], string | null>;
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage"`
+ * @group Derivables
+ */
+export type FileStorageSettingsBase = {
+    /**
+     * The default content type to be used when it cannot be infered by file extension.
+     *
+     * @default "application/octet-stream"
+     */
+    defaultContentType?: string;
+    /**
+     * Note this setting is only used by cloud object storage services like aws s3, azure, or google cloud storage.
+     *
+     * @default "inline"
+     */
+    defaultContentDisposition?: string | null;
+    /**
+     * Note this setting is only used by cloud object storage services like aws s3, azure, or google cloud storage.
+     *
+     * @default null
+     */
+    defaultContentEncoding?: string | null;
+    /**
+     * Note this setting is only used by cloud object storage services like aws s3, azure, or google cloud storage.
+     *
+     * @default ""
+     */
+    defaultCacheControl?: string | null;
+    /**
+     * Note this setting is only used by cloud object storage services like aws s3, azure, or google cloud storage.
+     *
+     * @default null
+     */
+    defaultContentLanguage?: string | null;
+    /**
+     * @default true
+     */
+    onlyLowercase?: boolean;
+    /**
+     * You can pass a key validator. The method should return string error message if unvalid or null if valid.
+     * @default
+     * ```ts
+     * import { defaultKeyValidator } from "@daiso-tech/core/file-storage";
+     *
+     * defaultKeyValidator
+     * ```
+     */
+    keyValidator?: FileKeyValidator;
+    /**
+     * @default
+     * ```ts
+     * import { NoOpNamespace } from "@daiso-tech/core/namespace";
+     *
+     * new NoOpNamespace()
+     * ```
+     */
+    namespace?: INamespace;
+    /**
+     * You can pass partial {@link IFileUrlAdapter | `IFileUrlAdapter`} that can overide generating public url, signed upload and download url of the file storage adapter.
+     */
+    urlAdapter?: Partial<IFileUrlAdapter>;
+    /**
+     * @default
+     * ```ts
+     * import { EventBus } from "@daiso-tech/core/event-bus";
+     * import { NoOpEventBusAdapter } from "@daiso-tech/core/event-bus/no-op-event-bus-adapter";
+     *
+     * new EventBus({
+     *   adapter: new NoOpEventBusAdapter()
+     * })
+     * ```
+     */
+    eventBus?: IEventBus;
+    /**
+     * @default
+     * ```ts
+     * import { Serde } from "@daiso-tech/serde";
+     * import { NoOpSerdeAdapter } from "@daiso-tech/serde/no-op-serde-adapter";
+     *
+     * new Serde(new NoOpSerdeAdapter())
+     * ```
+     */
+    serde?: OneOrMore<ISerderRegister>;
+    /**
+     * @default ""
+     */
+    serdeTransformerName?: string;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage"`
+ * @group Derivables
+ */
+export type FileStorageSettings = FileStorageSettingsBase & {
+    adapter: FileStorageAdapterVariants;
+};
+/**
+ * `FileStorage` class can be derived from any {@link ISignedFileStorageAdapter | `IFileStorageAdapter`}.
+ *
+ * Note the {@link IFile | `IFile`} instances created by the `FileStorage` class are serializable and deserializable,
+ * allowing them to be seamlessly transferred across different servers, processes, and databases.
+ * This can be done directly using {@link ISerderRegister | `ISerderRegister`} or indirectly through components that rely on {@link ISerderRegister | `ISerderRegister`} internally.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage"`
+ * @group Derivables
+ */
+export declare class FileStorage implements IFileStorage {
+    private readonly eventBus;
+    private readonly originalAdapter;
+    private readonly adapter;
+    private readonly namespace;
+    private readonly serde;
+    private readonly serdeTransformerName;
+    private readonly defaultContentType;
+    private readonly defaultContentDisposition;
+    private readonly defaultContentEncoding;
+    private readonly defaultCacheControl;
+    private readonly defaultContentLanguage;
+    private readonly onlyLowercase;
+    private readonly keyValidator;
+    /**
+     * @example
+     * ```ts
+     * import { Serde } from "@daiso-tech/core/serde";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"
+     * import { FileStorag } from "@daiso-tech/core/file-storage";
+     * import { FsFileStorageAdapter } from "@daiso-tech/core/file-storage/fs-file-storage-adapter";
+     *
+     * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const fileStorageAdapter = new FsFileStorageAdapter();
+     * const fileStorage = new FileStorage({
+     *   serde,
+     *   adapter: fileStorageAdapter,
+     * })
+     * ```
+     */
+    constructor(settings: FileStorageSettings);
+    private registerToSerde;
+    create(key: string): IFile;
+    private handleUnexpectedErrorEvent;
+    clear(): ITask<void>;
+    removeMany(files: Iterable<IFile>): ITask<boolean>;
+    get events(): IFileListenable;
+}

package/dist/file-storage/implementations/derivables/file-storage/file-storage.js

@@ -0,0 +1,185 @@
+/**
+ * @module FileStorage
+ */
+import {} from "../../../../event-bus/contracts/_module.js";
+import { NoOpEventBusAdapter } from "../../../../event-bus/implementations/adapters/_module.js";
+import { EventBus } from "../../../../event-bus/implementations/derivables/_module.js";
+import { FILE_EVENTS, isFileError, } from "../../../../file-storage/contracts/_module.js";
+import { FileSerdeTransformer } from "../../../../file-storage/implementations/derivables/file-storage/file-serde-transformer.js";
+import { File } from "../../../../file-storage/implementations/derivables/file-storage/file.js";
+import { resolveFileStorageAdapter } from "../../../../file-storage/implementations/derivables/file-storage/resolve-file-storage-adapter.js";
+import {} from "../../../../hooks/_module.js";
+import {} from "../../../../namespace/contracts/_module.js";
+import { NoOpNamespace } from "../../../../namespace/implementations/_module.js";
+import {} from "../../../../serde/contracts/_module.js";
+import { NoOpSerdeAdapter } from "../../../../serde/implementations/adapters/_module.js";
+import { Serde } from "../../../../serde/implementations/derivables/_module.js";
+import {} from "../../../../task/contracts/_module.js";
+import { Task } from "../../../../task/implementations/_module.js";
+import { CORE, resolveOneOrMore, } from "../../../../utilities/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage"`
+ * @group Derivables
+ */
+export function defaultKeyValidator(key) {
+    if (key.includes("../")) {
+        return `The key cannot contain "../"`;
+    }
+    if (key.includes("\n")) {
+        return `The key cannot contain "\\n"`;
+    }
+    if (key.includes("\t")) {
+        return `The key cannot contain "\\t"`;
+    }
+    if (key.trim() === "") {
+        return "The key cannot contain only spaces or be an empty string";
+    }
+    return null;
+}
+/**
+ * `FileStorage` class can be derived from any {@link ISignedFileStorageAdapter | `IFileStorageAdapter`}.
+ *
+ * Note the {@link IFile | `IFile`} instances created by the `FileStorage` class are serializable and deserializable,
+ * allowing them to be seamlessly transferred across different servers, processes, and databases.
+ * This can be done directly using {@link ISerderRegister | `ISerderRegister`} or indirectly through components that rely on {@link ISerderRegister | `ISerderRegister`} internally.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage"`
+ * @group Derivables
+ */
+export class FileStorage {
+    eventBus;
+    originalAdapter;
+    adapter;
+    namespace;
+    serde;
+    serdeTransformerName;
+    defaultContentType;
+    defaultContentDisposition;
+    defaultContentEncoding;
+    defaultCacheControl;
+    defaultContentLanguage;
+    onlyLowercase;
+    keyValidator;
+    /**
+     * @example
+     * ```ts
+     * import { Serde } from "@daiso-tech/core/serde";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"
+     * import { FileStorag } from "@daiso-tech/core/file-storage";
+     * import { FsFileStorageAdapter } from "@daiso-tech/core/file-storage/fs-file-storage-adapter";
+     *
+     * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const fileStorageAdapter = new FsFileStorageAdapter();
+     * const fileStorage = new FileStorage({
+     *   serde,
+     *   adapter: fileStorageAdapter,
+     * })
+     * ```
+     */
+    constructor(settings) {
+        const { adapter, namespace = new NoOpNamespace(), eventBus = new EventBus({
+            adapter: new NoOpEventBusAdapter(),
+        }), onlyLowercase = false, keyValidator = defaultKeyValidator, serde = new Serde(new NoOpSerdeAdapter()), serdeTransformerName = "", defaultContentType = "application/octet-stream", defaultCacheControl = null, defaultContentDisposition = "inline", defaultContentEncoding = null, defaultContentLanguage = null, urlAdapter = {}, } = settings;
+        this.onlyLowercase = onlyLowercase;
+        this.keyValidator = keyValidator;
+        this.originalAdapter = adapter;
+        this.defaultContentType = defaultContentType;
+        this.defaultContentDisposition = defaultContentDisposition;
+        this.defaultContentEncoding = defaultContentEncoding;
+        this.defaultCacheControl = defaultCacheControl;
+        this.defaultContentLanguage = defaultContentLanguage;
+        this.adapter = resolveFileStorageAdapter(adapter, urlAdapter);
+        this.namespace = namespace;
+        this.eventBus = eventBus;
+        this.serde = serde;
+        this.serdeTransformerName = serdeTransformerName;
+        this.registerToSerde();
+    }
+    registerToSerde() {
+        const transformer = new FileSerdeTransformer({
+            onlyLowercase: this.onlyLowercase,
+            keyValidator: this.keyValidator,
+            originalAdapter: this.originalAdapter,
+            defaultContentType: this.defaultContentType,
+            defaultCacheControl: this.defaultCacheControl,
+            defaultContentDisposition: this.defaultContentDisposition,
+            defaultContentEncoding: this.defaultContentEncoding,
+            defaultContentLanguage: this.defaultContentLanguage,
+            adapter: this.adapter,
+            eventBus: this.eventBus,
+            namespace: this.namespace,
+            serdeTransformerName: this.serdeTransformerName,
+        });
+        for (const serde of resolveOneOrMore(this.serde)) {
+            serde.registerCustom(transformer, CORE);
+        }
+    }
+    create(key) {
+        return new File({
+            onlyLowercase: this.onlyLowercase,
+            keyValidator: this.keyValidator,
+            originalAdapter: this.originalAdapter,
+            defaultContentType: this.defaultContentType,
+            defaultCacheControl: this.defaultCacheControl,
+            defaultContentDisposition: this.defaultContentDisposition,
+            defaultContentEncoding: this.defaultContentEncoding,
+            defaultContentLanguage: this.defaultContentLanguage,
+            adapter: this.adapter,
+            key: this.namespace.create(key),
+            eventDispatcher: this.eventBus,
+            serdeTransformerName: this.serdeTransformerName,
+            namespace: this.namespace,
+        });
+    }
+    handleUnexpectedErrorEvent = () => {
+        return async (args, next) => {
+            try {
+                return await next(...args);
+            }
+            catch (error) {
+                if (isFileError(error)) {
+                    throw error;
+                }
+                this.eventBus
+                    .dispatch(FILE_EVENTS.UNEXPECTED_ERROR, {
+                    error,
+                })
+                    .detach();
+                throw error;
+            }
+        };
+    };
+    clear() {
+        return new Task(async () => {
+            await this.adapter.removeByPrefix(this.namespace.toString());
+            this.eventBus.dispatch(FILE_EVENTS.CLEARED, {}).detach();
+        }).pipe([this.handleUnexpectedErrorEvent()]);
+    }
+    removeMany(files) {
+        return new Task(async () => {
+            const namespacedKeys = [...files].map((file) => {
+                return file.key.toString();
+            });
+            const hasRemovedAtLeastOne = await this.adapter.removeMany(namespacedKeys);
+            if (hasRemovedAtLeastOne) {
+                for (const file of files) {
+                    this.eventBus
+                        .dispatch(FILE_EVENTS.REMOVED, { file })
+                        .detach();
+                }
+            }
+            else {
+                for (const file of files) {
+                    this.eventBus
+                        .dispatch(FILE_EVENTS.NOT_FOUND, { file })
+                        .detach();
+                }
+            }
+            return hasRemovedAtLeastOne;
+        }).pipe([this.handleUnexpectedErrorEvent()]);
+    }
+    get events() {
+        return this.eventBus;
+    }
+}
+//# sourceMappingURL=file-storage.js.map

package/dist/file-storage/implementations/derivables/file-storage/file-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-storage.js","sourceRoot":"","sources":["../../../../../src/file-storage/implementations/derivables/file-storage/file-storage.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAkB,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AACtF,OAAO,EAAE,QAAQ,EAAE,MAAM,mDAAmD,CAAC;AAC7E,OAAO,EACH,WAAW,EACX,WAAW,GAQd,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,kFAAkF,CAAC;AACxH,OAAO,EAAE,IAAI,EAAE,MAAM,gEAAgE,CAAC;AACtF,OAAO,EAAE,yBAAyB,EAAE,MAAM,wFAAwF,CAAC;AACnI,OAAO,EAA0B,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAmB,MAAM,kCAAkC,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAC;AACvE,OAAO,EAAwB,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AAC/E,OAAO,EAAE,KAAK,EAAE,MAAM,+CAA+C,CAAC;AACtE,OAAO,EAAc,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,IAAI,EAAE,MAAM,mCAAmC,CAAC;AACzD,OAAO,EACH,IAAI,EACJ,gBAAgB,GAGnB,MAAM,wBAAwB,CAAC;AAEhC;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,GAAW;IAC3C,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,8BAA8B,CAAC;IAC1C,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACrB,OAAO,8BAA8B,CAAC;IAC1C,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACrB,OAAO,8BAA8B,CAAC;IAC1C,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACpB,OAAO,0DAA0D,CAAC;IACtE,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAqHD;;;;;;;;;GASG;AACH,MAAM,OAAO,WAAW;IACH,QAAQ,CAA0B;IAClC,eAAe,CAA6B;IAC5C,OAAO,CAA4B;IACnC,SAAS,CAAa;IACtB,KAAK,CAA6B;IAClC,oBAAoB,CAAS;IAC7B,kBAAkB,CAAS;IAC3B,yBAAyB,CAAgB;IACzC,sBAAsB,CAAgB;IACtC,mBAAmB,CAAgB;IACnC,sBAAsB,CAAgB;IACtC,aAAa,CAAU;IACvB,YAAY,CAA4C;IAEzE;;;;;;;;;;;;;;;OAeG;IACH,YAAY,QAA6B;QACrC,MAAM,EACF,OAAO,EACP,SAAS,GAAG,IAAI,aAAa,EAAE,EAC/B,QAAQ,GAAG,IAAI,QAAQ,CAAC;YACpB,OAAO,EAAE,IAAI,mBAAmB,EAAE;SACrC,CAAC,EACF,aAAa,GAAG,KAAK,EACrB,YAAY,GAAG,mBAAmB,EAClC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,gBAAgB,EAAE,CAAC,EACzC,oBAAoB,GAAG,EAAE,EACzB,kBAAkB,GAAG,0BAA0B,EAC/C,mBAAmB,GAAG,IAAI,EAC1B,yBAAyB,GAAG,QAAQ,EACpC,sBAAsB,GAAG,IAAI,EAC7B,sBAAsB,GAAG,IAAI,EAC7B,UAAU,GAAG,EAAE,GAClB,GAAG,QAAQ,CAAC;QAEb,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;QAC/B,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;QAC3D,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;QACrD,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC/C,IAAI,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;QACrD,IAAI,CAAC,OAAO,GAAG,yBAAyB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,eAAe,EAAE,CAAC;IAC3B,CAAC;IAEO,eAAe;QACnB,MAAM,WAAW,GAAG,IAAI,oBAAoB,CAAC;YACzC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;YACzD,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;SAClD,CAAC,CAAC;QACH,KAAK,MAAM,KAAK,IAAI,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/C,KAAK,CAAC,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC5C,CAAC;IACL,CAAC;IAED,MAAM,CAAC,GAAW;QACd,OAAO,IAAI,IAAI,CAAC;YACZ,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;YACzD,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;YACnD,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC;YAC/B,eAAe,EAAE,IAAI,CAAC,QAAQ;YAC9B,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;YAC/C,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CAAC,CAAC;IACP,CAAC;IAEO,0BAA0B,GAAG,GAGQ,EAAE;QAC3C,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;YACxB,IAAI,CAAC;gBACD,OAAO,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;YAC/B,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACtB,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrB,MAAM,KAAK,CAAC;gBAChB,CAAC;gBAED,IAAI,CAAC,QAAQ;qBACR,QAAQ,CAAC,WAAW,CAAC,gBAAgB,EAAE;oBACpC,KAAK;iBACR,CAAC;qBACD,MAAM,EAAE,CAAC;gBAEd,MAAM,KAAK,CAAC;YAChB,CAAC;QACL,CAAC,CAAC;IACN,CAAC,CAAC;IAEF,KAAK;QACD,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE;YACvB,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAC7D,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,0BAA0B,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,UAAU,CAAC,KAAsB;QAC7B,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,EAAE;YACvB,MAAM,cAAc,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC/B,CAAC,CAAC,CAAC;YAEH,MAAM,oBAAoB,GACtB,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YAElD,IAAI,oBAAoB,EAAE,CAAC;gBACvB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACvB,IAAI,CAAC,QAAQ;yBACR,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC;yBACvC,MAAM,EAAE,CAAC;gBAClB,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACvB,IAAI,CAAC,QAAQ;yBACR,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC;yBACzC,MAAM,EAAE,CAAC;gBAClB,CAAC;YACL,CAAC;YAED,OAAO,oBAAoB,CAAC;QAChC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,0BAA0B,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;CACJ"}

package/dist/file-storage/implementations/derivables/file-storage/file.d.ts

@@ -0,0 +1,114 @@
+/**
+ * @module FileStorage
+ */
+import { Buffer } from "node:buffer";
+import { Readable } from "stream";
+import { type IEventDispatcher } from "../../../../event-bus/contracts/_module.js";
+import { type IFile, type ISignedFileStorageAdapter, type FileMetadata, type WritableFileStream, type FileEventMap, type FileDownloadUrlOptions, type WritableFileContent, type FileStorageAdapterVariants, type FileUploadUrlOptions } from "../../../../file-storage/contracts/_module.js";
+import { type IKey, type INamespace } from "../../../../namespace/contracts/_module.js";
+import { type ITask } from "../../../../task/contracts/_module.js";
+import { type InvokableFn } from "../../../../utilities/_module.js";
+/**
+ * @internal
+ */
+export type FileSettings = {
+    onlyLowercase: boolean;
+    keyValidator: InvokableFn<[key: string], string | null>;
+    defaultContentType: string;
+    originalAdapter: FileStorageAdapterVariants;
+    adapter: ISignedFileStorageAdapter;
+    key: IKey;
+    eventDispatcher: IEventDispatcher<FileEventMap>;
+    serdeTransformerName: string;
+    namespace: INamespace;
+    defaultContentDisposition: string | null;
+    defaultContentEncoding: string | null;
+    defaultCacheControl: string | null;
+    defaultContentLanguage: string | null;
+};
+/**
+ * @internal
+ */
+export type ISerializedFile = {
+    version: "1";
+    key: string;
+};
+/**
+ * @internal
+ */
+export declare class File implements IFile {
+    /**
+     * @internal
+     */
+    static _internal_serialize(deserializedValue: File): ISerializedFile;
+    private readonly originalAdapter;
+    private readonly adapter;
+    private readonly _key;
+    private readonly eventDispatcher;
+    private readonly serdeTransformerName;
+    private readonly namespace;
+    private readonly defaultContentType;
+    private readonly defaultContentDisposition;
+    private readonly defaultContentEncoding;
+    private readonly defaultCacheControl;
+    private readonly defaultContentLanguage;
+    private readonly onlyLowercase;
+    private readonly keyValidator;
+    constructor(settings: FileSettings);
+    private handleKey;
+    _internal_getNamespace(): INamespace;
+    _internal_getSerdeTransformerName(): string;
+    _internal_getAdapter(): FileStorageAdapterVariants;
+    get key(): IKey;
+    private handleUnexpectedErrorEvent;
+    private handleNullableFoundEvent;
+    private handleBooleanFoundEvent;
+    getText(): ITask<string | null>;
+    getTextOrFail(): ITask<string>;
+    getBytes(): ITask<Uint8Array | null>;
+    getBytesOrFail(): ITask<Uint8Array>;
+    getBuffer(): ITask<Buffer | null>;
+    getBufferOrFail(): ITask<Buffer>;
+    getArrayBuffer(): ITask<ArrayBuffer | null>;
+    getArrayBufferOrFail(): ITask<ArrayBuffer>;
+    getReadable(): ITask<Readable | null>;
+    getReadableOrFail(): ITask<Readable>;
+    getReadableStream(): ITask<ReadableStream<Uint8Array> | null>;
+    getReadableStreamOrFail(): ITask<ReadableStream<Uint8Array>>;
+    getMetadata(): ITask<FileMetadata | null>;
+    getMetadataOrFail(): ITask<FileMetadata>;
+    exists(): ITask<boolean>;
+    missing(): ITask<boolean>;
+    private handleAddEvent;
+    add(content: WritableFileContent): ITask<boolean>;
+    addOrFail(content: WritableFileContent): ITask<void>;
+    private getContentType;
+    addStream(stream: WritableFileStream): ITask<boolean>;
+    addStreamOrFail(stream: WritableFileStream): ITask<void>;
+    private handleUpdateEvent;
+    update(content: WritableFileContent): ITask<boolean>;
+    updateOrFail(content: WritableFileContent): ITask<void>;
+    updateStream(stream: WritableFileStream): ITask<boolean>;
+    updateStreamOrFail(stream: WritableFileStream): ITask<void>;
+    private handlePutEvent;
+    put(content: WritableFileContent): ITask<boolean>;
+    putStream(stream: WritableFileStream): ITask<boolean>;
+    private handleRemoveEvent;
+    remove(): ITask<boolean>;
+    removeOrFail(): ITask<void>;
+    private _copy;
+    copy(destination: string): ITask<boolean>;
+    copyOrFail(destination: string): ITask<void>;
+    copyAndReplace(destination: string): ITask<boolean>;
+    copyAndReplaceOrFail(destination: string): ITask<void>;
+    private _move;
+    move(destination: string): ITask<boolean>;
+    moveOrFail(destination: string): ITask<void>;
+    moveAndReplace(destination: string): ITask<boolean>;
+    moveAndReplaceOrFail(destination: string): ITask<void>;
+    getPublicUrl(): ITask<string | null>;
+    getPublicUrlOrFail(): ITask<string>;
+    getSignedUploadUrl(options?: FileUploadUrlOptions): ITask<string>;
+    getSignedDownloadUrl(options?: FileDownloadUrlOptions): ITask<string | null>;
+    getSignedDownloadUrlOrFail(options?: FileDownloadUrlOptions): ITask<string>;
+}