@vitejs/devtools-rpc 0.0.0-alpha.20 → 0.0.0-alpha.21

package/dist/client-C3McYp9c.d.mts

@@ -0,0 +1,13 @@
+import { RpcClientPreset } from "./presets/index.mjs";
+import { ChannelOptions } from "birpc";
+
+//#region src/presets/ws/client.d.ts
+interface WebSocketRpcClientOptions {
+  url: string;
+  onConnected?: (e: Event) => void;
+  onError?: (e: Error) => void;
+  onDisconnected?: (e: CloseEvent) => void;
+}
+declare const createWsRpcPreset: RpcClientPreset<(options: WebSocketRpcClientOptions) => ChannelOptions>;
+//#endregion
+export { createWsRpcPreset as n, WebSocketRpcClientOptions as t };

package/dist/presets/ws/client.d.mts

@@ -1,13 +1,3 @@
-import { RpcClientPreset } from "../index.mjs";
-import { ChannelOptions } from "birpc";
-
-//#region src/presets/ws/client.d.ts
-interface WebSocketRpcClientOptions {
-  url: string;
-  onConnected?: (e: Event) => void;
-  onError?: (e: Error) => void;
-  onDisconnected?: (e: CloseEvent) => void;
-}
-declare const createWsRpcPreset: RpcClientPreset<(options: WebSocketRpcClientOptions) => ChannelOptions>;
-//#endregion
+import "../index.mjs";
+import { n as createWsRpcPreset, t as WebSocketRpcClientOptions } from "../../client-C3McYp9c.mjs";
 export { WebSocketRpcClientOptions, createWsRpcPreset };

package/dist/presets/ws/server.d.mts

@@ -1,12 +1,502 @@
 import { RpcServerPreset } from "../index.mjs";
-import { BirpcGroup, BirpcOptions } from "birpc";
+import { BirpcGroup, BirpcOptions, BirpcReturn } from "birpc";
+import { RpcFunctionsCollector, RpcFunctionsCollectorBase } from "birpc-x";
 import { WebSocket } from "ws";
+import { ResolvedConfig, ViteDevServer } from "vite";
+import { Raw } from "vue";
+import { ChildProcess } from "node:child_process";
 
+//#region ../kit/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>(event: K, ...args: Parameters<Events[K]>) => void;
+  /**
+   * Calls the listeners for a given event once and then removes the listener.
+   *
+   * @param event The event name.
+   * @param args The arguments for listeners.
+   */
+  emitOnce: <K extends keyof Events>(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>(event: K, cb: Events[K]) => EventUnsubscribe;
+  /**
+   * Add a listener for a given event once.
+   *
+   * ```js
+   * const unbind = ee.once('tick', (tickType, tickDuration) => {
+   *   count += 1
+   * })
+   *
+   * disable () {
+   *   unbind()
+   * }
+   * ```
+   *
+   * @param event The event name.
+   * @param cb The listener function.
+   * @returns Unbind listener from event.
+   */
+  once: <K extends keyof Events>(event: K, cb: Events[K]) => EventUnsubscribe;
+}
+//#endregion
+//#region ../kit/src/types/docks.d.ts
+interface DevToolsDockHost {
+  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: DevToolsDockEntryIcon;
+  /**
+   * The default order of the entry in the dock.
+   * The higher the number the earlier it appears.
+   * @default 0
+   */
+  defaultOrder?: number;
+  /**
+   * The category of the entry
+   * @default 'default'
+   */
+  category?: DevToolsDockEntryCategory;
+  /**
+   * Whether the entry should be hidden from the user.
+   * @default false
+   */
+  isHidden?: boolean;
+}
+interface ClientScriptEntry {
+  /**
+   * The filepath or module name to import from
+   */
+  importFrom: string;
+  /**
+   * The name to import the module as
+   *
+   * @default 'default'
+   */
+  importName?: string;
+}
+interface DevToolsViewIframe extends DevToolsDockEntryBase {
+  type: 'iframe';
+  url: string;
+  /**
+   * The id of the iframe, if multiple tabs is assigned with the same id, the iframe will be shared.
+   *
+   * When not provided, it would be treated as a unique frame.
+   */
+  frameId?: string;
+  /**
+   * Optional client script to import into the iframe
+   */
+  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;
+}
+interface DevToolsViewCustomRender extends DevToolsDockEntryBase {
+  type: 'custom-render';
+  renderer: ClientScriptEntry;
+}
+interface DevToolsViewBuiltin extends DevToolsDockEntryBase {
+  type: '~builtin';
+  id: '~terminals' | '~logs' | '~client-auth-notice';
+}
+type DevToolsDockUserEntry = DevToolsViewIframe | DevToolsViewAction | DevToolsViewCustomRender | DevToolsViewLauncher;
+type DevToolsDockEntry = DevToolsDockUserEntry | DevToolsViewBuiltin;
+//#endregion
+//#region ../kit/src/types/rpc-augments.d.ts
+/**
+ * To be extended
+ */
+interface DevToolsRpcClientFunctions {}
+/**
+ * To be extended
+ */
+interface DevToolsRpcServerFunctions {}
+//#endregion
+//#region ../kit/src/client/rpc.d.ts
+interface DevToolsRpcClient {
+  /**
+   * The events of the client
+   */
+  events: EventEmitter<RpcClientEvents>;
+  /**
+   * Whether the client is trusted
+   */
+  readonly isTrusted: boolean | null;
+  /**
+   * The connection meta
+   */
+  readonly connectionMeta: ConnectionMeta;
+  /**
+   * Return a promise that resolves when the client is trusted
+   *
+   * Rejects with an error if the timeout is reached
+   *
+   * @param timeout - The timeout in milliseconds, default to 60 seconds
+   */
+  ensureTrusted: (timeout?: number) => Promise<boolean>;
+  /**
+   * Request trust from the server
+   */
+  requestTrust: () => Promise<boolean>;
+  /**
+   * Call a RPC function on the server
+   */
+  call: BirpcReturn<DevToolsRpcServerFunctions, DevToolsRpcClientFunctions>['$call'];
+  /**
+   * Call a RPC event on the server, and does not expect a response
+   */
+  callEvent: BirpcReturn<DevToolsRpcServerFunctions, DevToolsRpcClientFunctions>['$callEvent'];
+  /**
+   * Call a RPC optional function on the server
+   */
+  callOptional: BirpcReturn<DevToolsRpcServerFunctions, DevToolsRpcClientFunctions>['$callOptional'];
+  /**
+   * The client RPC host
+   */
+  client: DevToolsClientRpcHost;
+}
+//#endregion
+//#region ../kit/src/client/docks.d.ts
+interface DockPanelStorage {
+  width: number;
+  height: number;
+  top: number;
+  left: number;
+  position: 'left' | 'right' | 'bottom' | 'top';
+  open: boolean;
+  inactiveTimeout: number;
+}
+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 standalone window (no user app)
+   */
+  readonly clientType: 'embedded' | 'standalone';
+  /**
+   * The panel context
+   */
+  readonly panel: DocksPanelContext;
+  /**
+   * The docks entries context
+   */
+  readonly docks: DocksEntriesContext;
+}
+type DevToolsClientRpcHost = RpcFunctionsCollector<DevToolsRpcClientFunctions, DevToolsClientContext>;
+interface DocksPanelContext {
+  store: DockPanelStorage;
+  isDragging: boolean;
+  isResizing: boolean;
+  readonly isVertical: boolean;
+}
+interface DocksEntriesContext {
+  selectedId: string | null;
+  readonly 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>;
+  /**
+   * Toggle the selected dock entry
+   *
+   * @returns Whether the selection was changed successfully
+   */
+  toggleEntry: (id: string) => Promise<boolean>;
+}
+interface DockEntryState {
+  entryMeta: DevToolsDockEntry;
+  readonly isActive: boolean;
+  domElements: {
+    iframe?: HTMLIFrameElement | null;
+    panel?: HTMLDivElement | null;
+  };
+  events: Raw<EventEmitter<DockEntryStateEvents>>;
+}
+interface DockEntryStateEvents {
+  'entry:activated': () => void;
+  'entry:deactivated': () => void;
+  'entry:updated': (newMeta: DevToolsDockUserEntry) => void;
+  'dom:panel:mounted': (panel: HTMLDivElement) => void;
+  'dom:iframe:mounted': (iframe: HTMLIFrameElement) => void;
+}
+interface RpcClientEvents {
+  'rpc:is-trusted:updated': (isTrusted: boolean) => void;
+}
+//#endregion
+//#region ../kit/src/client/client-script.d.ts
+/**
+ * Context for client scripts running in dock entries
+ */
+interface DockClientScriptContext extends DocksContext {
+  /**
+   * The state of the current dock entry
+   */
+  current: DockEntryState;
+}
+//#endregion
+//#region ../kit/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 ../kit/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 ../kit/src/types/vite-plugin.d.ts
+interface DevToolsCapabilities {
+  rpc?: boolean;
+  views?: boolean;
+}
+interface DevToolsPluginOptions {
+  capabilities?: {
+    dev?: DevToolsCapabilities | boolean;
+    build?: DevToolsCapabilities | boolean;
+  };
+  setup: (context: DevToolsNodeContext) => void | Promise<void>;
+}
+interface DevToolsNodeContext {
+  /**
+   * Workspace root directory of Vite DevTools
+   */
+  readonly workspaceRoot: string;
+  /**
+   * Current working directory of Vite DevTools
+   */
+  readonly cwd: string;
+  /**
+   * Current mode of Vite DevTools
+   * - 'dev' - when Vite DevTools is running in dev mode
+   * - 'build' - when Vite DevTools is running in build mode (no server)
+   */
+  readonly mode: 'dev' | 'build';
+  /**
+   * Resolved Vite configuration
+   */
+  readonly viteConfig: ResolvedConfig;
+  /**
+   * Vite dev server instance (only available in dev mode)
+   */
+  readonly viteServer?: ViteDevServer;
+  /**
+   * RPC functions host, for registering server-side RPC functions and calling client-side RPC functions
+   */
+  rpc: RpcFunctionsHost;
+  /**
+   * Docks host, for registering dock entries
+   */
+  docks: DevToolsDockHost;
+  /**
+   * Views host, for registering static views
+   */
+  views: DevToolsViewHost;
+  /**
+   * Utils for the node context
+   */
+  utils: DevToolsNodeUtils;
+  /**
+   * Terminals host, for registering terminal sessions and streaming terminal output
+   */
+  terminals: DevToolsTerminalHost;
+}
+interface DevToolsNodeUtils {
+  /**
+   * 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';
+  websocket?: number | string;
+}
+//#endregion
+//#region ../kit/src/types/rpc.d.ts
+interface DevToolsNodeRpcSessionMeta {
+  id: number;
+  ws?: WebSocket;
+  clientAuthId?: string;
+  isTrusted?: boolean;
+}
+interface DevToolsNodeRpcSession {
+  meta: DevToolsNodeRpcSessionMeta;
+  rpc: BirpcReturn<DevToolsRpcClientFunctions, DevToolsRpcServerFunctions, false>;
+}
+type RpcFunctionsHost = RpcFunctionsCollectorBase<DevToolsRpcServerFunctions, DevToolsNodeContext> & {
+  /**
+   * Broadcast a message to all connected clients
+   */
+  broadcast: <T extends keyof DevToolsRpcClientFunctions, Args extends Parameters<DevToolsRpcClientFunctions[T]>>(name: T, ...args: Args) => Promise<(Awaited<ReturnType<DevToolsRpcClientFunctions[T]>> | undefined)[]>;
+  /**
+   * Get the current RPC client
+   *
+   * Available in RPC functions to get the current RPC client
+   */
+  getCurrentRpcSession: () => DevToolsNodeRpcSession | undefined;
+};
+//#endregion
+//#region ../kit/src/types/vite-augment.d.ts
+declare module 'vite' {
+  interface Plugin {
+    devtools?: DevToolsPluginOptions;
+  }
+  interface UserConfig {
+    devtools?: ViteConfigDevtoolsOptions;
+  }
+}
+interface ViteConfigDevtoolsOptions {
+  /**
+   * Disable client authentication.
+   *
+   * Beware that if you disable client authentication,
+   * any browsers can connect to the devtools and access to your server and filesystem.
+   * (including other devices, if you open server `host` option to LAN or WAN)
+   *
+   * @default true
+   */
+  clientAuth?: boolean;
+}
+//#endregion
 //#region src/presets/ws/server.d.ts
 interface WebSocketRpcServerOptions {
   port: number;
-  onConnected?: (ws: WebSocket) => void;
-  onDisconnected?: (ws: WebSocket) => void;
+  host?: string;
+  onConnected?: (ws: WebSocket, meta: DevToolsNodeRpcSessionMeta) => void;
+  onDisconnected?: (ws: WebSocket, meta: DevToolsNodeRpcSessionMeta) => void;
 }
 declare const createWsRpcPreset: RpcServerPreset<(options: WebSocketRpcServerOptions) => <ClientFunctions extends object, ServerFunctions extends object>(rpc: BirpcGroup<ClientFunctions, ServerFunctions, false>, options?: Pick<BirpcOptions<ClientFunctions, ServerFunctions, false>, 'serialize' | 'deserialize'>) => void>;
 //#endregion

package/dist/presets/ws/server.mjs

@@ -3549,13 +3549,21 @@ var import_websocket_server = /* @__PURE__ */ __toESM(require_websocket_server()
 
 //#endregion
 //#region src/presets/ws/server.ts
+let id = 0;
 function NOOP() {}
 const createWsRpcPreset = defineRpcServerPreset((options) => {
-	const { port, onConnected = NOOP, onDisconnected = NOOP } = options;
-	const wss = new import_websocket_server.default({ port });
+	const { port, host = "localhost", onConnected = NOOP, onDisconnected = NOOP } = options;
+	const wss = new import_websocket_server.default({
+		port,
+		host
+	});
 	return (rpc, options$1) => {
 		const { serialize = stringify, deserialize = parse } = options$1 ?? {};
 		wss.on("connection", (ws) => {
+			const meta = {
+				id: id++,
+				ws
+			};
 			const channel = {
 				post: (data) => {
 					ws.send(data);
@@ -3566,7 +3574,8 @@ const createWsRpcPreset = defineRpcServerPreset((options) => {
 					});
 				},
 				serialize,
-				deserialize
+				deserialize,
+				meta
 			};
 			rpc.updateChannels((channels) => {
 				channels.push(channel);
@@ -3576,9 +3585,9 @@ const createWsRpcPreset = defineRpcServerPreset((options) => {
 					const index = channels.indexOf(channel);
 					if (index >= 0) channels.splice(index, 1);
 				});
-				onDisconnected(ws);
+				onDisconnected(ws, meta);
 			});
-			onConnected(ws);
+			onConnected(ws, meta);
 		});
 	};
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vitejs/devtools-rpc",
   "type": "module",
-  "version": "0.0.0-alpha.20",
+  "version": "0.0.0-alpha.21",
   "description": "DevTools rpc for Vite (work in progress)",
   "author": "VoidZero Inc.",
   "license": "MIT",
@@ -41,7 +41,7 @@
     "structured-clone-es": "^1.0.0"
   },
   "devDependencies": {
-    "tsdown": "^0.17.4",
+    "tsdown": "^0.18.2",
     "ws": "^8.18.3"
   },
   "scripts": {