@nuxt/devtools-kit 4.0.0-alpha.11 → 4.0.0-alpha.12

package/dist/runtime/host-client.d.mts

@@ -0,0 +1,7 @@
+import { NuxtDevtoolsHostClient } from '@nuxt/devtools-kit/types';
+import { Ref } from 'vue';
+
+declare function onDevtoolsHostClientConnected(fn: (client: NuxtDevtoolsHostClient) => void): (() => void) | undefined;
+declare function useDevtoolsHostClient(): Ref<NuxtDevtoolsHostClient | undefined>;
+
+export { onDevtoolsHostClientConnected, useDevtoolsHostClient };

package/dist/runtime/host-client.mjs

@@ -1,7 +1,8 @@
-import { shallowRef } from "vue";
+import { shallowRef } from 'vue';
+
 let clientRef;
 const fns = [];
-export function onDevtoolsHostClientConnected(fn) {
+function onDevtoolsHostClientConnected(fn) {
   fns.push(fn);
   if (typeof window === "undefined")
     return;
@@ -22,7 +23,7 @@ export function onDevtoolsHostClientConnected(fn) {
     fns.splice(fns.indexOf(fn), 1);
   };
 }
-export function useDevtoolsHostClient() {
+function useDevtoolsHostClient() {
   if (!clientRef) {
     clientRef = shallowRef();
     onDevtoolsHostClientConnected(setup);
@@ -32,3 +33,5 @@ export function useDevtoolsHostClient() {
   }
   return clientRef;
 }
+
+export { onDevtoolsHostClientConnected, useDevtoolsHostClient };

package/dist/runtime/iframe-client.d.mts

@@ -0,0 +1,42 @@
+import { DevToolsRpcClient } from '@vitejs/devtools-kit/client';
+import { Ref } from 'vue';
+import '../shared/devtools-kit.ClPv9w-a.mjs';
+import { NuxtDevtoolsIframeClient } from '../types.mjs';
+import '@vitejs/devtools-kit';
+import 'birpc';
+import 'nuxt/schema';
+import 'unimport';
+import 'vue-router';
+import 'unstorage';
+import 'vite';
+import '@nuxt/schema';
+import 'nitro/types';
+import 'nitropack';
+import 'node:child_process';
+import 'hookable';
+import 'nuxt/app';
+import 'ofetch';
+import 'shiki';
+import 'error-stack-parser-es';
+
+declare function onDevtoolsClientConnected(fn: (client: NuxtDevtoolsIframeClient) => void): (() => void) | undefined;
+/**
+ * Run a callback once the Vite DevTools client is ready, receiving the connected
+ * `DevToolsRpcClient` — the client-side mirror of the server's
+ * `onDevtoolsReady((ctx) => …)`.
+ *
+ * This is the recommended way to do client-side DevTools integration (register
+ * client RPC functions, call server functions, shared state, streaming, …):
+ *
+ * ```ts
+ * import { onDevtoolsReady } from '@nuxt/devtools-kit/iframe-client'
+ *
+ * onDevtoolsReady((kit) => {
+ *   kit.client.register({ name: 'my-module:on-update', type: 'event', handler })
+ * })
+ * ```
+ */
+declare function onDevtoolsReady(fn: (kit: DevToolsRpcClient) => void): (() => void) | undefined;
+declare function useDevtoolsClient(): Ref<NuxtDevtoolsIframeClient | undefined, NuxtDevtoolsIframeClient | undefined>;
+
+export { onDevtoolsClientConnected, onDevtoolsReady, useDevtoolsClient };

package/dist/runtime/iframe-client.mjs

@@ -1,11 +1,9 @@
-import { shallowRef, triggerRef } from "vue";
+import { shallowRef, triggerRef } from 'vue';
+
 let clientRef;
-const hasSetup = false;
 const fns = [];
-export function onDevtoolsClientConnected(fn) {
+function onDevtoolsClientConnected(fn) {
   fns.push(fn);
-  if (hasSetup)
-    return;
   if (typeof window === "undefined")
     return;
   if (window.__NUXT_DEVTOOLS__) {
@@ -25,14 +23,14 @@ export function onDevtoolsClientConnected(fn) {
     fns.splice(fns.indexOf(fn), 1);
   };
 }
-export function onDevtoolsReady(fn) {
+function onDevtoolsReady(fn) {
   return onDevtoolsClientConnected((client) => {
     const kit = client.devtools.devtoolsKit;
     if (kit)
       fn(kit);
   });
 }
-export function useDevtoolsClient() {
+function useDevtoolsClient() {
   if (!clientRef) {
     clientRef = shallowRef();
     onDevtoolsClientConnected(setup);
@@ -49,3 +47,5 @@ export function useDevtoolsClient() {
   }
   return clientRef;
 }
+
+export { onDevtoolsClientConnected, onDevtoolsReady, useDevtoolsClient };

package/dist/types.d.mts

@@ -1,4 +1,4 @@
-import { b as ServerFunctions, c as NuxtDevtoolsNotifyInput, H as HookInfo, P as PluginMetric, L as LoadingTimeMetric } from './shared/devtools-kit.ClPv9w-a.mjs';
+import { H as HookInfo, P as PluginMetric, L as LoadingTimeMetric, b as ServerFunctions, c as NuxtDevtoolsNotifyInput } from './shared/devtools-kit.ClPv9w-a.mjs';
 export { A as AnalyzeBuildMeta, d as AnalyzeBuildsInfo, e as AssetEntry, f as AssetInfo, g as AssetType, h as AutoImportsWithMetadata, B as BasicModuleInfo, C as CategorizedTabs, i as ClientFunctions, j as ClientUpdateEvent, k as CodeServerIntegrationOptions, l as CodeServerType, m as CodeSnippet, n as CompatibilityStatus, o as ComponentRelationship, p as ComponentWithRelationships, G as GitHubContributor, I as ImageMeta, q as InstallModuleReturn, r as InstalledModuleInfo, s as MaintainerInfo, t as ModuleBuiltinTab, u as ModuleCompatibility, M as ModuleCustomTab, v as ModuleIframeTabLazyOptions, w as ModuleIframeView, x as ModuleLaunchAction, y as ModuleLaunchView, z as ModuleOptions, D as ModuleStaticInfo, E as ModuleStats, F as ModuleTabInfo, J as ModuleType, K as ModuleVNodeView, O as ModuleView, Q as NpmCommandOptions, R as NpmCommandType, U as NuxtDevToolsOptions, a as NuxtDevtoolsInfo, V as NuxtDevtoolsNotifyLevel, W as NuxtDevtoolsRpc, N as NuxtDevtoolsServerContext, X as NuxtServerData, Y as PackageManagerName, Z as PackageUpdateInfo, _ as Payload, $ as PluginInfoWithMetic, a0 as RouteInfo, a1 as ScannedNitroTasks, a2 as ServerDebugContext, a3 as ServerDebugModuleMutationRecord, a4 as ServerRouteInfo, a5 as ServerRouteInput, a6 as ServerRouteInputType, a7 as ServerTaskInfo, S as SubprocessOptions, a8 as TabCategory, a9 as TerminalAction, aa as TerminalBase, ab as TerminalInfo, T as TerminalState, ac as VSCodeIntegrationOptions, ad as VSCodeTunnelOptions, ae as VueInspectorClient, af as VueInspectorData } from './shared/devtools-kit.ClPv9w-a.mjs';
 import { DevToolsRpcClient } from '@vitejs/devtools-kit/client';
 import { Hookable } from 'hookable';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxt/devtools-kit",
   "type": "module",
-  "version": "4.0.0-alpha.11",
+  "version": "4.0.0-alpha.12",
   "license": "MIT",
   "homepage": "https://devtools.nuxt.com/module/utils-kit",
   "repository": {
@@ -10,34 +10,18 @@
     "directory": "packages/devtools-kit"
   },
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
-    },
-    "./types": {
-      "types": "./types.d.ts",
-      "import": "./dist/types.mjs",
-      "require": "./dist/types.cjs"
-    },
-    "./iframe-client": {
-      "types": "./iframe-client.d.ts",
-      "import": "./iframe-client.mjs"
-    },
-    "./host-client": {
-      "types": "./host-client.d.ts",
-      "import": "./host-client.mjs"
-    }
+    ".": "./dist/index.mjs",
+    "./types": "./dist/types.mjs",
+    "./iframe-client": "./dist/runtime/iframe-client.mjs",
+    "./host-client": "./dist/runtime/host-client.mjs"
   },
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "files": [
-    "*.cjs",
-    "*.d.ts",
-    "*.mjs",
     "dist"
   ],
   "peerDependencies": {
+    "@nuxt/kit": "^4.0.0-0 || ^5.0.0-0",
     "nitro": "^3.0.0-0",
     "nitropack": "^2.0.0",
     "vite": ">=6.0"
@@ -51,11 +35,11 @@
     }
   },
   "dependencies": {
-    "@nuxt/kit": "npm:@nuxt/kit-nightly@5.0.0-29755283.b4586ef2",
     "nostics": "^1.2.0",
     "tinyexec": "^1.3.0"
   },
   "devDependencies": {
+    "@nuxt/kit": "npm:@nuxt/kit-nightly@5.0.0-29755283.b4586ef2",
     "@nuxt/schema": "npm:@nuxt/schema-nightly@5.0.0-29755283.b4586ef2",
     "birpc": "^4.1.0",
     "error-stack-parser-es": "^2.0.1",

package/dist/index.cjs

@@ -1,251 +0,0 @@
-'use strict';
-
-const kit = require('@nuxt/kit');
-const tinyexec = require('tinyexec');
-const nostics = require('nostics');
-
-function diagnosticsDocsBase(code) {
-  return `https://devtools.nuxt.com/module/migration-v4#${String(code).toLowerCase()}`;
-}
-const diagnosticCodes = {
-  /** `startSubprocess().getProcess()` → `getResult()`. */
-  NDT_DEP_0001: {
-    why: (p) => `\`${p.api}\` is deprecated.`,
-    fix: (p) => `Use \`${p.replacement}\` instead.`
-  },
-  // NDT_DEP_0002 is retired (was `disableAuthorization`, now a supported
-  // first-class option). The code is left unused so numbers stay stable.
-  /** `extendServerRpc` → `onDevtoolsReady((ctx) => ctx.rpc.register(...))`. */
-  NDT_DEP_0003: {
-    why: (p) => `\`${p.api}\` is deprecated.`,
-    fix: (p) => `Use \`${p.replacement}\` instead.`
-  },
-  /** `startSubprocess` → `onDevtoolsReady((ctx) => ctx.terminals.startChildProcess(...))`. */
-  NDT_DEP_0004: {
-    why: (p) => `\`${p.api}\` is deprecated.`,
-    fix: (p) => `Use \`${p.replacement}\` instead.`
-  },
-  /** `addCustomTab` → `onDevtoolsReady((ctx) => ctx.docks.register(...))`. */
-  NDT_DEP_0005: {
-    why: (p) => `\`${p.api}\` is deprecated.`,
-    fix: (p) => `Use \`${p.replacement}\` instead.`
-  },
-  /** `refreshCustomTabs` → `onDevtoolsReady((ctx) => ctx.docks.register(...))`. */
-  NDT_DEP_0006: {
-    why: (p) => `\`${p.api}\` is deprecated.`,
-    fix: (p) => `Use \`${p.replacement}\` instead.`
-  },
-  /** Direct `nuxt.devtools.rpc` access (`broadcast` / `functions`). */
-  NDT_DEP_0007: {
-    why: (p) => `\`${p.api}\` is deprecated.`,
-    fix: (p) => `Use \`${p.replacement}\` instead.`
-  },
-  /** Removed `vscode` module option → `codeServer`. */
-  NDT_DEP_0008: {
-    why: (p) => `\`${p.api}\` is deprecated and its legacy modes are no longer supported.`,
-    fix: (p) => `Use \`${p.replacement}\` instead. The legacy value is ignored rather than partially translated.`
-  },
-  /** `getServerData()` RPC → the Data Inspector panel's `Nuxt Application` source. */
-  NDT_DEP_0009: {
-    why: (p) => `\`${p.api}\` is deprecated.`,
-    fix: (p) => `Use \`${p.replacement}\` instead.`
-  }
-};
-const consoleDiagnostics = nostics.defineDiagnostics({
-  docsBase: diagnosticsDocsBase,
-  reporters: [nostics.createConsoleReporter()],
-  codes: diagnosticCodes
-});
-const stateByCtx = /* @__PURE__ */ new WeakMap();
-const fallbackState = { emitted: /* @__PURE__ */ new Set() };
-function getState(ctx) {
-  if (!ctx)
-    return fallbackState;
-  let state = stateByCtx.get(ctx);
-  if (!state) {
-    state = { emitted: /* @__PURE__ */ new Set() };
-    stateByCtx.set(ctx, state);
-  }
-  return state;
-}
-function getServerContext(nuxt) {
-  return nuxt?.devtools;
-}
-function registerHostDiagnostics(ctx) {
-  const host = ctx.devtoolsKit?.diagnostics;
-  if (!host)
-    return;
-  const catalog = host.defineDiagnostics({
-    docsBase: diagnosticsDocsBase,
-    codes: diagnosticCodes
-  });
-  host.register(catalog);
-  getState(ctx).hostCatalog = catalog;
-}
-function deprecate(nuxt, code, params, options = {}) {
-  const ctx = getServerContext(nuxt);
-  const state = getState(ctx);
-  const dedupeKey = `${code}:${options.key ?? code}`;
-  if (state.emitted.has(dedupeKey))
-    return;
-  state.emitted.add(dedupeKey);
-  const method = options.method ?? "warn";
-  const hostHandle = state.hostCatalog?.[code];
-  if (hostHandle)
-    return hostHandle(params, { method });
-  const handle = consoleDiagnostics[code];
-  return handle(params, { method });
-}
-function defineStandaloneDiagnostics(options) {
-  return nostics.defineDiagnostics({
-    ...options,
-    reporters: options.reporters ?? [nostics.createConsoleReporter()]
-  });
-}
-function deprecateWithNuxt(code, params, options) {
-  return deprecate(kit.useNuxt(), code, params, options);
-}
-
-const NUXT_DEVTOOLS_GROUP_ID = "nuxt";
-function addCustomTab(tab, nuxt = kit.useNuxt()) {
-  deprecate(nuxt, "NDT_DEP_0005", {
-    api: "addCustomTab",
-    replacement: "onDevtoolsReady((ctx) => ctx.docks.register(...))"
-  }, { key: typeof tab === "function" ? void 0 : tab.name });
-  nuxt.hook("devtools:customTabs", async (tabs) => {
-    if (typeof tab === "function")
-      tab = await tab();
-    tabs.push(tab);
-  });
-}
-function refreshCustomTabs(nuxt = kit.useNuxt()) {
-  deprecate(nuxt, "NDT_DEP_0006", {
-    api: "refreshCustomTabs",
-    replacement: "onDevtoolsReady((ctx) => ctx.docks.register(...).update(...))"
-  });
-  return nuxt.callHook("devtools:customTabs:refresh");
-}
-function startSubprocess(execaOptions, tabOptions, nuxt = kit.useNuxt()) {
-  deprecate(nuxt, "NDT_DEP_0004", {
-    api: "startSubprocess",
-    replacement: "onDevtoolsReady((ctx) => ctx.terminals.startChildProcess(...))"
-  }, { key: tabOptions.id });
-  const id = tabOptions.id;
-  let restarting = false;
-  function start() {
-    const proc = tinyexec.x(
-      execaOptions.command,
-      execaOptions.args,
-      {
-        nodeOptions: {
-          ...execaOptions.nodeOptions,
-          cwd: execaOptions.cwd ?? execaOptions.nodeOptions?.cwd,
-          env: {
-            ...process.env,
-            COLORS: "true",
-            FORCE_COLOR: "true",
-            ...execaOptions.env,
-            ...execaOptions.nodeOptions?.env,
-            __CLI_ARGV__: void 0
-          }
-        }
-      }
-    );
-    nuxt.callHook("devtools:terminal:write", { id, data: `> ${[execaOptions.command, ...execaOptions.args || []].join(" ")}
-
-` });
-    proc.process?.stdout?.on("data", (data) => {
-      nuxt.callHook("devtools:terminal:write", { id, data: data.toString() });
-    });
-    proc.process?.stderr?.on("data", (data) => {
-      nuxt.callHook("devtools:terminal:write", { id, data: data.toString() });
-    });
-    proc.process?.on("exit", (code) => {
-      if (!restarting) {
-        nuxt.callHook("devtools:terminal:write", { id, data: `
-> process terminated with ${code}
-` });
-        nuxt.callHook("devtools:terminal:exit", { id, code: code || 0 });
-      }
-    });
-    return proc;
-  }
-  register();
-  nuxt.hook("close", () => {
-    terminate();
-  });
-  let result = start();
-  function restart() {
-    restarting = true;
-    result.kill();
-    clear();
-    result = start();
-    restarting = false;
-  }
-  function clear() {
-    tabOptions.buffer = "";
-    register();
-  }
-  function terminate() {
-    restarting = false;
-    try {
-      result.kill();
-    } catch {
-    }
-    nuxt.callHook("devtools:terminal:remove", { id });
-  }
-  function register() {
-    nuxt.callHook("devtools:terminal:register", {
-      onActionRestart: tabOptions.restartable === false ? void 0 : restart,
-      onActionTerminate: tabOptions.terminatable === false ? void 0 : terminate,
-      isTerminated: false,
-      ...tabOptions
-    });
-  }
-  return {
-    /** @deprecated Use `getResult()` instead */
-    getProcess: () => {
-      deprecate(nuxt, "NDT_DEP_0001", {
-        api: "startSubprocess().getProcess()",
-        replacement: "getResult()"
-      }, { key: id });
-      return result.process;
-    },
-    getResult: () => result,
-    terminate,
-    restart,
-    clear
-  };
-}
-function extendServerRpc(namespace, functions, nuxt = kit.useNuxt()) {
-  const ctx = _getContext(nuxt);
-  if (!ctx)
-    throw new Error("[Nuxt DevTools] Failed to get devtools context.");
-  return ctx.extendServerRpc(namespace, functions);
-}
-function onDevToolsInitialized(fn, nuxt = kit.useNuxt()) {
-  nuxt.hook("devtools:initialized", fn);
-}
-function onDevtoolsReady(fn, nuxt = kit.useNuxt()) {
-  nuxt.hook("devtools:ready", fn);
-}
-function _getContext(nuxt = kit.useNuxt()) {
-  return nuxt?.devtools;
-}
-
-exports.createConsoleReporter = nostics.createConsoleReporter;
-exports.defineDiagnostics = nostics.defineDiagnostics;
-exports.NUXT_DEVTOOLS_GROUP_ID = NUXT_DEVTOOLS_GROUP_ID;
-exports.addCustomTab = addCustomTab;
-exports.consoleDiagnostics = consoleDiagnostics;
-exports.defineStandaloneDiagnostics = defineStandaloneDiagnostics;
-exports.deprecate = deprecate;
-exports.deprecateWithNuxt = deprecateWithNuxt;
-exports.diagnosticCodes = diagnosticCodes;
-exports.diagnosticsDocsBase = diagnosticsDocsBase;
-exports.extendServerRpc = extendServerRpc;
-exports.onDevToolsInitialized = onDevToolsInitialized;
-exports.onDevtoolsReady = onDevtoolsReady;
-exports.refreshCustomTabs = refreshCustomTabs;
-exports.registerHostDiagnostics = registerHostDiagnostics;
-exports.startSubprocess = startSubprocess;