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

package/dist/index.d.mts

@@ -1,10 +1,148 @@
 import { BirpcGroup, BirpcReturn } from "birpc";
 import { RpcFunctionsCollector, RpcFunctionsCollectorBase } from "birpc-x";
 import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
-import { Emitter } from "nanoevents";
 import { Raw } from "vue";
 import "@vitejs/devtools-rpc/presets/ws/client";
+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>(this: this, 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>(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: 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';
+}
+type DevToolsDockUserEntry = DevToolsViewIframe | DevToolsViewAction | DevToolsViewCustomRender | DevToolsViewLauncher;
+type DevToolsDockEntry = DevToolsDockUserEntry | DevToolsViewBuiltin;
+//#endregion
 //#region ../kit/src/types/rpc-augments.d.ts
 /**
  * To be extended
@@ -39,7 +177,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';
   /**
@@ -63,7 +201,8 @@ interface DocksPanelContext {
   readonly isVertical: boolean;
 }
 interface DocksEntriesContext {
-  selected: DevToolsDockEntry | null;
+  selectedId: string | null;
+  readonly selected: DevToolsDockEntry | null;
   entries: DevToolsDockEntry[];
   entryToStateMap: Map<string, DockEntryState>;
   /**
@@ -75,7 +214,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;
@@ -84,12 +223,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;
 }
@@ -105,13 +244,49 @@ interface DockClientScriptContext extends DocksContext {
   current: DockEntryState;
 }
 //#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/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
@@ -127,61 +302,6 @@ interface DevToolsViewHost {
    */
   hostStatic: (baseUrl: string, distDir: string) => void;
 }
-type DevToolsDockEntryCategory = 'app' | 'framework' | 'web' | 'advanced' | 'default';
-interface DevToolsDockEntryBase {
-  id: string;
-  title: string;
-  icon: string | {
-    light: string;
-    dark: string;
-  };
-  /**
-   * 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;
-}
-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;
-}
-interface DevToolsViewAction extends DevToolsDockEntryBase {
-  type: 'action';
-  action: ClientScriptEntry;
-}
-interface DevToolsViewCustomRender extends DevToolsDockEntryBase {
-  type: 'custom-render';
-  renderer: ClientScriptEntry;
-}
-type DevToolsDockEntry = DevToolsViewIframe | DevToolsViewAction | DevToolsViewCustomRender;
 //#endregion
 //#region ../kit/src/types/vite-plugin.d.ts
 interface DevToolsCapabilities {
@@ -204,6 +324,7 @@ interface DevToolsNodeContext {
   docks: DevToolsDockHost;
   views: DevToolsViewHost;
   utils: DevToolsNodeUtils;
+  terminals: DevToolsTerminalHost;
 }
 interface DevToolsNodeUtils {
   /**