@bejibun/storage 0.1.0 → 0.1.1

package/.prettierignore

@@ -0,0 +1,45 @@
+# dependencies (bun install)
+node_modules
+
+# output
+out
+dist
+*.tgz
+
+# code coverage
+coverage
+*.lcov
+
+# logs
+logs
+_.log
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# caches
+.eslintcache
+.cache
+*.tsbuildinfo
+
+# storage (runtime/framework generated content)
+storage/app
+storage/cache
+storage/framework
+
+# public
+public
+
+# bun
+bun.lock
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store

package/.prettierrc.json

@@ -0,0 +1,14 @@
+{
+    "tabWidth": 4,
+    "useTabs": false,
+    "semi": true,
+    "singleQuote": false,
+    "quoteProps": "as-needed",
+    "trailingComma": "none",
+    "bracketSpacing": false,
+    "bracketSameLine": false,
+    "arrowParens": "always",
+    "printWidth": 100,
+    "endOfLine": "lf",
+    "jsxSingleQuote": false
+}

package/CHANGELOG.md

@@ -3,6 +3,35 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+## [v0.1.1](https://github.com/Bejibun-Framework/bejibun-storage/compare/v0.1.0...v0.1.1) - 2026-08-20
+
+### 🩹 Fixes
+- Fix missing `options` in `Storage.put()`
+
+### 📖 Changes
+#### Tooling
+- Added `prettier` + `.prettierrc.json` / `.prettierignore` and an `eslint.config.js` (flat config, `typescript-eslint`) for consistent formatting/linting across `src`
+- Added `bun run format`, `bun run eslint`, and `bun run lint` scripts; `bun run build` now runs `lint` before compiling
+- `alias` script now runs `tsc-alias` directly instead of via `bunx`
+
+### 📦 Dependencies
+
+- Bumped `tsc-alias` (devDependency) from `^1.8.16` to `^1.9.2`
+- Added `@eslint/js` (devDependency) `^10.0.1`
+- Added `eslint` (devDependency) `^10.8.1`
+- Added `eslint-config-prettier` (devDependency) `^10.1.8`
+- Added `globals` (devDependency) `^17.11.0`
+- Added `prettier` (devDependency) `^3.9.6`
+- Added `typescript` (devDependency) `^6.0.3`
+- Added `typescript-eslint` (devDependency) `^8.67.0`
+
+### ❤️Contributors
+- Havea Crenata ([@crenata](https://github.com/crenata))
+
+**Full Changelog**: https://github.com/Bejibun-Framework/bejibun-storage/blob/master/CHANGELOG.md
+
+---
+
 ## [v0.1.0](https://github.com/Bejibun-Framework/bejibun-storage/compare/v0.1.0...v0.1.0) - 2026-08-03
 
 ### 🩹 Fixes

package/README.md

@@ -87,6 +87,10 @@ await Storage.put("path/to/your/file.ext", "content"); // Store content to file
 await Storage.copy("source/file.ext", "destination/file.ext"); // Copy file
 await Storage.move("source/file.ext", "destination/file.ext"); // Move file
 await Storage.delete("path/to/your/file.ext"); // Delete file
+await Storage.metadata("path/to/your/file.ext"); // Retrieve complete file metadata and statistics
+await Storage.size("path/to/your/file.ext"); // Get the file size in bytes
+await Storage.mimeType("path/to/your/file.ext"); // Get the file MIME type
+await Storage.lastModified("path/to/your/file.ext"); // Get the file's last modification date
 ```
 
 #### With Specified Disk
@@ -100,6 +104,10 @@ await Storage.disk("public").put("path/to/your/file.ext", "content");
 await Storage.disk("public").copy("source/file.ext", "destination/file.ext");
 await Storage.disk("public").move("source/file.ext", "destination/file.ext");
 await Storage.disk("public").delete("path/to/your/file.ext");
+await Storage.disk("public").metadata("path/to/your/file.ext");
+await Storage.disk("public").size("path/to/your/file.ext");
+await Storage.disk("public").mimeType("path/to/your/file.ext");
+await Storage.disk("public").lastModified("path/to/your/file.ext");
 ```
 
 #### New Disk at Runtime
@@ -134,6 +142,22 @@ await Storage.build({
     driver: "local",
     root: App.Path.storagePath("custom")
 }).delete("path/to/your/file.ext");
+await Storage.build({
+    driver: "local",
+    root: App.Path.storagePath("custom")
+}).metadata("path/to/your/file.ext");
+await Storage.build({
+    driver: "local",
+    root: App.Path.storagePath("custom")
+}).size("path/to/your/file.ext");
+await Storage.build({
+    driver: "local",
+    root: App.Path.storagePath("custom")
+}).mimeType("path/to/your/file.ext");
+await Storage.build({
+    driver: "local",
+    root: App.Path.storagePath("custom")
+}).lastModified("path/to/your/file.ext");
 ```
 
 ## ☕ Support / Donate

package/builders/StorageBuilder.js

@@ -60,7 +60,7 @@ export default class StorageBuilder {
     async missing(filepath) {
         if (isEmpty(filepath))
             throw new StorageException("The file path is required.");
-        return !await this.driver.missing(filepath);
+        return !(await this.driver.missing(filepath));
     }
     async metadata(filepath) {
         if (isEmpty(filepath))
@@ -96,7 +96,9 @@ export default class StorageBuilder {
             await this.driver.put(filepath, content, options);
         }
         catch (error) {
-            Logger.setContext("Storage").error("Something went wrong when saving file.").trace(error);
+            Logger.setContext("Storage")
+                .error("Something went wrong when saving file.")
+                .trace(error);
         }
     }
     async copy(source, destination, options) {
@@ -108,7 +110,9 @@ export default class StorageBuilder {
             await this.driver.copy(source, destination, options);
         }
         catch (error) {
-            Logger.setContext("Storage").error("Something went wrong when copying file.").trace(error);
+            Logger.setContext("Storage")
+                .error("Something went wrong when copying file.")
+                .trace(error);
         }
     }
     async move(source, destination, options) {
@@ -120,7 +124,9 @@ export default class StorageBuilder {
             await this.driver.move(source, destination, options);
         }
         catch (error) {
-            Logger.setContext("Storage").error("Something went wrong when moving file.").trace(error);
+            Logger.setContext("Storage")
+                .error("Something went wrong when moving file.")
+                .trace(error);
         }
     }
     async delete(filepath) {

package/builders/storage/StorageLocalBuilder.js

@@ -20,7 +20,7 @@ export default class StorageLocalBuilder {
     async missing(filepath) {
         if (isEmpty(filepath))
             throw new StorageException("The file path is required.");
-        return !await this.exists(filepath);
+        return !(await this.exists(filepath));
     }
     async metadata(filepath) {
         if (isEmpty(filepath))
@@ -56,7 +56,9 @@ export default class StorageLocalBuilder {
             await Bun.write(path.resolve(this.config.root, filepath), content, options);
         }
         catch (error) {
-            Logger.setContext("Storage").error("Something went wrong when saving file.").trace(error);
+            Logger.setContext("Storage")
+                .error("Something went wrong when saving file.")
+                .trace(error);
         }
     }
     async copy(source, destination, options) {
@@ -68,7 +70,9 @@ export default class StorageLocalBuilder {
             await this.put(destination, await this.get(source), options);
         }
         catch (error) {
-            Logger.setContext("Storage").error("Something went wrong when copying file.").trace(error);
+            Logger.setContext("Storage")
+                .error("Something went wrong when copying file.")
+                .trace(error);
         }
     }
     async move(source, destination, options) {
@@ -81,7 +85,9 @@ export default class StorageLocalBuilder {
             await this.delete(source);
         }
         catch (error) {
-            Logger.setContext("Storage").error("Something went wrong when moving file.").trace(error);
+            Logger.setContext("Storage")
+                .error("Something went wrong when moving file.")
+                .trace(error);
         }
     }
     async delete(filepath) {

package/builders/storage/StorageS3Builder.js

@@ -31,7 +31,7 @@ export default class StorageS3Builder {
     async missing(filepath) {
         if (isEmpty(filepath))
             throw new StorageException("The file path is required.");
-        return !await this.exists(filepath);
+        return !(await this.exists(filepath));
     }
     async metadata(filepath) {
         if (isEmpty(filepath))
@@ -67,7 +67,9 @@ export default class StorageS3Builder {
             await this.client.write(filepath, content, options);
         }
         catch (error) {
-            Logger.setContext("Storage").error("Something went wrong when saving file.").trace(error);
+            Logger.setContext("Storage")
+                .error("Something went wrong when saving file.")
+                .trace(error);
         }
     }
     async copy(source, destination, options) {
@@ -79,7 +81,9 @@ export default class StorageS3Builder {
             await this.put(destination, await this.get(source), options);
         }
         catch (error) {
-            Logger.setContext("Storage").error("Something went wrong when copying file.").trace(error);
+            Logger.setContext("Storage")
+                .error("Something went wrong when copying file.")
+                .trace(error);
         }
     }
     async move(source, destination, options) {
@@ -92,7 +96,9 @@ export default class StorageS3Builder {
             await this.delete(source);
         }
         catch (error) {
-            Logger.setContext("Storage").error("Something went wrong when moving file.").trace(error);
+            Logger.setContext("Storage")
+                .error("Something went wrong when moving file.")
+                .trace(error);
         }
     }
     async delete(filepath) {

package/configure.js

@@ -5,8 +5,7 @@ const configPath = path.resolve(__dirname, "config");
 const regex = /\.(m?js|ts)$/;
 const configs = Array.from(new Bun.Glob("**/*").scanSync({
     cwd: configPath
-})).filter(value => (regex.test(value) &&
-    !value.endsWith(".d.ts")));
+})).filter((value) => regex.test(value) && !value.endsWith(".d.ts"));
 for (const config of configs) {
     const destination = config.replace(regex, ".ts");
     await Bun.write(App.Path.configPath(destination), await Bun.file(path.resolve(configPath, config)).text());

package/eslint.config.js

@@ -0,0 +1,61 @@
+import js from "@eslint/js";
+import eslintConfigPrettier from "eslint-config-prettier";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+    {
+        ignores: [
+            "node_modules/**",
+            "dist/**",
+            "out/**",
+            "coverage/**",
+            "public/**",
+            "storage/app/**",
+            "storage/cache/**",
+            "storage/framework/**",
+            "bun.lock",
+            "*.tsbuildinfo"
+        ]
+    },
+
+    js.configs.recommended,
+    ...tseslint.configs.recommended,
+
+    // All TypeScript (server code + resources/views), no React-specific rules
+    {
+        files: ["**/*.{ts,tsx}"],
+        languageOptions: {
+            ecmaVersion: "latest",
+            sourceType: "module",
+            parserOptions: {
+                ecmaFeatures: {
+                    experimentalDecorators: true
+                }
+            },
+            globals: {
+                ...globals.node,
+                ...globals.browser,
+                Bun: "readonly"
+            }
+        },
+        rules: {
+            "no-unused-vars": "off",
+            "@typescript-eslint/no-unused-vars": [
+                "warn",
+                {
+                    argsIgnorePattern: "^_",
+                    varsIgnorePattern: "^_"
+                }
+            ],
+            "@typescript-eslint/no-explicit-any": "off",
+            "@typescript-eslint/no-empty-object-type": "off",
+            "@typescript-eslint/no-inferrable-types": "off",
+            "@typescript-eslint/no-require-imports": "off",
+            "no-console": "off"
+        }
+    },
+
+    // Prettier must be last: turns off stylistic rules that conflict with formatting
+    eslintConfigPrettier
+);

package/facades/Storage.js

@@ -28,7 +28,7 @@ export default class Storage {
         return await new StorageBuilder().get(path);
     }
     static async put(path, content, options) {
-        return await new StorageBuilder().put(path, content);
+        return await new StorageBuilder().put(path, content, options);
     }
     static async copy(source, destination, options) {
         return await new StorageBuilder().copy(source, destination, options);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bejibun/storage",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "author": "Havea Crenata <havea.crenata@gmail.com>",
     "repository": {
         "type": "git",
@@ -8,14 +8,16 @@
     },
     "main": "index.js",
     "module": "index.js",
-    "dependencies": {
-        "@bejibun/app": "^0.1.24",
-        "@bejibun/logger": "^0.1.22",
-        "@bejibun/utils": "^0.1.28"
-    },
     "devDependencies": {
-        "@types/bun": "latest",
-        "tsc-alias": "^1.9.1"
+        "@eslint/js": "^10.0.1",
+        "@types/bun": "^1.3.14",
+        "eslint": "^10.8.1",
+        "eslint-config-prettier": "^10.1.8",
+        "globals": "^17.11.0",
+        "prettier": "^3.9.6",
+        "tsc-alias": "^1.9.2",
+        "typescript": "^6.0.3",
+        "typescript-eslint": "^8.67.0"
     },
     "bugs": {
         "url": "https://github.com/Bejibun-Framework/bejibun-storage/issues"
@@ -31,13 +33,21 @@
     ],
     "license": "MIT",
     "scripts": {
-        "alias": "bunx tsc-alias -p tsconfig.json",
+        "alias": "tsc-alias -p tsconfig.json",
         "types": "cp -rf src/types dist",
         "rsync": "rsync -a dist/ ./",
         "clean": "rm -rf dist",
-        "build": "bunx tsc -p tsconfig.json && bun run types && bun run alias && bun run rsync && bun run clean",
+        "format": "prettier --write src --log-level=silent",
+        "eslint": "eslint src",
+        "lint": "bun run format && bun run eslint",
+        "build": "bun run lint && tsc -p tsconfig.json && bun run types && bun run alias && bun run rsync && bun run clean",
         "deploy": "bun run build && bun publish --access public"
     },
     "type": "module",
-    "types": "index.d.ts"
-}
+    "types": "index.d.ts",
+    "dependencies": {
+        "@bejibun/app": "^0.1.25",
+        "@bejibun/logger": "^0.1.23",
+        "@bejibun/utils": "^0.1.29"
+    }
+}

package/tsconfig.json

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

package/types/index.d.ts

@@ -1 +1 @@
-export * from "../types/storage";
+export * from "../types/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 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>;
+}