@applitools/nlp-web-runner 5.5.0 → 5.6.1-dev.7c135a4a5

package/dist/_inline/nlp-runner/web/index.d.ts

@@ -246,6 +246,10 @@ type Action<TType extends string> = Extract<EmptyAction | CommentAction | SetVar
   type: TType;
 }>;
 type Instruction = Action<any> | ControlFlow;
+type Program$1 = Instruction[];
+type SealedProgram = {
+  __seal?: never;
+};
 type Primitive<TPrimitiveName extends string> = TPrimitiveName extends 'null' ? null : TPrimitiveName extends 'boolean' ? boolean : TPrimitiveName extends 'number' ? number : TPrimitiveName extends 'string' ? string : TPrimitiveName extends 'any' ? Any : unknown;
 type PrimitiveName<TPrimitive = Any> = TPrimitive extends null ? 'null' : TPrimitive extends boolean ? 'boolean' : TPrimitive extends number ? 'number' : TPrimitive extends string ? 'string' : TPrimitive extends Any ? 'any' : never;
 type Reference<TType> = {
@@ -707,6 +711,7 @@ declare class Rectangle {
     width: number;
     height: number;
   }): Rectangle;
+  /** Builds the axis-aligned bounding box of a CDP quad, whose 4 corners come in transform-dependent order. */
   static fromQuad(quad: number[]): Rectangle;
   readonly left: number;
   readonly top: number;
@@ -769,7 +774,7 @@ declare class Rectangle {
 //#region src/patterns.d.ts
 type Match = (text: string) => string | null;
 //#endregion
-//#region dist/_inline/_chunks/script-De9VUKC6.d.ts
+//#region dist/_inline/_chunks/script-9fx1iw2D.d.ts
 //#region src/port.d.ts
 interface PortMessageEvent<TName extends string = string, TPayload = unknown> extends Event {
   readonly name: TName;
@@ -1026,7 +1031,7 @@ interface Request {
   readonly headers: Record<string, string>;
   body(): Promise<Uint8Array>;
 }
-interface Response {
+interface Response$1 {
   readonly request: Request;
   readonly status: number;
   readonly error?: string;
@@ -1092,7 +1097,7 @@ declare class InterceptedRequest extends Intercepted implements Request {
   body(): Promise<Uint8Array>;
 }
 declare function makeInterceptedResponse(options: InterceptedOptions): InterceptedResponse;
-declare class InterceptedResponse extends Intercepted implements Response {
+declare class InterceptedResponse extends Intercepted implements Response$1 {
   #private;
   readonly stage: "response";
   readonly request: Request;
@@ -1237,6 +1242,13 @@ declare class WebNode<TNode extends globalThis.Node = Element | Text> implements
     button?: 'left' | 'middle' | 'right' | 'back' | 'forward';
     times?: number;
   }): Promise<void>;
+  scrollIntoView({
+    block,
+    inline
+  }?: {
+    block?: ScrollLogicalPosition;
+    inline?: ScrollLogicalPosition;
+  }): Promise<void>;
   tryToUnobscure(): Promise<void>;
   isVisible(): Promise<boolean>;
   getObscurationInfo(): Promise<{
@@ -1920,7 +1932,7 @@ declare class Frame extends EventTargetNode<FrameEventMap> {
   getOwnerNode(): Promise<WebNode<HTMLIFrameElement> | null>;
   $<TNode extends globalThis.Node = Element | Text>(selector: string | string[]): Promise<WebNode<TNode> | null>;
   $$<TNode extends globalThis.Node = Element | Text>(selector: string | string[]): Promise<WebNode<TNode>[]>;
-  fetch(url: string, options?: FrameFetchOptions): Promise<Response>;
+  fetch(url: string, options?: FrameFetchOptions): Promise<Response$1>;
   execute<TResult = unknown, TArgs extends readonly any[] = any[]>(fn: EvaluationFunction<TArgs, TResult>, args?: TArgs, options?: EvaluationOptions): Promise<EvaluationResult<TResult>>;
   defaultExecute<TResult = unknown, TArgs extends readonly any[] = any[]>(fn: EvaluationFunction<TArgs, TResult>, args?: TArgs, options?: EvaluationOptions): Promise<EvaluationResult<TResult>>;
   evaluate<TResult = unknown>(expression: EvaluationExpression<TResult>, options?: EvaluationOptions): Promise<EvaluationResult<TResult>>;
@@ -8175,6 +8187,7 @@ declare class HarRecorderStatsChangedEvent extends Event {
 } //#endregion
 //#endregion
 //#region dist/_inline/ax-tree/public/index.d.ts
+//#endregion
 //#region src/public/types.d.ts
 interface AXTreeFlat<TNode> {
   nodes: AXNodeFlat<TNode>[];
@@ -8191,6 +8204,7 @@ interface AXTreeFlat<TNode> {
     height: number;
   };
   direction: 'ltr' | 'rtl';
+  version?: string;
 }
 interface AXNodeFlat<TNode> {
   node: TNode;
@@ -8384,6 +8398,7 @@ interface IAXTreeView<TNode = unknown> extends Iterable<IAXNodeView<TNode>> {
     height: number;
   };
   readonly direction: 'ltr' | 'rtl';
+  readonly version?: string;
   readonly root: IAXNodeView<TNode>;
   readonly nodeCount: number;
   readonly hosts: IAXNodeView<TNode>[];
@@ -8399,6 +8414,7 @@ interface IAXTreeView<TNode = unknown> extends Iterable<IAXNodeView<TNode>> {
       height: number;
     };
     direction: 'ltr' | 'rtl';
+    version?: string;
     root: AXNodeViewJSON$1<TNode>;
     hosts: AXNodeViewJSON$1<TNode>[];
     popups: AXNodeViewJSON$1<TNode>[];
@@ -8507,11 +8523,11 @@ type FindCandidatesOptions = {
 }; //#endregion
 //#region src/public/ax-provider.d.ts
 interface AXProvider {
-  makeAXTree<TNode>(flat: AXTreeFlat<TNode>): IAXTreeView<TNode>;
-  describeAXNode<TNode>(tree: IAXTreeView<TNode>, query: ElementDescriptorQuery<IAXNodeView<TNode>>): ResolvedElementDescriptor | undefined;
-  findAXNode<TNode>(nodes: Iterable<IAXNodeView<TNode>>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): CandidateMetric | null;
+  makeAXTree<TNode>(flat: AXTreeFlat<TNode>): Promise<IAXTreeView<TNode>>;
+  describeAXNode<TNode>(tree: IAXTreeView<TNode>, query: ElementDescriptorQuery<IAXNodeView<TNode>>): Promise<ResolvedElementDescriptor | undefined>;
+  findAXNode<TNode>(nodes: Iterable<IAXNodeView<TNode>>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): Promise<CandidateMetric | null>;
   /** Optional: remote providers may not support returning the full ranked candidate list. */
-  findAXNodes?<TNode>(nodes: Iterable<IAXNodeView<TNode>>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): CandidateMetric[];
+  findAXNodes?<TNode>(nodes: Iterable<IAXNodeView<TNode>>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): Promise<CandidateMetric[]>;
 } //#endregion
 //#endregion
 //#region src/scope.d.ts
@@ -9302,6 +9318,10 @@ declare abstract class Handler$1<TAutomator extends Automator, TInstruction exte
     mobile: IAXNodeView<IOSNode> | null;
   }[TAutomator["type"]]>;
   capture(): Promise<Capture | undefined>;
+  /** Best-effort scroll bringing the elements matched by this handler into the viewport, so the
+   *  `after` capture shows them. Call it after the instruction's page reads are done — the scroll
+   *  persists. No-op without `shouldCapture` or off web. */
+  reveal(): Promise<void>;
   before(): Promise<void>;
   after(): Promise<void>;
 }
@@ -10029,7 +10049,7 @@ declare class Runner<TAutomator extends Automator> extends EventTargetNode<Runne
   }>);
   get status(): ProgressStatus;
   constructor(options: RunnerOptions<TAutomator>);
-  run(input: string | Instruction[], options?: RunOptions): Promise<RunResult>;
+  run(input: string | Program$1 | SealedProgram, options?: RunOptions): Promise<RunResult>;
   handle<TInstruction extends Instruction>(instruction: TInstruction, options?: RunOptions): Promise<HandlerResult<TAutomator, TInstruction>>;
   /**
    * Locates an element on the page and returns its node, or `null` when nothing matches.
@@ -10206,9 +10226,9 @@ declare class AXOps<TAutomator extends Automator = Automator> {
   readonly axProvider: AXProvider;
   constructor(automator: TAutomator, axProvider: AXProvider);
   extractTree<TNode = unknown>(): Promise<IAXTreeView<TNode>>;
-  makeTree<TNode>(flat: AXTreeFlat<TNode>): IAXTreeView<TNode>;
-  findCandidate<TNode>(tree: IAXTreeView<TNode>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): CandidateMetric | null;
-  findCandidates<TNode>(tree: IAXTreeView<TNode>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): CandidateMetric[];
+  makeTree<TNode>(flat: AXTreeFlat<TNode>): Promise<IAXTreeView<TNode>>;
+  findCandidate<TNode>(tree: IAXTreeView<TNode>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): Promise<CandidateMetric | null>;
+  findCandidates<TNode>(tree: IAXTreeView<TNode>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): Promise<CandidateMetric[]>;
   /**
    * Search-oriented "find all": ranked candidates matching the descriptor, and — when the
    * descriptor combines a title with a type — the remaining candidates of that type appended
@@ -10217,8 +10237,8 @@ declare class AXOps<TAutomator extends Automator = Automator> {
    * The legacy safety-net type score is disabled: "all buttons" must not include nodes that
    * merely might be buttons.
    */
-  searchCandidates<TNode>(tree: IAXTreeView<TNode>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): CandidateMetric[];
-  describeNode<TNode>(tree: IAXTreeView<TNode>, query: ElementDescriptorQuery<IAXNodeView<TNode>>): ResolvedElementDescriptor | undefined;
+  searchCandidates<TNode>(tree: IAXTreeView<TNode>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): Promise<CandidateMetric[]>;
+  describeNode<TNode>(tree: IAXTreeView<TNode>, query: ElementDescriptorQuery<IAXNodeView<TNode>>): Promise<ResolvedElementDescriptor | undefined>;
   findNode(descriptor: ResolvedElementDescriptor, options: FindNodeOptions): Promise<FindNodeResult<TAutomator>>;
 }
 //#endregion
@@ -10692,12 +10712,33 @@ type DescribeAXNodeResponse = Omit<ResolvedElementDescriptor, 'node'> & {
   nodeIndex?: number;
 };
 declare abstract class RemoteAXProvider implements AXProvider {
-  makeAXTree<TNode>(flat: AXTreeFlat<TNode>): IAXTreeView<TNode>;
-  describeAXNode<TNode>(tree: IAXTreeView<TNode>, query: ElementDescriptorQuery<IAXNodeView<TNode>>): ResolvedElementDescriptor | undefined;
-  findAXNode<TNode>(nodes: Iterable<IAXNodeView<TNode>>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): CandidateMetric | null;
-  protected abstract _rqMakeAXTree<TNode>(flat: AXTreeFlat<TNode>): MakeAXTreeResponse<TNode>;
-  protected abstract _rqDescribeAXNode<TNode>(tree: IAXTreeView<TNode>, query: ElementDescriptorQuery<IAXNodeView<TNode>>): DescribeAXNodeResponse | undefined;
-  protected abstract _rqFindAXNode<TNode>(nodes: IAXNodeView<TNode>[], descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): CandidateMetricResponse | null;
+  makeAXTree<TNode>(flat: AXTreeFlat<TNode>): Promise<IAXTreeView<TNode>>;
+  describeAXNode<TNode>(tree: IAXTreeView<TNode>, query: ElementDescriptorQuery<IAXNodeView<TNode>>): Promise<ResolvedElementDescriptor | undefined>;
+  findAXNode<TNode>(nodes: Iterable<IAXNodeView<TNode>>, descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): Promise<CandidateMetric | null>;
+  protected abstract _rqMakeAXTree<TNode>(flat: AXTreeFlat<TNode>): Promise<MakeAXTreeResponse<TNode>>;
+  protected abstract _rqDescribeAXNode<TNode>(tree: IAXTreeView<TNode>, query: ElementDescriptorQuery<IAXNodeView<TNode>>): Promise<DescribeAXNodeResponse | undefined>;
+  protected abstract _rqFindAXNode<TNode>(nodes: IAXNodeView<TNode>[], descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): Promise<CandidateMetricResponse | null>;
+}
+//#endregion
+//#region src/ax/http-remote-ax-provider.d.ts
+type AXServerRequest = {
+  url: string;
+  method: string;
+  token: string;
+  body: unknown;
+};
+type AXServerFetch = (request: AXServerRequest) => Promise<Response>;
+type HttpRemoteAXProviderOptions = {
+  url: string;
+  getAuthToken: () => string | Promise<string>;
+  fetch?: AXServerFetch;
+};
+declare class HttpRemoteAXProvider extends RemoteAXProvider {
+  #private;
+  constructor(options: HttpRemoteAXProviderOptions);
+  protected _rqMakeAXTree<TNode>(flat: AXTreeFlat<TNode>): Promise<MakeAXTreeResponse<TNode>>;
+  protected _rqDescribeAXNode<TNode>(tree: IAXTreeView<TNode>, query: ElementDescriptorQuery<IAXNodeView<TNode>>): Promise<DescribeAXNodeResponse | undefined>;
+  protected _rqFindAXNode<TNode>(nodes: IAXNodeView<TNode>[], descriptor: ResolvedElementDescriptor, options?: FindCandidatesOptions): Promise<CandidateMetricResponse | null>;
 }
 //#endregion
-export { type AXContentType, type AXControlType, type AXNodeFlat, type AXOption, type AXProvider, type AXState, type AXStructuralType, type AXStyle, type AXTreeFlat, type AXType, AbortError, type AnchorDescriptor, Automator, AutomatorError, BlockingDialog, BodyConsumedError, Browser, BrowserActivePageChangedEvent, BrowserDisconnectedEvent, BrowserPageClosedEvent, BrowserPageCreatedEvent, BrowserPageNavigatedEvent, BrowserStabilizingLoadEvent, BrowserStabilizingNavigationEvent, BrowserStabilizingOutgoingRequestsEvent, BrowserTargetCrashedEvent, BrowserTargetCreatedEvent, BrowserWindowCreatedEvent, CallableRemoteFunctionHandle, CandidateMetricResponse, Connection, Cookie, type CustomActions, Debugger, DebuggerPausedEvent, DebuggerResumedEvent, DescribeAXNodeResponse, type DescriptorStrategy, DialogHandledEvent, type ElementDescriptor, type ElementDescriptorQuery, EvaluationArguments, EvaluationExpression, EvaluationFunction, EvaluationOptions, EvaluationResult, Evaluator, EvaluatorDestroyedEvent, EvaluatorLogEvent, Expression, FilepickerDialog, FlagChangedEvent, Flags, FlagsSnapshot, FlushError, Frame, FrameDestroyedEvent, FrameDocumentRequestEvent, FrameDocumentResponseEvent, FrameEvaluatorAttached, FrameFetchError, FrameFetchOptions, FrameLifecycleEvent, FrameNavigatedEvent, FrameNavigatingEvent, FrameSwappedEvent, FrameSwappingEvent, type Har, HarRecorder, HarRecorderOptions, HarRecorderStatsChangedEvent, HarStats, type IAXNodeView, type IAXTreeView, Injection, InjectionEvaluatorAttachedEvent, InjectionExpression, InjectionIncommingMessageEvent, InjectionOutgoingMessageEvent, InjectionTargetAttachedEvent, Intercepted, InterceptedRequest, InterceptedResponse, InterceptionHandler, InterceptionPattern, InterceptionPatternMatcher, Keyboard, Loader, LoaderRequestEvent, LoaderResponseEvent, LocalizedRemoteValue, MakeAXTreeResponse, Mouse, NavigationFailedError, NavigationTimedOutError, NoHistoryEntryError, Node, type NodeBackground, Port, PortIncommingMessageEvent, type PortMessageEvent, PortOutgoingMessageEvent, RemoteAXProvider, RemoteFunctionHandle, RemoteObjectHandle, type Request, type ResolvedAnchor, type ResolvedElementDescriptor, ResolvedRemoteValue, type Response, RunOptions, RunResult, Runner, RunnerAXNodeFoundEvent, type RunnerContext, RunnerFilepickerDialogRequestedEvent, RunnerOptions, RunnerStatusChangedEvent, Script, type SelectorElementDescriptor, StaleNodeError, StaleRemoteObjectHandleError, StylesheetHandle, Target, TargetActivatedEvent, TargetActivatingEvent, TargetAttachedEvent, TargetChangedEvent, TargetChildTargetCreatingEvent, TargetClosedEvent, TargetDetachedEvent, TargetDialogEvent, TargetElementSelectedEvent, TargetFilepickerDialogEvent, TargetFrameAttachedEvent, TargetFrameTargetCreatedEvent, TargetMainFrameReadyEvent, TargetNavigatedEvent, TargetVisibilityChangeEvent, UnresponsiveTargetError, type UsedValues, WebNode, Window, WindowDestroyedEvent, WindowTargetAttachedEvent, WindowTargetDetachedEvent, flags, isElementAcceptableInvisible, localizeRemoteValue, makeBlockingDialog, makeBrowser, makeBundledExpression, makeBundledScript, makeConnection, makeDebugger, makeEvaluator, makeExpression, makeFilepickerDialog, makeFrame, makeInjection, makeIntercepted, makeInterceptedRequest, makeInterceptedResponse, makeInterceptionPatternMatcher, makeKeyboard, makeLoader, makeMouse, makePort, makeRunner, makeScript, makeTarget, makeWebNode, makeWindow, provideRolldownConfig, index_d_exports as spec, toCDPPattern };
+export { type AXContentType, type AXControlType, type AXNodeFlat, type AXOption, type AXProvider, AXServerFetch, AXServerRequest, type AXState, type AXStructuralType, type AXStyle, type AXTreeFlat, type AXType, AbortError, type AnchorDescriptor, Automator, AutomatorError, BlockingDialog, BodyConsumedError, Browser, BrowserActivePageChangedEvent, BrowserDisconnectedEvent, BrowserPageClosedEvent, BrowserPageCreatedEvent, BrowserPageNavigatedEvent, BrowserStabilizingLoadEvent, BrowserStabilizingNavigationEvent, BrowserStabilizingOutgoingRequestsEvent, BrowserTargetCrashedEvent, BrowserTargetCreatedEvent, BrowserWindowCreatedEvent, CallableRemoteFunctionHandle, CandidateMetricResponse, Connection, Cookie, type CustomActions, Debugger, DebuggerPausedEvent, DebuggerResumedEvent, DescribeAXNodeResponse, type DescriptorStrategy, DialogHandledEvent, type ElementDescriptor, type ElementDescriptorQuery, EvaluationArguments, EvaluationExpression, EvaluationFunction, EvaluationOptions, EvaluationResult, Evaluator, EvaluatorDestroyedEvent, EvaluatorLogEvent, Expression, FilepickerDialog, FlagChangedEvent, Flags, FlagsSnapshot, FlushError, Frame, FrameDestroyedEvent, FrameDocumentRequestEvent, FrameDocumentResponseEvent, FrameEvaluatorAttached, FrameFetchError, FrameFetchOptions, FrameLifecycleEvent, FrameNavigatedEvent, FrameNavigatingEvent, FrameSwappedEvent, FrameSwappingEvent, type Har, HarRecorder, HarRecorderOptions, HarRecorderStatsChangedEvent, HarStats, HttpRemoteAXProvider, HttpRemoteAXProviderOptions, type IAXNodeView, type IAXTreeView, Injection, InjectionEvaluatorAttachedEvent, InjectionExpression, InjectionIncommingMessageEvent, InjectionOutgoingMessageEvent, InjectionTargetAttachedEvent, Intercepted, InterceptedRequest, InterceptedResponse, InterceptionHandler, InterceptionPattern, InterceptionPatternMatcher, Keyboard, Loader, LoaderRequestEvent, LoaderResponseEvent, LocalizedRemoteValue, MakeAXTreeResponse, Mouse, NavigationFailedError, NavigationTimedOutError, NoHistoryEntryError, Node, type NodeBackground, Port, PortIncommingMessageEvent, type PortMessageEvent, PortOutgoingMessageEvent, RemoteAXProvider, RemoteFunctionHandle, RemoteObjectHandle, type Request, type ResolvedAnchor, type ResolvedElementDescriptor, ResolvedRemoteValue, type Response$1 as Response, RunOptions, RunResult, Runner, RunnerAXNodeFoundEvent, type RunnerContext, RunnerFilepickerDialogRequestedEvent, RunnerOptions, RunnerStatusChangedEvent, Script, type SelectorElementDescriptor, StaleNodeError, StaleRemoteObjectHandleError, StylesheetHandle, Target, TargetActivatedEvent, TargetActivatingEvent, TargetAttachedEvent, TargetChangedEvent, TargetChildTargetCreatingEvent, TargetClosedEvent, TargetDetachedEvent, TargetDialogEvent, TargetElementSelectedEvent, TargetFilepickerDialogEvent, TargetFrameAttachedEvent, TargetFrameTargetCreatedEvent, TargetMainFrameReadyEvent, TargetNavigatedEvent, TargetVisibilityChangeEvent, UnresponsiveTargetError, type UsedValues, WebNode, Window, WindowDestroyedEvent, WindowTargetAttachedEvent, WindowTargetDetachedEvent, flags, isElementAcceptableInvisible, localizeRemoteValue, makeBlockingDialog, makeBrowser, makeBundledExpression, makeBundledScript, makeConnection, makeDebugger, makeEvaluator, makeExpression, makeFilepickerDialog, makeFrame, makeInjection, makeIntercepted, makeInterceptedRequest, makeInterceptedResponse, makeInterceptionPatternMatcher, makeKeyboard, makeLoader, makeMouse, makePort, makeRunner, makeScript, makeTarget, makeWebNode, makeWindow, provideRolldownConfig, index_d_exports as spec, toCDPPattern };