@vitejs/devtools-kit 0.0.0-alpha.17 → 0.0.0-alpha.19

package/dist/client.d.mts

@@ -1,2 +1,3 @@
-import { a as DockEntryState, c as DocksContext, d as ClientRpcReturn, f as DevToolsRpcClient, i as DockClientType, l as DocksEntriesContext, m as getDevToolsRpcClient, n as DevToolsClientContext, o as DockEntryStateEvents, p as DevToolsRpcClientOptions, r as DevToolsClientRpcHost, s as DockPanelStorage, t as DockClientScriptContext, u as DocksPanelContext } from "./index-C-bl_jKJ.mjs";
+import "./events-DDdYnct9.mjs";
+import { a as DockEntryState, c as DocksContext, d as ClientRpcReturn, f as DevToolsRpcClient, i as DockClientType, l as DocksEntriesContext, m as getDevToolsRpcClient, n as DevToolsClientContext, o as DockEntryStateEvents, p as DevToolsRpcClientOptions, r as DevToolsClientRpcHost, s as DockPanelStorage, t as DockClientScriptContext, u as DocksPanelContext } from "./index-CgOheNVD.mjs";
 export { ClientRpcReturn, DevToolsClientContext, DevToolsClientRpcHost, DevToolsRpcClient, DevToolsRpcClientOptions, DockClientScriptContext, DockClientType, DockEntryState, DockEntryStateEvents, DockPanelStorage, DocksContext, DocksEntriesContext, DocksPanelContext, getDevToolsRpcClient };

package/dist/client.mjs

@@ -3,23 +3,36 @@ import { createRpcClient } from "@vitejs/devtools-rpc";
 import { createWsRpcPreset } from "@vitejs/devtools-rpc/presets/ws/client";
 
 //#region src/client/rpc.ts
+const CONNECTION_META_KEY = "__VITE_DEVTOOLS_CONNECTION_META__";
 function isNumeric(str) {
 	if (str == null) return false;
 	return `${+str}` === `${str}`;
 }
+function findConnectionMetaFromWindows() {
+	const getters = [
+		() => window[CONNECTION_META_KEY],
+		() => globalThis[CONNECTION_META_KEY],
+		() => parent.window[CONNECTION_META_KEY]
+	];
+	for (const getter of getters) try {
+		const value = getter();
+		if (value) return value;
+	} catch {}
+}
 async function getDevToolsRpcClient(options = {}) {
 	const { baseURL = "/.devtools/", rpcOptions = {} } = options;
-	const urls = Array.isArray(baseURL) ? baseURL : [baseURL];
-	let connectionMeta = options.connectionMeta;
+	const bases = Array.isArray(baseURL) ? baseURL : [baseURL];
+	let connectionMeta = options.connectionMeta || findConnectionMetaFromWindows();
 	if (!connectionMeta) {
 		const errors = [];
-		for (const url$1 of urls) try {
-			connectionMeta = await fetch(`${url$1}.vdt-connection.json`).then((r) => r.json());
+		for (const base of bases) try {
+			connectionMeta = await fetch(`${base}.vdt-connection.json`).then((r) => r.json());
+			globalThis[CONNECTION_META_KEY] = connectionMeta;
 			break;
 		} catch (e) {
 			errors.push(e);
 		}
-		if (!connectionMeta) throw new Error(`Failed to get connection meta from ${urls.join(", ")}`, { cause: errors });
+		if (!connectionMeta) throw new Error(`Failed to get connection meta from ${bases.join(", ")}`, { cause: errors });
 	}
 	const url = isNumeric(connectionMeta.websocket) ? `${location.protocol.replace("http", "ws")}//${location.hostname}:${connectionMeta.websocket}` : connectionMeta.websocket;
 	const context = { rpc: void 0 };

package/dist/events-DDdYnct9.d.mts

@@ -0,0 +1,46 @@
+//#region src/types/events.d.ts
+interface EventsMap {
+  [event: string]: any;
+}
+interface EventUnsubscribe {
+  (): void;
+}
+interface EventEmitter<Events extends EventsMap> {
+  /**
+   * Calls each of the listeners registered for a given event.
+   *
+   * ```js
+   * ee.emit('tick', tickType, tickDuration)
+   * ```
+   *
+   * @param event The event name.
+   * @param args The arguments for listeners.
+   */
+  emit: <K extends keyof Events>(this: this, event: K, ...args: Parameters<Events[K]>) => void;
+  /**
+   * Event names in keys and arrays with listeners in values.
+   *
+   * @internal
+   */
+  _listeners: Partial<{ [E in keyof Events]: Events[E][] }>;
+  /**
+   * Add a listener for a given event.
+   *
+   * ```js
+   * const unbind = ee.on('tick', (tickType, tickDuration) => {
+   *   count += 1
+   * })
+   *
+   * disable () {
+   *   unbind()
+   * }
+   * ```
+   *
+   * @param event The event name.
+   * @param cb The listener function.
+   * @returns Unbind listener from event.
+   */
+  on: <K extends keyof Events>(this: this, event: K, cb: Events[K]) => EventUnsubscribe;
+}
+//#endregion
+export { EventUnsubscribe as n, EventsMap as r, EventEmitter as t };

package/dist/{index-C-bl_jKJ.d.mts → index-CgOheNVD.d.mts}

@@ -1,50 +1,32 @@
+import { t as EventEmitter } from "./events-DDdYnct9.mjs";
 import { RpcDefinitionsFilter, RpcDefinitionsToFunctions, RpcFunctionsCollector, RpcFunctionsCollectorBase } from "birpc-x";
 import { WebSocketRpcClientOptions } from "@vitejs/devtools-rpc/presets/ws/client";
-import { Emitter } from "nanoevents";
 import { Raw } from "vue";
 import { BirpcGroup, BirpcOptions, BirpcReturn } from "birpc";
 import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
+import { ChildProcess } from "node:child_process";
 
-//#region src/types/rpc-augments.d.ts
-/**
- * To be extended
- */
-interface DevToolsRpcClientFunctions {}
-/**
- * To be extended
- */
-interface DevToolsRpcServerFunctions {}
-//#endregion
-//#region src/types/views.d.ts
+//#region src/types/docks.d.ts
 interface DevToolsDockHost {
-  views: Map<string, DevToolsDockEntry>;
-  register: (entry: DevToolsDockEntry) => void;
-  update: (entry: DevToolsDockEntry) => void;
-  values: () => DevToolsDockEntry[];
-}
-interface DevToolsViewHost {
-  /**
-   * @internal
-   */
-  buildStaticDirs: {
-    baseUrl: string;
-    distDir: string;
-  }[];
-  /**
-   * Helper to host static files
-   * - In `dev` mode, it will register middleware to `viteServer.middlewares` to host the static files
-   * - In `build` mode, it will copy the static files to the dist directory
-   */
-  hostStatic: (baseUrl: string, distDir: string) => void;
+  readonly views: Map<string, DevToolsDockUserEntry>;
+  readonly events: EventEmitter<{
+    'dock:entry:updated': (entry: DevToolsDockUserEntry) => void;
+  }>;
+  register: <T extends DevToolsDockUserEntry>(entry: T, force?: boolean) => {
+    update: (patch: Partial<T>) => void;
+  };
+  update: (entry: DevToolsDockUserEntry) => void;
+  values: () => DevToolsDockUserEntry[];
 }
 type DevToolsDockEntryCategory = 'app' | 'framework' | 'web' | 'advanced' | 'default';
+type DevToolsDockEntryIcon = string | {
+  light: string;
+  dark: string;
+};
 interface DevToolsDockEntryBase {
   id: string;
   title: string;
-  icon: string | {
-    light: string;
-    dark: string;
-  };
+  icon: DevToolsDockEntryIcon;
   /**
    * The default order of the entry in the dock.
    * The higher the number the earlier it appears.
@@ -56,6 +38,11 @@ interface DevToolsDockEntryBase {
    * @default 'default'
    */
   category?: DevToolsDockEntryCategory;
+  /**
+   * Whether the entry should be hidden from the user.
+   * @default false
+   */
+  isHidden?: boolean;
 }
 interface ClientScriptEntry {
   /**
@@ -83,6 +70,20 @@ interface DevToolsViewIframe extends DevToolsDockEntryBase {
    */
   clientScript?: ClientScriptEntry;
 }
+type DevToolsViewLauncherStatus = 'idle' | 'loading' | 'success' | 'error';
+interface DevToolsViewLauncher extends DevToolsDockEntryBase {
+  type: 'launcher';
+  launcher: {
+    icon?: DevToolsDockEntryIcon;
+    title: string;
+    status?: DevToolsViewLauncherStatus;
+    error?: string;
+    description?: string;
+    buttonStart?: string;
+    buttonLoading?: string;
+    onLaunch: () => Promise<void>;
+  };
+}
 interface DevToolsViewAction extends DevToolsDockEntryBase {
   type: 'action';
   action: ClientScriptEntry;
@@ -91,7 +92,81 @@ interface DevToolsViewCustomRender extends DevToolsDockEntryBase {
   type: 'custom-render';
   renderer: ClientScriptEntry;
 }
-type DevToolsDockEntry = DevToolsViewIframe | DevToolsViewAction | DevToolsViewCustomRender;
+interface DevToolsViewBuiltin extends DevToolsDockEntryBase {
+  type: '~builtin';
+  id: '~terminals' | '~logs';
+}
+type DevToolsDockUserEntry = DevToolsViewIframe | DevToolsViewAction | DevToolsViewCustomRender | DevToolsViewLauncher;
+type DevToolsDockEntry = DevToolsDockUserEntry | DevToolsViewBuiltin;
+//#endregion
+//#region src/types/rpc-augments.d.ts
+/**
+ * To be extended
+ */
+interface DevToolsRpcClientFunctions {}
+/**
+ * To be extended
+ */
+interface DevToolsRpcServerFunctions {}
+//#endregion
+//#region src/types/terminals.d.ts
+interface DevToolsTerminalSessionStreamChunkEvent {
+  id: string;
+  chunks: string[];
+  ts: number;
+}
+interface DevToolsTerminalHost {
+  readonly sessions: Map<string, DevToolsTerminalSession>;
+  readonly events: EventEmitter<{
+    'terminal:session:updated': (session: DevToolsTerminalSession) => void;
+    'terminal:session:stream-chunk': (data: DevToolsTerminalSessionStreamChunkEvent) => void;
+  }>;
+  register: (session: DevToolsTerminalSession) => DevToolsTerminalSession;
+  update: (session: DevToolsTerminalSession) => void;
+  startChildProcess: (executeOptions: DevToolsChildProcessExecuteOptions, terminal: Omit<DevToolsTerminalSessionBase, 'status'>) => Promise<DevToolsChildProcessTerminalSession>;
+}
+type DevToolsTerminalStatus = 'running' | 'stopped' | 'error';
+interface DevToolsTerminalSessionBase {
+  id: string;
+  title: string;
+  description?: string;
+  status: DevToolsTerminalStatus;
+  icon?: DevToolsDockEntryIcon;
+}
+interface DevToolsTerminalSession extends DevToolsTerminalSessionBase {
+  buffer?: string[];
+  stream?: ReadableStream<string>;
+}
+interface DevToolsChildProcessExecuteOptions {
+  command: string;
+  args: string[];
+  cwd?: string;
+  env?: Record<string, string>;
+}
+interface DevToolsChildProcessTerminalSession extends DevToolsTerminalSession {
+  type: 'child-process';
+  executeOptions: DevToolsChildProcessExecuteOptions;
+  getChildProcess: () => ChildProcess | undefined;
+  terminate: () => Promise<void>;
+  restart: () => Promise<void>;
+}
+//#endregion
+//#region src/types/views.d.ts
+interface DevToolsViewHost {
+  /**
+   * @internal
+   */
+  buildStaticDirs: {
+    baseUrl: string;
+    distDir: string;
+  }[];
+  /**
+   * Helper to host static files
+   * - In `dev` mode, it will register middleware to `viteServer.middlewares` to host the static files
+   * - In `build` mode, it will copy the static files to the dist directory
+   */
+  hostStatic: (baseUrl: string, distDir: string) => void;
+}
 //#endregion
 //#region src/types/vite-plugin.d.ts
 interface DevToolsCapabilities {
@@ -114,6 +189,7 @@ interface DevToolsNodeContext {
   docks: DevToolsDockHost;
   views: DevToolsViewHost;
   utils: DevToolsNodeUtils;
+  terminals: DevToolsTerminalHost;
 }
 interface DevToolsNodeUtils {
   /**
@@ -137,6 +213,11 @@ type RpcFunctionsHost = RpcFunctionsCollectorBase<DevToolsRpcServerFunctions, De
 //#region src/types/utils.d.ts
 type Thenable<T> = T | Promise<T>;
 type EntriesToObject<T extends readonly [string, any][]> = { [K in T[number] as K[0]]: K[1] };
+type PartialWithoutId<T extends {
+  id: string;
+}> = Partial<Omit<T, 'id'>> & {
+  id: string;
+};
 //#endregion
 //#region src/types/vite-augment.d.ts
 declare module 'vite' {
@@ -185,7 +266,7 @@ interface DocksContext extends DevToolsClientContext {
    * Type of the client environment
    *
    * 'embedded' - running inside an embedded floating panel
-   * 'standalone' - running inside a standlone window (no user app)
+   * 'standalone' - running inside a standalone window (no user app)
    */
   readonly clientType: 'embedded' | 'standalone';
   /**
@@ -209,7 +290,8 @@ interface DocksPanelContext {
   readonly isVertical: boolean;
 }
 interface DocksEntriesContext {
-  selected: DevToolsDockEntry | null;
+  selectedId: string | null;
+  readonly selected: DevToolsDockEntry | null;
   entries: DevToolsDockEntry[];
   entryToStateMap: Map<string, DockEntryState>;
   /**
@@ -221,7 +303,7 @@ interface DocksEntriesContext {
    *
    * @returns Whether the selection was changed successfully
    */
-  switchEntry: (id: string | null) => Promise<boolean>;
+  switchEntry: (id?: string | null) => Promise<boolean>;
 }
 interface DockEntryState {
   entryMeta: DevToolsDockEntry;
@@ -230,12 +312,12 @@ interface DockEntryState {
     iframe?: HTMLIFrameElement | null;
     panel?: HTMLDivElement | null;
   };
-  events: Raw<Emitter<DockEntryStateEvents>>;
+  events: Raw<EventEmitter<DockEntryStateEvents>>;
 }
 interface DockEntryStateEvents {
   'entry:activated': () => void;
   'entry:deactivated': () => void;
-  'entry:updated': (newMeta: DevToolsDockEntry) => void;
+  'entry:updated': (newMeta: DevToolsDockUserEntry) => void;
   'dom:panel:mounted': (panel: HTMLDivElement) => void;
   'dom:iframe:mounted': (iframe: HTMLIFrameElement) => void;
 }
@@ -251,4 +333,4 @@ interface DockClientScriptContext extends DocksContext {
   current: DockEntryState;
 }
 //#endregion
-export { DevToolsDockHost as A, DevToolsNodeContext as C, DevToolsDockEntry as D, ClientScriptEntry as E, DevToolsRpcClientFunctions as F, DevToolsRpcServerFunctions as I, DevToolsViewCustomRender as M, DevToolsViewHost as N, DevToolsDockEntryBase as O, DevToolsViewIframe as P, DevToolsCapabilities as S, DevToolsPluginOptions as T, PluginWithDevTools as _, DockEntryState as a, RpcFunctionsHost as b, DocksContext as c, ClientRpcReturn as d, DevToolsRpcClient as f, RpcDefinitionsToFunctions as g, RpcDefinitionsFilter as h, DockClientType as i, DevToolsViewAction as j, DevToolsDockEntryCategory as k, DocksEntriesContext as l, getDevToolsRpcClient as m, DevToolsClientContext as n, DockEntryStateEvents as o, DevToolsRpcClientOptions as p, DevToolsClientRpcHost as r, DockPanelStorage as s, DockClientScriptContext as t, DocksPanelContext as u, EntriesToObject as v, DevToolsNodeUtils as w, ConnectionMeta as x, Thenable as y };
+export { DevToolsTerminalHost as A, DevToolsDockEntryCategory as B, DevToolsCapabilities as C, DevToolsViewHost as D, DevToolsPluginOptions as E, DevToolsRpcClientFunctions as F, DevToolsViewBuiltin as G, DevToolsDockHost as H, DevToolsRpcServerFunctions as I, DevToolsViewLauncher as J, DevToolsViewCustomRender as K, ClientScriptEntry as L, DevToolsTerminalSessionBase as M, DevToolsTerminalSessionStreamChunkEvent as N, DevToolsChildProcessExecuteOptions as O, DevToolsTerminalStatus as P, DevToolsDockEntry as R, ConnectionMeta as S, DevToolsNodeUtils as T, DevToolsDockUserEntry as U, DevToolsDockEntryIcon as V, DevToolsViewAction as W, DevToolsViewLauncherStatus as Y, PluginWithDevTools as _, DockEntryState as a, Thenable as b, DocksContext as c, ClientRpcReturn as d, DevToolsRpcClient as f, RpcDefinitionsToFunctions as g, RpcDefinitionsFilter as h, DockClientType as i, DevToolsTerminalSession as j, DevToolsChildProcessTerminalSession as k, DocksEntriesContext as l, getDevToolsRpcClient as m, DevToolsClientContext as n, DockEntryStateEvents as o, DevToolsRpcClientOptions as p, DevToolsViewIframe as q, DevToolsClientRpcHost as r, DockPanelStorage as s, DockClientScriptContext as t, DocksPanelContext as u, EntriesToObject as v, DevToolsNodeContext as w, RpcFunctionsHost as x, PartialWithoutId as y, DevToolsDockEntryBase as z };

package/dist/index.d.mts

@@ -1,7 +1,8 @@
-import { A as DevToolsDockHost, C as DevToolsNodeContext, D as DevToolsDockEntry, E as ClientScriptEntry, F as DevToolsRpcClientFunctions, I as DevToolsRpcServerFunctions, M as DevToolsViewCustomRender, N as DevToolsViewHost, O as DevToolsDockEntryBase, P as DevToolsViewIframe, S as DevToolsCapabilities, T as DevToolsPluginOptions, _ as PluginWithDevTools, b as RpcFunctionsHost, g as RpcDefinitionsToFunctions, h as RpcDefinitionsFilter, j as DevToolsViewAction, k as DevToolsDockEntryCategory, v as EntriesToObject, w as DevToolsNodeUtils, x as ConnectionMeta, y as Thenable } from "./index-C-bl_jKJ.mjs";
+import { n as EventUnsubscribe, r as EventsMap, t as EventEmitter } from "./events-DDdYnct9.mjs";
+import { A as DevToolsTerminalHost, B as DevToolsDockEntryCategory, C as DevToolsCapabilities, D as DevToolsViewHost, E as DevToolsPluginOptions, F as DevToolsRpcClientFunctions, G as DevToolsViewBuiltin, H as DevToolsDockHost, I as DevToolsRpcServerFunctions, J as DevToolsViewLauncher, K as DevToolsViewCustomRender, L as ClientScriptEntry, M as DevToolsTerminalSessionBase, N as DevToolsTerminalSessionStreamChunkEvent, O as DevToolsChildProcessExecuteOptions, P as DevToolsTerminalStatus, R as DevToolsDockEntry, S as ConnectionMeta, T as DevToolsNodeUtils, U as DevToolsDockUserEntry, V as DevToolsDockEntryIcon, W as DevToolsViewAction, Y as DevToolsViewLauncherStatus, _ as PluginWithDevTools, b as Thenable, g as RpcDefinitionsToFunctions, h as RpcDefinitionsFilter, j as DevToolsTerminalSession, k as DevToolsChildProcessTerminalSession, q as DevToolsViewIframe, v as EntriesToObject, w as DevToolsNodeContext, x as RpcFunctionsHost, y as PartialWithoutId, z as DevToolsDockEntryBase } from "./index-CgOheNVD.mjs";
 import * as birpc_x0 from "birpc-x";
 
-//#region src/utils/rpc.d.ts
+//#region src/utils/define.d.ts
 declare const defineRpcFunction: <NAME extends string, TYPE extends birpc_x0.RpcFunctionType, ARGS$1 extends any[], RETURN$1 = void>(definition: birpc_x0.RpcFunctionDefinition<NAME, TYPE, ARGS$1, RETURN$1, DevToolsNodeContext>) => birpc_x0.RpcFunctionDefinition<NAME, TYPE, ARGS$1, RETURN$1, DevToolsNodeContext>;
 //#endregion
-export { ClientScriptEntry, ConnectionMeta, DevToolsCapabilities, DevToolsDockEntry, DevToolsDockEntryBase, DevToolsDockEntryCategory, DevToolsDockHost, DevToolsNodeContext, DevToolsNodeUtils, DevToolsPluginOptions, DevToolsRpcClientFunctions, DevToolsRpcServerFunctions, DevToolsViewAction, DevToolsViewCustomRender, DevToolsViewHost, DevToolsViewIframe, EntriesToObject, PluginWithDevTools, RpcDefinitionsFilter, RpcDefinitionsToFunctions, RpcFunctionsHost, Thenable, defineRpcFunction };
+export { ClientScriptEntry, ConnectionMeta, DevToolsCapabilities, DevToolsChildProcessExecuteOptions, DevToolsChildProcessTerminalSession, DevToolsDockEntry, DevToolsDockEntryBase, DevToolsDockEntryCategory, DevToolsDockEntryIcon, DevToolsDockHost, DevToolsDockUserEntry, DevToolsNodeContext, DevToolsNodeUtils, DevToolsPluginOptions, DevToolsRpcClientFunctions, DevToolsRpcServerFunctions, DevToolsTerminalHost, DevToolsTerminalSession, DevToolsTerminalSessionBase, DevToolsTerminalSessionStreamChunkEvent, DevToolsTerminalStatus, DevToolsViewAction, DevToolsViewBuiltin, DevToolsViewCustomRender, DevToolsViewHost, DevToolsViewIframe, DevToolsViewLauncher, DevToolsViewLauncherStatus, EntriesToObject, EventEmitter, EventUnsubscribe, EventsMap, PartialWithoutId, PluginWithDevTools, RpcDefinitionsFilter, RpcDefinitionsToFunctions, RpcFunctionsHost, Thenable, defineRpcFunction };

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { createDefineWrapperWithContext } from "birpc-x";
 
-//#region src/utils/rpc.ts
+//#region src/utils/define.ts
 const defineRpcFunction = createDefineWrapperWithContext();
 
 //#endregion

package/dist/utils/events.d.mts

@@ -0,0 +1,10 @@
+import { r as EventsMap, t as EventEmitter } from "../events-DDdYnct9.mjs";
+
+//#region src/utils/events.d.ts
+
+/**
+ * Create event emitter.
+ */
+declare function createEventEmitter<Events extends EventsMap>(): EventEmitter<Events>;
+//#endregion
+export { createEventEmitter };

package/dist/utils/events.mjs

@@ -0,0 +1,26 @@
+//#region src/utils/events.ts
+/**
+* Create event emitter.
+*/
+function createEventEmitter() {
+	const _listeners = {};
+	return {
+		emit(event, ...args) {
+			const callbacks = _listeners[event] || [];
+			for (let i = 0, length = callbacks.length; i < length; i++) {
+				const callback = callbacks[i];
+				if (callback) callback(...args);
+			}
+		},
+		_listeners,
+		on(event, cb) {
+			(_listeners[event] ||= []).push(cb);
+			return () => {
+				_listeners[event] = _listeners[event]?.filter((i) => cb !== i);
+			};
+		}
+	};
+}
+
+//#endregion
+export { createEventEmitter };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitejs/devtools-kit",
   "type": "module",
-  "version": "0.0.0-alpha.17",
+  "version": "0.0.0-alpha.19",
   "description": "Vite DevTools Kit",
   "author": "VoidZero Inc.",
   "license": "MIT",
@@ -21,6 +21,7 @@
   "exports": {
     ".": "./dist/index.mjs",
     "./client": "./dist/client.mjs",
+    "./utils/events": "./dist/utils/events.mjs",
     "./package.json": "./package.json"
   },
   "main": "./dist/index.mjs",
@@ -35,8 +36,7 @@
   "dependencies": {
     "birpc": "^2.8.0",
     "birpc-x": "0.0.5",
-    "nanoevents": "^9.1.0",
-    "@vitejs/devtools-rpc": "0.0.0-alpha.17"
+    "@vitejs/devtools-rpc": "0.0.0-alpha.19"
   },
   "devDependencies": {
     "tsdown": "^0.16.1",