create-nexwire 4.3.0 → 4.4.0

package/express/src/resources/src/stores/auth.ts

@@ -3,11 +3,11 @@ import { defineStore } from "pinia";
 import { ref } from "vue";
 import { type AuthUser, clearUser, setUser } from "@/composables/useAuth";
 
-type LoginPayload = { email?: string; phone?: string; password: string; remember?: boolean };
-type VerifyEmailPayload = { email: string; token: string };
-type ForgotPayload = { email: string };
+export type LoginPayload = { email?: string; phone?: string; password: string; remember?: boolean };
+export type VerifyEmailPayload = { email: string; token: string };
+export type ForgotPayload = { email: string };
 
-type RegisterPayload = {
+export type RegisterPayload = {
   name: string;
   email?: string;
   phone?: string;
@@ -15,7 +15,7 @@ type RegisterPayload = {
   password_confirmation: string;
 };
 
-type ResetPayload = {
+export type ResetPayload = {
   email: string;
   token: string;
   password: string;
@@ -36,7 +36,10 @@ async function request<T>(method: "GET" | "POST", path: string, payload?: unknow
     return response.data;
   } catch (error: unknown) {
     if (axios.isAxiosError(error)) {
-      throw new Error(String(error.response?.data?.message || error.message || "Request failed"));
+      // Keep the AxiosError so Gum can read `response.data` and populate
+      // form.errors, but show the API's message instead of axios's generic one.
+      error.message = String(error.response?.data?.message || error.message || "Request failed");
+      throw error;
     }
     throw new Error("Request failed");
   }

package/fastify/.dockerignore

@@ -0,0 +1,14 @@
+node_modules
+dist
+.git
+.gitignore
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+coverage
+*.log
+tmp
+temp

package/fastify/.env

@@ -0,0 +1,44 @@
+# ── App ────────────────────────────────────────────
+APP_NAME=nexwire
+APP_ENV=development
+APP_PORT=3000
+APP_URL=http://localhost:3000
+
+# Frontend origin when UI is on a different domain than the API.
+# Leave empty if UI is served from the same APP_URL.
+FRONTEND_URL=
+
+# ── Database ───────────────────────────────────────
+# Supported: sqlite:, mysql://, postgres://
+# Default is SQLite so a fresh clone runs with zero setup (no server to install).
+# The dev stack migrates + seeds automatically on first run.
+# Switch later, e.g. mysql://root:@localhost:3306/nexwire
+DATABASE_URL=sqlite:./src/storage/database/nexwire.sqlite
+
+# ── Secrets ────────────────────────────────────────
+JWT_ACCESS_SECRET=change-me-access
+JWT_REFRESH_SECRET=change-me-refresh
+COOKIE_SECRET=change-me-cookie
+STORAGE_ACCESS_KEY_ID=
+STORAGE_SECRET_ACCESS_KEY=
+MAIL_USERNAME=
+MAIL_PASSWORD=
+
+# ── Redis ──────────────────────────────────────────
+# Set true to enable cache, session, queue, events, and Queue Dashboard
+REDIS=false
+# Shared key prefix for cache, session, queue, events, and dashboards
+REDIS_URL=redis://127.0.0.1:6379
+REDIS_PREFIX=nexwire
+
+# ── Feature Toggle ─────────────────────────────────
+# Set false for API-only mode (no UI build/serve)
+UI=true
+# Set true to enable OpenAPI / Scalar docs at /api-docs
+OPEN_API=true
+# Set false to disable Socket.IO realtime server
+SOCKET=false
+# Set false to disable browser security headers (CSP, HSTS, X-Frame)
+SECURITY_HEADERS=true
+
+

package/fastify/.env.example

@@ -0,0 +1,42 @@
+# ── App ────────────────────────────────────────────
+APP_ENV=development
+APP_NAME=nexwire
+APP_PORT=3000
+APP_URL=http://localhost:3000
+
+# Frontend origin when UI is on a different domain than the API.
+# Leave empty if UI is served from the same APP_URL.
+FRONTEND_URL=
+
+# ── Database ───────────────────────────────────────
+# Supported: sqlite:, mysql://, postgres://
+# Default is SQLite so a fresh clone runs with zero setup (no server to install).
+# The dev stack migrates + seeds automatically on first run.
+# Switch later, e.g. mysql://root:@localhost:3306/nexwire
+DATABASE_URL=sqlite:./src/storage/database/nexwire.sqlite
+
+# ── Secrets ────────────────────────────────────────
+JWT_ACCESS_SECRET=change-me-access
+JWT_REFRESH_SECRET=change-me-refresh
+COOKIE_SECRET=change-me-cookie
+STORAGE_ACCESS_KEY_ID=
+STORAGE_SECRET_ACCESS_KEY=
+MAIL_USERNAME=
+MAIL_PASSWORD=
+
+# ── Redis ──────────────────────────────────────────
+# Set true to enable cache, session, queue, events, and Queue Dashboard
+REDIS=false
+# Shared key prefix for cache, session, queue, events, and dashboards
+REDIS_URL=redis://127.0.0.1:6379
+REDIS_PREFIX=nexwire
+
+# ── Feature Toggle ─────────────────────────────────
+# Set false for API-only mode (no UI build/serve)
+UI=true
+# Set true to enable OpenAPI / Scalar docs at /api-docs
+OPEN_API=true
+# Set false to disable Socket.IO realtime server
+SOCKET=false
+# Set false to disable browser security headers (CSP, HSTS, X-Frame)
+SECURITY_HEADERS=true

package/fastify/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "biomejs.biome",
+    "editorconfig.editorconfig"
+  ]
+}

package/fastify/.vscode/settings.json

@@ -0,0 +1,37 @@
+{
+  "editor.defaultFormatter": "biomejs.biome",
+  "[typescript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[vue]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[css]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[scss]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "editor.codeActionsOnSave": {
+    "source.organizeImports.biome": "explicit",
+    "source.fixAll.biome": "explicit"
+  },
+  "files.eol": "\n",
+  "files.trimTrailingWhitespace": true,
+  "files.insertFinalNewline": true
+}

package/fastify/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 - present, niYam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/fastify/README.md

@@ -0,0 +1,232 @@
+<p align="center">
+  <a href="https://github.com/niyamulahsan/nexwire">
+    <img alt="nexwire" src="https://raw.githubusercontent.com/niyamulahsan/nexwire/main/logo-favicon/nexwire.png" width="300">
+  </a>
+</p>
+
+<h3 align="center">Full-stack TypeScript framework for modern web applications</h3>
+
+<p align="center">
+  <a href="https://niyamulahsan.github.io/nexwire"><img src="https://img.shields.io/badge/docs%20%7C%20nexwire-3b8eed" alt="Documentation"></a>
+  <a href="https://www.npmjs.com/package/create-nexwire"><img src="https://img.shields.io/npm/v/create-nexwire" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/create-nexwire"><img src="https://img.shields.io/npm/dt/create-nexwire" alt="npm downloads"></a>
+  <a href="https://github.com/niyamulahsan/nexwire/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="MIT License"></a>
+  <a href="https://github.com/niyamulahsan/nexwire"><img src="https://img.shields.io/github/stars/niyamulahsan/nexwire?style=social" alt="GitHub Stars"></a>
+</p>
+
+---
+
+nexwire is a batteries-included TypeScript framework that combines modular backends (Hono, Express, Fastify) with Drizzle ORM, BullMQ, Socket.IO, Redis, and a Vue 3 SPA frontend — all scaffolded with a single command and deployed with Docker Compose.
+
+## Quick Start
+
+### Hono (default)
+
+```bash
+npm create nexwire@latest my-app
+cd my-app
+npm install
+npm run maker db:migrate --seed
+npm run maker dev
+```
+
+### Express
+
+```bash
+npm create nexwire@latest my-app -- --engine=express
+cd my-app
+npm install
+npm run maker db:migrate --seed
+npm run maker dev
+```
+
+### Fastify
+
+```bash
+npm create nexwire@latest my-app -- --engine=fastify
+cd my-app
+npm install
+npm run maker db:migrate --seed
+npm run maker dev
+```
+
+Your API is live at `http://localhost:3000`, Scalar docs at `/api-docs`, and the Vue frontend at `http://localhost:5173`.
+
+Requires **Node.js >= 22.12**. Hono and Express also support **Bun >= 1.3**; Fastify is Node-only.
+
+### Current directory
+
+Scaffold directly into the current directory:
+
+```bash
+npm create nexwire@latest .
+npm create nexwire@latest . -- --engine=express
+npm create nexwire@latest . -- --engine=fastify
+```
+
+Works with any package manager: `pnpm`, `yarn`, or `bun`.
+
+### Package Manager
+
+All examples use `npm` as the default. nexwire works with any major package manager:
+
+| Manager  | Create project                      | Run commands          |
+| -------- | ----------------------------------- | --------------------- |
+| **npm**  | `npm create nexwire@latest my-app`  | `npm run maker <cmd>` |
+| **pnpm** | `pnpm create nexwire@latest my-app` | `pnpm maker <cmd>`    |
+| **yarn** | `yarn create nexwire@latest my-app` | `yarn maker <cmd>`    |
+| **bun**  | `bun create nexwire@latest my-app`  | `bun maker <cmd>`     |
+| **all**  | `npm create nexwire@latest .`       | current directory     |
+
+### Runtime
+
+nexwire runs on **Node.js** or **Bun** — pick whichever fits your deployment:
+
+| Runtime     | Minimum version | Notes                                                                 |
+| ----------- | --------------- | --------------------------------------------------------------------- |
+| **Node.js** | `>= 22.12`      | Default. Uses `node` in Dockerfile. Required by Fastify.              |
+| **Bun**     | `>= 1.3`        | Hono and Express only. Pass `--runtime=bun` to deploy:init.           |
+
+::: tip
+The Fastify template is **Node-only** and does not include Bun support.
+:::
+
+## Features
+
+| Category            | What you get                                                                           |
+| ------------------- | -------------------------------------------------------------------------------------- |
+| **API**             | Hono/Express/Fastify HTTP server with Zod validation, OpenAPI/Scalar docs, CORS, rate limiting |
+| **Database**        | Drizzle ORM — SQLite, MySQL, or PostgreSQL. Auto-detected from `DATABASE_URL`.         |
+| **Auth**            | JWT access + refresh token rotation, signed httpOnly cookies, role middleware          |
+| **Queue**           | BullMQ background jobs with `shouldQueue` decorator and Bull Board dashboard           |
+| **Realtime**        | Socket.IO with auto room joining (user, role, auth) and broadcast events               |
+| **Cache & Session** | Redis-backed with graceful fallback when Redis is disabled                             |
+| **Scheduler**       | Cron-based task scheduling with distributed Redis lock                                 |
+| **Storage**         | Local disk or S3-compatible (AWS S3, R2, MinIO, DigitalOcean Spaces)                   |
+| **Notifications**   | Database-persisted notifications with broadcast + mail delivery                        |
+| **Frontend**        | Vue 3 SPA — Vite, Pinia, Vue Router, Bootstrap 5, real-time Pulse plugin               |
+| **Security**        | CSP, HSTS, X-Frame headers — configured in one place, toggled per environment          |
+| **Reliability**     | Circuit breakers for Redis, mail, and S3 with auto-fallback; startup config validation |
+| **CLI**             | `maker` command for code generation, migrations, runtime, and deploy                   |
+| **Deploy**          | Two-layer Docker Compose — nginx-proxy, auto SSL, supervisor                           |
+
+## Architecture
+
+```
+src/
+├── env.ts              # Zod-validated environment config
+├── database/           # Drizzle schema, migrations, seeders
+├── framework/          # Reusable engine (HTTP, auth, queue, cache, etc.)
+├── modules/            # Application modules (auto-discovered)
+├── middlewares/        # Auth & role guards
+├── resources/          # Vue 3 SPA frontend
+└── storage/            # Uploaded files & logs
+```
+
+### Modules
+
+Every feature is a self-contained module under `src/modules/<name>/`:
+
+```
+src/modules/posts/
+├── __tests__/         # Unit tests
+├── console/           # CLI commands & scheduled tasks
+├── controllers/       # Request handlers
+├── database/
+│   ├── models/        # Drizzle table definitions
+│   └── seeders/       # Test data
+├── helpers/           # Pure functions — no I/O
+├── jobs/              # BullMQ queue handlers
+├── middlewares/       # Module-local middleware
+├── routes/            # HTTP route definitions (auto-discovered)
+├── schemas/           # Zod validation schemas
+├── services/          # Business logic — DB, files, network
+├── types/             # Shared TypeScript types
+└── facade.ts          # Public API for other modules
+```
+
+Modules are **auto-discovered** — no manual registration. Create one with:
+
+```bash
+npm run maker module:make blog
+npm run maker module:make-controller blog post
+npm run maker module:make-route blog post
+npm run maker module:make-model blog post
+```
+
+### Framework Facade
+
+Access all subsystems through a single import:
+
+```ts
+import {
+  db,
+  cache,
+  session,
+  queue,
+  dispatchEvent,
+  notify,
+  storage,
+  jwt,
+  mail,
+  password,
+  urls,
+  logger,
+} from "@/framework/facade.js";
+```
+
+## CLI Reference
+
+| Command                        | Description                                    |
+| ------------------------------ | ---------------------------------------------- |
+| `maker dev`                    | Start API server + frontend HMR + queue worker |
+| `maker serve [--prod]`         | API server (dev or production)                 |
+| `maker queue:work`             | BullMQ worker process                          |
+| `maker schedule:work`          | Cron scheduler                                 |
+| `maker db:migrate --seed`      | Run migrations + seeders                       |
+| `maker db:fresh`               | Drop all tables, re-migrate, re-seed           |
+| `maker module:make <name>`     | Scaffold a new module                          |
+| `maker deploy:init`            | Generate Docker deploy scaffolding             |
+| `maker deploy:workflow`        | Local deploy (Docker Desktop)                  |
+| `maker deploy:workflow:remote` | Remote deploy via SSH + rsync                  |
+
+## Deployment
+
+nexwire includes a complete Docker deployment system out of the box.
+
+### Local (Docker Desktop)
+
+```bash
+npm run maker deploy:init        # Generate deploy files (one-time)
+npm run maker deploy:workflow    # Build and start everything
+```
+
+### Remote (VPS / Cloud)
+
+```bash
+npm run maker deploy:init                      # Generate files
+# Edit deploy/workflow.remote.json with your SSH details
+npm run maker deploy:workflow:remote           # Deploy to server
+```
+
+The deploy system provisions:
+
+- **Multi-stage Dockerfile** — builder (install + build) → runner (minimal production image)
+- **Shared infrastructure** — nginx-proxy, MySQL/PostgreSQL, Redis, phpMyAdmin, pgAdmin
+- **Auto SSL** — Let's Encrypt via nginx-proxy companion
+- **Process supervisor** — API server, queue worker, cron scheduler, auto-migration
+- **Two-layer architecture** — server infra runs once per host, app stack rebuilds per deploy
+
+See the [deploy documentation](https://niyamulahsan.github.io/nexwire/deploy/overview) for full details.
+
+## Documentation
+
+Complete documentation is available at **[Documentation](https://niyamulahsan.github.io/nexwire)**
+
+## Contributing
+
+Contributions are welcome. Open an issue or pull request on [GitHub](https://github.com/niyamulahsan/nexwire).
+
+## License
+
+nexwire is open-sourced software licensed under the [MIT license](LICENSE).

package/fastify/biome.json

@@ -0,0 +1,99 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "html": {
+    "experimentalFullSupportEnabled": true,
+    "formatter": {
+      "enabled": true
+    }
+  },
+  "formatter": {
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 140,
+    "bracketSameLine": false
+  },
+  "files": {
+    "includes": [
+      "**",
+      "!**/node_modules"
+    ]
+  },
+  "linter": {
+    "rules": {
+      "preset": "recommended",
+      "a11y": {
+        "noLabelWithoutControl": "off",
+        "useButtonType": "off",
+        "useSemanticElements": "off",
+        "noStaticElementInteractions": "off",
+        "useKeyWithClickEvents": "off",
+        "useValidAnchor": "off",
+        "useAnchorContent": "off",
+        "noDistractingElements": "off"
+      },
+      "correctness": {
+        "noUnusedVariables": "off",
+        "useVueValidTemplateRoot": "off",
+        "noUnusedImports": "off"
+      },
+      "complexity": {
+        "noUselessEscapeInRegex": "off",
+        "noImportantStyles": "off"
+      },
+      "style": {
+        "noNonNullAssertion": "off",
+        "useVueMultiWordComponentNames": "off",
+        "useImportType": "off"
+      },
+      "suspicious": {
+        "noEmptyBlockStatements": "off",
+        "noExplicitAny": "off",
+        "noRedeclare": "off",
+        "noAssignInExpressions": "off",
+        "useIterableCallbackReturn": "off"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "double",
+      "semicolons": "always",
+      "trailingCommas": "none"
+    }
+  },
+  "overrides": [
+    {
+      "includes": [
+        "**/*.{js,mjs,cjs,ts,tsx,vue}"
+      ],
+      "javascript": {
+        "globals": [
+          "exports",
+          "location"
+        ]
+      }
+    }
+  ],
+  "assist": {
+    "actions": {
+      "source": {
+        "organizeImports": {
+          "level": "on",
+          "options": {
+            "groups": [
+              ":NODE:",
+              ":PACKAGE:",
+              ":ALIAS:",
+              ":PATH:"
+            ]
+          }
+        }
+      }
+    }
+  }
+}

package/fastify/drizzle.config.ts

@@ -0,0 +1,25 @@
+import { config } from "dotenv";
+import { defineConfig } from "drizzle-kit";
+
+config({ path: ".env" });
+
+function sqlitePathFromUrl(url: string) {
+  if (url.startsWith("sqlite:///")) return url.replace("sqlite:///", "");
+  if (url.startsWith("sqlite://")) return url.replace("sqlite://", "");
+  if (url.startsWith("sqlite:")) return url.replace("sqlite:", "");
+  return url;
+}
+
+const databaseUrl = process.env.DATABASE_URL || "sqlite:./src/storage/database/nexwire.sqlite";
+const dialect = databaseUrl.startsWith("mysql") ? "mysql" : databaseUrl.startsWith("postgres") ? "postgresql" : "sqlite";
+
+export default defineConfig({
+  schema: process.env.DRIZZLE_SCHEMA || "./src/database/schema.ts",
+  out: `./src/database/migrations/${dialect}`,
+  dialect,
+  dbCredentials: databaseUrl.startsWith("mysql")
+    ? { url: databaseUrl }
+    : databaseUrl.startsWith("postgres")
+      ? { url: databaseUrl }
+      : { url: `file:${sqlitePathFromUrl(databaseUrl)}` }
+});

package/fastify/gitignore-stub

@@ -0,0 +1,31 @@
+.env
+node_modules/
+dist/
+
+# Coverage reports - regenerated by `npm run test:coverage`, ~130 HTML files
+coverage/
+
+public/*
+!public/.gitkeep
+
+deploy/.env
+deploy/server/.env
+
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+.DS_Store
+Thumbs.db
+
+# Lock files — regenerated per developer's package manager
+# bun.lockb is the binary format used by bun before 1.2; bun.lock is the
+# current text format. Both are ignored, so upgrading bun cannot turn a
+# developer's local install into an untracked file.
+bun.lock
+bun.lockb
+package-lock.json
+pnpm-lock.yaml
+yarn.lock