@vitejs/devtools-kit 0.0.0-alpha.12 → 0.0.0-alpha.14

package/dist/client.d.ts

@@ -1,45 +1,2 @@
-import { D as DevToolsRpcServerFunctions, E as DevToolsRpcClientFunctions, g as DevToolsDockEntry, u as ConnectionMeta } from "./index-CQIA5hSl.js";
-import { WebSocketRpcClientOptions } from "@vitejs/devtools-rpc/presets/ws/client";
-import { BirpcOptions, BirpcReturn } from "birpc";
-
-//#region src/client/index.d.ts
-interface DevToolsRpcClientOptions {
-  connectionMeta?: ConnectionMeta;
-  baseURL?: string[];
-  wsOptions?: Partial<WebSocketRpcClientOptions>;
-  rpcOptions?: Partial<BirpcOptions<DevToolsRpcServerFunctions>>;
-}
-/**
- * Context for client scripts running in dock entries
- */
-interface DockClientScriptContext {
-  /**
-   * The dock entry info of the current dock item
-   */
-  dockEntry: DevToolsDockEntry;
-  /**
-   * The current state of the dock
-   */
-  dockState: 'active' | 'inactive';
-  /**
-   * Type of the client environment
-   *
-   * 'embedded' - running inside an embedded floating panel
-   * 'standalone' - running inside a standlone window (no user app)
-   */
-  clientType: 'embedded' | 'standalone';
-  /**
-   * Function to hide the panel, if applicable
-   */
-  hidePanel: () => void;
-  /**
-   * The panel element to mount into, if applicable
-   */
-  elPanel?: HTMLElement | null;
-}
-declare function getDevToolsRpcClient(options?: DevToolsRpcClientOptions): Promise<{
-  connectionMeta: ConnectionMeta;
-  rpc: BirpcReturn<DevToolsRpcServerFunctions, DevToolsRpcClientFunctions>;
-}>;
-//#endregion
-export { DevToolsRpcClientOptions, DockClientScriptContext, getDevToolsRpcClient };
+import { a as DockPanelStorage, c as DocksPanelContext, d as getDevToolsRpcClient, i as DockEntryState, l as DevToolsRpcClient, n as DockClientScriptCurrent, o as DocksContext, r as DockClientType, s as DocksEntriesContext, t as DockClientScriptContext, u as DevToolsRpcClientOptions } from "./index-6FiVMI6v.js";
+export { DevToolsRpcClient, DevToolsRpcClientOptions, DockClientScriptContext, DockClientScriptCurrent, DockClientType, DockEntryState, DockPanelStorage, DocksContext, DocksEntriesContext, DocksPanelContext, getDevToolsRpcClient };

package/dist/client.js

@@ -1,7 +1,7 @@
 import { createRpcClient } from "@vitejs/devtools-rpc";
 import { createWsRpcPreset } from "@vitejs/devtools-rpc/presets/ws/client";
 
-//#region src/client/index.ts
+//#region src/client/rpc.ts
 function isNumeric(str) {
 	if (str == null) return false;
 	return `${+str}` === `${str}`;

package/dist/{index-CQIA5hSl.d.ts → index-6FiVMI6v.d.ts}

@@ -1,5 +1,7 @@
-import { BirpcFn, BirpcReturn as BirpcReturn$1 } from "birpc";
+import { RpcFunctionsCollectorBase } from "birpc-x";
+import { WebSocketRpcClientOptions } from "@vitejs/devtools-rpc/presets/ws/client";
 import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
+import { BirpcFn, BirpcOptions, BirpcReturn, BirpcReturn as BirpcReturn$1 } from "birpc";
 
 //#region src/types/rpc-augments.d.ts
 /**
@@ -116,7 +118,13 @@ interface DevToolsNodeContext {
   utils: DevToolsNodeUtils;
 }
 interface DevToolsNodeUtils {
-  clientEntryFromSimpleFunction: (fn: () => void) => ClientScriptEntry;
+  /**
+   * Create a simple client script from a function or stringified code
+   *
+   * @deprecated DO NOT USE. This is mostly for testing only. Please use a proper importable module instead.
+   * @experimental
+   */
+  createSimpleClientScript: (fn: string | ((ctx: DockClientScriptContext) => void)) => ClientScriptEntry;
 }
 interface ConnectionMeta {
   backend: 'websocket' | 'static';
@@ -131,13 +139,7 @@ interface ConnectionMeta {
  * - query: A function that queries a resource
  */
 type RpcFunctionType = 'static' | 'action' | 'query';
-interface RpcFunctionsHost {
-  context: DevToolsNodeContext;
-  readonly functions: DevToolsRpcServerFunctions;
-  readonly definitions: Map<string, RpcFunctionDefinition<string, any, any, any>>;
-  register: (fn: RpcFunctionDefinition<string, any, any, any>) => void;
-  update: (fn: RpcFunctionDefinition<string, any, any, any>) => void;
-}
+type RpcFunctionsHost = RpcFunctionsCollectorBase<DevToolsRpcServerFunctions, DevToolsNodeContext>;
 interface RpcFunctionSetupResult<ARGS extends any[], RETURN = void> {
   handler: (...args: ARGS) => RETURN;
 }
@@ -164,4 +166,112 @@ interface PluginWithDevTools extends Plugin {
   devtools?: DevToolsPluginOptions;
 }
 //#endregion
-export { DevToolsViewIframe as C, DevToolsRpcServerFunctions as D, DevToolsRpcClientFunctions as E, DevToolsViewHost as S, Thenable as T, DevToolsDockEntryBase as _, RpcDefinitionsToFunctions as a, DevToolsViewAction as b, RpcFunctionType as c, DevToolsCapabilities as d, DevToolsNodeContext as f, DevToolsDockEntry as g, ClientScriptEntry as h, RpcDefinitionsFilter as i, RpcFunctionsHost as l, DevToolsPluginOptions as m, BirpcFn as n, RpcFunctionDefinition as o, DevToolsNodeUtils as p, BirpcReturn$1 as r, RpcFunctionSetupResult as s, PluginWithDevTools as t, ConnectionMeta as u, DevToolsDockEntryCategory as v, EntriesToObject as w, DevToolsViewCustomRender as x, DevToolsDockHost as y };
+//#region src/client/rpc.d.ts
+interface DevToolsRpcClientOptions {
+  connectionMeta?: ConnectionMeta;
+  baseURL?: string[];
+  wsOptions?: Partial<WebSocketRpcClientOptions>;
+  rpcOptions?: Partial<BirpcOptions<DevToolsRpcServerFunctions>>;
+}
+type DevToolsRpcClient = BirpcReturn<DevToolsRpcServerFunctions, DevToolsRpcClientFunctions>;
+declare function getDevToolsRpcClient(options?: DevToolsRpcClientOptions): Promise<{
+  connectionMeta: ConnectionMeta;
+  rpc: DevToolsRpcClient;
+}>;
+//#endregion
+//#region src/client/docks.d.ts
+interface DockPanelStorage {
+  width: number;
+  height: number;
+  top: number;
+  left: number;
+  position: 'left' | 'right' | 'bottom' | 'top';
+  open: boolean;
+  inactiveTimeout: number;
+}
+type DockClientType = 'embedded' | 'standalone';
+interface DocksContext {
+  /**
+   * Type of the client environment
+   *
+   * 'embedded' - running inside an embedded floating panel
+   * 'standalone' - running inside a standlone window (no user app)
+   */
+  readonly clientType: 'embedded' | 'standalone';
+  /**
+   * The RPC client to interact with the server
+   */
+  readonly rpc: DevToolsRpcClient;
+  /**
+   * The panel context
+   */
+  panel: DocksPanelContext;
+  /**
+   * The docks entries context
+   */
+  docks: DocksEntriesContext;
+}
+interface DocksPanelContext {
+  store: DockPanelStorage;
+  isDragging: boolean;
+  isResizing: boolean;
+  readonly isVertical: boolean;
+}
+interface DocksEntriesContext {
+  selected: DevToolsDockEntry | null;
+  entries: DevToolsDockEntry[];
+  entryToStateMap: Map<string, DockEntryState>;
+  /**
+   * Get the state of a dock entry by its ID
+   */
+  getStateById: (id: string) => DockEntryState | undefined;
+  /**
+   * Switch to the selected dock entry, pass `null` to clear the selection
+   *
+   * @returns Whether the selection was changed successfully
+   */
+  switchEntry: (id: string | null) => Promise<boolean>;
+}
+interface DockEntryState {
+  entryMeta: DevToolsDockEntry;
+  readonly isActive: boolean;
+  domElements: {
+    iframe?: HTMLIFrameElement | null;
+    panel?: HTMLDivElement | null;
+  };
+}
+//#endregion
+//#region src/client/client-script.d.ts
+/**
+ * Context for client scripts running in dock entries
+ */
+interface DockClientScriptContext extends DocksContext {
+  /**
+   * The state if the current dock entry
+   */
+  current: DockEntryState;
+}
+interface DockClientScriptCurrent {
+  /**
+   * The dock entry info of the current dock item
+   */
+  entryMeta: DevToolsDockEntry;
+  /**
+   * The current state of the dock
+   */
+  state: 'active' | 'inactive';
+  /**
+   * The panel element to mount into, when the entry type is `custom-render`
+   */
+  elPanel?: HTMLDivElement | null;
+  /**
+   * The iframe element to mount into, when the entry type is `iframe`
+   */
+  elIframe?: HTMLIFrameElement | null;
+  /**
+   * The dock icon element
+   */
+  elDockIcon?: HTMLDivElement | null;
+}
+//#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, DockEntryState as i, DevToolsViewAction as j, DevToolsDockEntryCategory as k, DevToolsRpcClient as l, BirpcReturn$1 as m, DockClientScriptCurrent as n, DocksContext as o, BirpcFn as p, DockClientType as r, DocksEntriesContext as s, DockClientScriptContext as t, DevToolsRpcClientOptions as u, RpcFunctionSetupResult as v, DevToolsNodeUtils as w, ConnectionMeta as x, RpcFunctionType as y };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { C as DevToolsViewIframe, D as DevToolsRpcServerFunctions, E as DevToolsRpcClientFunctions, S as DevToolsViewHost, T as Thenable, _ as DevToolsDockEntryBase, a as RpcDefinitionsToFunctions, b as DevToolsViewAction, c as RpcFunctionType, d as DevToolsCapabilities, f as DevToolsNodeContext, g as DevToolsDockEntry, h as ClientScriptEntry, i as RpcDefinitionsFilter, l as RpcFunctionsHost, m as DevToolsPluginOptions, n as BirpcFn, o as RpcFunctionDefinition, p as DevToolsNodeUtils, r as BirpcReturn, s as RpcFunctionSetupResult, t as PluginWithDevTools, u as ConnectionMeta, v as DevToolsDockEntryCategory, w as EntriesToObject, x as DevToolsViewCustomRender, y as DevToolsDockHost } from "./index-CQIA5hSl.js";
+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-6FiVMI6v.js";
+import * as birpc_x0 from "birpc-x";
 
 //#region src/utils/rpc.d.ts
-declare function defineRpcFunction<NAME extends string, TYPE extends RpcFunctionType, ARGS extends any[], RETURN = void>(definition: RpcFunctionDefinition<NAME, TYPE, ARGS, RETURN>): RpcFunctionDefinition<NAME, TYPE, ARGS, RETURN>;
-declare function getRpcHandler<NAME extends string, TYPE extends RpcFunctionType, ARGS extends any[], RETURN = void>(definition: RpcFunctionDefinition<NAME, TYPE, ARGS, RETURN>, context: DevToolsNodeContext): Promise<(...args: ARGS) => RETURN>;
+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>;
 //#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, getRpcHandler };
+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 };

package/dist/index.js

@@ -1,17 +1,7 @@
+import { createDefineWrapperWithContext } from "birpc-x";
+
 //#region src/utils/rpc.ts
-function defineRpcFunction(definition) {
-	return definition;
-}
-async function getRpcHandler(definition, context) {
-	if (definition.handler) return definition.handler;
-	if (definition.__resolved?.handler) return definition.__resolved.handler;
-	definition.__promise ??= Promise.resolve(definition.setup(context)).then((r) => {
-		definition.__resolved = r;
-		definition.__promise = void 0;
-		return r;
-	});
-	return (definition.__resolved ??= await definition.__promise).handler;
-}
+const defineRpcFunction = createDefineWrapperWithContext();
 
 //#endregion
-export { defineRpcFunction, getRpcHandler };
+export { defineRpcFunction };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitejs/devtools-kit",
   "type": "module",
-  "version": "0.0.0-alpha.12",
+  "version": "0.0.0-alpha.14",
   "description": "Vite DevTools Kit",
   "author": "VoidZero Inc.",
   "license": "MIT",
@@ -33,12 +33,13 @@
     "vite": "*"
   },
   "dependencies": {
-    "birpc": "^2.6.1",
-    "@vitejs/devtools-rpc": "0.0.0-alpha.12"
+    "birpc": "^2.7.0",
+    "birpc-x": "0.0.1",
+    "@vitejs/devtools-rpc": "0.0.0-alpha.14"
   },
   "devDependencies": {
     "tsdown": "^0.15.12",
-    "vite": "npm:rolldown-vite@^7.1.20"
+    "vite": "npm:rolldown-vite@^7.2.2"
   },
   "scripts": {
     "build": "tsdown",