@nuxt/devtools-kit-nightly 2.0.0-beta.0-28940159.3b2c84c

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-PRESENT Nuxt Team
+
+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/README.md

@@ -0,0 +1,129 @@
+<a href="https://devtools.nuxt.com"><img width="1200" alt="Nuxt DevTools" src="https://github-production-user-asset-6210df.s3.amazonaws.com/904724/261577617-a10567bd-ad33-48cc-9bda-9e37dbe1929f.png"></a>
+<br>
+
+<h1>
+Nuxt DevTools
+</h1>
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+[![Volta][volta-src]][volta-href]
+
+<p>
+Unleash Nuxt Developer Experience.
+<br>Nuxt DevTools is a set of visual tools that help you to know your app better.
+</p>
+
+<p>
+  <a href="https://nuxt.com/blog/nuxt-devtools-v1-0">👋 Introduction</a> |
+  <a href="https://github.com/nuxt/devtools/discussions/29">💡 Ideas & Suggestions</a> |
+  <a href="https://github.com/nuxt/devtools/discussions/31">🗺️ Project Roadmap</a> |
+  <a href="https://devtools.nuxt.com/">📚 Documentation</a>
+</p>
+
+<br>
+
+> [!NOTE]
+> You are viewing the v2.x branch which are in active development. For the latest stable version, please refer to the [v1.x branch](https://github.com/nuxt/devtools/tree/v1)
+
+## Installation
+
+> Nuxt DevTools v2 requires **Nuxt v3.15.0 or higher**.
+
+Nuxt DevTools is **enabled by default** in Nuxt v3.8.0. You can press <kbd>Shift</kbd> + <kbd>Alt</kbd> / <kbd>⇧ Shift</kbd> + <kbd>⌥ Option</kbd> + <kbd>D</kbd> in your app to open it up.
+
+If you want to explicitly enable or disable Nuxt DevTools, you can update your `nuxt.config` with:
+
+```js
+export default defineNuxtConfig({
+  devtools: {
+    enabled: true // or false to disable
+  }
+})
+```
+
+### Nightly Release Channel
+
+Similar to [Nuxt's Nightly Channel](https://nuxt.com/docs/guide/going-further/nightly-release-channel), DevTools also offers a nightly release channel, that automatically releases for every commit to `main` branch.
+
+You can opt-in to the nightly release channel by running:
+
+```diff
+{
+  "devDependencies": {
+--    "@nuxt/devtools": "^0.1.0"
+++    "@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
+  }
+}
+```
+
+Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.
+
+### Module Options
+
+To configure Nuxt DevTools, you can pass the `devtools` options.
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  devtools: {
+    // Enable devtools (default: true)
+    enabled: true,
+    // VS Code Server options
+    vscode: {},
+    // ...other options
+  }
+})
+```
+
+For all options available, please refer to TSDocs in your IDE, or the [type definition file](https://github.com/nuxt/devtools/blob/main/packages/devtools-kit/src/_types/options.ts).
+
+## Features
+
+Read the [**Announcement Blog Post 🎊**](https://nuxt.com/blog/nuxt-devtools-v1-0) for why we built Nuxt DevTools and what it can do!
+
+## Module Authors
+
+Please refer to the [Module Authors Guide](https://devtools.nuxt.com/module/guide).
+
+## Contribution Guide
+
+Please refer to the [Contribution Guide](https://devtools.nuxt.com/development/contributing).
+
+## Anonymous Usage Analytics
+
+Nuxt DevTools collects anonymous telemetry data about general usage. This helps us to accurately gauge feature usage and customization across all our users. This data will let us better understand how each features in Nuxt DevTools are used, measuring improvements made (DX and performances) and their relevance. It would also help us to prioritize our efforts and focus on the features that matter the most to our users.
+
+Nuxt DevTools' telemetry data is piped through [Nuxt Telemetry](https://github.com/nuxt/telemetry), meaning that Nuxt DevTools will respect your local and global Nuxt Telemetry settings. You can also opt-out Nuxt DevTools' telemetry in the Nuxt DevTools settings.
+
+The data we collect is completely anonymous, not traceable to the source (using hash+seed), and only meaningful in aggregate form. No data we collect is personally identifiable or trackable.
+
+### Events
+
+On top of the [default Nuxt Telemetry events](https://github.com/nuxt/telemetry#events), Nuxt DevTools also collects the following events:
+
+- Versions of Nuxt DevTools
+- Navigations between tabs/feature
+  - This helps us to understand which features are used the most to prioritize our efforts.
+- Browser and OS names and versions
+  - This helps us improve compatibility across different browsers and operating systems.
+- Click event on some action buttons
+
+## License
+
+[MIT](./LICENSE)
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@nuxt/devtools/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/@nuxt/devtools
+[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/devtools.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npm.chart.dev/@nuxt/devtools
+[license-src]: https://img.shields.io/npm/l/@nuxt/devtools.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://npmjs.com/package/@nuxt/devtools
+[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
+[nuxt-href]: https://nuxt.com
+[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
+[volta-href]: https://volta.net/nuxt/devtools?utm_source=nuxt_devtools_readme

package/dist/index.cjs

@@ -0,0 +1,112 @@
+'use strict';
+
+const kit = require('@nuxt/kit');
+const execa = require('execa');
+
+function addCustomTab(tab, nuxt = kit.useNuxt()) {
+  nuxt.hook("devtools:customTabs", async (tabs) => {
+    if (typeof tab === "function")
+      tab = await tab();
+    tabs.push(tab);
+  });
+}
+function refreshCustomTabs(nuxt = kit.useNuxt()) {
+  return nuxt.callHook("devtools:customTabs:refresh");
+}
+function startSubprocess(execaOptions, tabOptions, nuxt = kit.useNuxt()) {
+  const id = tabOptions.id;
+  let restarting = false;
+  function start() {
+    const process2 = execa.execa(
+      execaOptions.command,
+      execaOptions.args,
+      {
+        reject: false,
+        ...execaOptions,
+        env: {
+          COLORS: "true",
+          FORCE_COLOR: "true",
+          ...execaOptions.env,
+          // Force disable Nuxi CLI override
+          __CLI_ARGV__: void 0
+        }
+      }
+    );
+    nuxt.callHook("devtools:terminal:write", { id, data: `> ${[execaOptions.command, ...execaOptions.args || []].join(" ")}
+
+` });
+    process2.stdout.on("data", (data) => {
+      nuxt.callHook("devtools:terminal:write", { id, data: data.toString() });
+    });
+    process2.stderr.on("data", (data) => {
+      nuxt.callHook("devtools:terminal:write", { id, data: data.toString() });
+    });
+    process2.on("exit", (code) => {
+      if (!restarting) {
+        nuxt.callHook("devtools:terminal:write", { id, data: `
+> process terminalated with ${code}
+` });
+        nuxt.callHook("devtools:terminal:exit", { id, code: code || 0 });
+      }
+    });
+    return process2;
+  }
+  register();
+  nuxt.hook("close", () => {
+    terminate();
+  });
+  let process = start();
+  function restart() {
+    restarting = true;
+    process?.kill();
+    clear();
+    process = start();
+    restarting = false;
+  }
+  function clear() {
+    tabOptions.buffer = "";
+    register();
+  }
+  function terminate() {
+    restarting = false;
+    try {
+      process?.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 {
+    getProcess() {
+      return process;
+    },
+    terminate,
+    restart,
+    clear
+  };
+}
+function extendServerRpc(namespace, functions, nuxt = kit.useNuxt()) {
+  const ctx = _getContext(nuxt);
+  if (!ctx)
+    throw new Error("Failed to get devtools context.");
+  return ctx.extendServerRpc(namespace, functions);
+}
+function onDevToolsInitialized(fn, nuxt = kit.useNuxt()) {
+  nuxt.hook("devtools:initialized", fn);
+}
+function _getContext(nuxt = kit.useNuxt()) {
+  return nuxt?.devtools;
+}
+
+exports.addCustomTab = addCustomTab;
+exports.extendServerRpc = extendServerRpc;
+exports.onDevToolsInitialized = onDevToolsInitialized;
+exports.refreshCustomTabs = refreshCustomTabs;
+exports.startSubprocess = startSubprocess;

package/dist/index.d.cts

@@ -0,0 +1,35 @@
+import * as execa from 'execa';
+import * as _nuxt_schema from '@nuxt/schema';
+import { BirpcGroup } from 'birpc';
+import { M as ModuleCustomTab, S as SubprocessOptions, T as TerminalState, N as NuxtDevtoolsInfo } from './shared/devtools-kit-nightly.s0VF6R5p.cjs';
+import 'vue';
+import 'nuxt/schema';
+import 'unimport';
+import 'vite-plugin-vue-inspector';
+import 'vue-router';
+import 'nitropack';
+import 'unstorage';
+
+/**
+ * Hooks to extend a custom tab in devtools.
+ *
+ * Provide a function to pass a factory that can be updated dynamically.
+ */
+declare function addCustomTab(tab: ModuleCustomTab | (() => ModuleCustomTab | Promise<ModuleCustomTab>), nuxt?: _nuxt_schema.Nuxt): void;
+/**
+ * Retrigger update for custom tabs, `devtools:customTabs` will be called again.
+ */
+declare function refreshCustomTabs(nuxt?: _nuxt_schema.Nuxt): Promise<any>;
+/**
+ * Create a subprocess that handled by the DevTools.
+ */
+declare function startSubprocess(execaOptions: SubprocessOptions, tabOptions: TerminalState, nuxt?: _nuxt_schema.Nuxt): {
+    getProcess(): execa.ExecaChildProcess<string>;
+    terminate: () => void;
+    restart: () => void;
+    clear: () => void;
+};
+declare function extendServerRpc<ClientFunctions = Record<string, never>, ServerFunctions = Record<string, never>>(namespace: string, functions: ServerFunctions, nuxt?: _nuxt_schema.Nuxt): BirpcGroup<ClientFunctions, ServerFunctions>;
+declare function onDevToolsInitialized(fn: (info: NuxtDevtoolsInfo) => void, nuxt?: _nuxt_schema.Nuxt): void;
+
+export { addCustomTab, extendServerRpc, onDevToolsInitialized, refreshCustomTabs, startSubprocess };

package/dist/index.d.mts

@@ -0,0 +1,35 @@
+import * as execa from 'execa';
+import * as _nuxt_schema from '@nuxt/schema';
+import { BirpcGroup } from 'birpc';
+import { M as ModuleCustomTab, S as SubprocessOptions, T as TerminalState, N as NuxtDevtoolsInfo } from './shared/devtools-kit-nightly.s0VF6R5p.mjs';
+import 'vue';
+import 'nuxt/schema';
+import 'unimport';
+import 'vite-plugin-vue-inspector';
+import 'vue-router';
+import 'nitropack';
+import 'unstorage';
+
+/**
+ * Hooks to extend a custom tab in devtools.
+ *
+ * Provide a function to pass a factory that can be updated dynamically.
+ */
+declare function addCustomTab(tab: ModuleCustomTab | (() => ModuleCustomTab | Promise<ModuleCustomTab>), nuxt?: _nuxt_schema.Nuxt): void;
+/**
+ * Retrigger update for custom tabs, `devtools:customTabs` will be called again.
+ */
+declare function refreshCustomTabs(nuxt?: _nuxt_schema.Nuxt): Promise<any>;
+/**
+ * Create a subprocess that handled by the DevTools.
+ */
+declare function startSubprocess(execaOptions: SubprocessOptions, tabOptions: TerminalState, nuxt?: _nuxt_schema.Nuxt): {
+    getProcess(): execa.ExecaChildProcess<string>;
+    terminate: () => void;
+    restart: () => void;
+    clear: () => void;
+};
+declare function extendServerRpc<ClientFunctions = Record<string, never>, ServerFunctions = Record<string, never>>(namespace: string, functions: ServerFunctions, nuxt?: _nuxt_schema.Nuxt): BirpcGroup<ClientFunctions, ServerFunctions>;
+declare function onDevToolsInitialized(fn: (info: NuxtDevtoolsInfo) => void, nuxt?: _nuxt_schema.Nuxt): void;
+
+export { addCustomTab, extendServerRpc, onDevToolsInitialized, refreshCustomTabs, startSubprocess };

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import * as execa from 'execa';
+import * as _nuxt_schema from '@nuxt/schema';
+import { BirpcGroup } from 'birpc';
+import { M as ModuleCustomTab, S as SubprocessOptions, T as TerminalState, N as NuxtDevtoolsInfo } from './shared/devtools-kit-nightly.s0VF6R5p.js';
+import 'vue';
+import 'nuxt/schema';
+import 'unimport';
+import 'vite-plugin-vue-inspector';
+import 'vue-router';
+import 'nitropack';
+import 'unstorage';
+
+/**
+ * Hooks to extend a custom tab in devtools.
+ *
+ * Provide a function to pass a factory that can be updated dynamically.
+ */
+declare function addCustomTab(tab: ModuleCustomTab | (() => ModuleCustomTab | Promise<ModuleCustomTab>), nuxt?: _nuxt_schema.Nuxt): void;
+/**
+ * Retrigger update for custom tabs, `devtools:customTabs` will be called again.
+ */
+declare function refreshCustomTabs(nuxt?: _nuxt_schema.Nuxt): Promise<any>;
+/**
+ * Create a subprocess that handled by the DevTools.
+ */
+declare function startSubprocess(execaOptions: SubprocessOptions, tabOptions: TerminalState, nuxt?: _nuxt_schema.Nuxt): {
+    getProcess(): execa.ExecaChildProcess<string>;
+    terminate: () => void;
+    restart: () => void;
+    clear: () => void;
+};
+declare function extendServerRpc<ClientFunctions = Record<string, never>, ServerFunctions = Record<string, never>>(namespace: string, functions: ServerFunctions, nuxt?: _nuxt_schema.Nuxt): BirpcGroup<ClientFunctions, ServerFunctions>;
+declare function onDevToolsInitialized(fn: (info: NuxtDevtoolsInfo) => void, nuxt?: _nuxt_schema.Nuxt): void;
+
+export { addCustomTab, extendServerRpc, onDevToolsInitialized, refreshCustomTabs, startSubprocess };

package/dist/index.mjs

@@ -0,0 +1,106 @@
+import { useNuxt } from '@nuxt/kit';
+import { execa } from 'execa';
+
+function addCustomTab(tab, nuxt = useNuxt()) {
+  nuxt.hook("devtools:customTabs", async (tabs) => {
+    if (typeof tab === "function")
+      tab = await tab();
+    tabs.push(tab);
+  });
+}
+function refreshCustomTabs(nuxt = useNuxt()) {
+  return nuxt.callHook("devtools:customTabs:refresh");
+}
+function startSubprocess(execaOptions, tabOptions, nuxt = useNuxt()) {
+  const id = tabOptions.id;
+  let restarting = false;
+  function start() {
+    const process2 = execa(
+      execaOptions.command,
+      execaOptions.args,
+      {
+        reject: false,
+        ...execaOptions,
+        env: {
+          COLORS: "true",
+          FORCE_COLOR: "true",
+          ...execaOptions.env,
+          // Force disable Nuxi CLI override
+          __CLI_ARGV__: void 0
+        }
+      }
+    );
+    nuxt.callHook("devtools:terminal:write", { id, data: `> ${[execaOptions.command, ...execaOptions.args || []].join(" ")}
+
+` });
+    process2.stdout.on("data", (data) => {
+      nuxt.callHook("devtools:terminal:write", { id, data: data.toString() });
+    });
+    process2.stderr.on("data", (data) => {
+      nuxt.callHook("devtools:terminal:write", { id, data: data.toString() });
+    });
+    process2.on("exit", (code) => {
+      if (!restarting) {
+        nuxt.callHook("devtools:terminal:write", { id, data: `
+> process terminalated with ${code}
+` });
+        nuxt.callHook("devtools:terminal:exit", { id, code: code || 0 });
+      }
+    });
+    return process2;
+  }
+  register();
+  nuxt.hook("close", () => {
+    terminate();
+  });
+  let process = start();
+  function restart() {
+    restarting = true;
+    process?.kill();
+    clear();
+    process = start();
+    restarting = false;
+  }
+  function clear() {
+    tabOptions.buffer = "";
+    register();
+  }
+  function terminate() {
+    restarting = false;
+    try {
+      process?.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 {
+    getProcess() {
+      return process;
+    },
+    terminate,
+    restart,
+    clear
+  };
+}
+function extendServerRpc(namespace, functions, nuxt = useNuxt()) {
+  const ctx = _getContext(nuxt);
+  if (!ctx)
+    throw new Error("Failed to get devtools context.");
+  return ctx.extendServerRpc(namespace, functions);
+}
+function onDevToolsInitialized(fn, nuxt = useNuxt()) {
+  nuxt.hook("devtools:initialized", fn);
+}
+function _getContext(nuxt = useNuxt()) {
+  return nuxt?.devtools;
+}
+
+export { addCustomTab, extendServerRpc, onDevToolsInitialized, refreshCustomTabs, startSubprocess };

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

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

package/dist/runtime/host-client.mjs

@@ -0,0 +1,34 @@
+import { shallowRef } from "vue";
+let clientRef;
+const fns = [];
+export function onDevtoolsHostClientConnected(fn) {
+  fns.push(fn);
+  if (typeof window === "undefined")
+    return;
+  if (window.__NUXT_DEVTOOLS_HOST__) {
+    fns.forEach((fn2) => fn2(window.__NUXT_DEVTOOLS_HOST__));
+  }
+  Object.defineProperty(window, "__NUXT_DEVTOOLS_HOST__", {
+    set(value) {
+      if (value)
+        fns.forEach((fn2) => fn2(value));
+    },
+    get() {
+      return clientRef.value;
+    },
+    configurable: true
+  });
+  return () => {
+    fns.splice(fns.indexOf(fn), 1);
+  };
+}
+export function useDevtoolsHostClient() {
+  if (!clientRef) {
+    clientRef = shallowRef();
+    onDevtoolsHostClientConnected(setup);
+  }
+  function setup(client) {
+    clientRef.value = client;
+  }
+  return clientRef;
+}

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

@@ -0,0 +1,4 @@
+import type { NuxtDevtoolsIframeClient } from '@nuxt/devtools-kit/types';
+import type { Ref } from 'vue';
+export declare function onDevtoolsClientConnected(fn: (client: NuxtDevtoolsIframeClient) => void): (() => void) | undefined;
+export declare function useDevtoolsClient(): Ref<any, any>;

package/dist/runtime/iframe-client.mjs

@@ -0,0 +1,44 @@
+import { shallowRef, triggerRef } from "vue";
+let clientRef;
+const hasSetup = false;
+const fns = [];
+export function onDevtoolsClientConnected(fn) {
+  fns.push(fn);
+  if (hasSetup)
+    return;
+  if (typeof window === "undefined")
+    return;
+  if (window.__NUXT_DEVTOOLS__) {
+    fns.forEach((fn2) => fn2(window.__NUXT_DEVTOOLS__));
+  }
+  Object.defineProperty(window, "__NUXT_DEVTOOLS__", {
+    set(value) {
+      if (value)
+        fns.forEach((fn2) => fn2(value));
+    },
+    get() {
+      return clientRef.value;
+    },
+    configurable: true
+  });
+  return () => {
+    fns.splice(fns.indexOf(fn), 1);
+  };
+}
+export function useDevtoolsClient() {
+  if (!clientRef) {
+    clientRef = shallowRef();
+    onDevtoolsClientConnected(setup);
+  }
+  function onUpdateReactivity() {
+    if (clientRef) {
+      triggerRef(clientRef);
+    }
+  }
+  function setup(client) {
+    clientRef.value = client;
+    if (client.host)
+      client.host.hooks.hook("host:update:reactivity", onUpdateReactivity);
+  }
+  return clientRef;
+}