@nuxt/devtools-kit 0.6.6 → 0.7.0

package/dist/{hooks-6c23ef8a.d.ts → hooks-983cdddc.d.ts}

@@ -4,12 +4,12 @@ import { NuxtOptions, Component, NuxtPage, NuxtLayout, NuxtApp, Nuxt } from 'nux
 import { StorageMounts } from 'nitropack';
 import { StorageValue } from 'unstorage';
 import { VitePluginInspectorOptions } from 'vite-plugin-vue-inspector';
-import { RouteRecordNormalized } from 'vue-router';
 import { Import, UnimportMeta } from 'unimport';
+import { RouteRecordNormalized } from 'vue-router';
 import { Options } from 'execa';
 import { NuxtAnalyzeMeta } from '@nuxt/schema';
 
-type TabCategory = 'app' | 'analyze' | 'server' | 'modules' | 'documentation' | 'advanced';
+type TabCategory = 'pinned' | 'app' | 'analyze' | 'server' | 'modules' | 'documentation' | 'advanced';
 
 interface ModuleCustomTab {
     /**
@@ -127,106 +127,7 @@ interface ModuleBuiltinTab {
     onClick?: () => void;
 }
 type ModuleTabInfo = ModuleCustomTab | ModuleBuiltinTab;
-
-interface ModuleOptions {
-    /**
-     * Enable DevTools
-     *
-     * @default true
-     */
-    enabled?: boolean;
-    /**
-     * Custom tabs
-     *
-     * This is in static format, for dynamic injection, call `nuxt.hook('devtools:customTabs')` instead
-     */
-    customTabs?: ModuleCustomTab[];
-    /**
-     * VS Code Server integration options.
-     */
-    vscode?: VSCodeIntegrationOptions;
-    /**
-     * Enable Vue Component Inspector
-     *
-     * @default true
-     */
-    componentInspector?: boolean | VitePluginInspectorOptions;
-    /**
-     * Enable vite-plugin-inspect
-     *
-     * @default true
-     */
-    viteInspect?: boolean;
-    /**
-     * Disable dev time authorization check.
-     *
-     * **NOT RECOMMENDED**, only use this if you know what you are doing.
-     *
-     * @see https://github.com/nuxt/devtools/pull/257
-     * @default false
-     */
-    disableAuthorization?: boolean;
-}
-interface ModuleGlobalOptions {
-    /**
-     * List of projects to enable devtools for. Only works when devtools is installed globally.
-     */
-    projects?: string[];
-}
-interface VSCodeIntegrationOptions {
-    /**
-     * Enable VS Code Server integration
-     */
-    enabled?: boolean;
-    /**
-     * Start VS Code Server on boot
-     *
-     * @default false
-     */
-    startOnBoot?: boolean;
-    /**
-     * Port to start VS Code Server
-     *
-     * @default 3080
-     */
-    port?: number;
-    /**
-     * Reuse existing server if available (same port)
-     */
-    reuseExistingServer?: boolean;
-    /**
-     * Determine whether to use code-server or vs code tunnel
-     *
-     * @default 'local-serve'
-     */
-    mode?: 'local-serve' | 'tunnel';
-    /**
-     * Options for VS Code tunnel
-     */
-    tunnel?: VSCodeTunnelOptions;
-}
-interface VSCodeTunnelOptions {
-    /**
-     * the machine name for port forwarding service
-     *
-     * default: device hostname
-     */
-    name?: string;
-}
-interface NuxtDevToolsUIOptions {
-    componentsView: 'list' | 'graph';
-    componentsGraphShowNodeModules: boolean;
-    componentsGraphShowGlobalComponents: boolean;
-    componentsGraphShowPages: boolean;
-    componentsGraphShowLayouts: boolean;
-    componentsGraphShowWorkspace: boolean;
-    interactionCloseOnOutsideClick: boolean;
-    showExperimentalFeatures: boolean;
-    showHelpButtons: boolean;
-    scale: number;
-    hiddenTabs: string[];
-    hiddenTabCategories: string[];
-}
+type CategorizedTabs = [TabCategory, (ModuleCustomTab | ModuleBuiltinTab)[]][];
 
 interface HookInfo {
     name: string;
@@ -392,6 +293,148 @@ interface ComponentRelationship {
     deps: string[];
 }
 
+interface ModuleOptions {
+    /**
+     * Enable DevTools
+     *
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Custom tabs
+     *
+     * This is in static format, for dynamic injection, call `nuxt.hook('devtools:customTabs')` instead
+     */
+    customTabs?: ModuleCustomTab[];
+    /**
+     * VS Code Server integration options.
+     */
+    vscode?: VSCodeIntegrationOptions;
+    /**
+     * Enable Vue Component Inspector
+     *
+     * @default true
+     */
+    componentInspector?: boolean | VitePluginInspectorOptions;
+    /**
+     * Enable vite-plugin-inspect
+     *
+     * @default true
+     */
+    viteInspect?: boolean;
+    /**
+     * Disable dev time authorization check.
+     *
+     * **NOT RECOMMENDED**, only use this if you know what you are doing.
+     *
+     * @see https://github.com/nuxt/devtools/pull/257
+     * @default false
+     */
+    disableAuthorization?: boolean;
+    /**
+     * Experimental features
+     */
+    experimental?: {
+        /**
+         * Timline tab
+         * @deprecated Use `timeline.enable` instead
+         */
+        timeline?: boolean;
+    };
+    /**
+     * Options for the timeline tab
+     */
+    timeline?: {
+        /**
+         * Enable timeline tab
+         *
+         * @default false
+         */
+        enabled?: boolean;
+        /**
+         * Track on function calls
+         */
+        functions?: {
+            include?: (string | RegExp | ((item: Import) => boolean))[];
+            /**
+             * Include from specific modules
+             *
+             * @default ['#app', '@unhead/vue']
+             */
+            includeFrom?: string[];
+            exclude?: (string | RegExp | ((item: Import) => boolean))[];
+        };
+    };
+}
+interface ModuleGlobalOptions {
+    /**
+     * List of projects to enable devtools for. Only works when devtools is installed globally.
+     */
+    projects?: string[];
+}
+interface VSCodeIntegrationOptions {
+    /**
+     * Enable VS Code Server integration
+     */
+    enabled?: boolean;
+    /**
+     * Start VS Code Server on boot
+     *
+     * @default false
+     */
+    startOnBoot?: boolean;
+    /**
+     * Port to start VS Code Server
+     *
+     * @default 3080
+     */
+    port?: number;
+    /**
+     * Reuse existing server if available (same port)
+     */
+    reuseExistingServer?: boolean;
+    /**
+     * Determine whether to use code-server or vs code tunnel
+     *
+     * @default 'local-serve'
+     */
+    mode?: 'local-serve' | 'tunnel';
+    /**
+     * Options for VS Code tunnel
+     */
+    tunnel?: VSCodeTunnelOptions;
+}
+interface VSCodeTunnelOptions {
+    /**
+     * the machine name for port forwarding service
+     *
+     * default: device hostname
+     */
+    name?: string;
+}
+interface NuxtDevToolsOptions {
+    ui: {
+        componentsView: 'list' | 'graph';
+        componentsGraphShowNodeModules: boolean;
+        componentsGraphShowGlobalComponents: boolean;
+        componentsGraphShowPages: boolean;
+        componentsGraphShowLayouts: boolean;
+        componentsGraphShowWorkspace: boolean;
+        interactionCloseOnOutsideClick: boolean;
+        showExperimentalFeatures: boolean;
+        showHelpButtons: boolean;
+        scale: number;
+        hiddenTabs: string[];
+        hiddenTabCategories: string[];
+        pinnedTabs: string[];
+    };
+    serverRoutes: {
+        selectedRoute: ServerRouteInfo | null;
+        view: 'tree' | 'list';
+        inputDefaults: Record<string, ServerRouteInput[]>;
+    };
+}
+
 interface TerminalBase {
     id: string;
     name: string;
@@ -467,8 +510,8 @@ interface ServerFunctions {
     getStaticAssets(): Promise<AssetInfo[]>;
     getServerRoutes(): ServerRouteInfo[];
     getServerApp(): NuxtApp | undefined;
-    getUIOptions(): Promise<NuxtDevToolsUIOptions>;
-    updateUIOptions(settings: Partial<NuxtDevToolsUIOptions>): Promise<void>;
+    getOptions<T extends keyof NuxtDevToolsOptions>(tab: T): Promise<NuxtDevToolsOptions[T]>;
+    updateOptions<T extends keyof NuxtDevToolsOptions>(tab: T, settings: Partial<NuxtDevToolsOptions[T]>): Promise<void>;
     checkForUpdateFor(name: string): Promise<PackageUpdateInfo | undefined>;
     getPackageManager(): Promise<PackageManagerName>;
     getNpmCommand(command: NpmCommandType, packageName: string, options?: NpmCommandOptions): Promise<string[] | undefined>;
@@ -501,6 +544,7 @@ interface ServerFunctions {
     restartNuxt(hard?: boolean): Promise<void>;
     installNuxtModule(token: string, name: string, dry?: boolean): Promise<InstallModuleReturn>;
     uninstallNuxtModule(token: string, name: string, dry?: boolean): Promise<InstallModuleReturn>;
+    enableTimeline(dry: boolean): Promise<[string, string]>;
 }
 interface ClientFunctions {
     refresh(event: ClientUpdateEvent): void;
@@ -536,7 +580,7 @@ interface NuxtDevtoolsServerContext {
      * Ensure dev auth token is valid, throw if not
      */
     ensureDevAuthToken: (token: string) => Promise<void>;
-    extendServerRpc: <ClientFunctions = {}, ServerFunctions = {}>(name: string, functions: ServerFunctions) => BirpcGroup<ClientFunctions, ServerFunctions>;
+    extendServerRpc: <ClientFunctions = Record<string, never>, ServerFunctions = Record<string, never>>(name: string, functions: ServerFunctions) => BirpcGroup<ClientFunctions, ServerFunctions>;
 }
 interface NuxtDevtoolsInfo {
     version: string;
@@ -613,4 +657,4 @@ declare module '@nuxt/schema' {
     }
 }
 
-export { AnalyzeBuildsInfo as $, AutoImportsWithMetadata as A, BasicModuleInfo as B, CompatibilityStatus as C, MaintainerInfo as D, AssetType as E, AssetInfo as F, GitHubContributor as G, HookInfo as H, ImageMeta as I, CodeSnippet as J, ComponentRelationship as K, LoadingTimeMetric as L, ModuleCustomTab as M, NuxtDevtoolsInfo as N, WizardActions as O, PluginMetric as P, GetWizardArgs as Q, RouteInfo as R, SubprocessOptions as S, TerminalState as T, ClientFunctions as U, VueInspectorData as V, WizardFunctions as W, ClientUpdateEvent as X, NuxtDevtoolsServerContext as Y, InstallModuleReturn as Z, AnalyzeBuildMeta as _, VueInspectorClient as a, ModuleOptions as a0, ModuleGlobalOptions as a1, VSCodeIntegrationOptions as a2, VSCodeTunnelOptions as a3, NuxtDevToolsUIOptions as a4, TabCategory as a5, ServerFunctions as b, ModuleLaunchView as c, ModuleIframeView as d, ModuleVNodeView as e, ModuleLaunchAction as f, ModuleView as g, ModuleIframeTabLazyOptions as h, ModuleBuiltinTab as i, ModuleTabInfo as j, TerminalBase as k, TerminalAction as l, TerminalInfo as m, PackageUpdateInfo as n, PackageManagerName as o, NpmCommandType as p, NpmCommandOptions as q, ServerRouteInfo as r, ServerRouteInputType as s, ServerRouteInput as t, Payload as u, PluginInfoWithMetic as v, InstalledModuleInfo as w, ModuleStaticInfo as x, ModuleCompatibility as y, ModuleType as z };
+export { AnalyzeBuildMeta as $, AutoImportsWithMetadata as A, BasicModuleInfo as B, CategorizedTabs as C, ModuleType as D, MaintainerInfo as E, AssetType as F, GitHubContributor as G, HookInfo as H, ImageMeta as I, AssetInfo as J, CodeSnippet as K, LoadingTimeMetric as L, ModuleCustomTab as M, NuxtDevtoolsInfo as N, ComponentRelationship as O, PluginMetric as P, WizardActions as Q, RouteInfo as R, SubprocessOptions as S, TerminalState as T, GetWizardArgs as U, VueInspectorData as V, WizardFunctions as W, ClientFunctions as X, ClientUpdateEvent as Y, NuxtDevtoolsServerContext as Z, InstallModuleReturn as _, VueInspectorClient as a, AnalyzeBuildsInfo as a0, ModuleOptions as a1, ModuleGlobalOptions as a2, VSCodeIntegrationOptions as a3, VSCodeTunnelOptions as a4, NuxtDevToolsOptions as a5, TabCategory as a6, ServerFunctions as b, ModuleLaunchView as c, ModuleIframeView as d, ModuleVNodeView as e, ModuleLaunchAction as f, ModuleView as g, ModuleIframeTabLazyOptions as h, ModuleBuiltinTab as i, ModuleTabInfo as j, TerminalBase as k, TerminalAction as l, TerminalInfo as m, PackageUpdateInfo as n, PackageManagerName as o, NpmCommandType as p, NpmCommandOptions as q, ServerRouteInfo as r, ServerRouteInputType as s, ServerRouteInput as t, Payload as u, PluginInfoWithMetic as v, InstalledModuleInfo as w, ModuleStaticInfo as x, ModuleCompatibility as y, CompatibilityStatus as z };

package/dist/index.d.ts

@@ -1,14 +1,14 @@
 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 './hooks-6c23ef8a.js';
+import { M as ModuleCustomTab, S as SubprocessOptions, T as TerminalState, N as NuxtDevtoolsInfo } from './hooks-983cdddc.js';
 import 'vue';
 import 'nuxt/schema';
 import 'nitropack';
 import 'unstorage';
 import 'vite-plugin-vue-inspector';
-import 'vue-router';
 import 'unimport';
+import 'vue-router';
 
 /**
  * Hooks to extend a custom tab in devtools.
@@ -29,7 +29,7 @@ declare function startSubprocess(execaOptions: SubprocessOptions, tabOptions: Te
     restart: () => void;
     clear: () => void;
 };
-declare function extendServerRpc<ClientFunctions = {}, ServerFunctions = {}>(namespace: string, functions: ServerFunctions, nuxt?: _nuxt_schema.Nuxt): BirpcGroup<ClientFunctions, ServerFunctions>;
+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/runtime/iframe-client.mjs

@@ -30,13 +30,13 @@ export function useDevtoolsClient() {
     clientRef = shallowRef();
     onDevtoolsClientConnected(setup);
   }
+  function onUpdateReactivity() {
+    triggerRef(clientRef);
+  }
   function setup(client) {
     clientRef.value = client;
-    if (client.host) {
-      client.host.hooks.hook("host:update:reactivity", () => {
-        triggerRef(clientRef);
-      });
-    }
+    if (client.host)
+      client.host.hooks.hook("host:update:reactivity", onUpdateReactivity);
   }
   return clientRef;
 }

package/dist/types.d.ts

@@ -1,18 +1,64 @@
-import { V as VueInspectorData, a as VueInspectorClient, L as LoadingTimeMetric, H as HookInfo, P as PluginMetric, b as ServerFunctions } from './hooks-6c23ef8a.js';
-export { _ as AnalyzeBuildMeta, $ as AnalyzeBuildsInfo, F as AssetInfo, E as AssetType, A as AutoImportsWithMetadata, B as BasicModuleInfo, U as ClientFunctions, X as ClientUpdateEvent, J as CodeSnippet, C as CompatibilityStatus, K as ComponentRelationship, Q as GetWizardArgs, G as GitHubContributor, I as ImageMeta, Z as InstallModuleReturn, w as InstalledModuleInfo, D as MaintainerInfo, i as ModuleBuiltinTab, y as ModuleCompatibility, M as ModuleCustomTab, a1 as ModuleGlobalOptions, h as ModuleIframeTabLazyOptions, d as ModuleIframeView, f as ModuleLaunchAction, c as ModuleLaunchView, a0 as ModuleOptions, x as ModuleStaticInfo, j as ModuleTabInfo, z as ModuleType, e as ModuleVNodeView, g as ModuleView, q as NpmCommandOptions, p as NpmCommandType, a4 as NuxtDevToolsUIOptions, N as NuxtDevtoolsInfo, Y as NuxtDevtoolsServerContext, o as PackageManagerName, n as PackageUpdateInfo, u as Payload, v as PluginInfoWithMetic, R as RouteInfo, r as ServerRouteInfo, t as ServerRouteInput, s as ServerRouteInputType, S as SubprocessOptions, a5 as TabCategory, l as TerminalAction, k as TerminalBase, m as TerminalInfo, T as TerminalState, a2 as VSCodeIntegrationOptions, a3 as VSCodeTunnelOptions, O as WizardActions, W as WizardFunctions } from './hooks-6c23ef8a.js';
+import { V as VueInspectorData, a as VueInspectorClient, L as LoadingTimeMetric, H as HookInfo, P as PluginMetric, b as ServerFunctions } from './hooks-983cdddc.js';
+export { $ as AnalyzeBuildMeta, a0 as AnalyzeBuildsInfo, J as AssetInfo, F as AssetType, A as AutoImportsWithMetadata, B as BasicModuleInfo, C as CategorizedTabs, X as ClientFunctions, Y as ClientUpdateEvent, K as CodeSnippet, z as CompatibilityStatus, O as ComponentRelationship, U as GetWizardArgs, G as GitHubContributor, I as ImageMeta, _ as InstallModuleReturn, w as InstalledModuleInfo, E as MaintainerInfo, i as ModuleBuiltinTab, y as ModuleCompatibility, M as ModuleCustomTab, a2 as ModuleGlobalOptions, h as ModuleIframeTabLazyOptions, d as ModuleIframeView, f as ModuleLaunchAction, c as ModuleLaunchView, a1 as ModuleOptions, x as ModuleStaticInfo, j as ModuleTabInfo, D as ModuleType, e as ModuleVNodeView, g as ModuleView, q as NpmCommandOptions, p as NpmCommandType, a5 as NuxtDevToolsOptions, N as NuxtDevtoolsInfo, Z as NuxtDevtoolsServerContext, o as PackageManagerName, n as PackageUpdateInfo, u as Payload, v as PluginInfoWithMetic, R as RouteInfo, r as ServerRouteInfo, t as ServerRouteInput, s as ServerRouteInputType, S as SubprocessOptions, a6 as TabCategory, l as TerminalAction, k as TerminalBase, m as TerminalInfo, T as TerminalState, a3 as VSCodeIntegrationOptions, a4 as VSCodeTunnelOptions, Q as WizardActions, W as WizardFunctions } from './hooks-983cdddc.js';
 import { Ref } from 'vue';
 import { AppConfig } from 'nuxt/schema';
 import { NuxtApp } from 'nuxt/dist/app/nuxt';
 import { Hookable } from 'hookable';
 import { BirpcReturn } from 'birpc';
+import { StackFrame } from 'error-stack-parser-es';
 import 'nitropack';
 import 'unstorage';
 import 'vite-plugin-vue-inspector';
-import 'vue-router';
 import 'unimport';
+import 'vue-router';
 import 'execa';
 import '@nuxt/schema';
 
+interface TimelineEventFunction {
+    type: 'function';
+    start: number;
+    end?: number;
+    name: string;
+    args?: any[];
+    result?: any;
+    stacktrace?: StackFrame[];
+    isPromise?: boolean;
+}
+interface TimelineEventRoute {
+    type: 'route';
+    start: number;
+    end?: number;
+    from: string;
+    to: string;
+}
+interface TimelineOptions {
+    enabled: boolean;
+    stacktrace: boolean;
+    arguments: boolean;
+}
+type TimelineEvent = TimelineEventFunction | TimelineEventRoute;
+interface TimelineMetrics {
+    events: TimelineEvent[];
+    nonLiteralSymbol: symbol;
+    options: TimelineOptions;
+}
+interface TimelineEventNormalized<T> {
+    event: T;
+    segment: TimelineEventsSegment;
+    relativeStart: number;
+    relativeWidth: number;
+    layer: number;
+}
+interface TimelineEventsSegment {
+    start: number;
+    end: number;
+    events: TimelineEvent[];
+    functions: TimelineEventNormalized<TimelineEventFunction>[];
+    route?: TimelineEventNormalized<TimelineEventRoute>;
+    duration: number;
+    previousGap?: number;
+}
+
 interface NuxtDevtoolsClientHooks {
     /**
      * When the DevTools navigates, used for persisting the current tab
@@ -52,7 +98,8 @@ interface NuxtDevtoolsHostClient {
     };
     loadingTimeMetrics: LoadingTimeMetric;
     getClientHooksMetrics(): HookInfo[];
-    getClientPluginMetrics(): PluginMetric[];
+    clientPluginMetrics: PluginMetric[] | undefined;
+    clientTimelineMetrics: TimelineMetrics | undefined;
     reloadPage(): void;
     close(): void;
     open(): void;
@@ -82,7 +129,7 @@ interface NuxtDevtoolsClient {
     };
     renderMarkdown: (markdown: string) => string;
     colorMode: string;
-    extendClientRpc: <ServerFunctions = {}, ClientFunctions = {}>(name: string, functions: ClientFunctions) => BirpcReturn<ServerFunctions, ClientFunctions>;
+    extendClientRpc: <ServerFunctions = Record<string, never>, ClientFunctions = Record<string, never>>(name: string, functions: ClientFunctions) => BirpcReturn<ServerFunctions, ClientFunctions>;
 }
 interface NuxtDevtoolsIframeClient {
     host: NuxtDevtoolsHostClient;
@@ -92,4 +139,4 @@ interface NuxtDevtoolsGlobal {
     setClient(client: NuxtDevtoolsHostClient): void;
 }
 
-export { HookInfo, LoadingTimeMetric, NuxtDevtoolsClient, NuxtDevtoolsClientHooks, NuxtDevtoolsGlobal, NuxtDevtoolsHostClient, NuxtDevtoolsIframeClient, PluginMetric, ServerFunctions, VueInspectorClient, VueInspectorData };
+export { HookInfo, LoadingTimeMetric, NuxtDevtoolsClient, NuxtDevtoolsClientHooks, NuxtDevtoolsGlobal, NuxtDevtoolsHostClient, NuxtDevtoolsIframeClient, PluginMetric, ServerFunctions, TimelineEvent, TimelineEventFunction, TimelineEventNormalized, TimelineEventRoute, TimelineEventsSegment, TimelineMetrics, TimelineOptions, VueInspectorClient, VueInspectorData };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxt/devtools-kit",
   "type": "module",
-  "version": "0.6.6",
+  "version": "0.7.0",
   "license": "MIT",
   "repository": "nuxt/devtools",
   "exports": {
@@ -29,21 +29,22 @@
     "*.mjs"
   ],
   "peerDependencies": {
-    "nuxt": "^3.5.1",
+    "nuxt": "^3.6.1",
     "vite": "*"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.6.1",
-    "@nuxt/schema": "^3.6.1",
+    "@nuxt/kit": "^3.6.2",
+    "@nuxt/schema": "^3.6.2",
     "execa": "^7.1.1"
   },
   "devDependencies": {
     "birpc": "^0.2.12",
+    "error-stack-parser-es": "^0.1.0",
     "hookable": "^5.5.3",
     "unbuild": "^1.2.1",
-    "unimport": "^3.0.11",
+    "unimport": "^3.1.0",
     "vite-plugin-vue-inspector": "^3.4.2",
-    "vue-router": "^4.2.2"
+    "vue-router": "^4.2.4"
   },
   "scripts": {
     "build": "unbuild",