@bejibun/database 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+---
+
+## [v0.1.0](https://github.com/crenata/bejibun-database/compare/v0.1.0...v0.1.0) - 2025-10-22
+
+### 🩹 Fixes
+
+### 📖 Changes
+What's New :
+- Adding `Database.knex()` for init database connection
+- Adding `config/database.ts` configuration file
+- Adding commands directory structure
+
+Available Commands :
+- `db:seed` Run database seeders
+- `migrate:fresh` Rollback all migrations and re-run migrations
+- `migrate:latest` Run latest migration
+- `migrate:rollback` Rollback the latest migrations
+- `migrate:status` List migrations status
+
+### ❤️Contributors
+- Havea Crenata ([@crenata](https://github.com/crenata))
+- Ghulje ([@ghulje](https://github.com/ghulje))
+
+**Full Changelog**: https://github.com/crenata/bejibun-database/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,106 @@
+<div align="center">
+
+![GitHub top language](https://img.shields.io/github/languages/top/crenata/bejibun-database)
+![GitHub all releases](https://img.shields.io/github/downloads/crenata/bejibun-database/total)
+![GitHub issues](https://img.shields.io/github/issues/crenata/bejibun-database)
+![GitHub](https://img.shields.io/github/license/crenata/bejibun-database)
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/crenata/bejibun-database?display_name=tag&include_prereleases)
+
+</div>
+
+# Database for Bejibun
+Database package with Built-in Bun for Bejibun Framework.
+
+## Usage
+
+### Installation
+Install the package.
+
+```bash
+# Using Bun
+bun add @bejibun/database
+
+# Using Bejibun
+bun ace install @bejibun/database
+```
+
+### Configuration
+Add `database.ts` inside config directory on your project
+
+```bash
+config/database.ts
+```
+
+```ts
+const config: Record<string, any> = {
+    default: "local",
+
+    connections: {
+        local: {
+            host: "127.0.0.1",
+            port: 6379,
+            password: "",
+            database: 0,
+            maxRetries: 10
+        }
+    }
+};
+
+export default config;
+```
+
+You can pass the value with environment variables.
+
+### How to Use
+How to use tha package.
+
+```ts
+import type {DatabasePipeline} from "@bejibun/database/types";
+import BaseController from "@bejibun/core/bases/BaseController";
+import Logger from "@bejibun/logger";
+import Database from "@bejibun/database";
+
+export default class TestController extends BaseController {
+    public async database(request: Bun.BunRequest): Promise<Response> {
+        await Database.set("database", {hello: "world"});
+        const database = await Database.get("database");
+
+        await Database.connection("local").set("connection", "This is using custom connection.");
+        const connection = await Database.connection("local").get("connection");
+
+        const pipeline = await Database.pipeline((pipe: DatabasePipeline) => {
+            pipe.set("database-pipeline-1", "This is database pipeline 1");
+            pipe.set("database-pipeline-2", "This is database pipeline 2");
+
+            pipe.get("database-pipeline-1");
+            pipe.get("database-pipeline-2");
+        });
+
+        const subscriber = await Database.subscribe("database-subscribe", (message: string, channel: string) => {
+            Logger.setContext(channel).debug(message);
+        });
+        await Database.publish("database-subscribe", "Hai database subscriber!");
+        setTimeout(async () => {
+            await subscriber.unsubscribe();
+        }, 500);
+
+        return super.response.setData({database, connection, pipeline}).send();
+    }
+}
+```
+
+## 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 |

package/builders/DatabaseBuilder.d.ts

@@ -0,0 +1,5 @@
+import type { Knex } from "knex";
+export default class DatabaseBuilder {
+    protected database?: Knex;
+    knex(): Knex;
+}

package/builders/DatabaseBuilder.js

@@ -0,0 +1,17 @@
+import App from "@bejibun/app";
+import fs from "fs";
+import knex from "knex";
+import DatabaseConfig from "../config/database";
+export default class DatabaseBuilder {
+    database;
+    knex() {
+        const configPath = App.Path.configPath("database.ts");
+        let config;
+        if (fs.existsSync(configPath))
+            config = require(configPath).default;
+        else
+            config = DatabaseConfig;
+        this.database = knex(config);
+        return this.database;
+    }
+}

package/commands/db/DbSeedCommand.d.ts

@@ -0,0 +1,27 @@
+export default class DbSeedCommand {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var $signature string
+     */
+    protected $signature: string;
+    /**
+     * The console command description.
+     *
+     * @var $description string
+     */
+    protected $description: string;
+    /**
+     * The options or optional flag of the console command.
+     *
+     * @var $options Array<Array<any>>
+     */
+    protected $options: Array<Array<any>>;
+    /**
+     * The arguments of the console command.
+     *
+     * @var $arguments Array<Array<string>>
+     */
+    protected $arguments: Array<Array<string>>;
+    handle(options: any, args: Array<string>): Promise<void>;
+}

package/commands/db/DbSeedCommand.js

@@ -0,0 +1,51 @@
+import Chalk from "@bejibun/logger/facades/Chalk";
+import ora from "ora";
+import path from "path";
+import Database from "../../facades/Database";
+export default class DbSeedCommand {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var $signature string
+     */
+    $signature = "db:seed";
+    /**
+     * The console command description.
+     *
+     * @var $description string
+     */
+    $description = "Run database seeders";
+    /**
+     * The options or optional flag of the console command.
+     *
+     * @var $options Array<Array<any>>
+     */
+    $options = [];
+    /**
+     * The arguments of the console command.
+     *
+     * @var $arguments Array<Array<string>>
+     */
+    $arguments = [];
+    async handle(options, args) {
+        const database = Database.knex();
+        const spinner = ora(Chalk.setValue("Seeding...")
+            .info()
+            .show()).start();
+        try {
+            const logs = (await database.seed.run()).flat();
+            spinner.succeed("Seeding finished");
+            if (logs.length > 0)
+                logs.forEach((seeder) => spinner.succeed(path.basename(seeder)));
+            else
+                spinner.succeed("No seeders were run.");
+        }
+        catch (error) {
+            spinner.fail(`Seeding failed : ${error.message}`);
+        }
+        finally {
+            await database.destroy();
+            spinner.stop();
+        }
+    }
+}

package/commands/migrate/MigrateFreshCommand.d.ts

@@ -0,0 +1,27 @@
+export default class MigrateFreshCommand {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var $signature string
+     */
+    protected $signature: string;
+    /**
+     * The console command description.
+     *
+     * @var $description string
+     */
+    protected $description: string;
+    /**
+     * The options or optional flag of the console command.
+     *
+     * @var $options Array<Array<any>>
+     */
+    protected $options: Array<Array<any>>;
+    /**
+     * The arguments of the console command.
+     *
+     * @var $arguments Array<Array<string>>
+     */
+    protected $arguments: Array<Array<string>>;
+    handle(options: any, args: Array<string>): Promise<void>;
+}

package/commands/migrate/MigrateFreshCommand.js

@@ -0,0 +1,67 @@
+import Logger from "@bejibun/logger";
+import Chalk from "@bejibun/logger/facades/Chalk";
+import { ask, isNotEmpty } from "@bejibun/utils";
+import ora from "ora";
+import Database from "../../facades/Database";
+export default class MigrateFreshCommand {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var $signature string
+     */
+    $signature = "migrate:fresh";
+    /**
+     * The console command description.
+     *
+     * @var $description string
+     */
+    $description = "Rollback all migrations and re-run migrations";
+    /**
+     * The options or optional flag of the console command.
+     *
+     * @var $options Array<Array<any>>
+     */
+    $options = [
+        ["-f, --force", "Skip command confirmation"]
+    ];
+    /**
+     * The arguments of the console command.
+     *
+     * @var $arguments Array<Array<string>>
+     */
+    $arguments = [];
+    async handle(options, args) {
+        const database = Database.knex();
+        const bypass = isNotEmpty(options.force);
+        let confirm = "Y";
+        if (!bypass)
+            confirm = await ask(Chalk.setValue("This will DROP ALL tables and re-run ALL migrations. Are you want to continue? (Y/N): ")
+                .inline()
+                .error()
+                .show());
+        if (confirm.toUpperCase() === "Y") {
+            if (!bypass)
+                Logger.empty();
+            const spinner = ora(Chalk.setValue("Rollback...")
+                .info()
+                .show()).start();
+            try {
+                await database.migrate.rollback({}, true);
+                spinner.succeed("Rolled back all migrations");
+                const [batchNo, logs] = await database.migrate.latest();
+                spinner.succeed(`Batch ${batchNo} finished`);
+                if (logs.length > 0)
+                    logs.forEach((migration) => spinner.succeed(migration));
+                else
+                    spinner.succeed("No migrations were run.");
+            }
+            catch (error) {
+                spinner.fail(`Migration failed : ${error.message}`);
+            }
+            finally {
+                await database.destroy();
+                spinner.stop();
+            }
+        }
+    }
+}

package/commands/migrate/MigrateLatestCommand.d.ts

@@ -0,0 +1,27 @@
+export default class MigrateLatestCommand {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var $signature string
+     */
+    protected $signature: string;
+    /**
+     * The console command description.
+     *
+     * @var $description string
+     */
+    protected $description: string;
+    /**
+     * The options or optional flag of the console command.
+     *
+     * @var $options Array<Array<any>>
+     */
+    protected $options: Array<Array<any>>;
+    /**
+     * The arguments of the console command.
+     *
+     * @var $arguments Array<Array<string>>
+     */
+    protected $arguments: Array<Array<string>>;
+    handle(options: any, args: Array<string>): Promise<void>;
+}

package/commands/migrate/MigrateLatestCommand.js

@@ -0,0 +1,50 @@
+import Chalk from "@bejibun/logger/facades/Chalk";
+import ora from "ora";
+import Database from "../../facades/Database";
+export default class MigrateLatestCommand {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var $signature string
+     */
+    $signature = "migrate:latest";
+    /**
+     * The console command description.
+     *
+     * @var $description string
+     */
+    $description = "Run latest migration";
+    /**
+     * The options or optional flag of the console command.
+     *
+     * @var $options Array<Array<any>>
+     */
+    $options = [];
+    /**
+     * The arguments of the console command.
+     *
+     * @var $arguments Array<Array<string>>
+     */
+    $arguments = [];
+    async handle(options, args) {
+        const database = Database.knex();
+        const spinner = ora(Chalk.setValue("Migrating...")
+            .info()
+            .show()).start();
+        try {
+            const [batchNo, logs] = await database.migrate.latest();
+            spinner.succeed(`Batch ${batchNo} finished`);
+            if (logs.length > 0)
+                logs.forEach((migration) => spinner.succeed(migration));
+            else
+                spinner.succeed("No migrations were run.");
+        }
+        catch (error) {
+            spinner.fail(`Migration failed : ${error.message}`);
+        }
+        finally {
+            await database.destroy();
+            spinner.stop();
+        }
+    }
+}

package/commands/migrate/MigrateRollbackCommand.d.ts

@@ -0,0 +1,27 @@
+export default class MigrateRollbackCommand {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var $signature string
+     */
+    protected $signature: string;
+    /**
+     * The console command description.
+     *
+     * @var $description string
+     */
+    protected $description: string;
+    /**
+     * The options or optional flag of the console command.
+     *
+     * @var $options Array<Array<any>>
+     */
+    protected $options: Array<Array<any>>;
+    /**
+     * The arguments of the console command.
+     *
+     * @var $arguments Array<Array<string>>
+     */
+    protected $arguments: Array<Array<string>>;
+    handle(options: any, args: Array<string>): Promise<void>;
+}

package/commands/migrate/MigrateRollbackCommand.js

@@ -0,0 +1,65 @@
+import Logger from "@bejibun/logger";
+import Chalk from "@bejibun/logger/facades/Chalk";
+import { ask, isNotEmpty } from "@bejibun/utils";
+import ora from "ora";
+import Database from "../../facades/Database";
+export default class MigrateRollbackCommand {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var $signature string
+     */
+    $signature = "migrate:rollback";
+    /**
+     * The console command description.
+     *
+     * @var $description string
+     */
+    $description = "Rollback the latest migrations";
+    /**
+     * The options or optional flag of the console command.
+     *
+     * @var $options Array<Array<any>>
+     */
+    $options = [
+        ["-f, --force", "Skip command confirmation"]
+    ];
+    /**
+     * The arguments of the console command.
+     *
+     * @var $arguments Array<Array<string>>
+     */
+    $arguments = [];
+    async handle(options, args) {
+        const database = Database.knex();
+        const bypass = isNotEmpty(options.force);
+        let confirm = "Y";
+        if (!bypass)
+            confirm = await ask(Chalk.setValue("This will ROLLBACK latest migrations. Are you want to continue? (Y/N): ")
+                .inline()
+                .error()
+                .show());
+        if (confirm.toUpperCase() === "Y") {
+            if (!bypass)
+                Logger.empty();
+            const spinner = ora(Chalk.setValue("Rollback...")
+                .info()
+                .show()).start();
+            try {
+                const [batchNo, logs] = await database.migrate.rollback();
+                spinner.succeed(`Batch ${batchNo} finished`);
+                if (logs.length > 0)
+                    logs.forEach((migration) => spinner.succeed(migration));
+                else
+                    spinner.succeed("No migrations were rolled back.");
+            }
+            catch (error) {
+                spinner.fail(`Rollback failed : ${error.message}`);
+            }
+            finally {
+                await database.destroy();
+                spinner.stop();
+            }
+        }
+    }
+}

package/commands/migrate/MigrateStatusCommand.d.ts

@@ -0,0 +1,27 @@
+export default class MigrateStatusCommand {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var $signature string
+     */
+    protected $signature: string;
+    /**
+     * The console command description.
+     *
+     * @var $description string
+     */
+    protected $description: string;
+    /**
+     * The options or optional flag of the console command.
+     *
+     * @var $options Array<Array<any>>
+     */
+    protected $options: Array<Array<any>>;
+    /**
+     * The arguments of the console command.
+     *
+     * @var $arguments Array<Array<string>>
+     */
+    protected $arguments: Array<Array<string>>;
+    handle(options: any, args: Array<string>): Promise<void>;
+}

package/commands/migrate/MigrateStatusCommand.js

@@ -0,0 +1,59 @@
+import Logger from "@bejibun/logger";
+import Chalk from "@bejibun/logger/facades/Chalk";
+import ora from "ora";
+import Database from "../../facades/Database";
+export default class MigrateStatusCommand {
+    /**
+     * The name and signature of the console command.
+     *
+     * @var $signature string
+     */
+    $signature = "migrate:status";
+    /**
+     * The console command description.
+     *
+     * @var $description string
+     */
+    $description = "List migrations status";
+    /**
+     * The options or optional flag of the console command.
+     *
+     * @var $options Array<Array<any>>
+     */
+    $options = [
+        ["-f, --force", "Skip command confirmation"]
+    ];
+    /**
+     * The arguments of the console command.
+     *
+     * @var $arguments Array<Array<string>>
+     */
+    $arguments = [];
+    async handle(options, args) {
+        const database = Database.knex();
+        const spinner = ora(Chalk.setValue("Fetching...")
+            .info()
+            .show()).start();
+        try {
+            const [completed, pending] = await database.migrate.list();
+            spinner.succeed("Completed Migrations :");
+            if (completed.length > 0)
+                completed.forEach((migration) => spinner.succeed(migration.name));
+            else
+                spinner.succeed("No migrations were completed.");
+            Logger.empty();
+            spinner.succeed("Pending Migrations :");
+            if (pending.length > 0)
+                pending.forEach((migration) => spinner.succeed(migration.file));
+            else
+                spinner.succeed("No migrations were pending.");
+        }
+        catch (error) {
+            spinner.fail(`Fetching failed : ${error.message}`);
+        }
+        finally {
+            await database.destroy();
+            spinner.stop();
+        }
+    }
+}

package/config/database.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from "knex";
+declare const config: Knex.Config;
+export default config;

package/config/database.js

@@ -0,0 +1,24 @@
+const config = {
+    client: "pg",
+    connection: {
+        host: "127.0.0.1",
+        port: 5432,
+        user: "postgres",
+        password: "",
+        database: "bejibun"
+    },
+    migrations: {
+        extension: "ts",
+        directory: "./database/migrations",
+        tableName: "migrations"
+    },
+    pool: {
+        min: 0,
+        max: 1
+    },
+    seeds: {
+        extension: "ts",
+        directory: "./database/seeders"
+    }
+};
+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/facades/Database.d.ts

@@ -0,0 +1,4 @@
+import type { Knex } from "knex";
+export default class Database {
+    static knex(): Knex;
+}

package/facades/Database.js

@@ -0,0 +1,6 @@
+import DatabaseBuilder from "../builders/DatabaseBuilder";
+export default class Database {
+    static knex() {
+        return new DatabaseBuilder().knex();
+    }
+}

package/facades/index.d.ts

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

package/facades/index.js

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

package/index.d.ts

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

package/index.js

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

package/package.json

@@ -0,0 +1,45 @@
+{
+    "name": "@bejibun/database",
+    "version": "0.1.0",
+    "author": "Havea Crenata <havea.crenata@gmail.com>",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/crenata/bejibun-database.git"
+    },
+    "main": "index.js",
+    "module": "index.js",
+    "devDependencies": {
+        "@types/bun": "latest",
+        "tsc-alias": "^1.8.16"
+    },
+    "bugs": {
+        "url": "https://github.com/crenata/bejibun-database/issues"
+    },
+    "description": "Database for Bejibun Framework",
+    "homepage": "https://github.com/crenata/bejibun-database#readme",
+    "keywords": [
+        "bun",
+        "bun framework",
+        "database",
+        "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.19",
+        "@bejibun/logger": "^0.1.18",
+        "@bejibun/utils": "^0.1.14",
+        "knex": "^3.1.0",
+        "ora": "^9.0.0",
+        "pg": "^8.16.3"
+    }
+}

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/*"]
+        }
+    }
+}