@vitejs/devtools-kit 0.0.0-alpha.16 → 0.0.0-alpha.18

package/dist/client.d.mts

@@ -1,2 +1,2 @@
-import { a as DockPanelStorage, c as DocksPanelContext, d as getDevToolsRpcClient, i as DockEntryStateEvents, l as DevToolsRpcClient, n as DockClientType, o as DocksContext, r as DockEntryState, s as DocksEntriesContext, t as DockClientScriptContext, u as DevToolsRpcClientOptions } from "./index-Bf_5llis.mjs";
-export { DevToolsRpcClient, DevToolsRpcClientOptions, DockClientScriptContext, DockClientType, DockEntryState, DockEntryStateEvents, DockPanelStorage, DocksContext, DocksEntriesContext, DocksPanelContext, getDevToolsRpcClient };
+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-C7lGA5jg.mjs";
+export { ClientRpcReturn, DevToolsClientContext, DevToolsClientRpcHost, DevToolsRpcClient, DevToolsRpcClientOptions, DockClientScriptContext, DockClientType, DockEntryState, DockEntryStateEvents, DockPanelStorage, DocksContext, DocksEntriesContext, DocksPanelContext, getDevToolsRpcClient };

package/dist/client.mjs

@@ -1,35 +1,54 @@
+import { RpcFunctionsCollectorBase } from "birpc-x";
 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 of urls) try {
-			connectionMeta = await fetch(`${url}.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 rpc = createRpcClient({}, {
+	const url = isNumeric(connectionMeta.websocket) ? `${location.protocol.replace("http", "ws")}//${location.hostname}:${connectionMeta.websocket}` : connectionMeta.websocket;
+	const context = { rpc: void 0 };
+	const clientRpc = new RpcFunctionsCollectorBase(context);
+	const rpc = createRpcClient(clientRpc.functions, {
 		preset: createWsRpcPreset({
-			url: isNumeric(connectionMeta.websocket) ? `${location.protocol.replace("http", "ws")}//${location.hostname}:${connectionMeta.websocket}` : connectionMeta.websocket,
+			url,
 			...options.wsOptions
 		}),
 		rpcOptions
 	});
+	context.rpc = rpc;
 	return {
 		connectionMeta,
-		rpc
+		rpc,
+		clientRpc
 	};
 }
 

package/dist/{index-Bf_5llis.d.mts → index-C7lGA5jg.d.mts}

@@ -1,54 +1,26 @@
-import { RpcFunctionsCollectorBase } from "birpc-x";
+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 { BirpcFn, BirpcOptions, BirpcReturn, BirpcReturn as BirpcReturn$1 } from "birpc";
 
-//#region src/types/rpc-augments.d.ts
-/**
- * To be extended
- */
-interface DevToolsRpcClientFunctions {}
-/**
- * To be extended
- */
-interface DevToolsRpcServerFunctions {}
-//#endregion
-//#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] };
-//#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;
-}
 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.
@@ -87,6 +59,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;
@@ -95,7 +81,34 @@ interface DevToolsViewCustomRender extends DevToolsDockEntryBase {
   type: 'custom-render';
   renderer: ClientScriptEntry;
 }
-type DevToolsDockEntry = DevToolsViewIframe | DevToolsViewAction | DevToolsViewCustomRender;
+type DevToolsDockEntry = DevToolsViewIframe | DevToolsViewAction | DevToolsViewCustomRender | DevToolsViewLauncher;
+//#endregion
+//#region src/types/rpc-augments.d.ts
+/**
+ * To be extended
+ */
+interface DevToolsRpcClientFunctions {}
+/**
+ * To be extended
+ */
+interface DevToolsRpcServerFunctions {}
+//#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 {
@@ -134,29 +147,13 @@ interface ConnectionMeta {
 }
 //#endregion
 //#region src/types/rpc.d.ts
-/**
- * Type of the RPC function,
- * - static: A function that returns a static data (can be cached and dumped)
- * - action: A function that performs an action (no data returned)
- * - query: A function that queries a resource
- */
-type RpcFunctionType = 'static' | 'action' | 'query';
-type RpcFunctionsHost = RpcFunctionsCollectorBase<DevToolsRpcServerFunctions, DevToolsNodeContext>;
-interface RpcFunctionSetupResult<ARGS extends any[], RETURN = void> {
-  handler: (...args: ARGS) => RETURN;
-}
-interface RpcFunctionDefinition<NAME extends string, TYPE extends RpcFunctionType, ARGS extends any[] = [], RETURN = void> {
-  name: NAME;
-  type: TYPE;
-  setup: (context: DevToolsNodeContext) => Thenable<RpcFunctionSetupResult<ARGS, RETURN>>;
-  handler?: (...args: ARGS) => RETURN;
-  __resolved?: RpcFunctionSetupResult<ARGS, RETURN>;
-  __promise?: Thenable<RpcFunctionSetupResult<ARGS, RETURN>>;
-}
-type RpcDefinitionsToFunctions<T extends readonly RpcFunctionDefinition<any, any, any>[]> = EntriesToObject<{ [K in keyof T]: [T[K]['name'], Awaited<ReturnType<T[K]['setup']>>['handler']] }>;
-type RpcDefinitionsFilter<T extends readonly RpcFunctionDefinition<any, any, any>[], Type extends RpcFunctionType> = { [K in keyof T]: T[K] extends {
-  type: Type;
-} ? T[K] : never };
+type RpcFunctionsHost = RpcFunctionsCollectorBase<DevToolsRpcServerFunctions, DevToolsNodeContext> & {
+  boardcast: BirpcGroup<DevToolsRpcClientFunctions, DevToolsRpcServerFunctions>['broadcast'];
+};
+//#endregion
+//#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] };
 //#endregion
 //#region src/types/vite-augment.d.ts
 declare module 'vite' {
@@ -176,10 +173,12 @@ interface DevToolsRpcClientOptions {
   rpcOptions?: Partial<BirpcOptions<DevToolsRpcServerFunctions>>;
 }
 type DevToolsRpcClient = BirpcReturn<DevToolsRpcServerFunctions, DevToolsRpcClientFunctions>;
-declare function getDevToolsRpcClient(options?: DevToolsRpcClientOptions): Promise<{
+interface ClientRpcReturn {
   connectionMeta: ConnectionMeta;
   rpc: DevToolsRpcClient;
-}>;
+  clientRpc: DevToolsClientRpcHost;
+}
+declare function getDevToolsRpcClient(options?: DevToolsRpcClientOptions): Promise<ClientRpcReturn>;
 //#endregion
 //#region src/client/docks.d.ts
 interface DockPanelStorage {
@@ -192,27 +191,34 @@ interface DockPanelStorage {
   inactiveTimeout: number;
 }
 type DockClientType = 'embedded' | 'standalone';
-interface DocksContext {
+interface DevToolsClientContext {
+  /**
+   * The RPC client to interact with the server
+   */
+  readonly rpc: DevToolsRpcClient;
+}
+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';
-  /**
-   * The RPC client to interact with the server
-   */
-  readonly rpc: DevToolsRpcClient;
   /**
    * The panel context
    */
-  panel: DocksPanelContext;
+  readonly panel: DocksPanelContext;
   /**
    * The docks entries context
    */
-  docks: DocksEntriesContext;
+  readonly docks: DocksEntriesContext;
+  /**
+   * The client-side RPC functions to be called from the server
+   */
+  readonly clientRpc: DevToolsClientRpcHost;
 }
+type DevToolsClientRpcHost = RpcFunctionsCollector<DevToolsRpcClientFunctions, DevToolsClientContext>;
 interface DocksPanelContext {
   store: DockPanelStorage;
   isDragging: boolean;
@@ -220,7 +226,8 @@ interface DocksPanelContext {
   readonly isVertical: boolean;
 }
 interface DocksEntriesContext {
-  selected: DevToolsDockEntry | null;
+  selectedId: string | null;
+  readonly selected: DevToolsDockEntry | null;
   entries: DevToolsDockEntry[];
   entryToStateMap: Map<string, DockEntryState>;
   /**
@@ -262,4 +269,4 @@ interface DockClientScriptContext extends DocksContext {
   current: DockEntryState;
 }
 //#endregion
-export { DevToolsDockHost as A, DevToolsNodeContext as C, DevToolsDockEntry as D, ClientScriptEntry as E, EntriesToObject as F, Thenable as I, DevToolsRpcClientFunctions as L, DevToolsViewCustomRender as M, DevToolsViewHost as N, DevToolsDockEntryBase as O, DevToolsViewIframe as P, DevToolsRpcServerFunctions as R, DevToolsCapabilities as S, DevToolsPluginOptions as T, RpcFunctionDefinition as _, DockPanelStorage as a, RpcFunctionsHost as b, DocksPanelContext as c, getDevToolsRpcClient as d, PluginWithDevTools as f, RpcDefinitionsToFunctions as g, RpcDefinitionsFilter as h, DockEntryStateEvents as i, DevToolsViewAction as j, DevToolsDockEntryCategory as k, DevToolsRpcClient as l, BirpcReturn$1 as m, DockClientType as n, DocksContext as o, BirpcFn as p, DockEntryState as r, DocksEntriesContext as s, DockClientScriptContext as t, DevToolsRpcClientOptions as u, RpcFunctionSetupResult as v, DevToolsNodeUtils as w, ConnectionMeta as x, RpcFunctionType as y };
+export { DevToolsDockEntry as A, DevToolsNodeContext as C, DevToolsRpcClientFunctions as D, DevToolsViewHost as E, DevToolsViewAction as F, DevToolsViewCustomRender as I, DevToolsViewIframe as L, DevToolsDockEntryCategory as M, DevToolsDockEntryIcon as N, DevToolsRpcServerFunctions as O, DevToolsDockHost as P, DevToolsViewLauncher as R, 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, DevToolsDockEntryBase as j, ClientScriptEntry 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, DevToolsViewLauncherStatus as z };

package/dist/index.d.mts

@@ -1,7 +1,7 @@
-import { A as DevToolsDockHost, C as DevToolsNodeContext, D as DevToolsDockEntry, E as ClientScriptEntry, F as EntriesToObject, I as Thenable, L as DevToolsRpcClientFunctions, M as DevToolsViewCustomRender, N as DevToolsViewHost, O as DevToolsDockEntryBase, P as DevToolsViewIframe, R as DevToolsRpcServerFunctions, S as DevToolsCapabilities, T as DevToolsPluginOptions, _ as RpcFunctionDefinition, b as RpcFunctionsHost, f as PluginWithDevTools, g as RpcDefinitionsToFunctions, h as RpcDefinitionsFilter, j as DevToolsViewAction, k as DevToolsDockEntryCategory, m as BirpcReturn, p as BirpcFn, v as RpcFunctionSetupResult, w as DevToolsNodeUtils, x as ConnectionMeta, y as RpcFunctionType } from "./index-Bf_5llis.mjs";
+import { A as DevToolsDockEntry, C as DevToolsNodeContext, D as DevToolsRpcClientFunctions, E as DevToolsViewHost, F as DevToolsViewAction, I as DevToolsViewCustomRender, L as DevToolsViewIframe, M as DevToolsDockEntryCategory, N as DevToolsDockEntryIcon, O as DevToolsRpcServerFunctions, P as DevToolsDockHost, R as DevToolsViewLauncher, S as DevToolsCapabilities, T as DevToolsPluginOptions, _ as PluginWithDevTools, b as RpcFunctionsHost, g as RpcDefinitionsToFunctions, h as RpcDefinitionsFilter, j as DevToolsDockEntryBase, k as ClientScriptEntry, v as EntriesToObject, w as DevToolsNodeUtils, x as ConnectionMeta, y as Thenable, z as DevToolsViewLauncherStatus } from "./index-C7lGA5jg.mjs";
 import * as birpc_x0 from "birpc-x";
 
 //#region src/utils/rpc.d.ts
-declare const defineRpcFunction: <NAME extends string, TYPE extends birpc_x0.RpcFunctionType, ARGS extends any[], RETURN = void>(definition: birpc_x0.RpcFunctionDefinition<NAME, TYPE, ARGS, RETURN, DevToolsNodeContext>) => birpc_x0.RpcFunctionDefinition<NAME, TYPE, ARGS, RETURN, DevToolsNodeContext>;
+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 { BirpcFn, BirpcReturn, ClientScriptEntry, ConnectionMeta, DevToolsCapabilities, DevToolsDockEntry, DevToolsDockEntryBase, DevToolsDockEntryCategory, DevToolsDockHost, DevToolsNodeContext, DevToolsNodeUtils, DevToolsPluginOptions, DevToolsRpcClientFunctions, DevToolsRpcServerFunctions, DevToolsViewAction, DevToolsViewCustomRender, DevToolsViewHost, DevToolsViewIframe, EntriesToObject, PluginWithDevTools, RpcDefinitionsFilter, RpcDefinitionsToFunctions, RpcFunctionDefinition, RpcFunctionSetupResult, RpcFunctionType, RpcFunctionsHost, Thenable, defineRpcFunction };
+export { ClientScriptEntry, ConnectionMeta, DevToolsCapabilities, DevToolsDockEntry, DevToolsDockEntryBase, DevToolsDockEntryCategory, DevToolsDockEntryIcon, DevToolsDockHost, DevToolsNodeContext, DevToolsNodeUtils, DevToolsPluginOptions, DevToolsRpcClientFunctions, DevToolsRpcServerFunctions, DevToolsViewAction, DevToolsViewCustomRender, DevToolsViewHost, DevToolsViewIframe, DevToolsViewLauncher, DevToolsViewLauncherStatus, EntriesToObject, PluginWithDevTools, RpcDefinitionsFilter, RpcDefinitionsToFunctions, RpcFunctionsHost, Thenable, defineRpcFunction };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitejs/devtools-kit",
   "type": "module",
-  "version": "0.0.0-alpha.16",
+  "version": "0.0.0-alpha.18",
   "description": "Vite DevTools Kit",
   "author": "VoidZero Inc.",
   "license": "MIT",
@@ -33,10 +33,10 @@
     "vite": "*"
   },
   "dependencies": {
-    "birpc": "^2.7.0",
-    "birpc-x": "0.0.1",
+    "birpc": "^2.8.0",
+    "birpc-x": "0.0.5",
     "nanoevents": "^9.1.0",
-    "@vitejs/devtools-rpc": "0.0.0-alpha.16"
+    "@vitejs/devtools-rpc": "0.0.0-alpha.18"
   },
   "devDependencies": {
     "tsdown": "^0.16.1",