@bejibun/cache 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+---
+
+## [v0.1.0](https://github.com/crenata/bejibun-cache/compare/v0.1.0...v0.1.0) - 2025-11-09
+
+### 🩹 Fixes
+
+### 📖 Changes
+What's New :
+Cache with Redis, currently only redis.
+
+- `.remember()` Fetch data from cache if exists
+- `.has()` Check if cache exists
+- `.get()` Fetch data from cache
+- `.add()` Insert data to cache, will return false if cache is already exists
+- `.put()` Update cache data
+- `.forget()` Delete cache
+
+### ❤️Contributors
+- Havea Crenata ([@crenata](https://github.com/crenata))
+
+**Full Changelog**: https://github.com/crenata/bejibun-cache/blob/master/CHANGELOG.md

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Havea Crenata
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+<div align="center">
+
+<img src="https://github.com/crenata/bejibun/blob/master/public/images/bejibun.png?raw=true" width="150" alt="Bejibun" />
+
+![GitHub top language](https://img.shields.io/github/languages/top/crenata/bejibun-cache)
+![GitHub all releases](https://img.shields.io/github/downloads/crenata/bejibun-cache/total)
+![GitHub issues](https://img.shields.io/github/issues/crenata/bejibun-cache)
+![GitHub](https://img.shields.io/github/license/crenata/bejibun-cache)
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/crenata/bejibun-cache?display_name=tag&include_prereleases)
+
+</div>
+
+# Cache for Bejibun
+Cache for Bejibun Framework.
+
+## Usage
+
+### Installation
+Install the package.
+
+```bash
+# Using Bun
+bun add @bejibun/cache
+
+# Using Bejibun
+bun ace install @bejibun/cache
+```
+
+### Configuration
+The configuration file automatically executed if you are using `ace`.
+
+Or
+
+Add `cache.ts` inside config directory on your project if doesn't exist.
+
+```bash
+config/cache.ts
+```
+
+```ts
+const config: Record<string, any> = {
+    connection: "redis",
+
+    connections: {
+        redis: {
+            host: "127.0.0.100",
+            port: 6379,
+            password: "",
+            database: 0
+        }
+    }
+};
+
+export default config;
+```
+
+You can pass the value with environment variables.
+
+### How to Use
+How to use tha package.
+
+```ts
+import Cache from "@bejibun/cache";
+
+await Cache.remember("key", () => {}); // any
+await Cache.has("key"); // boolean
+await Cache.get("key"); // any
+await Cache.add("key", "Hello world"); // boolean
+await Cache.put("key", "Lorem ipsum"); // boolean
+```
+
+## Contributors
+- [Havea Crenata](mailto:havea.crenata@gmail.com)
+
+## ☕ Support / Donate
+
+If you find this project helpful and want to support it, you can donate via PayPal :
+
+[![Donate with PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?logo=paypal)](https://paypal.me/hafiizhghulam)
+
+Or if you are prefer using crypto :
+
+| EVM                                                                                                     | Solana                                                                                                  |
+| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| <img src="https://github.com/crenata/bejibun/blob/master/public/images/EVM.png?raw=true" width="150" /> | <img src="https://github.com/crenata/bejibun/blob/master/public/images/SOL.png?raw=true" width="150" /> |
+| 0xdABe8750061410D35cE52EB2a418c8cB004788B3                                                              | GAnoyvy9p3QFyxikWDh9hA3fmSk2uiPLNWyQ579cckMn                                                            |
+
+Or you can buy this `$BJBN (Bejibun)` tokens [here](https://pump.fun/coin/CQhbNnCGKfDaKXt8uE61i5DrBYJV7NPsCDD9vQgypump), beware of bots.

package/builders/CacheBuilder.d.ts

@@ -0,0 +1,13 @@
+export default class CacheBuilder {
+    protected conf: Record<string, any>;
+    protected prefix: string;
+    constructor();
+    private get config();
+    private key;
+    remember(key: string, callback: Function): Promise<any>;
+    has(key: string): Promise<boolean>;
+    get(key: string): Promise<any>;
+    add(key: string, value: any): Promise<boolean>;
+    put(key: string, value: any): Promise<boolean>;
+    forget(key: string): Promise<void>;
+}

package/builders/CacheBuilder.js

@@ -0,0 +1,127 @@
+import App from "@bejibun/app";
+import Logger from "@bejibun/logger";
+import Redis from "@bejibun/redis";
+import { isEmpty, isNotEmpty } from "@bejibun/utils";
+import fs from "fs";
+import CacheConfig from "../config/cache";
+import CacheException from "../exceptions/CacheException";
+export default class CacheBuilder {
+    conf;
+    prefix;
+    constructor() {
+        const configPath = App.Path.configPath("cache.ts");
+        let config;
+        if (fs.existsSync(configPath))
+            config = require(configPath).default;
+        else
+            config = CacheConfig;
+        this.conf = config;
+        this.prefix = "bejibun-cache";
+    }
+    get config() {
+        if (isEmpty(this.conf))
+            throw new CacheException("There is no config provided.");
+        return this.conf;
+    }
+    key(key) {
+        return `${this.prefix}/${key}`;
+    }
+    async remember(key, callback) {
+        let data;
+        switch (this.config.connection) {
+            case "redis":
+                data = await Redis.get(this.key(key));
+                if (isEmpty(data)) {
+                    data = callback();
+                    await Redis.set(this.key(key), data);
+                }
+                break;
+            default:
+                data = null;
+                break;
+        }
+        return data;
+    }
+    async has(key) {
+        let data;
+        switch (this.config.connection) {
+            case "redis":
+                data = await Redis.get(this.key(key));
+                break;
+            default:
+                data = false;
+                break;
+        }
+        return isNotEmpty(data);
+    }
+    async get(key) {
+        let data;
+        switch (this.config.connection) {
+            case "redis":
+                data = await Redis.get(this.key(key));
+                break;
+            default:
+                data = false;
+                break;
+        }
+        return data;
+    }
+    async add(key, value) {
+        let status = true;
+        let data;
+        try {
+            switch (this.config.connection) {
+                case "redis":
+                    data = await Redis.get(this.key(key));
+                    break;
+                default:
+                    data = null;
+                    break;
+            }
+            if (isEmpty(data)) {
+                switch (this.config.connection) {
+                    case "redis":
+                        await Redis.set(this.key(key), value);
+                        break;
+                    default:
+                        break;
+                }
+            }
+            else {
+                status = false;
+                Logger.setContext("Cache").info("The cache key is already exists.");
+            }
+        }
+        catch (error) {
+            status = false;
+            Logger.setContext("Cache").error("Failed to add cache.").trace(error);
+        }
+        return status;
+    }
+    async put(key, value) {
+        let status = true;
+        try {
+            switch (this.config.connection) {
+                case "redis":
+                    await Redis.set(this.key(key), value);
+                    break;
+                default:
+                    break;
+            }
+        }
+        catch (error) {
+            status = false;
+            Logger.setContext("Cache").error("Failed to add cache.").trace(error);
+        }
+        return status;
+    }
+    async forget(key) {
+        switch (this.config.connection) {
+            case "redis":
+                await Redis.del(this.key(key));
+                break;
+            default:
+                break;
+        }
+    }
+}

package/config/cache.d.ts

@@ -0,0 +1,2 @@
+declare const config: Record<string, any>;
+export default config;

package/config/cache.js

@@ -0,0 +1,12 @@
+const config = {
+    connection: "redis",
+    connections: {
+        redis: {
+            host: "127.0.0.100",
+            port: 6379,
+            password: "",
+            database: 0
+        }
+    }
+};
+export default config;

package/configure.d.ts

@@ -0,0 +1 @@
+export {};

package/configure.js

@@ -0,0 +1,14 @@
+import App from "@bejibun/app";
+import Logger from "@bejibun/logger";
+import path from "path";
+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")));
+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());
+    Logger.setContext("CONFIGURE").info(`Copying ${config} into config/${destination}`);
+}

package/exceptions/CacheException.d.ts

@@ -0,0 +1,4 @@
+export default class CacheException extends Error {
+    code: number;
+    constructor(message?: string, code?: number);
+}

package/exceptions/CacheException.js

@@ -0,0 +1,14 @@
+import Logger from "@bejibun/logger";
+import { defineValue } from "@bejibun/utils";
+export default class CacheException extends Error {
+    code;
+    constructor(message, code) {
+        super(message);
+        this.name = "CacheException";
+        this.code = defineValue(code, 503);
+        Logger.setContext(this.name).error(this.message).trace(this.stack);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, CacheException);
+        }
+    }
+}

package/exceptions/index.d.ts

@@ -0,0 +1 @@
+export * from "../exceptions/CacheException";

package/exceptions/index.js

@@ -0,0 +1 @@
+export * from "../exceptions/CacheException";

package/facades/Cache.d.ts

@@ -0,0 +1,8 @@
+export default class Cache {
+    static remember(key: string, callback: Function): Promise<any>;
+    static has(key: string): Promise<boolean>;
+    static get(key: string): Promise<any>;
+    static add(key: string, value: string): Promise<boolean>;
+    static put(key: string, value: string): Promise<boolean>;
+    static forget(key: string): Promise<void>;
+}

package/facades/Cache.js

@@ -0,0 +1,21 @@
+import CacheBuilder from "../builders/CacheBuilder";
+export default class Cache {
+    static async remember(key, callback) {
+        return new CacheBuilder().remember(key, callback);
+    }
+    static async has(key) {
+        return new CacheBuilder().has(key);
+    }
+    static async get(key) {
+        return new CacheBuilder().get(key);
+    }
+    static async add(key, value) {
+        return new CacheBuilder().add(key, value);
+    }
+    static async put(key, value) {
+        return new CacheBuilder().put(key, value);
+    }
+    static async forget(key) {
+        return new CacheBuilder().forget(key);
+    }
+}

package/facades/index.d.ts

@@ -0,0 +1 @@
+export * from "../facades/Cache";

package/facades/index.js

@@ -0,0 +1 @@
+export * from "../facades/Cache";

package/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from "./facades/Cache";
+export * from "./facades/index";

package/index.js

@@ -0,0 +1,2 @@
+export { default } from "./facades/Cache";
+export * from "./facades/index";

package/package.json

@@ -0,0 +1,43 @@
+{
+    "name": "@bejibun/cache",
+    "version": "0.1.0",
+    "author": "Havea Crenata <havea.crenata@gmail.com>",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/crenata/bejibun-cache.git"
+    },
+    "main": "index.js",
+    "module": "index.js",
+    "devDependencies": {
+        "@types/bun": "latest",
+        "tsc-alias": "^1.8.16"
+    },
+    "bugs": {
+        "url": "https://github.com/crenata/bejibun-cache/issues"
+    },
+    "description": "Cache for Bejibun Framework",
+    "homepage": "https://github.com/crenata/bejibun-cache#readme",
+    "keywords": [
+        "bun",
+        "bun framework",
+        "cache",
+        "bejibun",
+        "typescript"
+    ],
+    "license": "MIT",
+    "scripts": {
+        "alias": "bunx tsc-alias -p tsconfig.json",
+        "rsync": "rsync -a dist/ ./",
+        "clean": "rm -rf dist",
+        "build": "bunx tsc -p tsconfig.json && bun run alias && bun run rsync && bun run clean",
+        "deploy": "bun run build && bun publish --access public"
+    },
+    "type": "module",
+    "types": "index.d.ts",
+    "dependencies": {
+        "@bejibun/app": "^0.1.22",
+        "@bejibun/logger": "^0.1.22",
+        "@bejibun/redis": "^0.1.33",
+        "@bejibun/utils": "^0.1.20"
+    }
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+    "compilerOptions": {
+        "target": "ESNext",
+        "module": "ESNext",
+        "declaration": true,
+        "outDir": "dist",
+        "rootDir": "src",
+        "strict": true,
+        "moduleResolution": "bundler",
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "baseUrl": ".",
+        "paths": {
+            "@/*": ["src/*"]
+        }
+    }
+}