@daiso-tech/core 0.48.5 → 0.49.1

package/dist/file-storage/contracts/file.errors.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @module FileStorage
+ */
+import { type IKey } from "../../namespace/contracts/_module.js";
+/**
+ * The error is thrown when a file key is not found
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export declare class KeyNotFoundFileError extends Error {
+    static create(key: IKey, cause?: unknown): KeyNotFoundFileError;
+    /**
+     * Note: Do not instantiate `KeyNotFoundFileError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * The error is thrown when a file key already exists found
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export declare class KeyExistsFileError extends Error {
+    static create(key: IKey, cause?: unknown): KeyExistsFileError;
+    /**
+     * Note: Do not instantiate `KeyExistsFileError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * The error is thrown when file key is invalid.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export declare class InvalidKeyFileError extends Error {
+    static create(message: string, cause?: unknown): InvalidKeyFileError;
+    /**
+     * Note: Do not instantiate `InvalidKeyFileError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export declare const FILE_STORAGE_ERRORS: {
+    readonly KeyNotFound: typeof KeyNotFoundFileError;
+    readonly KeyExists: typeof KeyExistsFileError;
+    readonly InvalidKey: typeof InvalidKeyFileError;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export type AllFileErrors = KeyNotFoundFileError | KeyExistsFileError;
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export declare function isFileError(value: unknown): value is AllFileErrors;

package/dist/file-storage/contracts/file.errors.js

@@ -0,0 +1,86 @@
+/**
+ * @module FileStorage
+ */
+import {} from "../../namespace/contracts/_module.js";
+/**
+ * The error is thrown when a file key is not found
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export class KeyNotFoundFileError extends Error {
+    static create(key, cause) {
+        return new KeyNotFoundFileError(`Key "${key.get()}" is not found`, cause);
+    }
+    /**
+     * Note: Do not instantiate `KeyNotFoundFileError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = KeyNotFoundFileError.name;
+    }
+}
+/**
+ * The error is thrown when a file key already exists found
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export class KeyExistsFileError extends Error {
+    static create(key, cause) {
+        return new KeyExistsFileError(`Key "${key.get()}" already exists`, cause);
+    }
+    /**
+     * Note: Do not instantiate `KeyExistsFileError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = KeyExistsFileError.name;
+    }
+}
+/**
+ * The error is thrown when file key is invalid.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export class InvalidKeyFileError extends Error {
+    static create(message, cause) {
+        return new InvalidKeyFileError(message, cause);
+    }
+    /**
+     * Note: Do not instantiate `InvalidKeyFileError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = InvalidKeyFileError.name;
+    }
+}
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export const FILE_STORAGE_ERRORS = {
+    KeyNotFound: KeyNotFoundFileError,
+    KeyExists: KeyExistsFileError,
+    InvalidKey: InvalidKeyFileError,
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Errors
+ */
+export function isFileError(value) {
+    for (const ErrorClass of Object.values(FILE_STORAGE_ERRORS)) {
+        if (!(value instanceof ErrorClass)) {
+            return false;
+        }
+    }
+    return true;
+}
+//# sourceMappingURL=file.errors.js.map

package/dist/file-storage/contracts/file.errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.errors.js","sourceRoot":"","sources":["../../../src/file-storage/contracts/file.errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAa,MAAM,kCAAkC,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC3C,MAAM,CAAC,MAAM,CAAC,GAAS,EAAE,KAAe;QACpC,OAAO,IAAI,oBAAoB,CAC3B,QAAQ,GAAG,CAAC,GAAG,EAAE,gBAAgB,EACjC,KAAK,CACR,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC;IAC1C,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IACzC,MAAM,CAAC,MAAM,CAAC,GAAS,EAAE,KAAe;QACpC,OAAO,IAAI,kBAAkB,CACzB,QAAQ,GAAG,CAAC,GAAG,EAAE,kBAAkB,EACnC,KAAK,CACR,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC;IACxC,CAAC;CACJ;AAED;;;;;GAKG;AACH,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC1C,MAAM,CAAC,MAAM,CAAC,OAAe,EAAE,KAAe;QAC1C,OAAO,IAAI,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC;IACzC,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAC/B,WAAW,EAAE,oBAAoB;IACjC,SAAS,EAAE,kBAAkB;IAC7B,UAAU,EAAE,mBAAmB;CACzB,CAAC;AAQX;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACtC,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC1D,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/file-storage/contracts/file.events.d.ts

@@ -0,0 +1,135 @@
+/**
+ * @module FileStorage
+ */
+import { type IReadableFile } from "../../file-storage/contracts/file.contract.js";
+import { type IKey } from "../../namespace/contracts/namespace.contract.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type FileEventBase = {
+    file: IReadableFile;
+};
+/**
+ * The event is dispatched when file is found.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type FoundFileEvent = FileEventBase;
+/**
+ * The event is dispatched when file is not found.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type NotFoundFileEvent = FileEventBase;
+/**
+ * The event is dispatched when file is added.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type AddedFileEvent = FileEventBase;
+/**
+ * The event is dispatched when trying to add an key that exists.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type KeyExistsFileEvent = FileEventBase;
+/**
+ * The event is dispatched when file is updated.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type UpdatedFileEvent = FileEventBase;
+/**
+ * The event is dispatched when file is removed.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type RemovedFileEvent = FileEventBase;
+/**
+ * The event is dispatched when file is moved.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type MovedFileEvent = {
+    source: IReadableFile;
+    destination: IKey;
+    replaced: boolean;
+};
+/**
+ * The event is dispatched when file is copeid.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type CopiedFileEvent = {
+    source: IReadableFile;
+    destination: IKey;
+    replaced: boolean;
+};
+/**
+ * The event is dispatched when copying or moving a file to destination that exists.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type DestinationExistsFileEvent = {
+    source: IReadableFile;
+    destination: IKey;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type UnexpectedErrorLockEvent = {
+    file?: IReadableFile;
+    error: unknown;
+};
+/**
+ * The event is dispatched when all keys all cleared of the cache.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type ClearedFileEvent = {};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export declare const FILE_EVENTS: {
+    readonly FOUND: "FOUND";
+    readonly NOT_FOUND: "NOT_FOUND";
+    readonly ADDED: "ADDED";
+    readonly KEY_EXISTS: "KEY_EXISTS";
+    readonly UPDATED: "UPDATED";
+    readonly REMOVED: "REMOVED";
+    readonly CLEARED: "CLEARED";
+    readonly MOVED: "MOVED";
+    readonly COPIED: "COPIED";
+    readonly DESTINATION_EXISTS: "DESTINATION_EXISTS";
+    readonly UNEXPECTED_ERROR: "UNEXPECTED_ERROR";
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export type FileEventMap = {
+    [FILE_EVENTS.NOT_FOUND]: NotFoundFileEvent;
+    [FILE_EVENTS.FOUND]: FoundFileEvent;
+    [FILE_EVENTS.ADDED]: AddedFileEvent;
+    [FILE_EVENTS.KEY_EXISTS]: KeyExistsFileEvent;
+    [FILE_EVENTS.UPDATED]: UpdatedFileEvent;
+    [FILE_EVENTS.REMOVED]: RemovedFileEvent;
+    [FILE_EVENTS.CLEARED]: ClearedFileEvent;
+    [FILE_EVENTS.MOVED]: MovedFileEvent;
+    [FILE_EVENTS.COPIED]: CopiedFileEvent;
+    [FILE_EVENTS.DESTINATION_EXISTS]: DestinationExistsFileEvent;
+    [FILE_EVENTS.UNEXPECTED_ERROR]: UnexpectedErrorLockEvent;
+};

package/dist/file-storage/contracts/file.events.js

@@ -0,0 +1,23 @@
+/**
+ * @module FileStorage
+ */
+import {} from "../../file-storage/contracts/file.contract.js";
+import {} from "../../namespace/contracts/namespace.contract.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Events
+ */
+export const FILE_EVENTS = {
+    FOUND: "FOUND",
+    NOT_FOUND: "NOT_FOUND",
+    ADDED: "ADDED",
+    KEY_EXISTS: "KEY_EXISTS",
+    UPDATED: "UPDATED",
+    REMOVED: "REMOVED",
+    CLEARED: "CLEARED",
+    MOVED: "MOVED",
+    COPIED: "COPIED",
+    DESTINATION_EXISTS: "DESTINATION_EXISTS",
+    UNEXPECTED_ERROR: "UNEXPECTED_ERROR",
+};
+//# sourceMappingURL=file.events.js.map

package/dist/file-storage/contracts/file.events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.events.js","sourceRoot":"","sources":["../../../src/file-storage/contracts/file.events.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAsB,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAa,MAAM,6CAA6C,CAAC;AA+GxE;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,kBAAkB,EAAE,oBAAoB;IACxC,gBAAgB,EAAE,kBAAkB;CAC9B,CAAC"}

package/dist/file-storage/contracts/types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @module FileStorage
+ */
+import { type ISignedFileStorageAdapter, type IFileStorageAdapter } from "../../file-storage/contracts/file-storage-adapter.contract.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type FileStorageAdapterVariants = ISignedFileStorageAdapter | IFileStorageAdapter;

package/dist/file-storage/contracts/types.js

@@ -0,0 +1,5 @@
+/**
+ * @module FileStorage
+ */
+import {} from "../../file-storage/contracts/file-storage-adapter.contract.js";
+//# sourceMappingURL=types.js.map

package/dist/file-storage/contracts/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/file-storage/contracts/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAGN,MAAM,2DAA2D,CAAC"}

package/dist/file-storage/implementations/adapters/fs-file-storage-adapter/_module-exports.d.ts

@@ -0,0 +1 @@
+export * from "../../../../file-storage/implementations/adapters/fs-file-storage-adapter/fs-file-storage-adapter.js";

package/dist/file-storage/implementations/adapters/fs-file-storage-adapter/_module-exports.js

@@ -0,0 +1,2 @@
+export * from "../../../../file-storage/implementations/adapters/fs-file-storage-adapter/fs-file-storage-adapter.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/file-storage/implementations/adapters/fs-file-storage-adapter/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../../src/file-storage/implementations/adapters/fs-file-storage-adapter/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,4FAA4F,CAAC"}

package/dist/file-storage/implementations/adapters/fs-file-storage-adapter/_module.d.ts

@@ -0,0 +1 @@
+export * from "../../../../file-storage/implementations/adapters/fs-file-storage-adapter/fs-file-storage-adapter.js";

package/dist/file-storage/implementations/adapters/fs-file-storage-adapter/_module.js

@@ -0,0 +1,2 @@
+export * from "../../../../file-storage/implementations/adapters/fs-file-storage-adapter/fs-file-storage-adapter.js";
+//# sourceMappingURL=_module.js.map

package/dist/file-storage/implementations/adapters/fs-file-storage-adapter/_module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../../src/file-storage/implementations/adapters/fs-file-storage-adapter/_module.ts"],"names":[],"mappings":"AAAA,cAAc,4FAA4F,CAAC"}

package/dist/file-storage/implementations/adapters/fs-file-storage-adapter/fs-file-storage-adapter.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @module FileStorage
+ */
+import { type ICodec } from "../../../../codec/contracts/_module.js";
+import { type FileAdapterMetadata, type FileAdapterStream, type FileWriteEnum, type IFileStorageAdapter, type WritableFileAdapterContent, type WritableFileAdapterStream } from "../../../../file-storage/contracts/_module.js";
+import { type IDeinitizable, type IInitizable } from "../../../../utilities/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/fs-file-storage-adapter"`
+ * @group Adapters
+ */
+export type FsFileStorageAdapterSettings = {
+    /**
+     * @default
+     * ```ts
+     * new URL('./uploads', import.meta.url)
+     * ```
+     */
+    location?: string;
+    /**
+     * @default
+     * ```ts
+     * import { Base64Codec } from "@daiso-tech/core/codec/base-64-codec"
+     *
+     * new Base64Codec()
+     * ```
+     */
+    codec?: ICodec<string, string>;
+};
+/**
+ * The `FsFileStorageAdapter` is used for local development when persistence is need when restarting the dev server.
+ * Note `FsFileStorageAdapter` lacks nested folder support. A flat hierarchy is used, requiring filename encoding/decoding.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/fs-file-storage-adapter"`
+ * @group Adapters
+ */
+export declare class FsFileStorageAdapter implements IFileStorageAdapter, IDeinitizable, IInitizable {
+    private readonly codec;
+    private readonly location;
+    /**
+     * @example
+     * ```ts
+     * import { Base64Codec } from "@daiso-tech/core/codex/base-64-codec";
+     * import { FsFileStorageAdapter } from "@daiso-tech/core/file-storage/fs-file-storage-adapter";
+     *
+     * const fileStorageAdapter = new FsFileStorageAdapter({
+     *   // Both settings are optional
+     *   location: new URL("./uploads", import.meta.url).toString(),
+     *   // By default base64 is used for encoding and decoding the filenames,
+     *   codec: new Base64Codec()
+     * });
+     * ```
+     */
+    constructor(settings?: FsFileStorageAdapterSettings);
+    /**
+     * Creates the root foolder where the files will be saved.
+     */
+    init(): Promise<void>;
+    /**
+     * Removes the root foolder where the files are saved.
+     */
+    deInit(): Promise<void>;
+    private static isFileNotFoundError;
+    private static isFileFoundError;
+    private static isFileFound;
+    private normalizeKey;
+    exists(key: string): Promise<boolean>;
+    getStream(key: string): Promise<FileAdapterStream | null>;
+    getBytes(key: string): Promise<Uint8Array | null>;
+    getMetaData(key: string): Promise<FileAdapterMetadata | null>;
+    add(key: string, content: WritableFileAdapterContent): Promise<boolean>;
+    addStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
+    update(key: string, content: WritableFileAdapterContent): Promise<boolean>;
+    updateStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
+    put(key: string, content: WritableFileAdapterContent): Promise<boolean>;
+    putStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
+    copy(source: string, destination: string): Promise<FileWriteEnum>;
+    copyAndReplace(source: string, destination: string): Promise<boolean>;
+    move(source: string, destination: string): Promise<FileWriteEnum>;
+    moveAndReplace(source: string, destination: string): Promise<boolean>;
+    removeMany(keys: Array<string>): Promise<boolean>;
+    removeByPrefix(prefix: string): Promise<void>;
+}