lapeh 2.2.2 → 2.2.3

package/doc/CHEATSHEET.md

@@ -0,0 +1,89 @@
+# 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 "@/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,106 @@
+# 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>`.
+
+## 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. ❤️

package/doc/DEPLOYMENT.md

@@ -0,0 +1,122 @@
+# Deployment Guide
+
+Panduan ini akan membantu Anda membawa aplikasi Lapeh dari `localhost` ke Server Production (VPS/Cloud).
+
+## Persiapan Pra-Deploy
+
+Sebelum deploy, pastikan:
+
+1.  **Environment Variables**: Siapkan nilai `.env` untuk production (DB URL asli, JWT Secret yang kuat).
+2.  **Build**: TypeScript harus dikompilasi ke JavaScript.
+
+## Strategi 1: VPS (Ubuntu/Debian) dengan PM2
+
+Ini adalah cara paling umum dan hemat biaya.
+
+### 1. Setup Server
+
+Pastikan Node.js, NPM, dan Database (PostgreSQL/MySQL) sudah terinstall di server.
+
+### 2. Clone & Install
+
+```bash
+git clone https://github.com/username/repo-anda.git
+cd repo-anda
+npm install --production=false # Install devDependencies juga untuk build
+```
+
+### 3. Build Aplikasi
+
+```bash
+npm run build
+```
+
+Ini akan menghasilkan folder `dist/`.
+
+### 4. Setup Database Production
+
+```bash
+# Setup .env dulu
+cp .env.example .env
+nano .env # Isi dengan config production
+
+# Jalankan migrasi (Hanya deploy schema, jangan reset!)
+npm run prisma:deploy
+```
+
+### 5. Jalankan dengan PM2
+
+Gunakan PM2 agar aplikasi jalan di background dan auto-restart jika crash.
+
+```bash
+npm install -g pm2
+npm run start:prod # Atau: pm2 start dist/src/index.js --name "api-lapeh"
+```
+
+### 6. Reverse Proxy (Nginx)
+
+Jangan expose port 4000 langsung. Gunakan Nginx di depannya.
+Config Nginx block:
+
+```nginx
+server {
+    server_name api.domain-anda.com;
+    location / {
+        proxy_pass http://localhost:4000;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        proxy_set_header Host $host;
+        proxy_cache_bypass $http_upgrade;
+    }
+}
+```
+
+## Strategi 2: Docker (Container)
+
+Lapeh sudah menyertakan `Dockerfile` (jika belum, buat sederhana saja).
+
+**Dockerfile Minimal:**
+
+```dockerfile
+FROM node:18-alpine
+
+WORKDIR /app
+
+COPY package*.json ./
+RUN npm install
+
+COPY . .
+RUN npm run build
+
+EXPOSE 4000
+CMD ["npm", "run", "start:prod"]
+```
+
+**Deploy:**
+
+```bash
+docker build -t my-lapeh-app .
+docker run -p 4000:4000 --env-file .env my-lapeh-app
+```
+
+## Strategi 3: PaaS (Railway / Render / Vercel)
+
+Platform seperti Railway.app sangat mudah karena mendeteksi `package.json`.
+
+1.  Push kode ke GitHub.
+2.  Connect repo di Railway/Render.
+3.  Set Environment Variables di dashboard mereka.
+4.  Set **Build Command**: `npm run build`.
+5.  Set **Start Command**: `npm run start:prod`.
+
+**Catatan Khusus Vercel (Serverless):**
+Lapeh didesain sebagai _Long-Running Server_ (Express). Deploy ke Vercel dimungkinkan tapi butuh wrapper serverless (seperti `vercel-express`). Untuk performa terbaik, disarankan menggunakan VPS atau Container (Railway/Fly.io).
+
+## Checklist Keamanan Production
+
+- [ ] `NODE_ENV=production` harus diset.
+- [ ] `JWT_SECRET` harus panjang dan acak.
+- [ ] Database tidak boleh terekspos ke publik (gunakan private network atau firewall).
+- [ ] Rate Limiting aktif (default Lapeh sudah aktif).
+- [ ] Gunakan HTTPS (SSL) via Nginx atau Cloudflare.

package/doc/FAQ.md

@@ -0,0 +1,81 @@
+# Frequently Asked Questions (FAQ)
+
+Kumpulan pertanyaan umum dan solusi untuk masalah yang sering dihadapi.
+
+## Database
+
+### Q: Bagaimana cara mengganti database dari PostgreSQL ke MySQL?
+**A:**
+1. Buka `prisma/base.prisma.template`.
+2. Ubah `provider = "postgresql"` menjadi `provider = "mysql"`.
+3. Di `.env`, ubah `DATABASE_URL` formatnya menjadi format MySQL (`mysql://user:pass@host:3306/db`).
+4. Hapus folder `prisma/migrations` (jika baru mulai) atau siapkan strategi migrasi.
+5. Jalankan `npm run prisma:migrate`.
+
+### Q: Bagaimana cara membuat relasi antar tabel?
+**A:**
+Definisikan relasi di file `.prisma` masing-masing. Karena file akan digabung, Anda bisa mereferensikan model yang ada di file lain.
+**File `user.prisma`:**
+```prisma
+model User {
+  id    Int    @id
+  posts Post[] // Relasi ke Post
+}
+```
+**File `post.prisma`:**
+```prisma
+model Post {
+  id       Int  @id
+  authorId Int
+  author   User @relation(fields: [authorId], references: [id]) // Relasi ke User
+}
+```
+
+## Redis & Caching
+
+### Q: Saya tidak ingin pakai Redis di local, ribet installnya.
+**A:**
+Tenang, Lapeh otomatis mendeteksi jika Redis tidak berjalan dan akan menggunakan **In-Memory Mock** (simulasi Redis di RAM). Aplikasi tetap jalan normal tanpa error. Anda tidak perlu config apa-apa.
+
+### Q: Bagaimana cara clear cache Redis?
+**A:**
+Jika punya akses CLI Redis: `redis-cli FLUSHALL`.
+Atau via kode:
+```typescript
+import { redis } from "@/core/redis";
+await redis.flushall();
+```
+
+## Fitur & Kustomisasi
+
+### Q: Bagaimana cara handle File Upload?
+**A:**
+Gunakan `multer`. Framework sudah menyiapkannya di `src/routes/auth.ts` sebagai contoh (upload avatar).
+Anda bisa copy logic konfigurasi `multer` tersebut ke route lain.
+
+### Q: Bagaimana cara menambah middleware global baru?
+**A:**
+Buka `src/core/server.ts`. Di sana ada bagian `// Global Middlewares`. Tambahkan middleware Express Anda di situ:
+```typescript
+app.use(myCustomMiddleware);
+```
+
+### Q: Saya ingin mengubah port server.
+**A:**
+Cukup ubah variabel `PORT` di file `.env`. Defaultnya adalah `4000`.
+
+## Troubleshooting
+
+### Q: Error `EADDRINUSE: address already in use :::4000`
+**A:**
+Artinya port 4000 sedang dipakai program lain (atau instance Lapeh sebelumnya yang nyangkut).
+**Solusi:**
+1. Matikan terminal.
+2. Jalankan perintah kill (framework biasanya memberi saran commandnya saat error muncul).
+   - Windows: `taskkill /F /IM node.exe` (Hati-hati ini mematikan semua node process).
+   - Atau cari PID nya: `netstat -ano | findstr :4000`.
+
+### Q: Error `Unique constraint failed` saat seeding
+**A:**
+Data yang mau dimasukkan sudah ada (misal email `sa@sa.com`).
+Jalankan `npm run db:reset` untuk menghapus semua data dan mulai dari nol.

package/doc/FEATURES.md

@@ -0,0 +1,165 @@
+# Fitur & Konsep Inti
+
+Dokumen ini menjelaskan fitur-fitur utama Lapeh Framework dan cara penggunaannya secara mendalam.
+
+## 1. Validasi Data (Laravel-Style)
+
+Framework ini menyediakan utility `Validator` yang terinspirasi dari Laravel, menggunakan `zod` di belakang layar namun dengan API yang lebih string-based dan mudah dibaca.
+
+**Lokasi:** `@/utils/validator`
+
+### Penggunaan Dasar
+
+```typescript
+import { Validator } from "@/utils/validator";
+
+export async function createProduct(req: Request, res: Response) {
+  const validator = await Validator.make(req.body, {
+    name: "required|string|min:3",
+    price: "required|number|min:1000",
+    email: "required|email|unique:user,email", // Cek unik di tabel user kolom email
+    category_id: "required|exists:category,id", // Cek exist di tabel category kolom id
+    photo: "required|image|max:2048", // Validasi file upload (Max 2MB)
+  });
+
+  if (validator.fails()) {
+    return sendError(res, 400, "Validation failed", validator.errors());
+  }
+
+  const data = validator.validated();
+  // Lanjut proses simpan...
+}
+```
+
+### Aturan Tersedia (Rules)
+
+- `required`: Wajib diisi.
+- `string`, `number`, `boolean`: Tipe data.
+- `email`: Format email valid.
+- `min:X`, `max:X`: Panjang string atau nilai number.
+- `unique:table,column`: Pastikan nilai belum ada di database (Async).
+- `exists:table,column`: Pastikan nilai ada di database (Async).
+- `image`: File harus berupa gambar (jpg, png, webp, dll).
+- `mimes:types`: File harus tipe tertentu (misal: `mimes:pdf,docx`).
+
+## 2. High Performance Response (Fastify-Style)
+
+Untuk endpoint yang membutuhkan performa tinggi (misalnya list data besar), gunakan serialisasi berbasis schema. Ini jauh lebih cepat daripada `res.json` standar Express.
+
+**Lokasi:** `@/utils/response`, `@/core/serializer`
+
+### Langkah Implementasi
+
+1. **Definisikan Schema Output**
+   Sesuaikan dengan field yang ingin ditampilkan ke user.
+
+   ```typescript
+   const productSchema = {
+     type: "object",
+     properties: {
+       id: { type: "string" }, // BigInt otomatis jadi string
+       name: { type: "string" },
+       price: { type: "number" },
+     },
+   };
+   ```
+
+2. **Buat Serializer (Cached)**
+   Simpan di luar handler function agar dicompile sekali saja.
+
+   ```typescript
+   import { getSerializer, createResponseSchema } from "@/core/serializer";
+
+   const productSerializer = getSerializer(
+     "product-single",
+     createResponseSchema(productSchema)
+   );
+   ```
+
+3. **Kirim Response**
+
+   ```typescript
+   import { sendFastSuccess } from "@/utils/response";
+
+   // Di dalam controller
+   sendFastSuccess(res, 200, productSerializer, {
+     status: "success",
+     message: "Data retrieved",
+     data: productData,
+   });
+   ```
+
+## 3. Authentication & Authorization (RBAC)
+
+Sistem autentikasi menggunakan JWT (JSON Web Token) dan mendukung Role-Based Access Control.
+
+### Middleware Auth
+
+- `requireAuth`: Memastikan user login (mengirim header `Authorization: Bearer <token>`).
+- `requireAdmin`: Memastikan user login DAN memiliki role `admin` atau `super_admin`.
+
+**Contoh di Route:**
+
+```typescript
+import { requireAuth, requireAdmin } from "@/middleware/auth";
+
+router.get("/profile", requireAuth, getProfile); // Login only
+router.delete("/users/:id", requireAuth, requireAdmin, deleteUser); // Admin only
+```
+
+### Helper RBAC (Role Based Access Control)
+
+Anda bisa mengecek permission secara granular di dalam controller:
+
+```typescript
+// (Contoh implementasi, logic ada di AuthController/RbacController)
+if (req.user.role !== "manager") {
+  return sendError(res, 403, "Forbidden");
+}
+```
+
+## 4. Caching & Redis
+
+Framework ini memiliki integrasi Redis "Zero-Config".
+
+- Jika `REDIS_URL` ada di `.env` dan server Redis berjalan, framework akan connect.
+- Jika tidak ada atau gagal connect, framework otomatis fallback ke **In-Memory Mock**. Ini membuat development di local tidak wajib install Redis.
+
+**Mengakses Redis:**
+
+```typescript
+import { redis } from "@/core/redis";
+
+// Set cache (1 jam)
+await redis.set("my-key", "value", "EX", 3600);
+
+// Get cache
+const val = await redis.get("my-key");
+```
+
+## 5. Keamanan (Security)
+
+Secara default, framework sudah menerapkan:
+
+- **Helmet**: Mengamankan HTTP headers.
+- **CORS**: Mengizinkan akses lintas domain (configurable).
+- **Rate Limiting**: Membatasi jumlah request per IP untuk mencegah DDoS/Brute Force.
+  - Konfigurasi ada di `src/middleware/rateLimit.ts`.
+  - Default: 100 request / 15 menit.
+
+## 6. Import Path Aliases
+
+Gunakan `@/` untuk import module agar kode lebih bersih.
+
+- `@/core` -> `src/core`
+- `@/controllers` -> `src/controllers`
+- `@/utils` -> `src/utils`
+- `@/middleware` -> `src/middleware`
+
+**Contoh:**
+
+```typescript
+import { prisma } from "@/core/database"; // ✅ Rapi
+// vs
+import { prisma } from "../../../core/database"; // ❌ Berantakan
+```