@vitejs/devtools 0.0.0-alpha.1 → 0.0.0-alpha.11

package/dist/index-DdVYVGyC.d.ts

@@ -0,0 +1,153 @@
+import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
+
+//#region ../kit/src/types/rpc-augments.d.ts
+
+/**
+ * To be extended
+ */
+interface DevToolsRpcServerFunctions {}
+//#endregion
+//#region ../kit/src/types/utils.d.ts
+type Thenable<T> = T | Promise<T>;
+type EntriesToObject<T extends readonly [string, any][]> = { [K in T[number] as K[0]]: K[1] };
+//#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
+   */
+  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;
+}
+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 {
+  rpc?: boolean;
+  views?: boolean;
+}
+interface DevToolsPluginOptions {
+  capabilities?: {
+    dev?: DevToolsCapabilities | boolean;
+    build?: DevToolsCapabilities | boolean;
+  };
+  setup: (context: DevToolsNodeContext) => void | Promise<void>;
+}
+interface DevToolsNodeContext {
+  readonly cwd: string;
+  readonly mode: 'dev' | 'build';
+  readonly viteConfig: ResolvedConfig;
+  readonly viteServer?: ViteDevServer;
+  rpc: RpcFunctionsHost;
+  docks: DevToolsDockHost;
+  views: DevToolsViewHost;
+  utils: DevToolsNodeUtils;
+}
+interface DevToolsNodeUtils {
+  clientEntryFromSimpleFunction: (fn: () => void) => ClientScriptEntry;
+}
+//#endregion
+//#region ../kit/src/types/rpc.d.ts
+/**
+ * Type of the RPC function,
+ * - static: A function that returns a static data (can be cached and dumped)
+ * - action: A function that performs an action (no data returned)
+ * - query: A function that queries a resource
+ */
+type RpcFunctionType = 'static' | 'action' | 'query';
+interface RpcFunctionsHost {
+  context: DevToolsNodeContext;
+  readonly functions: DevToolsRpcServerFunctions;
+  readonly definitions: Map<string, RpcFunctionDefinition<string, any, any, any>>;
+  register: (fn: RpcFunctionDefinition<string, any, any, any>) => void;
+  update: (fn: RpcFunctionDefinition<string, any, any, any>) => void;
+}
+interface RpcFunctionSetupResult<ARGS extends any[], RETURN = void> {
+  handler: (...args: ARGS) => RETURN;
+}
+interface RpcFunctionDefinition<NAME extends string, TYPE extends RpcFunctionType, ARGS extends any[] = [], RETURN = void> {
+  name: NAME;
+  type: TYPE;
+  setup: (context: DevToolsNodeContext) => Thenable<RpcFunctionSetupResult<ARGS, RETURN>>;
+  handler?: (...args: ARGS) => RETURN;
+  __resolved?: RpcFunctionSetupResult<ARGS, RETURN>;
+  __promise?: Thenable<RpcFunctionSetupResult<ARGS, RETURN>>;
+}
+type RpcDefinitionsToFunctions<T extends readonly RpcFunctionDefinition<any, any, any>[]> = EntriesToObject<{ [K in keyof T]: [T[K]['name'], Awaited<ReturnType<T[K]['setup']>>['handler']] }>;
+//#endregion
+//#region ../kit/src/types/vite-augment.d.ts
+declare module 'vite' {
+  interface Plugin {
+    devtools?: DevToolsPluginOptions;
+  }
+}
+//#endregion
+export { DevToolsDockEntry as i, RpcFunctionDefinition as n, DevToolsNodeContext as r, RpcDefinitionsToFunctions as t };

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+import { i as DevToolsDockEntry, n as RpcFunctionDefinition, r as DevToolsNodeContext, t as RpcDefinitionsToFunctions } from "./index-DdVYVGyC.js";
+import { Plugin, ResolvedConfig, ViteDevServer } from "vite";
+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/index.d.ts
+declare const builtinRpcFunctions: readonly [RpcFunctionDefinition<"vite:core:list-rpc-functions", "action", [], Promise<{
+  [k: string]: {
+    type: any;
+  };
+}>>, RpcFunctionDefinition<"vite:core:list-dock-entries", "query", [], DevToolsDockEntry[]>, RpcFunctionDefinition<"vite:core:open-in-editor", "action", [path: string], Promise<void>>, RpcFunctionDefinition<"vite:core:open-in-finder", "action", [path: string], Promise<void>>];
+type ServerFunctions = RpcDefinitionsToFunctions<typeof builtinRpcFunctions>;
+declare module '@vitejs/devtools-kit' {
+  interface DevToolsRpcServerFunctions extends ServerFunctions {}
+}
+//#endregion
+//#region src/node/plugins/index.d.ts
+interface DevToolsOptions {
+  /**
+   * Include the Vite builtin devtools UI.
+   *
+   * @default true
+   */
+  builtinDevTools?: boolean;
+}
+declare function DevTools(options?: DevToolsOptions): Promise<Plugin[]>;
+//#endregion
+//#region src/node/ws.d.ts
+interface CreateWsServerOptions {
+  cwd: string;
+  portWebSocket?: number;
+  base?: string;
+  context: DevToolsNodeContext;
+}
+//#endregion
+//#region src/node/server.d.ts
+declare function createDevToolsMiddleware(options: CreateWsServerOptions): Promise<{
+  h3: h30.App;
+  middleware: h30.NodeListener;
+  rpc: birpc0.BirpcGroup<any, any>;
+}>;
+//#endregion
+export { DevTools, createDevToolsContext, createDevToolsMiddleware };

package/dist/index.js

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