@devframes/nuxt 0.9.0-beta.2 → 0.9.0-beta.7

package/dist/hub-client.d.mts

@@ -0,0 +1,28 @@
+import { DevframeClientHost, DevframeClientHost as DevframeClientHost$1, DevframeClientHostOptions, DevframeClientHostOptions as DevframeClientHostOptions$1 } from "@devframes/hub/client";
+import { Ref } from "vue";
+//#region src/hub-client.d.ts
+interface UseDevframeHubClientOptions extends DevframeClientHostOptions$1 {
+  /**
+   * Hub mount base to connect to. Forwarded as `connect.baseURL` when no
+   * `rpc` / `connect.baseURL` is supplied.
+   *
+   * @default '/__devframes/'
+   */
+  base?: string;
+}
+/**
+ * Boot the devframes-hub **client runtime** inside a Nuxt (Vue) client
+ * component — the browser half of `@devframes/nuxt/hub`. Connects RPC to the
+ * hub (defaulting `base` to `/__devframes/`), assembles the shared
+ * `DevframeClientContext`, imports each dock's client script into the page,
+ * and disposes when the current effect scope is torn down. Returns a ref that
+ * resolves to the {@link DevframeClientHost} (`null` while connecting).
+ *
+ * Client-only: call it inside `<script setup>` on a client-rendered component
+ * (e.g. under `<ClientOnly>`), never during SSR. Only needed when you render
+ * your own dock UI (or override the hub's `ui`); with the default
+ * `@devframes/hub-ui` the injected `embedded.js` boots the client for you.
+ */
+declare function useDevframeHubClient(options?: UseDevframeHubClientOptions): Ref<DevframeClientHost$1 | null>;
+//#endregion
+export { type DevframeClientHost, type DevframeClientHostOptions, UseDevframeHubClientOptions, useDevframeHubClient };

package/dist/hub-client.mjs

@@ -0,0 +1,43 @@
+import { createDevframeClientHost } from "@devframes/hub/client";
+import { DEVFRAMES_HUB_BASE } from "@devframes/hub/constants";
+import { onScopeDispose, shallowRef } from "vue";
+//#region src/hub-client.ts
+/**
+* Boot the devframes-hub **client runtime** inside a Nuxt (Vue) client
+* component — the browser half of `@devframes/nuxt/hub`. Connects RPC to the
+* hub (defaulting `base` to `/__devframes/`), assembles the shared
+* `DevframeClientContext`, imports each dock's client script into the page,
+* and disposes when the current effect scope is torn down. Returns a ref that
+* resolves to the {@link DevframeClientHost} (`null` while connecting).
+*
+* Client-only: call it inside `<script setup>` on a client-rendered component
+* (e.g. under `<ClientOnly>`), never during SSR. Only needed when you render
+* your own dock UI (or override the hub's `ui`); with the default
+* `@devframes/hub-ui` the injected `embedded.js` boots the client for you.
+*/
+function useDevframeHubClient(options = {}) {
+	const { base = DEVFRAMES_HUB_BASE, connect, ...rest } = options;
+	const host = shallowRef(null);
+	let disposed = false;
+	createDevframeClientHost({
+		...rest,
+		...rest.rpc ? {} : { connect: {
+			baseURL: base,
+			...connect
+		} }
+	}).then((created) => {
+		if (disposed) {
+			created.dispose();
+			return;
+		}
+		host.value = created;
+	});
+	onScopeDispose(() => {
+		disposed = true;
+		host.value?.dispose();
+		host.value = null;
+	});
+	return host;
+}
+//#endregion
+export { useDevframeHubClient };

package/dist/hub.d.mts

@@ -0,0 +1,40 @@
+import { ViteDevframeHubOptions } from "@devframes/vite/hub";
+//#region src/hub.d.ts
+interface DevframeNuxtHubOptions extends Omit<ViteDevframeHubOptions, 'quiet'> {
+  /**
+   * Inject `@devframes/hub-ui`'s floating-dock bootstrap (`<base>embedded.js`)
+   * into the app head in dev. Disable if you render your own UI or pass
+   * `ui: false`. Default: `true` (unless `ui` is `false`).
+   */
+  injectEmbedded?: boolean;
+  /**
+   * Silence the notice recommending Nuxt DevTools. See the module docs.
+   *
+   * @default false
+   */
+  quiet?: boolean;
+}
+type ModuleOptions = DevframeNuxtHubOptions;
+/**
+ * Nuxt module that mounts a whole **devframes-hub** alongside `nuxt dev` —
+ * many integrations under one namespace, one merged RPC registry — by wiring
+ * `@devframes/vite`'s hub plugin into Nuxt's underlying Vite dev server and
+ * injecting `@devframes/hub-ui`'s floating dock into the app. The UI defaults
+ * to `@devframes/hub-ui`; pass `ui` to swap it or `ui: false` for a headless
+ * hub you drive with `@devframes/nuxt/hub/client`.
+ *
+ * This mounts one integration-agnostic hub. Nuxt DevTools (`@nuxt/devtools`)
+ * integrates the same hub protocol natively and is the recommended path for a
+ * Nuxt app, so this module emits a one-time notice to that effect (silence it
+ * with `{ quiet: true }`). To wire a Nuxt app up as a single devframe client,
+ * reach for `@devframes/nuxt/single` instead.
+ *
+ * ```ts [nuxt.config.ts]
+ * export default defineNuxtConfig({
+ *   modules: [['@devframes/nuxt/hub', { devframes: [] }]],
+ * })
+ * ```
+ */
+declare const _default: import("@nuxt/schema").NuxtModule<DevframeNuxtHubOptions, DevframeNuxtHubOptions, false>;
+//#endregion
+export { DevframeNuxtHubOptions, ModuleOptions, _default as default };

package/dist/hub.mjs

@@ -0,0 +1,60 @@
+import { addVitePlugin, createResolver, defineNuxtModule } from "@nuxt/kit";
+import { DEVFRAMES_HUB_BASE, normalizeHubBase } from "@devframes/hub/constants";
+import { viteDevframeHub } from "@devframes/vite/hub";
+//#region src/hub.ts
+let recommendedNuxtDevtools = false;
+function recommendNuxtDevtools() {
+	if (recommendedNuxtDevtools) return;
+	recommendedNuxtDevtools = true;
+	console.warn("[@devframes/nuxt/hub] Serving a devframes-hub directly inside Nuxt works, but Nuxt DevTools (`@nuxt/devtools`) integrates the hub protocol natively — prefer it for a first-class, multi-integration experience. Pass `{ quiet: true }` to silence this notice.");
+}
+/**
+* Nuxt module that mounts a whole **devframes-hub** alongside `nuxt dev` —
+* many integrations under one namespace, one merged RPC registry — by wiring
+* `@devframes/vite`'s hub plugin into Nuxt's underlying Vite dev server and
+* injecting `@devframes/hub-ui`'s floating dock into the app. The UI defaults
+* to `@devframes/hub-ui`; pass `ui` to swap it or `ui: false` for a headless
+* hub you drive with `@devframes/nuxt/hub/client`.
+*
+* This mounts one integration-agnostic hub. Nuxt DevTools (`@nuxt/devtools`)
+* integrates the same hub protocol natively and is the recommended path for a
+* Nuxt app, so this module emits a one-time notice to that effect (silence it
+* with `{ quiet: true }`). To wire a Nuxt app up as a single devframe client,
+* reach for `@devframes/nuxt/single` instead.
+*
+* ```ts [nuxt.config.ts]
+* export default defineNuxtConfig({
+*   modules: [['@devframes/nuxt/hub', { devframes: [] }]],
+* })
+* ```
+*/
+var hub_default = defineNuxtModule({
+	meta: {
+		name: "@devframes/nuxt/hub",
+		configKey: "devframeHub"
+	},
+	defaults: {},
+	setup(options, nuxt) {
+		if (!options.quiet) recommendNuxtDevtools();
+		if (!nuxt.options.dev) return;
+		createResolver(import.meta.url);
+		const base = normalizeHubBase(options.base ?? DEVFRAMES_HUB_BASE);
+		const { injectEmbedded, quiet: _quiet, ...hubOptions } = options;
+		addVitePlugin(viteDevframeHub({
+			...hubOptions,
+			base,
+			quiet: true
+		}));
+		if (injectEmbedded ?? options.ui !== false) {
+			nuxt.options.app ??= {};
+			nuxt.options.app.head ??= {};
+			nuxt.options.app.head.script ??= [];
+			nuxt.options.app.head.script.push({
+				type: "module",
+				src: `${base}embedded.js`
+			});
+		}
+	}
+});
+//#endregion
+export { hub_default as default };

package/dist/index.d.mts

@@ -0,0 +1 @@
+export {}

package/dist/index.mjs

@@ -0,0 +1,4 @@
+//#region src/index.ts
+throw new Error("[@devframes/nuxt] has no root export. Use a scoped subpath instead:\n  • modules: [\"@devframes/nuxt/single\"] — Nuxt app as one devframe client\n  • modules: [\"@devframes/nuxt/hub\"]    — mount a devframes-hub with nuxt dev\n");
+//#endregion
+export {};

package/dist/module.json

@@ -1,8 +1,8 @@
 {
-  "name": "@devframes/nuxt",
+  "name": "@devframes/nuxt/single",
   "configKey": "devframe",
-  "version": "0.9.0-beta.2",
+  "version": "0.9.0-beta.7",
   "builder": {
     "tsdown": "0.22.14"
-  }        
+  }
 }

package/dist/{module.d.mts → single.d.mts}

@@ -1,5 +1,5 @@
 import { DevframeDefinition } from "devframe";
-//#region src/module.d.ts
+//#region src/single.d.ts
 interface DevframeNuxtModuleOptions {
   /**
    * Base URL, relative to the deployed page, where the devframe
@@ -24,8 +24,8 @@ interface DevframeNuxtModuleOptions {
    */
   devframe?: DevframeDefinition;
   /**
-   * Dev-time middleware mode. Mirrors `viteDevBridge`'s option of
-   * the same name.
+   * Dev-time middleware mode — whether to start `@devframes/vite`'s
+   * RPC bridge (`devframeViteBridge`) alongside `nuxt dev`.
    *
    *  - `true` (default) — when `devframe` is set and Nuxt is in dev
    *    mode, start the RPC bridge with all defaults.
@@ -57,9 +57,9 @@ type ModuleOptions = DevframeNuxtModuleOptions;
  *   - 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`.
+ *     Vite plugin (via `addVitePlugin(devframeViteBridge(devframe, {
+ *     ... }))`) that starts the RPC + WS bridge and serves
+ *     `${baseURL}__connection.json`.
  *
  * ```ts [nuxt.config.ts]
  * import devframe from './src/devframe' // defineDevframe(...) export

package/dist/{module.mjs → single.mjs}

@@ -1,6 +1,6 @@
+import { devframeViteBridge } from "@devframes/vite/single";
 import { addPlugin, addVitePlugin, createResolver, defineNuxtModule } from "@nuxt/kit";
-import { viteDevBridge } from "devframe/helpers/vite";
-//#region src/module.ts
+//#region src/single.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`.
@@ -11,9 +11,9 @@ import { viteDevBridge } from "devframe/helpers/vite";
 *   - 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`.
+*     Vite plugin (via `addVitePlugin(devframeViteBridge(devframe, {
+*     ... }))`) that starts the RPC + WS bridge and serves
+*     `${baseURL}__connection.json`.
 *
 * ```ts [nuxt.config.ts]
 * import devframe from './src/devframe' // defineDevframe(...) export
@@ -32,7 +32,7 @@ import { viteDevBridge } from "devframe/helpers/vite";
 * }
 * ```
 */
-var module_default = defineNuxtModule({
+var single_default = defineNuxtModule({
 	meta: {
 		name: "@devframes/nuxt",
 		configKey: "devframe"
@@ -66,16 +66,14 @@ var module_default = defineNuxtModule({
 		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, {
+			addVitePlugin(devframeViteBridge(options.devframe, {
 				base: options.baseURL ?? "./",
-				devMiddleware: {
-					port: mw.port,
-					host,
-					flags: mw.flags
-				}
+				port: mw.port,
+				host,
+				flags: mw.flags
 			}));
 		}
 	}
 });
 //#endregion
-export { module_default as default };
+export { single_default as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@devframes/nuxt",
   "type": "module",
-  "version": "0.9.0-beta.2",
+  "version": "0.9.0-beta.7",
   "description": "Nuxt module that exposes a Nuxt app as a devframe client.",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -20,25 +20,52 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./dist/types.d.mts",
-      "default": "./dist/module.mjs"
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./single": {
+      "types": "./dist/single.d.mts",
+      "default": "./dist/single.mjs"
+    },
+    "./hub": {
+      "types": "./dist/hub.d.mts",
+      "default": "./dist/hub.mjs"
+    },
+    "./hub/client": {
+      "types": "./dist/hub-client.d.mts",
+      "default": "./dist/hub-client.mjs"
     },
     "./package.json": "./package.json"
   },
-  "types": "./dist/types.d.mts",
+  "types": "./dist/index.d.mts",
   "files": [
     "dist"
   ],
   "peerDependencies": {
     "@nuxt/kit": "^3.0.0 || ^4.0.0 || ^5.0.0-0",
-    "devframe": "0.9.0-beta.2"
+    "vue": "^3.0.0",
+    "@devframes/hub": "0.9.0-beta.7",
+    "devframe": "0.9.0-beta.7"
+  },
+  "peerDependenciesMeta": {
+    "@devframes/hub": {
+      "optional": true
+    },
+    "vue": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@devframes/vite": "0.9.0-beta.7"
   },
   "devDependencies": {
     "@nuxt/kit": "^4.5.2",
     "@types/node": "^26.2.0",
     "nuxt": "^4.5.2",
     "tsdown": "^0.22.14",
-    "devframe": "0.9.0-beta.2"
+    "vue": "^3.5.41",
+    "devframe": "0.9.0-beta.7",
+    "@devframes/hub": "0.9.0-beta.7"
   },
   "scripts": {
     "build": "tsdown",

package/dist/types.d.mts

@@ -1,3 +0,0 @@
-export { default } from './module.mjs';
-
-export { type ModuleOptions, type DevframeNuxtModuleOptions } from './module.mjs';