@weapp-vite/devtools-runtime 0.4.17 → 0.4.19

package/README.md

@@ -0,0 +1,13 @@
+# @weapp-vite/devtools-runtime
+
+Shared WeChat DevTools runtime automation helpers for weapp-vite packages
+
+## 安装
+
+```bash
+pnpm add @weapp-vite/devtools-runtime
+```
+
+## 使用
+
+请根据包导出的 API 和仓库中的示例使用本包。完整文档与源码位于 [weapp-vite](https://github.com/weapp-vite/weapp-vite)。

package/dist/index.d.ts

@@ -1,29 +1,29 @@
 import { AutomatorElement, AutomatorMiniProgram, AutomatorPage, DevtoolsConnectionInput, DevtoolsContext, DevtoolsElementSnapshot, DevtoolsPageSnapshot, DevtoolsRuntimeHooks, DevtoolsRuntimeSessionOptions, DevtoolsToolResult, MiniProgramElementLike, readDevtoolsElementSnapshot, resolveDevtoolsProjectPath, resolveDevtoolsWorkspacePath, toDevtoolsSerializableValue } from "./mcp.js";
 //#region src/index.d.ts
-interface MiniProgramEventMap {
+export interface MiniProgramEventMap {
   console: (payload: unknown) => void;
   exception: (payload: unknown) => void;
 }
-declare function resolveSharedMiniProgramSessionKey(options: Pick<DevtoolsRuntimeSessionOptions, 'port' | 'projectPath' | 'sessionId'>): string;
+export declare function resolveSharedMiniProgramSessionKey(options: Pick<DevtoolsRuntimeSessionOptions, 'port' | 'projectPath' | 'sessionId'>): string;
 /**
  * @description 获取指定项目的共享 automator 会话；若不存在则自动创建。
  */
-declare function acquireSharedMiniProgram(hooks: DevtoolsRuntimeHooks, options: DevtoolsRuntimeSessionOptions): Promise<AutomatorMiniProgram>;
+export declare function acquireSharedMiniProgram(hooks: DevtoolsRuntimeHooks, options: DevtoolsRuntimeSessionOptions): Promise<AutomatorMiniProgram>;
 /**
  * @description 释放指定项目的共享会话引用；会话对象会继续缓存，直到显式关闭或重置。
  */
-declare function releaseSharedMiniProgram(projectPath: string, sessionIdOrPort?: string | number): void;
+export declare function releaseSharedMiniProgram(projectPath: string, sessionIdOrPort?: string | number): void;
 /**
  * @description 关闭并移除指定项目的共享 automator 会话。
  */
-declare function closeSharedMiniProgram(projectPath: string, sessionIdOrPort?: string | number): Promise<void>;
+export declare function closeSharedMiniProgram(projectPath: string, sessionIdOrPort?: string | number): Promise<void>;
 /**
  * @description 获取当前共享会话数量，供测试断言使用。
  */
-declare function getSharedMiniProgramSessionCount(): number;
+export declare function getSharedMiniProgramSessionCount(): number;
 /**
  * @description 统一管理 automator 会话生命周期。
  */
-declare function withMiniProgram<T>(hooks: DevtoolsRuntimeHooks, options: DevtoolsRuntimeSessionOptions, runner: (miniProgram: AutomatorMiniProgram) => Promise<T>): Promise<T>;
+export declare function withMiniProgram<T>(hooks: DevtoolsRuntimeHooks, options: DevtoolsRuntimeSessionOptions, runner: (miniProgram: AutomatorMiniProgram) => Promise<T>): Promise<T>;
 //#endregion
-export { type AutomatorElement, type AutomatorMiniProgram, type AutomatorPage, type DevtoolsConnectionInput, type DevtoolsContext, type DevtoolsElementSnapshot, type DevtoolsPageSnapshot, type DevtoolsRuntimeHooks, type DevtoolsRuntimeSessionOptions, type DevtoolsToolResult, type MiniProgramElementLike, MiniProgramEventMap, acquireSharedMiniProgram, closeSharedMiniProgram, getSharedMiniProgramSessionCount, readDevtoolsElementSnapshot, releaseSharedMiniProgram, resolveDevtoolsProjectPath, resolveDevtoolsWorkspacePath, resolveSharedMiniProgramSessionKey, toDevtoolsSerializableValue, withMiniProgram };
+export { type AutomatorElement, type AutomatorMiniProgram, type AutomatorPage, type DevtoolsConnectionInput, type DevtoolsContext, type DevtoolsElementSnapshot, type DevtoolsPageSnapshot, type DevtoolsRuntimeHooks, type DevtoolsRuntimeSessionOptions, type DevtoolsToolResult, type MiniProgramElementLike, readDevtoolsElementSnapshot, resolveDevtoolsProjectPath, resolveDevtoolsWorkspacePath, toDevtoolsSerializableValue };

package/dist/mcp.d.ts

@@ -1,14 +1,14 @@
 import { Element, MiniProgram, Page } from "@weapp-vite/miniprogram-automator";
 //#region src/mcp.d.ts
-type AutomatorMiniProgram = InstanceType<typeof MiniProgram> & {
+export type AutomatorMiniProgram = InstanceType<typeof MiniProgram> & {
   callWxMethod?: (method: string, ...args: unknown[]) => Promise<unknown>;
   enableLog?: (timeout?: number) => Promise<void>;
 };
-type AutomatorPage = InstanceType<typeof Page>;
-type AutomatorElement = InstanceType<typeof Element> & {
+export type AutomatorPage = InstanceType<typeof Page>;
+export type AutomatorElement = InstanceType<typeof Element> & {
   input?: (value: string) => Promise<void>;
 };
-interface DevtoolsRuntimeSessionOptions {
+export interface DevtoolsRuntimeSessionOptions {
   miniProgram?: AutomatorMiniProgram;
   openedOnly?: boolean;
   preferOpenedSession?: boolean;
@@ -19,11 +19,11 @@ interface DevtoolsRuntimeSessionOptions {
   sessionId?: string;
   timeout?: number;
 }
-interface DevtoolsRuntimeHooks {
+export interface DevtoolsRuntimeHooks {
   connectMiniProgram: (options: DevtoolsRuntimeSessionOptions) => Promise<AutomatorMiniProgram>;
   normalizeConnectionError?: (error: unknown) => unknown;
 }
-interface DevtoolsConnectionInput {
+export interface DevtoolsConnectionInput {
   projectPath: string;
   timeout?: number;
   openedOnly?: boolean;
@@ -32,7 +32,7 @@ interface DevtoolsConnectionInput {
   preserveProjectRoot?: boolean;
   sessionId?: string;
 }
-interface DevtoolsElementSnapshot {
+export interface DevtoolsElementSnapshot {
   selector: string;
   tagName: string;
   text: string | null;
@@ -44,21 +44,21 @@ interface DevtoolsElementSnapshot {
   wxml: string | null;
   outerWxml: string | null;
 }
-interface DevtoolsPageSnapshot {
+export interface DevtoolsPageSnapshot {
   path: string;
   query: unknown;
   size: unknown;
   scrollTop: unknown;
   data: unknown;
 }
-interface DevtoolsContext {
+export interface DevtoolsContext {
   miniProgram: AutomatorMiniProgram;
   page: AutomatorPage;
 }
-interface DevtoolsToolResult<T> {
+export interface DevtoolsToolResult<T> {
   result: T;
 }
-interface MiniProgramElementLike {
+export interface MiniProgramElementLike {
   tagName?: string;
   $?: (selector: string) => Promise<MiniProgramElementLike | null>;
   $$?: (selector: string) => Promise<MiniProgramElementLike[]>;
@@ -72,9 +72,8 @@ interface MiniProgramElementLike {
   value?: () => Promise<unknown>;
   wxml?: () => Promise<unknown>;
 }
-declare function resolveDevtoolsProjectPath(workspaceRoot: string, projectPath: string): string;
-declare function resolveDevtoolsWorkspacePath(workspaceRoot: string, filePath: string): string;
-declare function toDevtoolsSerializableValue(value: unknown): unknown;
-declare function readDevtoolsElementSnapshot(element: MiniProgramElementLike, selector: string, attributeNames?: readonly string[], styleNames?: readonly string[]): Promise<DevtoolsElementSnapshot>;
-//#endregion
-export { AutomatorElement, AutomatorMiniProgram, AutomatorPage, DevtoolsConnectionInput, DevtoolsContext, DevtoolsElementSnapshot, DevtoolsPageSnapshot, DevtoolsRuntimeHooks, DevtoolsRuntimeSessionOptions, DevtoolsToolResult, MiniProgramElementLike, readDevtoolsElementSnapshot, resolveDevtoolsProjectPath, resolveDevtoolsWorkspacePath, toDevtoolsSerializableValue };
+export declare function resolveDevtoolsProjectPath(workspaceRoot: string, projectPath: string): string;
+export declare function resolveDevtoolsWorkspacePath(workspaceRoot: string, filePath: string): string;
+export declare function toDevtoolsSerializableValue(value: unknown): unknown;
+export declare function readDevtoolsElementSnapshot(element: MiniProgramElementLike, selector: string, attributeNames?: readonly string[], styleNames?: readonly string[]): Promise<DevtoolsElementSnapshot>;
+//#endregion

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@weapp-vite/devtools-runtime",
   "type": "module",
-  "version": "0.4.17",
+  "version": "0.4.19",
   "description": "Shared WeChat DevTools runtime automation helpers for weapp-vite packages",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
+  "homepage": "https://github.com/weapp-vite/weapp-vite#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/weapp-vite/weapp-vite.git",
@@ -13,6 +14,16 @@
   "bugs": {
     "url": "https://github.com/weapp-vite/weapp-vite/issues"
   },
+  "keywords": [
+    "weapp-vite",
+    "weapp",
+    "wechat",
+    "mini-program",
+    "miniprogram",
+    "vite",
+    "runtime",
+    "devtools"
+  ],
   "sideEffects": false,
   "exports": {
     ".": {
@@ -35,10 +46,10 @@
   },
   "publishConfig": {
     "access": "public",
-    "registry": "https://registry.npmjs.org/"
+    "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@weapp-vite/miniprogram-automator": "1.2.16"
+    "@weapp-vite/miniprogram-automator": "1.2.18"
   },
   "scripts": {
     "dev": "tsdown -w --sourcemap",