@skalfa/skalfa-api 1.0.1 → 1.0.2

package/.env.example

@@ -1,76 +1,76 @@
-# =========================>
-# ## APP
-# =========================>
-APP_NAME=aluna_api
-APP_PORT=4000
-APP_CORS_ORIGINS=
-APP_CORS_METHODS=
-APP_CORS_HEADERS=
-
-
-# =========================>
-# ## DATABASE (OLTP)
-# =========================>
-DB_CONNECTION=pg
-DB_HOST=127.0.0.1
-DB_PORT=5432
-DB_USERNAME=postgres
-DB_PASSWORD=password
-DB_DATABASE=db_aluna_api
-
-
-# =========================>
-# ## DATABASE (OLAP)
-# =========================>
-
-
-# =========================>
-# ## REDIS
-# =========================>
-
-
-# =========================>
-# ## CRONJOB
-# =========================>
-
-
-# =========================>
-# ## SOCKET
-# =========================>
-
-
-# =========================>
-# ## LOGGER
-# =========================>
-ACCESS_LOG_DRIVER=
-ACCESS_LOG_DIR=
-ACCESS_LOG_TABLE=
-ACCESS_LOG_QUEUE=
-ACCESS_LOG_CONCURRENCY=
-ACCESS_LOG_FLUSH=
-
-ERROR_LOG_DRIVER=
-ERROR_LOG_DIR=
-ERROR_LOG_TABLE=
-ERROR_LOG_QUEUE=
-ERROR_LOG_CONCURRENCY=
-ERROR_LOG_FLUSH=
-
-ACTIVITY_LOG_DRIVER=
-ACTIVITY_LOG_DB_TABLE=
-ACTIVITY_LOG_DA_TABLE=
-ACTIVITY_LOG_QUEUE=
-ACTIVITY_LOG_CONCURRENCY=
-
-
-# =========================>
-# ## MAIL
-# =========================>
-MAIL_MAILER=smtp
-MAIL_HOST=smtp.gmail.com
-MAIL_PORT=587
-MAIL_USERNAME=
-MAIL_PASSWORD=
-MAIL_ENCRYPTION=tls
-MAIL_FROM_ADDRESS=
+# =========================>
+# ## APP
+# =========================>
+APP_NAME=aluna_api
+APP_PORT=4000
+APP_CORS_ORIGINS=
+APP_CORS_METHODS=
+APP_CORS_HEADERS=
+
+
+# =========================>
+# ## DATABASE (OLTP)
+# =========================>
+DB_CONNECTION=pg
+DB_HOST=127.0.0.1
+DB_PORT=5432
+DB_USERNAME=postgres
+DB_PASSWORD=password
+DB_DATABASE=db_aluna_api
+
+
+# =========================>
+# ## DATABASE (OLAP)
+# =========================>
+
+
+# =========================>
+# ## REDIS
+# =========================>
+
+
+# =========================>
+# ## CRONJOB
+# =========================>
+
+
+# =========================>
+# ## SOCKET
+# =========================>
+
+
+# =========================>
+# ## LOGGER
+# =========================>
+ACCESS_LOG_DRIVER=
+ACCESS_LOG_DIR=
+ACCESS_LOG_TABLE=
+ACCESS_LOG_QUEUE=
+ACCESS_LOG_CONCURRENCY=
+ACCESS_LOG_FLUSH=
+
+ERROR_LOG_DRIVER=
+ERROR_LOG_DIR=
+ERROR_LOG_TABLE=
+ERROR_LOG_QUEUE=
+ERROR_LOG_CONCURRENCY=
+ERROR_LOG_FLUSH=
+
+ACTIVITY_LOG_DRIVER=
+ACTIVITY_LOG_DB_TABLE=
+ACTIVITY_LOG_DA_TABLE=
+ACTIVITY_LOG_QUEUE=
+ACTIVITY_LOG_CONCURRENCY=
+
+
+# =========================>
+# ## MAIL
+# =========================>
+MAIL_MAILER=smtp
+MAIL_HOST=smtp.gmail.com
+MAIL_PORT=587
+MAIL_USERNAME=
+MAIL_PASSWORD=
+MAIL_ENCRYPTION=tls
+MAIL_FROM_ADDRESS=
 MAIL_FROM_NAME=

package/.github/workflows/publish.yml

@@ -19,12 +19,19 @@ jobs:
           node-version: 20
           registry-url: https://registry.npmjs.org/
 
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
       - name: Publish if version bumped
         run: |
           LOCAL_VER=$(node -p "require('./package.json').version")
           NPM_VER=$(npm view @skalfa/skalfa-api version 2>/dev/null || echo "0.0.0")
           if [ "$LOCAL_VER" != "$NPM_VER" ]; then
             echo "Publishing @skalfa/skalfa-api $LOCAL_VER (Registry version: $NPM_VER)"
+            bun install
+            
             npm publish --access public
           else
             echo "@skalfa/skalfa-api is up to date ($LOCAL_VER)"

package/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to @skalfa/skalfa-api
+
+Thank you for your interest in contributing to Skalfa! We welcome contributions from the community to help make Skalfa the premier development framework.
+
+## How to Contribute
+
+To contribute to this package, please follow these standard open-source steps:
+
+### 1. Fork the Repository
+Fork the official Skalfa repository on GitHub to your personal account.
+
+### 2. Clone Your Fork
+Clone your personal fork to your local machine:
+```bash
+git clone https://github.com/your-username/skalfa.git
+cd skalfa
+```
+
+### 3. Create a Feature Branch
+Create a new branch for your feature or bugfix:
+```bash
+git checkout -b feature/amazing-new-feature
+```
+*(Use `bugfix/issue-description` for bugfixes).*
+
+### 4. Implement and Commit Your Changes
+Make your changes in the codebase. Write clean, formatted code and ensure all tests and typechecks pass. Commit your changes using semantic commit messages:
+```bash
+git commit -m "feat: add amazing new feature"
+```
+*(Use `fix: description` for bugfixes, and `docs: description` for documentation updates).*
+
+### 5. Push to GitHub
+Push your branch to your personal fork on GitHub:
+```bash
+git push origin feature/amazing-new-feature
+```
+
+### 6. Submit a Pull Request (PR)
+Go to the official Skalfa repository on GitHub. You will see a prompt to submit a pull request. Click "New Pull Request", describe your changes in detail, link any related issues, and submit it for review by the maintainers.
+
+## Guidelines
+* **Code Style**: Ensure your code conforms to the project's ESLint rules and formatting guidelines.
+* **Type Safety**: Write strict, type-safe TypeScript. Do not bypass the compiler.
+* **Testing**: Run local tests and verify that the build compiles with 0 errors before submitting a PR.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Skalfa
+
+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

@@ -1,85 +1,79 @@
-## About Elysia Light
-
-Bun & Elysia stater kit for API Service Development with CRUD Generation, API Service Configuration, Etc. with elysia light save your time just for more creative thinking.
-
-<br>
-
-## Version Elysia ^ 1.4
-
-<p align="center"><a href="https://elysiajs.com/" target="_blank"><img src="https://elysiajs.com/assets/elysia_v.webp" width="70%" alt="Elysia Banner"></a></p>
-
-<br>
-<br>
-
-## Magic Command
-
-### Make Controller
-
-```
-bun light make:controller {name}
-```
-
-### Make Light Controller
-
-```
-bun light make:light-controller {name} --model={model[optional]}
-```
-
-### Make Model
-
-```
-bun light make:model {name}
-```
-
-### Make Light Model
-
-```
-bun light make:light-model {name}
-```
-
-### Make Migration
-
-```
-bun light make:migration {name}
-```
-
-### Run Migration
-
-```
-bun light migrate
-```
-
-### Run Fresh Migration
-
-```
-bun light migrate:fresh
-```
-
-### Make Seeder
-
-```
-bun light make:seeder {name}
-```
-
-### Run Seeder
-
-```
-bun light seed
-```
-
-### Make Blueprint
-
-```
-bun light make:blueprint {name}
-```
-
-### Run Blueprints
-
-```
-bun light blueprint {name[optional]}
-```
-
-
-========================= <br>
-Creative by: [SEJE Digital](https://sejedigital.com) <br>
-========================= <br>
+<p align="center">
+  <img src="https://raw.githubusercontent.com/skalfa-framework/skalfa/main/logo/logo-skalfa-full.png" alt="Skalfa Logo" width="300" />
+</p>
+
+# @skalfa/skalfa-api
+
+> Premium backend starter template powered by Elysia and Bun, pre-configured with modular utilities.
+
+---
+
+## About this Package
+
+This package is part of the **Skalfa Framework**, a premium development ecosystem designed to build high-performance, modular web applications and APIs.
+
+---
+
+## Documentation
+
+See the usage documentation at [Documentation](https://skalfa.sejedigital.com).
+
+---
+
+## Installation
+
+You can install this package using your preferred package manager:
+
+```bash
+# Using npm
+npm install @skalfa/skalfa-api
+
+# Using bun
+bun add @skalfa/skalfa-api
+```
+
+---
+
+## Development & Production Scripts
+
+This backend starter template provides the following CLI execution scripts:
+
+### 💻 Development
+* **`bun run dev`**: Starts the Elysia API server in hot-reload watch mode.
+* **`bun run dev:all`**: Concurrently starts the main API server and any background workers (queues, sockets, crons) in development watch mode.
+
+### 📦 Build & Production
+* **`bun run build`**: Compiles the Elysia backend application into optimized production JavaScript.
+* **`bun run start`**: Starts the production-built Elysia API server.
+
+### ⚙️ Background Workers (Optional Extensions)
+* **`bun start:cron`**: Launches the automated cron scheduler and background task runner worker.
+* **`bun start:queue`**: Launches the Redis-backed queue listener and background job worker.
+* **`bun start:socket`**: Launches the real-time Socket.io server gateway.
+
+---
+
+## Pre-installed Dependencies
+
+The following key dependencies are packaged and managed within this project:
+
+| Dependency | Scope | Version |
+| :--- | :--- | :--- |
+| `@skalfa/skalfa-api-core` | runtime | `^1.0.2` |
+| `@skalfa/skalfa-orm` | runtime | `^1.0.0` |
+| `bcrypt` | runtime | `^6.0.0` |
+| `dotenv` | runtime | `^17.2.2` |
+| `elysia` | runtime | `^1.2.0` |
+| `knex` | runtime | `^3.1.0` |
+| `pg` | runtime | `^8.16.3` |
+| `nodemailer` | runtime | `^7.0.9` |
+| `tsconfig-paths` | runtime | `^4.2.0` |
+| `validator` | runtime | `^13.15.15` |
+| `commander` | runtime | `^12.1.0` |
+| `eslint` | development | `^10.0.0` |
+
+---
+
+## License
+
+This package is licensed under the **MIT License**. For full license text, see the [LICENSE](LICENSE) file.

package/app/app.ts

@@ -1,74 +1,74 @@
-import os from 'os'
-import { Elysia } from 'elysia'
-import { controller, db, logger, middleware, storage, registry } from "@utils"
-import { routes } from '@routes'
-
-
-// =====================================>
-// ## Init: middleware & router app
-// =====================================>
-export const app  =  new Elysia()
-  .use(middleware.AccessLog)
-  .use(middleware.Cors)
-  .use(middleware.Auth)
-  .use(middleware.BodyParse)
-  .use(controller)
-  .use(storage)
-  .use(routes)
-  .use(middleware.ErrorHandler)
-
-
-// =====================================>
-// ## Init: database
-// =====================================>
-if (process.env.DB_HOST && process.env.DB_PORT && process.env.DB_USERNAME && process.env.DB_PASSWORD && process.env.DB_DATABASE) {
-  db.schema
-  logger.start(`Database connected ${process.env.DB_DATABASE}!`)
-}
-
-
-// =====================================>
-// ## Init: database olap
-// =====================================>
-// if (process.env.DA_HOST && process.env.DA_PORT && process.env.DA_USERNAME && process.env.DA_PASSWORD && process.env.DA_DATABASE) {
-//   daClient.ping();
-//   logger.start(`Database (OLAP) connected ${process.env.DA_DATABASE}!`)
-// }
-
-
-// =====================================>
-// ## Init: redis
-// =====================================>
-// if (process.env.REDIS_HOST && process.env.REDIS_PORT) {
-//   redis.on("connect", () => {
-//     logger.start(`Redis connected ${process.env.REDIS_HOST}:${process.env.REDIS_PORT}!`)
-//   })
-// 
-//   redis.on("error", (err) => {
-//     const em = err instanceof Error ? err.message : String(err)
-//     logger.error(`Redis error: ${em}`, { error: em })
-//   })
-// }
-
-
-
-
-
-// =====================================>
-// ## Init: running server
-// =====================================>
-function getLocalIP() {
-  const interfaces = os.networkInterfaces()
-  for (const name of Object.keys(interfaces)) {
-    for (const net of interfaces[name] || []) {
-      if (net.family === 'IPv4' && !net.internal) return net.address
-    }
-  }
-}
-
-app.listen({ port: process.env.APP_PORT, hostname: '0.0.0.0' })
-setTimeout(() => logger.start(`Server is running at \n        [LOCAL]    http://localhost:${process.env.APP_PORT || 4000} \n        [NETWORK]  http://${getLocalIP()}:${process.env.APP_PORT || 4000}!`), 200)
-
-
-
-
+import os from 'os'
+import { Elysia } from 'elysia'
+import { controller, db, logger, middleware, storage, registry } from "@utils"
+import { routes } from '@routes'
+
+
+// =====================================>
+// ## Init: middleware & router app
+// =====================================>
+export const app  =  new Elysia()
+  .use(middleware.AccessLog)
+  .use(middleware.Cors)
+  .use(middleware.Auth)
+  .use(middleware.BodyParse)
+  .use(controller)
+  .use(storage)
+  .use(routes)
+  .use(middleware.ErrorHandler)
+
+
+// =====================================>
+// ## Init: database
+// =====================================>
+if (process.env.DB_HOST && process.env.DB_PORT && process.env.DB_USERNAME && process.env.DB_PASSWORD && process.env.DB_DATABASE) {
+  db.schema
+  logger.start(`Database connected ${process.env.DB_DATABASE}!`)
+}
+
+
+// =====================================>
+// ## Init: database olap
+// =====================================>
+// if (process.env.DA_HOST && process.env.DA_PORT && process.env.DA_USERNAME && process.env.DA_PASSWORD && process.env.DA_DATABASE) {
+//   daClient.ping();
+//   logger.start(`Database (OLAP) connected ${process.env.DA_DATABASE}!`)
+// }
+
+
+// =====================================>
+// ## Init: redis
+// =====================================>
+// if (process.env.REDIS_HOST && process.env.REDIS_PORT) {
+//   redis.on("connect", () => {
+//     logger.start(`Redis connected ${process.env.REDIS_HOST}:${process.env.REDIS_PORT}!`)
+//   })
+// 
+//   redis.on("error", (err) => {
+//     const em = err instanceof Error ? err.message : String(err)
+//     logger.error(`Redis error: ${em}`, { error: em })
+//   })
+// }
+
+
+
+
+
+// =====================================>
+// ## Init: running server
+// =====================================>
+function getLocalIP() {
+  const interfaces = os.networkInterfaces()
+  for (const name of Object.keys(interfaces)) {
+    for (const net of interfaces[name] || []) {
+      if (net.family === 'IPv4' && !net.internal) return net.address
+    }
+  }
+}
+
+app.listen({ port: process.env.APP_PORT, hostname: '0.0.0.0' })
+setTimeout(() => logger.start(`Server is running at \n        [LOCAL]    http://localhost:${process.env.APP_PORT || 4000} \n        [NETWORK]  http://${getLocalIP()}:${process.env.APP_PORT || 4000}!`), 200)
+
+
+
+

package/app/controllers/base.controller.ts

@@ -1,17 +1,17 @@
-import { permission } from "@utils";
-
-export class BaseController {
-    static async index() {
-        return {
-            message: `Welcome to the API of ${process.env.APP_NAME}!`,
-        };
-    }
-
-    static async feature() {
-        return permission.getFeatures()
-    }
-
-    static async access() {
-        return permission.getAccesses()
-    }
+import { permission } from "@utils";
+
+export class BaseController {
+    static async index() {
+        return {
+            message: `Welcome to the API of ${process.env.APP_NAME}!`,
+        };
+    }
+
+    static async feature() {
+        return permission.getFeatures()
+    }
+
+    static async access() {
+        return permission.getAccesses()
+    }
 }