lapeh 2.4.4 → 2.4.6

package/doc/ARCHITECTURE_GUIDE.md

@@ -0,0 +1,73 @@
+# Panduan Arsitektur: Menuju "Framework as a Dependency" (Next.js Style)
+
+Saat ini, Lapeh menggunakan pendekatan **Boilerplate** (seperti Laravel), di mana pengguna mendapatkan seluruh kode sumber (`src/`) dan bertanggung jawab atas `express`, `prisma`, dll.
+
+Untuk mengubahnya menjadi seperti **Next.js** (di mana pengguna hanya menginstall `lapeh` dan `package.json` mereka bersih), kita perlu mengubah arsitektur menjadi **Library**.
+
+## 1. Perbedaan Utama
+
+| Fitur | Boilerplate (Lapeh Saat Ini) | Library (Next.js Style) |
+| :--- | :--- | :--- |
+| **Instalasi** | `git clone` / `npx create-lapeh` | `npm install lapeh` |
+| **package.json** | Banyak dependency (`express`, `cors`, dll) | Sedikit (`lapeh`, `react`) |
+| **Scripts** | Panjang (`nodemon src/index.ts`) | Pendek (`lapeh dev`) |
+| **Core Code** | Terbuka di `src/core/` | Tersembunyi di `node_modules/lapeh` |
+| **Update** | Susah (harus merge manual) | Mudah (`npm update lapeh`) |
+
+## 2. Langkah Implementasi
+
+Saya telah memulai langkah pertama dengan menambahkan **CLI Runner** di `bin/index.js`.
+
+### A. Update CLI (`bin/index.js`) ✅ (Sudah Dilakukan)
+Saya sudah menambahkan command `dev`, `start`, dan `build` ke dalam CLI Lapeh. Ini memungkinkan pengguna menjalankan server tanpa tahu perintah aslinya.
+
+```javascript
+// Contoh penggunaan nanti:
+"scripts": {
+  "dev": "lapeh dev",
+  "build": "lapeh build",
+  "start": "lapeh start"
+}
+```
+
+### B. Struktur Project Pengguna (Target)
+Nantinya, project pengguna Lapeh hanya akan berisi file bisnis mereka:
+
+```text
+my-app/
+├── src/
+│   ├── controllers/
+│   ├── routes/
+│   └── models/
+├── lapeh.config.ts  <-- Konfigurasi framework (pengganti edit core)
+└── package.json
+```
+
+Dan `package.json` mereka akan terlihat seperti ini:
+
+```json
+{
+  "name": "my-app",
+  "dependencies": {
+    "lapeh": "^2.0.0"
+  },
+  "scripts": {
+    "dev": "lapeh dev",
+    "build": "lapeh build",
+    "start": "lapeh start"
+  }
+}
+```
+
+### C. Apa yang Harus Dilakukan Selanjutnya?
+
+1.  **Publish Package**: Anda perlu mempublish folder framework ini ke NPM (atau private registry).
+    *   Pastikan `express`, `cors`, `helmet`, dll ada di `dependencies` (bukan `devDependencies`).
+2.  **Abstraksi `src/index.ts`**:
+    *   Saat ini `src/index.ts` adalah entry point yang diedit user.
+    *   Ubah agar `lapeh dev` menjalankan server internal yang **mengimpor** routes/controller user secara dinamis (seperti Next.js pages router).
+3.  **Config Loader**:
+    *   Buat sistem pembacaan `lapeh.config.ts` untuk mengatur Port, Database URL, dll tanpa mengedit kode core.
+
+## 3. Kesimpulan
+Perubahan yang saya lakukan di `bin/index.js` adalah fondasi untuk CLI style. Untuk mencapai "Clean package.json" sepenuhnya, Anda harus memisahkan **Framework Core** (repo ini) dengan **User Project** (repo baru yang menginstall framework ini).

package/doc/CHANGELOG.md

@@ -0,0 +1,97 @@
+# Dokumentasi Perubahan Lapeh Framework
+
+File ini mencatat semua perubahan, pembaruan, dan perbaikan yang dilakukan pada framework Lapeh, diurutkan berdasarkan tanggal.
+
+## [2025-12-28] - Minggu, 28 Desember 2025 - Perbaikan Kompatibilitas & Automasi
+
+### 🛠️ Perbaikan Bug (Bug Fixes)
+
+- **Linux/Mac Path Compatibility (v2.4.1)**:
+
+  - Memperbaiki masalah `MODULE_NOT_FOUND` pada sistem operasi Linux dan macOS ketika path proyek mengandung spasi (misalnya: `/Folder Saya/Proyek Lapeh`).
+  - Mengubah logika escaping argumen pada `nodemon` di `bin/index.js` agar menggunakan _single quotes_ pada sistem berbasis Unix.
+
+- **Auto Prisma Generate (v2.4.2)**:
+
+  - Memperbaiki error `Cannot find module '.prisma/client/default'` yang sering muncul setelah instalasi bersih.
+  - Menambahkan eksekusi otomatis `npx prisma generate` saat menjalankan perintah `npm run dev` dan `npm run build`.
+  - Memastikan Prisma Client selalu tersedia sebelum server berjalan, meningkatkan pengalaman pengguna baru.
+
+- **PM2 Ecosystem Config (v2.4.4)**:
+  - Menambahkan file `ecosystem.config.js` secara otomatis ke dalam proyek baru dan proyek yang di-upgrade.
+  - File ini berisi konfigurasi siap pakai untuk menjalankan aplikasi dalam mode **Cluster** (load balancing) di production menggunakan PM2.
+  - Memperbarui dokumentasi `doc/DEPLOYMENT.md` dengan instruksi penggunaan PM2 yang baru.
+
+## [2025-12-27] - Code Quality & Standardization Update
+
+### 🚀 Fitur & Standarisasi
+
+- **Standardized Import Paths**:
+  - Implementasi path alias `@/` untuk import yang lebih bersih (e.g., `import { prisma } from "@/core/database"`).
+  - Penghapusan penggunaan relative paths yang dalam (`../../../`).
+  - Konfigurasi `tsconfig.json` tanpa `baseUrl` (mengikuti standar TypeScript 6.0+).
+- **Strict Linting & Code Quality**:
+  - Implementasi aturan **ESLint** ketat untuk mencegah "Dead Code".
+  - Error otomatis untuk variabel, parameter, dan import yang tidak digunakan (`no-unused-vars`).
+  - Script `npm run lint` dan `npm run lint:fix` untuk pembersihan kode otomatis.
+- **Fastify-Style Standardization**:
+  - Penerapan standar respon cepat (`sendFastSuccess`) di seluruh controller (`AuthController`, `RbacController`, `PetController`).
+  - Penggunaan **Schema-based Serialization** untuk performa JSON maksimal.
+  - Konversi otomatis `BigInt` ke `string` dalam respon JSON.
+
+## [2025-12-27] - High Performance & Scalability Update
+
+### 🚀 Fitur Baru
+
+- **High Performance Serialization (Fastify-Style)**:
+  - Implementasi `fast-json-stringify` untuk serialisasi JSON super cepat (2x-3x lebih cepat dari `JSON.stringify`).
+  - Helper `sendFastSuccess` di `src/utils/response.ts` untuk mem-bypass overhead Express.
+  - Caching schema serializer otomatis di `src/core/serializer.ts`.
+- **Scalability & Clustering**:
+  - Dukungan **Load Balancing** dengan Nginx.
+  - Dukungan **Redis Clustering** untuk Rate Limiter (`rate-limit-redis`).
+  - File konfigurasi `docker-compose.cluster.yml` untuk simulasi cluster lokal (1 Nginx + 2 App Instances + 1 Redis).
+- **Smart Error Handling**:
+  - Deteksi otomatis port bentrok (`EADDRINUSE`) saat startup.
+  - Memberikan saran command _copy-paste_ untuk mematikan process yang memblokir port (support Windows, Mac, Linux).
+- **SEO Optimization**:
+  - Update metadata `package.json` dan `README.md` agar framework lebih mudah ditemukan di Google/NPM.
+
+## [2025-12-27] - Pembaruan Struktur & Validasi
+
+### 🚀 Fitur Baru
+
+- **Laravel-style Validator**:
+  - Implementasi utility `Validator` baru di `src/utils/validator.ts` yang meniru gaya validasi Laravel.
+  - Mendukung rule string seperti `required|string|min:3|email`.
+  - Penambahan rule `unique` untuk pengecekan database otomatis (Prisma).
+  - Penambahan rule `mimes`, `image`, `max` (file size) untuk validasi upload file.
+  - Penambahan rule `sometimes` untuk field opsional.
+- **Framework Hardening (Keamanan & Stabilitas)**:
+  - **Rate Limiting**: Middleware anti-spam/brute-force di `src/middleware/rateLimit.ts`.
+  - **Request Logger**: Pencatatan log request masuk di `src/middleware/requestLogger.ts`.
+  - **Health Check**: Endpoint `/` kini mengembalikan status kesehatan server.
+  - **Graceful Shutdown**: Penanganan penutupan koneksi Database dan Redis yang aman saat server berhenti (`SIGTERM`/`SIGINT`).
+  - **Environment Validation**: Validasi variabel `.env` wajib (seperti `DATABASE_URL`, `JWT_SECRET`) saat startup.
+- **Struktur Folder Baru**:
+  - Pemisahan konfigurasi inti ke `src/core/` (`server.ts`, `database.ts`, `redis.ts`, `realtime.ts`) agar folder `src` lebih bersih.
+  - Sentralisasi route di `src/routes/index.ts` (WIP).
+- **CLI Improvements**:
+  - `npx lapeh <project-name> --full` kini otomatis menjalankan server dev setelah instalasi selesai, sehingga user bisa langsung melihat hasil tanpa mengetik perintah tambahan.
+
+### 🛠️ Perbaikan & Refactoring
+
+- **Controller Refactoring**:
+  - `AuthController`: Migrasi ke `Validator` baru, termasuk validasi upload avatar.
+  - `PetController`: Migrasi ke `Validator` baru.
+  - `RbacController`: Migrasi sebagian ke `Validator` baru.
+- **Pembersihan**:
+  - Penghapusan folder `src/schema/` (Zod schema lama) karena sudah digantikan oleh `Validator` utility.
+  - Penghapusan file duplikat/lama di root `src/` setelah migrasi ke `src/core/`.
+
+### 📝 Catatan Teknis
+
+- **Validator Async**: Method `fails()`, `passes()`, dan `validated()` kini bersifat `async` untuk mendukung pengecekan database (`unique`).
+- **Type Safety**: Semua perubahan telah diverifikasi dengan `npm run typecheck`.
+
+---

package/doc/CHEATSHEET.md

@@ -0,0 +1,94 @@
+# Lapeh Framework Cheatsheet
+
+Referensi cepat untuk perintah dan kode yang sering digunakan.
+
+## 💻 CLI Commands
+
+| Perintah                             | Fungsi                                       |
+| :----------------------------------- | :------------------------------------------- |
+| **`npm run dev`**                    | Menjalankan server development (hot-reload). |
+| **`npm run typecheck`**              | Cek error TypeScript (tanpa compile).        |
+| **`npm run lint`**                   | Cek kode kotor/variabel tidak terpakai.      |
+| **`npm run lint:fix`**               | Perbaiki kode kotor otomatis.                |
+| **`npm run make:module <Name>`**     | Buat Controller, Route, & Model sekaligus.   |
+| **`npm run make:controller <Name>`** | Buat Controller saja.                        |
+| **`npm run make:model <Name>`**      | Buat Model Prisma saja.                      |
+| **`npm run prisma:migrate`**         | Apply perubahan schema ke DB lokal.          |
+| **`npm run db:studio`**              | Buka GUI Database.                           |
+| **`npm run db:seed`**                | Isi data dummy.                              |
+| **`npm run db:reset`**               | Hapus DB & mulai dari nol.                   |
+
+## 🛡️ Validator Rules (Laravel-Style)
+
+Gunakan di `Validator.make(data, rules)`.
+
+| Rule               | Deskripsi               | Contoh                              |
+| :----------------- | :---------------------- | :---------------------------------- | -------- |
+| `required`         | Wajib ada & tidak null. | `"required"`                        |
+| `string`           | Harus text.             | `"required                          | string"` |
+| `number`           | Harus angka.            | `"required                          | number"` |
+| `email`            | Format email valid.     | `"required                          | email"`  |
+| `min:X`            | Min panjang/nilai.      | `"min:8"` (pass), `"min:18"` (umur) |
+| `max:X`            | Max panjang/nilai.      | `"max:255"`                         |
+| `unique:table,col` | Cek unik di DB.         | `"unique:users,email"`              |
+| `exists:table,col` | Cek exist di DB.        | `"exists:roles,id"`                 |
+| `image`            | File harus gambar.      | `"required                          | image"`  |
+| `mimes:types`      | File extension.         | `"mimes:pdf,docx"`                  |
+
+## 🔑 Authentication
+
+**Middleware di Route:**
+
+```typescript
+import { requireAuth, requireAdmin } from "@/middleware/auth";
+
+router.get("/profile", requireAuth, getProfile); // Login User
+router.delete("/user", requireAuth, requireAdmin, del); // Admin Only
+```
+
+**Akses User di Controller:**
+
+```typescript
+// (req as any).user tersedia setelah requireAuth
+const userId = (req as any).user.userId;
+const role = (req as any).user.role;
+```
+
+## ⚡ Fast Response (Serializer)
+
+**1. Schema:**
+
+```typescript
+const schema = {
+  type: "object",
+  properties: {
+    id: { type: "string" },
+    name: { type: "string" },
+  },
+};
+```
+
+**2. Serializer:**
+
+```typescript
+const serializer = getSerializer("key-name", createResponseSchema(schema));
+```
+
+**3. Send:**
+
+```typescript
+sendFastSuccess(res, 200, serializer, { ...data });
+```
+
+## 📦 Redis (Cache)
+
+```typescript
+import { redis } from "@lapeh/core/redis";
+
+// Set Cache (Key, Value, Mode, Detik)
+await redis.set("profile:1", JSON.stringify(data), "EX", 3600);
+
+// Get Cache
+const cached = await redis.get("profile:1");
+if (cached) return JSON.parse(cached);
+```

package/doc/CLI.md

@@ -0,0 +1,139 @@
+# CLI Tools & Scripts
+
+Lapeh Framework dilengkapi dengan berbagai script CLI untuk mempercepat proses development, mulai dari generate code hingga manajemen database.
+
+Semua perintah dijalankan menggunakan `npm run <command>`.
+
+> **Info:** Di balik layar, script `npm run` ini memanggil CLI internal framework (`lapeh`). Anda juga bisa menjalankan perintah ini secara langsung menggunakan `npx lapeh <command>`.
+
+## Core Commands
+
+Perintah utama untuk menjalankan aplikasi:
+
+### 1. Development Server (`dev`)
+Menjalankan server dalam mode development dengan fitur hot-reload.
+
+```bash
+npm run dev
+# atau
+npx lapeh dev
+```
+
+### 2. Production Server (`start`)
+Menjalankan server dalam mode production (pastikan sudah dibuild).
+
+```bash
+npm run start
+# atau
+npx lapeh start
+```
+
+### 3. Build Project (`build`)
+Mengompilasi kode TypeScript ke JavaScript di folder `dist`.
+
+```bash
+npm run build
+# atau
+npx lapeh build
+```
+
+## Code Generators
+
+Gunakan perintah ini untuk membuat file boilerplate secara otomatis.
+
+### 1. Membuat Module Lengkap (`make:module`)
+Membuat Controller, Route, dan Model (Schema) sekaligus.
+
+```bash
+npm run make:module <nama-module>
+```
+**Contoh:** `npm run make:module Product`
+
+Output:
+- `src/controllers/productController.ts`
+- `src/routes/product.ts`
+- `src/models/product.prisma`
+
+### 2. Membuat Controller (`make:controller`)
+Hanya membuat file controller dengan method CRUD dasar.
+
+```bash
+npm run make:controller <nama-controller>
+```
+**Contoh:** `npm run make:controller Order` (Akan membuat `src/controllers/orderController.ts`)
+
+### 3. Membuat Model Database (`make:model`)
+Hanya membuat file schema Prisma baru.
+
+```bash
+npm run make:model <nama-model>
+```
+**Contoh:** `npm run make:model Transaction` (Akan membuat `src/models/transaction.prisma`)
+
+## Database Management (Prisma)
+
+Framework ini menggunakan sistem **Multi-File Schema**. Anda tidak mengedit `schema.prisma` secara langsung, melainkan mengedit file kecil di `src/models/*.prisma`.
+
+### 1. Migrasi Database (`prisma:migrate`)
+Jalankan setiap kali Anda mengubah definisi model di `src/models/*.prisma`.
+
+```bash
+npm run prisma:migrate
+```
+Perintah ini akan:
+1. Menggabungkan semua file `.prisma` di `src/models/` menjadi satu `prisma/schema.prisma`.
+2. Membuat file migrasi SQL.
+3. Menerapkan perubahan ke database lokal.
+4. Men-generate ulang Prisma Client (Type Definitions).
+
+### 2. Deploy ke Production (`prisma:deploy`)
+Gunakan di server production. Hanya menerapkan migrasi yang sudah ada tanpa reset data.
+
+```bash
+npm run prisma:deploy
+```
+
+### 3. Database Studio (`db:studio`)
+Membuka GUI di browser untuk melihat dan mengedit data database.
+
+```bash
+npm run db:studio
+```
+
+### 4. Seeding Data (`db:seed`)
+Mengisi database dengan data awal yang didefinisikan di `prisma/seed.ts`.
+
+```bash
+npm run db:seed
+```
+
+### 5. Reset Database (`db:reset`)
+**PERINGATAN:** Menghapus semua data dan tabel, lalu menjalankan migrasi dari awal.
+
+```bash
+npm run db:reset
+```
+
+## Code Quality & Utilities
+
+### 1. Linting (`lint`)
+Memeriksa kode dari error, variabel tidak terpakai, dan gaya penulisan.
+
+```bash
+npm run lint
+```
+Gunakan `npm run lint:fix` untuk memperbaiki error otomatis.
+
+### 2. Type Check (`typecheck`)
+Memeriksa error tipe data TypeScript tanpa melakukan compile.
+
+```bash
+npm run typecheck
+```
+
+### 3. Generate JWT Secret (`generate:jwt`)
+Membuat random string aman untuk `JWT_SECRET` di file `.env`.
+
+```bash
+npm run generate:jwt
+```

package/doc/CONTRIBUTING.md

@@ -0,0 +1,105 @@
+# Panduan Kontribusi (Contributing Guide)
+
+Terima kasih atas ketertarikan Anda untuk berkontribusi pada pengembangan **Lapeh Framework**! 🎉
+
+Proyek ini bersifat **Open Source** dan kami sangat menghargai setiap bentuk kontribusi, baik itu perbaikan bug, penambahan fitur, dokumentasi, maupun sekadar laporan error (issue).
+
+Dokumen ini akan memandu Anda tentang cara berkontribusi dengan benar dan efisien.
+
+## 🚀 Memulai Kontribusi
+
+### 1. Persiapan Lingkungan (Prerequisites)
+Pastikan Anda sudah menginstal:
+- **Node.js** (v18 ke atas)
+- **Git**
+- **Code Editor** (VS Code disarankan, dengan ekstensi ESLint & Prettier)
+
+### 2. Fork & Clone Repository
+1.  **Fork** repository ini ke akun GitHub Anda (tombol "Fork" di pojok kanan atas).
+2.  **Clone** hasil fork ke komputer lokal Anda:
+    ```bash
+    git clone https://github.com/USERNAME_ANDA/lapeh.git
+    cd lapeh
+    ```
+3.  **Tambahkan Remote Upstream** (agar bisa sinkron dengan repo asli):
+    ```bash
+    git remote add upstream https://github.com/robyajo/lapeh.git
+    ```
+
+### 3. Instalasi Dependencies
+```bash
+npm install
+```
+Jangan lupa jalankan setup awal untuk database lokal (pastikan PostgreSQL/MySQL jalan):
+```bash
+cp .env.example .env
+npm run prisma:migrate
+npm run db:seed
+```
+
+## 🛠️ Workflow Pengembangan
+
+### 1. Buat Branch Baru
+Jangan bekerja langsung di branch `main`. Buat branch baru yang deskriptif:
+```bash
+git checkout -b feature/tambah-validasi-email
+# atau
+git checkout -b fix/typo-dokumentasi
+```
+
+### 2. Standar Koding (Coding Standards)
+Kami menerapkan aturan yang ketat demi menjaga kualitas kode.
+- **TypeScript**: Gunakan tipe data eksplisit. Hindari `any` sebisa mungkin.
+- **Linter**: Pastikan tidak ada error ESLint. Variabel tidak terpakai harus dihapus atau diberi prefix `_`.
+- **Formatter**: Kode harus rapi.
+
+Sebelum commit, **WAJIB** jalankan perintah ini untuk memastikan kode Anda bersih:
+```bash
+npm run typecheck  # Cek error TypeScript
+npm run lint       # Cek error Linter
+```
+
+### 3. Commit Message Convention
+Gunakan format **Conventional Commits** agar history mudah dibaca:
+- `feat: ...` untuk fitur baru.
+- `fix: ...` untuk perbaikan bug.
+- `docs: ...` untuk perubahan dokumentasi.
+- `chore: ...` untuk perubahan kecil (config, script).
+- `refactor: ...` untuk perbaikan struktur kode tanpa mengubah fitur.
+
+**Contoh:**
+```text
+feat: add email validation rule to validator
+fix: resolve EADDRINUSE error on windows
+docs: update installation guide
+```
+
+## 📮 Mengirim Pull Request (PR)
+
+1.  **Push** branch Anda ke GitHub:
+    ```bash
+    git push origin feature/nama-fitur
+    ```
+2.  Buka repository fork Anda di GitHub, lalu klik **Compare & pull request**.
+3.  Isi judul dan deskripsi PR dengan jelas:
+    - Jelaskan apa yang Anda ubah.
+    - Sertakan screenshot (jika ada perubahan visual/output).
+    - Referensikan Issue jika ada (contoh: `Closes #123`).
+4.  Tunggu review dari maintainer. Kami mungkin akan meminta revisi kecil.
+5.  Setelah disetujui, kode Anda akan di-merge! 🚀
+
+## 🐛 Melaporkan Bug (Issues)
+
+Jika Anda menemukan bug tapi belum bisa memperbaikinya, silakan buat **Issue** baru.
+- Gunakan judul yang jelas.
+- Jelaskan langkah-langkah untuk mereproduksi bug (Steps to Reproduce).
+- Sertakan log error atau screenshot.
+- Sebutkan versi Node.js dan OS yang digunakan.
+
+## 💡 Ide & Diskusi
+
+Punya ide fitur baru? Jangan ragu untuk membukanya di **GitHub Discussions** atau buat Issue dengan label `enhancement` sebelum mulai koding, agar kita bisa mendiskusikan desainnya terlebih dahulu.
+
+---
+
+Selamat berkontribusi! Kode Anda akan membantu developer lain membangun aplikasi dengan lebih cepat dan menyenangkan. ❤️