weapp-ide-cli 5.1.2 → 5.1.4

package/dist/index.d.ts

@@ -1,28 +1,29 @@
-import { Buffer } from "node:buffer";
-import * as miniprogram_automator_out_MiniProgram0 from "miniprogram-automator/out/MiniProgram";
+import { Element, MiniProgram, Page } from "@weapp-vite/miniprogram-automator";
+import * as cac$1 from "cac";
 import * as execa from "execa";
 
 //#region src/cli/automator.d.ts
 interface AutomatorOptions {
   projectPath: string;
   timeout?: number;
+  cliPath?: string;
 }
 /**
- * @description Check if error is a DevTools HTTP port error
+ * @description 判断错误是否属于开发者工具服务端口不可用。
  */
 declare function isDevtoolsHttpPortError(error: unknown): boolean;
 /**
- * @description Check if error is a login required error
+ * @description 判断错误是否属于开发者工具登录失效。
  */
 declare function isAutomatorLoginError(error: unknown): boolean;
 /**
- * @description Format login error for display
+ * @description 格式化开发者工具登录失效错误，便于终端展示。
  */
 declare function formatAutomatorLoginError(error: unknown): string;
 /**
- * @description Launch automator with default options
+ * @description 基于当前配置解析 CLI 路径，并通过现代化 automator 入口启动会话。
  */
-declare function launchAutomator(options: AutomatorOptions): Promise<miniprogram_automator_out_MiniProgram0.default>;
+declare function launchAutomator(options: AutomatorOptions): Promise<any>;
 //#endregion
 //#region src/cli/automator-argv.d.ts
 interface ParsedAutomatorArgs {
@@ -53,39 +54,17 @@ interface MiniProgramEventMap {
   console: (payload: unknown) => void;
   exception: (payload: unknown) => void;
 }
-interface MiniProgramElement {
-  tap: () => Promise<void>;
+type MiniProgramLike = InstanceType<typeof MiniProgram>;
+type MiniProgramPage = InstanceType<typeof Page>;
+type MiniProgramElement = InstanceType<typeof Element> & {
   input?: (value: string) => Promise<void>;
-}
-interface MiniProgramPage {
-  path?: string;
-  query?: Record<string, unknown>;
-  data: (path?: string) => Promise<unknown>;
-  $: (selector: string) => Promise<MiniProgramElement | null>;
-}
-interface MiniProgramLike {
-  navigateTo: (url: string) => Promise<unknown>;
-  redirectTo: (url: string) => Promise<unknown>;
-  navigateBack: () => Promise<unknown>;
-  reLaunch: (url: string) => Promise<unknown>;
-  switchTab: (url: string) => Promise<unknown>;
-  pageStack: () => Promise<MiniProgramPage[]>;
-  currentPage: () => Promise<MiniProgramPage>;
-  systemInfo: () => Promise<unknown>;
-  pageScrollTo: (scrollTop: number) => Promise<unknown>;
-  stopAudits: () => Promise<unknown>;
-  screenshot: () => Promise<string | Buffer>;
-  remote: (enable?: boolean) => Promise<unknown>;
-  close: () => Promise<void>;
-  on: <TEvent extends keyof MiniProgramEventMap>(event: TEvent, listener: MiniProgramEventMap[TEvent]) => MiniProgramLike;
-  off?: <TEvent extends keyof MiniProgramEventMap>(event: TEvent, listener: MiniProgramEventMap[TEvent]) => MiniProgramLike;
-}
+};
 /**
  * @description 建立 automator 会话，并统一处理常见连接错误提示。
  */
 declare function connectMiniProgram(options: AutomatorSessionOptions): Promise<MiniProgramLike>;
 /**
- * @description 统一管理 automator 会话生命周期与常见连接错误提示。
+ * @description 统一管理 automator 会话生命周期。
  */
 declare function withMiniProgram<T>(options: AutomatorSessionOptions, runner: (miniProgram: MiniProgramLike) => Promise<T>): Promise<T>;
 //#endregion
@@ -138,20 +117,65 @@ interface PageSnapshot {
   path: string;
   query: Record<string, unknown> | undefined;
 }
+/**
+ * @description 执行保留栈页面跳转。
+ */
 declare function navigateTo(options: NavigateOptions): Promise<void>;
+/**
+ * @description 执行关闭当前页的重定向。
+ */
 declare function redirectTo(options: NavigateOptions): Promise<void>;
+/**
+ * @description 返回上一页。
+ */
 declare function navigateBack(options: AutomatorCommandOptions): Promise<void>;
+/**
+ * @description 重启到指定页面。
+ */
 declare function reLaunch(options: NavigateOptions): Promise<void>;
+/**
+ * @description 切换到 tabBar 页面。
+ */
 declare function switchTab(options: NavigateOptions): Promise<void>;
-declare function pageStack(options: PageInfoOptions): Promise<PageSnapshot[]>;
+/**
+ * @description 获取页面栈。
+ */
+declare function pageStack(options: PageInfoOptions): Promise<any>;
+/**
+ * @description 获取当前页面信息。
+ */
 declare function currentPage(options: PageInfoOptions): Promise<PageSnapshot>;
-declare function systemInfo(options: PageInfoOptions): Promise<unknown>;
-declare function pageData(options: PageDataOptions): Promise<unknown>;
+/**
+ * @description 获取系统信息。
+ */
+declare function systemInfo(options: PageInfoOptions): Promise<any>;
+/**
+ * @description 获取当前页面数据。
+ */
+declare function pageData(options: PageDataOptions): Promise<any>;
+/**
+ * @description 点击页面元素。
+ */
 declare function tap(options: TapOptions): Promise<void>;
+/**
+ * @description 向页面元素输入文本。
+ */
 declare function input(options: InputOptions): Promise<void>;
+/**
+ * @description 滚动页面到指定位置。
+ */
 declare function scrollTo(options: ScrollOptions): Promise<void>;
-declare function audit(options: AuditOptions): Promise<unknown>;
+/**
+ * @description 执行体验评分审计。
+ */
+declare function audit(options: AuditOptions): Promise<any>;
+/**
+ * @description 获取当前小程序截图。
+ */
 declare function takeScreenshot(options: ScreenshotOptions): Promise<ScreenshotResult>;
+/**
+ * @description 开关远程调试。
+ */
 declare function remote(options: RemoteOptions): Promise<void>;
 //#endregion
 //#region src/cli/config-command.d.ts
@@ -236,6 +260,10 @@ declare function waitForRetryKeypress(options?: RetryKeypressOptions): Promise<R
 declare function formatRetryHotkeyPrompt(timeoutMs?: number): string;
 //#endregion
 //#region src/cli/run.d.ts
+/**
+ * @description 基于 cac 注册顶层命令，用于统一识别入口。
+ */
+declare function createCli(): cac$1.CAC;
 /**
  * @description CLI 入口解析与分发。
  */
@@ -248,13 +276,13 @@ declare const AUTOMATOR_COMMAND_NAMES: string[];
  */
 declare function isAutomatorCommand(command: string | undefined): boolean;
 /**
- * @description 分发 automator 子命令。
+ * @description 获取 automator 子命令帮助文本。
  */
-declare function runAutomatorCommand(command: string, argv: string[]): Promise<void>;
+declare function getAutomatorCommandHelp(command: string): string | undefined;
 /**
- * @description 获取 automator 命令帮助文本。
+ * @description 执行 automator 子命令。
  */
-declare function getAutomatorCommandHelp(command: string): string | undefined;
+declare function runAutomatorCommand(command: string, argv: string[]): Promise<void>;
 //#endregion
 //#region src/cli/run-login.d.ts
 type LoginRetryMode = 'never' | 'once' | 'always';
@@ -412,4 +440,4 @@ declare function execute(cliPath: string, argv: string[], options?: ExecuteOptio
  */
 declare function resolvePath(filePath: string): string;
 //#endregion
-export { AUTOMATOR_COMMAND_NAMES, ArgvTransform, AuditOptions, AutomatorCommandOptions, AutomatorOptions, AutomatorSessionOptions, type BaseConfig, CONFIG_COMMAND_NAME, type ConfigSource, ForwardConsoleEvent, ForwardConsoleLogLevel, ForwardConsoleOptions, ForwardConsoleSession, InputOptions, LoginRetryMode, MINIDEV_NAMESPACE_COMMAND_NAMES, MiniProgramElement, MiniProgramEventMap, MiniProgramLike, MiniProgramPage, NavigateOptions, PageDataOptions, PageInfoOptions, ParsedAutomatorArgs, RemoteOptions, type ResolvedConfig, RetryKeypressOptions, RetryPromptResult, type ScreenshotOptions, type ScreenshotResult, ScrollOptions, SelectorOptions, SupportedPlatform, SupportedPlatformsMap, TapOptions, WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES, WECHAT_CLI_COMMAND_NAMES, audit, connectMiniProgram, createAlias, createCustomConfig, createLocaleConfig, createPathCompat, createWechatIdeLoginRequiredExitError, currentPage, defaultCustomConfigDirPath, defaultCustomConfigFilePath, execute, extractExecutionErrorText, formatAutomatorLoginError, formatRetryHotkeyPrompt, formatWechatIdeLoginRequiredError, getAutomatorCommandHelp, getConfig, getConfiguredLocale, getDefaultCliPath, handleConfigCommand, input, isAutomatorCommand, isAutomatorLoginError, isDevtoolsHttpPortError, isOperatingSystemSupported, isWeappIdeTopLevelCommand, isWechatIdeLoginRequiredError, launchAutomator, navigateBack, navigateTo, operatingSystemName, overwriteCustomConfig, pageData, pageStack, parse, parseAutomatorArgs, parseScreenshotArgs, printScreenshotHelp, promptForCliPath, reLaunch, readCustomConfig, readOptionValue, redirectTo, remote, removeCustomConfigKey, removeOption, resolveCliPath, resolvePath, runAutomatorCommand, runMinidev, runWechatCliWithRetry, scrollTo, startForwardConsole, switchTab, systemInfo, takeScreenshot, tap, transformArgv, validateWechatCliCommandArgs, waitForRetryKeypress, withMiniProgram };
+export { AUTOMATOR_COMMAND_NAMES, ArgvTransform, AuditOptions, AutomatorCommandOptions, AutomatorOptions, AutomatorSessionOptions, type BaseConfig, CONFIG_COMMAND_NAME, type ConfigSource, ForwardConsoleEvent, ForwardConsoleLogLevel, ForwardConsoleOptions, ForwardConsoleSession, InputOptions, LoginRetryMode, MINIDEV_NAMESPACE_COMMAND_NAMES, MiniProgramElement, MiniProgramEventMap, MiniProgramLike, MiniProgramPage, NavigateOptions, PageDataOptions, PageInfoOptions, ParsedAutomatorArgs, RemoteOptions, type ResolvedConfig, RetryKeypressOptions, RetryPromptResult, type ScreenshotOptions, type ScreenshotResult, ScrollOptions, SelectorOptions, SupportedPlatform, SupportedPlatformsMap, TapOptions, WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES, WECHAT_CLI_COMMAND_NAMES, audit, connectMiniProgram, createAlias, createCli, createCustomConfig, createLocaleConfig, createPathCompat, createWechatIdeLoginRequiredExitError, currentPage, defaultCustomConfigDirPath, defaultCustomConfigFilePath, execute, extractExecutionErrorText, formatAutomatorLoginError, formatRetryHotkeyPrompt, formatWechatIdeLoginRequiredError, getAutomatorCommandHelp, getConfig, getConfiguredLocale, getDefaultCliPath, handleConfigCommand, input, isAutomatorCommand, isAutomatorLoginError, isDevtoolsHttpPortError, isOperatingSystemSupported, isWeappIdeTopLevelCommand, isWechatIdeLoginRequiredError, launchAutomator, navigateBack, navigateTo, operatingSystemName, overwriteCustomConfig, pageData, pageStack, parse, parseAutomatorArgs, parseScreenshotArgs, printScreenshotHelp, promptForCliPath, reLaunch, readCustomConfig, readOptionValue, redirectTo, remote, removeCustomConfigKey, removeOption, resolveCliPath, resolvePath, runAutomatorCommand, runMinidev, runWechatCliWithRetry, scrollTo, startForwardConsole, switchTab, systemInfo, takeScreenshot, tap, transformArgv, validateWechatCliCommandArgs, waitForRetryKeypress, withMiniProgram };

package/dist/index.js

@@ -1,3 +1,3 @@
-import { D as launchAutomator, E as isDevtoolsHttpPortError, T as isAutomatorLoginError, _ as connectMiniProgram, a as navigateBack, c as pageStack, d as remote, f as scrollTo, g as tap, h as takeScreenshot, i as input, l as reLaunch, m as systemInfo, o as navigateTo, p as switchTab, r as currentPage, s as pageData, t as audit, u as redirectTo, v as withMiniProgram, w as formatAutomatorLoginError } from "./commands-BwCMEmX-.js";
-import { A as defaultCustomConfigDirPath, B as isAutomatorCommand, C as operatingSystemName, D as overwriteCustomConfig, E as createLocaleConfig, F as WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES, G as readOptionValue, H as parseScreenshotArgs, I as WECHAT_CLI_COMMAND_NAMES, K as removeOption, L as isWeappIdeTopLevelCommand, M as resolvePath, N as CONFIG_COMMAND_NAME, O as readCustomConfig, P as MINIDEV_NAMESPACE_COMMAND_NAMES, R as AUTOMATOR_COMMAND_NAMES, S as isOperatingSystemSupported, T as createCustomConfig, U as printScreenshotHelp, V as runAutomatorCommand, W as parseAutomatorArgs, _ as resolveCliPath, a as extractExecutionErrorText, b as SupportedPlatformsMap, c as isWechatIdeLoginRequiredError, d as execute, f as createAlias, g as handleConfigCommand, h as startForwardConsole, i as createWechatIdeLoginRequiredExitError, j as defaultCustomConfigFilePath, k as removeCustomConfigKey, l as waitForRetryKeypress, m as transformArgv, n as validateWechatCliCommandArgs, o as formatRetryHotkeyPrompt, p as createPathCompat, r as runWechatCliWithRetry, s as formatWechatIdeLoginRequiredError, t as parse, u as runMinidev, v as getConfig, w as promptForCliPath, x as getDefaultCliPath, y as getConfiguredLocale, z as getAutomatorCommandHelp } from "./cli-g8B8r0xg.js";
-export { AUTOMATOR_COMMAND_NAMES, CONFIG_COMMAND_NAME, MINIDEV_NAMESPACE_COMMAND_NAMES, SupportedPlatformsMap, WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES, WECHAT_CLI_COMMAND_NAMES, audit, connectMiniProgram, createAlias, createCustomConfig, createLocaleConfig, createPathCompat, createWechatIdeLoginRequiredExitError, currentPage, defaultCustomConfigDirPath, defaultCustomConfigFilePath, execute, extractExecutionErrorText, formatAutomatorLoginError, formatRetryHotkeyPrompt, formatWechatIdeLoginRequiredError, getAutomatorCommandHelp, getConfig, getConfiguredLocale, getDefaultCliPath, handleConfigCommand, input, isAutomatorCommand, isAutomatorLoginError, isDevtoolsHttpPortError, isOperatingSystemSupported, isWeappIdeTopLevelCommand, isWechatIdeLoginRequiredError, launchAutomator, navigateBack, navigateTo, operatingSystemName, overwriteCustomConfig, pageData, pageStack, parse, parseAutomatorArgs, parseScreenshotArgs, printScreenshotHelp, promptForCliPath, reLaunch, readCustomConfig, readOptionValue, redirectTo, remote, removeCustomConfigKey, removeOption, resolveCliPath, resolvePath, runAutomatorCommand, runMinidev, runWechatCliWithRetry, scrollTo, startForwardConsole, switchTab, systemInfo, takeScreenshot, tap, transformArgv, validateWechatCliCommandArgs, waitForRetryKeypress, withMiniProgram };
+import { A as createLocaleConfig, B as operatingSystemName, C as isAutomatorLoginError, D as getConfig, E as resolveCliPath, F as defaultCustomConfigFilePath, I as resolvePath, L as SupportedPlatformsMap, M as readCustomConfig, N as removeCustomConfigKey, O as getConfiguredLocale, P as defaultCustomConfigDirPath, R as getDefaultCliPath, S as formatAutomatorLoginError, T as launchAutomator, _ as connectMiniProgram, a as navigateBack, c as pageStack, d as remote, f as scrollTo, g as tap, h as takeScreenshot, i as input, j as overwriteCustomConfig, k as createCustomConfig, l as reLaunch, m as systemInfo, o as navigateTo, p as switchTab, r as currentPage, s as pageData, t as audit, u as redirectTo, v as withMiniProgram, w as isDevtoolsHttpPortError, z as isOperatingSystemSupported } from "./commands-CSbpftLN.js";
+import { A as parseAutomatorArgs, C as isWeappIdeTopLevelCommand, D as runAutomatorCommand, E as isAutomatorCommand, M as removeOption, O as parseScreenshotArgs, S as WECHAT_CLI_COMMAND_NAMES, T as getAutomatorCommandHelp, _ as handleConfigCommand, a as createWechatIdeLoginRequiredExitError, b as MINIDEV_NAMESPACE_COMMAND_NAMES, c as formatWechatIdeLoginRequiredError, d as runMinidev, f as execute, g as startForwardConsole, h as transformArgv, i as runWechatCliWithRetry, j as readOptionValue, k as printScreenshotHelp, l as isWechatIdeLoginRequiredError, m as createPathCompat, n as parse, o as extractExecutionErrorText, p as createAlias, r as validateWechatCliCommandArgs, s as formatRetryHotkeyPrompt, t as createCli, u as waitForRetryKeypress, v as promptForCliPath, w as AUTOMATOR_COMMAND_NAMES, x as WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES, y as CONFIG_COMMAND_NAME } from "./cli-BkQJ3Aww.js";
+export { AUTOMATOR_COMMAND_NAMES, CONFIG_COMMAND_NAME, MINIDEV_NAMESPACE_COMMAND_NAMES, SupportedPlatformsMap, WEAPP_IDE_TOP_LEVEL_COMMAND_NAMES, WECHAT_CLI_COMMAND_NAMES, audit, connectMiniProgram, createAlias, createCli, createCustomConfig, createLocaleConfig, createPathCompat, createWechatIdeLoginRequiredExitError, currentPage, defaultCustomConfigDirPath, defaultCustomConfigFilePath, execute, extractExecutionErrorText, formatAutomatorLoginError, formatRetryHotkeyPrompt, formatWechatIdeLoginRequiredError, getAutomatorCommandHelp, getConfig, getConfiguredLocale, getDefaultCliPath, handleConfigCommand, input, isAutomatorCommand, isAutomatorLoginError, isDevtoolsHttpPortError, isOperatingSystemSupported, isWeappIdeTopLevelCommand, isWechatIdeLoginRequiredError, launchAutomator, navigateBack, navigateTo, operatingSystemName, overwriteCustomConfig, pageData, pageStack, parse, parseAutomatorArgs, parseScreenshotArgs, printScreenshotHelp, promptForCliPath, reLaunch, readCustomConfig, readOptionValue, redirectTo, remote, removeCustomConfigKey, removeOption, resolveCliPath, resolvePath, runAutomatorCommand, runMinidev, runWechatCliWithRetry, scrollTo, startForwardConsole, switchTab, systemInfo, takeScreenshot, tap, transformArgv, validateWechatCliCommandArgs, waitForRetryKeypress, withMiniProgram };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "weapp-ide-cli",
   "type": "module",
-  "version": "5.1.2",
+  "version": "5.1.4",
   "description": "让微信开发者工具，用起来更加方便！",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -62,11 +62,12 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
+    "cac": "^7.0.0",
     "execa": "9.6.1",
     "fs-extra": "^11.3.4",
-    "miniprogram-automator": "^0.12.1",
     "pathe": "^2.0.3",
-    "@weapp-core/logger": "^3.1.1"
+    "@weapp-core/logger": "^3.1.1",
+    "@weapp-vite/miniprogram-automator": "1.0.1"
   },
   "scripts": {
     "dev": "tsdown -w --sourcemap",