@vitejs/devtools-vite 0.0.0-alpha.20 → 0.0.0-alpha.22

package/dist/index.d.mts

@@ -1,7 +1,9 @@
+import { BirpcReturn } from "birpc";
+import { WebSocket } from "ws";
 import { RpcFunctionsCollector, RpcFunctionsCollectorBase } from "birpc-x";
+import { Patch } from "immer";
 import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
 import { Raw } from "vue";
-import { BirpcReturn } from "birpc";
 import { ChildProcess } from "node:child_process";
 
 //#region ../kit/src/types/events.d.ts
@@ -22,14 +24,14 @@ interface EventEmitter<Events extends EventsMap> {
    * @param event The event name.
    * @param args The arguments for listeners.
    */
-  emit: <K extends keyof Events>(event: K, ...args: Parameters<Events[K]>) => void;
+  emit: <K$1 extends keyof Events>(event: K$1, ...args: Parameters<Events[K$1]>) => 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;
+  emitOnce: <K$1 extends keyof Events>(event: K$1, ...args: Parameters<Events[K$1]>) => void;
   /**
    * Event names in keys and arrays with listeners in values.
    *
@@ -53,7 +55,7 @@ interface EventEmitter<Events extends EventsMap> {
    * @param cb The listener function.
    * @returns Unbind listener from event.
    */
-  on: <K extends keyof Events>(event: K, cb: Events[K]) => EventUnsubscribe;
+  on: <K$1 extends keyof Events>(event: K$1, cb: Events[K$1]) => EventUnsubscribe;
   /**
    * Add a listener for a given event once.
    *
@@ -71,7 +73,7 @@ interface EventEmitter<Events extends EventsMap> {
    * @param cb The listener function.
    * @returns Unbind listener from event.
    */
-  once: <K extends keyof Events>(event: K, cb: Events[K]) => EventUnsubscribe;
+  once: <K$1 extends keyof Events>(event: K$1, cb: Events[K$1]) => EventUnsubscribe;
 }
 //#endregion
 //#region ../kit/src/types/docks.d.ts
@@ -162,11 +164,55 @@ 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;
 //#endregion
+//#region ../rpc/src/presets/ws/server.d.ts
+interface DevToolsNodeRpcSessionMeta {
+  id: number;
+  ws?: WebSocket;
+  clientAuthId?: string;
+  isTrusted?: boolean;
+}
+//#endregion
+//#region ../kit/src/utils/shared-state.d.ts
+type ImmutablePrimitive = undefined | null | boolean | string | number | Function;
+type Immutable<T> = T extends ImmutablePrimitive ? T : T extends Array<infer U> ? ImmutableArray<U> : T extends Map<infer K, infer V> ? ImmutableMap<K, V> : T extends Set<infer M> ? ImmutableSet<M> : ImmutableObject<T>;
+type ImmutableArray<T> = ReadonlyArray<Immutable<T>>;
+type ImmutableMap<K$1, V$1> = ReadonlyMap<Immutable<K$1>, Immutable<V$1>>;
+type ImmutableSet<T> = ReadonlySet<Immutable<T>>;
+type ImmutableObject<T> = { readonly [K in keyof T]: Immutable<T[K]> };
+/**
+ * State host that is immutable by default with explicit mutate.
+ */
+interface SharedState<T> {
+  /**
+   * Get the current state. Immutable.
+   */
+  value: () => Immutable<T>;
+  /**
+   * Subscribe to state changes.
+   */
+  on: EventEmitter<SharedStateEvents<T>>['on'];
+  /**
+   * Mutate the state.
+   */
+  mutate: (fn: (state: T) => void, syncId?: string) => void;
+  /**
+   * Apply patches to the state.
+   */
+  patch: (patches: Patch[], syncId?: string) => void;
+  /**
+   * Sync IDs that have been applied to the state.
+   */
+  syncIds: Set<string>;
+}
+interface SharedStateEvents<T> {
+  updated: (fullState: T, patches: Patch[] | undefined, syncId: string) => void;
+}
+//#endregion
 //#region ../kit/src/types/rpc-augments.d.ts
 /**
  * To be extended
@@ -176,6 +222,10 @@ interface DevToolsRpcClientFunctions {}
  * To be extended
  */
 interface DevToolsRpcServerFunctions {}
+/**
+ * To be extended
+ */
+interface DevToolsRpcSharedStates {}
 //#endregion
 //#region ../kit/src/client/rpc.d.ts
 interface DevToolsRpcClient {
@@ -183,10 +233,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
    */
@@ -203,6 +269,10 @@ interface DevToolsRpcClient {
    * The client RPC host
    */
   client: DevToolsClientRpcHost;
+  /**
+   * The shared state host
+   */
+  sharedState: RpcSharedStateHost;
 }
 //#endregion
 //#region ../kit/src/client/docks.d.ts
@@ -260,6 +330,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;
@@ -277,7 +353,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
 /**
@@ -362,14 +440,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 {
@@ -387,15 +498,60 @@ interface ConnectionMeta {
 }
 //#endregion
 //#region ../kit/src/types/rpc.d.ts
+interface DevToolsNodeRpcSession {
+  meta: DevToolsNodeRpcSessionMeta;
+  rpc: BirpcReturn<DevToolsRpcClientFunctions, DevToolsRpcServerFunctions, false>;
+}
+interface RpcBroadcastOptions<METHOD, Args extends any[]> {
+  method: METHOD;
+  args: Args;
+  optional?: boolean;
+  event?: boolean;
+  filter?: (client: BirpcReturn<DevToolsRpcClientFunctions, DevToolsRpcServerFunctions, false>) => boolean | void;
+}
 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]>>(options: RpcBroadcastOptions<T, Args>) => Promise<void>;
+  /**
+   * Get the current RPC client
+   *
+   * Available in RPC functions to get the current RPC client
+   */
+  getCurrentRpcSession: () => DevToolsNodeRpcSession | undefined;
+  /**
+   * The shared state host
+   */
+  sharedState: RpcSharedStateHost;
 };
+interface RpcSharedStateGetOptions<T> {
+  initialValue?: T;
+}
+interface RpcSharedStateHost {
+  get: <T extends keyof DevToolsRpcSharedStates>(key: T, options?: RpcSharedStateGetOptions<DevToolsRpcSharedStates[T]>) => Promise<SharedState<DevToolsRpcSharedStates[T]>>;
+}
 //#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;
 }
 interface PluginWithDevTools extends Plugin {
   devtools?: DevToolsPluginOptions;