@weapp-vite/miniprogram-automator 1.2.5 → 1.2.7

package/dist/index.d.mts

@@ -1,7 +1,6 @@
 import { EventEmitter } from "node:events";
 import WebSocket from "ws";
 import { Buffer } from "node:buffer";
-
 //#region src/smartapp/file.d.ts
 declare function mkdir(dir: string): Promise<void>;
 declare function rmdir(dir: string): Promise<void>;
@@ -45,13 +44,20 @@ declare class Transport extends EventEmitter {
 interface SendOptions {
   timeout?: number;
 }
+interface ToolInfo {
+  version?: string;
+}
 /** Connection 的实现。 */
 declare class Connection extends EventEmitter {
   private transport;
   private callbacks;
+  private useAppServicePageProtocol;
   constructor(transport: Transport);
   send(method: string, params?: Record<string, any>, options?: SendOptions): Promise<any>;
   dispose(): void;
+  /** 根据 DevTools 版本选择稳定的 Page 协议实现。 */
+  configureToolInfo(info: ToolInfo): void;
+  get prefersAppServicePageProtocol(): boolean;
   private onMessage;
   private onClose;
   static create(url: string, timeout?: number): Promise<Connection>;
@@ -111,6 +117,9 @@ interface IEventOptions {
   detail?: Record<string, any>;
 }
 type ElementMap = Map<string, Element>;
+interface ElementQueryOptions {
+  timeout?: number;
+}
 /** Element 的实现。 */
 declare class Element {
   private connection;
@@ -122,8 +131,8 @@ declare class Element {
   private pageId;
   private publicProps?;
   constructor(connection: Connection, options: IElementOptions, elementMap: ElementMap);
-  $(selector: string): Promise<Element | null>;
-  $$(selector: string): Promise<any>;
+  $(selector: string, options?: ElementQueryOptions): Promise<Element | null>;
+  $$(selector: string, options?: ElementQueryOptions): Promise<any>;
   size(): Promise<{
     width: any;
     height: any;
@@ -144,7 +153,9 @@ declare class Element {
   touchend(options?: ITouchEventOptions): Promise<void>;
   dispatchEvent(options: IEventOptions): Promise<void>;
   protected _property(name: string | string[]): Promise<any>;
-  protected send(method: string, params?: Record<string, any>): Promise<any>;
+  protected send(method: string, params?: Record<string, any>, options?: {
+    timeout?: number;
+  }): Promise<any>;
   protected callFunction(functionName: string, ...args: any[]): Promise<any>;
   private domProperty;
   private getter;
@@ -202,6 +213,41 @@ interface IPageOptions {
 }
 type PageMap = Map<number, Page>;
 type WaitCondition = string | number | (() => unknown | Promise<unknown>);
+interface PageQueryOptions {
+  componentSelectors?: string[];
+  fallback?: boolean;
+  routeOnly?: boolean;
+  timeout?: number;
+}
+interface PageDataOptions {
+  fallback?: boolean;
+  routeOnly?: boolean;
+  timeout?: number;
+}
+interface PageCallMethodOptions {
+  fallback?: boolean;
+  routeOnly?: boolean;
+  timeout?: number;
+}
+interface PageRenderedOptions {
+  componentSelectors?: string[];
+  dataset?: Record<string, string | number | boolean>;
+  predicate?: (wxml: string) => boolean;
+  selector?: string;
+  text?: string;
+  timeout?: number;
+}
+interface RenderedNodeSnapshot {
+  bottom?: number;
+  dataset?: Record<string, unknown>;
+  height?: number;
+  id?: string;
+  left?: number;
+  right?: number;
+  top?: number;
+  width?: number;
+}
+type RenderedSelectorNodesSnapshot = Record<string, RenderedNodeSnapshot[]>;
 /** Page 的实现。 */
 declare class Page {
   private connection;
@@ -209,20 +255,32 @@ declare class Page {
   query: any;
   private id;
   private elementMap;
+  private preferAppServicePageProtocol;
   constructor(connection: Connection, options: IPageOptions);
+  updateFromOptions(options: IPageOptions): void;
   waitFor(condition: WaitCondition): Promise<void>;
-  $(selector: string): Promise<Element | null>;
-  $$(selector: string): Promise<any>;
-  getElementByXpath(selector: string): Promise<Element | null>;
-  getElementsByXpath(selector: string): Promise<any>;
+  $(selector: string, options?: PageQueryOptions): Promise<Element | null>;
+  $$(selector: string, options?: PageQueryOptions): Promise<any>;
+  getElementByXpath(selector: string, options?: PageQueryOptions): Promise<Element | null>;
+  getElementsByXpath(selector: string, options?: PageQueryOptions): Promise<any>;
   xpath(selector: string): Promise<Element | null>;
-  data(path?: string): Promise<any>;
+  wxml(): Promise<any>;
+  renderedNodes(selector: string, options?: PageQueryOptions): Promise<RenderedNodeSnapshot[]>;
+  renderedSelectorNodes(selectors: string[], options?: PageQueryOptions): Promise<RenderedSelectorNodesSnapshot>;
+  waitForRendered(options?: PageRenderedOptions): Promise<any>;
+  data(path?: string, options?: PageDataOptions): Promise<any>;
+  private readRouteData;
   setData(data: any): Promise<void>;
   size(): Promise<{
     width: any;
     height: any;
   }>;
   callMethod(method: string, ...args: any[]): Promise<any>;
+  callMethodWithOptions(method: string, options?: PageCallMethodOptions, ...args: any[]): Promise<any>;
+  private queryRouteElement;
+  private queryRouteElements;
+  private callRouteMethod;
+  private setRouteData;
   scrollTop(): Promise<any>;
   private windowProperty;
   private send;
@@ -245,9 +303,13 @@ interface IToolClearCacheOptions {
 }
 type AutomatorCallable = (...args: any[]) => any;
 interface CurrentPageOptions {
+  appFunctionFallback?: boolean;
   retries?: number;
   timeout?: number;
 }
+interface EvaluateOptions {
+  timeout?: number;
+}
 /** MiniProgram 的实现。 */
 declare class MiniProgram extends EventEmitter {
   private connection;
@@ -257,14 +319,17 @@ declare class MiniProgram extends EventEmitter {
   private nativeIns?;
   constructor(connection: Connection);
   pageStack(): Promise<any>;
-  navigateTo(url: string): Promise<any>;
-  redirectTo(url: string): Promise<any>;
-  navigateBack(): Promise<any>;
-  reLaunch(url: string): Promise<any>;
-  switchTab(url: string): Promise<any>;
+  navigateTo(url: string): Promise<Page>;
+  redirectTo(url: string): Promise<Page>;
+  navigateBack(): Promise<Page>;
+  reLaunch(url: string): Promise<Page>;
+  switchTab(url: string): Promise<Page>;
   currentPage(options?: CurrentPageOptions): Promise<Page>;
   systemInfo(): Promise<any>;
   callWxMethod(method: string, ...args: any[]): Promise<any>;
+  callWxMethodWithOptions(method: string, options?: {
+    timeout?: number;
+  }, ...args: any[]): Promise<any>;
   private callWxMethodWithTimeout;
   mockWxMethod(method: string, result: any, ...args: any[]): Promise<void>;
   restoreWxMethod(method: string): Promise<void>;
@@ -272,6 +337,7 @@ declare class MiniProgram extends EventEmitter {
   mockPluginWxMethod(pluginId: string, method: string, result: any, ...args: any[]): Promise<void>;
   restorePluginWxMethod(pluginId: string, method: string): Promise<void>;
   evaluate(appFunction: AutomatorCallable | string, ...args: any[]): Promise<any>;
+  evaluateWithOptions(appFunction: AutomatorCallable | string, options?: EvaluateOptions, ...args: any[]): Promise<any>;
   pageScrollTo(scrollTop: number): Promise<void>;
   close(): Promise<void>;
   remote(auto?: boolean): Promise<void>;
@@ -311,6 +377,9 @@ declare class MiniProgram extends EventEmitter {
   private resolveRouteContextPage;
   private readRoutePollingCurrentPage;
   private readRoutePollingPageStack;
+  private createPageFromPayload;
+  private createPagesFromPayloads;
+  private readAppFunctionPageStack;
   private send;
   private onLogAdded;
   private onBindingCalled;