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

package/dist/{index-C5iw-7QZ.d.ts → index-CWvzFILY.d.ts}

@@ -1,8 +1,9 @@
-import { RpcDefinitionsToFunctions, RpcFunctionsCollector, RpcFunctionsCollectorBase } from "birpc-x";
 import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
+import { RpcDefinitionsToFunctions, RpcFunctionsCollector, RpcFunctionsCollectorBase } from "birpc-x";
 import { Raw } from "vue";
-import { ChildProcess } from "node:child_process";
 import { BirpcReturn } from "birpc";
+import { WebSocket } from "ws";
+import { ChildProcess } from "node:child_process";
 
 //#region ../kit/src/types/events.d.ts
 interface EventsMap {
@@ -162,7 +163,7 @@ interface DevToolsViewCustomRender extends DevToolsDockEntryBase {
 }
 interface DevToolsViewBuiltin extends DevToolsDockEntryBase {
   type: '~builtin';
-  id: '~terminals' | '~logs';
+  id: '~terminals' | '~logs' | '~client-auth-notice';
 }
 type DevToolsDockUserEntry = DevToolsViewIframe | DevToolsViewAction | DevToolsViewCustomRender | DevToolsViewLauncher;
 type DevToolsDockEntry = DevToolsDockUserEntry | DevToolsViewBuiltin;
@@ -249,14 +250,47 @@ interface DevToolsPluginOptions {
   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 {
@@ -274,8 +308,27 @@ interface ConnectionMeta {
 }
 //#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> & {
-  boardcast: <T extends keyof DevToolsRpcClientFunctions, Args extends Parameters<DevToolsRpcClientFunctions[T]>>(name: T, ...args: Args) => Promise<(Awaited<ReturnType<DevToolsRpcClientFunctions[T]>> | undefined)[]>;
+  /**
+   * 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
@@ -283,6 +336,21 @@ 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 ../kit/src/client/rpc.d.ts
@@ -291,10 +359,26 @@ 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
    */
@@ -368,6 +452,12 @@ interface DocksEntriesContext {
    * @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;
@@ -385,7 +475,9 @@ interface DockEntryStateEvents {
   'dom:panel:mounted': (panel: HTMLDivElement) => void;
   'dom:iframe:mounted': (iframe: HTMLIFrameElement) => void;
 }
-interface RpcClientEvents {}
+interface RpcClientEvents {
+  'rpc:is-trusted:updated': (isTrusted: boolean) => void;
+}
 //#endregion
 //#region ../kit/src/client/client-script.d.ts
 /**

package/dist/index.d.ts

@@ -1,15 +1,26 @@
-import { a as RpcDefinitionsToFunctions, c as DevToolsTerminalSessionBase, d as DevToolsRpcServerFunctions, f as DevToolsDockEntry, l as DevToolsTerminalSessionStreamChunkEvent, o as ConnectionMeta, s as DevToolsNodeContext, u as DevToolsRpcClientFunctions } from "./index-C5iw-7QZ.js";
+import { a as RpcDefinitionsToFunctions, c as DevToolsTerminalSessionBase, d as DevToolsRpcServerFunctions, f as DevToolsDockEntry, l as DevToolsTerminalSessionStreamChunkEvent, o as ConnectionMeta, s as DevToolsNodeContext, u as DevToolsRpcClientFunctions } from "./index-CWvzFILY.js";
+import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
 import * as birpc_x0 from "birpc-x";
 import { RpcFunctionsCollectorBase } from "birpc-x";
-import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
+import { AsyncLocalStorage } from "node:async_hooks";
 import * as birpc0 from "birpc";
 import * as h30 from "h3";
 
 //#region src/node/context.d.ts
 declare function createDevToolsContext(viteConfig: ResolvedConfig, viteServer?: ViteDevServer): Promise<DevToolsNodeContext>;
 //#endregion
+//#region src/node/rpc/anonymous/auth.d.ts
+interface DevToolsAuthInput {
+  authId: string;
+  ua: string;
+  origin: string;
+}
+interface DevToolsAuthReturn {
+  isTrusted: boolean;
+}
+//#endregion
 //#region src/node/rpc/index.d.ts
-declare const builtinRpcDecalrations: readonly [birpc_x0.RpcFunctionDefinition<"vite:core:open-in-editor", "action", [path: string], Promise<void>, DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:core:open-in-finder", "action", [path: string], Promise<void>, DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:internal:docks:list", "static", [], DevToolsDockEntry[], DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:internal:docks:on-launch", "action", [entryId: string], Promise<void>, DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:internal:rpc:server:list", "static", [], Promise<{
+declare const builtinRpcDecalrations: readonly [birpc_x0.RpcFunctionDefinition<"vite:core:open-in-editor", "action", [path: string], Promise<void>, DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:core:open-in-finder", "action", [path: string], Promise<void>, DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:anonymous:auth", "action", [query: DevToolsAuthInput], Promise<DevToolsAuthReturn>, DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:internal:docks:list", "static", [], DevToolsDockEntry[], DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:internal:docks:on-launch", "action", [entryId: string], Promise<void>, DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:internal:rpc:server:list", "static", [], Promise<{
   [k: string]: {
     type: any;
   };
@@ -42,6 +53,7 @@ declare function DevTools(options?: DevToolsOptions): Promise<Plugin[]>;
 interface CreateWsServerOptions {
   cwd: string;
   portWebSocket?: number;
+  hostWebSocket: string;
   base?: string;
   context: DevToolsNodeContext;
 }

package/dist/index.js

@@ -1,3 +1,3 @@
-import { d as createDevToolsContext, n as createDevToolsMiddleware, t as DevTools } from "./plugins-DfJlAQ2j.js";
+import { n as createDevToolsMiddleware, t as DevTools, u as createDevToolsContext } from "./plugins-Chcj6ENu.js";
 
 export { DevTools, createDevToolsContext, createDevToolsMiddleware };