@vitejs/devtools 0.0.0-alpha.17 → 0.0.0-alpha.19

package/dist/{index-DFE-IX9X.d.ts → index-Wdefo_Ne.d.ts}

@@ -1,50 +1,76 @@
 import { RpcDefinitionsToFunctions, RpcFunctionsCollector, RpcFunctionsCollectorBase } from "birpc-x";
 import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
-import { Emitter } from "nanoevents";
 import { Raw } from "vue";
 import { BirpcGroup, BirpcReturn } from "birpc";
+import { ChildProcess } from "node:child_process";
 import "@vitejs/devtools-rpc/presets/ws/client";
 
-//#region ../kit/src/types/rpc-augments.d.ts
-/**
- * To be extended
- */
-interface DevToolsRpcClientFunctions {}
-/**
- * To be extended
- */
-interface DevToolsRpcServerFunctions {}
-//#endregion
-//#region ../kit/src/types/views.d.ts
-interface DevToolsDockHost {
-  views: Map<string, DevToolsDockEntry>;
-  register: (entry: DevToolsDockEntry) => void;
-  update: (entry: DevToolsDockEntry) => void;
-  values: () => DevToolsDockEntry[];
+//#region ../kit/src/types/events.d.ts
+interface EventsMap {
+  [event: string]: any;
 }
-interface DevToolsViewHost {
+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>(this: this, event: K, ...args: Parameters<Events[K]>) => void;
   /**
+   * Event names in keys and arrays with listeners in values.
+   *
    * @internal
    */
-  buildStaticDirs: {
-    baseUrl: string;
-    distDir: string;
-  }[];
+  _listeners: Partial<{ [E in keyof Events]: Events[E][] }>;
   /**
-   * 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
+   * 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.
    */
-  hostStatic: (baseUrl: string, distDir: string) => void;
+  on: <K extends keyof Events>(this: this, 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: string | {
-    light: string;
-    dark: string;
-  };
+  icon: DevToolsDockEntryIcon;
   /**
    * The default order of the entry in the dock.
    * The higher the number the earlier it appears.
@@ -56,6 +82,11 @@ interface DevToolsDockEntryBase {
    * @default 'default'
    */
   category?: DevToolsDockEntryCategory;
+  /**
+   * Whether the entry should be hidden from the user.
+   * @default false
+   */
+  isHidden?: boolean;
 }
 interface ClientScriptEntry {
   /**
@@ -83,6 +114,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;
@@ -91,7 +136,81 @@ interface DevToolsViewCustomRender extends DevToolsDockEntryBase {
   type: 'custom-render';
   renderer: ClientScriptEntry;
 }
-type DevToolsDockEntry = DevToolsViewIframe | DevToolsViewAction | DevToolsViewCustomRender;
+interface DevToolsViewBuiltin extends DevToolsDockEntryBase {
+  type: '~builtin';
+  id: '~terminals' | '~logs';
+}
+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/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 {
@@ -114,6 +233,7 @@ interface DevToolsNodeContext {
   docks: DevToolsDockHost;
   views: DevToolsViewHost;
   utils: DevToolsNodeUtils;
+  terminals: DevToolsTerminalHost;
 }
 interface DevToolsNodeUtils {
   /**
@@ -170,7 +290,7 @@ 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';
   /**
@@ -194,7 +314,8 @@ interface DocksPanelContext {
   readonly isVertical: boolean;
 }
 interface DocksEntriesContext {
-  selected: DevToolsDockEntry | null;
+  selectedId: string | null;
+  readonly selected: DevToolsDockEntry | null;
   entries: DevToolsDockEntry[];
   entryToStateMap: Map<string, DockEntryState>;
   /**
@@ -206,7 +327,7 @@ interface DocksEntriesContext {
    *
    * @returns Whether the selection was changed successfully
    */
-  switchEntry: (id: string | null) => Promise<boolean>;
+  switchEntry: (id?: string | null) => Promise<boolean>;
 }
 interface DockEntryState {
   entryMeta: DevToolsDockEntry;
@@ -215,12 +336,12 @@ interface DockEntryState {
     iframe?: HTMLIFrameElement | null;
     panel?: HTMLDivElement | null;
   };
-  events: Raw<Emitter<DockEntryStateEvents>>;
+  events: Raw<EventEmitter<DockEntryStateEvents>>;
 }
 interface DockEntryStateEvents {
   'entry:activated': () => void;
   'entry:deactivated': () => void;
-  'entry:updated': (newMeta: DevToolsDockEntry) => void;
+  'entry:updated': (newMeta: DevToolsDockUserEntry) => void;
   'dom:panel:mounted': (panel: HTMLDivElement) => void;
   'dom:iframe:mounted': (iframe: HTMLIFrameElement) => void;
 }
@@ -236,4 +357,4 @@ interface DockClientScriptContext extends DocksContext {
   current: DockEntryState;
 }
 //#endregion
-export { DevToolsNodeContext as a, DevToolsRpcServerFunctions as c, RpcDefinitionsToFunctions as i, DocksContext as n, DevToolsDockEntry as o, ClientRpcReturn as r, DevToolsRpcClientFunctions as s, DockPanelStorage as t };
+export { RpcDefinitionsToFunctions as a, DevToolsTerminalSessionBase as c, DevToolsRpcServerFunctions as d, DevToolsDockEntry as f, ClientRpcReturn as i, DevToolsTerminalSessionStreamChunkEvent as l, DockPanelStorage as n, ConnectionMeta as o, DocksContext as r, DevToolsNodeContext as s, DockEntryState as t, DevToolsRpcClientFunctions as u };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { a as DevToolsNodeContext, c as DevToolsRpcServerFunctions, i as RpcDefinitionsToFunctions, o as DevToolsDockEntry, s as DevToolsRpcClientFunctions } from "./index-DFE-IX9X.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-Wdefo_Ne.js";
 import * as birpc_x0 from "birpc-x";
 import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
 import * as birpc0 from "birpc";
@@ -8,16 +8,21 @@ import * as h30 from "h3";
 declare function createDevToolsContext(viteConfig: ResolvedConfig, viteServer?: ViteDevServer): Promise<DevToolsNodeContext>;
 //#endregion
 //#region src/node/rpc/index.d.ts
-declare const builtinRpcFunctions: readonly [birpc_x0.RpcFunctionDefinition<"vite:core:list-rpc-functions", "action", [], 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: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;
   };
-}>, DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:core:list-dock-entries", "query", [], DevToolsDockEntry[], DevToolsNodeContext>, 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>];
-type ServerFunctions = RpcDefinitionsToFunctions<typeof builtinRpcFunctions>;
+}>, DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:internal:terminals:list", "static", [], Promise<DevToolsTerminalSessionBase[]>, DevToolsNodeContext>, birpc_x0.RpcFunctionDefinition<"vite:internal:terminals:read", "query", [id: string], Promise<{
+  buffer: string[];
+  ts: number;
+}>, DevToolsNodeContext>];
+type BuiltinServerFunctions = RpcDefinitionsToFunctions<typeof builtinRpcDecalrations>;
 declare module '@vitejs/devtools-kit' {
-  interface DevToolsRpcServerFunctions extends ServerFunctions {}
+  interface DevToolsRpcServerFunctions extends BuiltinServerFunctions {}
   interface DevToolsRpcClientFunctions {
-    'vite:core:list-dock-entries:updated': () => Promise<void>;
+    'vite:internal:docks:updated': () => Promise<void>;
+    'vite:internal:terminals:stream-chunk': (data: DevToolsTerminalSessionStreamChunkEvent) => Promise<void>;
+    'vite:internal:terminals:updated': () => Promise<void>;
   }
 }
 //#endregion
@@ -43,8 +48,9 @@ interface CreateWsServerOptions {
 //#region src/node/server.d.ts
 declare function createDevToolsMiddleware(options: CreateWsServerOptions): Promise<{
   h3: h30.App;
-  middleware: h30.NodeListener;
   rpc: birpc0.BirpcGroup<DevToolsRpcClientFunctions, DevToolsRpcServerFunctions>;
+  middleware: h30.NodeListener;
+  getConnectionMeta: () => Promise<ConnectionMeta>;
 }>;
 //#endregion
 export { DevTools, createDevToolsContext, createDevToolsMiddleware };

package/dist/index.js

@@ -1,4 +1,4 @@
-import { d as createDevToolsContext, n as createDevToolsMiddleware, t as DevTools } from "./plugins-B_YgEdT2.js";
+import { d as createDevToolsContext, n as createDevToolsMiddleware, t as DevTools } from "./plugins-l6D28NJB.js";
 import "./dirs-DcSK9l9L.js";
 
 export { DevTools, createDevToolsContext, createDevToolsMiddleware };