@daiso-tech/core 0.48.5 → 0.49.1

package/dist/file-size/implementations/file-size.js

@@ -0,0 +1,89 @@
+/**
+ * @module FileSize
+ */
+import { TO_BYTES } from "../../file-size/contracts/_module.js";
+import {} from "../../serde/contracts/_module.js";
+import {} from "../../utilities/_module.js";
+/**
+ * The `FileSize` class is used for representing file size.
+ * `FileSize` class cannot be negative, if you pass negative number it will be converted to 0.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-size"`
+ * @group Implementations
+ */
+export class FileSize {
+    fileSizeInBytes;
+    static kbInBytes = 1000;
+    static mbInBytes = 1000 * FileSize.kbInBytes;
+    static gbInBytes = 1000 * FileSize.mbInBytes;
+    static tbInBytes = 1000 * FileSize.gbInBytes;
+    static pbInBytes = 1000 * FileSize.tbInBytes;
+    static deserialize(serializedValue) {
+        return new FileSize(serializedValue.fileSizeInBytes);
+    }
+    static fromBytes(bytes) {
+        return new FileSize(bytes);
+    }
+    static fromKiloBytes(kiloBytes) {
+        return new FileSize(kiloBytes * FileSize.kbInBytes);
+    }
+    static fromMegaBytes(megaBytes) {
+        return new FileSize(megaBytes * FileSize.mbInBytes);
+    }
+    static fromGigaBytes(gigaBytes) {
+        return new FileSize(gigaBytes * FileSize.gbInBytes);
+    }
+    static fromTeraBytes(teraBytes) {
+        return new FileSize(teraBytes * FileSize.tbInBytes);
+    }
+    static fromPetaBytes(petaBytes) {
+        return new FileSize(petaBytes * FileSize.pbInBytes);
+    }
+    constructor(fileSizeInBytes) {
+        this.fileSizeInBytes = fileSizeInBytes;
+        this.fileSizeInBytes = Math.max(0, this.fileSizeInBytes);
+    }
+    [TO_BYTES]() {
+        return this.fileSizeInBytes;
+    }
+    equals(value) {
+        return value[TO_BYTES]() === this.toBytes();
+    }
+    gt(value) {
+        return value[TO_BYTES]() < this.toBytes();
+    }
+    gte(value) {
+        return value[TO_BYTES]() <= this.toBytes();
+    }
+    lt(value) {
+        return value[TO_BYTES]() > this.toBytes();
+    }
+    lte(value) {
+        return value[TO_BYTES]() >= this.toBytes();
+    }
+    serialize() {
+        return {
+            version: "1",
+            fileSizeInBytes: this.fileSizeInBytes,
+        };
+    }
+    toBytes() {
+        return this[TO_BYTES]();
+    }
+    toKiloBytes() {
+        return Math.floor(this.toBytes() / FileSize.kbInBytes);
+    }
+    toMegaBytes() {
+        return Math.floor(this.toBytes() / FileSize.mbInBytes);
+    }
+    toGigaBytes() {
+        return Math.floor(this.toBytes() / FileSize.gbInBytes);
+    }
+    toTeraBytes() {
+        return Math.floor(this.toBytes() / FileSize.tbInBytes);
+    }
+    toPetaBytes() {
+        return Math.floor(this.toBytes() / FileSize.pbInBytes);
+    }
+}
+//# sourceMappingURL=file-size.js.map

package/dist/file-size/implementations/file-size.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-size.js","sourceRoot":"","sources":["../../../src/file-size/implementations/file-size.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAkB,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAsB,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAoB,MAAM,wBAAwB,CAAC;AAW1D;;;;;;GAMG;AACH,MAAM,OAAO,QAAQ;IAwCoB;IAlC7B,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,MAAM,CAAC,SAAS,GAAG,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC;IAC7C,MAAM,CAAC,SAAS,GAAG,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC;IAC7C,MAAM,CAAC,SAAS,GAAG,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC;IAC7C,MAAM,CAAC,SAAS,GAAG,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC;IAErD,MAAM,CAAC,WAAW,CAAC,eAAmC;QAClD,OAAO,IAAI,QAAQ,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,KAAa;QAC1B,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,SAAiB;QAClC,OAAO,IAAI,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,SAAiB;QAClC,OAAO,IAAI,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,SAAiB;QAClC,OAAO,IAAI,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,SAAiB;QAClC,OAAO,IAAI,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,SAAiB;QAClC,OAAO,IAAI,QAAQ,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,YAAqC,eAAuB;QAAvB,oBAAe,GAAf,eAAe,CAAQ;QACxD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IAC7D,CAAC;IAED,CAAC,QAAQ,CAAC;QACN,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,KAAgB;QACnB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;IAChD,CAAC;IAED,EAAE,CAAC,KAAgB;QACf,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAC9C,CAAC;IAED,GAAG,CAAC,KAAgB;QAChB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;IAC/C,CAAC;IAED,EAAE,CAAC,KAAgB;QACf,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAC9C,CAAC;IAED,GAAG,CAAC,KAAgB;QAChB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;IAC/C,CAAC;IAED,SAAS;QACL,OAAO;YACH,OAAO,EAAE,GAAG;YACZ,eAAe,EAAE,IAAI,CAAC,eAAe;SACxC,CAAC;IACN,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC5B,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC"}

package/dist/file-storage/contracts/_module-exports.d.ts

@@ -0,0 +1,7 @@
+export * from "../../file-storage/contracts/file-storage-adapter.contract.js";
+export type * from "../../file-storage/contracts/file-storage-factory.contract.js";
+export type * from "../../file-storage/contracts/file-storage.contract.js";
+export type * from "../../file-storage/contracts/file.contract.js";
+export * from "../../file-storage/contracts/file.errors.js";
+export * from "../../file-storage/contracts/file.events.js";
+export type * from "../../file-storage/contracts/types.js";

package/dist/file-storage/contracts/_module-exports.js

@@ -0,0 +1,4 @@
+export * from "../../file-storage/contracts/file-storage-adapter.contract.js";
+export * from "../../file-storage/contracts/file.errors.js";
+export * from "../../file-storage/contracts/file.events.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/file-storage/contracts/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../src/file-storage/contracts/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,2DAA2D,CAAC;AAI1E,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC"}

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

@@ -0,0 +1,7 @@
+export * from "../../file-storage/contracts/file-storage-adapter.contract.js";
+export type * from "../../file-storage/contracts/file-storage-factory.contract.js";
+export type * from "../../file-storage/contracts/file-storage.contract.js";
+export type * from "../../file-storage/contracts/file.contract.js";
+export * from "../../file-storage/contracts/file.errors.js";
+export * from "../../file-storage/contracts/file.events.js";
+export type * from "../../file-storage/contracts/types.js";

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

@@ -0,0 +1,4 @@
+export * from "../../file-storage/contracts/file-storage-adapter.contract.js";
+export * from "../../file-storage/contracts/file.errors.js";
+export * from "../../file-storage/contracts/file.events.js";
+//# sourceMappingURL=_module.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../src/file-storage/contracts/_module.ts"],"names":[],"mappings":"AAAA,cAAc,2DAA2D,CAAC;AAI1E,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC"}

package/dist/file-storage/contracts/file-storage-adapter.contract.d.ts

@@ -0,0 +1,180 @@
+/**
+ * @module FileStorage
+ */
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type FileAdapterSignedDownloadUrlSettings = {
+    expirationInSeconds: number;
+    contentType: string | null;
+    contentDisposition: string | null;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type FileAdapterSignedUploadUrlSettings = {
+    expirationInSeconds: number;
+    contentType: string | null;
+};
+/**
+ * The `IFileUrlAdapter` contract defines a way for creating temporary signed url for uploading and downloading files. It also allows for creating public url for files.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type IFileUrlAdapter = {
+    getPublicUrl(key: string): Promise<string | null>;
+    getSignedDownloadUrl(key: string, settings: FileAdapterSignedDownloadUrlSettings): Promise<string | null>;
+    getSignedUploadUrl(key: string, settings: FileAdapterSignedUploadUrlSettings): Promise<string>;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type FileAdapterMetadata = {
+    etag: string;
+    contentType: string;
+    fileSizeInBytes: number;
+    /**
+     * This field tracks the file's creation date and its last modified date.
+     */
+    updatedAt: Date;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type FileAdapterStream = AsyncIterable<Uint8Array>;
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type WritableFileAdapterCommonSettings = {
+    contentType: string;
+    contentLanguage: string | null;
+    contentEncoding: string | null;
+    contentDisposition: string | null;
+    cacheControl: string | null;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type WritableFileAdapterContent = WritableFileAdapterCommonSettings & {
+    data: Uint8Array;
+    fileSizeInBytes: number;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type WritableFileAdapterStream = WritableFileAdapterCommonSettings & {
+    data: FileAdapterStream;
+    fileSizeInBytes: number | null;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export declare const FILE_WRITE_ENUM: {
+    readonly SUCCESS: "SUCCESS";
+    readonly NOT_FOUND: "NOT_FOUND";
+    readonly KEY_EXISTS: "KEY_EXISTS";
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type FileWriteEnum = (typeof FILE_WRITE_ENUM)[keyof typeof FILE_WRITE_ENUM];
+/**
+ * The `IFileStorageAdapter` contract defines a way for storing files independent of storage.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type IFileStorageAdapter = {
+    exists(key: string): Promise<boolean>;
+    /**
+     * The `getStream` method returns the file as stream when `key` is found otherwise null will be returned.
+     */
+    getStream(key: string): Promise<FileAdapterStream | null>;
+    /**
+     * The `getBytes` method returns the file as bytes when `key` is found otherwise null will be returned.
+     */
+    getBytes(key: string): Promise<Uint8Array | null>;
+    /**
+     * The `getMetaData` method returns the file metadata when `key` is found otherwise null will be returned.
+     */
+    getMetaData(key: string): Promise<FileAdapterMetadata | null>;
+    /**
+     * The `add` method adds the file as bytes when `key` doesn't exists. Returns `true` when key doesn't exists otherwise `false` will be returned.
+     */
+    add(key: string, content: WritableFileAdapterContent): Promise<boolean>;
+    /**
+     * The `addStream` method adds the file as streaming when `key` doesn't exists. Returns `true` when key doesn't exists otherwise `false` will be returned.
+     */
+    addStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
+    /**
+     * The `update` method updates the file by bytes. Returns `true` if the `key` where updated otherwise `false` will be returned.
+     */
+    update(key: string, content: WritableFileAdapterContent): Promise<boolean>;
+    /**
+     * The `updateStream` method updates the file by stream. Returns `true` if the `key` where updated otherwise `false` will be returned.
+     */
+    updateStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
+    /**
+     * The `put` methods upsert the given key with file bytes.
+     * Returns `true` when the key was updated otherwise `false` is returned.
+     */
+    put(key: string, content: WritableFileAdapterContent): Promise<boolean>;
+    /**
+     * The `putStream` methods upsert the given key with file stream.
+     * Returns `true` when the key was updated otherwise `false` is returned.
+     */
+    putStream(key: string, stream: WritableFileAdapterStream): Promise<boolean>;
+    /**
+     * The `copy` methods copies the `source` file to the given `destination` when it doesnt exists.
+     *
+     * Returns
+     * - `FILE_WRITE_ENUM.SUCCESS` when file successfully copied.
+     * - `FILE_WRITE_ENUM.NOT_FOUND` when `source` file is not found.
+     * - `FILE_WRITE_ENUM.KEY_EXISTS` when `destination` file already exists.
+     */
+    copy(source: string, destination: string): Promise<FileWriteEnum>;
+    /**
+     * The `copyAndReplace` methods copies the `source` file to the given `destination`. The `destination` file will always be replaces.
+     * Returns `true` if the `source` is found otherwise `false` is returned.
+     */
+    copyAndReplace(source: string, destination: string): Promise<boolean>;
+    /**
+     * The `move` methods moves the `source` file to the given `destination` when it doesnt exists.
+     *
+     * Returns
+     * - `FILE_WRITE_ENUM.SUCCESS` when file successfully moved.
+     * - `FILE_WRITE_ENUM.NOT_FOUND` when `source` file is not found.
+     * - `FILE_WRITE_ENUM.KEY_EXISTS` when `destination` file already exists.
+     */
+    move(source: string, destination: string): Promise<FileWriteEnum>;
+    /**
+     * The `moveAndReplace` methods moves the `source` file to the given `destination`. The `destination` file will always be replaces.
+     * Returns `true` if the `source` is found otherwise `false` is returned.
+     */
+    moveAndReplace(source: string, destination: string): Promise<boolean>;
+    /**
+     * The `removeMany` method removes many keys. Returns `true` if one of the keys where deleted otherwise `false` is returned.
+     */
+    removeMany(keys: Array<string>): Promise<boolean>;
+    /**
+     * The `removeByKeyPrefix` method removes all the keys in the file-storage that starts with the given `prefix`.
+     */
+    removeByPrefix(prefix: string): Promise<void>;
+};
+/**
+ * The `ISignedFileStorageAdapter` contract defines a way for storing files independent of storage, creating temporary signed url for uploading and downloading files. It also allows for creating public url for files
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type ISignedFileStorageAdapter = IFileUrlAdapter & IFileStorageAdapter;

package/dist/file-storage/contracts/file-storage-adapter.contract.js

@@ -0,0 +1,13 @@
+/**
+ * @module FileStorage
+ */
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export const FILE_WRITE_ENUM = {
+    SUCCESS: "SUCCESS",
+    NOT_FOUND: "NOT_FOUND",
+    KEY_EXISTS: "KEY_EXISTS",
+};
+//# sourceMappingURL=file-storage-adapter.contract.js.map

package/dist/file-storage/contracts/file-storage-adapter.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-storage-adapter.contract.js","sourceRoot":"","sources":["../../../src/file-storage/contracts/file-storage-adapter.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AA4FH;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC3B,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,UAAU,EAAE,YAAY;CAClB,CAAC"}

package/dist/file-storage/contracts/file-storage-factory.contract.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @module FileStorage
+ */
+import { type IFileStorage } from "../../file-storage/contracts/_module.js";
+/**
+ * The `IFileStorageFactory` contract makes it easy to configure and switch between different {@link IFileStorage | `IFileStorage`} dynamically.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type IFileStorageFactory<TAdapters extends string = string> = {
+    /**
+     * The `use` method will throw an error if you provide it unregisted adapter.
+     * If no default adapter is defined an error will be thrown.
+     * @throws {UnregisteredAdapterError} {@link UnregisteredAdapterError}
+     * @throws {DefaultAdapterNotDefinedError} {@link DefaultAdapterNotDefinedError}
+     */
+    use(adapterName?: TAdapters): IFileStorage;
+};

package/dist/file-storage/contracts/file-storage-factory.contract.js

@@ -0,0 +1,10 @@
+/**
+ * @module FileStorage
+ */
+import {} from "../../file-storage/contracts/_module.js";
+import { 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+UnregisteredAdapterError, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+DefaultAdapterNotDefinedError, } from "../../utilities/_module.js";
+//# sourceMappingURL=file-storage-factory.contract.js.map

package/dist/file-storage/contracts/file-storage-factory.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-storage-factory.contract.js","sourceRoot":"","sources":["../../../src/file-storage/contracts/file-storage-factory.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAqB,MAAM,qCAAqC,CAAC;AACxE,OAAO;AACH,6DAA6D;AAC7D,wBAAwB;AACxB,6DAA6D;AAC7D,6BAA6B,GAChC,MAAM,wBAAwB,CAAC"}

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

@@ -0,0 +1,37 @@
+/**
+ * @module FileStorage
+ */
+import { type IEventListenable } from "../../event-bus/contracts/_module.js";
+import { type IFile } from "../../file-storage/contracts/file.contract.js";
+import { type FileEventMap } from "../../file-storage/contracts/file.events.js";
+import { type ITask } from "../../task/contracts/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type IFileListenable = IEventListenable<FileEventMap>;
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type IFileProvider = {
+    create(key: string): IFile;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type IFileStorageBase = IFileProvider & {
+    clear(): ITask<void>;
+    removeMany(files: Iterable<IFile>): ITask<boolean>;
+};
+/**
+ * The `IFileStorage` contract defines a way for managing files independent of the underlying technology.
+ * It commes with more convient methods compared to `IFileStorageAdapter`.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type IFileStorage = IFileStorageBase & {
+    readonly events: IFileListenable;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * @module FileStorage
+ */
+import {} from "../../event-bus/contracts/_module.js";
+import {} from "../../file-storage/contracts/file.contract.js";
+import {} from "../../file-storage/contracts/file.events.js";
+import {} from "../../task/contracts/_module.js";
+//# sourceMappingURL=file-storage.contract.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file-storage.contract.js","sourceRoot":"","sources":["../../../src/file-storage/contracts/file-storage.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAyB,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAc,MAAM,2CAA2C,CAAC;AACvE,OAAO,EAAqB,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAc,MAAM,6BAA6B,CAAC"}

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

@@ -0,0 +1,224 @@
+/**
+ * @module FileStorage
+ */
+import { type Readable } from "node:stream";
+import { type IFileSize } from "../../file-size/contracts/_module.js";
+import { type IKey } from "../../namespace/contracts/_module.js";
+import { type ITask } from "../../task/contracts/_module.js";
+import { type ITimeSpan } from "../../time-span/contracts/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type FileDownloadUrlOptions = {
+    /**
+     * The ttl of signed url.
+     *
+     * @default
+     * ```ts
+     * import { TimeSpan } from "@daiso-tech/time-span"
+     *
+     * TimeSpan.fromMinutes(10)
+     * ```
+     */
+    ttl?: ITimeSpan;
+    /**
+     * The content type will be infered by key.
+     */
+    contentType?: string | null;
+    /**
+     * @default null
+     */
+    contentDisposition?: string | null;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type FileUploadUrlOptions = {
+    /**
+     * The ttl of signed url.
+     *
+     * @default
+     * ```ts
+     * import { TimeSpan } from "@daiso-tech/time-span"
+     *
+     * TimeSpan.fromMinutes(10)
+     * ```
+     */
+    ttl?: ITimeSpan;
+    /**
+     * The content type will be infered by key.
+     */
+    contentType?: string | null;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type FileMetadata = {
+    etag: string;
+    contentType: string;
+    fileSize: IFileSize;
+    updatedAt: Date;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type IReadableFile = {
+    readonly key: IKey;
+    getText(): ITask<string | null>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    getTextOrFail(): ITask<string>;
+    getBytes(): ITask<Uint8Array | null>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    getBytesOrFail(): ITask<Uint8Array>;
+    getBuffer(): ITask<Buffer | null>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    getBufferOrFail(): ITask<Buffer>;
+    getArrayBuffer(): ITask<ArrayBuffer | null>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    getArrayBufferOrFail(): ITask<ArrayBuffer>;
+    getReadable(): ITask<Readable | null>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    getReadableOrFail(): ITask<Readable>;
+    getReadableStream(): ITask<ReadableStream<Uint8Array> | null>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    getReadableStreamOrFail(): ITask<ReadableStream<Uint8Array>>;
+    getMetadata(): ITask<FileMetadata | null>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    getMetadataOrFail(): ITask<FileMetadata>;
+    exists(): ITask<boolean>;
+    missing(): ITask<boolean>;
+    getPublicUrl(): ITask<string | null>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    getPublicUrlOrFail(): ITask<string>;
+    getSignedDownloadUrl(options?: FileDownloadUrlOptions): ITask<string | null>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    getSignedDownloadUrlOrFail(options?: FileUploadUrlOptions): ITask<string>;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type FileContent = string | ArrayBufferLike | ArrayBufferView;
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type WritableFileCommonSettings = {
+    /**
+     * You can explicitly set a custom Content-Type. If one is not provided, it will be inferred from the key. For example, a key ending in .txt (such as key-a.txt) will be assigned text/plain.
+     * If the key contains a non-standard extension it will default to application/octet-stream.
+     */
+    contentType?: string;
+    /**
+     * Note a default value is always provided. To explicitly unset a field and prevent it from being passed to the underlying adapter, pass in `null`.
+     */
+    contentLanguage?: string | null;
+    /**
+     * Note a default value is always provided. To explicitly unset a field and prevent it from being passed to the underlying adapter, pass in `null`.
+     */
+    contentEncoding?: string | null;
+    /**
+     * Note a default value is always provided. To explicitly unset a field and prevent it from being passed to the underlying adapter, pass in `null`.
+     */
+    contentDisposition?: string | null;
+    /**
+     * Note a default value is always provided. To explicitly unset a field and prevent it from being passed to the underlying adapter, pass in `null`.
+     */
+    cacheControl?: string | null;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type WritableFileContent = WritableFileCommonSettings & {
+    data: FileContent;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type WritableFileStream = WritableFileCommonSettings & {
+    data: AsyncIterable<FileContent>;
+    /**
+     * @default null
+     */
+    fileSize?: IFileSize | null;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/file-storage/contracts"`
+ * @group Contracts
+ */
+export type IFile = IReadableFile & {
+    add(content: WritableFileContent): ITask<boolean>;
+    /**
+     * @throws {KeyExistsFileError} {@link KeyExistsFileError}
+     */
+    addOrFail(content: WritableFileContent): ITask<void>;
+    addStream(stream: WritableFileStream): ITask<boolean>;
+    /**
+     * @throws {KeyExistsFileError} {@link KeyExistsFileError}
+     */
+    addStreamOrFail(stream: WritableFileStream): ITask<void>;
+    update(content: WritableFileContent): ITask<boolean>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    updateOrFail(content: WritableFileContent): ITask<void>;
+    updateStream(stream: WritableFileStream): ITask<boolean>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    updateStreamOrFail(stream: WritableFileStream): ITask<void>;
+    put(content: WritableFileContent): ITask<boolean>;
+    putStream(stream: WritableFileStream): ITask<boolean>;
+    remove(): ITask<boolean>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    removeOrFail(): ITask<void>;
+    copy(destination: string): ITask<boolean>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     * @throws {KeyExistsFileError} {@link KeyExistsFileError}
+     */
+    copyOrFail(destination: string): ITask<void>;
+    copyAndReplace(destination: string): ITask<boolean>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    copyAndReplaceOrFail(destination: string): ITask<void>;
+    move(destination: string): ITask<boolean>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     * @throws {KeyExistsFileError} {@link KeyExistsFileError}
+     */
+    moveOrFail(destination: string): ITask<void>;
+    moveAndReplace(destination: string): ITask<boolean>;
+    /**
+     * @throws {KeyNotFoundFileError} {@link KeyNotFoundFileError}
+     */
+    moveAndReplaceOrFail(destination: string): ITask<void>;
+    getSignedUploadUrl(options?: FileUploadUrlOptions): ITask<string>;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * @module FileStorage
+ */
+import {} from "node:stream";
+import {} from "../../file-size/contracts/_module.js";
+import {} from "../../file-storage/contracts/file.errors.js";
+import {} from "../../namespace/contracts/_module.js";
+import {} from "../../task/contracts/_module.js";
+import {} from "../../time-span/contracts/_module.js";
+//# sourceMappingURL=file.contract.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file.contract.js","sourceRoot":"","sources":["../../../src/file-storage/contracts/file.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAiB,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAkB,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAKN,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAa,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAc,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAkB,MAAM,kCAAkC,CAAC"}