@vitejs/devtools-kit 0.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present, VoidZero Inc. and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/client.d.ts

@@ -0,0 +1,17 @@
+import { ConnectionMeta, DevToolsRpcClientFunctions, DevToolsRpcServerFunctions } from "./rpc-ls6mUIa2.js";
+import { WebSocketRpcClientOptions } from "@vitejs/devtools-rpc/presets/ws/client";
+import { BirpcOptions, BirpcReturn } from "birpc";
+
+//#region src/client/index.d.ts
+interface DevToolsRpcClientOptions {
+  connectionMeta?: ConnectionMeta;
+  baseURL?: string[];
+  wsOptions?: Partial<WebSocketRpcClientOptions>;
+  rpcOptions?: Partial<BirpcOptions<DevToolsRpcServerFunctions>>;
+}
+declare function getDevToolsRpcClient(options?: DevToolsRpcClientOptions): Promise<{
+  connectionMeta: ConnectionMeta;
+  rpc: BirpcReturn<DevToolsRpcServerFunctions, DevToolsRpcClientFunctions>;
+}>;
+//#endregion
+export { DevToolsRpcClientOptions, getDevToolsRpcClient };

package/dist/client.js

@@ -0,0 +1,38 @@
+import { createRpcClient } from "@vitejs/devtools-rpc";
+import { createWsRpcPreset } from "@vitejs/devtools-rpc/presets/ws/client";
+
+//#region src/client/index.ts
+function isNumeric(str) {
+	if (str == null) return false;
+	return `${+str}` === `${str}`;
+}
+async function getDevToolsRpcClient(options = {}) {
+	const { baseURL = "/__vite_devtools__/api/" } = options;
+	const urls = Array.isArray(baseURL) ? baseURL : [baseURL];
+	let connectionMeta = options.connectionMeta;
+	if (!connectionMeta) {
+		const errors = [];
+		for (const url$1 of urls) try {
+			connectionMeta = await fetch(`${url$1}connection.json`).then((r) => r.json());
+			break;
+		} catch (e) {
+			errors.push(e);
+		}
+		if (!connectionMeta) throw new Error(`Failed to get connection meta from ${urls.join(", ")}`, { cause: errors });
+	}
+	const url = isNumeric(connectionMeta.websocket) ? `${location.protocol.replace("http", "ws")}//${location.hostname}:${connectionMeta.websocket}` : connectionMeta.websocket;
+	const rpc = createRpcClient({}, {
+		preset: createWsRpcPreset({
+			url,
+			...options.wsOptions
+		}),
+		...options.rpcOptions
+	});
+	return {
+		connectionMeta,
+		rpc
+	};
+}
+
+//#endregion
+export { getDevToolsRpcClient };

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { BirpcFn, BirpcReturn, ConnectionMeta, DevToolsCapabilities, DevToolsDockEntry, DevToolsDockEntryBase, DevToolsDockHost, DevToolsNodeContext, DevToolsPluginOptions, DevToolsRpcClientFunctions, DevToolsRpcServerFunctions, DevToolsViewAction, DevToolsViewIframe, DevToolsViewWebComponent, EntriesToObject, RpcDefinitionsFilter, RpcDefinitionsToFunctions, RpcFunctionDefinition, RpcFunctionSetupResult, RpcFunctionType, RpcFunctionsHost, Thenable } from "./rpc-ls6mUIa2.js";
+import { Plugin } from "vite";
+
+//#region src/types/vite-augment.d.ts
+declare module 'vite' {
+  interface Plugin {
+    devtools?: DevToolsPluginOptions;
+  }
+}
+interface PluginWithDevTools extends Plugin {
+  devtools?: DevToolsPluginOptions;
+}
+//#endregion
+//#region src/utils/rpc.d.ts
+declare function defineRpcFunction<NAME extends string, TYPE extends RpcFunctionType, ARGS extends any[], RETURN = void>(definition: RpcFunctionDefinition<NAME, TYPE, ARGS, RETURN>): RpcFunctionDefinition<NAME, TYPE, ARGS, RETURN>;
+declare function getRpcHandler<NAME extends string, TYPE extends RpcFunctionType, ARGS extends any[], RETURN = void>(definition: RpcFunctionDefinition<NAME, TYPE, ARGS, RETURN>, context: DevToolsNodeContext): Promise<(...args: ARGS) => RETURN>;
+//#endregion
+export { BirpcFn, BirpcReturn, ConnectionMeta, DevToolsCapabilities, DevToolsDockEntry, DevToolsDockEntryBase, DevToolsDockHost, DevToolsNodeContext, DevToolsPluginOptions, DevToolsRpcClientFunctions, DevToolsRpcServerFunctions, DevToolsViewAction, DevToolsViewIframe, DevToolsViewWebComponent, EntriesToObject, PluginWithDevTools, RpcDefinitionsFilter, RpcDefinitionsToFunctions, RpcFunctionDefinition, RpcFunctionSetupResult, RpcFunctionType, RpcFunctionsHost, Thenable, defineRpcFunction, getRpcHandler };

package/dist/index.js

@@ -0,0 +1,17 @@
+//#region src/utils/rpc.ts
+function defineRpcFunction(definition) {
+	return definition;
+}
+async function getRpcHandler(definition, context) {
+	if (definition.handler) return definition.handler;
+	if (definition.__resolved?.handler) return definition.__resolved.handler;
+	definition.__promise ??= Promise.resolve(definition.setup(context)).then((r) => {
+		definition.__resolved = r;
+		definition.__promise = void 0;
+		return r;
+	});
+	return (definition.__resolved ??= await definition.__promise).handler;
+}
+
+//#endregion
+export { defineRpcFunction, getRpcHandler };

package/dist/rpc-ls6mUIa2.d.ts

@@ -0,0 +1,118 @@
+import { BirpcFn, BirpcReturn as BirpcReturn$1 } from "birpc";
+import { ResolvedConfig, ViteDevServer } from "vite";
+
+//#region src/types/rpc-augments.d.ts
+/**
+ * To be extended
+ */
+interface DevToolsRpcClientFunctions {}
+/**
+ * To be extended
+ */
+interface DevToolsRpcServerFunctions {}
+//#endregion
+//#region 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 src/types/views.d.ts
+interface DevToolsDockHost {
+  register: (entry: DevToolsDockEntry) => void;
+  values: () => DevToolsDockEntry[];
+}
+interface DevToolsDockEntryBase {
+  id: string;
+  title: string;
+  icon: 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;
+}
+interface DevToolsViewWebComponent extends DevToolsDockEntryBase {
+  type: 'webcomponent';
+  from: string;
+  import: string;
+}
+interface DevToolsViewAction extends DevToolsDockEntryBase {
+  type: 'action';
+  importFrom: string;
+  /**
+   * @default 'default'
+   */
+  importName?: string;
+}
+type DevToolsDockEntry = DevToolsViewIframe | DevToolsViewWebComponent | DevToolsViewAction;
+//#endregion
+//#region 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;
+  /**
+   * 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;
+  staticDirs: {
+    baseUrl: string;
+    distDir: string;
+  }[];
+}
+interface ConnectionMeta {
+  backend: 'websocket' | 'static';
+  websocket?: number | string;
+}
+//#endregion
+//#region 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;
+}
+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']] }>;
+type RpcDefinitionsFilter<T extends readonly RpcFunctionDefinition<any, any, any>[], Type extends RpcFunctionType> = { [K in keyof T]: T[K] extends {
+  type: Type;
+} ? T[K] : never };
+//#endregion
+export { type BirpcFn, type BirpcReturn$1 as BirpcReturn, ConnectionMeta, DevToolsCapabilities, DevToolsDockEntry, DevToolsDockEntryBase, DevToolsDockHost, DevToolsNodeContext, DevToolsPluginOptions, DevToolsRpcClientFunctions, DevToolsRpcServerFunctions, DevToolsViewAction, DevToolsViewIframe, DevToolsViewWebComponent, EntriesToObject, RpcDefinitionsFilter, RpcDefinitionsToFunctions, RpcFunctionDefinition, RpcFunctionSetupResult, RpcFunctionType, RpcFunctionsHost, Thenable };

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@vitejs/devtools-kit",
+  "type": "module",
+  "version": "0.0.0-alpha.1",
+  "description": "Vite DevTools Kit",
+  "author": "VoidZero Inc.",
+  "license": "MIT",
+  "homepage": "https://github.com/vitejs/devtools#readme",
+  "repository": {
+    "directory": "packages/devtools-kit",
+    "type": "git",
+    "url": "git+https://github.com/vitejs/devtools.git"
+  },
+  "bugs": "https://github.com/vitejs/devtools/issues",
+  "keywords": [
+    "vite",
+    "devtools",
+    "kit"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.js",
+    "./client": "./dist/client.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "vite": "npm:rolldown-vite@^7.1.14"
+  },
+  "dependencies": {
+    "birpc": "^2.6.1",
+    "@vitejs/devtools-rpc": "0.0.0-alpha.1"
+  },
+  "devDependencies": {
+    "tsdown": "^0.15.6",
+    "vite": "npm:rolldown-vite@^7.1.14"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "watch": "tsdown --watch"
+  }
+}