create-nexwire 4.2.5 → 4.4.0

package/fastify/src/resources/vite.config.ts

@@ -0,0 +1,64 @@
+import path from "node:path";
+import { fileURLToPath, URL } from "node:url";
+import vue from "@vitejs/plugin-vue";
+import { defineConfig, loadEnv } from "vite";
+
+const configDir = path.dirname(fileURLToPath(import.meta.url));
+const projectRoot = path.resolve(configDir, "../..");
+
+export default defineConfig(({ mode }) => {
+  // 1. Load the .env file just like the backend does. Resolve it from the
+  // config file so a different process cwd cannot point Vite at the wrong .env.
+  const env = loadEnv(mode, projectRoot, "");
+
+  const cacheBase = process.env.LOCALAPPDATA || process.env.TEMP || ".";
+  const apiUrl = env.APP_URL || "http://localhost:3000";
+
+  // Match the backend default: Socket.IO is off unless SOCKET=true
+  const socketEnabled = env.SOCKET === "true";
+
+  const proxy: Record<string, any> = {
+    "/api": { target: apiUrl, changeOrigin: true },
+    "/health": { target: apiUrl, changeOrigin: true },
+    "/storage": { target: apiUrl, changeOrigin: true }
+  };
+
+  if (socketEnabled) {
+    proxy["/socket.io"] = { target: apiUrl, changeOrigin: true, ws: true, timeout: 10000 };
+  }
+
+  return {
+    define: {
+      // 3. ALWAYS stringify the value when using Vite define
+      // `import.meta.env.*` is inlined into every module in dev as well as in
+      // the production bundle, so the UI never depends on a stale global.
+      "import.meta.env.VITE_SOCKET_ENABLED": JSON.stringify(socketEnabled),
+      __SOCKET_ENABLED__: JSON.stringify(socketEnabled),
+      __API_URL__: JSON.stringify(apiUrl)
+    },
+    root: fileURLToPath(new URL(".", import.meta.url)),
+    cacheDir: path.join(cacheBase, "nexwire", "vite-cache", "resources"),
+    plugins: [vue()],
+    css: {
+      preprocessorOptions: {
+        scss: {
+          quietDeps: true,
+          silenceDeprecations: ["import", "if-function", "global-builtin", "color-functions", "slash-div"]
+        }
+      }
+    },
+    resolve: {
+      alias: {
+        "@": fileURLToPath(new URL("./src", import.meta.url))
+      }
+    },
+    build: {
+      outDir: "../../public",
+      emptyOutDir: true
+    },
+    server: {
+      port: 5173,
+      proxy // /socket.io is only proxied when SOCKET=true
+    }
+  };
+});

package/fastify/src/types/global.d.ts

@@ -0,0 +1,32 @@
+declare module "*.vue" {
+  import type { DefineComponent } from "vue";
+
+  const component: DefineComponent<Record<string, unknown>, Record<string, unknown>, unknown>;
+  export default component;
+}
+
+declare module "bootstrap/js/dist/modal.js" {
+  export default class Modal {
+    constructor(element: Element, options?: { backdrop?: boolean | "static"; keyboard?: boolean });
+    show(): void;
+    hide(): void;
+    dispose(): void;
+  }
+}
+
+declare module "bootstrap/js/dist/toast.js" {
+  export default class Toast {
+    static getOrCreateInstance(element: Element): Toast;
+    show(): void;
+  }
+}
+
+declare module "luxon";
+declare module "nodemailer";
+declare module "vue-select";
+
+interface ImportMetaEnv {
+  readonly VITE_API_URL?: string;
+  readonly VITE_SOCKET_URL?: string;
+  readonly VITE_SOCKET_ENABLED?: boolean;
+}

package/fastify/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "jsx": "react-jsx",
+    "paths": {
+      "@/*": ["./src/*"]
+    },
+    "strict": false,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "outDir": "./dist",
+    "skipLibCheck": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/framework/maker-cli/**/*.mjs", "drizzle.config.ts"],
+  "exclude": ["node_modules", "dist", "src/resources", "src/storage/trash"]
+}

package/fastify/vitest.config.ts

@@ -0,0 +1,38 @@
+import { fileURLToPath } from "node:url";
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  resolve: {
+    alias: {
+      "@": fileURLToPath(new URL("./src", import.meta.url))
+    }
+  },
+  test: {
+    globals: true,
+    include: ["src/**/*.test.ts", "src/**/*.spec.ts"],
+    exclude: ["src/resources/**", "src/storage/**", "node_modules/**", "dist/**"],
+    environment: "node",
+    coverage: {
+      provider: "v8",
+      reporter: ["text", "json", "html"],
+      include: ["src/**/*.ts"],
+      exclude: ["src/resources/**", "src/storage/**", "src/framework/maker-cli/**", "src/**/*.d.ts", "src/**/*.test.ts", "src/**/*.spec.ts"]
+      // No `thresholds` here on purpose.
+      //
+      // This file is published inside the package, so any floor written here also
+      // becomes every scaffolded project's floor - and it would fail them on the
+      // first run. A new project ships with only the auth module's tests: the
+      // framework's own tests under `src/framework/**/__tests__/` are not
+      // published, because they test the framework rather than the application.
+      // That measures 8.49% statements, so a floor calibrated for this repository
+      // reports a failure for a developer who has done nothing wrong and whose
+      // 56 tests all pass.
+      //
+      // The floor is a guard on this repository, not on yours, so it is passed on
+      // the command line when the framework's own suite is run - it is never read
+      // from this file. That keeps this file byte-identical across both engines,
+      // keeps it free of a number that would be meaningless in someone else's
+      // project, and still fails when untested code is added here.
+    }
+  }
+});

package/hono/.env

@@ -37,7 +37,7 @@ UI=true
 # Set true to enable OpenAPI / Scalar docs at /api-docs
 OPEN_API=true
 # Set false to disable Socket.IO realtime server
-SOCKET=true
+SOCKET=false
 # Set false to disable browser security headers (CSP, HSTS, X-Frame)
 SECURITY_HEADERS=true
 

package/hono/package.json

@@ -62,7 +62,7 @@
     "ioredis": "^5.11.1",
     "lodash-es": "^4.18.1",
     "luxon": "^3.7.2",
-    "maildev": "^3.0.0",
+    "maildev": "^2.2.1",
     "mysql2": "^3.23.3",
     "nodemailer": "^10.2.1",
     "pinia": "^3.0.4",

package/hono/src/config/database.ts

@@ -1,29 +1,48 @@
-import { env } from "@/env.js";
-
-/**
- * Why: Database connection settings for Drizzle.
- * When: Database bootstrap and dialect detection.
- * Where: src/config/database.ts.
- * How: The connection URL contains credentials, so it stays in .env
- *      (`DATABASE_URL`). Dialect is derived from the URL prefix.
- */
-export const databaseConfig = {
-  url: env.DATABASE_URL
-};
-
-export type DatabaseConfig = typeof databaseConfig;
-
-/**
- * Why: Maps a connection URL to its Drizzle dialect.
- * When: Selecting the pool driver and dialect-specific branching.
- * Where: Framework database connection helpers.
- * How: Matches the URL prefix; anything that isn't mysql/postgres is sqlite.
- */
-export function detectDialectFrom(url: string): "sqlite" | "mysql" | "postgresql" {
-  const value = url.toLowerCase();
-  if (value.startsWith("mysql")) return "mysql";
-  if (value.startsWith("postgres")) return "postgresql";
-  return "sqlite";
-}
-
-export const databaseDialect = detectDialectFrom(databaseConfig.url);
+import { env } from "@/env.js";
+
+/**
+ * Why: Database connection settings.
+ * When: Database bootstrap and dialect detection.
+ * Where: src/config/database.ts.
+ * How: Only DATABASE_URL is required. Pool settings use generic,
+ *      provider-agnostic defaults.
+ */
+
+const rawUrl = env.DATABASE_URL;
+
+export const databaseConfig = {
+  // If it's sqlite, convert "sqlite:./db.sqlite" to "file:./db.sqlite"
+  url: rawUrl.startsWith("sqlite:") ? `file:${rawUrl.slice("sqlite:".length)}` : rawUrl,
+
+  /** Generic, sensible pool defaults for any provider */
+  pool: {
+    max: 10,
+    idleTimeout: 20000, // ms
+    connectTimeout: 10000, // ms
+    keepAlive: true
+  },
+
+  /**
+   * Default to true. If a provider (like a pooler) doesn't support it,
+   * they usually indicate this in the connection string or require the user
+   * to handle it at the driver level.
+   */
+  prepare: true,
+
+  /**
+   * Require TLS for MySQL and PostgreSQL connections. Set this to true, or
+   * append `?sslmode=require` to DATABASE_URL if your provider documents that.
+   */
+  ssl: false
+};
+
+export type DatabaseConfig = typeof databaseConfig;
+
+export function detectDialectFrom(url: string): "sqlite" | "mysql" | "postgresql" {
+  const value = url.toLowerCase();
+  if (value.startsWith("mysql")) return "mysql";
+  if (value.startsWith("postgres")) return "postgresql";
+  return "sqlite";
+}
+
+export const databaseDialect = detectDialectFrom(rawUrl);

package/hono/src/config/index.ts

@@ -1,83 +1,83 @@
-import { type AppConfig, appConfig } from "./app.js";
-import { type AuthConfig, authConfig } from "./auth.js";
-import { type CacheConfig, cacheConfig } from "./cache.js";
-import { type CookieConfig, cookieConfig } from "./cookie.js";
-import { type CorsConfig, corsConfig } from "./cors.js";
-import { type DatabaseConfig, databaseConfig } from "./database.js";
-import { type JwtConfig, jwtConfig } from "./jwt.js";
-import { type LoggingConfig, loggingConfig } from "./logging.js";
-import { type MailConfig, mailConfig } from "./mail.js";
-import { type OpenApiConfig, openApiConfig } from "./openapi.js";
-import { type QueueConfig, queueConfig } from "./queue.js";
-import { type RateLimitConfig, rateLimitConfig } from "./rateLimit.js";
-import { type RealtimeConfig, realtimeConfig } from "./realtime.js";
-import { type RedisConfig, redisConfig } from "./redis.js";
-import { type SecurityConfig, securityConfig } from "./security.js";
-import { type SessionConfig, sessionConfig } from "./session.js";
-import { type StorageConfig, storageConfig } from "./storage.js";
-
-export { appConfig } from "./app.js";
-export { authConfig } from "./auth.js";
-export { cacheConfig } from "./cache.js";
-export { cookieConfig } from "./cookie.js";
-export { corsConfig } from "./cors.js";
-export { databaseConfig } from "./database.js";
-export { jwtConfig } from "./jwt.js";
-export { loggingConfig } from "./logging.js";
-export { mailConfig } from "./mail.js";
-export { openApiConfig } from "./openapi.js";
-export { queueConfig } from "./queue.js";
-export { rateLimitConfig } from "./rateLimit.js";
-export { realtimeConfig } from "./realtime.js";
-export { redisConfig } from "./redis.js";
-export { securityConfig } from "./security.js";
-export { sessionConfig } from "./session.js";
-export { storageConfig } from "./storage.js";
-
-/**
- * Why: Single import point for every config domain.
- * When: Application code needs configuration values.
- * Where: Imported as `import { config } from "@/config/index.js"`.
- * How: Aggregates per-domain config objects; individual files remain the
- *      place to edit each setting.
- */
-export const config = {
-  app: appConfig,
-  auth: authConfig,
-  cache: cacheConfig,
-  cookie: cookieConfig,
-  cors: corsConfig,
-  database: databaseConfig,
-  jwt: jwtConfig,
-  logging: loggingConfig,
-  mail: mailConfig,
-  openApi: openApiConfig,
-  queue: queueConfig,
-  rateLimit: rateLimitConfig,
-  realtime: realtimeConfig,
-  redis: redisConfig,
-  session: sessionConfig,
-  security: securityConfig,
-  storage: storageConfig
-} as const;
-
-export type Config = typeof config;
-export type {
-  AppConfig,
-  AuthConfig,
-  CacheConfig,
-  CookieConfig,
-  CorsConfig,
-  DatabaseConfig,
-  JwtConfig,
-  LoggingConfig,
-  MailConfig,
-  OpenApiConfig,
-  QueueConfig,
-  RateLimitConfig,
-  RealtimeConfig,
-  RedisConfig,
-  SecurityConfig,
-  SessionConfig,
-  StorageConfig
-};
+import { type AppConfig, appConfig } from "./app.js";
+import { type AuthConfig, authConfig } from "./auth.js";
+import { type CacheConfig, cacheConfig } from "./cache.js";
+import { type CookieConfig, cookieConfig } from "./cookie.js";
+import { type CorsConfig, corsConfig } from "./cors.js";
+import { type DatabaseConfig, databaseConfig } from "./database.js";
+import { type JwtConfig, jwtConfig } from "./jwt.js";
+import { type LoggingConfig, loggingConfig } from "./logging.js";
+import { type MailConfig, mailConfig } from "./mail.js";
+import { type OpenApiConfig, openApiConfig } from "./openapi.js";
+import { type QueueConfig, queueConfig } from "./queue.js";
+import { type RateLimitConfig, rateLimitConfig } from "./rateLimit.js";
+import { type RealtimeConfig, realtimeConfig } from "./realtime.js";
+import { type RedisConfig, redisConfig } from "./redis.js";
+import { type SecurityConfig, securityConfig } from "./security.js";
+import { type SessionConfig, sessionConfig } from "./session.js";
+import { type StorageConfig, storageConfig } from "./storage.js";
+
+export { appConfig } from "./app.js";
+export { authConfig } from "./auth.js";
+export { cacheConfig } from "./cache.js";
+export { cookieConfig } from "./cookie.js";
+export { corsConfig } from "./cors.js";
+export { databaseConfig, databaseDialect, detectDialectFrom } from "./database.js";
+export { jwtConfig } from "./jwt.js";
+export { loggingConfig } from "./logging.js";
+export { mailConfig } from "./mail.js";
+export { openApiConfig } from "./openapi.js";
+export { queueConfig } from "./queue.js";
+export { rateLimitConfig } from "./rateLimit.js";
+export { realtimeConfig } from "./realtime.js";
+export { redisConfig } from "./redis.js";
+export { securityConfig } from "./security.js";
+export { sessionConfig } from "./session.js";
+export { storageConfig } from "./storage.js";
+
+/**
+ * Why: Single import point for every config domain.
+ * When: Application code needs configuration values.
+ * Where: Imported as `import { config } from "@/config/index.js"`.
+ * How: Aggregates per-domain config objects; individual files remain the
+ *      place to edit each setting.
+ */
+export const config = {
+  app: appConfig,
+  auth: authConfig,
+  cache: cacheConfig,
+  cookie: cookieConfig,
+  cors: corsConfig,
+  database: databaseConfig,
+  jwt: jwtConfig,
+  logging: loggingConfig,
+  mail: mailConfig,
+  openApi: openApiConfig,
+  queue: queueConfig,
+  rateLimit: rateLimitConfig,
+  realtime: realtimeConfig,
+  redis: redisConfig,
+  session: sessionConfig,
+  security: securityConfig,
+  storage: storageConfig
+} as const;
+
+export type Config = typeof config;
+export type {
+  AppConfig,
+  AuthConfig,
+  CacheConfig,
+  CookieConfig,
+  CorsConfig,
+  DatabaseConfig,
+  JwtConfig,
+  LoggingConfig,
+  MailConfig,
+  OpenApiConfig,
+  QueueConfig,
+  RateLimitConfig,
+  RealtimeConfig,
+  RedisConfig,
+  SecurityConfig,
+  SessionConfig,
+  StorageConfig
+};

package/hono/src/config/openapi.ts

@@ -8,46 +8,28 @@ import { appConfig } from "./app.js";
  *      and the Scalar docs UI appearance.
  */
 export const openApiConfig = {
-  /** OpenAPI spec version */
   version: "3.0.0",
-
-  /** API title shown in docs and the /doc spec */
   title: `${appConfig.name} API`,
-
-  /** API version shown in docs */
   apiVersion: "1.0.0",
-
-  /** Optional description shown in the /doc spec */
   description: "",
 
   /** Scalar docs UI settings */
   scalar: {
-    /** URL path to the OpenAPI JSON spec */
-    specUrl: "/doc",
-
-    /** URL path to the interactive docs UI */
-    docsPath: "/api-docs",
-
-    /** UI layout: "classic" or "modern" */
-    layout: "classic" as const,
-
+    specUrl: "/doc", // URL path to the OpenAPI JSON spec
+    docsPath: "/api-docs", // URL path to the interactive docs UI
+    layout: "classic" as const, // UI layout: "classic" or "modern"
     /** UI theme: "default", "moon", "purple", "solarized", "bluePlanet", "fastify", "kepler", "mars", "nebula", "none" */
     theme: "moon" as const,
-
-    /** HTML page title for the /api-docs page */
-    pageTitle: `${appConfig.name} API`,
-
+    pageTitle: `${appConfig.name} API`, // HTML page title for the /api-docs page
     /** Favicon file (project-relative) served at /favicon.ico for the /api-docs page */
     favicon: "src/resources/src/assets/images/favicon/favicon.ico",
-
     /** Default HTTP client shown in code examples */
     defaultHttpClient: {
       targetKey: "js" as const,
       clientKey: "fetch" as const
     },
-
-    /** Expand all tags on load */
-    defaultOpenAllTags: true
+    defaultOpenAllTags: true, // Expand all tags on load
+    showDeveloperTools: "never"
   }
 } as const;
 

package/hono/src/config/queue.ts

@@ -1,30 +1,30 @@
-import { redisConfig } from "./redis.js";
-
-/**
- * Why: Queue workers, concurrency, and BullMQ key namespaces.
- * When: The queue facade bootstraps workers and the dashboard connects.
- * Where: src/config/queue.ts.
- * How: `queues` lists which queue names get a worker by default (default,
- *      mail, maintenance). `concurrency` caps parallel jobs per worker.
- *      Key prefixes derive from the shared `REDIS_PREFIX`.
- */
-export const queueConfig = {
-  queues: ["default", "mail", "maintenance"],
-  concurrency: 10,
-  /**
-   * autoPruneQueues
-   * Why: Automatically deletes phantom queues (Redis keys for queue names that
-   *      no longer exist in `queues`) when a queue worker boots. Safe because
-   *      only empty, unconfigured queues are removed, and BullMQ recreates a
-   *      queue's keys on demand if code still dispatches to it.
-   * When: Set false to disable automatic pruning and rely on manual
-   *      `queue:clear` instead.
-   */
-  autoPruneQueues: true,
-  prefix: `${redisConfig.prefix}:queue`,
-  durablePrefix: `${redisConfig.prefix}:durable`,
-  queueUi: "/queues",
-  allowedEmails: ""
-};
-
-export type QueueConfig = typeof queueConfig;
+import { redisConfig } from "./redis.js";
+
+/**
+ * Why: Queue workers, concurrency, and BullMQ key namespaces.
+ * When: The queue facade bootstraps workers and the dashboard connects.
+ * Where: src/config/queue.ts.
+ * How: `queues` lists which queue names get a worker by default (default,
+ *      mail, maintenance). `concurrency` caps parallel jobs per worker.
+ *      Key prefixes derive from the shared `REDIS_PREFIX`.
+ */
+export const queueConfig = {
+  queues: ["default", "mail", "maintenance"],
+  concurrency: 10,
+  /**
+   * autoPruneQueues
+   * Why: Automatically deletes phantom queues (Redis keys for queue names that
+   *      no longer exist in `queues`) when a queue worker boots. Safe because
+   *      only empty, unconfigured queues are removed, and BullMQ recreates a
+   *      queue's keys on demand if code still dispatches to it.
+   * When: Set false to disable automatic pruning and rely on manual
+   *      `queue:clear` instead.
+   */
+  autoPruneQueues: true,
+  prefix: `${redisConfig.prefix}:queue`,
+  durablePrefix: `${redisConfig.prefix}:durable`,
+  queueUi: "/queues",
+  allowedEmails: "" // Comma-separated list of email addresses allowed to access the queue UI. Empty means no restriction.
+};
+
+export type QueueConfig = typeof queueConfig;

package/hono/src/config/validate.ts

@@ -1,40 +1,50 @@
-import { databaseConfig } from "./database.js";
-import { mailConfig } from "./mail.js";
-import { redisConfig } from "./redis.js";
-import { storageConfig } from "./storage.js";
-
-/**
- * Why: Validates that resolved configs are internally consistent at startup.
- * When: Called before any framework subsystem initializes.
- * Where: kernel.ts, before storage.init() and initRedis().
- * How: Checks cross-config dependencies and throws clear errors for inconsistencies.
- */
-export function validateConfig(): void {
-  if (!databaseConfig.url) {
-    throw new Error("DATABASE_URL is required but is empty");
-  }
-
-  if (storageConfig.driver === "s3") {
-    if (!storageConfig.bucket) {
-      throw new Error("STORAGE_BUCKET is required when storage driver is s3");
-    }
-    if (!storageConfig.accessKeyId || !storageConfig.secretAccessKey) {
-      throw new Error("STORAGE_ACCESS_KEY_ID and STORAGE_SECRET_ACCESS_KEY are required when storage driver is s3");
-    }
-  }
-
-  if (redisConfig.enabled) {
-    try {
-      const url = new URL(redisConfig.url);
-      if (!url.hostname || url.port === "") {
-        throw new Error(`REDIS_URL is invalid: "${redisConfig.url}" — must include host and port`);
-      }
-    } catch (error) {
-      throw new Error(`REDIS_URL is invalid: "${redisConfig.url}" — ${error instanceof Error ? error.message : error}`);
-    }
-  }
-
-  if (!mailConfig.failSilent && !mailConfig.username) {
-    throw new Error("MAIL_USERNAME is required when MAIL_FAIL_SILENT is false");
-  }
-}
+import { databaseConfig } from "./database.js";
+import { mailConfig } from "./mail.js";
+import { redisConfig } from "./redis.js";
+import { storageConfig } from "./storage.js";
+
+/**
+ * Why: Validates that resolved configs are internally consistent at startup.
+ * When: Called before any framework subsystem initializes.
+ * Where: kernel.ts, before storage.init() and initRedis().
+ * How: Checks cross-config dependencies and throws clear errors for inconsistencies.
+ */
+export function validateConfig(): void {
+  if (!databaseConfig.url) {
+    throw new Error("DATABASE_URL is required but is empty");
+  }
+
+  if (storageConfig.driver === "s3") {
+    if (!storageConfig.bucket) {
+      throw new Error("STORAGE_BUCKET is required when storage driver is s3");
+    }
+    if (!storageConfig.accessKeyId || !storageConfig.secretAccessKey) {
+      throw new Error("STORAGE_ACCESS_KEY_ID and STORAGE_SECRET_ACCESS_KEY are required when storage driver is s3");
+    }
+  }
+
+  if (redisConfig.enabled) {
+    try {
+      const url = new URL(redisConfig.url);
+
+      // Ensure it starts with redis:// or rediss://
+      if (url.protocol !== "redis:" && url.protocol !== "rediss:") {
+        throw new Error("URL must start with redis:// or rediss://");
+      }
+
+      // Hostname is mandatory (e.g., localhost, 127.0.0.1, redis-container)
+      if (!url.hostname) {
+        throw new Error("URL must include a valid hostname");
+      }
+
+      // Note: We do NOT check if the port is empty.
+      // ioredis automatically defaults to 6379 if no port is provided.
+    } catch (error) {
+      throw new Error(`REDIS_URL is invalid: "${redisConfig.url}" — ${error instanceof Error ? error.message : error}`);
+    }
+  }
+
+  if (!mailConfig.failSilent && !mailConfig.username) {
+    throw new Error("MAIL_USERNAME is required when MAIL_FAIL_SILENT is false");
+  }
+}