@bejibun/cache 0.1.11 → 0.1.13

package/CHANGELOG.md

@@ -3,6 +3,48 @@ All notable changes to this project will be documented in this file.
 
 ---
 
+## [v0.1.13](https://github.com/crenata/bejibun-cache/compare/v0.1.12...v0.1.13) - 2025-12-12
+
+### 🩹 Fixes
+
+### 📖 Changes
+What's New :
+- Adding `ttl` supports for file scheme.
+
+#### How does it work?
+When you use a cache and include a `ttl`, the system generates a `unix timestamp` and adds it with specified `ttl`.
+Then system will write it to a file in the format `ttl|file`, separated by the `|` symbol.
+
+When you call data from the cache, the system creates metadata consisting of the `ttl` and `data` by splitting them with `|`.
+The system then checks if the `ttl` is empty and returns the data.
+
+Or if the `ttl` is present, the system checks whether the `current timestamp` <= `ttl`?
+If so, the data is returned. Otherwise, the cache file will be deleted and returned null.
+
+### ❤️Contributors
+- Havea Crenata ([@crenata](https://github.com/crenata))
+
+**Full Changelog**: https://github.com/crenata/bejibun-cache/blob/master/CHANGELOG.md
+
+---
+
+## [v0.1.12](https://github.com/crenata/bejibun-cache/compare/v0.1.11...v0.1.12) - 2025-12-04
+
+### 🩹 Fixes
+
+### 📖 Changes
+What's New :
+- Adding `local` connection for file schema
+
+Now, [@bejibun/cache](https://github.com/crenata/bejibun-cache) has local and redis for cache system.
+
+### ❤️Contributors
+- Havea Crenata ([@crenata](https://github.com/crenata))
+
+**Full Changelog**: https://github.com/crenata/bejibun-cache/blob/master/CHANGELOG.md
+
+---
+
 ## [v0.1.11](https://github.com/crenata/bejibun-cache/compare/v0.1.0...v0.1.11) - 2025-11-23
 
 ### 🩹 Fixes

package/README.md

@@ -38,10 +38,16 @@ config/cache.ts
 ```
 
 ```ts
+import App from "@bejibun/app";
+
 const config: Record<string, any> = {
-    connection: "redis",
+    connection: "local",
 
     connections: {
+        local: {
+            path: App.Path.storagePath("cache") // absolute path
+        },
+
         redis: {
             host: "127.0.0.100",
             port: 6379,

package/builders/CacheBuilder.d.ts

@@ -4,6 +4,11 @@ export default class CacheBuilder {
     constructor();
     private get config();
     private key;
+    private connection;
+    private filePath;
+    private file;
+    private setFile;
+    private getFile;
     remember(key: string, callback: Function, ttl?: number): Promise<any>;
     has(key: string): Promise<boolean>;
     get(key: string): Promise<any>;

package/builders/CacheBuilder.js

@@ -1,8 +1,10 @@
 import App from "@bejibun/app";
 import Logger from "@bejibun/logger";
 import Redis from "@bejibun/redis";
-import { isEmpty, isNotEmpty } from "@bejibun/utils";
+import Luxon from "@bejibun/utils/facades/Luxon";
+import { defineValue, isEmpty, isNotEmpty } from "@bejibun/utils";
 import fs from "fs";
+import path from "path";
 import CacheConfig from "../config/cache";
 import CacheException from "../exceptions/CacheException";
 export default class CacheBuilder {
@@ -24,11 +26,65 @@ export default class CacheBuilder {
         return this.conf;
     }
     key(key) {
-        return `${this.prefix}/${key}`;
+        const defaultKey = `${this.prefix}-${key.replaceAll("/", "-").replaceAll(" ", "-")}`;
+        return defaultKey;
+        /*if (forceDefault) return defaultKey;
+
+        switch (this.config.connection) {
+            case "local":
+                return `${Luxon.DateTime.now().toUnixInteger()}-${defaultKey}`;
+            default:
+                return defaultKey;
+        }*/
+    }
+    connection() {
+        return this.config.connections[this.config.connection];
+    }
+    filePath(key) {
+        return path.resolve(this.connection().path, `${this.key(key)}.cache`);
+    }
+    file(key) {
+        return Bun.file(this.filePath(key));
+    }
+    async setFile(key, data, ttl) {
+        ttl = defineValue(ttl, "");
+        if (isNotEmpty(ttl))
+            ttl = Luxon.DateTime.now().toUnixInteger() + ttl;
+        await fs.promises.mkdir(this.connection().path, { recursive: true });
+        return await Bun.write(this.filePath(key), `${ttl}|${data}`);
+    }
+    async getFile(key) {
+        let metadata = {
+            ttl: null,
+            data: null
+        };
+        const file = this.file(key);
+        if (await file.exists()) {
+            const raw = await file.text();
+            const [unix, ...rest] = raw.split("|");
+            const ttl = Number(unix);
+            const data = rest.join("|");
+            if (isEmpty(ttl) || Luxon.DateTime.now().toUnixInteger() <= ttl)
+                metadata = {
+                    ttl: defineValue(Number(ttl)),
+                    data
+                };
+            else
+                await this.file(key).delete();
+        }
+        return metadata;
     }
     async remember(key, callback, ttl) {
         let data;
         switch (this.config.connection) {
+            case "local":
+                const raw = await this.getFile(key);
+                data = raw.data;
+                if (isEmpty(data)) {
+                    data = callback();
+                    await this.setFile(key, data, ttl);
+                }
+                break;
             case "redis":
                 data = await Redis.get(this.key(key));
                 if (isEmpty(data)) {
@@ -45,6 +101,10 @@ export default class CacheBuilder {
     async has(key) {
         let data;
         switch (this.config.connection) {
+            case "local":
+                const raw = await this.getFile(key);
+                data = raw.data;
+                break;
             case "redis":
                 data = await Redis.get(this.key(key));
                 break;
@@ -57,6 +117,10 @@ export default class CacheBuilder {
     async get(key) {
         let data;
         switch (this.config.connection) {
+            case "local":
+                const raw = await this.getFile(key);
+                data = raw.data;
+                break;
             case "redis":
                 data = await Redis.get(this.key(key));
                 break;
@@ -71,6 +135,10 @@ export default class CacheBuilder {
         let data;
         try {
             switch (this.config.connection) {
+                case "local":
+                    const raw = await this.getFile(key);
+                    data = raw.data;
+                    break;
                 case "redis":
                     data = await Redis.get(this.key(key));
                     break;
@@ -80,6 +148,9 @@ export default class CacheBuilder {
             }
             if (isEmpty(data)) {
                 switch (this.config.connection) {
+                    case "local":
+                        await this.setFile(key, value, ttl);
+                        break;
                     case "redis":
                         await Redis.set(this.key(key), value, ttl);
                         break;
@@ -102,6 +173,9 @@ export default class CacheBuilder {
         let status = true;
         try {
             switch (this.config.connection) {
+                case "local":
+                    await this.setFile(key, value, ttl);
+                    break;
                 case "redis":
                     await Redis.set(this.key(key), value, ttl);
                     break;
@@ -117,6 +191,14 @@ export default class CacheBuilder {
     }
     async forget(key) {
         switch (this.config.connection) {
+            case "local":
+                try {
+                    await this.file(key).delete();
+                }
+                catch (error) {
+                    break;
+                }
+                break;
             case "redis":
                 await Redis.del(this.key(key));
                 break;
@@ -127,6 +209,18 @@ export default class CacheBuilder {
     async increment(key, ttl) {
         let data;
         switch (this.config.connection) {
+            case "local":
+                const raw = await this.getFile(key);
+                data = Number(raw.data);
+                if (isEmpty(data)) {
+                    data = 1;
+                    await this.setFile(key, String(data), ttl);
+                }
+                else {
+                    data++;
+                    await this.setFile(key, String(data), ttl);
+                }
+                break;
             case "redis":
                 data = Number(await Redis.get(this.key(key)));
                 if (isEmpty(data)) {
@@ -147,6 +241,18 @@ export default class CacheBuilder {
     async decrement(key, ttl) {
         let data;
         switch (this.config.connection) {
+            case "local":
+                const raw = await this.getFile(key);
+                data = Number(raw.data);
+                if (isEmpty(data)) {
+                    data = -1;
+                    await this.setFile(key, String(data), ttl);
+                }
+                else {
+                    data--;
+                    await this.setFile(key, String(data), ttl);
+                }
+                break;
             case "redis":
                 data = Number(await Redis.get(this.key(key)));
                 if (isEmpty(data)) {

package/config/cache.js

@@ -1,6 +1,10 @@
+import App from "@bejibun/app";
 const config = {
-    connection: "redis",
+    connection: "local",
     connections: {
+        local: {
+            path: App.Path.storagePath("cache") // absolute path
+        },
         redis: {
             host: "127.0.0.100",
             port: 6379,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bejibun/cache",
-    "version": "0.1.11",
+    "version": "0.1.13",
     "author": "Havea Crenata <havea.crenata@gmail.com>",
     "repository": {
         "type": "git",
@@ -37,7 +37,7 @@
     "dependencies": {
         "@bejibun/app": "^0.1.22",
         "@bejibun/logger": "^0.1.22",
-        "@bejibun/redis": "^0.1.34",
-        "@bejibun/utils": "^0.1.21"
+        "@bejibun/redis": "^0.1.36",
+        "@bejibun/utils": "^0.1.27"
     }
 }