create-nexwire 4.2.2 → 4.2.4

package/hono/src/providers/README.md

@@ -0,0 +1,107 @@
+# Providers
+
+Provider files in this folder are imported automatically when the application
+boots. Use them for anything the **whole app** needs — a replacement auth
+implementation, a payment gateway, an SMS driver, a storage backend.
+
+There is no wiring step: drop a file in here and it runs.
+
+## How it works
+
+1. Every `src/providers/**/*.{ts,js,mjs}` file is imported at boot.
+2. Every `src/modules/<module>/providers.ts` file is imported at boot too, so a
+   module can plug itself into the app without the app knowing about it.
+3. Every `src/modules/<module>/providers/*.ts` file is imported at boot as well,
+   for a module that offers more than one implementation.
+4. A provider file claims a contract by registering an implementation.
+
+```ts
+// src/providers/payment.ts
+import { registerProvider } from "@/framework/facade.js";
+
+registerProvider("payment", {
+  async charge(order) {
+    return { id: "ch_123", status: "paid" };
+  }
+});
+```
+
+Read it back the same way:
+
+```ts
+import { getProvider } from "@/framework/facade.js";
+
+const payment = getProvider<any>("payment");
+```
+
+## Generating one
+
+```bash
+npm run maker provider:make payment
+npm run maker module:make-provider billing stripe
+```
+
+`provider:make` writes `src/providers/<name>.ts` for the whole app.
+`module:make-provider` writes `src/modules/<module>/providers/<name>.ts` for a
+single module. Both files register themselves when they are imported.
+
+## Replacing the built-in auth
+
+The framework ships with an auth module under `src/modules/auth`. To replace
+it, delete that folder and register your own auth provider:
+
+```ts
+// src/providers/auth.ts
+import { registerAuthProvider } from "@/framework/facade.js";
+import type { AuthProvider } from "@/framework/facade.js";
+
+const authProvider: AuthProvider = {
+  async getUserById(id) {
+    // Return any user shape you like. Extra fields (tenantId, plan, status, ...)
+    // are passed straight through to `c.get("auth")` / `res.locals.auth`.
+    return { id, email: "user@example.com", tenantId: 42, plan: "pro" };
+  },
+  async findRefreshToken(jti) {
+    // Return the stored refresh token, or null when it is unknown.
+    return { id: 1, jti, revoked: false, expiresAt: new Date() };
+  },
+  async revokeRefreshToken(tokenId) {
+    // Optional. Called when a refresh token is expired or revoked.
+  },
+  async getAuthContext(user, payload) {
+    // Optional. Shapes what handlers receive as the auth context.
+    return { id: user.id, email: user.email, tenantId: user.tenantId };
+  },
+  async getUserContact(userId) {
+    // Optional. Used by `notify()` to find the email address of a user.
+    return { email: "user@example.com", name: "User" };
+  }
+};
+
+registerAuthProvider(authProvider);
+```
+
+Import `registerAuthProvider` and the `AuthProvider` type from
+`@/framework/facade.js` — never from `@/framework/...` internals. The facade is
+the public API of the framework.
+
+## Module-to-module
+
+Modules do not import each other. They talk through:
+
+- `src/modules/<module>/facade.ts` — the public API of a module.
+- `dispatchEvent` / `dispatchCommand` — for cross-module notifications.
+- `src/providers/` — for app-wide implementations.
+
+## Contract reference
+
+| Method                              | Required | Purpose                                                        |
+| ----------------------------------- | -------- | -------------------------------------------------------------- |
+| `getUserById(id)`                   | Yes      | Loads a user. Any extra fields are passed through to the auth context. |
+| `findRefreshToken(jti)`             | Yes      | Loads a stored refresh token by its JWT id.                    |
+| `revokeRefreshToken(id)`            | No       | Revokes a refresh token. `deleteRefreshToken(id)` also works.  |
+| `getAuthContext(user, payload)`     | No       | Shapes the object handlers receive as `auth`.                   |
+| `getUserContact(userId)`            | No       | Finds the email/name of a user, used by notifications.         |
+
+When no provider is registered and `src/modules/auth` was deleted, the auth
+middleware logs a warning and lets the request through instead of crashing.

package/hono/src/resources/src/main.ts

@@ -1,5 +1,5 @@
 import "@/plugins/axios";
-import { createHead } from "@vueuse/head";
+import { createHead } from "@unhead/vue/client";
 import { createPinia } from "pinia";
 import { createApp } from "vue";
 import { DialogPlugin } from "@/plugins/dialog";

package/hono/src/resources/src/pages/auth/forgetPassword.vue

@@ -43,7 +43,7 @@
 </template>
 
 <script setup lang="ts">
-import { useHead } from "@vueuse/head";
+import { useHead } from "@unhead/vue";
 import { ref } from "vue";
 import Button from "@/components/Button.vue";
 import Input from "@/components/Input.vue";

package/hono/src/resources/src/pages/auth/login.vue

@@ -47,7 +47,7 @@
 </template>
 
 <script setup lang="ts">
-import { useHead } from "@vueuse/head";
+import { useHead } from "@unhead/vue";
 import { ref } from "vue";
 import { useRouter } from "vue-router";
 import Checkbox from "@/components/Checkbox.vue";

package/hono/src/resources/src/pages/auth/register.vue

@@ -65,7 +65,7 @@
 </template>
 
 <script setup lang="ts">
-import { useHead } from "@vueuse/head";
+import { useHead } from "@unhead/vue";
 import { ref } from "vue";
 import { useRouter } from "vue-router";
 import Input from "@/components/Input.vue";

package/hono/src/resources/src/pages/auth/resetPassword.vue

@@ -53,7 +53,7 @@
 </template>
 
 <script setup lang="ts">
-import { useHead } from "@vueuse/head";
+import { useHead } from "@unhead/vue";
 import { ref } from "vue";
 import { useRoute, useRouter } from "vue-router";
 import Button from "@/components/Button.vue";

package/hono/src/resources/src/pages/auth/verifyEmail.vue

@@ -23,7 +23,7 @@
 </template>
 
 <script setup lang="ts">
-import { useHead } from "@vueuse/head";
+import { useHead } from "@unhead/vue";
 import { ref } from "vue";
 import { useRoute } from "vue-router";
 import { useGum } from "@/plugins/gum";

package/hono/src/resources/src/pages/dashboard/index.vue

@@ -1,66 +1,66 @@
-<template>
-  <Pagebar title="Dashboard" />
-
-  <div class="dashboard-placeholder">
-    <div class="row g-2 mb-2">
-      <div class="col-12 col-md-4">
-        <div class="placeholder-card"></div>
-      </div>
-      <div class="col-12 col-md-4">
-        <div class="placeholder-card"></div>
-      </div>
-      <div class="col-12 col-md-4">
-        <div class="placeholder-card"></div>
-      </div>
-    </div>
-
-    <div class="placeholder-panel"></div>
-  </div>
-</template>
-
-<script setup lang="ts">
-import { useHead } from "@vueuse/head";
-import { onMounted, onUnmounted } from "vue";
-import Pagebar from "@/components/Pagebar.vue";
-import { useAuth } from "@/composables/useAuth";
-import { pulse } from "@/plugins/pulse";
-
-useHead({ title: "Dashboard" });
-
-const { user } = useAuth();
-
-onMounted(() => {
-  const ch = pulse.channel("user");
-  ch.listen("user.changed", () => alert("me"));
-  onUnmounted(() => ch.stopListening("user.changed"));
-});
-
-// const hardRefresh = () => window.location.reload();
-</script>
-
-<style scoped>
-.placeholder-card,
-.placeholder-panel {
-  border: 1px solid var(--app-border);
-  border-radius: 0.3rem;
-  background: var(--app-surface);
-}
-
-.placeholder-card {
-  min-height: 220px;
-}
-
-.placeholder-panel {
-  min-height: 520px;
-}
-
-@media (max-width: 768px) {
-  .placeholder-card {
-    min-height: 160px;
-  }
-
-  .placeholder-panel {
-    min-height: 360px;
-  }
-}
-</style>
+<template>
+  <Pagebar title="Dashboard" />
+
+  <div class="dashboard-placeholder">
+    <div class="row g-2 mb-2">
+      <div class="col-12 col-md-4">
+        <div class="placeholder-card"></div>
+      </div>
+      <div class="col-12 col-md-4">
+        <div class="placeholder-card"></div>
+      </div>
+      <div class="col-12 col-md-4">
+        <div class="placeholder-card"></div>
+      </div>
+    </div>
+
+    <div class="placeholder-panel"></div>
+  </div>
+</template>
+
+<script setup lang="ts">
+import { useHead } from "@unhead/vue";
+import { onMounted, onUnmounted } from "vue";
+import Pagebar from "@/components/Pagebar.vue";
+import { useAuth } from "@/composables/useAuth";
+import { pulse } from "@/plugins/pulse";
+
+useHead({ title: "Dashboard" });
+
+const { user } = useAuth();
+
+onMounted(() => {
+  const ch = pulse.channel("user");
+  ch.listen("user.changed", () => alert("me"));
+  onUnmounted(() => ch.stopListening("user.changed"));
+});
+
+// const hardRefresh = () => window.location.reload();
+</script>
+
+<style scoped>
+.placeholder-card,
+.placeholder-panel {
+  border: 1px solid var(--app-border);
+  border-radius: 0.3rem;
+  background: var(--app-surface);
+}
+
+.placeholder-card {
+  min-height: 220px;
+}
+
+.placeholder-panel {
+  min-height: 520px;
+}
+
+@media (max-width: 768px) {
+  .placeholder-card {
+    min-height: 160px;
+  }
+
+  .placeholder-panel {
+    min-height: 360px;
+  }
+}
+</style>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nexwire",
-  "version": "4.2.2",
+  "version": "4.2.4",
   "type": "module",
   "description": "Scaffold a new nexwire project",
   "bin": {
@@ -51,9 +51,9 @@
     "@socket.io/admin-ui": "^0.5",
     "@socket.io/bun-engine": "^0.1",
     "@socket.io/redis-adapter": "^8",
+    "@unhead/vue": "^3",
     "@vitejs/plugin-vue": "^6",
     "@vueuse/core": "^14",
-    "@vueuse/head": "^2",
     "axios": "^1",
     "bcryptjs": "^3",
     "bootstrap": "^5",
@@ -61,7 +61,7 @@
     "bullmq": "^5",
     "bullmq-durable": "^0.2",
     "chalk": "^5",
-    "commander": "^14",
+    "commander": "^15",
     "croner": "^10",
     "dotenv": "^17",
     "dotenv-expand": "^13",
@@ -72,14 +72,14 @@
     "ioredis": "^5",
     "lodash-es": "^4",
     "luxon": "^3",
-    "maildev": "^2",
+    "maildev": "^3",
     "mysql2": "^3",
-    "nodemailer": "^9",
+    "nodemailer": "^10",
     "pinia": "^3",
     "pino": "^10",
     "postgres": "^3",
     "redis-commander": "^0.9.0",
-    "sass-embedded": "^1",
+    "sass": "^1",
     "socket.io": "^4",
     "socket.io-client": "^4",
     "stoker": "^2",
@@ -123,13 +123,13 @@
     "@socket.io/redis-adapter": {
       "optional": true
     },
-    "@vitejs/plugin-vue": {
+    "@unhead/vue": {
       "optional": true
     },
-    "@vueuse/core": {
+    "@vitejs/plugin-vue": {
       "optional": true
     },
-    "@vueuse/head": {
+    "@vueuse/core": {
       "optional": true
     },
     "axios": {
@@ -207,7 +207,7 @@
     "redis-commander": {
       "optional": true
     },
-    "sass-embedded": {
+    "sass": {
       "optional": true
     },
     "socket.io": {

package/src/index.js

@@ -130,22 +130,30 @@ async function main() {
     console.log(`create-nexwire v${version}`);
     console.log();
     console.log("Usage:");
-    console.log("  npm create nexwire@latest <project-name> [--engine=<hono|express>]");
-    console.log("  pnpm create nexwire@latest <project-name> [--engine=<hono|express>]");
-    console.log("  bun create nexwire@latest <project-name> [--engine=<hono|express>]");
-    console.log("  npx create-nexwire@latest <project-name> [--engine=<hono|express>]");
+    console.log("  npm create nexwire@latest <project-name|.> [--engine=<hono|express>]");
+    console.log("  pnpm create nexwire@latest <project-name|.> [--engine=<hono|express>]");
+    console.log("  bun create nexwire@latest <project-name|.> [--engine=<hono|express>]");
+    console.log("  npx create-nexwire@latest <project-name|.> [--engine=<hono|express>]");
     console.log();
     console.log("Engines:");
     console.log("  hono     (default) Hono-based HTTP layer and OpenAPI");
     console.log("  express  Express-based HTTP layer and OpenAPI");
+    console.log();
+    console.log("Tip:");
+    console.log("  Use '.' to scaffold into the current directory (must be empty).");
     process.exit(0);
   }
 
   if (!projectName) {
-    projectName = await ask("Project name: ");
+    projectName = await ask("Project name or '.' for the current directory: ");
+  }
+
+  if (!projectName) {
+    console.error("Error: Please provide a project name or '.' to scaffold into the current directory.");
+    process.exit(1);
   }
 
-  if (!projectName || (projectName !== "." && !isValidProjectName(projectName))) {
+  if (projectName !== "." && !isValidProjectName(projectName)) {
     console.error("Error: Invalid project name. Use alphanumeric, dashes, or underscores, or '.' for the current directory.");
     process.exit(1);
   }

package/express/src/modules/auth/database/models/notification.ts

@@ -1,24 +0,0 @@
-import { relations } from "drizzle-orm";
-import { integer, sqliteTable, text } from "drizzle-orm/sqlite-core";
-import { users } from "@/modules/auth/database/models/user.js";
-
-export const notifications = sqliteTable("notifications", {
-  id: integer("id").primaryKey({ autoIncrement: true }),
-  userId: integer("user_id")
-    .notNull()
-    .references(() => users.id, { onUpdate: "cascade", onDelete: "cascade" }),
-  type: text("type").notNull(),
-  title: text("title").notNull(),
-  body: text("body"),
-  data: text("data"),
-  link: text("link"),
-  readAt: integer("read_at", { mode: "timestamp" }),
-  createdAt: integer("created_at", { mode: "timestamp" }).defaultNow().notNull()
-});
-
-export const notificationsRelations = relations(notifications, ({ one }) => ({
-  user: one(users, {
-    fields: [notifications.userId],
-    references: [users.id]
-  })
-}));

package/hono/src/modules/auth/database/models/notification.ts

@@ -1,24 +0,0 @@
-import { relations } from "drizzle-orm";
-import { integer, sqliteTable, text } from "drizzle-orm/sqlite-core";
-import { users } from "@/modules/auth/database/models/user.js";
-
-export const notifications = sqliteTable("notifications", {
-  id: integer("id").primaryKey({ autoIncrement: true }),
-  userId: integer("user_id")
-    .notNull()
-    .references(() => users.id, { onUpdate: "cascade", onDelete: "cascade" }),
-  type: text("type").notNull(),
-  title: text("title").notNull(),
-  body: text("body"),
-  data: text("data"),
-  link: text("link"),
-  readAt: integer("read_at", { mode: "timestamp" }),
-  createdAt: integer("created_at", { mode: "timestamp" }).defaultNow().notNull()
-});
-
-export const notificationsRelations = relations(notifications, ({ one }) => ({
-  user: one(users, {
-    fields: [notifications.userId],
-    references: [users.id]
-  })
-}));