@skalfa/skalfa-api-core 1.0.2

package/src/commands/stubs/index.ts

@@ -0,0 +1,289 @@
+export const basicControllerStub = `import type { ControllerContext } from "elysia"
+
+export class {{ name }} {
+    // ========================================>
+    // ## Display a listing of the resource.
+    // ========================================>
+    static async index(c: ControllerContext) {
+        // something amazing
+    }
+
+
+    // =============================================>
+    // ## Store a newly created resource.
+    // =============================================>
+    static async store(c: ControllerContext) {
+        // something amazing
+    }
+
+
+    // ============================================>
+    // ## Update the specified resource.
+    // ============================================>
+    static async update(c: ControllerContext) {
+        // something amazing
+    }
+
+
+    // ===============================================>
+    // ## Remove the specified resource.
+    // ===============================================>
+    static async destroy(c: ControllerContext) {
+        // something amazing
+    }
+}`;
+
+export const basicMigrationStub = `import type { Knex } from "knex"
+
+export async function up(knex: Knex): Promise<void> {
+  await knex.schema.createTable("{{ tableName }}", (table) => {
+    table.bigIncrements('id').primary()
+    // your table schema
+    table.timestamps(true, true)
+    table.softDelete()
+  })
+}`;
+
+export const basicModelStub = `import { Model } from '@utils'
+
+export class {{ name }} extends Model {
+    // something amazing
+}`;
+
+export const basicSeederStub = `import { {{ model }} } from "@models";
+
+export default async function {{ name }}() {
+    // =========================>
+    // ## Seed the application's database
+    // =========================>
+    
+    await {{ model }}.query().insert([]);
+}
+`;
+
+export const blueprintStub = `[
+    {
+        "model"   :  "",
+        "schema"  :  {},
+        "relations": {},
+        "controllers": {},
+        "migrations"  :  true,
+        "seeders"      :  [],
+        "documentation": true
+    }
+]`;
+
+export const daMigrationStub = `import { DAMigration } from "@utils"
+
+export default class {{ className }} extends DAMigration {
+  async up() { 
+    await this.createTable("{{ tableName }}",(table) => {
+      table.uuid()
+    }, {
+      engine: "MergeTree",
+    })
+  }
+}
+`;
+
+export const lightControllerStub = `{{ marker }}
+import type { ControllerContext } from "elysia"
+import { permission } from '@utils'
+import { {{ model }} } from '@models'
+
+
+
+// ========================================>
+// ## Permission of the resource.
+// ========================================>
+const p = permission.register({
+    "{{ permission_code }}": {
+        name: "{{ permission_name }}",
+        accesses: {
+            "00": "Melihat",
+            "01": "Membuat",
+            "02": "Mengubah",
+            "03": "Menghapus",
+        }
+    }
+})
+
+
+
+export class {{ name }} {
+    // ========================================>
+    // ## Display a listing of the resource.
+    // ========================================>
+    static async index(c: ControllerContext) {
+        p.have("{{ permission_code }}.00").guard(c)
+
+        const { data, total } = await {{ model }}.query().resolve(c)
+        
+        c.responseData(data, total)
+    }
+
+
+    // =============================================>
+    // ## Store a newly created resource.
+    // =============================================>
+    static async store(c: ControllerContext) {
+        p.have("{{ permission_code }}.01").guard(c)
+
+        c.validation<{{ model }}>({{{ validations }}})
+
+        let record = {}
+
+        try {
+            record = await (new {{ model }}).pump(c.payload)            
+        } catch (err) {
+            c.responseError(err as Error, "Create {{ model }}")
+        }
+
+        c.responseSaved(record)
+    }
+
+
+    // ============================================>
+    // ## Update the specified resource.
+    // ============================================>
+    static async update(c: ControllerContext) {
+        p.have("{{ permission_code }}.02").guard(c)
+
+        const record = await {{ model }}.query().findOrNotFound(c.params.id)
+
+        c.validation<{{ model }}>({{{ validations }}})
+
+        try {
+            await record.pump(c.payload)
+        } catch (err) {
+            c.responseError(err as Error, "Update {{ model }}")
+        }
+        
+        c.responseSaved(record)
+    }
+
+
+    // ===============================================>
+    // ## Remove the specified resource.
+    // ===============================================>
+    static async destroy(c: ControllerContext) {
+        p.have("{{ permission_code }}.03").guard(c)
+
+        const record = await {{ model }}.query().findOrNotFound(c.params.id)
+        
+        try {
+            await record.delete()
+        } catch (err) {
+            c.responseError(err as Error, "Delete {{ model }}")
+        }
+
+        c.responseSuccess(record)
+    }
+}
+`;
+
+export const lightMigrationStub = `{{ marker }}
+import type { Knex } from "knex"
+
+export async function up(knex: Knex): Promise<void> {
+  await knex.schema.createTable("{{ tableName }}", (table) => {
+    table.bigIncrements('id').primary()
+{{ schemas }}
+    table.timestamps(true, true)
+    table.softDelete()
+  })
+
+{{ pivot }}
+}`;
+
+export const lightModelStub = `{{ marker }}
+import { Model, SoftDelete{{ import_utils }} } from '@utils'
+{{ import }}
+
+export class {{ name }} extends Model {
+    // =====================>
+    // ## Field
+    // =====================>
+{{ fields }}
+
+    @SoftDelete()
+    deleted_at!: Date
+
+
+    // =========================>
+    // ## Relations
+    // =========================>
+{{ relations }}
+
+
+    // =====================>
+    // ## Attribute
+    // =====================>
+{{ attributes }}
+
+
+    // =====================>
+    // ## Hook
+    // =====================>
+
+}
+`;
+
+export const lightSeederStub = `{{ marker }}
+import { {{ model }} } from "@models";
+
+export default async function {{ name }}Seeder() {
+    // =========================>
+    // ## Seed the application's database
+    // =========================>
+    
+    await (new {{ model }}).pump([
+      {{ seeders }}
+    ]);
+}
+`;
+
+export const mailStub = `import { renderMailTemplate, sendMail } from "@utils"
+
+export async function {{ name }}Mail(to: string) {
+  const content = renderMailTemplate("{{ name }}", {
+      title: "{{ title }}",
+  })
+
+  const send = await sendMail({
+      subject: "{{ title }}",
+      to: to,
+      content: content
+  })
+  
+  return send;
+}
+`;
+
+export const notificationStub = `import { queue } from "@utils";
+
+export async function {{ name }}Notification(payload: Record<string,any>) {
+  await queue.add('notification', { payload })
+}
+`;
+
+export const queueStub = `import { queue } from '@utils'
+
+export const {{ name }}QueueWorker = () => {
+  queue.worker("{{ worker_name }}", async (payload) => {
+    
+  })
+}
+`;
+
+export const routeStub = `import { Elysia } from 'elysia'
+import { api, middleware } from '@utils'
+import { 
+
+} from '@controllers'
+
+export const {{ name }}Routes = (app: Elysia) => app.group('/{{ path }}', (route) => {
+
+    return route;
+})
+`;

package/src/context/context.ts

@@ -0,0 +1,17 @@
+import { AsyncLocalStorage } from 'node:async_hooks'
+
+export type AppContext = { 
+  user_id?: number,
+}
+
+const storage = new AsyncLocalStorage<AppContext>()
+
+export const context = {
+  run<T>(ctx: AppContext, fn: () => T) {
+    return storage.run(ctx, fn)
+  },
+
+  get<K extends keyof AppContext>(key: K): AppContext[K] {
+    return storage.getStore()?.[key]
+  },
+}

package/src/context/index.ts

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

package/src/controller/controller.ts

@@ -0,0 +1,240 @@
+import fs from "fs";
+import path from "path";
+import "elysia";
+import { Elysia, Context } from "elysia";
+import { validate, logger, KeyPermission, ValidationRules, ValidationRule } from "@utils";
+import { db } from "@skalfa/skalfa-orm";
+
+
+
+declare module "elysia" {
+  interface ControllerContext extends Context {
+    getQuery                :  {
+      paginate            :  number;
+      page                :  number;
+      sort                :  string[];
+      filter              :  Record<string, string>;
+      search              :  string;
+      searchable          :  string[];
+      selectable          :  string[];
+      selectableOption    :  string[];
+      expand              :  string[];
+    };
+
+    responseData            :  (
+      data                :  any[],
+      totalRow           ?:  number,
+      message            ?:  string,
+      columns            ?:  string[],
+      access             ?:  string[]
+    ) => { 
+      status                : number; 
+      body                  : any 
+    };
+
+    validation              :  <T extends object>(rules: Partial<Record<keyof T | string, ValidationRule[] | string>>) => any;
+    responseError           :  (error: any, section?: string, message?: string, debug?: boolean) => any;
+    responseErrorValidation :  (errors: Record<string, string[]>) => any;
+    responseSaved           :  (data: any, message?: string) => any;
+    responseSuccess         :  (data: any, message?: string) => any;
+    responseForbidden       :  (message?: string) => any;
+    uploadFile              :  (file: File, folder?: string) => Promise<string>;
+    deleteFile              :  (filePath: string) => void;
+    user                   ?:  any
+    permissions            ?:  KeyPermission[],
+    payload                 :  Record<string, any>
+  }
+}
+
+export type ValidationRulesFor<T> = Partial<
+  Record<keyof T | string, ValidationRule[] | string>
+>
+
+
+export const controller = (app: Elysia) => app.derive(({ query, body, status }) => ({
+
+  // =====================================>
+  // ## Basic fetching data query
+  // =====================================>
+  getQuery: {
+    page              :  query.page              ?   Number(query.page)                                  :    1,
+    paginate          :  query.paginate          ?   Number(query.paginate)                              :    10,
+    search            :  query.search            ?   query.search                                        :    "",
+    sort              :  query.sort              ?   JSON.parse(query.sort)                        :   ["created_at desc"],
+    filter            :  query.filter            ?   JSON.parse(query.filter)                      :    [],
+    searchable        :  query.searchable        ?   JSON.parse(query.searchable)                  :    [],
+    selectable        :  query.selectable        ?   JSON.parse(query.selectable)                  :    [],
+    selectableOption  :  query.selectableOption  ?   JSON.parse(query.selectableOption)            :    [],
+    expand            :  query.expand            ?   JSON.parse(query.expand)                      :    [],
+  },
+
+
+
+  // ===================================>
+  // ## Validation request body
+  // ===================================>
+  validation: async <T extends object>(
+    rules: Partial<Record<keyof T | string, ValidationRules[] | string>>
+  ) => {
+    const result = await validate(
+      body as Record<string, any>,
+      rules as ValidationRules
+    )
+
+    if (!result.valid) {
+      throw status(422, {
+        message: "Error: Unprocessable Entity!",
+        errors: result.errors,
+      })
+    }
+  },
+
+
+
+
+  // ====================================>
+  // ## Response error validation
+  // ====================================>
+  responseErrorValidation: (errors: Record<string, string[]>) => {
+    throw status(422, {
+      message: "Error: Unprocessable Entity!",
+      errors: errors,
+    })
+  },
+
+
+
+  // ====================================>
+  // ## Response error
+  // ====================================>
+  responseError: (error: any, section?: string, message?: string, debug = (process.env.APP_DEBUG || true)) => {
+    logger.error(`Error: ${error}`, { error: error, feature: section })
+
+    if (debug) {
+      throw status(500, {
+        message  :  message ?? "Error: Server Side Having Problem!",
+        error    :  error?.message ?? "unknown",
+        section  :  section ?? "unknown",
+      })
+    }
+
+    throw status(500, {
+      message: message ?? "Error: Server Side Having Problem!"
+    })
+  },
+
+
+  // ====================================>
+  // ## Response Forbidden
+  // ====================================>
+  responseForbidden: (message?: string) => {
+    throw status(403, {
+      message: message ?? "Access Forbidden!"
+    })
+  },
+
+
+  // ====================================> 
+  // ## Response record
+  // ====================================>
+  responseData: (data: any[], totalRow?: number, message?: string) => {
+    throw status(200, {
+      message    :  message ?? (data.length ? "Success" : "Empty data"),
+      data       :  data ?? [],
+      total_row  :  totalRow ?? null,
+    });
+  },
+
+
+
+  // ===================================>
+  // ## Response success
+  // ===================================>
+  responseSuccess: (data: any, message?: string, code?: 200 | 201) => {
+    throw status(code || 200, {
+      message  :  message ?? "Success",
+      data     :  data ?? [],
+    })
+  },
+
+
+
+  // ===================================>
+  // ## Response saved record
+  // ===================================>
+  responseSaved: (data: any, message?: string) => {
+    throw status(201, {
+      message  :  message ?? "Success",
+      data     :  data ?? [],
+    })
+  },
+
+
+
+  // ===================================>
+  // ## Upload file
+  // ===================================>
+  uploadFile: async (file: File, folder = "uploads", options?: { disk?: "public" | "private", owner_id?: number, permissions?: { user_id?: number; role_id?: number }[]}): Promise<string> => {
+    const disk = options?.disk ?? "public"
+
+    const dir = path.resolve("storage", disk, folder);
+    if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
+
+    const fileName = `${Date.now().toString(36)}${Math.random().toString(36).substring(2, 18)}${path.extname(file.name).toLowerCase()}`;
+    const filePath = path.join(dir, fileName);
+
+    const buffer = Buffer.from(await file.arrayBuffer());
+
+    fs.writeFileSync(filePath, buffer);
+
+    const relativePath = `/${folder}/${fileName}`
+
+    if(db && options) {
+      const [storage] = await db("storages").insert({
+        user_id     :  options?.owner_id ?? null,
+        disk        :  disk,
+        path        :  relativePath,
+        filename    :  file.name,
+        filetype    :  file.type,
+        filesize    :  buffer.length,
+        created_at  :  new Date(),
+      }).returning(["id"])
+
+      if (options?.permissions?.length) {
+        const permissions = options.permissions.map(p => ({
+          storage_id  :  storage.id,
+          user_id     :  p.user_id ?? null,
+          role_id     :  p.role_id ?? null,
+          created_at  :  new Date(),
+        }))
+
+        await db("storage_permissions").insert(permissions)
+      }
+    }
+
+
+    return relativePath
+  },
+
+
+
+  // ==================================>
+  // ## Delete File
+  // ==================================>
+  deleteFile: async (filePath: string) => {
+    if (fs.existsSync(filePath)) { 
+      if (db) {
+        const record = await db("storages").where("path", filePath).first()
+        
+        if(record) {
+          await db("storages").where("id", record.id).delete()
+          await db("storage_permissions").where("storage_id", record.id).delete()
+        }
+      }
+
+      fs.unlinkSync(filePath); return true; 
+    }
+  
+    return false;
+  },
+}));

package/src/controller/index.ts

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

package/src/conversion/conversion.ts

@@ -0,0 +1,65 @@
+export const conversion = {
+
+  // =============================>
+  // ## Conversion: String formatter 
+  // =============================>
+  strSnake(value: string, delimiter: string = "_"): string {
+    return toWords(value).join(delimiter)
+  },
+
+  strSlug(value: string, delimiter: string = "-"): string {
+    return toWords(value).join(delimiter);
+  },
+
+  strCamel(value: string, delimiter: string = ""): string {
+    return toWords(value).map((w, i) => i === 0 ? w : w[0].toUpperCase() + w.slice(1)).join(delimiter);
+  },
+
+  strPascal(value: string, delimiter: string = ""): string {
+    return toWords(value).map(w => w[0].toUpperCase() + w.slice(1)).join(delimiter);
+  },
+
+  strPlural(value: string): string {
+    const match = value.match(/^(.*?)([A-Za-z]+)$/)
+    if (!match) return value
+
+    const [, prefix, word] = match
+
+    if (word.endsWith("y") && !/[aeiou]y$/i.test(word)) {
+      return prefix + word.slice(0, -1) + "ies"
+    }
+
+    if (!word.endsWith("s")) return prefix + word + "s"
+
+    return value
+  },
+
+  strSingular(value: string): string {
+    const match = value.match(/^(.*?)([A-Za-z]+)$/)
+    if (!match) return value
+
+    const [, prefix, word] = match
+
+    if (word.endsWith("ies")) {
+      return prefix + word.slice(0, -3) + "y"
+    }
+
+    if (word.endsWith("s") && !word.endsWith("ss")) {
+      return prefix + word.slice(0, -1)
+    }
+
+    return value
+  }
+};
+
+
+
+function toWords(value: string): string[] {
+  return value
+    .replace(/([a-z0-9])([A-Z])/g, "$1 $2")
+    .replace(/[_\-\s]+/g, " ")
+    .trim()
+    .toLowerCase()
+    .split(" ")
+    .filter(Boolean)
+}

package/src/conversion/index.ts

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

package/src/index.ts

@@ -0,0 +1,22 @@
+export * from "./auth";
+export * from "./controller";
+export * from "./conversion";
+export * from "./context";
+export * from "./middleware";
+export * from "./permission";
+export * from "./route";
+export * from "./storage";
+export * from "./validation";
+export * from "./mail";
+export * from "./logger";
+export * from "./registry";
+export * from "./commands/cli";
+
+declare module "knex" {
+  namespace Knex {
+    interface CreateTableBuilder {
+      foreignIdFor(tableName: string, column?: string): Knex.ColumnBuilder;
+      softDelete(column?: string): Knex.ColumnBuilder;
+    }
+  }
+}

package/src/logger/index.ts

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