@devframes/nuxt 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present, VoidZero Inc. and contributors
+
+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/dist/index.d.mts

@@ -0,0 +1,46 @@
+import * as _$_nuxt_schema0 from "@nuxt/schema";
+
+//#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;
+}
+/**
+ * Nuxt module that wires a Nuxt-built SPA up as a devframe client:
+ *
+ *   - 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 connectDevtool} once on
+ *     page load and exposes the RPC client via `useNuxtApp().$rpc`.
+ *
+ * ```ts [nuxt.config.ts]
+ * export default defineNuxtConfig({
+ *   modules: ['@devframes/nuxt'],
+ * })
+ * ```
+ *
+ * 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,58 @@
+import { addPlugin, createResolver, defineNuxtModule } from "@nuxt/kit";
+//#region src/index.ts
+/**
+* Nuxt module that wires a Nuxt-built SPA up as a devframe client:
+*
+*   - 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 connectDevtool} once on
+*     page load and exposes the RPC client via `useNuxtApp().$rpc`.
+*
+* ```ts [nuxt.config.ts]
+* export default defineNuxtConfig({
+*   modules: ['@devframes/nuxt'],
+* })
+* ```
+*
+* 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
+	},
+	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
+		};
+		addPlugin({
+			src: resolve("./runtime/plugin.client"),
+			mode: "client"
+		});
+	}
+});
+//#endregion
+export { src_default as default };

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

@@ -0,0 +1,8 @@
+//#region src/runtime/plugin.client.d.ts
+/**
+ * Nuxt client plugin that calls `connectDevtool()` once on the client
+ * and provides the RPC client as `$rpc` / `useNuxtApp().$rpc`.
+ */
+declare const _default: any;
+//#endregion
+export { _default as default };

package/dist/runtime/plugin.client.mjs

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

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@devframes/nuxt",
+  "type": "module",
+  "version": "0.0.0",
+  "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",
+  "repository": {
+    "directory": "devframe/packages/nuxt",
+    "type": "git",
+    "url": "git+https://github.com/vitejs/devtools.git"
+  },
+  "bugs": "https://github.com/vitejs/devtools/issues",
+  "keywords": [
+    "devframe",
+    "nuxt",
+    "devtools"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./runtime/plugin.client": "./dist/runtime/plugin.client.mjs",
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@nuxt/kit": "^3.0.0 || ^4.0.0",
+    "devframe": "0.1.19"
+  },
+  "devDependencies": {
+    "@nuxt/kit": "^4.4.4",
+    "tsdown": "^0.21.10"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "watch": "tsdown --watch"
+  }
+}