@skalfa/skalfa-api 1.0.0

package/.env.example

@@ -0,0 +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=
+MAIL_FROM_NAME=

package/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - 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)"
+            npm publish --access public
+          else
+            echo "@skalfa/skalfa-api is up to date ($LOCAL_VER)"
+          fi
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,85 @@
+## 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>

package/app/app.ts

@@ -0,0 +1,85 @@
+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: cron
+// =====================================>
+// cron.worker()
+
+
+// =====================================>
+// ## Init: socket
+// =====================================>
+// if (process.env.SOCKET_PORT) {
+//   socket.start(Number(process.env.SOCKET_PORT))
+// }
+
+
+// =====================================>
+// ## 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

@@ -0,0 +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()
+    }
+}

package/app/controllers/iam/auth.controller.ts

@@ -0,0 +1,144 @@
+import { ControllerContext } from "elysia"
+import bcrypt from 'bcrypt';
+import { User } from "app/models"
+import { auth, db } from '@utils';
+import { UserMailToken } from "app/outputs/mails";
+
+export class AuthController {
+    // =============================================>
+    // ## Login with email & password
+    // =============================================>
+    static async login(c: ControllerContext) {
+        await c.validation({
+            email     :  "required",
+            password  :  "required",
+        })
+
+        const { email, password } = c.body as Record<string, any>
+
+        const user = await User.query().where("email", email).whereNotNull("email_verification_at").first();
+        if (!user) return c.responseErrorValidation({email: ["E-mail not found!"]})
+
+        const checkPassword = await bcrypt.compare(password, user.password)
+        if (!checkPassword) return c.responseErrorValidation({password: ["Wrong password!"]})
+        
+        const { token } = await auth.createAccessToken(user.id, c.request)
+
+        c.responseSuccess({ user, token }, "Success")
+    }
+
+
+    // =============================================>
+    // ## Register new account.
+    // =============================================>
+    static async register(c: ControllerContext) {
+        await c.validation({
+            name      :  "required",
+            email     :  "required",
+            password  :  "required",
+        })
+
+        const trx = await db.transaction()
+
+        const { email, password } = c.body as Record<string, any>
+
+        const checkRegisteredUser = await User.query().where("email", email).whereNotNull("email_verification_at").first()
+        if (checkRegisteredUser) c.responseErrorValidation({email: ["Email is registered!"]})
+
+        await User.query().where("email", email).whereNull("email_verification_at").delete();
+        
+        const model = new User().fill(c.body as Record<string, any>)
+
+        model.password = await bcrypt.hash(password, 10)
+
+        try {
+            await model.save()            
+        } catch (err) {
+            await trx.rollback()
+            c.responseError(err as Error, "Create User")
+        }
+
+        const user = model.toJSON()
+
+        const { token } = await auth.createAccessToken(user.id, c.request, false)
+
+        const { token: mailToken } = await auth.createUserMailToken(user.id)
+        
+        await UserMailToken(user, mailToken)
+
+        await trx.commit()
+
+        c.responseSuccess({ user, token }, "Success")
+    }
+
+
+    // =============================================>
+    // ## Verify user mail token.
+    // =============================================>
+    static async verify(c: ControllerContext) {
+        await c.validation({
+            token      :  "required",
+        })
+
+        const { token } = c.body as Record<string, any>
+
+        if (!c.user) {
+            throw c.status(401, {
+                message: "Unauthorized!"
+            })
+        }
+
+        const verify = await auth.verifyUserMailToken(c?.user?.id, String(token));
+        if(!verify)  {
+            c.responseErrorValidation({token: ["Invalid Token!"]})
+        }
+
+        await User.query().where("id", c?.user?.id).update({ email_verification_at: new Date() }) 
+        
+
+        c.responseSuccess({ user: c.user }, "Success")
+    }
+
+
+    // =============================================>
+    // ## Get logged account
+    // =============================================>
+    static async me(c: ControllerContext) {
+        c.responseSuccess(c.user, "Success")
+    }
+
+    // =============================================>
+    // ## Edit logged account
+    // =============================================>
+    static async update(c: ControllerContext) {
+        const model = await User.query().findOrNotFound(c.user.id)
+
+        await c.validation({
+            name   :  "required",
+            email  :  "required",
+        })
+
+        const trx = await db.transaction()
+
+        const body = c.body as Record<string, any>;
+
+        model.fill(body)
+        
+
+        if (body.image && body.image instanceof File) {
+            const imageSource = await c.uploadFile(body.image, 'users');
+            
+            model.fill({image: imageSource});
+        }
+        
+        try {
+            await model.save({ trx })
+        } catch (err) {
+            await trx.rollback()
+            c.responseError(err as Error, "Create User")
+        }
+        
+        await trx.commit()
+        c.responseSaved(model.toJSON())
+    }
+}

package/app/controllers/iam/user.controller.ts

@@ -0,0 +1,93 @@
+import type { ControllerContext } from "elysia"
+import { db, permission, ValidationRules } from '@utils'
+import { User } from "app/models"
+
+export const UserPermission = permission.register({
+  "100": {
+    name: "User Management",
+    accesses: {
+      "01": "View",
+      "02": "create",
+      "03": "update",
+      "04": "delete",
+    }
+  },
+})
+
+export class UserController {
+  // ========================================>
+  // ## Display a listing of the resource.
+  // ========================================>
+  static async index(c: ControllerContext) {    
+    const users = await User.query().resolve(c)
+
+    c.responseData(users.data, users.total)
+  }
+
+  // =============================================>
+  // ## Store a newly created resource.
+  // =============================================>
+  static async store(c: ControllerContext) {
+    
+    c.validation<User>({
+      name  : "required",
+      email : ["required", "email"],
+    })
+
+    const trx = await db.transaction()
+
+    let record = new User();
+    
+    try {
+      record = await record.pump(c.body as Record<string, any>, { trx })            
+    } catch (err) {
+      await trx.rollback()
+      return c.responseError(err as Error, "Create User")
+    }
+
+    await trx.commit()
+
+    c.responseSaved(record)
+  }
+
+
+  // ============================================>
+  // ## Update the specified resource.
+  // ============================================>
+  static async update(c: ControllerContext) {
+    let record = await User.query().findOrNotFound(c.params.id);
+
+    c.validation({
+        name   :  "required",
+        email  :  "required",
+    })
+    
+    const trx = await db.transaction()
+
+    try {
+        record = await record.pump(c.body as Record<string, any>, { trx })
+    } catch (err) {
+        await trx.rollback()
+        return c.responseError(err as Error, "Create User")
+    }
+
+    await trx.commit()
+    c.responseSaved(record)
+  }
+
+
+  // ===============================================>
+  // ## Remove the specified resource.
+  // ===============================================>
+  static async destroy(c: ControllerContext) {
+    let record = await User.query().findOrNotFound(c.params.id)
+    
+    try {
+        record = await record.delete()
+    } catch (err) {
+        c.responseError(err as Error, "Delete User")
+    }
+
+    c.responseSuccess(record)
+  }
+}

package/app/controllers/index.ts

@@ -0,0 +1,7 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+
+export * from "./base.controller";
+export * from "./iam/auth.controller";
+export * from "./iam/user.controller";

package/app/jobs/crons/index.ts

@@ -0,0 +1,9 @@
+import { cron } from "@utils";
+
+
+
+// ============================================>
+// ## List of cron jobs.
+// ============================================>
+// eslint-disable-next-line no-console
+cron.add("1 * * * *", () => console.log('example cron job...'), 'example');

package/app/jobs/crons/worker.cron.ts

@@ -0,0 +1,9 @@
+import { cron, logger } from "@utils";
+import "./index"
+
+
+// ============================================>
+// ## Run of cron job worker.
+// ============================================>
+cron.worker();
+logger.start(`Cron job workers is running!`)

package/app/jobs/queues/access-log.queue.worker.ts

@@ -0,0 +1,32 @@
+import { queue, da, AccessLog } from '@utils'
+
+const ACCESS_LOG_QUEUE        =  process.env.ACCESS_LOG_QUEUE        || "access-log"
+const ACCESS_LOG_TABLE        =  process.env.ACCESS_LOG_TABLE        || 'access_logs'
+const ACCESS_LOG_CONCURRENCY  =  process.env.ACCESS_LOG_CONCURRENCY  || 500
+const ACCESS_LOG_FLUSH        =  process.env.ACCESS_LOG_FLUSH        || 1000
+
+let accessBuffer: AccessLog[] = []
+let lastAccessFlush = Date.now()
+
+export const accessLogQueueWorker = () => {
+  queue.worker(ACCESS_LOG_QUEUE, async (payload) => {
+      accessBuffer.push(payload as AccessLog)
+
+      const now = Date.now()
+
+      if (accessBuffer.length >= Number(ACCESS_LOG_CONCURRENCY) || now - lastAccessFlush >= Number(ACCESS_LOG_FLUSH)) {
+        if (!accessBuffer.length) return
+
+        const batch = accessBuffer
+        accessBuffer = []
+        lastAccessFlush = Date.now()
+
+        await da.insert(ACCESS_LOG_TABLE, {
+          values : batch,
+          format : 'JSONEachRow'
+        })
+      }
+    },
+    { concurrency: 1, interval: 50 }
+  )
+}

package/app/jobs/queues/activity-log.queue.worker.ts

@@ -0,0 +1,32 @@
+import { queue, da } from '@utils'
+
+const ACTIVITY_LOG_QUEUE        =  process.env.ACTIVITY_LOG_QUEUE     ||'activity-log'
+const ACTIVITY_LOG_CONCURRENCY  =  process.env.ACCESS_LOG_CONCURRENCY || 500
+const ACTIVITY_LOG_FLUSH        =  process.env.ACCESS_LOG_FLUS        || 2000
+const ACTIVITY_LOG_DA_TABLE     =  process.env.ACTIVITY_LOG_DA_TABLE  || 'activity_logs'
+
+let buffer: any[]  =  []
+let lastFlush      =  Date.now()
+
+export const activityLogQueueWorker = () => {
+  queue.worker(ACTIVITY_LOG_QUEUE, async (payload) => {
+      buffer.push(payload)
+
+      const now = Date.now()
+      if (buffer.length >= Number(ACTIVITY_LOG_CONCURRENCY) || now - lastFlush >= Number(ACTIVITY_LOG_FLUSH)) {
+        if (!buffer.length) return
+
+        const batch = buffer
+        buffer = []
+        lastFlush = Date.now()
+
+        await da.insert(ACTIVITY_LOG_DA_TABLE, {
+          values : batch,
+          format : 'JSONEachRow'
+        })
+      }
+    },
+    { concurrency: 1, interval: 50 }
+  )
+
+}

package/app/jobs/queues/auth.queue.worker.ts

@@ -0,0 +1,10 @@
+import { auth, queue } from "@utils"
+
+export const activityLogQueueWorker = () => {
+  queue.worker("auth:revalidate-permission", async (payload) => {
+      const userId = payload?.userId
+
+      await auth.revalidateUserPermissions(userId)
+    }
+  )
+}

package/app/jobs/queues/error-log.queue.worker.ts

@@ -0,0 +1,32 @@
+import { queue, da, ErrorLog } from '@utils'
+
+const ERROR_LOG_QUEUE        =  process.env.ERROR_LOG_QUEUE        || "error-log"
+const ACCESS_LOG_TABLE        =  process.env.ACCESS_LOG_TABLE      || 'error_logs'
+const ERROR_LOG_CONCURRENCY  =  process.env.ERROR_LOG_CONCURRENCY  || 10
+const ERROR_LOG_FLUSH        =  process.env.ERROR_LOG_FLUSH        || 200
+
+let errorBuffer: ErrorLog[] = []
+let lastErrorFlush = Date.now()
+
+export const errorLogQueueWorker = () => {
+  queue.worker(ERROR_LOG_QUEUE, async (payload) => {
+      errorBuffer.push(payload as ErrorLog)
+
+      const now = Date.now()
+
+      if (errorBuffer.length >= Number(ERROR_LOG_CONCURRENCY) || now - lastErrorFlush >= Number(ERROR_LOG_FLUSH)) {
+        if (!errorBuffer.length) return
+
+        const batch = errorBuffer
+        errorBuffer = []
+        lastErrorFlush = Date.now()
+
+        await da.insert(ACCESS_LOG_TABLE, {
+          values : batch,
+          format : 'JSONEachRow'
+        })
+      }
+    },
+    { concurrency: 1, interval: 50 }
+  )
+}

package/app/jobs/queues/notification.queue.worker.ts

@@ -0,0 +1,11 @@
+import { queue, notification, NotificationPayload, NotificationCancelPayload } from '@utils'
+
+export const notificationQueueWorker = () => {
+  queue.worker("notifications", async (payload) => {
+      if (payload?.type != "cancel") {
+        notification.send(payload as NotificationPayload)
+      } else {
+        notification.cancel(payload as NotificationCancelPayload)
+      }
+  }, { concurrency: 1, interval: 50 })
+}