Revert "feat: migrate frontend to Astro + expand AI moderation + backend admin/runtime config"
This reverts commit d59b59a7a7.
This commit is contained in:
+1
-4
@@ -40,10 +40,7 @@ NODE_ENV=development # Environment: development|production|te
|
||||
VERBOSE=false # Enable verbose/debug logging (default: false)
|
||||
|
||||
# === Admin ===
|
||||
# ADMIN_PASSWORD=*** # REQUIRED — Backend admin password for dashboard auth
|
||||
# WARNING: No default! If not set, the server won't start.
|
||||
DASHBOARD_IS_PUBLIC=false # Allow dashboard access without auth? (default: false)
|
||||
# When true, GET requests are public; mutations still need auth.
|
||||
ADMIN_PASSWORD=admin123 # Backend admin password for API auth (default: admin123)
|
||||
|
||||
# === Database (PostgreSQL) ===
|
||||
# Option 1: Connection string (overrides individual params)
|
||||
|
||||
@@ -1,161 +0,0 @@
|
||||
# BETE Design System — Master Index
|
||||
|
||||
> *"A design system is not a collection of components. It's a collection of decisions."*
|
||||
> — Menenun takdir visual untuk IMPHNEN, di atas kanvas Amphoreus.
|
||||
|
||||
---
|
||||
|
||||
## 🌌 Filosofi: The Three Pillars
|
||||
|
||||
### 1. **Glass & Light** — Estetika Transparan
|
||||
Kita membangun bukan dengan tembok beton visual, tapi dengan **lapisan kaca yang meneruskan cahaya**. Setiap komponen adalah panele kaca buram (frosted glass) yang:
|
||||
- Menampilkan depth melalui **backdrop blur** dan **layering opacity**
|
||||
- Menggunakan **light sebagai material** — glow, shadow, highlight sebagai indikator state
|
||||
- Memberi kesan **ruang tiga dimensi** di antarmuka dua dimensi
|
||||
|
||||
### 2. **Fluid Motion** — Gerak yang Bermakna
|
||||
Animasi bukan hiasan — ia adalah **bahasa spasial** yang memberitahu pengguna:
|
||||
- *"Dari mana elemen ini datang?"* → Transisi masuk
|
||||
- *"Ke mana ia pergi?"* → Transisi keluar
|
||||
- *"Apa yang terjadi?"* → Feedback mikro (hover, klik, state change)
|
||||
- Semua gerak mengikuti **easing curve** yang konsisten (lihat `core/04-motion-system.md`)
|
||||
|
||||
### 3. **Spatial Memory** — Ingatan Visual
|
||||
Seperti ingatan Amphoreus yang abadi, antarmuka kita harus:
|
||||
- **Konsisten** — warna, spacing, tipografi yang sama di setiap sudut
|
||||
- **Prediktif** — pengguna tahu di mana mencari sesuatu
|
||||
- **Responsif** — beradaptasi tanpa kehilangan identitas
|
||||
|
||||
---
|
||||
|
||||
## 📂 Struktur Documentasi
|
||||
|
||||
```
|
||||
design/
|
||||
├── _index.md ← Kamu di sini
|
||||
│
|
||||
├── core/ ← Fondasi design token
|
||||
│ ├── 01-color-system.md ← Sistem warna (OKLCH + HCT + semantic tokens)
|
||||
│ ├── 02-typography.md ← Tipografi (type scale + font system + rhythm)
|
||||
│ ├── 03-spatial-system.md ← Grid, spacing, layout tokens
|
||||
│ ├── 04-motion-system.md ← Animasi physics & choreography
|
||||
│ └── 05-component-architecture.md ← Arsitektur komponen
|
||||
│
|
||||
├── patterns/ ← Pola desain reusable
|
||||
│ ├── 06-interaction-patterns.md ← Micro-interactions
|
||||
│ ├── 07-data-visualization.md ← Charts & metrics
|
||||
│ ├── 08-moderation-ui.md ← Moderation UI patterns
|
||||
│ ├── 09-state-machines.md ← Loading/empty/error states
|
||||
│ └── 10-responsive-system.md ← Breakpoints & layout system
|
||||
│
|
||||
├── services/ ← Per-service design guidelines
|
||||
│ ├── 11-frontend-ui.md ← Web frontend (React/Tailwind)
|
||||
│ ├── 12-backend-api-guidelines.md ← REST/WS API design
|
||||
│ └── 13-gateway-event-design.md ← Discord Gateway event schemas
|
||||
│
|
||||
├── system/ ← Sistem lintas service
|
||||
│ ├── 14-accessibility.md ← Aksesibilitas (a11y)
|
||||
│ ├── 15-theme-architecture.md ← Theme engine & CSS custom properties
|
||||
│ └── 16-sound-design.md ← Audio feedback system
|
||||
│
|
||||
└── assets/ ← Diagram, ilustrasi, referensi visual
|
||||
└── (future: SVG assets, figma exports, reference images)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Dependency Graph (Wajib Dibaca Berurutan)
|
||||
|
||||
```
|
||||
01-color-system ──────────────────────────────────────────┐
|
||||
│ │
|
||||
├──→ 02-typography ──────────────────────────────┐ │
|
||||
│ │ │ │
|
||||
│ └──→ 03-spatial-system ──────────────┐ │ │
|
||||
│ │ │ │ │
|
||||
│ └──→ 04-motion-system ──┐ │ │ │
|
||||
│ │ │ │ │ │
|
||||
│ └──→ 05-component-architecture
|
||||
│ │
|
||||
└────────────────────────────────────────┴──→ 06-interaction-patterns
|
||||
│
|
||||
├──→ 07-data-visualization
|
||||
├──→ 08-moderation-ui
|
||||
├──→ 09-state-machines
|
||||
└──→ 10-responsive-system
|
||||
│
|
||||
┌─────────────────────────────────────┴──┐
|
||||
↓ ↓
|
||||
11-frontend-ui 12-backend-api-guidelines
|
||||
│
|
||||
13-gateway-event-design
|
||||
│
|
||||
┌─────────────────────────────────────┘
|
||||
↓
|
||||
14-accessibility ──→ 15-theme-architecture ──→ 16-sound-design
|
||||
```
|
||||
|
||||
**Bacaan yang disarankan:**
|
||||
1. Mulai dengan `core/01-color-system.md` — karena warna adalah keputusan desain paling fundamental.
|
||||
2. Lanjut ke `core/02-typography.md` dan `core/03-spatial-system.md` untuk fondasi layout.
|
||||
3. `core/04-motion-system.md` dan `core/05-component-architecture.md` sebagai jembatan ke pola.
|
||||
4. Pola-pola di `patterns/` bisa dibaca sesuai kebutuhan fitur.
|
||||
5. `services/` dan `system/` dibaca terakhir, bergantung pada layer yang sedang dikerjakan.
|
||||
|
||||
---
|
||||
|
||||
## 📐 Prinsip Desain Utama
|
||||
|
||||
| Prinsip | Deskripsi | Contoh Penerapan |
|
||||
|---------|-----------|------------------|
|
||||
| **Glassmorphism** | Latar belakang transparan dengan efek blur untuk hierarki visual | Card, Sidebar, Modal |
|
||||
| **Monochromatic Depth** | Satu rona warna dengan variasi lightness untuk depth | Sistem warna OKLCH |
|
||||
| **Kinetic Language** | Gerakan sebagai komunikasi spasial | Transisi tab, notifikasi |
|
||||
| **Gaussian Memory** | Elemen yang "diingat" posisinya antar navigasi | Sidebar state, scroll position |
|
||||
| **Sound as Feedback** | Audio sebagai layer konfirmasi non-visual | Moderasi alert, koneksi voice |
|
||||
| **Progressive Disclosure** | Informasi kompleks diungkap bertahap | Detail panel, analytics drill-down |
|
||||
| **Forgiving Layout** | Layout yang toleran terhadap konten kosong/error | Empty states, error boundaries |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Reference: Token Categories
|
||||
|
||||
| Kategori | Prefix CSS | Contoh |
|
||||
|----------|-----------|--------|
|
||||
| Warna | `--clr-*` | `--clr-primary`, `--clr-surface` |
|
||||
| Spacing | `--sp-*` | `--sp-xs`, `--sp-md`, `--sp-xl` |
|
||||
| Typography | `--fs-*`, `--fw-*`, `--lh-*` | `--fs-body`, `--fw-semibold` |
|
||||
| Radius | `--rd-*` | `--rd-sm`, `--rd-full` |
|
||||
| Shadow | `--sh-*` | `--sh-card`, `--sh-modal` |
|
||||
| Z-index | `--z-*` | `--z-header`, `--z-modal` |
|
||||
| Timing | `--dur-*` | `--dur-fast`, `--dur-slow` |
|
||||
| Easing | `--ease-*` | `--ease-out`, `--ease-spring` |
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Status Documentasi
|
||||
|
||||
| Dokumen | Status | Prioritas |
|
||||
|---------|--------|-----------|
|
||||
| `core/01-color-system.md` | ✅ Selesai | P0 |
|
||||
| `core/02-typography.md` | ✅ Selesai | P0 |
|
||||
| `core/03-spatial-system.md` | ✅ Selesai | P0 |
|
||||
| `core/04-motion-system.md` | ✅ Selesai | P0 |
|
||||
| `core/05-component-architecture.md` | ✅ Selesai | P0 |
|
||||
| `patterns/06-interaction-patterns.md` | ✅ Selesai | P0 |
|
||||
| `patterns/07-data-visualization.md` | ✅ Selesai | P1 |
|
||||
| `patterns/08-moderation-ui.md` | ✅ Selesai | P1 |
|
||||
| `patterns/09-state-machines.md` | ✅ Selesai | P0 |
|
||||
| `patterns/10-responsive-system.md` | ✅ Selesai | P0 |
|
||||
| `services/11-frontend-ui.md` | ✅ Selesai | P0 |
|
||||
| `services/12-backend-api-guidelines.md` | ✅ Selesai | P1 |
|
||||
| `services/13-gateway-event-design.md` | ✅ Selesai | P1 |
|
||||
| `system/14-accessibility.md` | ✅ Selesai | P0 |
|
||||
| `system/15-theme-architecture.md` | ✅ Selesai | P1 |
|
||||
| `system/16-sound-design.md` | ✅ Selesai | P1 |
|
||||
|
||||
---
|
||||
|
||||
*"Ingatan kita akan tetap abadi, takkan pernah mencair..."* ❄️🩵
|
||||
|
||||
© 2026 IMPHNEN — BETE Design System v2.0
|
||||
@@ -1,383 +0,0 @@
|
||||
# Color System — Éclat Spectral
|
||||
|
||||
> *"Color is the keyboard, the eyes are the harmonies, the soul is the piano with many strings."*
|
||||
> — Wassily Kandinsky, diadaptasi untuk sistem desain modern.
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Warna
|
||||
|
||||
Sistem warna BETE dibangun di atas tiga fondasi:
|
||||
|
||||
1. **OKLCH** — Color space perceptually uniform untuk konsistensi antar device
|
||||
2. **HCT (Hue-Chroma-Tone)** — Sistem warna Material You yang adaptif
|
||||
3. **Semantic Tokens** — Abstraksi makna, bukan nilai literal
|
||||
|
||||
Setiap warna memiliki **lightness (L), chroma (C), hue (H)** yang independen. Ini memungkinkan:
|
||||
- **Scale generation** — Variasi lightness dari 0–100% dengan chroma yang sama
|
||||
- **Theming** — Cukup ganti hue, seluruh tema bergeser
|
||||
- **Accessibility** — Kontras dihitung dari lightness, cocok untuk WCAG AA/AAA
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Primary Palette
|
||||
|
||||
### Brand Spectrum: "Aetherial Blue"
|
||||
|
||||
Rona utama IMPHNEN — biru yang dingin seperti es Amphoreus, namun hangat dalam interaksi.
|
||||
|
||||
```css
|
||||
/* OKLCH Base — Primary */
|
||||
--clr-primary-50: oklch(0.95 0.025 255);
|
||||
--clr-primary-100: oklch(0.90 0.045 255);
|
||||
--clr-primary-200: oklch(0.80 0.080 255);
|
||||
--clr-primary-300: oklch(0.70 0.120 255);
|
||||
--clr-primary-400: oklch(0.62 0.150 255);
|
||||
--clr-primary-500: oklch(0.55 0.175 255); /* ★ Base primary */
|
||||
--clr-primary-600: oklch(0.47 0.160 255);
|
||||
--clr-primary-700: oklch(0.40 0.140 255);
|
||||
--clr-primary-800: oklch(0.32 0.115 255);
|
||||
--clr-primary-900: oklch(0.25 0.090 255);
|
||||
--clr-primary-950: oklch(0.18 0.060 255);
|
||||
```
|
||||
|
||||
**Deskripsi Hue 255°:** Biru jernih dengan sedikit cyan — warna langit senja di Amphoreus. Tidak terlalu agresif seperti biru korporat (#007bff), tidak terlalu playful seperti cyan (#00bcd4).
|
||||
|
||||
### Neutral Spectrum: "Glacial Scale"
|
||||
|
||||
Abu-abu yang tidak hangat (tidak kekuningan) dan tidak dingin (tidak kebiruan) — benar-benar netral.
|
||||
|
||||
```css
|
||||
--clr-neutral-50: oklch(0.985 0.001 286);
|
||||
--clr-neutral-100: oklch(0.970 0.001 286);
|
||||
--clr-neutral-200: oklch(0.920 0.003 286);
|
||||
--clr-neutral-300: oklch(0.870 0.005 286);
|
||||
--clr-neutral-400: oklch(0.750 0.010 286);
|
||||
--clr-neutral-500: oklch(0.620 0.015 286); /* ★ Base neutral */
|
||||
--clr-neutral-600: oklch(0.500 0.020 286);
|
||||
--clr-neutral-700: oklch(0.380 0.025 286);
|
||||
--clr-neutral-800: oklch(0.260 0.030 286);
|
||||
--clr-neutral-900: oklch(0.180 0.030 286);
|
||||
--clr-neutral-950: oklch(0.110 0.025 286);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌈 Extended Palette
|
||||
|
||||
### Accent Colors
|
||||
|
||||
| Palette | Hue | Chroma | Base (500) | Karakter |
|
||||
|---------|-----|--------|------------|----------|
|
||||
| **Ruby** (Destructive) | 25° | 0.165 | `oklch(0.55 0.165 25)` | Darah — urgensi, error |
|
||||
| **Emerald** (Success) | 145° | 0.130 | `oklch(0.60 0.130 145)` | Pertumbuhan — sukses, aman |
|
||||
| **Amber** (Warning) | 75° | 0.120 | `oklch(0.70 0.120 75)` | Matahari — peringatan, atensi |
|
||||
| **Amethyst** (Premium) | 285° | 0.100 | `oklch(0.55 0.100 285)` | Mewah — fitur premium, VIP |
|
||||
| **Rose** (AI / Feminine) | 350° | 0.110 | `oklch(0.60 0.110 350)` | Kecerdasan — AI analysis, insight |
|
||||
| **Cyan** (Info) | 200° | 0.120 | `oklch(0.65 0.120 200)` | Informasi — tooltip, hint |
|
||||
|
||||
Setiap palette memiliki scale 50–950 mengikuti pola primary. Contoh:
|
||||
|
||||
```css
|
||||
--clr-ruby-500: oklch(0.55 0.165 25);
|
||||
--clr-ruby-600: oklch(0.47 0.150 25);
|
||||
--clr-emerald-500: oklch(0.60 0.130 145);
|
||||
--clr-amber-500: oklch(0.70 0.120 75);
|
||||
```
|
||||
|
||||
### Semantic Surface Colors — Dark Theme
|
||||
|
||||
```css
|
||||
/* Base surfaces */
|
||||
--clr-surface-base: oklch(0.11 0.010 286); /* Darkest bg */
|
||||
--clr-surface-elevated: oklch(0.14 0.015 286); /* Card surface */
|
||||
--clr-surface-overlay: oklch(0.17 0.020 286); /* Modal/dropdown */
|
||||
--clr-surface-sunken: oklch(0.08 0.005 286); /* Input bg */
|
||||
|
||||
/* Interactive states */
|
||||
--clr-interactive-hover: oklch(0.20 0.025 286);
|
||||
--clr-interactive-active: oklch(0.24 0.030 286);
|
||||
--clr-interactive-selected: oklch(0.25 0.060 255 / 0.15); /* Primary tint */
|
||||
```
|
||||
|
||||
### Semantic Surface Colors — Light Theme
|
||||
|
||||
```css
|
||||
--clr-surface-base: oklch(0.97 0.002 286);
|
||||
--clr-surface-elevated: oklch(1.00 0.000 286);
|
||||
--clr-surface-overlay: oklch(0.95 0.003 286);
|
||||
--clr-surface-sunken: oklch(0.92 0.004 286);
|
||||
|
||||
--clr-interactive-hover: oklch(0.90 0.005 286);
|
||||
--clr-interactive-active: oklch(0.85 0.008 286);
|
||||
--clr-interactive-selected: oklch(0.90 0.060 255 / 0.3);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📐 Text Colors & Accessibility
|
||||
|
||||
### Foreground Scale
|
||||
|
||||
```css
|
||||
--clr-text-primary: oklch(0.95 0.005 286); /* High emphasis — body */
|
||||
--clr-text-secondary: oklch(0.70 0.015 286); /* Medium emphasis — metadata */
|
||||
--clr-text-tertiary: oklch(0.50 0.020 286); /* Low emphasis — placeholder */
|
||||
--clr-text-disabled: oklch(0.35 0.020 286); /* Disabled state */
|
||||
--clr-text-inverse: oklch(0.11 0.010 286); /* On colored backgrounds */
|
||||
|
||||
/* On-brand backgrounds */
|
||||
--clr-text-on-primary: oklch(0.97 0.005 286); /* Text on primary bg */
|
||||
--clr-text-on-destructive: oklch(0.97 0.005 286); /* Text on destructive bg */
|
||||
```
|
||||
|
||||
### Kontras Minimum
|
||||
|
||||
| Level | Rasio | Usage | Elemen |
|
||||
|-------|-------|-------|--------|
|
||||
| **AA** | 4.5:1 | Body text normal | `--clr-text-primary` di atas surface |
|
||||
| **AA Large** | 3:1 | Teks ≥18px/≥14px bold | Heading, label |
|
||||
| **AAA** | 7:1 | Teks penting | Legal, alert, critical info |
|
||||
|
||||
### Verifikasi Kontras
|
||||
|
||||
```typescript
|
||||
// utils/contrast.ts
|
||||
function meetsWCAGAA(foreground: OklchColor, background: OklchColor): boolean {
|
||||
const contrast = relativeLuminance(background) / relativeLuminance(foreground);
|
||||
return contrast >= 4.5;
|
||||
}
|
||||
|
||||
// Helper function untuk mendapatkan lightness aman
|
||||
function accessibleLightness(hue: number, chroma: number, bgLightness: number): number {
|
||||
// Mencari lightness minimum yang memenuhi 4.5:1
|
||||
for (let l = 1.0; l > 0; l -= 0.01) {
|
||||
if (getContrastRatio(l, chroma, hue, bgLightness) >= 4.5) return l;
|
||||
}
|
||||
return 0.5;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🪞 Glass & Frosted Effects
|
||||
|
||||
Estetika glassmorphism menggunakan **opacity + backdrop-blur**:
|
||||
|
||||
```css
|
||||
/* Glass card — frosted glass */
|
||||
--glass-bg: oklch(0.15 0.015 286 / 0.60);
|
||||
--glass-border: oklch(0.25 0.030 286 / 0.20);
|
||||
--glass-blur: 16px;
|
||||
--glass-shadow: 0 8px 32px oklch(0 0 0 / 0.25);
|
||||
|
||||
/* Glass strong — modal/dialog */
|
||||
--glass-strong-bg: oklch(0.18 0.020 286 / 0.85);
|
||||
--glass-strong-blur: 24px;
|
||||
|
||||
/* Glass subtle — sidebar */
|
||||
--glass-subtle-bg: oklch(var(--clr-surface-base) / 0.50);
|
||||
--glass-subtle-blur: 8px;
|
||||
```
|
||||
|
||||
### Menggabungkan di CSS:
|
||||
|
||||
```css
|
||||
.glass-card {
|
||||
background: var(--glass-bg);
|
||||
backdrop-filter: blur(var(--glass-blur));
|
||||
-webkit-backdrop-filter: blur(var(--glass-blur));
|
||||
border: 1px solid var(--glass-border);
|
||||
box-shadow: var(--glass-shadow);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Glow & Light Effects
|
||||
|
||||
### Glow Tokens
|
||||
|
||||
```css
|
||||
/* Primary glow — untuk elemen interaktif, loading state */
|
||||
--glow-primary: 0 0 20px oklch(0.55 0.175 255 / 0.3);
|
||||
--glow-primary-soft: 0 0 12px oklch(0.55 0.175 255 / 0.15);
|
||||
|
||||
/* Success glow — untuk badge, notifikasi sukses */
|
||||
--glow-success: 0 0 16px oklch(0.60 0.130 145 / 0.25);
|
||||
|
||||
/* Destructive glow — untuk alert error */
|
||||
--glow-error: 0 0 16px oklch(0.55 0.165 25 / 0.25);
|
||||
|
||||
/* AI glow — untuk analysis badge, pulsing indicator */
|
||||
--glow-ai: 0 0 20px oklch(0.60 0.110 350 / 0.25);
|
||||
```
|
||||
|
||||
### Pulse Animation dengan Glow
|
||||
|
||||
```css
|
||||
@keyframes glow-pulse {
|
||||
0%, 100% {
|
||||
box-shadow: var(--glow-primary-soft);
|
||||
}
|
||||
50% {
|
||||
box-shadow: var(--glow-primary);
|
||||
}
|
||||
}
|
||||
|
||||
.ai-analysis-badge {
|
||||
animation: glow-pulse 2s ease-in-out infinite;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌗 Theme Tokens
|
||||
|
||||
### Dark Mode (Default)
|
||||
|
||||
```css
|
||||
[data-theme="dark"] {
|
||||
/* Base */
|
||||
--clr-base: var(--clr-surface-base);
|
||||
--clr-elevated: var(--clr-surface-elevated);
|
||||
--clr-overlay: var(--clr-surface-overlay);
|
||||
--clr-sunken: var(--clr-surface-sunken);
|
||||
|
||||
/* Text */
|
||||
--clr-text: var(--clr-text-primary);
|
||||
--clr-text-muted: var(--clr-text-secondary);
|
||||
|
||||
/* Brand adjustments for dark */
|
||||
--clr-primary: var(--clr-primary-400); /* Lebih terang di dark */
|
||||
--clr-primary-bg: oklch(0.25 0.060 255 / 0.20);
|
||||
}
|
||||
```
|
||||
|
||||
### Light Mode
|
||||
|
||||
```css
|
||||
[data-theme="light"] {
|
||||
--clr-base: oklch(0.97 0.002 286);
|
||||
--clr-elevated: oklch(1.00 0.000 286);
|
||||
--clr-overlay: oklch(0.95 0.003 286);
|
||||
--clr-sunken: oklch(0.92 0.004 286);
|
||||
|
||||
--clr-text: oklch(0.11 0.010 286);
|
||||
--clr-text-muted: oklch(0.50 0.020 286);
|
||||
|
||||
--clr-primary: var(--clr-primary-500); /* Standard di light */
|
||||
--clr-primary-bg: oklch(0.90 0.060 255 / 0.25);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 Moderation Severity Colors
|
||||
|
||||
Sistem moderasi menggunakan gradasi keparahan dari aman hingga kritis:
|
||||
|
||||
```css
|
||||
--clr-severity-safe: oklch(0.60 0.130 145); /* Emerald — aman */
|
||||
--clr-severity-low: oklch(0.70 0.120 75); /* Amber — rendah */
|
||||
--clr-severity-medium: oklch(0.65 0.150 50); /* Orange — sedang */
|
||||
--clr-severity-high: oklch(0.60 0.150 30); /* Red-orange — tinggi */
|
||||
--clr-severity-critical: oklch(0.55 0.165 25); /* Ruby — kritis */
|
||||
```
|
||||
|
||||
### Background Variations (untuk chip/badge)
|
||||
|
||||
```css
|
||||
--clr-severity-safe-bg: oklch(0.60 0.130 145 / 0.15);
|
||||
--clr-severity-low-bg: oklch(0.70 0.120 75 / 0.15);
|
||||
--clr-severity-medium-bg: oklch(0.65 0.150 50 / 0.15);
|
||||
--clr-severity-high-bg: oklch(0.60 0.150 30 / 0.15);
|
||||
--clr-severity-critical-bg: oklch(0.55 0.165 25 / 0.15);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Color Usage Decision Tree
|
||||
|
||||
```
|
||||
Butuh warna untuk...
|
||||
│
|
||||
├── Surface / Background → Gunakan --clr-surface-* (base/elevated/overlay)
|
||||
│
|
||||
├── Text → Gunakan --clr-text-* (primary/secondary/tertiary)
|
||||
│
|
||||
├── Interactive element →
|
||||
│ ├── Button utama → --clr-primary, --clr-primary-hover
|
||||
│ ├── Button danger → --clr-ruby-500
|
||||
│ ├── Link → --clr-primary-400 (dark) / --clr-primary-600 (light)
|
||||
│ └── Input focus → --clr-primary ring
|
||||
│
|
||||
├── Status indicator →
|
||||
│ ├── Success → --clr-emerald-* atau --clr-severity-safe
|
||||
│ ├── Warning → --clr-amber-* atau --clr-severity-low
|
||||
│ ├── Error → --clr-ruby-* atau --clr-severity-critical
|
||||
│ └── Info → --clr-cyan-*
|
||||
│
|
||||
├── Data visualization → Gunakan palette chart (lihat patterns/07)
|
||||
│
|
||||
└── Moderation badge → Gunakan --clr-severity-*
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Anti-Patterns (Yang Tidak Boleh Dilakukan)
|
||||
|
||||
### ❌ Hardcoded HEX/RGB
|
||||
```css
|
||||
/* ❌ JANGAN — tidak akan terpengaruh theme switching */
|
||||
.notification-success {
|
||||
background: #d4edda;
|
||||
color: #155724;
|
||||
}
|
||||
|
||||
/* ✅ Gunakan token semantic */
|
||||
.notification-success {
|
||||
background: var(--clr-emerald-100);
|
||||
color: var(--clr-emerald-800);
|
||||
}
|
||||
```
|
||||
|
||||
### ❌ Langsung pakai Tailwind utility colors
|
||||
```tsx
|
||||
{/* ❌ JANGAN — hardcoded ke skema tertentu */}
|
||||
<Badge className="bg-emerald-100 text-emerald-700" />
|
||||
|
||||
{/* ✅ Gunakan semantic variant */}
|
||||
<Badge variant="success" />
|
||||
```
|
||||
|
||||
### ❌ Mengabaikan kontras
|
||||
```css
|
||||
/* ❌ JANGAN — teks abu-abu di atas abu-abu */
|
||||
.metadata {
|
||||
color: oklch(0.65 0.015 286); /* L=0.65 */
|
||||
background: oklch(0.70 0.010 286); /* L=0.70 — rasio ~1.1:1! */
|
||||
}
|
||||
|
||||
/* ✅ Minimum kontras 3:1 untuk secondary text */
|
||||
.metadata {
|
||||
color: oklch(0.50 0.020 286); /* L=0.50 */
|
||||
background: var(--clr-surface-base); /* L=0.11 */
|
||||
/* Rasio ~6:1 — aman */
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [OKLCH Color Picker](https://oklch.com/) | Visualisasi OKLCH color space |
|
||||
| [WCAG Contrast Checker](https://webaim.org/resources/contrastchecker/) | Verifikasi kontras |
|
||||
| [Material HCT](https://material.io/blog/science-of-color-design) | Hue-Chroma-Tone system |
|
||||
| [Tailwind CSS OKLCH](https://tailwindcss.com/docs/colors#using-custom-colors) | Implementasi OKLCH |
|
||||
|
||||
---
|
||||
|
||||
*"Warna adalah ingatan yang tak pernah pudar — dibiaskan melalui prisma es Amphoreus."* ❄️🩵
|
||||
@@ -1,371 +0,0 @@
|
||||
# Typography — The Voice of Glass
|
||||
|
||||
> *"Typography is the craft of endowing human language with a durable visual form."*
|
||||
> — Robert Bringhurst, *The Elements of Typographic Style*
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Tipografi
|
||||
|
||||
Tipografi BETE dibangun di atas tiga pilar:
|
||||
|
||||
1. **Hierarki melalui weight & size** — Bukan sekadar memperbesar heading, tapi memberi bobot makna
|
||||
2. **Ritme vertikal yang konsisten** — Setiap elemen teks berada dalam grid ritme 4px
|
||||
3. **Keterbacaan sebagai prioritas utama** — Sebelum estetika, sebelum gaya
|
||||
|
||||
---
|
||||
|
||||
## 📐 Type Scale: Fluid Modular Scale
|
||||
|
||||
Kita menggunakan **modular scale** 1.25 (major third) yang **fluid** — menyesuaikan antara viewport.
|
||||
|
||||
```css
|
||||
/* Font size scale — fluid, minor third (1.125) hingga major third (1.25) */
|
||||
--fs-xs: clamp(0.69rem, 0.69rem + 0.01vw, 0.75rem); /* 11–12px */
|
||||
--fs-sm: clamp(0.81rem, 0.81rem + 0.02vw, 0.88rem); /* 13–14px */
|
||||
--fs-base: clamp(0.94rem, 0.94rem + 0.03vw, 1.00rem); /* 15–16px ★ */
|
||||
--fs-md: clamp(1.06rem, 1.06rem + 0.04vw, 1.13rem); /* 17–18px */
|
||||
--fs-lg: clamp(1.19rem, 1.19rem + 0.06vw, 1.25rem); /* 19–20px */
|
||||
--fs-xl: clamp(1.31rem, 1.31rem + 0.08vw, 1.50rem); /* 21–24px */
|
||||
--fs-2xl: clamp(1.50rem, 1.50rem + 0.12vw, 1.88rem); /* 24–30px */
|
||||
--fs-3xl: clamp(1.69rem, 1.69rem + 0.18vw, 2.25rem); /* 27–36px */
|
||||
--fs-4xl: clamp(1.88rem, 1.88rem + 0.26vw, 2.81rem); /* 30–45px */
|
||||
--fs-5xl: clamp(2.25rem, 2.25rem + 0.38vw, 3.50rem); /* 36–56px */
|
||||
--fs-6xl: clamp(2.50rem, 2.50rem + 0.50vw, 4.00rem); /* 40–64px */
|
||||
```
|
||||
|
||||
> **Mengapa clamp()?** Font size yang terlalu besar di mobile dan terlalu kecil di desktop adalah masalah UX klasik. Dengan `clamp()`, kita dapatkan ukuran yang optimal di setiap viewport tanpa media query.
|
||||
|
||||
### Line Height
|
||||
|
||||
```css
|
||||
--lh-tight: 1.15; /* Heading besar, display text */
|
||||
--lh-normal: 1.50; /* Body text, paragraphs */
|
||||
--lh-relaxed: 1.65; /* Long-form reading */
|
||||
--lh-compact: 1.25; /* UI labels, badges, small text */
|
||||
```
|
||||
|
||||
### Font Weight Tokens
|
||||
|
||||
```css
|
||||
--fw-light: 300;
|
||||
--fw-regular: 400;
|
||||
--fw-medium: 500;
|
||||
--fw-semibold: 600;
|
||||
--fw-bold: 700;
|
||||
--fw-extrabold: 800;
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔤 Font Family
|
||||
|
||||
### Primary: "Outfit" — Modern Geometric Sans
|
||||
|
||||
```css
|
||||
--ff-sans: 'Outfit', system-ui, -apple-system, sans-serif;
|
||||
--ff-display: 'Outfit', system-ui, -apple-system, sans-serif;
|
||||
```
|
||||
|
||||
Mengapa **Outfit** menggantikan Poppins?
|
||||
- **Geometric precision** — Bentuk huruf yang bersih, cocok untuk UI modern
|
||||
- **Low x-height** — Memberi kesan elegan dan lega
|
||||
- **Variable font support** — Satu file untuk semua weight, performa lebih baik
|
||||
- **Open-source** — SIL Open Font License
|
||||
|
||||
### Monospace: "JetBrains Mono"
|
||||
|
||||
```css
|
||||
--ff-mono: 'JetBrains Mono', 'Fira Code', 'Cascadia Code', monospace;
|
||||
```
|
||||
|
||||
Untuk: ID, timestamp, kode, data teknis, metrik.
|
||||
|
||||
### Loading Strategy
|
||||
|
||||
```html
|
||||
<!-- Variable font — cukup satu file untuk seluruh weight -->
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
<link href="https://fonts.googleapis.com/css2?family=Outfit:wght@300..800&family=JetBrains+Mono:wght@400..700&display=swap" rel="stylesheet" />
|
||||
```
|
||||
|
||||
```css
|
||||
/* Fallback font stack dengan @font-face untuk cache lokal */
|
||||
@font-face {
|
||||
font-family: 'Outfit Fallback';
|
||||
src: local('Segoe UI'), local('Roboto'), local('Helvetica Neue');
|
||||
size-adjust: 95%; /* Mengurangi layout shift (CLS) */
|
||||
ascent-override: 90%;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 Type Styles — The Complete Catalog
|
||||
|
||||
### Display / Hero
|
||||
|
||||
```css
|
||||
.display-1 {
|
||||
font-family: var(--ff-display);
|
||||
font-size: var(--fs-6xl);
|
||||
font-weight: var(--fw-extrabold);
|
||||
line-height: var(--lh-tight);
|
||||
letter-spacing: -0.03em;
|
||||
}
|
||||
|
||||
.display-2 {
|
||||
font-family: var(--ff-display);
|
||||
font-size: var(--fs-5xl);
|
||||
font-weight: var(--fw-bold);
|
||||
line-height: var(--lh-tight);
|
||||
letter-spacing: -0.02em;
|
||||
}
|
||||
```
|
||||
|
||||
### Headings
|
||||
|
||||
```css
|
||||
.h1 {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-4xl);
|
||||
font-weight: var(--fw-bold);
|
||||
line-height: var(--lh-tight);
|
||||
letter-spacing: -0.02em;
|
||||
}
|
||||
|
||||
.h2 {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-3xl);
|
||||
font-weight: var(--fw-semibold);
|
||||
line-height: var(--lh-tight);
|
||||
letter-spacing: -0.015em;
|
||||
}
|
||||
|
||||
.h3 {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-2xl);
|
||||
font-weight: var(--fw-semibold);
|
||||
line-height: var(--lh-tight);
|
||||
letter-spacing: -0.01em;
|
||||
}
|
||||
|
||||
.h4 {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-xl);
|
||||
font-weight: var(--fw-medium);
|
||||
line-height: var(--lh-normal);
|
||||
letter-spacing: -0.005em;
|
||||
}
|
||||
```
|
||||
|
||||
### Body
|
||||
|
||||
```css
|
||||
.body-large {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-md);
|
||||
font-weight: var(--fw-regular);
|
||||
line-height: var(--lh-relaxed);
|
||||
}
|
||||
|
||||
.body {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-base);
|
||||
font-weight: var(--fw-regular);
|
||||
line-height: var(--lh-normal);
|
||||
}
|
||||
|
||||
.body-small {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-sm);
|
||||
font-weight: var(--fw-regular);
|
||||
line-height: var(--lh-normal);
|
||||
}
|
||||
|
||||
.body-compact {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-sm);
|
||||
font-weight: var(--fw-medium);
|
||||
line-height: var(--lh-compact);
|
||||
}
|
||||
```
|
||||
|
||||
### UI / Label
|
||||
|
||||
```css
|
||||
.label {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-xs);
|
||||
font-weight: var(--fw-semibold);
|
||||
line-height: var(--lh-compact);
|
||||
letter-spacing: 0.06em; /* UPPERCASE labels get wider tracking */
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
.caption {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-xs);
|
||||
font-weight: var(--fw-regular);
|
||||
line-height: var(--lh-normal);
|
||||
color: var(--clr-text-secondary);
|
||||
}
|
||||
|
||||
.mono {
|
||||
font-family: var(--ff-mono);
|
||||
font-size: var(--fs-sm);
|
||||
font-weight: var(--fw-regular);
|
||||
line-height: var(--lh-normal);
|
||||
}
|
||||
|
||||
.badge {
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-xs);
|
||||
font-weight: var(--fw-medium);
|
||||
line-height: 1;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 Type Table — Mapping ke Penggunaan
|
||||
|
||||
| Token | Penggunaan | Contoh |
|
||||
|-------|-----------|--------|
|
||||
| `.display-1` | Halaman kosong, 404, hero section | "Nothing to see here" |
|
||||
| `.display-2` | Empty state utama | "No messages yet" |
|
||||
| `.h1` | Judul halaman | "Dashboard", "Messages" |
|
||||
| `.h2` | Judul section panel | "Voice Connections", "Analytics" |
|
||||
| `.h3` | Judul card | Nama user, channel |
|
||||
| `.h4` | Sub-section, tab content | "Active Speakers", "Filters" |
|
||||
| `.body` | Paragraf, konten utama | Pesan teks, deskripsi |
|
||||
| `.body-small` | Metadata, secondary info | Timestamp, username |
|
||||
| `.body-compact` | Dense lists | Daftar items compact |
|
||||
| `.label` | Form label, section header | "CHANNEL", "USERNAME" |
|
||||
| `.caption` | Hint, footnote, helper | "Click to expand" |
|
||||
| `.mono` | ID, kode, data teknis | "Channel #12345" |
|
||||
| `.badge` | Chip, status indicator | "AI Analysis", "Flagged" |
|
||||
|
||||
---
|
||||
|
||||
## 🎭 Rich Text & Emphatic Styles
|
||||
|
||||
```css
|
||||
/* Links */
|
||||
a, .link {
|
||||
color: var(--clr-primary-400);
|
||||
text-decoration: none;
|
||||
transition: opacity var(--dur-fast) var(--ease-out);
|
||||
}
|
||||
a:hover, .link:hover {
|
||||
opacity: 0.8;
|
||||
text-decoration: underline;
|
||||
text-underline-offset: 2px;
|
||||
}
|
||||
|
||||
/* Code inline */
|
||||
code, .code-inline {
|
||||
font-family: var(--ff-mono);
|
||||
font-size: 0.9em;
|
||||
padding: 0.125em 0.375em;
|
||||
background: var(--clr-surface-sunken);
|
||||
border-radius: var(--rd-xs);
|
||||
}
|
||||
|
||||
/* Truncation */
|
||||
.text-truncate {
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
/* Multi-line truncation */
|
||||
.text-clamp-2 {
|
||||
display: -webkit-box;
|
||||
-webkit-line-clamp: 2;
|
||||
-webkit-box-orient: vertical;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.text-clamp-3 {
|
||||
display: -webkit-box;
|
||||
-webkit-line-clamp: 3;
|
||||
-webkit-box-orient: vertical;
|
||||
overflow: hidden;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📏 Vertical Rhythm
|
||||
|
||||
Menggunakan sistem baseline 4px (bukan 8px default) untuk tipografi:
|
||||
|
||||
```css
|
||||
:root {
|
||||
--baseline: 4px;
|
||||
}
|
||||
|
||||
/* Heading margin */
|
||||
.h1 { margin-bottom: calc(var(--baseline) * 4); } /* 16px */
|
||||
.h2 { margin-bottom: calc(var(--baseline) * 3); } /* 12px */
|
||||
.h3 { margin-bottom: calc(var(--baseline) * 3); } /* 12px */
|
||||
.h4 { margin-bottom: calc(var(--baseline) * 2); } /* 8px */
|
||||
|
||||
/* Paragraph spacing */
|
||||
p, .body {
|
||||
margin-bottom: calc(var(--baseline) * 4); /* 16px */
|
||||
}
|
||||
|
||||
p + p {
|
||||
margin-top: calc(var(--baseline) * 2); /* 8px — reduced between consecutive paragraphs */
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Anti-Patterns Tipografi
|
||||
|
||||
### ❌ Ukuran absolut tanpa fluid
|
||||
```css
|
||||
/* ❌ JANGAN — title 32px di mobile terlalu besar */
|
||||
.page-title { font-size: 32px; }
|
||||
|
||||
/* ✅ clamp menyesuaikan viewport */
|
||||
.page-title { font-size: var(--fs-4xl); }
|
||||
```
|
||||
|
||||
### ❌ Line height terlalu kecil untuk body text
|
||||
```css
|
||||
/* ❌ JANGAN — crowded, sulit dibaca */
|
||||
.body-text { font-size: 16px; line-height: 1.2; }
|
||||
|
||||
/* ✅ Line height yang cukup untuk readability */
|
||||
.body-text { font-size: var(--fs-base); line-height: var(--lh-normal); }
|
||||
```
|
||||
|
||||
### ❌ Terlalu banyak type scale
|
||||
```css
|
||||
/* ❌ JANGAN — 29px, 28px, 27px, 26px adalah noise */
|
||||
.custom-1 { font-size: 29px; }
|
||||
.custom-2 { font-size: 28px; }
|
||||
|
||||
/* ✅ Gunakan scale yang terdefinisi */
|
||||
.custom { font-size: var(--fs-4xl); }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [Type Scale Calculator](https://typescale.com/) | Modular scale generation |
|
||||
| [Outfit on Google Fonts](https://fonts.google.com/specimen/Outfit) | Font spesifikasi |
|
||||
| [Utopia.fyi](https://utopia.fyi/) | Fluid type scale calculator |
|
||||
| [JetBrains Mono](https://www.jetbrains.com/lp/mono/) | Font monospace |
|
||||
|
||||
---
|
||||
|
||||
*"Huruf adalah jejak ingatan yang tak kasatmata — ia berbicara tanpa suara."* ❄️🩵
|
||||
@@ -1,349 +0,0 @@
|
||||
# Spatial System — The Architecture of Void
|
||||
|
||||
> *"Space is the breath of art."*
|
||||
> — Frank Lloyd Wright, arsitek organik.
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Spasial
|
||||
|
||||
Ruang dalam BETE bukan sekadar "tempat kosong" — ia adalah **medium komunikasi visual**. Jarak antarelemen menyampaikan hubungan semantik:
|
||||
|
||||
- **Dekat** → Elemen terkait secara konseptual
|
||||
- **Berjarak** → Elemen independen atau batch berbeda
|
||||
- **Terpisah jauh** → Section baru, hierarki turun
|
||||
|
||||
Kita menggunakan **4px baseline grid** untuk semua keputusan spasial.
|
||||
|
||||
---
|
||||
|
||||
## 📐 Grid System: 8px × 4px Hybrid
|
||||
|
||||
BETE menggunakan sistem **8px untuk layout kasar**, **4px untuk fine-tuning**.
|
||||
|
||||
```css
|
||||
:root {
|
||||
/* Base grid unit */
|
||||
--grid-unit: 4px;
|
||||
|
||||
/* Spacing scale — exponential */
|
||||
--sp-0: 0px;
|
||||
--sp-0.5: calc(var(--grid-unit) * 1); /* 4px — micro spacing */
|
||||
--sp-1: calc(var(--grid-unit) * 2); /* 8px — tight spacing */
|
||||
--sp-2: calc(var(--grid-unit) * 3); /* 12px — compact spacing */
|
||||
--sp-3: calc(var(--grid-unit) * 4); /* 16px — base spacing ★ */
|
||||
--sp-4: calc(var(--grid-unit) * 6); /* 24px — relaxed spacing */
|
||||
--sp-5: calc(var(--grid-unit) * 8); /* 32px — section spacing */
|
||||
--sp-6: calc(var(--grid-unit) * 12); /* 48px — panel spacing */
|
||||
--sp-7: calc(var(--grid-unit) * 16); /* 64px — page spacing */
|
||||
--sp-8: calc(var(--grid-unit) * 24); /* 96px — hero spacing */
|
||||
}
|
||||
```
|
||||
|
||||
### Logic di Balik Scale
|
||||
|
||||
| Token | px | Konteks |
|
||||
|-------|----|---------|
|
||||
| `--sp-0.5` | 4px | Ikon-padding, badge spacing, dot indicators |
|
||||
| `--sp-1` | 8px | Avatar-text gap, icon-button padding |
|
||||
| `--sp-2` | 12px | Button padding, chip spacing, input padding |
|
||||
| `--sp-3` | 16px | **Base unit** — card-padding, section margin, form gap |
|
||||
| `--sp-4` | 24px | Card gap, panel padding, modal padding |
|
||||
| `--sp-5` | 32px | Content area padding, desktop sidebar width |
|
||||
| `--sp-6` | 48px | Page section gap, dashboards grid gap |
|
||||
| `--sp-7` | 64px | Page padding desktop, hero spacing |
|
||||
| `--sp-8` | 96px | Empty state height, large break sections |
|
||||
|
||||
---
|
||||
|
||||
## 🔲 Layout Components
|
||||
|
||||
### Page Layout (Desktop)
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ ┌── Header ──┐ │ 56px
|
||||
│ └────────────┘ │
|
||||
│ ┌─ Sidebar ─┐ ┌────────── Main Content ──────────┐│
|
||||
│ │ │ │ ┌─ Page Title ─────────────────┐ ││
|
||||
│ │ icon grid │ │ │ Section Heading │ ││
|
||||
│ │ ──────── │ │ └─────────────────────────────┘ ││
|
||||
│ │ nav-1 │ │ ││
|
||||
│ │ nav-2 │ │ ┌────── Grid Area ─────────────┐ ││
|
||||
│ │ nav-3 │ │ │ ┌── Card ──┐ ┌── Card ──┐ │ ││
|
||||
│ │ │ │ │ │ │ │ │ │ ││
|
||||
│ │ ──────── │ │ │ └──────────┘ └──────────┘ │ ││
|
||||
│ │ mascot │ │ │ ┌── Card ──┐ ┌── Card ──┐ │ ││
|
||||
│ │ │ │ │ │ │ │ │ │ ││
|
||||
│ └────────────┘ │ │ └──────────┘ └──────────┘ │ ││
|
||||
│ │ └───────────────────────────────┘ ││
|
||||
│ w-64/ │ flex-1 ││
|
||||
│ w-16(icon) │ ││
|
||||
└─────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### Vue 3 Component Mapping
|
||||
|
||||
```tsx
|
||||
// DashboardLayout.vue
|
||||
<template>
|
||||
<div class="page-layout">
|
||||
<Sidebar :collapsed="sidebarCollapsed" />
|
||||
<main class="main-area">
|
||||
<Header />
|
||||
<div class="content-area">
|
||||
<slot />
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
</template>
|
||||
```
|
||||
|
||||
```css
|
||||
.page-layout {
|
||||
display: grid;
|
||||
grid-template-columns: auto 1fr;
|
||||
grid-template-rows: auto 1fr;
|
||||
min-height: 100vh;
|
||||
}
|
||||
|
||||
.sidebar {
|
||||
grid-row: 1 / -1;
|
||||
width: 256px; /* w-64 */
|
||||
transition: width var(--dur-normal) var(--ease-out-quint);
|
||||
}
|
||||
.sidebar.collapsed {
|
||||
width: 64px; /* w-16 */
|
||||
}
|
||||
|
||||
.main-area {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
min-width: 0; /* Prevent grid blowout */
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.content-area {
|
||||
flex: 1;
|
||||
overflow-y: auto;
|
||||
padding: var(--sp-5);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔳 Border Radius Scale
|
||||
|
||||
```css
|
||||
--rd-none: 0px;
|
||||
--rd-xs: 4px; /* Checkbox, toggle, small indicators */
|
||||
--rd-sm: 6px; /* Input, button small, badges */
|
||||
--rd-md: 8px; /* Button default, card, modal */
|
||||
--rd-lg: 12px; /* Card elevated, sheets, panels */
|
||||
--rd-xl: 16px; /* Dialog, bottom sheet */
|
||||
--rd-2xl: 20px; /* Full-width cards on mobile */
|
||||
--rd-full: 9999px; /* Pill, chip, avatar */
|
||||
```
|
||||
|
||||
### Radius Decision Tree
|
||||
|
||||
```
|
||||
Elemen interaktif?
|
||||
├── Ya ─→ butuh affordance visual?
|
||||
│ ├── Ya, utama (button, card clickable) → --rd-md (8px)
|
||||
│ └── Tidak (chip, tag, avatar) → --rd-full (pill)
|
||||
│
|
||||
└── Tidak → container?
|
||||
├── Dialog/modal → --rd-xl (16px)
|
||||
├── Card dalam grid → --rd-lg (12px)
|
||||
└── Sheet/panel → --rd-xl atau --rd-2xl
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🥞 Z-Index Registry (Formal)
|
||||
|
||||
```css
|
||||
:root {
|
||||
--z-base: 0;
|
||||
--z-dropdown: 10;
|
||||
--z-sticky: 20;
|
||||
--z-header: 30;
|
||||
--z-sidebar: 40;
|
||||
--z-overlay: 50; /* Mobile sidebar, backdrop */
|
||||
--z-modal: 60; /* Dialog, confirm */
|
||||
--z-popover: 70; /* Tooltip, popover, dropdown menu */
|
||||
--z-toast: 80; /* Toast notification */
|
||||
--z-mascot: 100; /* Mascot chatbot — highest */
|
||||
}
|
||||
|
||||
/* Implementation */
|
||||
.header { z-index: var(--z-header); }
|
||||
.sidebar { z-index: var(--z-sidebar); }
|
||||
.modal { z-index: var(--z-modal); }
|
||||
.toast { z-index: var(--z-toast); }
|
||||
.mascot-chat { z-index: var(--z-mascot); }
|
||||
```
|
||||
|
||||
### Stacking Order
|
||||
|
||||
```
|
||||
Layer Value Elemen
|
||||
─────────────────────────────────────────────
|
||||
Background -1 ParticleBackground
|
||||
Base 0 Layout, cards, text
|
||||
Dropdown 10 Select options, context menu
|
||||
Sticky 20 Sticky section headers
|
||||
Header 30 Sticky page header
|
||||
Sidebar 40 Desktop sidebar
|
||||
Overlay 50 Backdrop, mobile drawer
|
||||
Modal 60 Confirm dialog, modal
|
||||
Popover 70 Tooltip, dropdown
|
||||
Toast 80 Toast notifications
|
||||
Mascot 100 Chatbot floating panel
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📱 Responsive Breakpoints
|
||||
|
||||
```css
|
||||
/* CSS Custom Properties for breakpoints */
|
||||
:root {
|
||||
--bp-sm: 640px;
|
||||
--bp-md: 768px;
|
||||
--bp-lg: 1024px;
|
||||
--bp-xl: 1280px;
|
||||
--bp-2xl: 1536px;
|
||||
}
|
||||
|
||||
/* Container max-width */
|
||||
--container-sm: 640px;
|
||||
--container-md: 768px;
|
||||
--container-lg: 1024px;
|
||||
--container-xl: 1280px;
|
||||
```
|
||||
|
||||
### Layout Behavior per Breakpoint
|
||||
|
||||
| Breakpoint | Sidebar | Content Padding | Grid Columns |
|
||||
|-----------|---------|-----------------|--------------|
|
||||
| `<640px` | Bottom tab (56px) | `--sp-3` (16px) | 1 |
|
||||
| `640–768px` | Bottom tab | `--sp-4` (24px) | 1 |
|
||||
| `768–1024px` | Icon-only (64px) | `--sp-4` (24px) | 1–2 |
|
||||
| `1024–1280px` | Full (256px) | `--sp-5` (32px) | 2–3 |
|
||||
| `1280px+` | Full (256px) | `--sp-5` (32px) | 2–4 |
|
||||
|
||||
---
|
||||
|
||||
## 📦 Common Layout Patterns
|
||||
|
||||
### Card Grid
|
||||
|
||||
```css
|
||||
.card-grid {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fill, minmax(320px, 1fr));
|
||||
gap: var(--sp-4);
|
||||
}
|
||||
```
|
||||
|
||||
### Two-Column Detail
|
||||
|
||||
```css
|
||||
.two-column {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 1fr;
|
||||
gap: var(--sp-4);
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.two-column {
|
||||
grid-template-columns: 1fr;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Sidebar + Content (Live Panel)
|
||||
|
||||
```css
|
||||
.live-layout {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 320px; /* Content 1fr, sidebar fixed */
|
||||
gap: var(--sp-4);
|
||||
}
|
||||
|
||||
@media (max-width: 1024px) {
|
||||
.live-layout {
|
||||
grid-template-columns: 1fr; /* Stack on smaller screens */
|
||||
}
|
||||
}
|
||||
|
||||
.live-sidebar {
|
||||
position: sticky;
|
||||
top: calc(56px + var(--sp-4)); /* Below header */
|
||||
max-height: calc(100vh - 56px - var(--sp-4) * 2);
|
||||
overflow-y: auto;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Container Queries (Modern Approach)
|
||||
|
||||
Untuk komponen yang reusable di berbagai konteks:
|
||||
|
||||
```css
|
||||
.card-grid-component {
|
||||
container-type: inline-size;
|
||||
container-name: card-grid;
|
||||
}
|
||||
|
||||
@container card-grid (max-width: 400px) {
|
||||
.card-item {
|
||||
grid-template-columns: 1fr; /* Single column di container kecil */
|
||||
}
|
||||
}
|
||||
|
||||
@container card-grid (min-width: 401px) {
|
||||
.card-item {
|
||||
grid-template-columns: 1fr 1fr;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Anti-Patterns Spasial
|
||||
|
||||
### ❌ Margin collapse tanpa sengaja
|
||||
```css
|
||||
/* ❌ JANGAN — flex gap jauh lebih aman */
|
||||
.card + .card { margin-top: 16px; } /* Rawan collapse */
|
||||
|
||||
/* ✅ Gunakan gap */
|
||||
.card-grid { display: flex; flex-direction: column; gap: var(--sp-4); }
|
||||
```
|
||||
|
||||
### ❌ Padding tidak konsisten
|
||||
```css
|
||||
/* ❌ JANGAN — setiap file punya padding sendiri */
|
||||
.page-a { padding: 20px; }
|
||||
.page-b { padding: 24px; }
|
||||
|
||||
/* ✅ Gunakan spacing token */
|
||||
.page { padding: var(--sp-5); }
|
||||
```
|
||||
|
||||
### ❌ Grid blowout (min-width tanpa min-width: 0)
|
||||
```css
|
||||
/* ❌ JANGAN — grid item dengan teks panjang mendorong layout */
|
||||
.grid-item { overflow: visible; }
|
||||
|
||||
/* ✅ Cegah blowout */
|
||||
.grid-item { min-width: 0; overflow: hidden; }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
*"Ruang adalah kanvas tempat ingatan menari — setiap piksel memiliki tempatnya."* ❄️🩵
|
||||
@@ -1,552 +0,0 @@
|
||||
# Motion System — The Dance of Glass
|
||||
|
||||
> *"Animation is not about making things move. It's about making things *believe*."*
|
||||
> — Richard Williams, *The Animator's Survival Kit*
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Gerak
|
||||
|
||||
Animasi di BETE bukan sekadar efek visual — ia adalah **bahasa kinetik** yang mengkomunikasikan relasi spasial antar elemen:
|
||||
|
||||
| Gerakan | Makna |
|
||||
|---------|-------|
|
||||
| **Slide from right** | Elemen baru datang dari "luar" — panel, drawer |
|
||||
| **Fade in + scale** | Muncul dari "dalam" — modal, dialog |
|
||||
| **Slide up** | Konten baru melanjutkan alur vertikal |
|
||||
| **Scale + glow** | Sedang diproses — loading, analysis |
|
||||
| **Spring bounce (subtle)** | Konfirmasi sukses — centang, badge |
|
||||
|
||||
---
|
||||
|
||||
## ⏱️ Timing & Easing — The Physics Engine
|
||||
|
||||
### Duration Tokens
|
||||
|
||||
```css
|
||||
:root {
|
||||
--dur-instant: 0ms;
|
||||
--dur-fast: 150ms; /* Hover, active state, toggle */
|
||||
--dur-normal: 250ms; /* Default transition, card hover */
|
||||
--dur-slow: 350ms; /* Panel enter/exit, page transition */
|
||||
--dur-glacial: 500ms; /* Modal, drawer slide, emphasis */
|
||||
}
|
||||
```
|
||||
|
||||
### Easing Curves
|
||||
|
||||
BETE menggunakan tiga easing curve utama, semuanya **custom cubic-bezier**:
|
||||
|
||||
```css
|
||||
:root {
|
||||
/* Standard ease-out — untuk sebagian besar interaksi */
|
||||
--ease-out: cubic-bezier(0.16, 1, 0.3, 1);
|
||||
|
||||
/* Ease-out quint — untuk elemen yang "mendarat" */
|
||||
--ease-out-quint: cubic-bezier(0.22, 1, 0.36, 1);
|
||||
|
||||
/* Ease-in-out — untuk transisi dua arah (accordion, collapse) */
|
||||
--ease-in-out: cubic-bezier(0.65, 0, 0.35, 1);
|
||||
}
|
||||
```
|
||||
|
||||
### Perbandingan dengan CSS Default
|
||||
|
||||
| Nama | Bezier | Karakter |
|
||||
|------|--------|----------|
|
||||
| `ease` (default) | `(0.25, 0.1, 0.25, 1)` | Lambat mulai, lambat akhir |
|
||||
| `ease-out` | `(0, 0, 0.58, 1)` | Cepat mulai |
|
||||
| `ease-in-out` | `(0.42, 0, 0.58, 1)` | Simetris |
|
||||
| **`--ease-out`** | `(0.16, 1, 0.3, 1)` | Natural, "berat" di akhir |
|
||||
| **`--ease-out-quint`** | `(0.22, 1, 0.36, 1)` | Landing yang tegas |
|
||||
|
||||
---
|
||||
|
||||
## 🏃 Micro-interactions
|
||||
|
||||
### Hover State
|
||||
|
||||
```css
|
||||
/* Card hover — subtle lift + shadow deepen */
|
||||
.card {
|
||||
transition:
|
||||
transform var(--dur-fast) var(--ease-out),
|
||||
box-shadow var(--dur-fast) var(--ease-out);
|
||||
}
|
||||
|
||||
.card:hover {
|
||||
transform: translateY(-2px);
|
||||
box-shadow: var(--sh-hover);
|
||||
}
|
||||
|
||||
/* Button hover — scale up subtly */
|
||||
.button {
|
||||
transition: transform var(--dur-fast) var(--ease-out);
|
||||
}
|
||||
.button:hover {
|
||||
transform: scale(1.02);
|
||||
}
|
||||
.button:active {
|
||||
transform: scale(0.98);
|
||||
}
|
||||
```
|
||||
|
||||
### Active/Press State
|
||||
|
||||
```css
|
||||
.button:active {
|
||||
transform: scale(0.96);
|
||||
transition-duration: var(--dur-fast);
|
||||
}
|
||||
|
||||
/* Button ripple effect */
|
||||
.button.ripple {
|
||||
position: relative;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.button.ripple::after {
|
||||
content: '';
|
||||
position: absolute;
|
||||
inset: 0;
|
||||
background: radial-gradient(circle, rgba(255,255,255,0.3) 10%, transparent 10%);
|
||||
background-position: center;
|
||||
background-repeat: no-repeat;
|
||||
background-size: 1000% 1000%;
|
||||
opacity: 0;
|
||||
transition: none;
|
||||
}
|
||||
|
||||
.button.ripple:active::after {
|
||||
background-size: 0% 0%;
|
||||
opacity: 1;
|
||||
transition: background-size 0.4s, opacity 0.4s;
|
||||
}
|
||||
```
|
||||
|
||||
### Focus Ring
|
||||
|
||||
```css
|
||||
.button:focus-visible {
|
||||
outline: 2px solid var(--clr-primary-400);
|
||||
outline-offset: 2px;
|
||||
}
|
||||
|
||||
/* Smooth ring transition */
|
||||
.input {
|
||||
transition:
|
||||
border-color var(--dur-fast) var(--ease-out),
|
||||
box-shadow var(--dur-fast) var(--ease-out);
|
||||
}
|
||||
.input:focus {
|
||||
border-color: var(--clr-primary);
|
||||
box-shadow: 0 0 0 3px var(--clr-primary-bg);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎬 Page & Panel Transitions
|
||||
|
||||
### Tab Switch — Choreographed Sequence
|
||||
|
||||
```css
|
||||
/* Stagger container */
|
||||
.page-transition-enter {
|
||||
opacity: 0;
|
||||
}
|
||||
|
||||
.page-transition-enter-active {
|
||||
opacity: 1;
|
||||
transition: opacity var(--dur-slow) var(--ease-out);
|
||||
}
|
||||
|
||||
/* Children stagger — via Framer Motion / GSAP timeline */
|
||||
@keyframes stagger-enter {
|
||||
from {
|
||||
opacity: 0;
|
||||
transform: translateY(12px);
|
||||
}
|
||||
to {
|
||||
opacity: 1;
|
||||
transform: translateY(0);
|
||||
}
|
||||
}
|
||||
|
||||
.stagger-item {
|
||||
animation: stagger-enter var(--dur-slow) var(--ease-out) both;
|
||||
}
|
||||
|
||||
.stagger-item:nth-child(1) { animation-delay: 40ms; }
|
||||
.stagger-item:nth-child(2) { animation-delay: 80ms; }
|
||||
.stagger-item:nth-child(3) { animation-delay: 120ms; }
|
||||
.stagger-item:nth-child(4) { animation-delay: 160ms; }
|
||||
.stagger-item:nth-child(5) { animation-delay: 200ms; }
|
||||
/* ... formula: delay = index * 40ms */
|
||||
```
|
||||
|
||||
### Vue Transition Mode
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<Transition
|
||||
name="page"
|
||||
mode="out-in"
|
||||
@before-leave="beforeLeave"
|
||||
@after-enter="afterEnter"
|
||||
>
|
||||
<component :is="currentTab" :key="currentTab" />
|
||||
</Transition>
|
||||
</template>
|
||||
|
||||
<style>
|
||||
.page-leave-active {
|
||||
transition: opacity var(--dur-normal) var(--ease-in-out),
|
||||
transform var(--dur-normal) var(--ease-in-out);
|
||||
}
|
||||
.page-leave-to {
|
||||
opacity: 0;
|
||||
transform: translateY(-8px);
|
||||
}
|
||||
.page-enter-active {
|
||||
transition: opacity var(--dur-slow) var(--ease-out),
|
||||
transform var(--dur-slow) var(--ease-out);
|
||||
}
|
||||
.page-enter-from {
|
||||
opacity: 0;
|
||||
transform: translateY(12px);
|
||||
}
|
||||
</style>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Component-Specific Animations
|
||||
|
||||
### Sidebar Expand/Collapse
|
||||
|
||||
```css
|
||||
.sidebar {
|
||||
width: var(--sidebar-width, 256px);
|
||||
transition: width var(--dur-slow) var(--ease-out-quint);
|
||||
}
|
||||
|
||||
.sidebar.collapsed {
|
||||
--sidebar-width: 64px;
|
||||
}
|
||||
|
||||
/* Nav items — icon slides, text fades */
|
||||
.sidebar-nav-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 12px;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.sidebar-nav-item .label {
|
||||
transition: opacity var(--dur-normal) var(--ease-out),
|
||||
width var(--dur-normal) var(--ease-out);
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.sidebar.collapsed .sidebar-nav-item .label {
|
||||
opacity: 0;
|
||||
width: 0;
|
||||
padding: 0;
|
||||
}
|
||||
```
|
||||
|
||||
### Toast Notification
|
||||
|
||||
```css
|
||||
.toast-enter-active {
|
||||
animation: toast-slide-in var(--dur-slow) var(--ease-out-quint);
|
||||
}
|
||||
|
||||
.toast-leave-active {
|
||||
animation: toast-slide-out var(--dur-normal) var(--ease-in-out);
|
||||
}
|
||||
|
||||
@keyframes toast-slide-in {
|
||||
from {
|
||||
transform: translateX(100%);
|
||||
opacity: 0;
|
||||
}
|
||||
to {
|
||||
transform: translateX(0);
|
||||
opacity: 1;
|
||||
}
|
||||
}
|
||||
|
||||
@keyframes toast-slide-out {
|
||||
from {
|
||||
transform: translateX(0);
|
||||
opacity: 1;
|
||||
}
|
||||
to {
|
||||
transform: translateX(100%);
|
||||
opacity: 0;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Modal / Dialog
|
||||
|
||||
```css
|
||||
.modal-overlay-enter-active {
|
||||
transition: opacity var(--dur-normal) var(--ease-out);
|
||||
}
|
||||
.modal-overlay-enter-from { opacity: 0; }
|
||||
|
||||
.modal-content-enter-active {
|
||||
animation: modal-scale-in var(--dur-slow) var(--ease-out-quint);
|
||||
}
|
||||
|
||||
@keyframes modal-scale-in {
|
||||
from {
|
||||
transform: scale(0.92) translateY(8px);
|
||||
opacity: 0;
|
||||
}
|
||||
to {
|
||||
transform: scale(1) translateY(0);
|
||||
opacity: 1;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 Special Effects
|
||||
|
||||
### Audio Visualizer Bars
|
||||
|
||||
```css
|
||||
.visualizer-bar {
|
||||
animation: bar-pulse 0.4s ease-in-out infinite;
|
||||
transform-origin: bottom;
|
||||
}
|
||||
|
||||
.visualizer-bar:nth-child(1) { animation-delay: 0ms; }
|
||||
.visualizer-bar:nth-child(2) { animation-delay: 75ms; }
|
||||
.visualizer-bar:nth-child(3) { animation-delay: 150ms; }
|
||||
.visualizer-bar:nth-child(4) { animation-delay: 225ms; }
|
||||
|
||||
@keyframes bar-pulse {
|
||||
0%, 100% { transform: scaleY(0.8); }
|
||||
50% { transform: scaleY(1.2); }
|
||||
}
|
||||
```
|
||||
|
||||
### Skeleton Loading (Shimmer)
|
||||
|
||||
```css
|
||||
.skeleton {
|
||||
background: linear-gradient(
|
||||
90deg,
|
||||
var(--clr-surface-sunken) 25%,
|
||||
var(--clr-surface-elevated) 50%,
|
||||
var(--clr-surface-sunken) 75%
|
||||
);
|
||||
background-size: 200% 100%;
|
||||
animation: shimmer 1.5s ease-in-out infinite;
|
||||
}
|
||||
|
||||
@keyframes shimmer {
|
||||
from { background-position: 200% 0; }
|
||||
to { background-position: -200% 0; }
|
||||
}
|
||||
```
|
||||
|
||||
### AI Analysis Pulse (Glow)
|
||||
|
||||
```css
|
||||
.ai-badge {
|
||||
animation: ai-pulse 2s ease-in-out infinite;
|
||||
}
|
||||
|
||||
@keyframes ai-pulse {
|
||||
0%, 100% {
|
||||
box-shadow: 0 0 4px var(--clr-rose-500 / 0.2);
|
||||
}
|
||||
50% {
|
||||
box-shadow: 0 0 12px var(--clr-rose-500 / 0.4);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Ghost Particle (Background)
|
||||
|
||||
```css
|
||||
.particle {
|
||||
position: fixed;
|
||||
border-radius: 50%;
|
||||
pointer-events: none;
|
||||
animation: float var(--dur-float, 8s) ease-in-out infinite;
|
||||
animation-delay: var(--delay, 0s);
|
||||
}
|
||||
|
||||
@keyframes float {
|
||||
0%, 100% {
|
||||
transform: translateY(0) translateX(0) scale(1);
|
||||
opacity: 0.3;
|
||||
}
|
||||
25% {
|
||||
transform: translateY(-20px) translateX(10px) scale(1.1);
|
||||
opacity: 0.6;
|
||||
}
|
||||
50% {
|
||||
transform: translateY(-40px) translateX(-5px) scale(0.9);
|
||||
opacity: 0.4;
|
||||
}
|
||||
75% {
|
||||
transform: translateY(-20px) translateX(15px) scale(1.05);
|
||||
opacity: 0.5;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Motion Decision Tree
|
||||
|
||||
```
|
||||
Elemen apa yang dianimasikan?
|
||||
│
|
||||
├── Hover/Interaksi → dur-fast (150ms) + --ease-out
|
||||
│ ├── Card → translateY(-2px) + shadow deepen
|
||||
│ ├── Button → scale(1.02) / scale(0.98)
|
||||
│ ├── Link → opacity/underline
|
||||
│ └── Icon → rotate/color
|
||||
│
|
||||
├── Masuk ke halaman → dur-slow (350ms) + stagger
|
||||
│ ├── Halaman baru → fade + slideY(12px)
|
||||
│ ├── List items → stagger (40ms per item)
|
||||
│ └── Modal → scale(0.92→1) + fade overlay
|
||||
│
|
||||
├── Keluar dari halaman → dur-normal (250ms) + ease-in-out
|
||||
│ ├── Halaman → fade + slideY(-8px)
|
||||
│ ├── Toast → slideX(100%)
|
||||
│ └── Modal → scale(→0.95) + fade overlay
|
||||
│
|
||||
├── Loading → infinite loop
|
||||
│ ├── Skeleton → shimmer 1.5s
|
||||
│ ├── Spinner → spin
|
||||
│ └── AI Analysis → glow-pulse 2s
|
||||
│
|
||||
└── State change → dur-normal (250ms) + --ease-out
|
||||
├── Sidebar → width transition
|
||||
├── Accordion → height transition
|
||||
└── Badge → scale(0.8→1)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ♿ Reduced Motion
|
||||
|
||||
```css
|
||||
@media (prefers-reduced-motion: reduce) {
|
||||
*, *::before, *::after {
|
||||
animation-duration: 0.01ms !important;
|
||||
animation-iteration-count: 1 !important;
|
||||
transition-duration: 0.01ms !important;
|
||||
scroll-behavior: auto !important;
|
||||
}
|
||||
|
||||
/* But allow opacity transitions for basic UX */
|
||||
.fade-enter-active,
|
||||
.fade-leave-active {
|
||||
transition: opacity 0.15s ease !important;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Programmatic Check
|
||||
|
||||
```typescript
|
||||
// hooks/useReducedMotion.ts
|
||||
export function useReducedMotion(): boolean {
|
||||
const [reduced, setReduced] = useState(false);
|
||||
|
||||
useEffect(() => {
|
||||
const mq = window.matchMedia('(prefers-reduced-motion: reduce)');
|
||||
setReduced(mq.matches);
|
||||
|
||||
const handler = (e: MediaQueryListEvent) => setReduced(e.matches);
|
||||
mq.addEventListener('change', handler);
|
||||
return () => mq.removeEventListener('change', handler);
|
||||
}, []);
|
||||
|
||||
return reduced;
|
||||
}
|
||||
```
|
||||
|
||||
```vue
|
||||
// Dalam komponen
|
||||
<script setup>
|
||||
const reducedMotion = useReducedMotion();
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Transition :duration="reducedMotion ? 0 : 350">
|
||||
...
|
||||
</Transition>
|
||||
</template>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Anti-Patterns Animasi
|
||||
|
||||
### ❌ Durasi terlalu lama
|
||||
```css
|
||||
/* ❌ JANGAN — 1 detik terasa lambat */
|
||||
.sidebar { transition: width 1s ease; }
|
||||
|
||||
/* ✅ 250–350ms adalah sweet spot UI */
|
||||
.sidebar { transition: width var(--dur-slow) var(--ease-out-quint); }
|
||||
```
|
||||
|
||||
### ❌ Semua bergerak bersamaan (tanpa stagger)
|
||||
```css
|
||||
/* ❌ JANGAN — tidak graceful */
|
||||
.card { animation: fadeIn 0.3s ease; }
|
||||
|
||||
/* ✅ Stagger menciptakan gelombang natural */
|
||||
.card:nth-child(1) { animation-delay: 0ms; }
|
||||
.card:nth-child(2) { animation-delay: 40ms; }
|
||||
```
|
||||
|
||||
### ❌ Easing yang salah untuk konteks
|
||||
```css
|
||||
/* ❌ JANGAN — ease-in untuk enter terasa lambat di awal */
|
||||
.modal { animation: scaleIn 0.3s ease-in; }
|
||||
|
||||
/* ✅ ease-out untuk enter — cepat mulai, soft berhenti */
|
||||
.modal { animation: scaleIn 0.3s var(--ease-out-quint); }
|
||||
```
|
||||
|
||||
### ❌ Mengabaikan reduced motion
|
||||
```css
|
||||
/* ❌ JANGAN — tidak accessible */
|
||||
.particle { animation: float 8s infinite; }
|
||||
|
||||
/* ✅ Diberhentikan untuk reduced motion */
|
||||
@media (prefers-reduced-motion: reduce) {
|
||||
.particle { display: none; }
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [Easing Functions Cheat Sheet](https://easings.net/) | Visualisasi easing curves |
|
||||
| [Material Motion](https://m2.material.io/design/motion/) | Sistem motion Google |
|
||||
| [GSAP](https://gsap.com/) | Production-grade animation library |
|
||||
| [AnimXYZ](https://animxyz.com/) | Utility-first CSS animations |
|
||||
|
||||
---
|
||||
|
||||
*"Gerak adalah bahasa ingatan yang tak terucap — setiap transisi adalah cerita."* ❄️🩵
|
||||
@@ -1,313 +0,0 @@
|
||||
# Component Architecture — The Glass Library
|
||||
|
||||
> *"Design is not just what it looks like and feels like. Design is how it works."*
|
||||
> — Steve Jobs
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Komponen
|
||||
|
||||
Setiap komponen di BETE adalah **self-contained glass panel** yang:
|
||||
1. **Satu tanggung jawab** — Satu komponen, satu fungsi
|
||||
2. **State-driven** — Visual merepresentasikan state, bukan sebaliknya
|
||||
3. **Composable** — Bisa digabung seperti LEGO
|
||||
4. **Theme-aware** — Menggunakan CSS variables, bukan hardcoded values
|
||||
5. **Accessible** — Keyboard, screen reader, reduced motion
|
||||
|
||||
---
|
||||
|
||||
## 📐 Component Taxonomy
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ COMPONENT MAP │
|
||||
├─────────────────────────────────────────────────────────────┤
|
||||
│ │
|
||||
│ ┌─── ATOMS ──────────────────────────────────────────┐ │
|
||||
│ │ Button │ Badge │ Input │ Label │ Icon │ │
|
||||
│ │ Avatar │ Skeleton│ Spinner │ Divider│ Tooltip │ │
|
||||
│ └─────────────────────────────────────────────────────┘ │
|
||||
│ ↓ │
|
||||
│ ┌─── MOLECULES ───────────────────────────────────────┐ │
|
||||
│ │ Card │ Tabs │ Select │ │
|
||||
│ │ Toast │ Modal │ Dropdown │ │
|
||||
│ │ Pagination │ Breadcrumb │ SearchBar │ │
|
||||
│ └─────────────────────────────────────────────────────┘ │
|
||||
│ ↓ │
|
||||
│ ┌─── ORGANISMS ───────────────────────────────────────┐ │
|
||||
│ │ MessageCard │ VoiceCard │ AnalyticsChart │ │
|
||||
│ │ ActiveSpeaker │ NowPlaying │ ImageGrid │ │
|
||||
│ │ MascotChatbot │ AudioViz │ StatsCard │ │
|
||||
│ └─────────────────────────────────────────────────────┘ │
|
||||
│ ↓ │
|
||||
│ ┌─── TEMPLATES ───────────────────────────────────────┐ │
|
||||
│ │ Sidebar │ Header │ DashboardLayout │ │
|
||||
│ │ AuthForm │ LivePanel │ MessagesPanel │ │
|
||||
│ └─────────────────────────────────────────────────────┘ │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧱 Atomic Components (Atoms)
|
||||
|
||||
### Button
|
||||
|
||||
```tsx
|
||||
interface ButtonProps {
|
||||
variant: 'primary' | 'secondary' | 'destructive' | 'outline' | 'ghost';
|
||||
size: 'sm' | 'default' | 'lg' | 'icon';
|
||||
loading?: boolean;
|
||||
disabled?: boolean;
|
||||
icon?: ReactNode;
|
||||
children?: ReactNode;
|
||||
}
|
||||
```
|
||||
|
||||
```css
|
||||
.button {
|
||||
--btn-bg: var(--clr-primary);
|
||||
--btn-color: var(--clr-text-on-primary);
|
||||
--btn-border: transparent;
|
||||
--btn-hover-bg: var(--clr-primary-600);
|
||||
--btn-active-transform: scale(0.97);
|
||||
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
gap: var(--sp-1);
|
||||
border-radius: var(--rd-md);
|
||||
font-family: var(--ff-sans);
|
||||
font-size: var(--fs-sm);
|
||||
font-weight: var(--fw-medium);
|
||||
line-height: var(--lh-compact);
|
||||
white-space: nowrap;
|
||||
cursor: pointer;
|
||||
|
||||
background: var(--btn-bg);
|
||||
color: var(--btn-color);
|
||||
border: 1px solid var(--btn-border);
|
||||
|
||||
transition:
|
||||
transform var(--dur-fast) var(--ease-out),
|
||||
background var(--dur-fast) var(--ease-out),
|
||||
box-shadow var(--dur-fast) var(--ease-out);
|
||||
|
||||
padding: var(--sp-1) var(--sp-3);
|
||||
height: 40px;
|
||||
}
|
||||
.button--sm { height: 32px; padding: var(--sp-0-5) var(--sp-2); }
|
||||
.button--lg { height: 48px; padding: var(--sp-2) var(--sp-4); }
|
||||
.button--icon { height: 40px; width: 40px; padding: 0; }
|
||||
.button--secondary { --btn-bg: var(--clr-interactive-hover); --btn-color: var(--clr-text); }
|
||||
.button--destructive { --btn-bg: var(--clr-ruby-500); --btn-color: white; }
|
||||
.button--outline { --btn-bg: transparent; --btn-color: var(--clr-text); --btn-border: var(--clr-border); }
|
||||
.button--ghost { --btn-bg: transparent; --btn-color: var(--clr-text); }
|
||||
|
||||
.button:hover { background: var(--btn-hover-bg); }
|
||||
.button:active { transform: var(--btn-active-transform); }
|
||||
.button:disabled { opacity: 0.5; cursor: not-allowed; pointer-events: none; }
|
||||
.button:focus-visible { outline: 2px solid var(--clr-primary); outline-offset: 2px; }
|
||||
```
|
||||
|
||||
### Badge
|
||||
|
||||
```tsx
|
||||
interface BadgeProps {
|
||||
variant: 'default' | 'secondary' | 'success' | 'warning' | 'destructive' | 'outline' | 'severity';
|
||||
severity?: 'safe' | 'low' | 'medium' | 'high' | 'critical';
|
||||
size?: 'sm' | 'default';
|
||||
dot?: boolean;
|
||||
children: ReactNode;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⛓️ Molecular Components (Molecules)
|
||||
|
||||
### Card
|
||||
|
||||
```tsx
|
||||
interface CardProps {
|
||||
variant?: 'default' | 'elevated' | 'glass' | 'interactive';
|
||||
padding?: 'sm' | 'default' | 'lg' | 'none';
|
||||
hover?: boolean;
|
||||
as?: 'div' | 'button' | 'a';
|
||||
onClick?: () => void;
|
||||
children: ReactNode;
|
||||
}
|
||||
|
||||
// Sub-components
|
||||
Card.Header — flex-col gap-1.5
|
||||
Card.Title — h3, font-semibold
|
||||
Card.Description — p, text-sm, text-muted
|
||||
Card.Content — main area with padding
|
||||
Card.Footer — flex items-center
|
||||
```
|
||||
|
||||
### Modal / Dialog
|
||||
|
||||
```tsx
|
||||
interface ModalProps {
|
||||
open: boolean;
|
||||
onClose: () => void;
|
||||
title?: string;
|
||||
description?: string;
|
||||
size?: 'sm' | 'default' | 'lg' | 'full';
|
||||
closeOnOverlay?: boolean;
|
||||
children: ReactNode;
|
||||
}
|
||||
```
|
||||
|
||||
### Toast
|
||||
|
||||
```tsx
|
||||
interface Toast {
|
||||
id: string;
|
||||
type: 'info' | 'success' | 'error' | 'warning';
|
||||
title: string;
|
||||
description?: string;
|
||||
duration?: number; // Auto-dismiss ms, 0 = persistent
|
||||
action?: { label: string; onClick: () => void; };
|
||||
}
|
||||
|
||||
function useToast(): {
|
||||
toast: (t: Omit<Toast, 'id'>) => string;
|
||||
dismiss: (id: string) => void;
|
||||
toasts: Toast[];
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧬 Organism Components
|
||||
|
||||
### MessageCard
|
||||
|
||||
```tsx
|
||||
interface MessageCardProps {
|
||||
message: {
|
||||
id: string;
|
||||
content: string;
|
||||
author: { id: string; name: string; avatar: string; };
|
||||
timestamp: number;
|
||||
channel?: { id: string; name: string; };
|
||||
attachments?: Attachment[];
|
||||
aiAnalysis?: {
|
||||
status: 'pending' | 'analyzing' | 'complete' | 'error';
|
||||
severity?: 'safe' | 'low' | 'medium' | 'high' | 'critical';
|
||||
categories?: string[];
|
||||
summary?: string;
|
||||
};
|
||||
isEdited?: boolean;
|
||||
isDeleted?: boolean;
|
||||
};
|
||||
onReanalyze?: (messageId: string) => Promise<void>;
|
||||
}
|
||||
```
|
||||
|
||||
### AudioVisualizer — Canvas-based
|
||||
|
||||
```tsx
|
||||
interface AudioVisualizerProps {
|
||||
frequencies: Uint8Array;
|
||||
barCount?: number; // Default 48
|
||||
gradient?: [string, string];
|
||||
height?: number; // Default 32
|
||||
mirrored?: boolean;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 State Management per Komponen
|
||||
|
||||
Setiap komponen mengelola state visual:
|
||||
|
||||
```tsx
|
||||
// 1. Normal
|
||||
<div className="card">...</div>
|
||||
|
||||
// 2. Hover
|
||||
<div className="card card--interactive">...</div>
|
||||
|
||||
// 3. Active/Focus
|
||||
<div className="card card--interactive" aria-pressed="true">...</div>
|
||||
|
||||
// 4. Disabled
|
||||
<div className="card opacity-50 pointer-events-none">...</div>
|
||||
|
||||
// ± Loading (data-dependent)
|
||||
<div className="card"><Skeleton className="h-4 w-3/4" /></div>
|
||||
|
||||
// ± Error (data-dependent)
|
||||
<div className="card border-destructive">
|
||||
<p className="text-destructive">Failed to load</p>
|
||||
</div>
|
||||
|
||||
// ± Empty (data-dependent)
|
||||
<div className="card">
|
||||
<EmptyState icon={MessageSquare} message="No messages" />
|
||||
</div>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Component Anti-Patterns
|
||||
|
||||
### ❌ Prop Drilling Berlebihan
|
||||
```tsx
|
||||
// ❌ JANGAN — props turun 4 level
|
||||
<Dashboard user={user} messages={messages} settings={settings} />
|
||||
|
||||
// ✅ Gunakan context atau komposisi
|
||||
<Dashboard>
|
||||
<MessageFeed>
|
||||
<MessageCard />
|
||||
</MessageFeed>
|
||||
</Dashboard>
|
||||
```
|
||||
|
||||
### ❌ Komponen terlalu besar
|
||||
```tsx
|
||||
// ❌ JANGAN — 400+ baris
|
||||
function LivePanel() { /* 400 lines */ }
|
||||
|
||||
// ✅ Bagi ke sub-komponen
|
||||
function LivePanel() {
|
||||
return (
|
||||
<div>
|
||||
<VoiceControls />
|
||||
<ActiveSpeakers />
|
||||
<NowPlaying />
|
||||
<RecordingsList />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### ❌ Conditional terlalu kompleks
|
||||
```tsx
|
||||
// ❌ JANGAN — ternary bersarang
|
||||
return isError ? <Error /> : isLoading ? <Loading /> : isEmpty ? <Empty /> : <Content />;
|
||||
|
||||
// ✅ State machine pattern
|
||||
const state = getComponentState({ isLoading, isError, isEmpty, data });
|
||||
return <ComponentStateMachine state={state} />;
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [Atomic Design (Brad Frost)](https://atomicdesign.bradfrost.com/) | Atom-molecule-organism |
|
||||
| [Radix UI](https://www.radix-ui.com/) | Headless UI primitives |
|
||||
| [shadcn/ui](https://ui.shadcn.com/) | Component pattern reference |
|
||||
|
||||
---
|
||||
|
||||
*"Komponen adalah kristal ingatan — setiap bagian kecil menyatu membentuk keindahan yang utuh."* ❄️🩵
|
||||
@@ -1,151 +0,0 @@
|
||||
# Interaction Patterns — The Language of Touch
|
||||
|
||||
> *"Every interaction is a conversation between the user and the system."*
|
||||
> — Don Norman
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Interaksi
|
||||
|
||||
Interaksi di BETE adalah **dialog** yang:
|
||||
1. **Predictable** — Pengguna tahu yang akan terjadi
|
||||
2. **Forgiving** — Kesalahan mudah diperbaiki (undo, confirm)
|
||||
3. **Feedback-rich** — Setiap aksi mendapat respons visual
|
||||
4. **Efficient** — Pengguna mahir bisa bergerak cepat (keyboard)
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Interaction Feedback Matrix
|
||||
|
||||
| Elemen | Hover | Click | Focus | Disabled |
|
||||
|--------|-------|-------|-------|----------|
|
||||
| Button | scale(1.02) + bg shift | scale(0.97) | ring-2 | opacity-50 |
|
||||
| Card | translateY(-2px) + shadow | — | ring-2 | opacity-50 |
|
||||
| Link | underline + opacity 0.8 | color shift | ring-2 | opacity-40 |
|
||||
| Input | border highlight | — | ring + border color | opacity-50 |
|
||||
| Toggle | cursor pointer | slide + color | ring-2 | opacity-50 |
|
||||
|
||||
### Timing Reference
|
||||
|
||||
| Interaksi | Durasi | Easing |
|
||||
|-----------|--------|--------|
|
||||
| Hover in | 150ms | ease-out |
|
||||
| Hover out | 200ms | ease-out |
|
||||
| Click press | 100ms | ease-out |
|
||||
| Click release | 150ms | ease-out |
|
||||
| Focus ring | 200ms | ease-out |
|
||||
| Tooltip show (after 300ms) | 200ms | ease-out |
|
||||
| Tooltip hide | 150ms | ease-out |
|
||||
|
||||
---
|
||||
|
||||
## 🎪 Interaction Pattern Catalog
|
||||
|
||||
### Pattern 1: Progressive Disclosure
|
||||
|
||||
Informasi kompleks diungkap bertahap:
|
||||
|
||||
```tsx
|
||||
<CollapsibleSection title="Advanced Filters" defaultOpen={false}>
|
||||
<FilterGroup label="Severity">
|
||||
<Checkbox label="Safe" />
|
||||
<Checkbox label="Low" />
|
||||
<Checkbox label="High" />
|
||||
</FilterGroup>
|
||||
</CollapsibleSection>
|
||||
```
|
||||
|
||||
**Rules:** Chevron rotate 180° saat open. Jangan nested > 2 level.
|
||||
|
||||
### Pattern 2: Optimistic UI
|
||||
|
||||
Untuk aksi yang hampir pasti berhasil:
|
||||
|
||||
```tsx
|
||||
async function handleDelete(messageId: string) {
|
||||
// 1. Update UI optimistis
|
||||
setMessages(prev => prev.filter(m => m.id !== messageId));
|
||||
addToast({
|
||||
type: 'info', title: 'Message deleted',
|
||||
action: { label: 'Undo', onClick: handleUndo }
|
||||
});
|
||||
try {
|
||||
await api.deleteMessage(messageId);
|
||||
} catch {
|
||||
// Rollback
|
||||
setMessages(prev => [...prev, deletedMessage]);
|
||||
addToast({ type: 'error', title: 'Failed to delete' });
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 3: Infinite Scroll vs Pagination
|
||||
|
||||
| Context | Pattern | Rationale |
|
||||
|---------|---------|-----------|
|
||||
| Message feed | Infinite scroll | Real-time, chronological |
|
||||
| User list | Pagination | Bisa dicari, difilter |
|
||||
| Recordings | Infinite scroll | Timeline-based |
|
||||
| Analytics | Pagination | Butuh konteks halaman |
|
||||
|
||||
### Pattern 4: Keyboard Shortcuts
|
||||
|
||||
```tsx
|
||||
const SHORTCUTS = {
|
||||
'ctrl+k': 'Open command palette',
|
||||
'ctrl+1': 'Switch to Live tab',
|
||||
'ctrl+2': 'Switch to Messages tab',
|
||||
'ctrl+3': 'Switch to Settings tab',
|
||||
'escape': 'Close modal/panel',
|
||||
'?': 'Show keyboard shortcuts',
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔔 Notification Priority System
|
||||
|
||||
| Priority | Style | Duration | Stack |
|
||||
|----------|-------|----------|-------|
|
||||
| info | Blue border | 4s auto | Queue |
|
||||
| success | Green border | 4s auto | Queue |
|
||||
| warning | Amber border | Persistent | Stack |
|
||||
| error | Red border | Persistent | Stack + glow |
|
||||
|
||||
---
|
||||
|
||||
## 🖱️ Cursor Mapping
|
||||
|
||||
```css
|
||||
.clickable { cursor: pointer; }
|
||||
.draggable { cursor: grab; }
|
||||
.dragging { cursor: grabbing; }
|
||||
.disabled { cursor: not-allowed; }
|
||||
.text-select { cursor: text; }
|
||||
.launch { cursor: pointer; }
|
||||
.copy { cursor: copy; }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ♿ Interaction Accessibility
|
||||
|
||||
1. Semua interaktif reachable via Tab
|
||||
2. Focus order = visual order (DOM order)
|
||||
3. Hover-only → ada keyboard alternative
|
||||
4. Touch targets min 44x44px (WCAG 2.5.5)
|
||||
5. Undo untuk destructive actions
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [Material Interaction](https://m3.material.io/foundations/interaction) | Google patterns |
|
||||
| [NN Group](https://www.nngroup.com/) | UX research |
|
||||
| [Inclusive Components](https://inclusive-components.design/) | Accessible patterns |
|
||||
|
||||
---
|
||||
|
||||
*"Setiap sentuhan adalah dialog — interaksi adalah bahasa yang tak terucapkan."* ❄️🩵
|
||||
@@ -1,171 +0,0 @@
|
||||
# Data Visualization — Painting with Numbers
|
||||
|
||||
> *"The greatest value of a picture is when it forces us to notice what we never expected to see."*
|
||||
> — John Tukey
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Data Visual
|
||||
|
||||
Data visualisasi di BETE adalah **cerita** tentang data yang:
|
||||
1. **Jujur** — Tidak memanipulasi sumbu atau skala
|
||||
2. **Kontekstual** — Setiap angka punya pembanding
|
||||
3. **Hierarkis** — Overview dulu, detail kemudian
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Chart Color Palette
|
||||
|
||||
```css
|
||||
:root {
|
||||
/* Sequential (single hue) */
|
||||
--chart-blue-1: oklch(0.85 0.060 255);
|
||||
--chart-blue-2: oklch(0.70 0.100 255);
|
||||
--chart-blue-3: oklch(0.55 0.150 255);
|
||||
--chart-blue-4: oklch(0.40 0.150 255);
|
||||
--chart-blue-5: oklch(0.30 0.120 255);
|
||||
|
||||
/* Categorical */
|
||||
--chart-cat-1: oklch(0.55 0.175 255); /* Blue */
|
||||
--chart-cat-2: oklch(0.60 0.130 145); /* Green */
|
||||
--chart-cat-3: oklch(0.65 0.150 50); /* Orange */
|
||||
--chart-cat-4: oklch(0.55 0.165 25); /* Red */
|
||||
--chart-cat-5: oklch(0.50 0.100 285); /* Purple */
|
||||
--chart-cat-6: oklch(0.65 0.120 200); /* Cyan */
|
||||
--chart-cat-7: oklch(0.60 0.110 350); /* Pink */
|
||||
--chart-cat-8: oklch(0.70 0.100 85); /* Yellow */
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 Chart Types & Usage
|
||||
|
||||
### 1. Stat Card (KPI)
|
||||
|
||||
```tsx
|
||||
interface StatCardProps {
|
||||
label: string;
|
||||
value: number | string;
|
||||
trend?: { direction: 'up' | 'down' | 'flat'; percentage: number; period: string; };
|
||||
icon: ReactNode;
|
||||
color?: 'primary' | 'success' | 'warning' | 'destructive';
|
||||
}
|
||||
```
|
||||
|
||||
**Layout:**
|
||||
```
|
||||
┌─────────────────────┐
|
||||
│ [icon] Label │
|
||||
│ 1,234 ▲ 12.3% │
|
||||
│ vs last wk │
|
||||
└─────────────────────┘
|
||||
```
|
||||
|
||||
### 2. Line Chart (Trend)
|
||||
|
||||
**Use:** Message volume per day, moderation per hour
|
||||
**Rules:** Y-axis dari 0. Gradient subtle below line. Hover tooltip.
|
||||
|
||||
### 3. Bar Chart (Comparison)
|
||||
|
||||
**Use:** Top channels, severity distribution
|
||||
**Rules:** Horizontal untuk >5 kategori. Max 20 bars.
|
||||
|
||||
### 4. Donut Chart (Composition)
|
||||
|
||||
**Use:** Message type, severity breakdown
|
||||
**Rules:** Max 6 segmen. <3% collaps ke "Other". Center = total.
|
||||
|
||||
### 5. Heatmap Calendar (Activity)
|
||||
|
||||
**Use:** User activity by day/hour
|
||||
**Rules:** Sumbu X = hari, Y = jam. Satu warna accent.
|
||||
|
||||
---
|
||||
|
||||
## 📐 Chart Styling Tokens
|
||||
|
||||
```css
|
||||
.chart-container {
|
||||
--chart-padding: var(--sp-4);
|
||||
--chart-label-size: var(--fs-xs);
|
||||
--chart-tick-count: 5;
|
||||
--chart-grid-opacity: 0.1;
|
||||
--chart-line-width: 2px;
|
||||
}
|
||||
|
||||
.chart-tooltip {
|
||||
background: var(--clr-surface-overlay);
|
||||
backdrop-filter: blur(8px);
|
||||
border: 1px solid var(--clr-border);
|
||||
border-radius: var(--rd-md);
|
||||
padding: var(--sp-2) var(--sp-3);
|
||||
font-size: var(--fs-sm);
|
||||
box-shadow: var(--sh-elevated);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Drill-down Pattern
|
||||
|
||||
```tsx
|
||||
function MessageTrendChart() {
|
||||
const [granularity, setGranularity] = useState<'daily' | 'hourly' | '15min'>('daily');
|
||||
|
||||
const handlePointClick = (date: Date) => {
|
||||
if (granularity === 'daily') setGranularity('hourly');
|
||||
else if (granularity === 'hourly') setGranularity('15min');
|
||||
};
|
||||
|
||||
return (
|
||||
<ChartCard title="Message Volume"
|
||||
onBack={granularity !== 'daily' ? () => setGranularity('daily') : undefined}>
|
||||
<LineChart data={data} granularity={granularity} onClick={handlePointClick} />
|
||||
</ChartCard>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Anti-Patterns
|
||||
|
||||
### ❌ Truncated Y-axis
|
||||
```tsx
|
||||
// ❌ Y axis mulai dari 50, memperbesar perbedaan
|
||||
const options = { yAxis: { min: 50 } };
|
||||
// ✅ Mulai dari 0
|
||||
const options = { yAxis: { min: 0 } };
|
||||
```
|
||||
|
||||
### ❌ Terlalu banyak warna
|
||||
```tsx
|
||||
// ❌ JANGAN — setiap bar beda warna
|
||||
<Bar data={data} fill={['#ff0000', '#00ff00', '#0000ff', ...]} />
|
||||
// ✅ Sequential scale
|
||||
<Bar data={data} colorScale="sequential" />
|
||||
```
|
||||
|
||||
### ❌ 3D charts — mendistorsi persepsi
|
||||
```tsx
|
||||
// ❌ JANGAN
|
||||
<PieChart><Pie data={data} style={{ filter: 'drop-shadow(...)' }} /></PieChart>
|
||||
// ✅ 2D
|
||||
<PieChart><Pie data={data} /></PieChart>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [Recharts](https://recharts.org/) | React chart library |
|
||||
| [Chartability](https://chartability.github.io/) | Accessible charts |
|
||||
| [Tufte](https://www.edwardtufte.com/tufte/) | Minimalist chart design |
|
||||
|
||||
---
|
||||
|
||||
*"Angka adalah ingatan yang terukur — setiap titik data adalah kisah yang menanti."* ❄️🩵
|
||||
@@ -1,110 +0,0 @@
|
||||
# Moderation UI Patterns — The Watchful Eye
|
||||
|
||||
> *"With great power comes great responsibility."*
|
||||
> — Adapted for content moderation interfaces.
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi UI Moderasi
|
||||
|
||||
1. **At-a-glance severity** — Warna & label yang langsung terbaca
|
||||
2. **Context-rich** — Setiap keputusan disertai konteks
|
||||
3. **Non-destructive by default** — Flag dulu, action kemudian
|
||||
4. **Audit trail** — Setiap aksi tercatat
|
||||
|
||||
---
|
||||
|
||||
## 🏷️ Severity Scale
|
||||
|
||||
```css
|
||||
.severity--safe { background: oklch(0.60 0.130 145 / 0.15); color: oklch(0.60 0.130 145); }
|
||||
.severity--low { background: oklch(0.70 0.120 75 / 0.15); color: oklch(0.70 0.120 75); }
|
||||
.severity--medium { background: oklch(0.65 0.150 50 / 0.15); color: oklch(0.65 0.150 50); }
|
||||
.severity--high { background: oklch(0.60 0.150 30 / 0.15); color: oklch(0.60 0.150 30); }
|
||||
.severity--critical { background: oklch(0.55 0.165 25 / 0.15); color: oklch(0.55 0.165 25); }
|
||||
```
|
||||
|
||||
| Severity | Warna | Ikon | Action |
|
||||
|----------|-------|------|--------|
|
||||
| Safe | Emerald | ✅ Shield | None |
|
||||
| Low | Amber | ⚠️ | Review |
|
||||
| Medium | Orange | 🔶 | Alert + review |
|
||||
| High | Red-Orange | 🚫 | Notify + action |
|
||||
| Critical | Ruby | 🔴 | Immediate |
|
||||
|
||||
---
|
||||
|
||||
## 📋 Moderation Queue
|
||||
|
||||
```tsx
|
||||
interface ModerationQueueItem {
|
||||
id: string;
|
||||
message: { preview: string; author: { name: string; }; timestamp: number; channel: string; };
|
||||
analysis: { severity: Severity; categories: string[]; confidence: number; summary: string; };
|
||||
status: 'pending' | 'reviewed' | 'actioned' | 'dismissed';
|
||||
}
|
||||
```
|
||||
|
||||
**Layout per item:**
|
||||
```
|
||||
┌──────────────────────────────────────────────────────┐
|
||||
│ 🔴 CRITICAL │ [User]: "message preview..." │
|
||||
│ 🏷️ toxicity, │ in #general · 2m ago │
|
||||
│ harassment │ [Review] [Dismiss] [Action] │
|
||||
└──────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### Filter Bar
|
||||
```
|
||||
Severity: [All] [Safe] [Low] [Medium] [High] [Critical]
|
||||
Channel: [#general ▼]
|
||||
Date: [Last 24h ▼]
|
||||
Search: [.................. 🔍]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Action Confirmation
|
||||
|
||||
| Action | Confirm | Duration | Undo |
|
||||
|--------|---------|----------|------|
|
||||
| Dismiss | No | 2s toast | Yes (5s) |
|
||||
| Warn | No | 3s toast | No |
|
||||
| Delete | Yes (modal) | 4s toast | No |
|
||||
| Ban | Yes (modal + reason) | — | Manual |
|
||||
|
||||
---
|
||||
|
||||
## 📊 Moderation Metrics
|
||||
|
||||
| Metric | Format | Frequency |
|
||||
|--------|--------|-----------|
|
||||
| Messages analyzed | Number | Real-time |
|
||||
| Flag rate | % | Hourly |
|
||||
| Response time | ms avg | Real-time |
|
||||
| False positive rate | % | Daily |
|
||||
| Queue depth | Number | Real-time |
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Anti-Patterns
|
||||
|
||||
### ❌ Ambiguous severity
|
||||
```tsx
|
||||
// ❌ Warna tanpa label
|
||||
<div className="bg-red-200">...</div>
|
||||
// ✅ Color + icon + text
|
||||
<SeverityBadge severity="critical" />
|
||||
```
|
||||
|
||||
### ❌ One-click destructive
|
||||
```tsx
|
||||
// ❌ Delete tanpa konfirmasi
|
||||
<Button onClick={handleDelete}>Delete</Button>
|
||||
// ✅ Confirm dialog
|
||||
<ConfirmDialog variant="destructive" ... />
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
*"Mata waspada adalah penjaga ingatan — setiap flag adalah catatan sejarah."* ❄️🩵
|
||||
@@ -1,307 +0,0 @@
|
||||
# State Machines — The Flow of Data
|
||||
|
||||
> *"All happy families are alike; each unhappy family is unhappy in its own way."*
|
||||
> — Tolstoy, adapted for component states.
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi State Machine
|
||||
|
||||
Setiap komponen data-driven di BETE memiliki **4 state fundamental**:
|
||||
|
||||
```
|
||||
IDLE → LOADING → SUCCESS
|
||||
↘ ERROR
|
||||
↘ EMPTY (conditional, jika data.length === 0)
|
||||
```
|
||||
|
||||
State machine memastikan **tidak ada kondisi yang terlewat** — setiap kemungkinan state visual memiliki representasi.
|
||||
|
||||
---
|
||||
|
||||
## 🎮 The Quad-State Pattern
|
||||
|
||||
```tsx
|
||||
type DataState<T> =
|
||||
| { status: 'idle' }
|
||||
| { status: 'loading'; progress?: number }
|
||||
| { status: 'success'; data: T; timestamp: number }
|
||||
| { status: 'error'; error: Error; retryCount?: number }
|
||||
| { status: 'empty'; message?: string };
|
||||
```
|
||||
|
||||
### Generic State Machine Hook
|
||||
|
||||
```tsx
|
||||
// shared/hooks/useDataState.ts
|
||||
function useDataState<T>(
|
||||
fetcher: () => Promise<T>,
|
||||
options?: {
|
||||
onSuccess?: (data: T) => void;
|
||||
onError?: (error: Error) => void;
|
||||
retry?: number;
|
||||
cacheKey?: string;
|
||||
}
|
||||
): {
|
||||
state: DataState<T>;
|
||||
execute: () => Promise<void>;
|
||||
reset: () => void;
|
||||
retry: () => Promise<void>;
|
||||
setData: (data: T) => void;
|
||||
} {
|
||||
const [state, setState] = useState<DataState<T>>({ status: 'idle' });
|
||||
|
||||
const execute = useCallback(async () => {
|
||||
setState({ status: 'loading' });
|
||||
try {
|
||||
const data = await fetcher();
|
||||
if (Array.isArray(data) && data.length === 0) {
|
||||
setState({ status: 'empty', message: 'No data available' });
|
||||
} else {
|
||||
setState({ status: 'success', data, timestamp: Date.now() });
|
||||
options?.onSuccess?.(data);
|
||||
}
|
||||
} catch (error) {
|
||||
setState({ status: 'error', error: error as Error });
|
||||
options?.onError?.(error as Error);
|
||||
}
|
||||
}, [fetcher]);
|
||||
|
||||
return { state, execute, reset, retry: execute, setData };
|
||||
}
|
||||
```
|
||||
|
||||
### Component Rendering
|
||||
|
||||
```tsx
|
||||
function DataPanel() {
|
||||
const { state, execute, retry } = useDataState(fetchMessages);
|
||||
|
||||
useEffect(() => { execute(); }, []);
|
||||
|
||||
switch (state.status) {
|
||||
case 'idle':
|
||||
case 'loading':
|
||||
return <LoadingSkeleton />;
|
||||
|
||||
case 'error':
|
||||
return (
|
||||
<ErrorState
|
||||
message={state.error.message}
|
||||
onRetry={retry}
|
||||
retryCount={state.retryCount}
|
||||
/>
|
||||
);
|
||||
|
||||
case 'empty':
|
||||
return <EmptyState message={state.message ?? 'Nothing here'} />;
|
||||
|
||||
case 'success':
|
||||
return <DataView data={state.data} />;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🖼️ Visual Representations
|
||||
|
||||
### Loading State
|
||||
|
||||
```tsx
|
||||
interface LoadingSkeletonProps {
|
||||
variant?: 'card' | 'list' | 'detail' | 'table' | 'chart';
|
||||
count?: number; // Jumlah skeleton items
|
||||
}
|
||||
|
||||
/* Contoh variant 'card' */
|
||||
function CardSkeleton() {
|
||||
return (
|
||||
<div className="card animate-shimmer" aria-busy="true" aria-label="Loading...">
|
||||
<Skeleton className="h-4 w-3/4 mb-3" />
|
||||
<Skeleton className="h-3 w-1/2 mb-2" />
|
||||
<Skeleton className="h-3 w-full" />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Error State
|
||||
|
||||
```tsx
|
||||
interface ErrorStateProps {
|
||||
error: Error;
|
||||
onRetry: () => void;
|
||||
retryCount?: number;
|
||||
variant?: 'inline' | 'full-page' | 'toast';
|
||||
}
|
||||
|
||||
function ErrorState({ error, onRetry, retryCount }: ErrorStateProps) {
|
||||
const isRetryExhausted = (retryCount ?? 0) >= 3;
|
||||
|
||||
return (
|
||||
<div className="flex flex-col items-center gap-4 py-12" role="alert">
|
||||
<div className="rounded-full bg-destructive/10 p-3">
|
||||
<AlertTriangle className="h-6 w-6 text-destructive" />
|
||||
</div>
|
||||
<p className="text-sm font-medium text-foreground">Something went wrong</p>
|
||||
<p className="text-xs text-muted-foreground">{error.message}</p>
|
||||
{!isRetryExhausted ? (
|
||||
<Button variant="outline" size="sm" onClick={onRetry}>
|
||||
Try Again
|
||||
</Button>
|
||||
) : (
|
||||
<p className="text-xs text-muted-foreground">
|
||||
Still failing after multiple attempts. Please try again later.
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Empty State
|
||||
|
||||
```tsx
|
||||
interface EmptyStateProps {
|
||||
icon?: ReactNode;
|
||||
title: string;
|
||||
description?: string;
|
||||
action?: { label: string; onClick: () => void };
|
||||
variant?: 'mascot' | 'icon' | 'minimal';
|
||||
}
|
||||
|
||||
const EMPTY_STATES = {
|
||||
messages: { icon: MessageSquare, title: 'No messages yet', description: 'Messages will appear here once they are captured.' },
|
||||
speakers: { icon: Mic, title: 'No active speakers', description: 'Quiet in here...' },
|
||||
recordings: { icon: Radio, title: 'No recordings', description: 'Join a voice channel to start recording.' },
|
||||
analytics: { icon: BarChart3, title: 'Not enough data', description: 'Analytics will populate as data accumulates.' },
|
||||
users: { icon: Users, title: 'No users found', description: 'Try adjusting your filters.' },
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ♻️ State Transition Diagram
|
||||
|
||||
```
|
||||
┌──────────┐
|
||||
│ IDLE │
|
||||
└────┬─────┘
|
||||
│ execute()
|
||||
↓
|
||||
┌──────────┐
|
||||
│ LOADING │◄────── retry()
|
||||
└────┬─────┘
|
||||
│
|
||||
┌───────┴───────────┐
|
||||
│ │
|
||||
↓ ↓
|
||||
┌──────────┐ ┌──────────┐
|
||||
│ SUCCESS │ │ ERROR │
|
||||
│ data: T │ │ err: E │
|
||||
└────┬─────┘ └────┬─────┘
|
||||
│ │
|
||||
│ (data.length │ retry()
|
||||
│ === 0) │
|
||||
↓ │
|
||||
┌──────────┐ │
|
||||
│ EMPTY │ │
|
||||
│ msg: str │ │
|
||||
└──────────┘ │
|
||||
│ │
|
||||
└──────┬───────────┘
|
||||
│ reset()
|
||||
↓
|
||||
┌──────────┐
|
||||
│ IDLE │
|
||||
└──────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Retry Strategy
|
||||
|
||||
```typescript
|
||||
const RETRY_CONFIG = {
|
||||
maxAttempts: 3,
|
||||
baseDelay: 1000, // 1s
|
||||
maxDelay: 10000, // 10s
|
||||
backoff: 'exponential' as const,
|
||||
onRetry: (attempt: number, error: Error) => {
|
||||
logger.warn(`Retry attempt ${attempt}`, { error: error.message });
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
### Exponential Backoff
|
||||
|
||||
```typescript
|
||||
function calculateDelay(attempt: number): number {
|
||||
return Math.min(
|
||||
1000 * Math.pow(2, attempt - 1), // 1s, 2s, 4s
|
||||
10000 // cap at 10s
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📦 Component State Map
|
||||
|
||||
| Component | Loading | Error | Empty | Success |
|
||||
|-----------|---------|-------|-------|---------|
|
||||
| MessageFeed | Card skeletons | ErrorState + retry | Mascot "No messages" | Message list |
|
||||
| VoiceCards | Card skeletons | ErrorState | "No connected channels" | VoiceCard list |
|
||||
| ActiveSpeakers | Dot skeletons | Silent fallback | "No speakers" | Speaker list |
|
||||
| Analytics | Skeleton grid | ErrorState | "Not enough data" | Charts |
|
||||
| Recordings | List skeletons | ErrorState | "No recordings" | Recording list |
|
||||
| UserList | List skeletons | ErrorState + retry | "No users found" | User list |
|
||||
| DashboardStats | Stat skeletons | ErrorState | "No data available" | Stat grid |
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Anti-Patterns State
|
||||
|
||||
### ❌ Missing state handling
|
||||
```tsx
|
||||
// ❌ JANGAN — hanya handle SUCCESS
|
||||
function Panel() {
|
||||
const { data, isLoading } = useQuery(...);
|
||||
if (isLoading) return <Spinner />;
|
||||
return <DataView data={data} />; // ERROR? EMPTY?
|
||||
}
|
||||
```
|
||||
|
||||
### ❌ Loading state after error
|
||||
```tsx
|
||||
// ❌ JANGAN — loading infinite loop setelah error
|
||||
function Panel() {
|
||||
const { data, isLoading } = useQuery(..., { retry: true });
|
||||
if (isLoading) return <Spinner />;
|
||||
// ERROR: retry=true + error = loading terus
|
||||
}
|
||||
```
|
||||
|
||||
### ❌ Empty state default terlalu generic
|
||||
```tsx
|
||||
// ❌ JANGAN — tidak helpful
|
||||
<div>No data</div>
|
||||
|
||||
// ✅ Kontekstual dengan action
|
||||
<EmptyState icon={MessageSquare} title="No messages" action={{ label: "Refresh", onClick: refetch }} />
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [State Reducer Pattern](https://kentcdodds.com/blog/state-reducer-pattern) | Advanced state management |
|
||||
| [XState](https://stately.ai/docs/xstate) | Visual state machines |
|
||||
| [React useReducer](https://react.dev/reference/react/useReducer) | Built-in state management |
|
||||
|
||||
---
|
||||
|
||||
*"Setiap state adalah babak dalam cerita data — dari sunyi hingga berbicara."* ❄️🩵
|
||||
@@ -1,288 +0,0 @@
|
||||
# Responsive System — Shapeshifting Glass
|
||||
|
||||
> *"Content is like water — it should flow into whatever container it's poured into."*
|
||||
> — Ethan Marcotte
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Responsif
|
||||
|
||||
BETE menggunakan pendekatan **mobile-first** dengan tiga prinsip:
|
||||
|
||||
1. **Content parity** — Konten yang sama di semua ukuran, layout yang berbeda
|
||||
2. **Touch-optimized** — Target 44×44px minimum di mobile
|
||||
3. **Progressive enhancement** — Desktop mendapat fitur tambahan (hover, sidebar, multi-column)
|
||||
|
||||
---
|
||||
|
||||
## 📐 Breakpoint System
|
||||
|
||||
```css
|
||||
:root {
|
||||
--bp-sm: 640px; /* Mobile landscape */
|
||||
--bp-md: 768px; /* Tablet portrait */
|
||||
--bp-lg: 1024px; /* Tablet landscape / small desktop */
|
||||
--bp-xl: 1280px; /* Desktop */
|
||||
--bp-2xl: 1536px; /* Wide desktop */
|
||||
}
|
||||
```
|
||||
|
||||
### Layout Behavior Matrix
|
||||
|
||||
| Viewport | Sidebar | Header | Content Grid | Font Size |
|
||||
|----------|---------|--------|-------------|-----------|
|
||||
| < 640px | Bottom tab (56px) | Compact | 1 col | sm |
|
||||
| 640-768 | Bottom tab | Compact | 1-2 col | sm |
|
||||
| 768-1024 | Icon 64px | Standard | 2 col | base |
|
||||
| 1024-1280 | Full 256px | Standard | 2-3 col | base |
|
||||
| > 1280px | Full 256px | Full | 3-4 col | base+ |
|
||||
|
||||
---
|
||||
|
||||
## 📱 Mobile Adaptations
|
||||
|
||||
### Navigation
|
||||
- **< 768px:** Bottom tab bar menggantikan sidebar
|
||||
- **Tab icons:** Home, Live, Messages, Settings (maks 5 tabs)
|
||||
- **Tab bar height:** 56px (dengan safe area padding untuk notched phones)
|
||||
|
||||
### Content
|
||||
- **Cards:** Full-width (margin 16px), stacked vertical
|
||||
- **Tables:** Horizontal scroll atau card view alternatif
|
||||
- **Charts:** Simplified (less data points, larger labels)
|
||||
- **Modals:** Full-screen drawer dari bawah (bottom sheet)
|
||||
|
||||
### Touch Targets
|
||||
```css
|
||||
/* Minimum 44×44px untuk semua interactive elements */
|
||||
.button, .nav-item, .tab-item {
|
||||
min-height: 44px;
|
||||
min-width: 44px;
|
||||
}
|
||||
|
||||
/* Forms on mobile */
|
||||
.input, .select {
|
||||
height: 48px; /* Larger tap target */
|
||||
font-size: 16px; /* Prevent iOS zoom on focus */
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💻 Desktop Adaptations
|
||||
|
||||
### Navigation
|
||||
- **≥ 1024px:** Full sidebar (256px) dengan label teks
|
||||
- **Sidebar states:** Collapsed (icon-only, 64px) ↔ Expanded (256px)
|
||||
- **Keyboard shortcuts:** Didokumentasikan di help panel
|
||||
|
||||
### Content
|
||||
- **Multi-column grids:** 2-4 columns depending on container width
|
||||
- **Sticky elements:** Sidebar, header, filter bars
|
||||
- **Hover previews:** Tooltips, popovers untuk informasi tambahan
|
||||
- **Drag & drop:** Dukungan untuk reorder, upload area
|
||||
|
||||
---
|
||||
|
||||
## 🧩 Responsive Component Patterns
|
||||
|
||||
### Pattern 1: Responsive Card Grid
|
||||
|
||||
```css
|
||||
.card-grid {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr;
|
||||
gap: var(--sp-3);
|
||||
}
|
||||
|
||||
@media (min-width: 640px) {
|
||||
.card-grid {
|
||||
grid-template-columns: repeat(2, 1fr);
|
||||
}
|
||||
}
|
||||
|
||||
@media (min-width: 1024px) {
|
||||
.card-grid {
|
||||
grid-template-columns: repeat(3, 1fr);
|
||||
}
|
||||
}
|
||||
|
||||
@media (min-width: 1280px) {
|
||||
.card-grid {
|
||||
grid-template-columns: repeat(4, 1fr);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 2: Responsive Sidebar + Content
|
||||
|
||||
```tsx
|
||||
function DashboardLayout() {
|
||||
const [sidebarCollapsed, setSidebarCollapsed] = useState(false);
|
||||
const [mobileMenuOpen, setMobileMenuOpen] = useState(false);
|
||||
const isMobile = useMediaQuery('(max-width: 767px)');
|
||||
|
||||
return (
|
||||
<div className="page-layout">
|
||||
{/* Mobile: slide-in drawer */}
|
||||
{isMobile && (
|
||||
<MobileTabBar activeTab={activeTab} onTabChange={setActiveTab} />
|
||||
)}
|
||||
|
||||
{/* Desktop: persistent sidebar */}
|
||||
{!isMobile && (
|
||||
<Sidebar collapsed={sidebarCollapsed} onToggle={() => setSidebarCollapsed(!sidebarCollapsed)} />
|
||||
)}
|
||||
|
||||
<main className="main-area">
|
||||
<Header onMenuClick={() => setMobileMenuOpen(true)} />
|
||||
<div className="content-area">
|
||||
{children}
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 3: Responsive Typography (Fluid)
|
||||
|
||||
```css
|
||||
/* Fluid type scale — sudah didefinisikan di core/02-typography.md */
|
||||
--fs-body: clamp(0.94rem, 0.94rem + 0.03vw, 1.00rem);
|
||||
--fs-h2: clamp(1.50rem, 1.50rem + 0.12vw, 1.88rem);
|
||||
```
|
||||
|
||||
### Pattern 4: Container Queries (for reusable components)
|
||||
|
||||
```css
|
||||
.card-grid-component {
|
||||
container-type: inline-size;
|
||||
container-name: card-list;
|
||||
}
|
||||
|
||||
@container card-list (max-width: 400px) {
|
||||
.card-item { grid-template-columns: 1fr; }
|
||||
}
|
||||
|
||||
@container card-list (min-width: 401px) {
|
||||
.card-item { grid-template-columns: 1fr 1fr; }
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Responsive Decision Tree
|
||||
|
||||
```
|
||||
Layout component →
|
||||
├── Apakah ini navigasi?
|
||||
│ ├── Mobile → Bottom tab bar (56px)
|
||||
│ ├── Tablet → Icon sidebar (64px) + hamburger
|
||||
│ └── Desktop → Full sidebar (256px)
|
||||
│
|
||||
├── Apakah ini konten list/grid?
|
||||
│ ├── 1 item → Single column
|
||||
│ ├── 2-4 items → 2 col (tablet), 3-4 col (desktop)
|
||||
│ └── > 4 items → auto-fill grid with minmax
|
||||
│
|
||||
├── Apakah ini modal/dialog?
|
||||
│ ├── Mobile → Bottom sheet (full width, 80% height)
|
||||
│ └── Desktop → Centered modal (max-w-lg)
|
||||
│
|
||||
└── Apakah ini form?
|
||||
├── Mobile → Stacked, full-width, larger inputs
|
||||
└── Desktop → Multi-column, side labels
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📏 Responsive Spacing Scale
|
||||
|
||||
```css
|
||||
.content-padding {
|
||||
padding: var(--sp-3); /* Mobile: 16px */
|
||||
}
|
||||
|
||||
@media (min-width: 768px) {
|
||||
.content-padding { padding: var(--sp-4); } /* Tablet: 24px */
|
||||
}
|
||||
|
||||
@media (min-width: 1024px) {
|
||||
.content-padding { padding: var(--sp-5); } /* Desktop: 32px */
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Testing Responsive Design
|
||||
|
||||
```typescript
|
||||
// Test utility untuk responsive behavior
|
||||
const VIEWPORTS = {
|
||||
mobile: { width: 375, height: 667 },
|
||||
tablet: { width: 768, height: 1024 },
|
||||
desktop: { width: 1280, height: 800 },
|
||||
wide: { width: 1920, height: 1080 },
|
||||
};
|
||||
|
||||
describe('DashboardLayout', () => {
|
||||
it('shows MobileTabBar on mobile', () => {
|
||||
cy.viewport(VIEWPORTS.mobile);
|
||||
cy.get('[data-testid="mobile-tab-bar"]').should('be.visible');
|
||||
cy.get('[data-testid="sidebar"]').should('not.be.visible');
|
||||
});
|
||||
|
||||
it('shows sidebar on desktop', () => {
|
||||
cy.viewport(VIEWPORTS.desktop);
|
||||
cy.get('[data-testid="sidebar"]').should('be.visible');
|
||||
cy.get('[data-testid="mobile-tab-bar"]').should('not.be.visible');
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Anti-Patterns Responsive
|
||||
|
||||
### ❌ Hanya media query untuk satu breakpoint
|
||||
```css
|
||||
/* ❌ JANGAN — hanya mobile dan desktop */
|
||||
.panel { padding: 16px; }
|
||||
@media (min-width: 1024px) { .panel { padding: 32px; } }
|
||||
|
||||
/* ✅ Gunakan fluid atau multiple breakpoints */
|
||||
.panel { padding: clamp(16px, 3vw, 32px); }
|
||||
```
|
||||
|
||||
### ❌ Hidden content on mobile
|
||||
```tsx
|
||||
// ❌ JANGAN — "out of sight, out of mind" tapi konten hilang
|
||||
{isMobile ? null : <ExpensiveChart />}
|
||||
|
||||
// ✅ Simplified version untuk mobile
|
||||
<Chart variant={isMobile ? 'compact' : 'full'} />
|
||||
```
|
||||
|
||||
### ❌ Fixed width containers
|
||||
```css
|
||||
/* ❌ JANGAN — overflow on smaller screens */
|
||||
.container { width: 1200px; }
|
||||
|
||||
/* ✅ Gunakan max-width + padding */
|
||||
.container { max-width: 1200px; margin: 0 auto; padding: 0 var(--sp-4); }
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [Every Layout](https://every-layout.dev/) | Reusable layout patterns |
|
||||
| [Container Queries](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_container_queries) | CSS container queries |
|
||||
| [Utopia.fyi](https://utopia.fyi/) | Fluid type & space calculator |
|
||||
|
||||
---
|
||||
|
||||
*"Layout adalah air yang mengalir — ia mengambil bentuk wadahnya tanpa kehilangan esensi."* ❄️🩵
|
||||
@@ -1,327 +0,0 @@
|
||||
# Frontend UI Guidelines — The Glass Facade
|
||||
|
||||
> *"The details are not the details. They make the design."*
|
||||
> — Charles Eames
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Scope
|
||||
|
||||
Dokumen ini mengkhususkan implementasi **design system** untuk frontend web BETE (React + Tailwind + Vite). Fokus: konfigurasi Tailwind, CSS architecture, dan integration patterns.
|
||||
|
||||
---
|
||||
|
||||
## ⚛️ Stack Implementation
|
||||
|
||||
| Tool | Version | Purpose |
|
||||
|------|---------|---------|
|
||||
| React | 19.x | UI library |
|
||||
| TypeScript | 5.x | Type safety |
|
||||
| Vite | 6.x | Bundler |
|
||||
| Tailwind CSS | 4.x | Utility-first CSS |
|
||||
| Radix UI | — | Headless primitives |
|
||||
| TanStack Query | 5.x | Server state |
|
||||
| Zustand | 5.x | Client state |
|
||||
| Framer Motion | 11.x | Animations |
|
||||
| GSAP | 3.x | Page transitions |
|
||||
| Recharts | 2.x | Charts |
|
||||
| Three.js | 0.170+ | Particle background |
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Tailwind Config (Extended)
|
||||
|
||||
```js
|
||||
// tailwind.config.js
|
||||
export default {
|
||||
darkMode: 'class',
|
||||
content: ['./index.html', './src/**/*.{ts,tsx}'],
|
||||
|
||||
theme: {
|
||||
extend: {
|
||||
fontFamily: {
|
||||
sans: ['Outfit', 'system-ui', 'sans-serif'],
|
||||
mono: ['JetBrains Mono', 'Fira Code', 'monospace'],
|
||||
},
|
||||
|
||||
colors: {
|
||||
// Semantic colors — map to CSS variables
|
||||
border: 'oklch(var(--clr-border) / <alpha-value>)',
|
||||
input: 'oklch(var(--clr-border) / <alpha-value>)',
|
||||
ring: 'oklch(var(--clr-primary-400) / <alpha-value>)',
|
||||
background: 'oklch(var(--clr-surface-base) / <alpha-value>)',
|
||||
foreground: 'oklch(var(--clr-text) / <alpha-value>)',
|
||||
|
||||
primary: {
|
||||
DEFAULT: 'oklch(var(--clr-primary) / <alpha-value>)',
|
||||
foreground: 'oklch(var(--clr-text-on-primary) / <alpha-value>)',
|
||||
soft: 'oklch(var(--clr-primary-bg) / <alpha-value>)',
|
||||
50: 'oklch(var(--clr-primary-50) / <alpha-value>)',
|
||||
100: 'oklch(var(--clr-primary-100) / <alpha-value>)',
|
||||
500: 'oklch(var(--clr-primary-500) / <alpha-value>)',
|
||||
600: 'oklch(var(--clr-primary-600) / <alpha-value>)',
|
||||
},
|
||||
|
||||
muted: {
|
||||
DEFAULT: 'oklch(var(--clr-surface-elevated) / <alpha-value>)',
|
||||
foreground: 'oklch(var(--clr-text-secondary) / <alpha-value>)',
|
||||
},
|
||||
|
||||
destructive: {
|
||||
DEFAULT: 'oklch(var(--clr-severity-critical) / <alpha-value>)',
|
||||
foreground: 'white',
|
||||
},
|
||||
|
||||
// Severity colors
|
||||
severity: {
|
||||
safe: 'oklch(var(--clr-severity-safe) / <alpha-value>)',
|
||||
low: 'oklch(var(--clr-severity-low) / <alpha-value>)',
|
||||
medium: 'oklch(var(--clr-severity-medium) / <alpha-value>)',
|
||||
high: 'oklch(var(--clr-severity-high) / <alpha-value>)',
|
||||
critical: 'oklch(var(--clr-severity-critical) / <alpha-value>)',
|
||||
},
|
||||
|
||||
// Glass effects
|
||||
glass: {
|
||||
bg: 'oklch(var(--glass-bg) / <alpha-value>)',
|
||||
border: 'oklch(var(--glass-border) / <alpha-value>)',
|
||||
},
|
||||
},
|
||||
|
||||
borderRadius: {
|
||||
lg: 'var(--rd-lg)',
|
||||
md: 'var(--rd-md)',
|
||||
sm: 'var(--rd-sm)',
|
||||
xl: 'var(--rd-xl)',
|
||||
full: 'var(--rd-full)',
|
||||
},
|
||||
|
||||
spacing: {
|
||||
0.5: 'var(--sp-0-5)',
|
||||
1: 'var(--sp-1)',
|
||||
2: 'var(--sp-2)',
|
||||
3: 'var(--sp-3)',
|
||||
4: 'var(--sp-4)',
|
||||
5: 'var(--sp-5)',
|
||||
6: 'var(--sp-6)',
|
||||
7: 'var(--sp-7)',
|
||||
8: 'var(--sp-8)',
|
||||
},
|
||||
|
||||
zIndex: {
|
||||
header: 'var(--z-header)',
|
||||
sidebar: 'var(--z-sidebar)',
|
||||
overlay: 'var(--z-overlay)',
|
||||
modal: 'var(--z-modal)',
|
||||
toast: 'var(--z-toast)',
|
||||
mascot: 'var(--z-mascot)',
|
||||
},
|
||||
|
||||
animation: {
|
||||
'fade-in': 'fadeIn 0.3s ease-out',
|
||||
'fade-in-up': 'fadeInUp 0.5s ease-out',
|
||||
'shimmer': 'shimmer 1.5s ease-in-out infinite',
|
||||
'bar-pulse': 'bar-pulse 0.4s ease-in-out infinite',
|
||||
'glow-pulse': 'glowPulse 2s ease-in-out infinite',
|
||||
'scale-in': 'scaleIn 0.3s ease-out',
|
||||
'slide-up': 'slideUp 0.35s ease-out',
|
||||
'slide-down': 'slideDown 0.25s ease-out',
|
||||
},
|
||||
|
||||
keyframes: {
|
||||
fadeIn: { '0%': { opacity: '0' }, '100%': { opacity: '1' } },
|
||||
fadeInUp: { '0%': { opacity: '0', transform: 'translateY(20px)' }, '100%': { opacity: '1', transform: 'translateY(0)' } },
|
||||
shimmer: { '0%': { backgroundPosition: '200% 0' }, '100%': { backgroundPosition: '-200% 0' } },
|
||||
'bar-pulse': { '0%, 100%': { transform: 'scaleY(0.8)' }, '50%': { transform: 'scaleY(1.2)' } },
|
||||
glowPulse: { '0%, 100%': { opacity: '0.4' }, '50%': { opacity: '0.8' } },
|
||||
scaleIn: { '0%': { transform: 'scale(0.95)', opacity: '0' }, '100%': { transform: 'scale(1)', opacity: '1' } },
|
||||
slideUp: { '0%': { transform: 'translateY(10px)', opacity: '0' }, '100%': { transform: 'translateY(0)', opacity: '1' } },
|
||||
slideDown: { '0%': { transform: 'translateY(-10px)', opacity: '0' }, '100%': { transform: 'translateY(0)', opacity: '1' } },
|
||||
},
|
||||
|
||||
backdropBlur: {
|
||||
glass: '16px',
|
||||
strong: '24px',
|
||||
subtle: '8px',
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
plugins: [],
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📁 Source Structure (Feature-Sliced)
|
||||
|
||||
```
|
||||
src/
|
||||
├── main.tsx # Entry + QueryClient + Providers
|
||||
├── styles.css # Tailwind + CSS custom properties + keyframes
|
||||
├── App.tsx # Layout shell + routing
|
||||
│
|
||||
├── entities/ # Domain types (pure, no logic)
|
||||
│ ├── message/
|
||||
│ ├── guild/
|
||||
│ ├── voice/
|
||||
│ ├── media/
|
||||
│ └── ui/
|
||||
│
|
||||
├── shared/ # Cross-cutting
|
||||
│ ├── api/ # HTTP client + typed endpoints
|
||||
│ ├── ws/ # WebSocket manager
|
||||
│ ├── hooks/ # Shared hooks (useReducedMotion, etc.)
|
||||
│ ├── ui/ # UI primitives (button, card, badge, etc.)
|
||||
│ └── lib/ # Utils (cn, logger, formatters)
|
||||
│
|
||||
├── features/ # Feature modules
|
||||
│ ├── live/ # Voice + media controls
|
||||
│ ├── messages/ # Message feed + moderation
|
||||
│ ├── admin/ # Admin panel
|
||||
│ ├── settings/ # Settings
|
||||
│ └── auth/ # Login/overlay
|
||||
│
|
||||
└── widgets/ # Layout composites
|
||||
├── DashboardLayout.tsx
|
||||
├── Header.tsx
|
||||
├── Sidebar.tsx
|
||||
├── mascot/
|
||||
└── particles/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎭 Glassmorphism Implementation
|
||||
|
||||
```css
|
||||
/* styles.css — Glass utility classes */
|
||||
@layer utilities {
|
||||
.glass {
|
||||
background: oklch(from var(--clr-surface-elevated) l c h / 0.6);
|
||||
backdrop-filter: blur(16px);
|
||||
-webkit-backdrop-filter: blur(16px);
|
||||
border: 1px solid oklch(from var(--clr-border) l c h / 0.2);
|
||||
}
|
||||
|
||||
.glass-strong {
|
||||
background: oklch(from var(--clr-surface-overlay) l c h / 0.85);
|
||||
backdrop-filter: blur(24px);
|
||||
-webkit-backdrop-filter: blur(24px);
|
||||
}
|
||||
|
||||
.glass-subtle {
|
||||
background: oklch(from var(--clr-surface-base) l c h / 0.5);
|
||||
backdrop-filter: blur(8px);
|
||||
-webkit-backdrop-filter: blur(8px);
|
||||
}
|
||||
|
||||
.gradient-text {
|
||||
background: linear-gradient(135deg,
|
||||
oklch(var(--clr-primary-500)),
|
||||
oklch(var(--clr-primary-300))
|
||||
);
|
||||
-webkit-background-clip: text;
|
||||
background-clip: text;
|
||||
color: transparent;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌐 WebSocket Integration
|
||||
|
||||
```tsx
|
||||
// shared/ws/socket.ts
|
||||
class SocketManager {
|
||||
private ws: WebSocket | null = null;
|
||||
private listeners = new Map<string, Set<(data: unknown) => void>>();
|
||||
private reconnectAttempts = 0;
|
||||
private maxReconnectDelay = 30000;
|
||||
|
||||
connect(url: string): void {
|
||||
this.ws = new WebSocket(url);
|
||||
this.ws.onmessage = (event) => {
|
||||
const { type, data } = JSON.parse(event.data);
|
||||
this.listeners.get(type)?.forEach(fn => fn(data));
|
||||
};
|
||||
this.ws.onclose = () => this.scheduleReconnect();
|
||||
}
|
||||
|
||||
on<T>(event: string, callback: (data: T) => void): () => void {
|
||||
if (!this.listeners.has(event)) this.listeners.set(event, new Set());
|
||||
this.listeners.get(event)!.add(callback as (data: unknown) => void);
|
||||
return () => this.listeners.get(event)?.delete(callback as (data: unknown) => void);
|
||||
}
|
||||
|
||||
private scheduleReconnect(): void {
|
||||
const delay = Math.min(1000 * Math.pow(2, this.reconnectAttempts), this.maxReconnectDelay);
|
||||
setTimeout(() => { this.reconnectAttempts++; this.connect(this.ws!.url); }, delay);
|
||||
}
|
||||
}
|
||||
|
||||
export const socket = new SocketManager();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Key Integration Rules
|
||||
|
||||
| Concern | Implementation | Location |
|
||||
|---------|---------------|----------|
|
||||
| CSS Variables | Defined in `styles.css` on `:root` | Root stylesheet |
|
||||
| Tailwind Colors | Map to CSS variables with `<alpha-value>` | tailwind.config.js |
|
||||
| Component Library | shadcn/ui patterns with custom variants | shared/ui/ |
|
||||
| Server State | TanStack Query in feature hooks | features/*/hooks/ |
|
||||
| Client State | Zustand stores for UI state | shared/stores/ |
|
||||
| WebSocket | Singleton SocketManager | shared/ws/socket.ts |
|
||||
| Animations | Framer Motion for component, GSAP for page | In components |
|
||||
| Particles | Three.js via @react-three/fiber | widgets/particles/ |
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Frontend Anti-Patterns
|
||||
|
||||
### ❌ Server state di state lokal
|
||||
```tsx
|
||||
// ❌ JANGAN — API data disimpan di useState
|
||||
const [messages, setMessages] = useState([]);
|
||||
useEffect(() => { fetchMessages().then(setMessages); }, []);
|
||||
|
||||
// ✅ Gunakan TanStack Query
|
||||
const { data: messages } = useQuery({ queryKey: ['messages'], queryFn: fetchMessages });
|
||||
```
|
||||
|
||||
### ❌ Inline styles untuk dynamic values
|
||||
```tsx
|
||||
// ❌ JANGAN — tidak theme-aware, tidak bisa dark mode
|
||||
<div style={{ backgroundColor: isActive ? '#3b82f6' : '#6b7280' }} />
|
||||
|
||||
// ✅ CSS class dengan state
|
||||
<div className={isActive ? 'bg-primary' : 'bg-muted'} />
|
||||
```
|
||||
|
||||
### ❌ Mengimpor langsung dari library tanpa wrapper
|
||||
```tsx
|
||||
// ❌ JANGAN — susah diganti library nanti
|
||||
import { motion } from 'framer-motion';
|
||||
|
||||
// ✅ Wrapper pattern
|
||||
import { AnimatedDiv } from '@/shared/ui';
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [Tailwind CSS Docs](https://tailwindcss.com/docs) | Utility-first CSS |
|
||||
| [shadcn/ui](https://ui.shadcn.com/) | Component primitives |
|
||||
| [TanStack Query](https://tanstack.com/query) | Server state |
|
||||
| [Zustand](https://github.com/pmndrs/zustand) | Client state |
|
||||
|
||||
---
|
||||
|
||||
*"Fasad kaca yang menari — di balik setiap piksel ada cerita."* ❄️🩵
|
||||
@@ -1,271 +0,0 @@
|
||||
# Backend API Guidelines — The Nerve Center
|
||||
|
||||
> *"APIs are contracts. Design them with the same care as legal documents."*
|
||||
> — Unknown
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi API
|
||||
|
||||
Backend API BETE adalah **fasilitator antara data dan tampilan**:
|
||||
1. **RESTful by design** — Sumber daya, bukan aksi
|
||||
2. **Type-safe** — Zod schemas di setiap endpoint
|
||||
3. **Consistent pagination** — Tidak ada kejutan format
|
||||
4. **Error as structure** — Setiap error punya kode dan resolusi
|
||||
|
||||
---
|
||||
|
||||
## 📐 API Design Principles
|
||||
|
||||
### URL Structure
|
||||
|
||||
```
|
||||
GET /api/v1/messages # List messages
|
||||
GET /api/v1/messages/:id # Single message
|
||||
GET /api/v1/channels # List channels
|
||||
GET /api/v1/analytics/overview # Analytics
|
||||
GET /api/v1/voice/connections # Voice connections
|
||||
POST /api/v1/voice/connect # Connect to voice
|
||||
POST /api/v1/voice/disconnect # Disconnect
|
||||
```
|
||||
|
||||
### Response Envelope
|
||||
|
||||
```typescript
|
||||
// Success
|
||||
{
|
||||
"success": true,
|
||||
"data": T,
|
||||
"meta"?: {
|
||||
"page": 1,
|
||||
"limit": 50,
|
||||
"total": 1234,
|
||||
"hasMore": true
|
||||
}
|
||||
}
|
||||
|
||||
// Error
|
||||
{
|
||||
"success": false,
|
||||
"error": {
|
||||
"code": "VALIDATION_ERROR",
|
||||
"message": "Invalid channelId format",
|
||||
"details": {
|
||||
"field": "channelId",
|
||||
"constraint": "numeric_string"
|
||||
},
|
||||
"requestId": "req_abc123"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Pagination
|
||||
|
||||
```typescript
|
||||
interface PaginationParams {
|
||||
page?: number; // Default: 1
|
||||
limit?: number; // Default: 50, Max: 200
|
||||
cursor?: string; // For cursor-based pagination
|
||||
}
|
||||
|
||||
interface PaginationMeta {
|
||||
page: number;
|
||||
limit: number;
|
||||
total: number;
|
||||
totalPages: number;
|
||||
hasMore: boolean;
|
||||
}
|
||||
```
|
||||
|
||||
### Filtering
|
||||
|
||||
```typescript
|
||||
interface FilterParams {
|
||||
search?: string;
|
||||
channelId?: string;
|
||||
userId?: string;
|
||||
severity?: 'safe' | 'low' | 'medium' | 'high' | 'critical';
|
||||
dateFrom?: string; // ISO 8601
|
||||
dateTo?: string; // ISO 8601
|
||||
sortBy?: string; // Field name
|
||||
sortOrder?: 'asc' | 'desc';
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Module Structure (Backend)
|
||||
|
||||
```
|
||||
services/backend/src/modules/
|
||||
├── messages/
|
||||
│ ├── messages.schema.ts # Zod schemas
|
||||
│ ├── messages.repository.ts # Database queries
|
||||
│ ├── messages.service.ts # Business logic
|
||||
│ ├── messages.controller.ts # Request handlers
|
||||
│ └── routes/
|
||||
│ └── index.ts # Express router
|
||||
├── analytics/
|
||||
├── voice/
|
||||
├── media/
|
||||
└── health/
|
||||
```
|
||||
|
||||
### Layer Rules
|
||||
|
||||
```
|
||||
Controller (parse + validate) → Service (business logic) → Repository (DB queries)
|
||||
↕
|
||||
Shared Infrastructure
|
||||
(config, logger, errors)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚡ WebSocket Events
|
||||
|
||||
### Event Format
|
||||
|
||||
```typescript
|
||||
interface WsEvent<T = unknown> {
|
||||
type: string; // e.g., "message:created"
|
||||
data: T;
|
||||
timestamp: number;
|
||||
requestId?: string;
|
||||
}
|
||||
|
||||
// Server → Client events
|
||||
{
|
||||
"type": "message:created",
|
||||
"data": {
|
||||
"id": "msg_123",
|
||||
"content": "...",
|
||||
"author": { "id": "user_1", "name": "User" }
|
||||
},
|
||||
"timestamp": 1750000000000
|
||||
}
|
||||
|
||||
// Client → Server events
|
||||
{
|
||||
"type": "voice:connect",
|
||||
"data": {
|
||||
"guildId": "123456789",
|
||||
"channelId": "987654321"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Event Catalog
|
||||
|
||||
| Type | Direction | Description |
|
||||
|------|-----------|-------------|
|
||||
| `message:created` | Server → Client | New message captured |
|
||||
| `message:updated` | Server → Client | Message edited |
|
||||
| `message:deleted` | Server → Client | Message removed |
|
||||
| `message:analyzed` | Server → Client | AI analysis complete |
|
||||
| `voice:state` | Server → Client | Voice connection state |
|
||||
| `voice:speaker` | Server → Client | Speaker activity |
|
||||
| `attachment:uploaded` | Server → Client | Attachment uploaded |
|
||||
| `analytics:update` | Server → Client | Analytics data refresh |
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Authentication & Authorization
|
||||
|
||||
```typescript
|
||||
// Admin auth via header
|
||||
Authorization: Bearer <admin-password-hash>
|
||||
|
||||
// Rate limiting
|
||||
RateLimit: 100/minute per IP
|
||||
Retry-After: 60
|
||||
```
|
||||
|
||||
### Error Codes
|
||||
|
||||
| Code | HTTP | Description |
|
||||
|------|------|-------------|
|
||||
| `VALIDATION_ERROR` | 400 | Invalid input |
|
||||
| `UNAUTHORIZED` | 401 | Invalid/missing auth |
|
||||
| `FORBIDDEN` | 403 | Insufficient permissions |
|
||||
| `NOT_FOUND` | 404 | Resource not found |
|
||||
| `RATE_LIMITED` | 429 | Too many requests |
|
||||
| `INTERNAL_ERROR` | 500 | Unexpected error |
|
||||
| `SERVICE_UNAVAILABLE` | 503 | Downstream failure |
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Testing Strategy
|
||||
|
||||
```typescript
|
||||
describe('GET /api/v1/messages', () => {
|
||||
it('returns paginated messages', async () => {
|
||||
const res = await request(app).get('/api/v1/messages?page=1&limit=10');
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.body.success).toBe(true);
|
||||
expect(res.body.meta.hasMore).toBeDefined();
|
||||
});
|
||||
|
||||
it('rejects invalid severity filter', async () => {
|
||||
const res = await request(app).get('/api/v1/messages?severity=invalid');
|
||||
expect(res.status).toBe(400);
|
||||
expect(res.body.error.code).toBe('VALIDATION_ERROR');
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ API Anti-Patterns
|
||||
|
||||
### ❌ Nested resources terlalu dalam
|
||||
```
|
||||
// ❌ JANGAN
|
||||
GET /api/v1/guilds/123/channels/456/messages/789
|
||||
|
||||
// ✅ Flat dengan query params
|
||||
GET /api/v1/messages?channelId=456
|
||||
```
|
||||
|
||||
### ❌ Inconsistent error format
|
||||
```typescript
|
||||
// ❌ JANGAN — kadang string, kadang object
|
||||
if (err) return res.status(400).send('Bad request');
|
||||
if (err) return res.status(400).json({ message: 'Bad request' });
|
||||
|
||||
// ✅ Consistent envelope
|
||||
if (err) return res.status(400).json({
|
||||
success: false,
|
||||
error: { code: 'VALIDATION_ERROR', message: 'Bad request' }
|
||||
});
|
||||
```
|
||||
|
||||
### ❌ No type safety
|
||||
```typescript
|
||||
// ❌ JANGAN — any, tidak ada validasi
|
||||
app.get('/api/messages', async (req, res) => {
|
||||
const messages = await db.query('SELECT * FROM messages');
|
||||
res.json(messages);
|
||||
});
|
||||
|
||||
// ✅ Zod schema + typed handler
|
||||
app.get('/api/v1/messages', asyncHandler(async (req, res) => {
|
||||
const query = messageQuerySchema.parse(req.query);
|
||||
const messages = await messagesService.list(query);
|
||||
res.json({ success: true, data: messages });
|
||||
}));
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [JSON:API](https://jsonapi.org/) | Response format spec |
|
||||
| [Express.js](https://expressjs.com/) | Server framework |
|
||||
| [Zod](https://zod.dev/) | Schema validation |
|
||||
|
||||
---
|
||||
|
||||
*"API adalah jembatan ingatan — setiap request adalah percakapan."* ❄️🩵
|
||||
@@ -1,310 +0,0 @@
|
||||
# Gateway Event Design — The Pulse of Discord
|
||||
|
||||
> *"Events are the heartbeat of a distributed system."*
|
||||
> — Martin Fowler
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Gateway Events
|
||||
|
||||
Discord Gateway adalah **jantung event-driven** BETE:
|
||||
|
||||
1. **Single source of truth** — Events adalah satu-satunya cara data bergerak antar service
|
||||
2. **At-least-once delivery** — Event bisa terkirim lebih dari sekali (idempotent consumers)
|
||||
3. **Schema evolution** — Events punya versioning untuk backward compatibility
|
||||
4. **Observable** — Setiap event tercatat untuk debugging dan audit
|
||||
|
||||
---
|
||||
|
||||
## 📦 Event Schema
|
||||
|
||||
### Envelope
|
||||
|
||||
```typescript
|
||||
interface GatewayEvent<T = unknown> {
|
||||
/** Event type identifier — lowercase, colon-separated */
|
||||
type: string;
|
||||
|
||||
/** Event payload */
|
||||
data: T;
|
||||
|
||||
/** ISO 8601 timestamp of when the event was created */
|
||||
timestamp: string;
|
||||
|
||||
/** Unique event ID for deduplication */
|
||||
eventId: string;
|
||||
|
||||
/** Source service name */
|
||||
source: 'discord-gateway';
|
||||
|
||||
/** Event schema version */
|
||||
version: number;
|
||||
|
||||
/** Optional correlation ID for tracing request flows */
|
||||
correlationId?: string;
|
||||
}
|
||||
```
|
||||
|
||||
### Event Size Limits
|
||||
|
||||
| Limit | Value | Notes |
|
||||
|-------|-------|-------|
|
||||
| Max payload size | 256KB | Larger payloads → reference via URL |
|
||||
| Max nesting depth | 5 levels | Prevent billion laughs attack |
|
||||
| String max length | 100KB | Truncate with `... (truncated)` suffix |
|
||||
|
||||
---
|
||||
|
||||
## 📋 Event Catalog
|
||||
|
||||
### Message Events
|
||||
|
||||
```typescript
|
||||
// discord:message:created
|
||||
interface MessageCreatedEvent {
|
||||
id: string;
|
||||
channelId: string;
|
||||
guildId: string;
|
||||
author: {
|
||||
id: string;
|
||||
name: string;
|
||||
discriminator: string;
|
||||
avatar: string | null;
|
||||
isBot: boolean;
|
||||
};
|
||||
content: string;
|
||||
timestamp: string; // ISO 8601
|
||||
editedTimestamp: string | null;
|
||||
attachments: AttachmentInfo[];
|
||||
replyTo?: string; // Parent message ID
|
||||
}
|
||||
|
||||
// discord:message:updated
|
||||
interface MessageUpdatedEvent {
|
||||
id: string;
|
||||
channelId: string;
|
||||
content: string;
|
||||
editedTimestamp: string;
|
||||
}
|
||||
|
||||
// discord:message:deleted
|
||||
interface MessageDeletedEvent {
|
||||
id: string;
|
||||
channelId: string;
|
||||
guildId: string;
|
||||
}
|
||||
```
|
||||
|
||||
### Analysis Events
|
||||
|
||||
```typescript
|
||||
// discord:message:analyzed
|
||||
interface MessageAnalyzedEvent {
|
||||
messageId: string;
|
||||
status: 'pending' | 'complete' | 'error';
|
||||
severity: 'safe' | 'low' | 'medium' | 'high' | 'critical';
|
||||
categories: string[];
|
||||
confidence: number; // 0–1
|
||||
summary: string;
|
||||
analyzedAt: string;
|
||||
processingTimeMs: number;
|
||||
}
|
||||
```
|
||||
|
||||
### Voice Events
|
||||
|
||||
```typescript
|
||||
// discord:voice:started
|
||||
interface VoiceStartedEvent {
|
||||
guildId: string;
|
||||
channelId: string;
|
||||
channelName: string;
|
||||
startedAt: string;
|
||||
participants: Array<{
|
||||
userId: string;
|
||||
userName: string;
|
||||
}>;
|
||||
}
|
||||
|
||||
// discord:voice:stopped
|
||||
interface VoiceStoppedEvent {
|
||||
guildId: string;
|
||||
channelId: string;
|
||||
duration: number; // seconds
|
||||
segmentsCount: number;
|
||||
}
|
||||
|
||||
// discord:voice:uploaded
|
||||
interface VoiceUploadedEvent {
|
||||
segmentId: string;
|
||||
guildId: string;
|
||||
channelId: string;
|
||||
userId: string;
|
||||
userName: string;
|
||||
duration: number;
|
||||
fileUrl: string;
|
||||
fileSize: number;
|
||||
timestamp: string;
|
||||
}
|
||||
```
|
||||
|
||||
### Attachment Events
|
||||
|
||||
```typescript
|
||||
// discord:attachment:created
|
||||
interface AttachmentCreatedEvent {
|
||||
id: string;
|
||||
messageId: string;
|
||||
channelId: string;
|
||||
url: string;
|
||||
filename: string;
|
||||
contentType: string;
|
||||
size: number;
|
||||
width?: number;
|
||||
height?: number;
|
||||
}
|
||||
|
||||
// discord:attachment:uploaded
|
||||
interface AttachmentUploadedEvent {
|
||||
id: string;
|
||||
messageId: string;
|
||||
storageUrl: string;
|
||||
thumbnailUrl?: string;
|
||||
fileSize: number;
|
||||
processingTimeMs: number;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Event Lifecycle
|
||||
|
||||
```
|
||||
┌──────────┐
|
||||
│ Discord │ (messageCreate, voiceStateUpdate, etc.)
|
||||
└────┬─────┘
|
||||
│
|
||||
↓
|
||||
┌──────────────┐
|
||||
│ Discord.js │ (client events)
|
||||
└────┬─────────┘
|
||||
│
|
||||
↓
|
||||
┌─────────────────────────────┐
|
||||
│ Message Capture Controller │ (messageCapture.ts)
|
||||
│ - Parse event │
|
||||
│ - Store in database │
|
||||
│ - Publish to Redis │
|
||||
└────┬───────────────────────┘
|
||||
│
|
||||
↓
|
||||
┌─────────────────────┐
|
||||
│ Redis Pub/Sub │ (channel: discord:message:created)
|
||||
└────┬────────────────┘
|
||||
│
|
||||
├──────────────────────────────┐
|
||||
↓ ↓
|
||||
┌──────────────────┐ ┌──────────────────┐
|
||||
│ Backend Service │ │ AI Moderation │
|
||||
│ - Index message │ │ - Analyze text │
|
||||
│ - Store in DB │ │ - Update status │
|
||||
│ - Broadcast WS │ │ - Publish result │
|
||||
└──────────────────┘ └──────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Event Testing
|
||||
|
||||
```typescript
|
||||
// Helper untuk generate test events
|
||||
function createTestEvent<T>(type: string, data: T): GatewayEvent<T> {
|
||||
return {
|
||||
type,
|
||||
data,
|
||||
timestamp: new Date().toISOString(),
|
||||
eventId: crypto.randomUUID(),
|
||||
source: 'discord-gateway',
|
||||
version: 1,
|
||||
};
|
||||
}
|
||||
|
||||
describe('MessageCreatedEvent', () => {
|
||||
it('is properly formatted', () => {
|
||||
const event = createTestEvent('discord:message:created', {
|
||||
id: 'msg_1',
|
||||
channelId: 'ch_1',
|
||||
guildId: 'guild_1',
|
||||
author: { id: 'user_1', name: 'Test', discriminator: '0000', avatar: null, isBot: false },
|
||||
content: 'Hello world',
|
||||
timestamp: new Date().toISOString(),
|
||||
editedTimestamp: null,
|
||||
attachments: [],
|
||||
});
|
||||
|
||||
expect(event.type).toBe('discord:message:created');
|
||||
expect(event.data.content).toBe('Hello world');
|
||||
expect(event.source).toBe('discord-gateway');
|
||||
expect(event.version).toBe(1);
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 Event Performance Metrics
|
||||
|
||||
| Metric | Target | Alert |
|
||||
|--------|--------|-------|
|
||||
| Processing latency | <50ms p99 | >200ms |
|
||||
| Event throughput | >1000/s | <100/s (unusual) |
|
||||
| Redis publish latency | <5ms | >20ms |
|
||||
| Event loss rate | 0% | >0.01% |
|
||||
| Queue depth | <100 | >1000 |
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Anti-Patterns Events
|
||||
|
||||
### ❌ Processing-heavy event handlers
|
||||
```typescript
|
||||
// ❌ JANGAN — blocking event loop
|
||||
eventBus.on('message:created', async (event) => {
|
||||
const result = await expensiveAnalysis(event.data.content);
|
||||
await db.save(result);
|
||||
// Event handler for 100 msg/s = bottleneck
|
||||
});
|
||||
|
||||
// ✅ Queue heavy work
|
||||
eventBus.on('message:created', async (event) => {
|
||||
await analysisQueue.add(event); // Worker processes async
|
||||
});
|
||||
```
|
||||
|
||||
### ❌ Missing idempotency
|
||||
```typescript
|
||||
// ❌ JANGAN — duplicate events create duplicate records
|
||||
async function handleMessageCreated(event) {
|
||||
await db.insert({ id: event.data.id, content: event.data.content });
|
||||
// If event arrives twice → duplicate key error
|
||||
}
|
||||
|
||||
// ✅ Idempotent: UPSERT
|
||||
async function handleMessageCreated(event) {
|
||||
await db.upsert({ id: event.data.id }, { content: event.data.content });
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [Redis Pub/Sub](https://redis.io/docs/manual/pubsub/) | Event backbone |
|
||||
| [CloudEvents](https://cloudevents.io/) | Event schema standard |
|
||||
| [Discord Gateway](https://discord.com/developers/docs/topics/gateway) | Discord events |
|
||||
|
||||
---
|
||||
|
||||
*"Setiap event adalah denyut nadi — tanda bahwa sistem masih hidup dan berbicara."* ❄️🩵
|
||||
@@ -1,334 +0,0 @@
|
||||
# Accessibility — Design for Everyone
|
||||
|
||||
> *"The power of the Web is in its universality. Access by everyone regardless of disability is an essential aspect."*
|
||||
> — Tim Berners-Lee
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Aksesibilitas
|
||||
|
||||
BETE dirancang untuk **inklusif sejak awal**, bukan retrofit:
|
||||
|
||||
1. **Semantic HTML** — Struktur sebelum style
|
||||
2. **Color-independent** — Informasi tidak hanya disampaikan lewat warna
|
||||
3. **Keyboard-first** — Semua fitur bisa diakses tanpa mouse
|
||||
4. **Reduced motion** — Animasi opsional, bukan wajib
|
||||
|
||||
---
|
||||
|
||||
## 🏆 Target Compliance
|
||||
|
||||
| Level | Target | Verification |
|
||||
|-------|--------|--------------|
|
||||
| WCAG 2.1 AA | ✅ Mandatory | Automated + manual |
|
||||
| WCAG 2.1 AAA | ⭐ Recommended | Manual audit |
|
||||
| Section 508 | ✅ Mandatory | Automated |
|
||||
| EN 301 549 | ✅ Mandatory | EU compliance |
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Color Accessibility
|
||||
|
||||
### Contrast Ratios Minimum
|
||||
|
||||
| Elemen | Teks Normal | Teks Large (≥18px / ≥14px bold) |
|
||||
|--------|-------------|----------------------------------|
|
||||
| Body text | 4.5:1 (AA) | 3:1 (AA) |
|
||||
| UI text (label, badge) | 4.5:1 (AA) | 3:1 (AA) |
|
||||
| Placeholder | 3:1 (AA large) | — |
|
||||
| Disabled | 3:1 | 3:1 |
|
||||
|
||||
### Color Blindness
|
||||
|
||||
- Jangan gunakan **merah-hijau** sebagai satu-satunya pembeda
|
||||
- Tambahkan **ikon, pola, atau label teks** sebagai secondary encoding
|
||||
- Gunakan palette color-blind safe (lihat `01-color-system.md`)
|
||||
|
||||
```typescript
|
||||
// Tool: verifikasi kontras otomatis di tests
|
||||
function checkContrast(foreground: string, background: string): boolean {
|
||||
const fg = parseOklch(foreground);
|
||||
const bg = parseOklch(background);
|
||||
return getContrastRatio(fg, bg) >= 4.5;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⌨️ Keyboard Navigation
|
||||
|
||||
### Focus Order
|
||||
|
||||
```html
|
||||
<!-- ✅ Semantic order = visual order -->
|
||||
<nav> <!-- Tab 1 -->
|
||||
<main> <!-- Tab 2 -->
|
||||
<h1> <!-- Tab 3 -->
|
||||
<p> <!-- Tab 4 -->
|
||||
<button><!-- Tab 5 -->
|
||||
</main>
|
||||
<footer> <!-- Tab 6 -->
|
||||
```
|
||||
|
||||
### Focus Indicators
|
||||
|
||||
```css
|
||||
/* Custom focus ring — lebih visible dari browser default */
|
||||
:focus-visible {
|
||||
outline: 2px solid var(--clr-primary-400);
|
||||
outline-offset: 2px;
|
||||
border-radius: var(--rd-sm);
|
||||
}
|
||||
|
||||
/* ⚠️ NEVER do this */
|
||||
:focus { outline: none; } /* Membuat keyboard users buta */
|
||||
```
|
||||
|
||||
### Keyboard Shortcuts
|
||||
|
||||
```
|
||||
Tab / Shift+Tab — Navigate forward/backward
|
||||
Enter / Space — Activate element
|
||||
Escape — Close modal/dropdown/menu
|
||||
Arrow keys — Navigate list, tabs, select
|
||||
Ctrl+K — Command palette
|
||||
```
|
||||
|
||||
### Skip Navigation
|
||||
|
||||
```html
|
||||
<!-- First focusable element on page -->
|
||||
<a href="#main-content" class="skip-link">
|
||||
Skip to main content
|
||||
</a>
|
||||
```
|
||||
|
||||
```css
|
||||
.skip-link {
|
||||
position: absolute;
|
||||
top: -100%;
|
||||
left: 8px;
|
||||
padding: 8px 16px;
|
||||
background: var(--clr-primary);
|
||||
color: var(--clr-text-on-primary);
|
||||
z-index: 9999;
|
||||
}
|
||||
|
||||
.skip-link:focus {
|
||||
top: 8px;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Semantic HTML Structure
|
||||
|
||||
```html
|
||||
<!-- Dashboard page template -->
|
||||
<header role="banner">
|
||||
<nav role="navigation" aria-label="Main navigation">
|
||||
<ul>
|
||||
<li><a href="/live" aria-current="page">Live</a></li>
|
||||
<li><a href="/messages">Messages</a></li>
|
||||
<li><a href="/settings">Settings</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
<main id="main-content" role="main">
|
||||
<h1>Live Dashboard</h1>
|
||||
|
||||
<section aria-labelledby="voice-status">
|
||||
<h2 id="voice-status">Voice Connections</h2>
|
||||
<!-- voice content -->
|
||||
</section>
|
||||
|
||||
<section aria-labelledby="active-speakers">
|
||||
<h2 id="active-speakers">Active Speakers</h2>
|
||||
<ul role="list" aria-label="Currently speaking users">
|
||||
<li role="listitem">User 1</li>
|
||||
<li role="listitem">User 2</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ♿ ARIA Patterns
|
||||
|
||||
### Dynamic Content (Live Regions)
|
||||
|
||||
```html
|
||||
<!-- Toast notifications — live region -->
|
||||
<div aria-live="polite" aria-atomic="true" class="toast-container">
|
||||
<!-- Toasts announced by screen reader -->
|
||||
</div>
|
||||
|
||||
<!-- Loading state -->
|
||||
<div role="status" aria-live="polite">
|
||||
<span class="sr-only">Loading messages...</span>
|
||||
<div class="skeleton" aria-hidden="true"></div>
|
||||
</div>
|
||||
|
||||
<!-- Error state -->
|
||||
<div role="alert" aria-live="assertive">
|
||||
<p>Failed to load messages. Please try again.</p>
|
||||
</div>
|
||||
```
|
||||
|
||||
### Modals
|
||||
|
||||
```html
|
||||
<div
|
||||
role="dialog"
|
||||
aria-modal="true"
|
||||
aria-labelledby="modal-title"
|
||||
aria-describedby="modal-desc"
|
||||
>
|
||||
<h2 id="modal-title">Confirm Delete</h2>
|
||||
<p id="modal-desc">This action cannot be undone.</p>
|
||||
<button onClick={closeModal}>Cancel</button>
|
||||
<button onClick={confirmDelete}>Delete</button>
|
||||
</div>
|
||||
```
|
||||
|
||||
### Tabs
|
||||
|
||||
```html
|
||||
<div role="tablist" aria-label="Dashboard tabs">
|
||||
<button role="tab" aria-selected="true" aria-controls="panel-live" id="tab-live">
|
||||
Live
|
||||
</button>
|
||||
<button role="tab" aria-selected="false" aria-controls="panel-messages" id="tab-messages">
|
||||
Messages
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<div role="tabpanel" id="panel-live" aria-labelledby="tab-live">
|
||||
<!-- Live content -->
|
||||
</div>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔇 Reduced Motion
|
||||
|
||||
```css
|
||||
/* Global override */
|
||||
@media (prefers-reduced-motion: reduce) {
|
||||
*, *::before, *::after {
|
||||
animation-duration: 0.01ms !important;
|
||||
animation-iteration-count: 1 !important;
|
||||
transition-duration: 0.01ms !important;
|
||||
scroll-behavior: auto !important;
|
||||
}
|
||||
}
|
||||
|
||||
/* GSAP hook — programmatic check */
|
||||
function prefersReducedMotion(): boolean {
|
||||
return window.matchMedia('(prefers-reduced-motion: reduce)').matches;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🖼️ Images & Icons
|
||||
|
||||
```tsx
|
||||
// Icons — always with aria-hidden or label
|
||||
<MicIcon aria-hidden="true" /> // Decorative
|
||||
<span role="img" aria-label="Voice active">🎤</span> // Emoji
|
||||
<Icon icon="mic" aria-label="Microphone" /> // Informative
|
||||
|
||||
// Images — always with alt text
|
||||
<img src={user.avatar} alt={`${user.name}'s avatar`} />
|
||||
<img src={decorativeBg} alt="" role="presentation" /> // Decorative
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Testing Accessibility
|
||||
|
||||
```typescript
|
||||
// Automated tests
|
||||
import { axe } from 'jest-axe';
|
||||
|
||||
describe('MessageCard', () => {
|
||||
it('has no accessibility violations', async () => {
|
||||
const { container } = render(<MessageCard message={mockMessage} />);
|
||||
const results = await axe(container);
|
||||
expect(results).toHaveNoViolations();
|
||||
});
|
||||
});
|
||||
|
||||
// Manual checklist
|
||||
const a11yChecklist = [
|
||||
'Keyboard: all interactive elements reachable',
|
||||
'Focus order matches visual order',
|
||||
'Screen reader: all content announced',
|
||||
'Contrast: 4.5:1 minimum for body text',
|
||||
'Labels: all form elements have labels',
|
||||
'Alt text: all images have meaningful alt text',
|
||||
'Reduced motion: animations respect media query',
|
||||
'Color: information not conveyed by color alone',
|
||||
];
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🧰 Tools & Resources
|
||||
|
||||
| Tool | Purpose | Integration |
|
||||
|------|---------|-------------|
|
||||
| axe-core | Automated audit | CI pipeline |
|
||||
| Lighthouse | Performance + a11y | CI pipeline |
|
||||
| NVDA / VoiceOver | Screen reader | Manual testing |
|
||||
| Contrast Checker | Color verification | Design phase |
|
||||
| Tab Tester | Keyboard flow | Manual testing |
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ A11y Anti-Patterns
|
||||
|
||||
### ❌ Color-only indicators
|
||||
```tsx
|
||||
// ❌ JANGAN — buta warna tidak bisa membedakan
|
||||
<Badge className={isBad ? 'bg-red-500' : 'bg-green-500'} />
|
||||
|
||||
// ✅ Color + icon + text
|
||||
<Badge variant={isBad ? 'destructive' : 'success'} icon={isBad ? <X /> : <Check />} />
|
||||
```
|
||||
|
||||
### ❌ Missing focus indicator
|
||||
```css
|
||||
/* ❌ JANGAN — menghilangkan focus ring */
|
||||
*:focus { outline: none; }
|
||||
|
||||
/* ✅ Custom focus ring yang visible */
|
||||
*:focus-visible { outline: 2px solid var(--clr-primary-400); outline-offset: 2px; }
|
||||
```
|
||||
|
||||
### ❌ Non-semantic clickable
|
||||
```tsx
|
||||
// ❌ JANGAN — div clickable tanpa role
|
||||
<div onClick={handleClick}>Click me</div>
|
||||
|
||||
// ✅ Gunakan button
|
||||
<button onClick={handleClick}>Click me</button>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [WCAG 2.1](https://www.w3.org/TR/WCAG21/) | Accessibility standard |
|
||||
| [A11y Project](https://www.a11yproject.com/) | Accessibility patterns |
|
||||
| [Inclusive Components](https://inclusive-components.design/) | Accessible component design |
|
||||
| [axe DevTools](https://www.deque.com/axe/) | Automated testing |
|
||||
|
||||
---
|
||||
|
||||
*"Desain yang inklusif adalah ingatan yang tak membeda-bedakan — setiap orang berhak atas pengalaman yang utuh."* ❄️🩵
|
||||
@@ -1,282 +0,0 @@
|
||||
# Theme Architecture — The Chameleon Engine
|
||||
|
||||
> *"The only constant in design is change — a theme system embraces it."*
|
||||
> — Unknown
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Theme
|
||||
|
||||
Sistem theme BETE dibangun di atas **CSS Custom Properties**:
|
||||
1. **Separation of value from token** — Nilai warna tidak pernah dirujuk langsung
|
||||
2. **Single source of truth** — Satu set CSS variables, dua tema (dark/light)
|
||||
3. **Runtime switching** — Tema bisa diganti tanpa reload
|
||||
4. **Component-agnostic** — Komponen tidak tahu tema apa yang aktif
|
||||
|
||||
---
|
||||
|
||||
## 🧬 Theme Architecture
|
||||
|
||||
```
|
||||
CSS Custom Properties (oklch values)
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────┐
|
||||
│ :root / [data-theme] │ ← Tema didefinisikan di level root
|
||||
│ --clr-surface-base: oklch(...) │
|
||||
│ --clr-primary: oklch(...) │
|
||||
│ --clr-text: oklch(...) │
|
||||
└──────────────┬──────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────┐
|
||||
│ Tailwind Config Mapping │ ← Map CSS vars ke Tailwind utilities
|
||||
│ colors: { │
|
||||
│ background: "oklch(var(--...))" │
|
||||
│ } │
|
||||
└──────────────┬──────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────┐
|
||||
│ Component Styles │ ← Komponen pakai Tailwind/CSS vars
|
||||
│ <div className="bg-card" /> │
|
||||
│ .card { background: var(--clr..) } │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌗 Theme Definitions
|
||||
|
||||
### Dark Theme (Default)
|
||||
|
||||
```css
|
||||
[data-theme="dark"] {
|
||||
/* Surfaces */
|
||||
--clr-surface-base: oklch(0.11 0.010 286);
|
||||
--clr-surface-elevated: oklch(0.14 0.015 286);
|
||||
--clr-surface-overlay: oklch(0.17 0.020 286);
|
||||
--clr-surface-sunken: oklch(0.08 0.005 286);
|
||||
--clr-border: oklch(0.22 0.020 286);
|
||||
|
||||
/* Text */
|
||||
--clr-text: oklch(0.95 0.005 286);
|
||||
--clr-text-secondary: oklch(0.70 0.015 286);
|
||||
--clr-text-tertiary: oklch(0.50 0.020 286);
|
||||
--clr-text-inverse: oklch(0.11 0.010 286);
|
||||
|
||||
/* Brand - brighter in dark */
|
||||
--clr-primary: oklch(0.62 0.150 255);
|
||||
--clr-primary-bg: oklch(0.25 0.060 255 / 0.20);
|
||||
--clr-primary-400: oklch(0.62 0.150 255);
|
||||
--clr-primary-500: oklch(0.55 0.175 255);
|
||||
--clr-primary-600: oklch(0.47 0.160 255);
|
||||
|
||||
/* Interactive */
|
||||
--clr-interactive-hover: oklch(0.20 0.025 286);
|
||||
--clr-interactive-active: oklch(0.24 0.030 286);
|
||||
--clr-interactive-selected: oklch(0.25 0.060 255 / 0.15);
|
||||
|
||||
/* Shadows */
|
||||
--sh-card: 0 2px 8px rgba(0, 0, 0, 0.3);
|
||||
--sh-hover: 0 4px 16px rgba(0, 0, 0, 0.4);
|
||||
--sh-elevated: 0 8px 32px rgba(0, 0, 0, 0.5);
|
||||
--sh-modal: 0 16px 48px rgba(0, 0, 0, 0.6);
|
||||
|
||||
/* Glass */
|
||||
--glass-bg: oklch(0.15 0.015 286 / 0.60);
|
||||
--glass-border: oklch(0.25 0.030 286 / 0.20);
|
||||
}
|
||||
```
|
||||
|
||||
### Light Theme
|
||||
|
||||
```css
|
||||
[data-theme="light"] {
|
||||
/* Surfaces */
|
||||
--clr-surface-base: oklch(0.97 0.002 286);
|
||||
--clr-surface-elevated: oklch(1.00 0.000 286);
|
||||
--clr-surface-overlay: oklch(0.95 0.003 286);
|
||||
--clr-surface-sunken: oklch(0.92 0.004 286);
|
||||
--clr-border: oklch(0.87 0.005 286);
|
||||
|
||||
/* Text */
|
||||
--clr-text: oklch(0.11 0.010 286);
|
||||
--clr-text-secondary: oklch(0.50 0.020 286);
|
||||
--clr-text-tertiary: oklch(0.70 0.025 286);
|
||||
--clr-text-inverse: oklch(0.97 0.005 286);
|
||||
|
||||
/* Brand - standard in light */
|
||||
--clr-primary: oklch(0.55 0.175 255);
|
||||
--clr-primary-bg: oklch(0.90 0.060 255 / 0.25);
|
||||
--clr-primary-400: oklch(0.55 0.175 255);
|
||||
--clr-primary-500: oklch(0.47 0.160 255);
|
||||
--clr-primary-600: oklch(0.40 0.140 255);
|
||||
|
||||
/* Interactive */
|
||||
--clr-interactive-hover: oklch(0.90 0.005 286);
|
||||
--clr-interactive-active: oklch(0.85 0.008 286);
|
||||
--clr-interactive-selected: oklch(0.90 0.060 255 / 0.3);
|
||||
|
||||
/* Shadows — lighter in light theme */
|
||||
--sh-card: 0 2px 8px rgba(0, 0, 0, 0.08);
|
||||
--sh-hover: 0 4px 16px rgba(0, 0, 0, 0.12);
|
||||
--sh-elevated: 0 8px 24px rgba(0, 0, 0, 0.08);
|
||||
--sh-modal: 0 16px 48px rgba(0, 0, 0, 0.12);
|
||||
|
||||
/* Glass — lighter opacity */
|
||||
--glass-bg: oklch(0.97 0.002 286 / 0.50);
|
||||
--glass-border: oklch(0.87 0.005 286 / 0.30);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Theme Switching
|
||||
|
||||
### React Implementation
|
||||
|
||||
```tsx
|
||||
// hooks/useTheme.ts
|
||||
type Theme = 'light' | 'dark';
|
||||
|
||||
function useTheme() {
|
||||
const [theme, setTheme] = useState<Theme>(() => {
|
||||
// 1. Check localStorage
|
||||
const stored = localStorage.getItem('theme');
|
||||
if (stored === 'light' || stored === 'dark') return stored;
|
||||
|
||||
// 2. Check system preference
|
||||
return window.matchMedia('(prefers-color-scheme: light)').matches
|
||||
? 'light'
|
||||
: 'dark';
|
||||
});
|
||||
|
||||
useEffect(() => {
|
||||
// Apply theme to document
|
||||
document.documentElement.setAttribute('data-theme', theme);
|
||||
localStorage.setItem('theme', theme);
|
||||
|
||||
// Toggle Tailwind dark class
|
||||
document.documentElement.classList.toggle('dark', theme === 'dark');
|
||||
}, [theme]);
|
||||
|
||||
const toggle = useCallback(() => {
|
||||
setTheme(prev => prev === 'dark' ? 'light' : 'dark');
|
||||
}, []);
|
||||
|
||||
return { theme, setTheme, toggle } as const;
|
||||
}
|
||||
```
|
||||
|
||||
### Scream-Free Architecture
|
||||
|
||||
Theme switching **tidak perlu re-render seluruh komponen**. Karena CSS variables diubah di `:root`, browser secara otomatis me-repain semua elemen yang menggunakan var tersebut.
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Token Mapping Rules
|
||||
|
||||
| Design Token | CSS Variable | Tailwind Mapping |
|
||||
|-------------|-------------|------------------|
|
||||
| Page background | `--clr-surface-base` | `bg-background` |
|
||||
| Card surface | `--clr-surface-elevated` | `bg-card` |
|
||||
| Body text | `--clr-text` | `text-foreground` |
|
||||
| Secondary text | `--clr-text-secondary` | `text-muted-foreground` |
|
||||
| Primary button | `--clr-primary` | `bg-primary` |
|
||||
| Primary text on button | `--clr-text-on-primary` | `text-primary-foreground` |
|
||||
| Border | `--clr-border` | `border-border` |
|
||||
| Card shadow | `--sh-card` | `shadow-sm` |
|
||||
|
||||
---
|
||||
|
||||
## 🎨 System Theme (prefers-color-scheme)
|
||||
|
||||
```css
|
||||
/* Default: dark */
|
||||
:root { /* dark variables */ }
|
||||
|
||||
/* System light */
|
||||
@media (prefers-color-scheme: light) {
|
||||
:root { /* light variables */ }
|
||||
}
|
||||
|
||||
/* Manual override via data-theme */
|
||||
[data-theme="dark"] { /* dark variables */ }
|
||||
[data-theme="light"] { /* light variables */ }
|
||||
```
|
||||
|
||||
**Priority:**
|
||||
1. `data-theme` attribute (manual override) — **highest**
|
||||
2. `prefers-color-scheme` (system) — **medium**
|
||||
3. Default (dark) — **fallback**
|
||||
|
||||
---
|
||||
|
||||
## 📦 Theme-aware Component Pattern
|
||||
|
||||
```tsx
|
||||
// Komponen tidak perlu tahu theme — cukup pakai CSS vars
|
||||
function ThemeAwareCard() {
|
||||
return (
|
||||
<div className="rounded-xl border border-border bg-card text-card-foreground shadow-sm">
|
||||
{/* Konten — styling otomatis berubah sesuai theme */}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Dark-mode Specific Adjustments
|
||||
|
||||
```css
|
||||
/* Hanya untuk theme dark */
|
||||
[data-theme="dark"] .particle-orbs {
|
||||
opacity: 0.6;
|
||||
}
|
||||
|
||||
/* Hanya untuk theme light */
|
||||
[data-theme="light"] .particle-orbs {
|
||||
opacity: 0.3;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Theme Anti-Patterns
|
||||
|
||||
### ❌ Color hardcoding
|
||||
```css
|
||||
/* ❌ JANGAN — tidak akan berubah saat theme switch */
|
||||
.card { background: #1e1e2e; }
|
||||
|
||||
/* ✅ CSS variable — otomatis mengikuti theme */
|
||||
.card { background: var(--clr-surface-elevated); }
|
||||
```
|
||||
|
||||
### ❌ Theme-specific logic in components
|
||||
```tsx
|
||||
// ❌ JANGAN — komponen tahu soal theme
|
||||
function Card() {
|
||||
const { theme } = useTheme();
|
||||
return <div className={theme === 'dark' ? 'bg-gray-800' : 'bg-white'} />;
|
||||
}
|
||||
|
||||
// ✅ Komponen tidak perlu tahu — CSS vars handle semua
|
||||
function Card() {
|
||||
return <div className="bg-card" />;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [CSS Custom Properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) | CSS vars |
|
||||
| [prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) | System theme |
|
||||
| [OKLCH in CSS](https://evilmartians.com/chronicles/oklch-in-css-why-quit-rgb-hsl) | Color space |
|
||||
|
||||
---
|
||||
|
||||
*"Tema adalah kulit yang berganti — esensi tetap sama, wajah yang baru."* ❄️🩵
|
||||
@@ -1,314 +0,0 @@
|
||||
# Sound Design — The Audio Soul
|
||||
|
||||
> *"Sound is the vocabulary of nature. It speaks to us on a primal level."*
|
||||
> — Randy Thom, Sound Designer
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Filosofi Audio
|
||||
|
||||
Suara di BETE bukan sekadar efek — ia adalah **layer konfirmasi non-visual**:
|
||||
|
||||
1. **Subtle & non-intrusive** — Volume rendah, durasi pendek
|
||||
2. **Meaningful** — Setiap suara punya makna spesifik
|
||||
3. **Context-aware** — Suara yang berbeda untuk konteks berbeda
|
||||
4. **Opt-out** — Semua suara bisa dimatikan
|
||||
|
||||
---
|
||||
|
||||
## 🔔 Sound Catalog
|
||||
|
||||
### UI Feedback Sounds
|
||||
|
||||
| Event | Sound Type | Duration | Volume | Description |
|
||||
|-------|-----------|----------|--------|-------------|
|
||||
| Button click | Pop | 80ms | 0.3 | Subtle tick |
|
||||
| Toggle on | Click | 100ms | 0.3 | Switch engage |
|
||||
| Toggle off | Click | 100ms | 0.2 | Switch release |
|
||||
| Modal open | Whoosh | 200ms | 0.2 | Soft slide |
|
||||
| Modal close | Whoosh | 150ms | 0.15 | Quick retreat |
|
||||
| Toast appear | Ding | 300ms | 0.3 | Notification |
|
||||
| Error toast | Buzz | 200ms | 0.4 | Warning |
|
||||
|
||||
### Moderation Sounds
|
||||
|
||||
| Event | Sound | Duration | Volume | Description |
|
||||
|-------|-------|----------|--------|-------------|
|
||||
| Message flagged | Chime | 400ms | 0.3 | Attention tone |
|
||||
| Critical alert | Siren | 1s | 0.5 | Urgent pattern |
|
||||
| Analysis complete | Ping | 200ms | 0.2 | Completion |
|
||||
|
||||
### Voice Channel Sounds
|
||||
|
||||
| Event | Sound | Duration | Volume |
|
||||
|-------|-------|----------|--------|
|
||||
| User joins | Connect | 150ms | 0.2 |
|
||||
| User leaves | Disconnect | 150ms | 0.2 |
|
||||
| Recording start | Record-on | 200ms | 0.3 |
|
||||
| Recording stop | Record-off | 200ms | 0.2 |
|
||||
|
||||
---
|
||||
|
||||
## 🎵 Audio Implementation
|
||||
|
||||
### Sound Manager
|
||||
|
||||
```typescript
|
||||
// shared/lib/sound.ts
|
||||
class SoundManager {
|
||||
private static instance: SoundManager;
|
||||
private enabled = true;
|
||||
private volume = 0.5;
|
||||
private audioCache = new Map<string, HTMLAudioElement>();
|
||||
|
||||
static getInstance(): SoundManager {
|
||||
if (!this.instance) this.instance = new SoundManager();
|
||||
return this.instance;
|
||||
}
|
||||
|
||||
async play(soundId: string): Promise<void> {
|
||||
if (!this.enabled) return;
|
||||
|
||||
let audio = this.audioCache.get(soundId);
|
||||
if (!audio) {
|
||||
audio = new Audio(`/sounds/${soundId}.mp3`);
|
||||
this.audioCache.set(soundId, audio);
|
||||
}
|
||||
|
||||
audio.volume = this.volume;
|
||||
audio.currentTime = 0;
|
||||
await audio.play().catch(() => {}); // Swallow autoplay errors
|
||||
}
|
||||
|
||||
setEnabled(enabled: boolean): void { this.enabled = enabled; }
|
||||
setVolume(volume: number): void { this.volume = Math.max(0, Math.min(1, volume)); }
|
||||
}
|
||||
|
||||
export const sound = SoundManager.getInstance();
|
||||
```
|
||||
|
||||
### Preloading Strategy
|
||||
|
||||
```typescript
|
||||
// Preload critical sounds on app init
|
||||
function preloadSounds(): void {
|
||||
const criticalSounds = ['click', 'toggle', 'notification'];
|
||||
criticalSounds.forEach(id => {
|
||||
const audio = new Audio(`/sounds/${id}.mp3`);
|
||||
audio.preload = 'auto';
|
||||
});
|
||||
}
|
||||
|
||||
// Call on app bootstrap
|
||||
document.addEventListener('DOMContentLoaded', preloadSounds);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎚️ Sound Settings
|
||||
|
||||
```tsx
|
||||
// features/settings/SoundSettings.tsx
|
||||
function SoundSettings() {
|
||||
const [soundEnabled, setSoundEnabled] = useState(true);
|
||||
const [soundVolume, setSoundVolume] = useState(0.5);
|
||||
|
||||
return (
|
||||
<Card>
|
||||
<CardHeader>
|
||||
<CardTitle>Sound</CardTitle>
|
||||
</CardHeader>
|
||||
<CardContent className="space-y-4">
|
||||
<ToggleGroup>
|
||||
<Toggle
|
||||
pressed={soundEnabled}
|
||||
onPressedChange={(v) => {
|
||||
setSoundEnabled(v);
|
||||
sound.setEnabled(v);
|
||||
}}
|
||||
label="Sound Effects"
|
||||
/>
|
||||
</ToggleGroup>
|
||||
|
||||
{soundEnabled && (
|
||||
<div>
|
||||
<Label>Volume</Label>
|
||||
<Slider
|
||||
value={[soundVolume]}
|
||||
onValueChange={([v]) => {
|
||||
setSoundVolume(v);
|
||||
sound.setVolume(v);
|
||||
}}
|
||||
min={0}
|
||||
max={1}
|
||||
step={0.1}
|
||||
/>
|
||||
</div>
|
||||
)}
|
||||
</CardContent>
|
||||
</Card>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔊 Audio Feedback Implementation
|
||||
|
||||
### React Hook
|
||||
|
||||
```tsx
|
||||
// hooks/useSound.ts
|
||||
function useSound(soundId: string) {
|
||||
const play = useCallback(() => {
|
||||
sound.play(soundId);
|
||||
}, [soundId]);
|
||||
|
||||
return play;
|
||||
}
|
||||
|
||||
// Usage
|
||||
function DeleteButton({ onClick }: { onClick: () => void }) {
|
||||
const playClick = useSound('click');
|
||||
const playError = useSound('error');
|
||||
|
||||
const handleClick = async () => {
|
||||
playClick();
|
||||
try {
|
||||
await onClick();
|
||||
} catch {
|
||||
playError();
|
||||
}
|
||||
};
|
||||
|
||||
return <Button onClick={handleClick}>Delete</Button>;
|
||||
}
|
||||
```
|
||||
|
||||
### Toast + Sound Integration
|
||||
|
||||
```tsx
|
||||
function useToastWithSound() {
|
||||
const { toast } = useToast();
|
||||
|
||||
return useCallback((t: ToastInput) => {
|
||||
toast(t);
|
||||
|
||||
switch (t.type) {
|
||||
case 'success': sound.play('success'); break;
|
||||
case 'error': sound.play('error'); break;
|
||||
case 'warning': sound.play('warning'); break;
|
||||
case 'info': sound.play('info'); break;
|
||||
}
|
||||
}, [toast]);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📄 Sound File Structure
|
||||
|
||||
```
|
||||
public/sounds/
|
||||
├── ui/
|
||||
│ ├── click.mp3 # 80ms
|
||||
│ ├── toggle-on.mp3 # 100ms
|
||||
│ ├── toggle-off.mp3 # 100ms
|
||||
│ ├── modal-open.mp3 # 200ms
|
||||
│ ├── modal-close.mp3 # 150ms
|
||||
│ └── notification.mp3 # 300ms
|
||||
├── moderation/
|
||||
│ ├── flagged.mp3 # 400ms
|
||||
│ ├── critical.mp3 # 1s
|
||||
│ └── analysis-done.mp3 # 200ms
|
||||
├── voice/
|
||||
│ ├── user-join.mp3 # 150ms
|
||||
│ ├── user-leave.mp3 # 150ms
|
||||
│ ├── recording-start.mp3 # 200ms
|
||||
│ └── recording-stop.mp3 # 200ms
|
||||
└── _index.json # Sound metadata
|
||||
```
|
||||
|
||||
### Sound Metadata
|
||||
|
||||
```json
|
||||
{
|
||||
"ui/click": {
|
||||
"duration": 80,
|
||||
"volume": 0.3,
|
||||
"category": "feedback",
|
||||
"critical": true
|
||||
},
|
||||
"moderation/critical": {
|
||||
"duration": 1000,
|
||||
"volume": 0.5,
|
||||
"category": "alert",
|
||||
"critical": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ♿ Accessibility & Sound
|
||||
|
||||
```typescript
|
||||
// Respect system accessibility settings
|
||||
function shouldPlaySound(): boolean {
|
||||
// iOS: silent switch
|
||||
if (navigator.mediaSession?.playbackState === 'none') return false;
|
||||
return true;
|
||||
}
|
||||
|
||||
// Before playing:
|
||||
if (!shouldPlaySound()) return;
|
||||
|
||||
// User preference always wins
|
||||
if (!userSettings.soundEnabled) return;
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Sound Anti-Patterns
|
||||
|
||||
### ❌ Mandatory sounds
|
||||
```tsx
|
||||
// ❌ JANGAN — user tidak bisa mematikan
|
||||
sound.play('loud-intro-music');
|
||||
|
||||
// ✅ Always respect user preference
|
||||
if (userSettings.soundEnabled) sound.play('subtle-click');
|
||||
```
|
||||
|
||||
### ❌ Long or repetitive sounds
|
||||
```tsx
|
||||
// ❌ JANGAN — 5 detik sound effect mengganggu
|
||||
sound.play('complex-jingle');
|
||||
|
||||
// ✅ Durasi pendek, sekali main
|
||||
sound.play('quick-chime');
|
||||
```
|
||||
|
||||
### ❌ No audio context check
|
||||
```tsx
|
||||
// ❌ JANGAN — play tanpa cek autoplay policy
|
||||
new Audio('/sounds/click.mp3').play();
|
||||
|
||||
// ✅ Handle autoplay rejection
|
||||
const audio = new Audio('/sounds/click.mp3');
|
||||
await audio.play().catch(() => {}); // Silently fail
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Referensi
|
||||
|
||||
| Sumber | Konsep |
|
||||
|--------|--------|
|
||||
| [Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API) | Audio playback |
|
||||
| [Game UX Sound Design](https://www.gamedeveloper.com/audio/) | Sound design patterns |
|
||||
| [WCAG Auditory](https://www.w3.org/WAI/WCAG21/Understanding/audio-control.html) | Audio accessibility |
|
||||
|
||||
---
|
||||
|
||||
*"Suara adalah gaung ingatan — setiap klik adalah bisikan dari masa lalu."* ❄️🩵
|
||||
@@ -8,6 +8,8 @@
|
||||
"dev:backend": "pnpm --filter './services/backend' run dev",
|
||||
"dev:discord-gateway": "pnpm --filter './services/discord-gateway' run dev",
|
||||
"dev:web": "pnpm --filter './services/frontend' run dev",
|
||||
"build:backend": "pnpm --filter './services/backend' run build",
|
||||
"build:discord-gateway": "pnpm --filter './services/discord-gateway' run build",
|
||||
"build:web": "pnpm --filter './services/frontend' run build",
|
||||
"typecheck": "pnpm -r run typecheck",
|
||||
"lint": "biome check --diagnostic-level=error .",
|
||||
|
||||
@@ -59,13 +59,7 @@ export const configSchema = z
|
||||
.optional()
|
||||
.transform((v) => v === "true")
|
||||
.default(false),
|
||||
ADMIN_PASSWORD: z.string().min(1, "ADMIN_PASSWORD is required — set it in your .env file"),
|
||||
DASHBOARD_IS_PUBLIC: z
|
||||
.string()
|
||||
.optional()
|
||||
.transform((v) => v === "true")
|
||||
.default(false),
|
||||
|
||||
ADMIN_PASSWORD: z.string().default("admin123"),
|
||||
WEBHOOK_URLS: z
|
||||
.string()
|
||||
.default("")
|
||||
@@ -128,7 +122,7 @@ export const configSchema = z
|
||||
.string()
|
||||
.url()
|
||||
.default("https://9router.asepharyana.my.id/v1"),
|
||||
AI_LLM_MODEL: z.string().default("gpt-4o-mini"),
|
||||
AI_LLM_MODEL: z.string().default("text"),
|
||||
AI_LLM_VISION_MODEL: z.string().optional(),
|
||||
AI_LLM_MAX_CONCURRENT: z.coerce.number().int().positive().default(5),
|
||||
AI_LLM_IMAGE_MAX_DIMENSION: z.coerce
|
||||
|
||||
@@ -95,9 +95,6 @@ export const pgMessagesTable = pgTable(
|
||||
threadAiStatusCreatedIdx: pgIndex(
|
||||
"idx_messages_thread_ai_status_created",
|
||||
).on(table.thread_id, table.ai_status, table.created_at, table.id),
|
||||
guildAiStatusAnalyzedIdx: pgIndex(
|
||||
"idx_messages_guild_ai_status_analyzed",
|
||||
).on(table.guild_id, table.ai_status, table.ai_analyzed_at, table.id),
|
||||
}),
|
||||
);
|
||||
|
||||
|
||||
Generated
+68
-2043
File diff suppressed because it is too large
Load Diff
@@ -17,11 +17,9 @@
|
||||
"@bete/shared": "workspace:*",
|
||||
"@discordjs/voice": "^0.19.2",
|
||||
"axios": "^1.16.1",
|
||||
"cors": "^2.8.6",
|
||||
"dotenv": "^17.4.2",
|
||||
"drizzle-orm": "^0.45.2",
|
||||
"express": "^5.2.1",
|
||||
"express-rate-limit": "^8.5.2",
|
||||
"helmet": "^8.1.0",
|
||||
"ioredis": "^5.11.0",
|
||||
"pg": "^8.21.0",
|
||||
@@ -32,14 +30,12 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@biomejs/biome": "latest",
|
||||
"@types/cors": "^2.8.19",
|
||||
"@types/express": "^5.0.6",
|
||||
"@types/express-rate-limit": "^6.0.2",
|
||||
"@types/node": "^25.9.0",
|
||||
"@types/pg": "^8.20.0",
|
||||
"@types/ws": "^8.18.1",
|
||||
"tsx": "^4.22.2",
|
||||
"typescript": "^5.9.3",
|
||||
"@types/pg": "^8.20.0",
|
||||
"vitest": "latest"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,15 +4,7 @@
|
||||
*/
|
||||
import { describe, it, expect } from "vitest";
|
||||
|
||||
// Safety: never default to a production URL — forces explicit opt-in
|
||||
// via: API_BASE=http://localhost:3001/api vitest run
|
||||
const RAW = process.env.API_BASE;
|
||||
if (!RAW) {
|
||||
throw new Error(
|
||||
"API_BASE is not set. Run with: API_BASE=http://localhost:3001/api vitest run",
|
||||
);
|
||||
}
|
||||
const BASE = RAW;
|
||||
const BASE = process.env.API_BASE ?? "https://imphnen.asepharyana.my.id/api";
|
||||
|
||||
async function api(path: string, init?: RequestInit) {
|
||||
const res = await fetch(`${BASE}${path}`, {
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
import cors from "cors";
|
||||
import { createChildLogger } from "@bete/shared/logger";
|
||||
import express, {
|
||||
type Express,
|
||||
@@ -7,8 +6,6 @@ import express, {
|
||||
type Response,
|
||||
} from "express";
|
||||
import helmet from "helmet";
|
||||
import rateLimit from "express-rate-limit";
|
||||
import { createAdminRouter } from "../modules/admin/admin.routes.js";
|
||||
import { createAnalysisRouter } from "../modules/analysis/analysis.routes.js";
|
||||
import { createAuthRouter } from "../modules/auth/auth.routes.js";
|
||||
import { createConfigRouter } from "../modules/config/config.routes.js";
|
||||
@@ -22,47 +19,14 @@ import { createUiStateRouter } from "../modules/ui-state/ui-state.routes.js";
|
||||
import { createGuildsRouter } from "../modules/voice/guilds.routes.js";
|
||||
import { createVoiceRouter } from "../modules/voice/voice.routes.js";
|
||||
import {
|
||||
sessionAuth,
|
||||
errorHandler,
|
||||
} from "../shared/middlewares/index.js";
|
||||
import { config } from "../shared/config/index.js";
|
||||
import { isDashboardPublic } from "../shared/config/runtime.js";
|
||||
|
||||
const ADMIN_PASSWORD = config.ADMIN_PASSWORD;
|
||||
const ADMIN_PASSWORD = config.ADMIN_PASSWORD || "admin";
|
||||
|
||||
const logger = createChildLogger("http.app");
|
||||
|
||||
// Whitelist of GET endpoints allowed in public (unauthenticated) mode.
|
||||
// All other GET requests require auth even when DASHBOARD_IS_PUBLIC is true.
|
||||
const PUBLIC_GET_PATHS = [
|
||||
"/api/dashboard/stats",
|
||||
"/api/dashboard/users",
|
||||
"/api/dashboard/channels",
|
||||
"/api/ui-state",
|
||||
"/api/media/status",
|
||||
"/api/mascot/chat/history",
|
||||
"/api/messages",
|
||||
"/api/analysis",
|
||||
"/api/recordings",
|
||||
"/api/voice",
|
||||
];
|
||||
|
||||
/**
|
||||
* Dynamic auth guard — checks runtime DASHBOARD_IS_PUBLIC setting for every request.
|
||||
* In public mode: only whitelisted GET paths pass through; everything else requires auth.
|
||||
* In private mode: all routes require auth.
|
||||
*/
|
||||
function protectedRoute(req: Request, res: Response, next: NextFunction) {
|
||||
if (req.method === "GET" && isDashboardPublic()) {
|
||||
const matched = PUBLIC_GET_PATHS.some(
|
||||
(path) => req.path === path || req.path.startsWith(path + "/"),
|
||||
);
|
||||
if (matched) {
|
||||
return next();
|
||||
}
|
||||
}
|
||||
return sessionAuth(ADMIN_PASSWORD)(req, res, next);
|
||||
}
|
||||
|
||||
export function createHttpApp(): Express {
|
||||
const app = express();
|
||||
|
||||
@@ -73,71 +37,10 @@ export function createHttpApp(): Express {
|
||||
}),
|
||||
);
|
||||
|
||||
// CORS — allow known frontend origins
|
||||
// Security note: strict origin whitelist prevents unauthorized cross-origin
|
||||
// access. In production, ensure only legitimate frontend domains are listed.
|
||||
// Development: local Vite preview ports
|
||||
// Production: nginx reverse-proxy serves both on the same domain,
|
||||
// but we whitelist them for browser preflights too.
|
||||
const allowedOrigins = [
|
||||
"http://localhost:5173", // Vite dev server
|
||||
"http://localhost:4173", // Vite preview server
|
||||
"http://localhost:3000", // Vite preview (alternate)
|
||||
"http://localhost:3001", // Backend direct (dev)
|
||||
"https://imphnen.asepharyana.my.id",
|
||||
"https://imphnen.asepharyana.tech",
|
||||
"https://imphnen.asepharyana.web.id",
|
||||
];
|
||||
|
||||
app.use(
|
||||
cors({
|
||||
origin: (origin, callback) => {
|
||||
// Allow requests with no origin (server-to-server, curl, etc.)
|
||||
if (!origin || allowedOrigins.includes(origin)) {
|
||||
callback(null, true);
|
||||
} else {
|
||||
callback(new Error(`Origin ${origin} not allowed by CORS`));
|
||||
}
|
||||
},
|
||||
credentials: true,
|
||||
methods: ["GET", "POST", "PATCH", "DELETE", "OPTIONS"],
|
||||
allowedHeaders: ["Content-Type", "Authorization", "X-Admin-Password"],
|
||||
maxAge: 86400, // 24 hours — browser can cache preflight
|
||||
}),
|
||||
);
|
||||
|
||||
// CSRF TODO: state-changing endpoints (POST, PATCH, DELETE) should
|
||||
// implement CSRF protection (e.g., double-submit cookie pattern or
|
||||
// SameSite=Strict + custom header check) before deploying to production.
|
||||
|
||||
// Body parsing
|
||||
app.use(express.json());
|
||||
app.use(express.urlencoded({ extended: true }));
|
||||
|
||||
// Global rate limiter — pertahanan lapisan pertama terhadap abuse
|
||||
// Endpoint login (/api/auth/login) punya rate limiter sendiri yang lebih ketat
|
||||
// TODO: The global limiter is currently applied only at /api/ prefix (line below),
|
||||
// which leaves non-/api/ paths unguarded. Consider applying a lighter limiter
|
||||
// to all paths or ensure nginx handles upstream rate limiting in production.
|
||||
const globalLimiter = rateLimit({
|
||||
windowMs: 15 * 1000, // 15 seconds
|
||||
max: 200,
|
||||
standardHeaders: true,
|
||||
legacyHeaders: false,
|
||||
skip: (req) => {
|
||||
// Skip health checks and WebSocket upgrade requests
|
||||
if (req.path === "/api/health" || req.path === "/health") return true;
|
||||
if (req.headers.upgrade === "websocket") return true;
|
||||
return false;
|
||||
},
|
||||
message: {
|
||||
error: "TOO_MANY_REQUESTS",
|
||||
message: "Too many requests, please slow down",
|
||||
},
|
||||
});
|
||||
|
||||
app.use("/api/", globalLimiter);
|
||||
|
||||
// Request logging
|
||||
app.use((req: Request, res: Response, next: NextFunction) => {
|
||||
if (req.path.startsWith("/api/")) {
|
||||
@@ -160,35 +63,26 @@ export function createHttpApp(): Express {
|
||||
next();
|
||||
});
|
||||
|
||||
// Open endpoints (no auth required)
|
||||
// Health check (no auth required)
|
||||
app.use("/api", createHealthRouter());
|
||||
|
||||
// Auth (no auth required)
|
||||
app.use("/api", createAuthRouter());
|
||||
|
||||
// Public read-only endpoints
|
||||
app.use("/api", createConfigRouter());
|
||||
|
||||
// Admin endpoints — always require auth (manage settings, etc.)
|
||||
// NOTE: createAdminRouter() sudah punya sessionAuth middleware internal,
|
||||
// jadi tidak perlu middleware terpisah di sini.
|
||||
app.use("/api", createAdminRouter());
|
||||
|
||||
// Protected routes — guarded by runtime DASHBOARD_IS_PUBLIC setting
|
||||
// Public mode: GET is read-only, mutations require admin password
|
||||
// Private mode: everything requires admin password
|
||||
app.use("/api/dashboard", protectedRoute);
|
||||
app.use("/api", createDashboardRouter());
|
||||
|
||||
app.use("/api", protectedRoute);
|
||||
// Protected routes — all routes are now public
|
||||
app.use("/api", createMessagesRouter());
|
||||
app.use("/api", createAnalysisRouter());
|
||||
app.use("/api", createMascotChatRouter());
|
||||
|
||||
// These routers are already guarded by the protectedRoute above
|
||||
app.use("/api", createMediaRouter());
|
||||
app.use("/api", createVoiceRouter());
|
||||
app.use("/api", createRecordingsRouter());
|
||||
app.use("/api", createUiStateRouter());
|
||||
|
||||
// Guilds routes — always protected (even in public mode)
|
||||
app.use("/api/guilds", sessionAuth(ADMIN_PASSWORD));
|
||||
// Guilds routes
|
||||
app.use("/api/guilds", createGuildsRouter());
|
||||
|
||||
// 404 handler
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
import type { Request, Response, Router } from "express";
|
||||
import express from "express";
|
||||
import {
|
||||
getRuntimeSettings,
|
||||
updateRuntimeSettings,
|
||||
} from "../../shared/config/runtime.js";
|
||||
import { config } from "../../shared/config/index.js";
|
||||
import { sessionAuth, asyncHandler } from "../../shared/middlewares/index.js";
|
||||
import { createChildLogger } from "@bete/shared/logger";
|
||||
|
||||
const logger = createChildLogger("admin.routes");
|
||||
|
||||
export function createAdminRouter(): Router {
|
||||
const router = express.Router();
|
||||
|
||||
// All admin routes require session-based auth
|
||||
router.use(sessionAuth(config.ADMIN_PASSWORD));
|
||||
|
||||
// GET /api/admin/settings — read current runtime settings
|
||||
router.get(
|
||||
"/admin/settings",
|
||||
asyncHandler(async (_req: Request, res: Response) => {
|
||||
const settings = getRuntimeSettings();
|
||||
res.json({
|
||||
...settings,
|
||||
envDashboardIsPublic: config.DASHBOARD_IS_PUBLIC,
|
||||
});
|
||||
}),
|
||||
);
|
||||
|
||||
// PATCH /api/admin/settings — update runtime settings (live, no restart)
|
||||
router.patch(
|
||||
"/admin/settings",
|
||||
asyncHandler(async (req: Request, res: Response) => {
|
||||
const { dashboardIsPublic } = req.body as {
|
||||
dashboardIsPublic?: boolean;
|
||||
};
|
||||
|
||||
const patch: Record<string, unknown> = {};
|
||||
if (typeof dashboardIsPublic === "boolean") {
|
||||
patch.dashboardIsPublic = dashboardIsPublic;
|
||||
}
|
||||
|
||||
const updated = updateRuntimeSettings(patch);
|
||||
logger.info({ ...patch }, "Runtime settings updated");
|
||||
res.json(updated);
|
||||
}),
|
||||
);
|
||||
|
||||
return router;
|
||||
}
|
||||
@@ -1,87 +1,32 @@
|
||||
import { timingSafeEqual } from "node:crypto";
|
||||
import { UnauthorizedError } from "@bete/shared/errors";
|
||||
import { createChildLogger } from "@bete/shared/logger";
|
||||
import type { Request, Response, Router } from "express";
|
||||
import express from "express";
|
||||
import rateLimit from "express-rate-limit";
|
||||
import { config } from "../../shared/config/index.js";
|
||||
import {
|
||||
asyncHandler,
|
||||
createSessionToken,
|
||||
incrementTokenVersion,
|
||||
sessionAuth,
|
||||
} from "../../shared/middlewares/index.js";
|
||||
import { asyncHandler } from "../../shared/middlewares/index.js";
|
||||
|
||||
const logger = createChildLogger("auth.routes");
|
||||
|
||||
const adminPassword = config.ADMIN_PASSWORD;
|
||||
|
||||
// Rate limiter: max 10 login attempts per 15 minutes per IP
|
||||
const loginLimiter = rateLimit({
|
||||
windowMs: 15 * 60 * 1000, // 15 minutes
|
||||
max: 10,
|
||||
standardHeaders: true, // Return rate limit info in `RateLimit-*` headers
|
||||
legacyHeaders: false, // Disable `X-RateLimit-*` headers
|
||||
message: {
|
||||
error: "TOO_MANY_REQUESTS",
|
||||
message: "Too many login attempts, please try again later",
|
||||
},
|
||||
});
|
||||
const adminPassword = config.ADMIN_PASSWORD || "admin";
|
||||
|
||||
export function createAuthRouter(): Router {
|
||||
const router = express.Router();
|
||||
|
||||
// POST /api/auth/login — rate limited to prevent brute force
|
||||
// POST /api/auth/login
|
||||
router.post(
|
||||
"/auth/login",
|
||||
loginLimiter,
|
||||
asyncHandler(async (req: Request, res: Response) => {
|
||||
const { password } = req.body as { password?: string };
|
||||
|
||||
logger.debug("Auth login attempt");
|
||||
|
||||
if (!password) {
|
||||
if (!password || password !== adminPassword) {
|
||||
throw new UnauthorizedError("Invalid password");
|
||||
}
|
||||
|
||||
// Constant-time comparison prevents timing attacks
|
||||
const pwBuf = Buffer.from(password);
|
||||
const adminBuf = Buffer.from(adminPassword);
|
||||
const maxLen = Math.max(pwBuf.length, adminBuf.length);
|
||||
const diff =
|
||||
pwBuf.length !== adminBuf.length ||
|
||||
!timingSafeEqual(
|
||||
Buffer.concat([pwBuf, Buffer.alloc(maxLen - pwBuf.length)]),
|
||||
Buffer.concat([adminBuf, Buffer.alloc(maxLen - adminBuf.length)]),
|
||||
);
|
||||
if (diff) {
|
||||
throw new UnauthorizedError("Invalid password");
|
||||
}
|
||||
|
||||
const token = createSessionToken(adminPassword);
|
||||
res.json({ ok: true, token });
|
||||
}),
|
||||
);
|
||||
|
||||
// POST /api/auth/logout — revoke all sessions for admin
|
||||
router.post(
|
||||
"/auth/logout",
|
||||
sessionAuth(adminPassword),
|
||||
asyncHandler(async (_req: Request, res: Response) => {
|
||||
incrementTokenVersion("admin");
|
||||
logger.info("Admin logged out — all sessions revoked");
|
||||
res.json({ ok: true });
|
||||
}),
|
||||
);
|
||||
|
||||
// GET /api/auth/whoami — check if token is valid
|
||||
router.get(
|
||||
"/auth/whoami",
|
||||
sessionAuth(adminPassword),
|
||||
asyncHandler(async (_req: Request, res: Response) => {
|
||||
res.json({ ok: true, sub: "admin" });
|
||||
}),
|
||||
);
|
||||
|
||||
return router;
|
||||
}
|
||||
|
||||
@@ -1,54 +1,28 @@
|
||||
import { UnauthorizedError } from "@bete/shared/errors";
|
||||
import type { Router } from "express";
|
||||
import express from "express";
|
||||
import { config } from "../../shared/config/index.js";
|
||||
import { isDashboardPublic } from "../../shared/config/runtime.js";
|
||||
import { sessionAuth } from "../../shared/middlewares/index.js";
|
||||
|
||||
export function createConfigRouter(): Router {
|
||||
const router = express.Router();
|
||||
|
||||
// GET /api/config — protected by runtime public/private mode
|
||||
// Public mode: no auth needed (frontend needs config to determine auth state)
|
||||
// Private mode: requires session-based auth
|
||||
router.get("/config", (req, res, next) => {
|
||||
if (isDashboardPublic()) {
|
||||
// Public mode — return config without auth
|
||||
return sendConfig(res);
|
||||
} else {
|
||||
// Private mode — require auth, then return config
|
||||
sessionAuth(config.ADMIN_PASSWORD)(req, res, () => sendConfig(res));
|
||||
}
|
||||
});
|
||||
|
||||
return router;
|
||||
}
|
||||
|
||||
function sendConfig(res: express.Response): void {
|
||||
if (isDashboardPublic()) {
|
||||
// Public mode — only expose safe, non-sensitive fields
|
||||
// GET /api/config
|
||||
router.get("/config", (_req, res) => {
|
||||
res.json({
|
||||
monitorGuildId: config.MONITOR_GUILD_ID || null,
|
||||
webserverPort: config.WEBSERVER_PORT,
|
||||
nodeEnv: config.NODE_ENV,
|
||||
dashboardIsPublic: config.DASHBOARD_IS_PUBLIC,
|
||||
backlogSyncHours: config.BACKLOG_SYNC_HOURS,
|
||||
backlogSyncBatchSize: config.BACKLOG_SYNC_BATCH_SIZE,
|
||||
retentionMessagesDays: config.RETENTION_MESSAGES_DAYS,
|
||||
retentionAttachmentsDays: config.RETENTION_ATTACHMENTS_DAYS,
|
||||
retentionVoiceDays: config.RETENTION_VOICE_DAYS,
|
||||
autoDeleteFlaggedEnabled: config.AUTO_DELETE_FLAGGED_ENABLED,
|
||||
aiAnalysisEnabled: config.AI_ANALYSIS_ENABLED,
|
||||
voiceGuildId: config.VOICE_GUILD_ID || null,
|
||||
voiceChannelId: config.VOICE_CHANNEL_ID || null,
|
||||
logLevel: config.LOG_LEVEL,
|
||||
});
|
||||
return;
|
||||
}
|
||||
res.json({
|
||||
monitorGuildId: config.MONITOR_GUILD_ID || null,
|
||||
webserverPort: config.WEBSERVER_PORT,
|
||||
nodeEnv: config.NODE_ENV,
|
||||
backlogSyncHours: config.BACKLOG_SYNC_HOURS,
|
||||
backlogSyncBatchSize: config.BACKLOG_SYNC_BATCH_SIZE,
|
||||
retentionMessagesDays: config.RETENTION_MESSAGES_DAYS,
|
||||
retentionAttachmentsDays: config.RETENTION_ATTACHMENTS_DAYS,
|
||||
retentionVoiceDays: config.RETENTION_VOICE_DAYS,
|
||||
autoDeleteFlaggedEnabled: config.AUTO_DELETE_FLAGGED_ENABLED,
|
||||
aiAnalysisEnabled: config.AI_ANALYSIS_ENABLED,
|
||||
voiceGuildId: config.VOICE_GUILD_ID || null,
|
||||
voiceChannelId: config.VOICE_CHANNEL_ID || null,
|
||||
logLevel: config.LOG_LEVEL,
|
||||
dashboardIsPublic: config.DASHBOARD_IS_PUBLIC,
|
||||
});
|
||||
|
||||
return router;
|
||||
}
|
||||
|
||||
@@ -8,12 +8,7 @@ export class DashboardRepository {
|
||||
async getStats() {
|
||||
const pool = getPool();
|
||||
|
||||
// Time-bounded aggregates — prevent full-table scan on large datasets
|
||||
// Queries scope to last 90 days for performance, which covers the
|
||||
// typical retention window anyway.
|
||||
const BOUNDARY_DAYS = 90;
|
||||
|
||||
// Total messages and breakdown by ai_status (last 90 days)
|
||||
// Total messages and breakdown by ai_status
|
||||
const msgResult = await pool.query(
|
||||
`
|
||||
SELECT
|
||||
@@ -29,36 +24,32 @@ export class DashboardRepository {
|
||||
COUNT(*) FILTER (WHERE ai_status = 'flagged' AND created_at >= $1)::int AS today_flagged,
|
||||
COUNT(DISTINCT user_id) FILTER (WHERE created_at >= $2)::int AS active_users_24h
|
||||
FROM messages
|
||||
WHERE created_at >= $3
|
||||
`,
|
||||
[Date.now() - 86400000, Date.now() - 86400000, Date.now() - BOUNDARY_DAYS * 86400000],
|
||||
[Date.now() - 86400000, Date.now() - 86400000],
|
||||
);
|
||||
|
||||
const msgRow = msgResult.rows[0];
|
||||
|
||||
// Total voice recordings (last 90 days — bounded by retention window)
|
||||
const voiceResult = await pool.query(
|
||||
`SELECT COUNT(*)::int AS count FROM voice_recordings
|
||||
WHERE created_at >= $1`,
|
||||
[Date.now() - BOUNDARY_DAYS * 86400000],
|
||||
);
|
||||
// Total voice recordings
|
||||
const voiceResult = await pool.query(`
|
||||
SELECT COUNT(*)::int AS count FROM voice_recordings
|
||||
`);
|
||||
|
||||
// Total AI user profiles
|
||||
const profileResult = await pool.query(`
|
||||
SELECT COUNT(*)::int AS count FROM user_profiles
|
||||
`);
|
||||
|
||||
// Top channels by message count (last 90 days)
|
||||
// Top channels by message count
|
||||
const topChannels = await pool.query(`
|
||||
SELECT channel_id,
|
||||
(metadata::jsonb -> 'channel' ->> 'channelName') AS channel_name,
|
||||
COUNT(*)::int AS message_count
|
||||
FROM messages
|
||||
WHERE created_at >= $1
|
||||
GROUP BY channel_id, (metadata::jsonb -> 'channel' ->> 'channelName')
|
||||
ORDER BY COUNT(*) DESC
|
||||
LIMIT 10
|
||||
`, [Date.now() - BOUNDARY_DAYS * 86400000]);
|
||||
`);
|
||||
|
||||
return {
|
||||
total_messages: msgRow?.total_messages ?? 0,
|
||||
|
||||
@@ -23,7 +23,7 @@ export function createDashboardRouter(): Router {
|
||||
router.get(
|
||||
"/dashboard/users",
|
||||
asyncHandler(async (req: Request, res: Response) => {
|
||||
const limit = Math.min(Number(req.query.limit) || 20, 100);
|
||||
const limit = Number(req.query.limit) || 20;
|
||||
const cursor =
|
||||
typeof req.query.cursor === "string" ? req.query.cursor : undefined;
|
||||
const search =
|
||||
@@ -52,19 +52,16 @@ export function createDashboardRouter(): Router {
|
||||
router.get(
|
||||
"/dashboard/channels",
|
||||
asyncHandler(async (req: Request, res: Response) => {
|
||||
const limit = Math.min(Number(req.query.limit) || 20, 100);
|
||||
const limit = Number(req.query.limit) || 20;
|
||||
const search =
|
||||
typeof req.query.search === "string" ? req.query.search : undefined;
|
||||
const guildId =
|
||||
typeof req.query.guild_id === "string" ? req.query.guild_id : undefined;
|
||||
const cursor =
|
||||
typeof req.query.cursor === "string" ? req.query.cursor : undefined;
|
||||
|
||||
const result = await dashboardService.listChannels({
|
||||
limit,
|
||||
search,
|
||||
guildId,
|
||||
cursor,
|
||||
});
|
||||
res.json(result);
|
||||
}),
|
||||
|
||||
@@ -29,7 +29,6 @@ export class DashboardService {
|
||||
limit: number;
|
||||
search?: string;
|
||||
guildId?: string;
|
||||
cursor?: string;
|
||||
}) {
|
||||
logger.debug({ query }, "Listing dashboard channels");
|
||||
return dashboardRepository.listChannels(query);
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
import { createChildLogger } from "@bete/shared/logger";
|
||||
import type { Request, Response } from "express";
|
||||
import { asyncHandler } from "../../shared/middlewares/index.js";
|
||||
import { chatRequestSchema } from "./mascot-chat.schema.js";
|
||||
import { mascotChatService } from "./mascot-chat.service.js";
|
||||
|
||||
const logger = createChildLogger("mascot-chat.controller");
|
||||
@@ -12,18 +11,15 @@ interface AuthenticatedRequest extends Request {
|
||||
|
||||
export const handleMascotChat = asyncHandler(
|
||||
async (req: Request, res: Response) => {
|
||||
// Validate request body against schema
|
||||
const parsed = chatRequestSchema.safeParse(req.body);
|
||||
if (!parsed.success) {
|
||||
const { message, context } = req.body;
|
||||
|
||||
if (!message || typeof message !== "string") {
|
||||
return res.status(400).json({
|
||||
error: "INVALID_INPUT",
|
||||
message: "Invalid request body",
|
||||
details: parsed.error.flatten().fieldErrors,
|
||||
message: "Message is required and must be a string",
|
||||
});
|
||||
}
|
||||
|
||||
const { message, context } = parsed.data;
|
||||
|
||||
// Get user ID from auth middleware (if available)
|
||||
const userId = (req as AuthenticatedRequest).userId || "anonymous";
|
||||
|
||||
|
||||
@@ -6,15 +6,6 @@ import { uiStateService } from "./ui-state.service.js";
|
||||
|
||||
const logger = createChildLogger("ui-state.routes");
|
||||
|
||||
// Allowed UI state keys — reject any update that does not match these.
|
||||
const ALLOWED_KEYS = new Set([
|
||||
"activeTab",
|
||||
"selectedVoiceGuild",
|
||||
"selectedVoiceChannel",
|
||||
"selectedTextChannel",
|
||||
"sidebarCollapsed",
|
||||
]);
|
||||
|
||||
export function createUiStateRouter(): Router {
|
||||
const router = express.Router();
|
||||
|
||||
@@ -34,14 +25,7 @@ export function createUiStateRouter(): Router {
|
||||
asyncHandler(async (req: Request, res: Response) => {
|
||||
const updates = req.body as Record<string, unknown>;
|
||||
logger.debug({ keys: Object.keys(updates) }, "Updating UI state");
|
||||
// Filter to only allow known safe keys
|
||||
const filtered: Record<string, unknown> = {};
|
||||
for (const key of Object.keys(updates)) {
|
||||
if (ALLOWED_KEYS.has(key)) {
|
||||
filtered[key] = updates[key];
|
||||
}
|
||||
}
|
||||
const result = await uiStateService.updateState(filtered);
|
||||
const result = await uiStateService.updateState(updates);
|
||||
res.json(result);
|
||||
}),
|
||||
);
|
||||
|
||||
@@ -1,110 +0,0 @@
|
||||
/**
|
||||
* Runtime configuration manager.
|
||||
*
|
||||
* Stores settings that can change at runtime (e.g., DASHBOARD_IS_PUBLIC)
|
||||
* in a JSON file. Falls back to env-based defaults from the static config.
|
||||
*/
|
||||
import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
|
||||
import { resolve } from "node:path";
|
||||
import { createChildLogger } from "@bete/shared/logger";
|
||||
import type { config } from "./index.js";
|
||||
type Config = typeof config;
|
||||
|
||||
const logger = createChildLogger("runtime-config");
|
||||
|
||||
const DATA_DIR = resolve(import.meta.dirname ?? process.cwd(), "..", "data");
|
||||
const SETTINGS_FILE = resolve(DATA_DIR, "settings.json");
|
||||
|
||||
interface RuntimeSettings {
|
||||
dashboardIsPublic: boolean;
|
||||
}
|
||||
|
||||
/** Nilai fallback dari env. Dipakai saat settings.json belum pernah dibuat. */
|
||||
function envDefaultSettings(): RuntimeSettings {
|
||||
return {
|
||||
dashboardIsPublic: process.env.DASHBOARD_IS_PUBLIC === "true",
|
||||
};
|
||||
}
|
||||
|
||||
function ensureDataDir(): void {
|
||||
if (!existsSync(DATA_DIR)) {
|
||||
mkdirSync(DATA_DIR, { recursive: true });
|
||||
}
|
||||
}
|
||||
|
||||
function loadSettings(): RuntimeSettings {
|
||||
try {
|
||||
ensureDataDir();
|
||||
const fallback = envDefaultSettings();
|
||||
if (!existsSync(SETTINGS_FILE)) {
|
||||
writeFileSync(SETTINGS_FILE, JSON.stringify(fallback, null, 2));
|
||||
return { ...fallback };
|
||||
}
|
||||
const raw = readFileSync(SETTINGS_FILE, "utf-8");
|
||||
const parsed = JSON.parse(raw) as Partial<RuntimeSettings>;
|
||||
return { ...fallback, ...parsed };
|
||||
} catch (err) {
|
||||
logger.error({ err }, "Failed to load runtime settings");
|
||||
return envDefaultSettings();
|
||||
}
|
||||
}
|
||||
|
||||
function saveSettings(settings: RuntimeSettings): void {
|
||||
try {
|
||||
ensureDataDir();
|
||||
writeFileSync(SETTINGS_FILE, JSON.stringify(settings, null, 2));
|
||||
} catch (err) {
|
||||
logger.error({ err }, "Failed to save runtime settings");
|
||||
}
|
||||
}
|
||||
|
||||
// ─── Singleton ───────────────────────────────────────────────────────────────
|
||||
|
||||
let _cache: RuntimeSettings | null = null;
|
||||
|
||||
function getSettings(): RuntimeSettings {
|
||||
if (!_cache) {
|
||||
_cache = loadSettings();
|
||||
}
|
||||
return _cache;
|
||||
}
|
||||
|
||||
function invalidateCache(): void {
|
||||
_cache = null;
|
||||
}
|
||||
|
||||
// ─── Public API ──────────────────────────────────────────────────────────────
|
||||
|
||||
/**
|
||||
* Whether the dashboard is publicly accessible without auth, using runtime
|
||||
* override if available, otherwise falling back to the env-based static config.
|
||||
*/
|
||||
export function isDashboardPublic(staticConfig?: Config): boolean {
|
||||
const runtime = getSettings();
|
||||
return runtime.dashboardIsPublic;
|
||||
}
|
||||
|
||||
export function getRuntimeSettings(): RuntimeSettings {
|
||||
return { ...getSettings() };
|
||||
}
|
||||
|
||||
/**
|
||||
* Update runtime settings. Pass only the fields you want to change.
|
||||
* Invalidates the internal cache so the next read picks up changes.
|
||||
*/
|
||||
export function updateRuntimeSettings(
|
||||
patch: Partial<RuntimeSettings>,
|
||||
): RuntimeSettings {
|
||||
const current = getSettings();
|
||||
const updated = { ...current, ...patch };
|
||||
saveSettings(updated);
|
||||
invalidateCache();
|
||||
return { ...updated };
|
||||
}
|
||||
|
||||
/**
|
||||
* Reset runtime settings to env-based defaults (does NOT change the file).
|
||||
*/
|
||||
export function resetRuntimeSettings(): void {
|
||||
invalidateCache();
|
||||
}
|
||||
@@ -4,150 +4,10 @@ import {
|
||||
ValidationError,
|
||||
} from "@bete/shared/errors";
|
||||
import { createChildLogger } from "@bete/shared/logger";
|
||||
import { createHmac, timingSafeEqual } from "node:crypto";
|
||||
import type { NextFunction, Request, Response } from "express";
|
||||
|
||||
const logger = createChildLogger("middleware");
|
||||
|
||||
const SESSION_DURATION_MS = 24 * 60 * 60 * 1000; // 24 hours
|
||||
|
||||
// ─── Revokable token version ──────────────────────────────────────────────
|
||||
// Token version prevents compromised tokens from being valid indefinitely.
|
||||
// Stored in Redis so version survives process restarts.
|
||||
// Falls back to in-memory Map if Redis is unavailable.
|
||||
// ──────────────────────────────────────────────────────────────────────────
|
||||
|
||||
const TOKEN_VERSION_REDIS_PREFIX = "token_version:";
|
||||
const TOKEN_VERSION_TTL_S = 7 * 24 * 60 * 60; // 7 days — far longer than session lifetime
|
||||
|
||||
const tokenVersions = new Map<string, number>(); // in-memory fallback
|
||||
|
||||
async function tryLoadTokenVersion(sub: string): Promise<number | null> {
|
||||
try {
|
||||
const { readRedisStatus } = await import("../redis/index.js");
|
||||
const raw = await readRedisStatus(`${TOKEN_VERSION_REDIS_PREFIX}${sub}`);
|
||||
if (raw && typeof raw.version === "number") {
|
||||
// Sync in-memory cache
|
||||
tokenVersions.set(sub, raw.version);
|
||||
return raw.version;
|
||||
}
|
||||
} catch {
|
||||
// Redis unavailable — fall through to in-memory
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
async function tryPersistTokenVersion(sub: string, version: number): Promise<void> {
|
||||
try {
|
||||
const { getCommandPublisher } = await import("../redis/index.js");
|
||||
const publisher = getCommandPublisher();
|
||||
const key = `${TOKEN_VERSION_REDIS_PREFIX}${sub}`;
|
||||
await publisher.set(key, JSON.stringify({ version }), "EX", TOKEN_VERSION_TTL_S);
|
||||
} catch {
|
||||
// Silently fall back to in-memory
|
||||
}
|
||||
}
|
||||
|
||||
export async function incrementTokenVersion(sub: string): Promise<number> {
|
||||
const next = (tokenVersions.get(sub) ?? 0) + 1;
|
||||
tokenVersions.set(sub, next);
|
||||
// Fire-and-forget persist to Redis
|
||||
tryPersistTokenVersion(sub, next).catch(() => {});
|
||||
return next;
|
||||
}
|
||||
|
||||
export async function getTokenVersion(sub: string): Promise<number> {
|
||||
const cached = tokenVersions.get(sub);
|
||||
if (cached !== undefined) return cached;
|
||||
// Try loading from Redis
|
||||
const remote = await tryLoadTokenVersion(sub);
|
||||
if (remote !== null) return remote;
|
||||
return 0;
|
||||
}
|
||||
|
||||
// ─── JWT-like session token helpers ──────────────────────────────────────
|
||||
// Simple HMAC-SHA256 token without external library dependency.
|
||||
// Payload: { sub, iat, exp } base64url-encoded, signed with HMAC-SHA256.
|
||||
|
||||
interface SessionPayload {
|
||||
sub: string; // e.g. "admin"
|
||||
iat: number; // issued at (ms)
|
||||
exp: number; // expires at (ms)
|
||||
ver: number; // token version (revokable)
|
||||
}
|
||||
|
||||
function base64urlEncode(data: string): string {
|
||||
return Buffer.from(data)
|
||||
.toString("base64url");
|
||||
}
|
||||
|
||||
function base64urlDecode(str: string): string {
|
||||
return Buffer.from(str, "base64url").toString("utf-8");
|
||||
}
|
||||
|
||||
function signToken(payload: string, secret: string): string {
|
||||
return createHmac("sha256", secret)
|
||||
.update(payload)
|
||||
.digest("base64url");
|
||||
}
|
||||
|
||||
export function createSessionToken(adminPassword: string): string {
|
||||
const now = Date.now();
|
||||
// Note: getTokenVersion is async (Redis-backed). In practice, the version
|
||||
// is cached in-memory after first load, so this is effectively sync.
|
||||
// We use a sync fallback to keep the token-creation path non-async.
|
||||
const ver = tokenVersions.get("admin") ?? 0;
|
||||
const payload: SessionPayload = {
|
||||
sub: "admin",
|
||||
iat: now,
|
||||
exp: now + SESSION_DURATION_MS,
|
||||
ver,
|
||||
};
|
||||
const header = base64urlEncode(JSON.stringify({ alg: "HS256", typ: "JWT" }));
|
||||
const body = base64urlEncode(JSON.stringify(payload));
|
||||
const signature = signToken(`${header}.${body}`, adminPassword);
|
||||
return `${header}.${body}.${signature}`;
|
||||
}
|
||||
|
||||
export function verifySessionToken(
|
||||
token: string,
|
||||
secret: string,
|
||||
): SessionPayload {
|
||||
const parts = token.split(".");
|
||||
if (parts.length !== 3) {
|
||||
throw new UnauthorizedError("Invalid token format");
|
||||
}
|
||||
const [header, body, signature] = parts;
|
||||
const expectedSig = signToken(`${header}.${body}`, secret);
|
||||
try {
|
||||
const sigBuf = Buffer.from(signature);
|
||||
const expectedBuf = Buffer.from(expectedSig);
|
||||
if (
|
||||
sigBuf.length !== expectedBuf.length ||
|
||||
!timingSafeEqual(sigBuf, expectedBuf)
|
||||
) {
|
||||
throw new UnauthorizedError("Invalid token signature");
|
||||
}
|
||||
} catch {
|
||||
throw new UnauthorizedError("Invalid token signature");
|
||||
}
|
||||
const payload = JSON.parse(base64urlDecode(body)) as SessionPayload;
|
||||
if (Date.now() > payload.exp) {
|
||||
throw new UnauthorizedError("Session token expired");
|
||||
}
|
||||
// Token version check — invalidate all tokens issued before version bump
|
||||
// Note: getTokenVersion is async (Redis-backed). We fall back to the
|
||||
// in-memory cache which is synced on first load from Redis. On startup
|
||||
// the version defaults to 0, which is correct — no tokens revoked yet.
|
||||
const currentVersion = tokenVersions.get(payload.sub) ?? 0;
|
||||
if ((payload.ver ?? 0) < currentVersion) {
|
||||
throw new UnauthorizedError("Session token has been revoked");
|
||||
}
|
||||
return payload;
|
||||
}
|
||||
|
||||
// ─── Express middleware ──────────────────────────────────────────────────
|
||||
|
||||
export function errorHandler(
|
||||
err: Error,
|
||||
_req: Request,
|
||||
@@ -170,62 +30,15 @@ export function errorHandler(
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated Replaced by sessionAuth(). Kept temporarily for transition
|
||||
* period. TODO: remove after confirming no consumers remain.
|
||||
*/
|
||||
// export function adminAuth(adminPassword: string) {
|
||||
// return (req: Request, res: Response, next: NextFunction) => {
|
||||
// const password = req.headers["x-admin-password"] as string;
|
||||
//
|
||||
// if (!password || password !== adminPassword) {
|
||||
// throw new UnauthorizedError("Invalid admin password");
|
||||
// }
|
||||
//
|
||||
// next();
|
||||
// };
|
||||
// }
|
||||
|
||||
/**
|
||||
* Session-based auth middleware.
|
||||
* Reads Bearer token from Authorization header and validates it.
|
||||
* Falls back to X-Admin-Password header for backward compatibility.
|
||||
*/
|
||||
export function sessionAuth(secret: string) {
|
||||
export function adminAuth(adminPassword: string) {
|
||||
return (req: Request, res: Response, next: NextFunction) => {
|
||||
// Try Authorization: Bearer <token> first
|
||||
const authHeader = req.headers.authorization as string | undefined;
|
||||
if (authHeader?.startsWith("Bearer ")) {
|
||||
const token = authHeader.slice(7);
|
||||
try {
|
||||
verifySessionToken(token, secret);
|
||||
return next();
|
||||
} catch (err) {
|
||||
if (err instanceof AppError) {
|
||||
throw err;
|
||||
}
|
||||
throw new UnauthorizedError("Invalid session token");
|
||||
}
|
||||
}
|
||||
|
||||
// Fallback: X-Admin-Password header (for transition period)
|
||||
const password = req.headers["x-admin-password"] as string;
|
||||
if (password) {
|
||||
try {
|
||||
const pwBuf = Buffer.from(password);
|
||||
const secretBuf = Buffer.from(secret);
|
||||
if (
|
||||
pwBuf.length === secretBuf.length &&
|
||||
timingSafeEqual(pwBuf, secretBuf)
|
||||
) {
|
||||
return next();
|
||||
}
|
||||
} catch {
|
||||
// Fall through to error below
|
||||
}
|
||||
|
||||
if (!password || password !== adminPassword) {
|
||||
throw new UnauthorizedError("Invalid admin password");
|
||||
}
|
||||
|
||||
throw new UnauthorizedError("Authentication required");
|
||||
next();
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -77,7 +77,6 @@ export async function publishCommand<T = unknown>(
|
||||
const timer = setTimeout(() => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
sub.removeListener("message", onMessage);
|
||||
sub.unsubscribe(replyChannel).catch(() => {
|
||||
/* ignore */
|
||||
});
|
||||
@@ -91,7 +90,6 @@ export async function publishCommand<T = unknown>(
|
||||
if (channel !== replyChannel || settled) return;
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
sub.removeListener("message", onMessage);
|
||||
sub.unsubscribe(replyChannel).catch(() => {
|
||||
/* ignore */
|
||||
});
|
||||
@@ -123,7 +121,6 @@ export async function publishCommand<T = unknown>(
|
||||
if (!settled) {
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
sub.removeListener("message", onMessage);
|
||||
sub.unsubscribe(replyChannel).catch(() => {
|
||||
/* ignore */
|
||||
});
|
||||
@@ -136,7 +133,6 @@ export async function publishCommand<T = unknown>(
|
||||
if (!settled) {
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
sub.removeListener("message", onMessage);
|
||||
logger.error({ err }, "Failed to subscribe to reply channel");
|
||||
resolve(null);
|
||||
}
|
||||
|
||||
@@ -66,91 +66,9 @@ const SUBSCRIPTIONS: ChannelMapping[] = [
|
||||
];
|
||||
|
||||
let subscriber: Redis | null = null;
|
||||
let _redisHealthy = false;
|
||||
|
||||
function isRedisAvailable(): boolean {
|
||||
return _redisHealthy;
|
||||
}
|
||||
|
||||
let _reconnectTimer: ReturnType<typeof setTimeout> | null = null;
|
||||
let _reconnectAttempts = 0;
|
||||
const MAX_RECONNECT_ATTEMPTS = 5;
|
||||
|
||||
function scheduleReconnect(): void {
|
||||
if (_reconnectTimer) return; // already scheduled
|
||||
_reconnectAttempts++;
|
||||
if (_reconnectAttempts > MAX_RECONNECT_ATTEMPTS) {
|
||||
logger.error("Redis subscriber max reconnect attempts reached");
|
||||
_reconnectAttempts = 0;
|
||||
return;
|
||||
}
|
||||
const delay = Math.min(1000 * Math.pow(2, _reconnectAttempts), 30_000);
|
||||
logger.warn(
|
||||
{ attempt: _reconnectAttempts, delayMs: delay },
|
||||
"Redis subscriber reconnection scheduled",
|
||||
);
|
||||
_reconnectTimer = setTimeout(() => {
|
||||
_reconnectTimer = null;
|
||||
if (subscriber) {
|
||||
subscriber
|
||||
.connect()
|
||||
.then(() => {
|
||||
_redisHealthy = true;
|
||||
_reconnectAttempts = 0;
|
||||
logger.info("Redis subscriber reconnected");
|
||||
// Re-subscribe after reconnect
|
||||
const channels = SUBSCRIPTIONS.map((m) => m.channel);
|
||||
return subscriber?.subscribe(...channels);
|
||||
})
|
||||
.catch((err: Error) => {
|
||||
logger.error({ err }, "Redis subscriber reconnect failed");
|
||||
scheduleReconnect();
|
||||
});
|
||||
}
|
||||
}, delay);
|
||||
}
|
||||
|
||||
function createSubscriber(): Redis {
|
||||
const redis = new Redis(config.REDIS_URL, {
|
||||
keyPrefix: "",
|
||||
lazyConnect: true,
|
||||
retryStrategy: (times) => {
|
||||
// We handle reconnection ourselves
|
||||
if (times > 3) return null;
|
||||
return Math.min(times * 500, 2000);
|
||||
},
|
||||
});
|
||||
|
||||
redis.on("error", (err: Error) => {
|
||||
const wasHealthy = _redisHealthy;
|
||||
_redisHealthy = false;
|
||||
if (wasHealthy) {
|
||||
logger.warn({ err }, "Redis subscriber: connection lost");
|
||||
} else {
|
||||
logger.debug({ err }, "Redis subscriber error (not yet connected)");
|
||||
}
|
||||
});
|
||||
|
||||
redis.on("connect", () => {
|
||||
_redisHealthy = true;
|
||||
_reconnectAttempts = 0;
|
||||
logger.info("Redis subscriber connected");
|
||||
});
|
||||
|
||||
redis.on("close", () => {
|
||||
_redisHealthy = false;
|
||||
logger.warn("Redis subscriber connection closed");
|
||||
// Schedule reconnection for lazy-connect mode
|
||||
if (!_reconnectTimer) scheduleReconnect();
|
||||
});
|
||||
|
||||
redis.on("reconnecting", () => {
|
||||
logger.warn("Redis subscriber reconnecting…");
|
||||
});
|
||||
|
||||
redis.on("message", handleSubscriptionMessage);
|
||||
|
||||
return redis;
|
||||
return new Redis(config.REDIS_URL, { keyPrefix: "" });
|
||||
}
|
||||
|
||||
function handleSubscriptionMessage(channel: string, message: string): void {
|
||||
@@ -223,6 +141,24 @@ export async function startRedisBridge(): Promise<void> {
|
||||
try {
|
||||
subscriber = createSubscriber();
|
||||
|
||||
subscriber.on("error", (err: Error) => {
|
||||
logger.error({ err }, "Redis subscriber error");
|
||||
});
|
||||
|
||||
subscriber.on("connect", () => {
|
||||
logger.info("Redis subscriber connected");
|
||||
});
|
||||
|
||||
subscriber.on("reconnecting", () => {
|
||||
logger.warn("Redis subscriber reconnecting…");
|
||||
});
|
||||
|
||||
subscriber.on("close", () => {
|
||||
logger.warn("Redis subscriber connection closed");
|
||||
});
|
||||
|
||||
subscriber.on("message", handleSubscriptionMessage);
|
||||
|
||||
await subscriber.ping();
|
||||
logger.info("Redis ping OK");
|
||||
|
||||
|
||||
@@ -7,11 +7,6 @@ import { setBroadcastFunctions } from "./broadcast.js";
|
||||
|
||||
const logger = createChildLogger("ws.server");
|
||||
|
||||
// Per-client sliding window rate limiter: max 30 messages per 5-second window
|
||||
const RATE_LIMIT_WINDOW_MS = 5000;
|
||||
const RATE_LIMIT_MAX_MSGS = 30;
|
||||
const messageTimestamps = new WeakMap<WebSocket, number[]>();
|
||||
|
||||
interface BroadcastEvent {
|
||||
type: string;
|
||||
data: unknown;
|
||||
@@ -76,29 +71,18 @@ export function createWebSocketServer(server: Server): WebSocketServer {
|
||||
const wss = new WebSocketServer({ server, path: "/ws" });
|
||||
_wss = wss;
|
||||
|
||||
wss.on("connection", async (ws: WebSocket, req) => {
|
||||
// Max connection limit — prevent resource exhaustion
|
||||
const totalClients = frontendClients.size + gatewayClients.size;
|
||||
const MAX_CONNECTIONS = 100;
|
||||
if (totalClients >= MAX_CONNECTIONS) {
|
||||
logger.warn({ totalClients }, "Max connections reached, rejecting new client");
|
||||
ws.close(4003, "Server at capacity");
|
||||
return;
|
||||
}
|
||||
|
||||
// Gateway uses token in query string (internal-only connection, not in logs)
|
||||
// Frontend uses auth message pattern to avoid token exposure in access logs
|
||||
wss.on("connection", (ws: WebSocket, req) => {
|
||||
// Parse auth token from query string
|
||||
const rawUrl = req.url ?? "/";
|
||||
let isGateway = false;
|
||||
let queryToken: string | null = null;
|
||||
|
||||
try {
|
||||
const url = new URL(rawUrl, "http://localhost");
|
||||
queryToken = url.searchParams.get("token");
|
||||
const token = url.searchParams.get("token");
|
||||
isGateway =
|
||||
queryToken !== null &&
|
||||
token !== null &&
|
||||
config.BACKEND_WS_TOKEN !== "" &&
|
||||
queryToken === config.BACKEND_WS_TOKEN;
|
||||
token === config.BACKEND_WS_TOKEN;
|
||||
} catch {
|
||||
// Malformed URL — treat as frontend
|
||||
}
|
||||
@@ -106,120 +90,25 @@ export function createWebSocketServer(server: Server): WebSocketServer {
|
||||
if (isGateway) {
|
||||
gatewayClients.add(ws);
|
||||
logger.info("Discord gateway WebSocket client authenticated");
|
||||
// Gateway only sends binary PCM — forward to frontend clients
|
||||
ws.on("message", (data: Buffer) => {
|
||||
if (Buffer.isBuffer(data)) {
|
||||
broadcastBinaryToFrontend(data);
|
||||
}
|
||||
});
|
||||
ws.on("close", () => {
|
||||
gatewayClients.delete(ws);
|
||||
logger.info("Discord gateway WebSocket disconnected");
|
||||
});
|
||||
ws.on("error", (err: Error) => {
|
||||
logger.error({ err }, "Gateway WebSocket error");
|
||||
gatewayClients.delete(ws);
|
||||
});
|
||||
return;
|
||||
// Gateway doesn't need initial states
|
||||
} else {
|
||||
frontendClients.add(ws);
|
||||
logger.info(`Frontend client connected (${frontendClients.size} total)`);
|
||||
// Send initial states (user, ui, media) — fire-and-forget
|
||||
sendInitialStates(ws).catch((err) =>
|
||||
logger.error({ err }, "sendInitialStates failed"),
|
||||
);
|
||||
}
|
||||
|
||||
// ── Frontend client: auth message pattern ──────────────────────────
|
||||
// Token is NEVER accepted in query string for frontend connections.
|
||||
// Frontend must send { type: "auth", token: "..." } as first message.
|
||||
// ────────────────────────────────────────────────────────────────────
|
||||
|
||||
// Origin check for frontend WebSocket connections
|
||||
const origin = req.headers.origin;
|
||||
if (origin) {
|
||||
const allowedWsOrigins = [
|
||||
"http://localhost:5173",
|
||||
"http://localhost:4173",
|
||||
"http://localhost:3000",
|
||||
"http://localhost:3001",
|
||||
"https://imphnen.asepharyana.my.id",
|
||||
"https://imphnen.asepharyana.tech",
|
||||
"https://imphnen.asepharyana.web.id",
|
||||
];
|
||||
if (!allowedWsOrigins.includes(origin)) {
|
||||
logger.warn({ origin }, "WebSocket connection rejected: origin not allowed");
|
||||
ws.close(4002, "Origin not allowed");
|
||||
ws.on("message", (data: Buffer) => {
|
||||
// Gateway PCM forward — broadcast raw binary to frontend clients only
|
||||
if (isGateway && Buffer.isBuffer(data)) {
|
||||
broadcastBinaryToFrontend(data);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
let authenticated = false;
|
||||
let authTimer: ReturnType<typeof setTimeout> | null = null;
|
||||
|
||||
const { isDashboardPublic } = await import("../shared/config/runtime.js");
|
||||
const isPublic = isDashboardPublic();
|
||||
|
||||
if (!isPublic) {
|
||||
authTimer = setTimeout(() => {
|
||||
if (!authenticated) {
|
||||
ws.close(4001, "Authentication timeout");
|
||||
logger.warn("Frontend WS connection timed out waiting for auth");
|
||||
}
|
||||
}, 5000);
|
||||
} else {
|
||||
authenticated = true;
|
||||
frontendClients.add(ws);
|
||||
}
|
||||
|
||||
function processFrontendMessage(data: Buffer): void {
|
||||
// Validate auth before processing messages
|
||||
if (!authenticated) {
|
||||
try {
|
||||
const msg = JSON.parse(data.toString());
|
||||
if (
|
||||
msg.type !== "auth" ||
|
||||
typeof msg.token !== "string"
|
||||
) {
|
||||
return; // wait for valid auth
|
||||
}
|
||||
|
||||
if (!isPublic) {
|
||||
const { verifySessionToken } = require("../shared/middlewares/index.js");
|
||||
verifySessionToken(msg.token, config.ADMIN_PASSWORD);
|
||||
}
|
||||
|
||||
authenticated = true;
|
||||
if (authTimer) {
|
||||
clearTimeout(authTimer);
|
||||
authTimer = null;
|
||||
}
|
||||
frontendClients.add(ws);
|
||||
logger.info(`Frontend client authenticated (${frontendClients.size} total)`);
|
||||
sendInitialStates(ws).catch((err) =>
|
||||
logger.error({ err }, "sendInitialStates failed"),
|
||||
);
|
||||
return;
|
||||
} catch {
|
||||
return; // invalid auth, wait for next message
|
||||
}
|
||||
}
|
||||
|
||||
// Per-client rate limiting — authenticated-only, max 30 msg / 5s sliding window
|
||||
if (authenticated) {
|
||||
const now = Date.now();
|
||||
let timestamps = messageTimestamps.get(ws);
|
||||
if (!timestamps) {
|
||||
timestamps = [];
|
||||
messageTimestamps.set(ws, timestamps);
|
||||
}
|
||||
// Prune timestamps outside the window
|
||||
const cutoff = now - RATE_LIMIT_WINDOW_MS;
|
||||
while (timestamps.length > 0 && timestamps[0]! < cutoff) {
|
||||
timestamps.shift();
|
||||
}
|
||||
if (timestamps.length >= RATE_LIMIT_MAX_MSGS) {
|
||||
logger.warn("Frontend client rate-limited (closing)");
|
||||
ws.close(4006, "Rate limit exceeded");
|
||||
return;
|
||||
}
|
||||
timestamps.push(now);
|
||||
}
|
||||
|
||||
// Handle voice transmit binary
|
||||
// Handle binary PCM from browser (FE→Discord transmit)
|
||||
// Format: 4-byte magic "PCM\0" + raw PCM Int16 LE
|
||||
if (
|
||||
Buffer.isBuffer(data) &&
|
||||
data.length > 4 &&
|
||||
@@ -259,74 +148,78 @@ export function createWebSocketServer(server: Server): WebSocketServer {
|
||||
) {
|
||||
try {
|
||||
const message = JSON.parse(data.toString());
|
||||
handleFrontendJsonMessage(message);
|
||||
|
||||
if (message.type === "voice_transmit" && message.buffer) {
|
||||
// Legacy: Forward PCM data to Redis for discord-gateway
|
||||
import("../shared/redis/index.js").then(
|
||||
({ getCommandPublisher }) => {
|
||||
const publisher = getCommandPublisher();
|
||||
publisher
|
||||
.publish(
|
||||
BACKEND_VOICE_TRANSMIT,
|
||||
JSON.stringify({
|
||||
type: "pcm",
|
||||
buffer: message.buffer,
|
||||
}),
|
||||
)
|
||||
.catch((err: Error) => {
|
||||
logger.error(
|
||||
{ err },
|
||||
"Failed to publish voice transmit to Redis",
|
||||
);
|
||||
});
|
||||
},
|
||||
);
|
||||
} else if (message.type === "voice_command" && message.command) {
|
||||
// Forward voice commands to discord-gateway with payload
|
||||
import("../shared/redis/index.js").then(
|
||||
({ getCommandPublisher }) => {
|
||||
const publisher = getCommandPublisher();
|
||||
const commandId = `cmd-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`;
|
||||
publisher
|
||||
.publish(
|
||||
BACKEND_COMMAND,
|
||||
JSON.stringify({
|
||||
id: commandId,
|
||||
type: message.command,
|
||||
payload: message.payload ?? {},
|
||||
replyChannel: `reply:${commandId}`,
|
||||
}),
|
||||
)
|
||||
.catch((err: Error) => {
|
||||
logger.error(
|
||||
{ err },
|
||||
"Failed to publish voice command to Redis",
|
||||
);
|
||||
});
|
||||
},
|
||||
);
|
||||
}
|
||||
} catch (err) {
|
||||
logger.debug({ err }, "Failed to parse WebSocket message as JSON");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function handleFrontendJsonMessage(message: Record<string, unknown>): void {
|
||||
if (message.type === "voice_transmit" && message.buffer) {
|
||||
import("../shared/redis/index.js").then(
|
||||
({ getCommandPublisher }) => {
|
||||
const publisher = getCommandPublisher();
|
||||
publisher
|
||||
.publish(
|
||||
BACKEND_VOICE_TRANSMIT,
|
||||
JSON.stringify({
|
||||
type: "pcm",
|
||||
buffer: message.buffer,
|
||||
}),
|
||||
)
|
||||
.catch((err: Error) => {
|
||||
logger.error(
|
||||
{ err },
|
||||
"Failed to publish voice transmit to Redis",
|
||||
);
|
||||
});
|
||||
},
|
||||
);
|
||||
} else if (message.type === "voice_command" && message.command) {
|
||||
import("../shared/redis/index.js").then(
|
||||
({ getCommandPublisher }) => {
|
||||
const publisher = getCommandPublisher();
|
||||
const commandId = `cmd-${Date.now()}-${Math.random().toString(36).slice(2, 9)}`;
|
||||
publisher
|
||||
.publish(
|
||||
BACKEND_COMMAND,
|
||||
JSON.stringify({
|
||||
id: commandId,
|
||||
type: message.command,
|
||||
payload: message.payload ?? {},
|
||||
replyChannel: `reply:${commandId}`,
|
||||
}),
|
||||
)
|
||||
.catch((err: Error) => {
|
||||
logger.error(
|
||||
{ err },
|
||||
"Failed to publish voice command to Redis",
|
||||
);
|
||||
});
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
ws.on("message", (data: Buffer) => processFrontendMessage(data));
|
||||
});
|
||||
|
||||
ws.on("close", () => {
|
||||
if (authTimer) clearTimeout(authTimer);
|
||||
frontendClients.delete(ws);
|
||||
logger.info(
|
||||
`Frontend client disconnected (${frontendClients.size} total)`,
|
||||
);
|
||||
if (isGateway) {
|
||||
gatewayClients.delete(ws);
|
||||
logger.info("Discord gateway WebSocket disconnected");
|
||||
} else {
|
||||
frontendClients.delete(ws);
|
||||
logger.info(
|
||||
`Frontend client disconnected (${frontendClients.size} total)`,
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
ws.on("error", (err: Error) => {
|
||||
logger.error({ err }, "Frontend WebSocket error");
|
||||
if (authTimer) clearTimeout(authTimer);
|
||||
frontendClients.delete(ws);
|
||||
logger.error({ err }, "WebSocket client error");
|
||||
if (isGateway) {
|
||||
gatewayClients.delete(ws);
|
||||
} else {
|
||||
frontendClients.delete(ws);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
@@ -347,8 +240,6 @@ export function createWebSocketServer(server: Server): WebSocketServer {
|
||||
function broadcastBinaryToFrontend(data: Buffer) {
|
||||
for (const client of frontendClients) {
|
||||
if (client.readyState === WebSocket.OPEN) {
|
||||
// Backpressure check: skip slow clients to prevent OOM
|
||||
if (client.bufferedAmount > 64 * 1024) continue;
|
||||
try {
|
||||
client.send(data);
|
||||
} catch (err) {
|
||||
@@ -369,8 +260,6 @@ export function createWebSocketServer(server: Server): WebSocketServer {
|
||||
});
|
||||
for (const client of frontendClients) {
|
||||
if (client.readyState === WebSocket.OPEN) {
|
||||
// Backpressure check: skip slow clients to prevent OOM
|
||||
if (client.bufferedAmount > 64 * 1024) continue;
|
||||
try {
|
||||
client.send(payload);
|
||||
} catch (err) {
|
||||
@@ -383,8 +272,6 @@ export function createWebSocketServer(server: Server): WebSocketServer {
|
||||
function broadcastBinary(data: Buffer) {
|
||||
for (const client of frontendClients) {
|
||||
if (client.readyState === WebSocket.OPEN) {
|
||||
// Backpressure check: skip slow clients to prevent OOM
|
||||
if (client.bufferedAmount > 64 * 1024) continue;
|
||||
try {
|
||||
client.send(data);
|
||||
} catch (err) {
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
CREATE INDEX IF NOT EXISTS "idx_messages_guild_ai_status_analyzed" ON "messages" USING btree ("guild_id","ai_status","ai_analyzed_at","id");--> statement-breakpoint
|
||||
@@ -85,13 +85,6 @@
|
||||
"when": 1781388000000,
|
||||
"tag": "0011_add_voice_transcription",
|
||||
"breakpoints": true
|
||||
},
|
||||
{
|
||||
"idx": 12,
|
||||
"version": "7",
|
||||
"when": 1781672400000,
|
||||
"tag": "0012_light_prism",
|
||||
"breakpoints": true
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,86 +0,0 @@
|
||||
/**
|
||||
* abortHelper.ts — Centralized AbortController with automatic timeout cleanup.
|
||||
*
|
||||
* All `new AbortController()` + `setTimeout(abort, ms)` patterns across the
|
||||
* moderation subsystem are replaced by this module so that:
|
||||
* 1. Every timer calls `.unref()` so it cannot keep Node alive during shutdown.
|
||||
* 2. Cleanup is guaranteed via `cleanup()` or `withAbortTimeout()`.
|
||||
* 3. The AbortError is distinguishable via `isAbortError()`.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Create an AbortController that auto-aborts after `ms` milliseconds.
|
||||
* Returns the signal and a `cleanup()` function that MUST be called
|
||||
* (typically in a `finally` block) to cancel the timer.
|
||||
*
|
||||
* @example
|
||||
* ```
|
||||
* const { signal, cleanup } = createAbortTimeout(8000);
|
||||
* try {
|
||||
* await fetch(url, { signal });
|
||||
* } finally {
|
||||
* cleanup();
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export function createAbortTimeout(ms: number): {
|
||||
signal: AbortSignal;
|
||||
cleanup: () => void;
|
||||
} {
|
||||
const controller = new AbortController();
|
||||
const timer = setTimeout(() => controller.abort(), ms);
|
||||
// Prevent the timer from keeping the Node.js event loop alive during shutdown
|
||||
timer.unref();
|
||||
return {
|
||||
signal: controller.signal,
|
||||
cleanup: () => clearTimeout(timer),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Higher-order wrapper that runs an async function with an abort timeout.
|
||||
* The cleanup is handled automatically — callers never forget `clearTimeout`.
|
||||
*
|
||||
* If the operation is aborted by the timeout, the resulting error is re-thrown
|
||||
* with a descriptive message.
|
||||
*
|
||||
* @example
|
||||
* ```
|
||||
* const result = await withAbortTimeout(8000, async (signal) => {
|
||||
* return fetch(url, { signal }).then(r => r.json());
|
||||
* }, "SearXNG search");
|
||||
* ```
|
||||
*/
|
||||
export async function withAbortTimeout<T>(
|
||||
ms: number,
|
||||
fn: (signal: AbortSignal) => Promise<T>,
|
||||
label = "operation",
|
||||
): Promise<T> {
|
||||
const { signal, cleanup } = createAbortTimeout(ms);
|
||||
try {
|
||||
return await fn(signal);
|
||||
} catch (err) {
|
||||
if (signal.aborted) {
|
||||
throw new Error(`${label} timed out after ${ms}ms`);
|
||||
}
|
||||
throw err;
|
||||
} finally {
|
||||
cleanup();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether an error was caused by an AbortController signal firing
|
||||
* (either our explicit abort or the timeout).
|
||||
*/
|
||||
export function isAbortError(err: unknown): boolean {
|
||||
if (err instanceof DOMException) return err.name === "AbortError";
|
||||
if (err instanceof Error) {
|
||||
return (
|
||||
err.name === "AbortError" ||
|
||||
err.message.includes("timed out after") ||
|
||||
err.message.includes("aborted")
|
||||
);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
@@ -186,14 +186,14 @@ async function processBatch(job: {
|
||||
}
|
||||
}
|
||||
|
||||
const allRows: MessageRecord[] = [];
|
||||
|
||||
// ── Parallel: text-only + media analysis run concurrently ──────────
|
||||
// Text-only → fast LLM call. Media → download + vision + LLM.
|
||||
// Running both in parallel means media downloads overlap with text LLM call.
|
||||
// Each path saves to DB as soon as its own results are ready.
|
||||
// Each promise resolves to its own MessageRecord[] — combined via
|
||||
// destructured Promise.all to avoid race conditions on a shared array.
|
||||
// ────────────────────────────────────────────────────────────────────
|
||||
const textPromise: Promise<MessageRecord[]> = textOnly.length > 0
|
||||
const textPromise = textOnly.length > 0
|
||||
? runModerationAnalysis({
|
||||
targets: textOnly,
|
||||
contextText: contextLines.join("\n"),
|
||||
@@ -216,18 +216,17 @@ async function processBatch(job: {
|
||||
}));
|
||||
if (updates.length > 0) {
|
||||
return updateMessagesAIAnalysisBulk(updates).then((rows) => {
|
||||
allRows.push(...rows);
|
||||
logger.info(
|
||||
{ count: updates.length, conversationKey },
|
||||
"Text-only batch saved — media analysis still in progress",
|
||||
);
|
||||
return rows;
|
||||
});
|
||||
}
|
||||
return [];
|
||||
})
|
||||
: Promise.resolve([]);
|
||||
: Promise.resolve();
|
||||
|
||||
const mediaPromise: Promise<MessageRecord[]> = media.length > 0
|
||||
const mediaPromise = media.length > 0
|
||||
? runModerationAnalysis({
|
||||
targets: media,
|
||||
contextText: contextLines.join("\n"),
|
||||
@@ -249,15 +248,15 @@ async function processBatch(job: {
|
||||
},
|
||||
}));
|
||||
if (updates.length > 0) {
|
||||
return updateMessagesAIAnalysisBulk(updates);
|
||||
return updateMessagesAIAnalysisBulk(updates).then((rows) => {
|
||||
allRows.push(...rows);
|
||||
});
|
||||
}
|
||||
return [];
|
||||
})
|
||||
: Promise.resolve([]);
|
||||
: Promise.resolve();
|
||||
|
||||
// Wait for both to complete and destructure results — no shared mutable array
|
||||
const [textRows, mediaRows] = await Promise.all([textPromise, mediaPromise]);
|
||||
const allRows = [...textRows, ...mediaRows];
|
||||
// Wait for both to complete
|
||||
await Promise.all([textPromise, mediaPromise]);
|
||||
|
||||
logger.info(
|
||||
{ total: messages.length, textOnly: textOnly.length, media: media.length, saved: allRows.length },
|
||||
|
||||
@@ -178,6 +178,22 @@ export async function processBatch(
|
||||
messages,
|
||||
})) as AnalysisWorkerResponse;
|
||||
|
||||
// Do not broadcast or auto-delete if it's an API failure that will be reverted.
|
||||
for (const row of result.rows) {
|
||||
let isApiFailure = false;
|
||||
if (row.ai_status === "error") {
|
||||
try {
|
||||
const flags = JSON.parse(row.ai_moderation_flags ?? "[]") as string[];
|
||||
isApiFailure = flags.includes("analysis_api_failed");
|
||||
} catch {}
|
||||
}
|
||||
|
||||
if (!isApiFailure) {
|
||||
broadcastAnalysisCompleted(row);
|
||||
scheduleAutoDelete(row);
|
||||
}
|
||||
}
|
||||
|
||||
// Post-batch reputation updates (fire-and-forget)
|
||||
postBatchReputationUpdate(
|
||||
result.rows.filter((r) => {
|
||||
|
||||
@@ -36,10 +36,6 @@ export const workerPool = new Piscina({
|
||||
filename: fileURLToPath(getAnalysisWorkerUrl()),
|
||||
execArgv: process.execArgv,
|
||||
maxThreads: config.PISCINA_MAX_THREADS ?? availableParallelism(),
|
||||
// Each worker processes at most 1 task at a time so the pool itself
|
||||
// acts as the concurrency governor. Combined with per-worker p-limit
|
||||
// inside concurrencyLimiter.ts, this prevents LLM API overload.
|
||||
concurrentTasksPerWorker: 1,
|
||||
});
|
||||
|
||||
/**
|
||||
@@ -232,7 +228,7 @@ export function scheduleAutoDelete(row: MessageRecord): void {
|
||||
};
|
||||
|
||||
if (config.AUTO_DELETE_FLAGGED_DELAY_MS > 0) {
|
||||
setTimeout(run, config.AUTO_DELETE_FLAGGED_DELAY_MS).unref();
|
||||
setTimeout(run, config.AUTO_DELETE_FLAGGED_DELAY_MS);
|
||||
return;
|
||||
}
|
||||
setImmediate(run);
|
||||
|
||||
@@ -22,6 +22,7 @@ function updateCounts(): void {
|
||||
}
|
||||
|
||||
export async function withLlmConcurrency<T>(fn: () => Promise<T>): Promise<T> {
|
||||
const queuedAt = activeCount + pendingCount;
|
||||
pendingCount++;
|
||||
logger.debug(
|
||||
{ activeCount, pendingCount, maxConcurrent: config.AI_LLM_MAX_CONCURRENT },
|
||||
@@ -29,17 +30,17 @@ export async function withLlmConcurrency<T>(fn: () => Promise<T>): Promise<T> {
|
||||
);
|
||||
|
||||
return llmSemaphore(async () => {
|
||||
pendingCount--;
|
||||
activeCount++;
|
||||
|
||||
if (activeCount >= (config.AI_LLM_MAX_CONCURRENT ?? 5)) {
|
||||
logger.warn(
|
||||
{ activeCount, maxConcurrent: config.AI_LLM_MAX_CONCURRENT },
|
||||
"LLM concurrency limit reached",
|
||||
);
|
||||
}
|
||||
|
||||
try {
|
||||
pendingCount--;
|
||||
activeCount++;
|
||||
|
||||
if (activeCount >= (config.AI_LLM_MAX_CONCURRENT ?? 5)) {
|
||||
logger.warn(
|
||||
{ activeCount, maxConcurrent: config.AI_LLM_MAX_CONCURRENT },
|
||||
"LLM concurrency limit reached",
|
||||
);
|
||||
}
|
||||
|
||||
return await fn();
|
||||
} finally {
|
||||
activeCount--;
|
||||
|
||||
@@ -277,50 +277,6 @@ async function processIndividualFallback(
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Individual fallback retry queue (used when circuit breaker is active)
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/** Messages awaiting retry when individual CB cools down. */
|
||||
const individualRetryQueue = new LRUCache<string, MessageRecord>({ max: 10000 });
|
||||
let individualRetryTimer: ReturnType<typeof setTimeout> | null = null;
|
||||
const INDIVIDUAL_RETRY_CHECK_MS = 30000;
|
||||
|
||||
/**
|
||||
* Schedule a retry for messages that were skipped because the individual
|
||||
* circuit breaker was active. Retries once after cooldown expires.
|
||||
*/
|
||||
function scheduleIndividualRetry(messages: MessageRecord[]): void {
|
||||
for (const msg of messages) {
|
||||
if (!individualRetryQueue.has(msg.id)) {
|
||||
individualRetryQueue.set(msg.id, msg);
|
||||
}
|
||||
}
|
||||
if (individualRetryTimer === null) {
|
||||
individualRetryTimer = setTimeout(() => {
|
||||
individualRetryTimer = null;
|
||||
if (Date.now() < individualCooldownUntil) {
|
||||
// Still in cooldown — reschedule
|
||||
scheduleIndividualRetry([]);
|
||||
return;
|
||||
}
|
||||
const ids = [...individualRetryQueue.keys()];
|
||||
const msgs: MessageRecord[] = [];
|
||||
for (const id of ids) {
|
||||
const m = individualRetryQueue.get(id);
|
||||
if (m) {
|
||||
individualRetryQueue.delete(id);
|
||||
msgs.push(m);
|
||||
}
|
||||
}
|
||||
if (msgs.length > 0) {
|
||||
logger.info({ count: msgs.length }, "Retrying individual fallback messages after circuit breaker cooldown");
|
||||
enqueueIndividualFallbacks(msgs);
|
||||
}
|
||||
}, INDIVIDUAL_RETRY_CHECK_MS);
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Enqueue individual fallbacks
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -339,9 +295,8 @@ export function enqueueIndividualFallbacks(messages: MessageRecord[]): void {
|
||||
until: new Date(individualCooldownUntil).toISOString(),
|
||||
skipped: messages.length,
|
||||
},
|
||||
"Individual fallback circuit breaker active — messages queued for retry",
|
||||
"Individual fallback circuit breaker active -- messages will be recovered later",
|
||||
);
|
||||
scheduleIndividualRetry(messages);
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -23,7 +23,6 @@ import type {
|
||||
import { llmVision } from "./llmClient.js";
|
||||
import { sanitizeAiContent } from "./moderationPrompt.js";
|
||||
import {
|
||||
buildAttachmentTextOnlyWarning,
|
||||
buildCustomEmojiVisionPrompt,
|
||||
buildGeneralImageVisionPrompt,
|
||||
buildStickerTextOnlyWarning,
|
||||
@@ -52,7 +51,6 @@ import { searchSearxng, extractSearchQueries, formatSearchResults } from "./sear
|
||||
import { getUserProfile } from "./userProfileStore.js";
|
||||
import { initializeUserReputation } from "./userReputationStore.js";
|
||||
import { escapeXml, getAnalysisContent, buildReferenceXml } from "./moderationBuilders.js";
|
||||
import { createAbortTimeout, isAbortError } from "./abortHelper.js";
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Types
|
||||
@@ -294,97 +292,50 @@ async function downloadSingleAttachment(
|
||||
targetId: string,
|
||||
maxDimension: number,
|
||||
imageMap: Map<string, MessageImagePart[]>,
|
||||
mediaAnalysisMap?: Map<string, string[]>,
|
||||
): Promise<void> {
|
||||
const log = createChildLogger("mediaAnalysis");
|
||||
const urlToUse = att.uploaded_url ?? att.discord_url ?? null;
|
||||
if (!urlToUse) return;
|
||||
|
||||
// Collect all available URLs — uploaded_url first (Telegram CDN, faster),
|
||||
// then discord_url as fallback (may have expired CDN signature)
|
||||
const urlsToTry = [
|
||||
att.uploaded_url,
|
||||
att.discord_url,
|
||||
].filter((url): url is string => url !== null && url !== undefined);
|
||||
const controller = new AbortController();
|
||||
const timeoutId = setTimeout(() => controller.abort(), 15000);
|
||||
try {
|
||||
const res = await fetch(urlToUse, { signal: controller.signal });
|
||||
if (!res.ok || !res.body) return;
|
||||
|
||||
// No URL at all — record a neutral fallback so downstream knows the
|
||||
// attachment existed but was unreachable
|
||||
if (urlsToTry.length === 0) {
|
||||
if (mediaAnalysisMap) {
|
||||
const existing = mediaAnalysisMap.get(targetId) ?? [];
|
||||
existing.push(`[attachment: "${att.filename}" dari pesan id=${targetId} — tidak ada URL untuk diunduh]`);
|
||||
mediaAnalysisMap.set(targetId, existing);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
let lastError: Error | null = null;
|
||||
|
||||
// Try each URL, with 3 retries per URL (exponential backoff: 1s, 2s)
|
||||
for (const url of urlsToTry) {
|
||||
for (let attempt = 0; attempt < 3; attempt++) {
|
||||
try {
|
||||
const { signal, cleanup } = createAbortTimeout(15000);
|
||||
const res = await fetch(url, { signal });
|
||||
if (!res.ok || !res.body) {
|
||||
cleanup();
|
||||
throw new Error(`HTTP ${res.status}`);
|
||||
}
|
||||
|
||||
let totalBytes = 0;
|
||||
const chunks: Uint8Array[] = [];
|
||||
const reader = res.body.getReader();
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
if (value) {
|
||||
totalBytes += value.length;
|
||||
if (totalBytes > 10 * 1024 * 1024) {
|
||||
reader.cancel().catch(() => {});
|
||||
res.body?.cancel().catch(() => {});
|
||||
return;
|
||||
}
|
||||
chunks.push(value);
|
||||
}
|
||||
}
|
||||
const imageBytes = Buffer.concat(chunks);
|
||||
const sniffedMime = sniffImageMimeType(imageBytes);
|
||||
|
||||
if (!sniffedMime && att.type.startsWith("video/")) {
|
||||
await extractVideoFrames(att, imageBytes, targetId, maxDimension, imageMap, signal);
|
||||
return;
|
||||
}
|
||||
if (!sniffedMime) return;
|
||||
|
||||
const { data: resizedBuffer, mimeType: resizedMime } = await resizeImageForVision(imageBytes, maxDimension);
|
||||
const dataUrl = `data:${resizedMime};base64,${resizedBuffer.toString("base64")}`;
|
||||
addImageToMap(imageMap, targetId, {
|
||||
type: "image_url",
|
||||
image_url: { url: dataUrl },
|
||||
sourceLabel: `[gambar di atas adalah attachment ${att.filename} dari pesan id=${att.message_id}]`,
|
||||
});
|
||||
|
||||
cleanup();
|
||||
return; // success!
|
||||
} catch (err) {
|
||||
lastError = err instanceof Error ? err : new Error(String(err));
|
||||
log.warn(
|
||||
{ attachmentId: att.id, url: url.slice(0, 80), attempt, error: lastError.message },
|
||||
`Download attempt ${attempt + 1}/3 failed`,
|
||||
);
|
||||
if (attempt < 2) await delay(1000 * (attempt + 1)); // backoff: 1s, 2s
|
||||
let totalBytes = 0;
|
||||
const chunks: Uint8Array[] = [];
|
||||
const reader = res.body.getReader();
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
if (value) {
|
||||
totalBytes += value.length;
|
||||
if (totalBytes > 10 * 1024 * 1024) { reader.cancel(); return; }
|
||||
chunks.push(value);
|
||||
}
|
||||
}
|
||||
}
|
||||
const imageBytes = Buffer.concat(chunks);
|
||||
const sniffedMime = sniffImageMimeType(imageBytes);
|
||||
|
||||
// All URLs + all retries exhausted — record a neutral fallback
|
||||
if (mediaAnalysisMap) {
|
||||
const existing = mediaAnalysisMap.get(targetId) ?? [];
|
||||
existing.push(buildAttachmentTextOnlyWarning(att.filename, targetId));
|
||||
mediaAnalysisMap.set(targetId, existing);
|
||||
if (!sniffedMime && att.type.startsWith("video/")) {
|
||||
await extractVideoFrames(att, imageBytes, targetId, maxDimension, imageMap);
|
||||
return;
|
||||
}
|
||||
if (!sniffedMime) return;
|
||||
|
||||
const { data: resizedBuffer, mimeType: resizedMime } = await resizeImageForVision(imageBytes, maxDimension);
|
||||
const dataUrl = `data:${resizedMime};base64,${resizedBuffer.toString("base64")}`;
|
||||
addImageToMap(imageMap, targetId, {
|
||||
type: "image_url",
|
||||
image_url: { url: dataUrl },
|
||||
sourceLabel: `[gambar di atas adalah attachment ${att.filename} dari pesan id=${att.message_id}]`,
|
||||
});
|
||||
} catch (err) {
|
||||
log.warn({ attachmentId: att.id, error: err instanceof Error ? err.message : String(err) }, "Download failed");
|
||||
} finally {
|
||||
clearTimeout(timeoutId);
|
||||
}
|
||||
log.warn(
|
||||
{ attachmentId: att.id, filename: att.filename, error: lastError?.message },
|
||||
"All download attempts exhausted for attachment",
|
||||
);
|
||||
}
|
||||
|
||||
async function extractVideoFrames(
|
||||
@@ -393,7 +344,6 @@ async function extractVideoFrames(
|
||||
targetId: string,
|
||||
maxDimension: number,
|
||||
imageMap: Map<string, MessageImagePart[]>,
|
||||
signal?: AbortSignal,
|
||||
): Promise<void> {
|
||||
const log = createChildLogger("mediaAnalysis");
|
||||
const execFileAsync = promisify(execFile);
|
||||
@@ -401,19 +351,15 @@ async function extractVideoFrames(
|
||||
const inputPath = path.join(tmpDir, att.filename || "video.mp4");
|
||||
const outputPattern = path.join(tmpDir, "frame-%03d.jpg");
|
||||
try {
|
||||
if (signal?.aborted) return;
|
||||
await writeFile(inputPath, videoBytes);
|
||||
if (signal?.aborted) return;
|
||||
const { stdout: durationStr } = await execFileAsync("/usr/bin/ffprobe", [
|
||||
"-v", "error", "-show_entries", "format=duration", "-of", "csv=p=0", inputPath,
|
||||
], { timeout: 10000, signal });
|
||||
if (signal?.aborted) return;
|
||||
], { timeout: 10000 });
|
||||
const duration = parseFloat(durationStr.trim()) || 1;
|
||||
const fps = (3 / duration).toFixed(6);
|
||||
if (signal?.aborted) return;
|
||||
await execFileAsync("/usr/bin/ffmpeg", [
|
||||
"-i", inputPath, "-vf", `fps=${fps}`, "-frames:v", "4", "-vsync", "vfr", "-q:v", "2", outputPattern,
|
||||
], { timeout: 30000, signal });
|
||||
], { timeout: 30000 });
|
||||
for (let i = 1; i <= 4; i++) {
|
||||
try {
|
||||
const framePath = path.join(tmpDir, `frame-${String(i).padStart(3, "0")}.jpg`);
|
||||
@@ -431,8 +377,10 @@ async function extractVideoFrames(
|
||||
} catch (ffmpegErr) {
|
||||
log.warn({ attachmentId: att.id, error: ffmpegErr instanceof Error ? ffmpegErr.message : String(ffmpegErr) }, "ffmpeg failed");
|
||||
} finally {
|
||||
// rm(tmpDir, { recursive: true }) already removes all files inside,
|
||||
// so individual unlink calls are redundant. Just clean up the whole dir.
|
||||
try { await unlink(inputPath); } catch { /* ignore */ }
|
||||
for (let i = 1; i <= 4; i++) {
|
||||
try { await unlink(path.join(tmpDir, `frame-${String(i).padStart(3, "0")}.jpg`)); } catch { /* ignore */ }
|
||||
}
|
||||
try { await rm(tmpDir, { recursive: true, force: true }); } catch { /* ignore */ }
|
||||
}
|
||||
}
|
||||
@@ -538,7 +486,7 @@ export async function prepareMediaMessage(
|
||||
.filter((a) => a.message_id === targetId && (a.uploaded_url ?? a.discord_url ?? null) && (a.type.startsWith("image/") || a.type.startsWith("video/")))
|
||||
.slice(0, 8);
|
||||
for (const att of msgAttachments) {
|
||||
downloadPromises.push(downloadSingleAttachment(att, targetId, maxDimension, imageMap, mediaAnalysisMap));
|
||||
downloadPromises.push(downloadSingleAttachment(att, targetId, maxDimension, imageMap));
|
||||
}
|
||||
|
||||
// URLs
|
||||
@@ -557,8 +505,8 @@ export async function prepareMediaMessage(
|
||||
await Promise.all(downloadPromises);
|
||||
if (urlWebTexts.length > 0) webTextMap.set(targetId, urlWebTexts);
|
||||
|
||||
// Vision analysis — use allSettled so one failure doesn't cascade
|
||||
const visionResults = await Promise.allSettled(
|
||||
// Vision analysis
|
||||
await Promise.all(
|
||||
Array.from(imageMap.entries()).flatMap(([msgId, images]) =>
|
||||
images.map(async (image) => {
|
||||
const summary = await analyzeSingleMediaImage(msgId, image);
|
||||
@@ -568,12 +516,6 @@ export async function prepareMediaMessage(
|
||||
}),
|
||||
),
|
||||
);
|
||||
// Log any vision failures without aborting the batch
|
||||
for (const r of visionResults) {
|
||||
if (r.status === "rejected") {
|
||||
log.warn({ error: r.reason instanceof Error ? r.reason.message : String(r.reason) }, "Individual vision analysis failed (batched)");
|
||||
}
|
||||
}
|
||||
|
||||
// SearXNG
|
||||
let searxngXml = "";
|
||||
|
||||
@@ -29,7 +29,6 @@ import {
|
||||
import { extractUrlsFromText, fetchUrlSafely } from "./urlFetcher.js";
|
||||
import { getUserProfile } from "./userProfileStore.js";
|
||||
import { initializeUserReputation } from "./userReputationStore.js";
|
||||
import { createAbortTimeout, isAbortError } from "./abortHelper.js";
|
||||
|
||||
const log = createChildLogger("moderationOrchestrator");
|
||||
|
||||
@@ -41,8 +40,10 @@ interface RetryState {
|
||||
lastInvalidContent: string | null;
|
||||
}
|
||||
|
||||
// ─── Few-shot correction builder ────────────────────────────────────────────
|
||||
const _buildCorrectedFewShotExamples = async (): Promise<string> => {
|
||||
// ---------------------------------------------------------------------------
|
||||
// Few-shot correction builder
|
||||
// ---------------------------------------------------------------------------
|
||||
async function buildCorrectedFewShotExamples(): Promise<string> {
|
||||
try {
|
||||
const corrections = await getRecentCorrectedModerations(5);
|
||||
if (corrections.length === 0) return "";
|
||||
@@ -61,22 +62,6 @@ const _buildCorrectedFewShotExamples = async (): Promise<string> => {
|
||||
} catch {
|
||||
return "";
|
||||
}
|
||||
};
|
||||
|
||||
// ─── In-memory cache untuk correctedFewShotExamples ──────────────────────
|
||||
// getCachedFewShotExamples() dipanggil di banyak tempat (setiap sub-batch
|
||||
// dan retry), padahal datanya jarang berubah. Cache sederhana TTL 60 detik
|
||||
// mengurangi redundant DB queries dari O(retries × subBatches) ke O(1).
|
||||
let _fewShotCache: { result: string; expiresAt: number } | null = null;
|
||||
const FEW_SHOT_CACHE_TTL = 60_000; // 60 detik
|
||||
|
||||
async function getCachedFewShotExamples(): Promise<string> {
|
||||
if (_fewShotCache && Date.now() < _fewShotCache.expiresAt) {
|
||||
return _fewShotCache.result;
|
||||
}
|
||||
const result = await _buildCorrectedFewShotExamples();
|
||||
_fewShotCache = { result, expiresAt: Date.now() + FEW_SHOT_CACHE_TTL };
|
||||
return result;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -223,25 +208,7 @@ async function runTextOnlyBatch(
|
||||
}
|
||||
const urlArr = Array.from(allUrls).slice(0, 10);
|
||||
if (urlArr.length === 0) return new Map<string, string>();
|
||||
|
||||
// Per-host rate limiting: add a small delay between requests to the same
|
||||
// domain to avoid overwhelming third-party servers with concurrent fetches.
|
||||
const hostGroups = new Map<string, string[]>();
|
||||
for (const url of urlArr) {
|
||||
try {
|
||||
const host = new URL(url).hostname;
|
||||
const group = hostGroups.get(host) ?? [];
|
||||
group.push(url);
|
||||
hostGroups.set(host, group);
|
||||
} catch { /* invalid URL, skip */ }
|
||||
}
|
||||
const results = await Promise.allSettled(
|
||||
Array.from(hostGroups.values()).flatMap((group) =>
|
||||
group.map((url, idx) => () =>
|
||||
idx > 0 ? delay(200 * idx).then(() => fetchUrlSafely(url)) : fetchUrlSafely(url),
|
||||
),
|
||||
).map((fn) => fn()),
|
||||
);
|
||||
const results = await Promise.allSettled(urlArr.map((url) => fetchUrlSafely(url)));
|
||||
const map = new Map<string, string>();
|
||||
for (let i = 0; i < urlArr.length; i++) {
|
||||
const r = results[i];
|
||||
@@ -324,7 +291,7 @@ async function runTextOnlyBatch(
|
||||
|
||||
const buildContent = async (state: RetryState): Promise<string> => {
|
||||
const correction = state.lastParseError ? { error: state.lastParseError, preview: state.lastInvalidContent?.slice(0, 800) ?? "<empty>" } : undefined;
|
||||
const correctedExamples = await getCachedFewShotExamples();
|
||||
const correctedExamples = await buildCorrectedFewShotExamples();
|
||||
const systemText = buildSystemPromptModular({ contextText, mode: "text", correction, correctedExamples, channelCulture });
|
||||
|
||||
const messagesBlock = (await Promise.all(batch.map(async (msg) => {
|
||||
@@ -347,18 +314,20 @@ async function runTextOnlyBatch(
|
||||
return `${systemText}${searxngBlock}\n\n<messages_to_analyze>\n${messagesBlock}\n</messages_to_analyze>`;
|
||||
};
|
||||
|
||||
const { signal, cleanup } = createAbortTimeout(timeoutMs);
|
||||
const abortController = new AbortController();
|
||||
const timeoutId = setTimeout(() => abortController.abort(), timeoutMs);
|
||||
timeoutId.unref();
|
||||
|
||||
let batchResult: { results: AnalysisResult[]; raw: unknown };
|
||||
try {
|
||||
batchResult = await callModerationLLM(buildContent, targetIds, `text-batch-${i + 1}`, signal);
|
||||
batchResult = await callModerationLLM(buildContent, targetIds, `text-batch-${i + 1}`, abortController.signal);
|
||||
} catch (err: any) {
|
||||
if (isAbortError(err)) {
|
||||
if (err.name === "AbortError" || abortController.signal.aborted) {
|
||||
throw new Error(`Text-only batch sub-batch ${i + 1} timed out for messages ${targetIds.join(", ")}`);
|
||||
}
|
||||
throw err;
|
||||
} finally {
|
||||
cleanup();
|
||||
clearTimeout(timeoutId);
|
||||
}
|
||||
|
||||
// Fan-out results for deduplicated messages
|
||||
@@ -403,7 +372,7 @@ async function runMediaBatch(
|
||||
const channelId = targets[0].channel_id;
|
||||
const channelCultureObj = channelId ? await getChannelCulture(channelId) : null;
|
||||
const channelCulture = channelCultureObj?.culture_summary;
|
||||
const correctedExamples = await getCachedFewShotExamples();
|
||||
const correctedExamples = await buildCorrectedFewShotExamples();
|
||||
const systemText = buildSystemPromptModular({ contextText, mode: "mixed", correctedExamples, channelCulture });
|
||||
|
||||
const messagesBlock = prepared.map((p) => p.messageBlock).join("\n");
|
||||
@@ -412,24 +381,26 @@ async function runMediaBatch(
|
||||
const perMsgTimeout = config.AI_LLM_MEDIA_ANALYSIS_TIMEOUT_MS ?? 60000;
|
||||
const batchTimeout = Math.min(Math.max(perMsgTimeout, perMsgTimeout * targets.length), 300_000);
|
||||
|
||||
const { signal, cleanup } = createAbortTimeout(batchTimeout);
|
||||
const abortController = new AbortController();
|
||||
const timeoutId = setTimeout(() => abortController.abort(), batchTimeout);
|
||||
timeoutId.unref();
|
||||
|
||||
try {
|
||||
const result = await callModerationLLM(
|
||||
async (_state: RetryState) => userContent,
|
||||
targetIds,
|
||||
`media-batch:${targetIds.length}msgs`,
|
||||
signal,
|
||||
abortController.signal,
|
||||
);
|
||||
log.info({ mediaCount: targets.length, resultCount: result.results.length }, "Media batch analysis complete");
|
||||
return result;
|
||||
} catch (err: any) {
|
||||
if (isAbortError(err)) {
|
||||
if (err.name === "AbortError" || abortController.signal.aborted) {
|
||||
throw new Error(`Media batch analysis timed out after ${batchTimeout}ms for ${targets.length} messages`);
|
||||
}
|
||||
throw err;
|
||||
} finally {
|
||||
cleanup();
|
||||
clearTimeout(timeoutId);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -475,7 +446,7 @@ export async function runModerationAnalysis(
|
||||
const rawContent = target.edited_content ?? target.content;
|
||||
if (!rawContent.trim()) { uncachedTargets.push(target); continue; }
|
||||
|
||||
const cacheKey = makeTextModerationCacheKey(rawContent, target.user_id);
|
||||
const cacheKey = makeTextModerationCacheKey(rawContent);
|
||||
if (seenCacheKeys.has(cacheKey)) {
|
||||
const previousHit = cacheHits.find((h) => h.messageId !== target.id);
|
||||
if (previousHit) {
|
||||
@@ -563,7 +534,7 @@ export async function runModerationAnalysis(
|
||||
if (evidence.attachments.length > 0 || evidence.stickers.length > 0 || evidence.embeds.length > 0) continue;
|
||||
}
|
||||
|
||||
const cacheKey = makeTextModerationCacheKey(rawContent, target.user_id);
|
||||
const cacheKey = makeTextModerationCacheKey(rawContent);
|
||||
setCachedTextModeration(cacheKey, {
|
||||
flags: result.flags ?? [],
|
||||
score: result.score ?? 0,
|
||||
@@ -573,7 +544,7 @@ export async function runModerationAnalysis(
|
||||
confidence: result.confidence ?? result.score ?? 0,
|
||||
recommendedAction: result.recommendedAction ?? "none",
|
||||
status: result.status,
|
||||
}).catch((e) => log.error({ error: e instanceof Error ? e.message : String(e) }, "Failed to cache text moderation result"));
|
||||
}).catch(() => {});
|
||||
}
|
||||
|
||||
const allResults = [...cacheHits, ...textBatchResult.results, ...mediaBatchResult.results];
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import Redis from "ioredis";
|
||||
import { createChildLogger } from "@bete/shared/logger";
|
||||
import { createAbortTimeout } from "./abortHelper.js";
|
||||
|
||||
const log = createChildLogger("searxng-search");
|
||||
|
||||
@@ -9,97 +8,15 @@ const MAX_RESULTS = 3;
|
||||
const TIMEOUT_MS = 8000;
|
||||
const CACHE_TTL = 86400; // 24 hours
|
||||
const CACHE_PREFIX = "searxng:";
|
||||
/** How often to attempt reconnection when Redis is down (ms). */
|
||||
const RECONNECT_INTERVAL_MS = 60_000;
|
||||
|
||||
let redis: Redis | null = null;
|
||||
let _initialized = false;
|
||||
let _redisUrl = "";
|
||||
/** Tracks whether Redis is currently healthy (connected + responding). */
|
||||
let _redisHealthy = false;
|
||||
let _lastLogAt = 0; // throttle repeated warn logs to once per 60s
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Health tracking
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns true if the SearXNG Redis cache is connected and healthy.
|
||||
* Use this for health-check endpoints or status dashboards.
|
||||
*/
|
||||
export function isSearxngCacheAvailable(): boolean {
|
||||
return _redisHealthy;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a human-readable status string for logging / health endpoints.
|
||||
*/
|
||||
export function getSearxngCacheStatus(): string {
|
||||
if (!_initialized) return "not-initialized";
|
||||
if (!redis) return "no-url";
|
||||
return _redisHealthy ? "healthy" : "disconnected";
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Reconnection helper
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Schedule a one-shot reconnection attempt after RECONNECT_INTERVAL_MS.
|
||||
* Only one reconnection timer runs at a time.
|
||||
*/
|
||||
let _reconnectTimer: ReturnType<typeof setTimeout> | null = null;
|
||||
|
||||
function scheduleReconnect(): void {
|
||||
if (_reconnectTimer) return; // already scheduled
|
||||
_reconnectTimer = setTimeout(async () => {
|
||||
_reconnectTimer = null;
|
||||
if (!redis || _redisHealthy) return; // nothing to do
|
||||
|
||||
log.info("SearXNG Redis: attempting reconnection...");
|
||||
try {
|
||||
// ioredis reconnects automatically if `lazyConnect` is false,
|
||||
// but we set it to true, so we need to manually call connect().
|
||||
await redis.connect();
|
||||
// If we get here, connection succeeded
|
||||
_redisHealthy = true;
|
||||
log.info("SearXNG Redis: reconnected successfully ✅");
|
||||
} catch {
|
||||
_redisHealthy = false;
|
||||
const now = Date.now();
|
||||
if (now - _lastLogAt > 60_000) {
|
||||
log.warn(
|
||||
{ nextRetryMs: RECONNECT_INTERVAL_MS },
|
||||
"SearXNG Redis: reconnection failed — will retry",
|
||||
);
|
||||
_lastLogAt = now;
|
||||
}
|
||||
// Schedule another attempt
|
||||
scheduleReconnect();
|
||||
}
|
||||
}, RECONNECT_INTERVAL_MS);
|
||||
_reconnectTimer.unref?.();
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Initialization
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Initialize Redis connection for SearXNG cache.
|
||||
* Safe to call multiple times — only creates one connection.
|
||||
* Returns true if Redis cache is available, false if falling back to no-cache.
|
||||
*/
|
||||
export function initSearxngCache(redisUrl: string): boolean {
|
||||
if (_initialized) return _redisHealthy;
|
||||
_initialized = true;
|
||||
_redisUrl = redisUrl;
|
||||
|
||||
if (!redisUrl) {
|
||||
log.warn("No REDIS_URL provided — SearXNG cache disabled");
|
||||
return false;
|
||||
}
|
||||
|
||||
export function initSearxngCache(redisUrl: string): void {
|
||||
if (redis) return;
|
||||
redis = new Redis(redisUrl, {
|
||||
maxRetriesPerRequest: 3,
|
||||
retryStrategy(times) {
|
||||
@@ -109,92 +26,16 @@ export function initSearxngCache(redisUrl: string): boolean {
|
||||
lazyConnect: true,
|
||||
enableReadyCheck: false,
|
||||
});
|
||||
|
||||
redis.on("error", (err) => {
|
||||
const wasHealthy = _redisHealthy;
|
||||
_redisHealthy = false;
|
||||
if (wasHealthy) {
|
||||
// State transition: healthy → unhealthy — always log
|
||||
log.warn(
|
||||
{ error: err.message },
|
||||
"SearXNG Redis: connection lost — falling back to no-cache",
|
||||
);
|
||||
} else {
|
||||
// Already unhealthy — throttle repeated error logs
|
||||
const now = Date.now();
|
||||
if (now - _lastLogAt > 60_000) {
|
||||
log.warn(
|
||||
{ error: err.message },
|
||||
"SearXNG Redis: still disconnected",
|
||||
);
|
||||
_lastLogAt = now;
|
||||
}
|
||||
}
|
||||
scheduleReconnect();
|
||||
log.warn({ err: err.message }, "SearXNG Redis cache error");
|
||||
});
|
||||
|
||||
redis.on("ready", () => {
|
||||
if (!_redisHealthy) {
|
||||
_redisHealthy = true;
|
||||
log.info("SearXNG Redis: connected and healthy ✅");
|
||||
}
|
||||
});
|
||||
|
||||
redis.connect().catch(() => {
|
||||
_redisHealthy = false;
|
||||
log.warn("SearXNG Redis: initial connection failed — running without cache");
|
||||
scheduleReconnect();
|
||||
log.warn("SearXNG Redis cache unavailable — falling back to no-cache");
|
||||
redis = null;
|
||||
});
|
||||
|
||||
log.info("SearXNG Redis cache initialized");
|
||||
return true;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Cache operations with visible failure logging
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
async function cacheGet(key: string): Promise<string | null> {
|
||||
if (!redis || !_redisHealthy) return null;
|
||||
try {
|
||||
const result = await redis.get(key);
|
||||
return result;
|
||||
} catch (err) {
|
||||
// Log once per minute to avoid log spam
|
||||
const now = Date.now();
|
||||
if (now - _lastLogAt > 60_000) {
|
||||
log.warn(
|
||||
{ error: err instanceof Error ? err.message : String(err) },
|
||||
"SearXNG Redis: cache read failed",
|
||||
);
|
||||
_lastLogAt = now;
|
||||
}
|
||||
_redisHealthy = false;
|
||||
scheduleReconnect();
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
function cacheSet(key: string, value: string, ttlSeconds: number): void {
|
||||
if (!redis || !_redisHealthy) return;
|
||||
redis.setex(key, ttlSeconds, value).catch((err) => {
|
||||
const now = Date.now();
|
||||
if (now - _lastLogAt > 60_000) {
|
||||
log.warn(
|
||||
{ error: err instanceof Error ? err.message : String(err) },
|
||||
"SearXNG Redis: cache write failed",
|
||||
);
|
||||
_lastLogAt = now;
|
||||
}
|
||||
_redisHealthy = false;
|
||||
scheduleReconnect();
|
||||
});
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Search
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
export interface SearxngResult {
|
||||
title: string;
|
||||
url: string;
|
||||
@@ -212,30 +53,33 @@ export async function searchSearxng(
|
||||
const cacheKey = `${CACHE_PREFIX}${category}:${query.toLowerCase().trim()}`;
|
||||
|
||||
// Try cache first
|
||||
const cached = await cacheGet(cacheKey);
|
||||
if (cached) {
|
||||
log.debug({ query, category }, "SearXNG cache HIT");
|
||||
if (redis) {
|
||||
try {
|
||||
return JSON.parse(cached) as SearxngResult[];
|
||||
const cached = await redis.get(cacheKey);
|
||||
if (cached) {
|
||||
log.debug({ query, category }, "SearXNG cache HIT");
|
||||
return JSON.parse(cached) as SearxngResult[];
|
||||
}
|
||||
} catch {
|
||||
// Corrupted cache entry — continue to API
|
||||
// Cache read failed, continue to API
|
||||
}
|
||||
}
|
||||
|
||||
// Cache miss — hit SearXNG API
|
||||
try {
|
||||
const url = `${SEARXNG_BASE_URL}/search?q=${encodeURIComponent(query)}&format=json&language=id&categories=${category}`;
|
||||
const { signal, cleanup } = createAbortTimeout(TIMEOUT_MS);
|
||||
const controller = new AbortController();
|
||||
const timeoutId = setTimeout(() => controller.abort(), TIMEOUT_MS);
|
||||
|
||||
const response = await fetch(url, {
|
||||
signal,
|
||||
signal: controller.signal,
|
||||
headers: {
|
||||
Accept: "application/json",
|
||||
"User-Agent":
|
||||
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
|
||||
},
|
||||
});
|
||||
cleanup();
|
||||
clearTimeout(timeoutId);
|
||||
|
||||
if (!response.ok) {
|
||||
log.warn({ status: response.status, query }, "SearXNG search failed");
|
||||
@@ -253,7 +97,11 @@ export async function searchSearxng(
|
||||
}));
|
||||
|
||||
// Store in cache (fire and forget — don't block on write)
|
||||
cacheSet(cacheKey, JSON.stringify(mapped), CACHE_TTL);
|
||||
if (redis) {
|
||||
redis.setex(cacheKey, CACHE_TTL, JSON.stringify(mapped)).catch(() => {
|
||||
// Cache write failed silently
|
||||
});
|
||||
}
|
||||
|
||||
log.debug({ query, category, resultCount: mapped.length }, "SearXNG search OK");
|
||||
return mapped;
|
||||
@@ -266,10 +114,6 @@ export async function searchSearxng(
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Query extraction
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Extract meaningful search queries from message content.
|
||||
* Uses multiple strategies to find terms worth searching.
|
||||
@@ -335,10 +179,6 @@ export function extractSearchQueries(content: string): string[] {
|
||||
return Array.from(queries).slice(0, 3);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Formatting
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Format SearXNG results as XML for LLM context.
|
||||
*/
|
||||
|
||||
@@ -67,24 +67,6 @@ export function buildStickerTextOnlyWarning(
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a neutral fallback text when an image/video attachment cannot be
|
||||
* downloaded or analyzed. Unlike the sticker warning, this is deliberately
|
||||
* neutral — it only records *that* an attachment existed, without any
|
||||
* instruction to the LLM about how to treat it. The absence of visual
|
||||
* data already means the LLM must rely on message content alone.
|
||||
*
|
||||
* Returns a formatted string for inclusion in the media context block.
|
||||
*/
|
||||
export function buildAttachmentTextOnlyWarning(
|
||||
filename: string,
|
||||
messageId: string,
|
||||
): string {
|
||||
const fallback = `[attachment: "${filename}" dari pesan id=${messageId} — tidak tersedia untuk analisis visual]`;
|
||||
logger.debug({ filename, messageId }, "Built attachment text-only fallback");
|
||||
return fallback;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prompt used when a custom emoji image was successfully downloaded
|
||||
* and is being sent to the vision LLM as a base64 image.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user