@bejibun/storage 0.1.0 → 0.1.11

package/tests/unit/storage.test.ts

@@ -0,0 +1,177 @@
+import {
+    afterEach,
+    beforeEach,
+    describe,
+    expect,
+    mock,
+    test
+} from "bun:test";
+import StorageBuilder from "../../src/builders/StorageBuilder";
+import StorageException from "../../src/exceptions/StorageException";
+import Storage from "../../src/facades/Storage";
+
+const log = mock(console.log);
+const error = mock(console.error);
+
+beforeEach(() => {
+    log.mockReset();
+    error.mockReset();
+    console.log = log;
+    console.error = error;
+});
+
+afterEach(() => {
+    console.log = console.log;
+    console.error = console.error;
+});
+
+describe("StorageBuilder", () => {
+    test("build applies the disk override and returns the builder", () => {
+        const disk = {driver: "local", root: "/tmp"};
+        const builder = new StorageBuilder().build(disk);
+
+        expect(builder).toBeInstanceOf(StorageBuilder);
+    });
+
+    test("disk selects a disk by name and returns the builder", () => {
+        const builder = new StorageBuilder().disk("local");
+
+        expect(builder).toBeInstanceOf(StorageBuilder);
+    });
+
+    test("exists throws when the file path is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const error: any = await builder.exists("").catch((e) => e);
+
+        expect(error).toBeInstanceOf(StorageException);
+        expect(error.message).toBe("The file path is required.");
+    });
+
+    test("missing throws when the file path is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const error: any = await builder.missing("").catch((e) => e);
+
+        expect(error).toBeInstanceOf(StorageException);
+        expect(error.message).toBe("The file path is required.");
+    });
+
+    test("metadata throws when the file path is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const error: any = await builder.metadata("").catch((e) => e);
+
+        expect(error).toBeInstanceOf(StorageException);
+        expect(error.message).toBe("The file path is required.");
+    });
+
+    test("size throws when the file path is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const error: any = await builder.size("").catch((e) => e);
+
+        expect(error).toBeInstanceOf(StorageException);
+        expect(error.message).toBe("The file path is required.");
+    });
+
+    test("mimeType throws when the file path is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const error: any = await builder.mimeType("").catch((e) => e);
+
+        expect(error).toBeInstanceOf(StorageException);
+        expect(error.message).toBe("The file path is required.");
+    });
+
+    test("lastModified throws when the file path is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const error: any = await builder.lastModified("").catch((e) => e);
+
+        expect(error).toBeInstanceOf(StorageException);
+        expect(error.message).toBe("The file path is required.");
+    });
+
+    test("get throws when the file path is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const error: any = await builder.get("").catch((e) => e);
+
+        expect(error).toBeInstanceOf(StorageException);
+        expect(error.message).toBe("The file path is required.");
+    });
+
+    test("put throws when the file path or content is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const pathError: any = await builder.put("", "x").catch((e) => e);
+
+        expect(pathError).toBeInstanceOf(StorageException);
+        expect(pathError.message).toBe("The file path is required.");
+
+        const contentError: any = await builder.put("file.txt", "").catch((e) => e);
+
+        expect(contentError).toBeInstanceOf(StorageException);
+        expect(contentError.message).toBe("The content is required.");
+    });
+
+    test("copy throws when the source or destination path is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const sourceError: any = await builder.copy("", "dst").catch((e) => e);
+
+        expect(sourceError.message).toBe("The source file path is required.");
+
+        const destError: any = await builder.copy("src", "").catch((e) => e);
+
+        expect(destError.message).toBe("The destination file path is required.");
+    });
+
+    test("move throws when the source or destination path is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const sourceError: any = await builder.move("", "dst").catch((e) => e);
+
+        expect(sourceError.message).toBe("The source file path is required.");
+
+        const destError: any = await builder.move("src", "").catch((e) => e);
+
+        expect(destError.message).toBe("The destination file path is required.");
+    });
+
+    test("delete throws when the file path is empty", async () => {
+        const builder = new StorageBuilder();
+
+        const error: any = await builder.delete("").catch((e) => e);
+
+        expect(error).toBeInstanceOf(StorageException);
+        expect(error.message).toBe("The file path is required.");
+    });
+});
+
+describe("Storage facade", () => {
+    test("build returns a StorageBuilder", () => {
+        expect(Storage.build({driver: "local", root: "/tmp"})).toBeInstanceOf(
+            StorageBuilder
+        );
+    });
+
+    test("disk returns a StorageBuilder", () => {
+        expect(Storage.disk("local")).toBeInstanceOf(StorageBuilder);
+    });
+
+    test("exists throws when the file path is empty", async () => {
+        const error: any = await Storage.exists("").catch((e) => e);
+
+        expect(error).toBeInstanceOf(StorageException);
+        expect(error.message).toBe("The file path is required.");
+    });
+
+    test("put throws when the file path is empty", async () => {
+        const error: any = await Storage.put("", "x").catch((e) => e);
+
+        expect(error).toBeInstanceOf(StorageException);
+        expect(error.message).toBe("The file path is required.");
+    });
+});

package/tsconfig.json

@@ -12,7 +12,7 @@
         "paths": {
             "@/*": ["./src/*"]
         },
-        "ignoreDeprecations": "6.0",
         "types": ["bun-types"]
-    }
+    },
+    "exclude": ["tests"]
 }

package/types/index.d.ts

@@ -1 +1,4 @@
-export * from "../types/storage";
+/**
+ * Re-exports the storage type declarations.
+ */
+export * from "./storage";

package/types/storage.d.ts

@@ -1,138 +1,138 @@
-import type {Stats} from "fs";
-
-export type StorageDisk = {
-    driver: string;
-    [key: string]: unknown;
-};
-
-export type StorageOptions = {
-    mode?: number;
-    createPath?: boolean;
-    acl?:
-        | "private"
-        | "public-read"
-        | "public-read-write"
-        | "aws-exec-read"
-        | "authenticated-read"
-        | "bucket-owner-read"
-        | "bucket-owner-full-control"
-        | "log-delivery-write";
-    bucket?: string;
-    region?: string;
-    accessKeyId?: string;
-    secretAccessKey?: string;
-    sessionToken?: string;
-    endpoint?: string;
-    virtualHostedStyle?: boolean;
-    partSize?: number;
-    queueSize?: number;
-    retry?: number;
-    type?: string;
-    contentDisposition?: string | undefined;
-    storageClass?:
-        | "STANDARD"
-        | "DEEP_ARCHIVE"
-        | "EXPRESS_ONEZONE"
-        | "GLACIER"
-        | "GLACIER_IR"
-        | "INTELLIGENT_TIERING"
-        | "ONEZONE_IA"
-        | "OUTPOSTS"
-        | "REDUCED_REDUNDANCY"
-        | "SNOW"
-        | "STANDARD_IA";
-    requestPayer?: boolean;
-    highWaterMark?: number;
-};
-
-export interface StorageDriver {
-    /**
-     * Determine whether a file exists.
-     *
-     * @param filepath The path to the file.
-     * @returns True if the file exists; otherwise false.
-     */
-    exists(filepath: string): Promise<boolean>;
-
-    /**
-     * Determine whether a file is missing.
-     *
-     * @param filepath The path to the file.
-     * @returns True if the file does not exist; otherwise false.
-     */
-    missing(filepath: string): Promise<boolean>;
-
-    /**
-     * Retrieve metadata for a file.
-     *
-     * @param filepath The path to the file.
-     * @returns File metadata and statistics.
-     */
-    metadata(filepath: string): Promise<Stats | Bun.S3Stats>;
-
-    /**
-     * Get the file size in bytes.
-     *
-     * @param filepath The path to the file.
-     * @returns The file size in bytes.
-     */
-    size(filepath: string): Promise<number>;
-
-    /**
-     * Get the file MIME type.
-     *
-     * @param filepath The path to the file.
-     * @returns The detected MIME type.
-     */
-    mimeType(filepath: string): Promise<string>;
-
-    /**
-     * Get the file's last modification date.
-     *
-     * @param filepath The path to the file.
-     * @returns The last modified timestamp.
-     */
-    lastModified(filepath: string): Promise<Date>;
-
-    /**
-     * Retrieve a file from storage.
-     *
-     * @param filepath The path to the file.
-     * @returns The storage file instance.
-     */
-    get(filepath: string): Promise<Bun.BunFile | Bun.S3File>;
-
-    /**
-     * Store content at the given path.
-     *
-     * @param filepath The destination file path.
-     * @param content The content to store.
-     * @param options Additional storage options.
-     */
-    put(filepath: string, content: any, options?: StorageOptions): Promise<void>;
-
-    /**
-     * Copy a file to a new location.
-     *
-     * @param source The source file path.
-     * @param destination The destination file path.
-     * @param options Additional storage options.
-     */
-    copy(source: string, destination: string, options?: StorageOptions): Promise<void>;
-
-    /**
-     * Move a file to a new location.
-     *
-     * @param source The source file path.
-     * @param destination The destination file path.
-     * @param options Additional storage options.
-     */
-    move(source: string, destination: string, options?: StorageOptions): Promise<void>;
-
-    /**
-     * Delete a file from storage.
-     *
-     * @param filepath The path to the file.
-     */
-    delete(filepath: string): Promise<void>;
-}
+import type {Stats} from "fs";
+
+export type StorageDisk = {
+    driver: string;
+    [key: string]: unknown;
+};
+
+export type StorageOptions = {
+    mode?: number;
+    createPath?: boolean;
+    acl?:
+        | "private"
+        | "public-read"
+        | "public-read-write"
+        | "aws-exec-read"
+        | "authenticated-read"
+        | "bucket-owner-read"
+        | "bucket-owner-full-control"
+        | "log-delivery-write";
+    bucket?: string;
+    region?: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    sessionToken?: string;
+    endpoint?: string;
+    virtualHostedStyle?: boolean;
+    partSize?: number;
+    queueSize?: number;
+    retry?: number;
+    type?: string;
+    contentDisposition?: string | undefined;
+    storageClass?:
+        | "STANDARD"
+        | "DEEP_ARCHIVE"
+        | "EXPRESS_ONEZONE"
+        | "GLACIER"
+        | "GLACIER_IR"
+        | "INTELLIGENT_TIERING"
+        | "ONEZONE_IA"
+        | "OUTPOSTS"
+        | "REDUCED_REDUNDANCY"
+        | "SNOW"
+        | "STANDARD_IA";
+    requestPayer?: boolean;
+    highWaterMark?: number;
+};
+
+export interface StorageDriver {
+    /**
+     * Determine whether a file exists.
+     *
+     * @param {string} filepath The path to the file.
+     * @returns {boolean} True if the file exists; otherwise false.
+     */
+    exists(filepath: string): Promise<boolean>;
+
+    /**
+     * Determine whether a file is missing.
+     *
+     * @param {string} filepath The path to the file.
+     * @returns {boolean} True if the file does not exist; otherwise false.
+     */
+    missing(filepath: string): Promise<boolean>;
+
+    /**
+     * Retrieve metadata for a file.
+     *
+     * @param {string} filepath The path to the file.
+     * @returns {Stats|Bun.S3Stats} File metadata and statistics.
+     */
+    metadata(filepath: string): Promise<Stats | Bun.S3Stats>;
+
+    /**
+     * Get the file size in bytes.
+     *
+     * @param {string} filepath The path to the file.
+     * @returns {number} The file size in bytes.
+     */
+    size(filepath: string): Promise<number>;
+
+    /**
+     * Get the file MIME type.
+     *
+     * @param {string} filepath The path to the file.
+     * @returns {string} The detected MIME type.
+     */
+    mimeType(filepath: string): Promise<string>;
+
+    /**
+     * Get the file's last modification date.
+     *
+     * @param {string} filepath The path to the file.
+     * @returns {Date} The last modified timestamp.
+     */
+    lastModified(filepath: string): Promise<Date>;
+
+    /**
+     * Retrieve a file from storage.
+     *
+     * @param {string} filepath The path to the file.
+     * @returns {Bun.BunFile|Bun.S3File} The storage file instance.
+     */
+    get(filepath: string): Promise<Bun.BunFile | Bun.S3File>;
+
+    /**
+     * Store content at the given path.
+     *
+     * @param {string} filepath The destination file path.
+     * @param {any} content The content to store.
+     * @param {StorageOptions} options Additional storage options.
+     */
+    put(filepath: string, content: any, options?: StorageOptions): Promise<void>;
+
+    /**
+     * Copy a file to a new location.
+     *
+     * @param {string} source The source file path.
+     * @param {string} destination The destination file path.
+     * @param {StorageOptions} options Additional storage options.
+     */
+    copy(source: string, destination: string, options?: StorageOptions): Promise<void>;
+
+    /**
+     * Move a file to a new location.
+     *
+     * @param {string} source The source file path.
+     * @param {string} destination The destination file path.
+     * @param {StorageOptions} options Additional storage options.
+     */
+    move(source: string, destination: string, options?: StorageOptions): Promise<void>;
+
+    /**
+     * Delete a file from storage.
+     *
+     * @param {string} filepath The path to the file.
+     */
+    delete(filepath: string): Promise<void>;
+}