@vitejs/devtools-vite 0.0.0-alpha.16 → 0.0.0-alpha.18

package/dist/index.d.mts

@@ -1,10 +1,88 @@
-import { RpcFunctionsCollectorBase } from "birpc-x";
+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 { BirpcReturn } from "birpc";
 
+//#region ../kit/src/types/docks.d.ts
+interface DevToolsDockHost {
+  views: Map<string, DevToolsDockEntry>;
+  register: (entry: DevToolsDockEntry) => void;
+  update: (entry: DevToolsDockEntry) => void;
+  values: () => DevToolsDockEntry[];
+}
+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;
+}
+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;
+}
+type DevToolsDockEntry = DevToolsViewIframe | DevToolsViewAction | DevToolsViewCustomRender | DevToolsViewLauncher;
+//#endregion
 //#region ../kit/src/types/rpc-augments.d.ts
 /**
  * To be extended
@@ -28,27 +106,34 @@ interface DockPanelStorage {
   open: boolean;
   inactiveTimeout: number;
 }
-interface DocksContext {
+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 standlone window (no user app)
+   * 'standalone' - running inside a standalone window (no user app)
    */
   readonly clientType: 'embedded' | 'standalone';
-  /**
-   * The RPC client to interact with the server
-   */
-  readonly rpc: DevToolsRpcClient;
   /**
    * The panel context
    */
-  panel: DocksPanelContext;
+  readonly panel: DocksPanelContext;
   /**
    * The docks entries context
    */
-  docks: DocksEntriesContext;
+  readonly docks: DocksEntriesContext;
+  /**
+   * The client-side RPC functions to be called from the server
+   */
+  readonly clientRpc: DevToolsClientRpcHost;
 }
+type DevToolsClientRpcHost = RpcFunctionsCollector<DevToolsRpcClientFunctions, DevToolsClientContext>;
 interface DocksPanelContext {
   store: DockPanelStorage;
   isDragging: boolean;
@@ -56,7 +141,8 @@ interface DocksPanelContext {
   readonly isVertical: boolean;
 }
 interface DocksEntriesContext {
-  selected: DevToolsDockEntry | null;
+  selectedId: string | null;
+  readonly selected: DevToolsDockEntry | null;
   entries: DevToolsDockEntry[];
   entryToStateMap: Map<string, DockEntryState>;
   /**
@@ -99,12 +185,6 @@ interface DockClientScriptContext extends DocksContext {
 }
 //#endregion
 //#region ../kit/src/types/views.d.ts
-interface DevToolsDockHost {
-  views: Map<string, DevToolsDockEntry>;
-  register: (entry: DevToolsDockEntry) => void;
-  update: (entry: DevToolsDockEntry) => void;
-  values: () => DevToolsDockEntry[];
-}
 interface DevToolsViewHost {
   /**
    * @internal
@@ -120,61 +200,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 {
@@ -209,7 +234,9 @@ interface DevToolsNodeUtils {
 }
 //#endregion
 //#region ../kit/src/types/rpc.d.ts
-type RpcFunctionsHost = RpcFunctionsCollectorBase<DevToolsRpcServerFunctions, DevToolsNodeContext>;
+type RpcFunctionsHost = RpcFunctionsCollectorBase<DevToolsRpcServerFunctions, DevToolsNodeContext> & {
+  boardcast: BirpcGroup<DevToolsRpcClientFunctions, DevToolsRpcServerFunctions>['broadcast'];
+};
 //#endregion
 //#region ../kit/src/types/vite-augment.d.ts
 declare module 'vite' {