@devframes/nuxt 0.1.22 → 0.2.1

package/{LICENSE → LICENSE.md}

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025-present, VoidZero Inc. and contributors
+Copyright (c) 2025-PRESENT Anthony Fu <https://github.com/antfu>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/index.d.mts

@@ -0,0 +1,82 @@
+import * as _$_nuxt_schema0 from "@nuxt/schema";
+import { DevframeDefinition } from "devframe/types";
+
+//#region src/index.d.ts
+interface DevframeNuxtModuleOptions {
+  /**
+   * Base URL, relative to the deployed page, where the devframe
+   * connection meta (`__connection.json`) and dump shards live.
+   * Defaults to `'./'` — the SPA root — so a single build works at any
+   * deployment base (the browser resolves relative fetches against
+   * `document.baseURI`).
+   */
+  baseURL?: string;
+  /**
+   * Disable the opinionated Nuxt app defaults (`app.baseURL: './'`,
+   * `vite.base: './'`). Set to `true` if you need to own these yourself.
+   * Defaults to `false` — devframe sets sensible base-agnostic defaults.
+   */
+  skipAppDefaults?: boolean;
+  /**
+   * Devframe definition that powers the dev-time RPC bridge. When set
+   * (and Nuxt is in dev mode), the module starts a separate RPC + WS
+   * server alongside `nuxt dev` and registers Vite middleware at
+   * `${baseURL}__connection.json` so the client SPA can discover the
+   * WS endpoint. Without it the module stays client-only.
+   */
+  devframe?: DevframeDefinition;
+  /**
+   * Dev-time middleware mode. Mirrors `viteDevBridge`'s option of
+   * the same name.
+   *
+   *  - `true` (default) — when `devframe` is set and Nuxt is in dev
+   *    mode, start the RPC bridge with all defaults.
+   *  - `false` — skip the bridge entirely. The module remains
+   *    client-only.
+   *  - object — enable with explicit overrides.
+   */
+  devMiddleware?: boolean | {
+    /** Override the bridge port. Default: resolved via `get-port-please`. */port?: number;
+    /**
+     * Override the bridge bind host. Defaults to
+     * `nuxt.options.devServer.host ?? devframe.cli?.host ?? 'localhost'`,
+     * so `nuxt dev --host` propagates automatically.
+     */
+    host?: string; /** Flag bag forwarded to `devframe.setup(ctx, { flags })`. */
+    flags?: Record<string, unknown>;
+  };
+}
+/**
+ * Nuxt module that wires a Nuxt-built SPA up as a devframe client, and
+ * (optionally) serves the dev-time RPC bridge alongside `nuxt dev`.
+ *
+ *   - Sets `app.baseURL: './'` + `vite.base: './'` so the production
+ *     build is base-agnostic (works at any deployment path without
+ *     build-time rewriting).
+ *   - Injects a client plugin that calls {@link connectDevframe} once on
+ *     page load and exposes the RPC client via `useNuxtApp().$rpc`.
+ *   - When `devframe` is provided and Nuxt is in dev mode, registers a
+ *     Vite plugin (via `addVitePlugin(viteDevBridge(devframe, {
+ *     devMiddleware: ... }))`) that starts the RPC + WS bridge and
+ *     serves `${baseURL}__connection.json`.
+ *
+ * ```ts [nuxt.config.ts]
+ * import devframe from './src/devframe' // defineDevframe(...) export
+ *
+ * export default defineNuxtConfig({
+ *   modules: [['@devframes/nuxt', { devframe }]],
+ * })
+ * ```
+ *
+ * At the call site:
+ *
+ * ```ts [composables/payload.ts]
+ * export async function fetchPayload() {
+ *   const { $rpc } = useNuxtApp()
+ *   return $rpc.call('my-tool:get-payload')
+ * }
+ * ```
+ */
+declare const _default: _$_nuxt_schema0.NuxtModule<DevframeNuxtModuleOptions, DevframeNuxtModuleOptions, false>;
+//#endregion
+export { DevframeNuxtModuleOptions, _default as default };

package/dist/index.mjs

@@ -0,0 +1,83 @@
+import { addPlugin, addVitePlugin, createResolver, defineNuxtModule } from "@nuxt/kit";
+import { viteDevBridge } from "devframe/helpers/vite";
+//#region src/index.ts
+/**
+* Nuxt module that wires a Nuxt-built SPA up as a devframe client, and
+* (optionally) serves the dev-time RPC bridge alongside `nuxt dev`.
+*
+*   - Sets `app.baseURL: './'` + `vite.base: './'` so the production
+*     build is base-agnostic (works at any deployment path without
+*     build-time rewriting).
+*   - Injects a client plugin that calls {@link connectDevframe} once on
+*     page load and exposes the RPC client via `useNuxtApp().$rpc`.
+*   - When `devframe` is provided and Nuxt is in dev mode, registers a
+*     Vite plugin (via `addVitePlugin(viteDevBridge(devframe, {
+*     devMiddleware: ... }))`) that starts the RPC + WS bridge and
+*     serves `${baseURL}__connection.json`.
+*
+* ```ts [nuxt.config.ts]
+* import devframe from './src/devframe' // defineDevframe(...) export
+*
+* export default defineNuxtConfig({
+*   modules: [['@devframes/nuxt', { devframe }]],
+* })
+* ```
+*
+* At the call site:
+*
+* ```ts [composables/payload.ts]
+* export async function fetchPayload() {
+*   const { $rpc } = useNuxtApp()
+*   return $rpc.call('my-tool:get-payload')
+* }
+* ```
+*/
+var src_default = defineNuxtModule({
+	meta: {
+		name: "devframe",
+		configKey: "devframe"
+	},
+	defaults: {
+		baseURL: "./",
+		skipAppDefaults: false,
+		devMiddleware: true
+	},
+	setup(options, nuxt) {
+		const { resolve } = createResolver(import.meta.url);
+		if (!options.skipAppDefaults) {
+			nuxt.options.app ??= {};
+			nuxt.options.app.baseURL ??= "./";
+			nuxt.options.vite ??= {};
+			nuxt.options.vite.base ??= "./";
+		}
+		nuxt.options.runtimeConfig ??= {};
+		nuxt.options.runtimeConfig.public ??= {};
+		const publicConfig = nuxt.options.runtimeConfig.public;
+		publicConfig.devframe = {
+			...publicConfig.devframe ?? {},
+			baseURL: options.baseURL
+		};
+		const runtimeDir = resolve("./runtime");
+		nuxt.hook("prepare:types", ({ references }) => {
+			references.push({ path: resolve(runtimeDir, "types") });
+		});
+		addPlugin({
+			src: resolve(runtimeDir, "plugin.client"),
+			mode: "client"
+		});
+		if (options.devframe && options.devMiddleware !== false && nuxt.options.dev) {
+			const mw = options.devMiddleware === true || options.devMiddleware === void 0 ? {} : options.devMiddleware;
+			const host = mw.host ?? nuxt.options.devServer?.host ?? options.devframe.cli?.host;
+			addVitePlugin(viteDevBridge(options.devframe, {
+				base: options.baseURL ?? "./",
+				devMiddleware: {
+					port: mw.port,
+					host,
+					flags: mw.flags
+				}
+			}));
+		}
+	}
+});
+//#endregion
+export { src_default as default };

package/dist/runtime/plugin.client.d.ts

@@ -0,0 +1,6 @@
+import type { Plugin } from '#app';
+import type { DevToolsRpcClient } from 'devframe/client';
+declare const plugin: Plugin<{
+  rpc: DevToolsRpcClient;
+}>;
+export default plugin;

package/dist/runtime/plugin.client.js

@@ -0,0 +1,12 @@
+import { connectDevframe } from "devframe/client";
+import { defineNuxtPlugin, useRuntimeConfig } from "#imports";
+//#region src/runtime/plugin.client.ts
+/**
+* Nuxt client plugin that calls `connectDevframe()` once on the client
+* and provides the RPC client as `$rpc` / `useNuxtApp().$rpc`.
+*/
+var plugin_client_default = defineNuxtPlugin({ async setup() {
+	return { provide: { rpc: await connectDevframe({ baseURL: useRuntimeConfig().public?.devframe?.baseURL ?? "./" }) } };
+} });
+//#endregion
+export { plugin_client_default as default };

package/dist/runtime/types.d.ts

@@ -0,0 +1,20 @@
+import type { DevToolsRpcClient } from 'devframe/client'
+
+declare module '#app' {
+  interface NuxtApp {
+    /**
+     * Devframe RPC client, provided by the `@devframes/nuxt` module's
+     * client plugin.
+     */
+    $rpc: DevToolsRpcClient
+  }
+}
+
+declare module 'vue' {
+  interface ComponentCustomProperties {
+    /** Devframe RPC client (see `NuxtApp['$rpc']`). */
+    $rpc: DevToolsRpcClient
+  }
+}
+
+export {}

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@devframes/nuxt",
   "type": "module",
-  "version": "0.1.22",
+  "version": "0.2.1",
   "description": "Nuxt module for Devframe — wires a Nuxt-built SPA up as a devframe client",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
-  "homepage": "https://github.com/vitejs/devtools#readme",
+  "homepage": "https://github.com/devframes/devframe#readme",
   "repository": {
-    "directory": "devframe/packages/nuxt",
+    "directory": "packages/nuxt",
     "type": "git",
-    "url": "git+https://github.com/vitejs/devtools.git"
+    "url": "git+https://github.com/devframes/devframe.git"
   },
-  "bugs": "https://github.com/vitejs/devtools/issues",
+  "bugs": "https://github.com/devframes/devframe/issues",
   "keywords": [
     "devframe",
     "nuxt",
@@ -20,20 +20,22 @@
   "sideEffects": false,
   "exports": {
     ".": "./dist/index.mjs",
-    "./runtime/plugin.client": "./dist/runtime/plugin.client.mjs",
     "./package.json": "./package.json"
   },
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.mts",
   "files": [
     "dist"
   ],
   "peerDependencies": {
-    "@nuxt/kit": "^3.0.0 || ^4.0.0",
-    "devframe": "0.1.22"
+    "@nuxt/kit": "^3.0.0 || ^4.0.0 || ^5.0.0-0",
+    "devframe": "0.2.1"
   },
   "devDependencies": {
     "@nuxt/kit": "^4.4.5",
-    "tsdown": "^0.22.0"
+    "@types/node": "^25.7.0",
+    "nuxt": "^4.4.4",
+    "tsdown": "^0.22.0",
+    "devframe": "0.2.1"
   },
   "scripts": {
     "build": "tsdown",