@applitools/nlp-web-runner 5.6.1 → 5.7.0

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

@@ -118,7 +118,7 @@ type TypeAction = {
   type: 'type';
   value: AnyExpression | Extractor<ElementDescriptor, any> | Generator$1;
   secret?: boolean;
-  element?: ElementDescriptor | ChromeElementDescriptor;
+  element?: ElementDescriptor | ChromeElementDescriptor | DialogElementDescriptor;
 };
 type SearchAction = {
   type: 'search';
@@ -141,6 +141,10 @@ type ClickChromeElementAction = {
   type: 'click';
   element: ChromeElementDescriptor;
 };
+type ClickDialogElementAction = {
+  type: 'click';
+  element: DialogElementDescriptor;
+};
 type HoverAction = {
   type: 'hover';
   element: ElementDescriptor;
@@ -175,11 +179,6 @@ type ScrollTheElementAction = {
   distance: NumberExpression;
   times?: NumberExpression;
 };
-type AlertAction = {
-  type: 'alert';
-  value: boolean;
-  condition?: ElementCondition;
-};
 type NavigatePdfAction = {
   type: 'navigate pdf';
   page: NumberExpression;
@@ -212,7 +211,7 @@ type CloseTargetAction = {
 };
 type CloseAction = {
   type: 'close';
-  element: ElementDescriptor;
+  element: ElementDescriptor | DialogDescriptor;
 };
 type SwitchTargetByIndexAction = {
   type: 'switch target';
@@ -242,7 +241,7 @@ type IntentAction = {
   type: 'intent';
   description: string;
 };
-type Action<TType extends string> = Extract<EmptyAction | CommentAction | SetVariableAction | SetValueAction | FetchAction | AssertAction | EvaluateAction | FocusAction | CheckAction | ClearAction | EraseAction | TypeAction | HitKeyAction | SearchAction | ClickElementAction | ClickChromeElementAction | HoverAction | ScrollByDistanceAction | ScrollByFractionAction | ScrollToPositionAction | ScrollToElementAction | ScrollTheElementAction | AlertAction | NavigateToUrlAction | NavigateThroughHistoryAction | NavigatePdfAction | RefreshAction | CreateTargetAction | CloseTargetAction | CloseAction | SwitchTargetByIndexAction | SwitchTargetByTitleAction | SwitchTargetByPositionAction | WaitAction | GoAction | FindAction | VisualCheckAction | IntentAction, {
+type Action<TType extends string> = Extract<EmptyAction | CommentAction | SetVariableAction | SetValueAction | FetchAction | AssertAction | EvaluateAction | FocusAction | CheckAction | ClearAction | EraseAction | TypeAction | HitKeyAction | SearchAction | ClickElementAction | ClickChromeElementAction | ClickDialogElementAction | HoverAction | ScrollByDistanceAction | ScrollByFractionAction | ScrollToPositionAction | ScrollToElementAction | ScrollTheElementAction | NavigateToUrlAction | NavigateThroughHistoryAction | NavigatePdfAction | RefreshAction | CreateTargetAction | CloseTargetAction | CloseAction | SwitchTargetByIndexAction | SwitchTargetByTitleAction | SwitchTargetByPositionAction | WaitAction | GoAction | FindAction | VisualCheckAction | IntentAction, {
   type: TType;
 }>;
 type Instruction = Action<any> | ControlFlow;
@@ -504,11 +503,15 @@ type RelativeAnchorDescriptor<TElement = ElementDescriptor> = {
 };
 type AbsoluteAnchorDescriptor<TElement = ElementDescriptor> = {
   position: AbsolutePosition | AbsolutePosition[];
-  element?: TElement | ViewportDescriptor;
+  element?: TElement | ViewportDescriptor | DialogDescriptor;
 };
 type DialogDescriptor = {
   isDialogDescriptor: true;
 };
+type DialogElementDescriptor = {
+  isDialogElementDescriptor: true;
+  title: 'ok' | 'cancel' | 'prompt';
+};
 type ChromeElementDescriptor = {
   isChromeElementDescriptor: true;
   title: 'refresh' | 'back' | 'forward' | 'url';
@@ -520,11 +523,6 @@ type CharacterKey = 'Backquote' | 'Digit1' | 'Digit2' | 'Digit3' | 'Digit4' | 'D
 type ArrowKey = 'ArrowUp' | 'ArrowDown' | 'ArrowLeft' | 'ArrowRight';
 type ControlKey = 'Escape' | 'F1' | 'F2' | 'F3' | 'F4' | 'F5' | 'F6' | 'F7' | 'F8' | 'F9' | 'F10' | 'F11' | 'F12' | 'Backspace' | 'Tab' | 'CapsLock' | 'Enter' | 'ShiftLeft' | 'ShiftRight' | 'ControlLeft' | 'MetaLeft' | 'AltLeft' | 'Space' | 'AltRight' | 'AltGraph' | 'MetaRight' | 'ControlRight' | 'Delete' | 'Home' | 'End' | 'PageUp' | 'PageDown' | 'Insert';
 type Key = ControlKey | ArrowKey | CharacterKey;
-type ElementCondition = {
-  type: ConditionType;
-  element?: ElementDescriptor;
-};
-type ConditionType = 'exists' | 'not-exists' | 'visible' | 'not-visible' | 'clickable';
 type ElementType = StructuralType | ControlType | ContentType;
 type StructuralType = 'app' | 'host' | 'ad' | 'header' | 'footer' | 'sidebar' | 'popup' | 'tooltip' | 'modal' | 'scrollable' | 'form' | 'fieldset' | 'menu' | 'menuitem' | 'hamburger' | 'list' | 'listitem' | 'heading' | 'table' | 'table-cell' | 'table-head-cell' | 'table-row' | 'table-dom-row' | 'table-leaf-row' | 'table-head-row' | 'table-column' | 'table-leaf-column' | 'table-stub-column' | 'card' | 'pdfpage';
 type ControlType = 'checkboxgroup' | 'checkbox' | 'radiogroup' | 'radio' | 'textbox' | 'combobox' | 'listbox' | 'option' | 'datepicker' | 'timepicker' | 'datetimepicker' | 'colorpicker' | 'filepicker' | 'slider' | 'inputbox' | 'selectbox' | 'valuebox' | 'button' | 'color';
@@ -711,6 +709,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;
@@ -773,7 +772,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-DKZ-WCFT.d.ts
 //#region src/port.d.ts
 interface PortMessageEvent<TName extends string = string, TPayload = unknown> extends Event {
   readonly name: TName;
@@ -1241,6 +1240,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<{
@@ -1291,6 +1297,7 @@ type BlockingDialogOptions = {
 };
 declare function makeBlockingDialog(options: BlockingDialogOptions): BlockingDialog;
 declare class BlockingDialog extends EventTargetNode<DialogEventMap> {
+  #private;
   readonly target: Target;
   readonly type: 'alert' | 'confirm' | 'prompt' | 'beforeunload';
   readonly message: string;
@@ -1299,6 +1306,8 @@ declare class BlockingDialog extends EventTargetNode<DialogEventMap> {
     type,
     message
   }: BlockingDialogOptions);
+  /** Whether the dialog was closed programmatically (as opposed to by the user). */
+  get handled(): boolean;
   handle(ok: boolean, text?: string): Promise<void>;
 }
 type FilepickerDialogOptions = {
@@ -1828,7 +1837,14 @@ declare class TargetFrameTargetCreatedEvent extends Event {
 declare class TargetDialogEvent extends Event {
   readonly state: 'opened' | 'closed';
   readonly dialog: BlockingDialog;
-  constructor(state: 'opened' | 'closed', dialog: BlockingDialog);
+  /** Whether the dialog was confirmed (only on `closed`). */
+  readonly result?: boolean;
+  /** The prompt input the dialog was confirmed with (only on `closed`). */
+  readonly value?: string;
+  constructor(state: 'opened' | 'closed', dialog: BlockingDialog, options?: {
+    result?: boolean;
+    value?: string;
+  });
 }
 declare class TargetFilepickerDialogEvent extends Event {
   readonly dialog: FilepickerDialog;
@@ -9183,6 +9199,7 @@ declare const ErrorCode: {
   readonly ELEMENT_NOT_CLEARABLE: "ELEMENT_NOT_CLEARABLE";
   readonly UNHANDLED_DIALOG: "UNHANDLED_DIALOG";
   readonly NO_ELEMENT: "NO_ELEMENT";
+  readonly ILLEGAL_ELEMENT_DESCRIPTOR: "ILLEGAL_ELEMENT_DESCRIPTOR";
   readonly NO_OPTION: "NO_OPTION";
   readonly NO_DIALOG: "NO_DIALOG";
   readonly CONDITION_TIMED_OUT: "CONDITION_TIMED_OUT";
@@ -9310,6 +9327,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>;
 }
@@ -9574,6 +9595,9 @@ declare class ClickHandler$1 extends Handler$1<Browser, Action<'click'>> {
   handle(): Promise<{
     status: "success";
   }>;
+  handleWithDialogElementDescriptor(descriptor: DialogElementDescriptor): Promise<{
+    status: "success";
+  }>;
   handleWithChromeElementDescriptor(descriptor: ChromeElementDescriptor): Promise<{
     status: "success";
   }>;
@@ -9587,6 +9611,9 @@ declare class TypeHandler$1 extends Handler$1<Browser, Action<'type'>> {
   handle(): Promise<{
     status: "success";
   }>;
+  handleWithDialogElementDescriptor(): Promise<{
+    status: "success";
+  }>;
 }
 //#endregion
 //#region src/handlers/web/clear.d.ts
@@ -9726,13 +9753,6 @@ declare class GoHandler extends Handler$1<Browser, Action<'go'>, NavigateResult
   }>;
 }
 //#endregion
-//#region src/handlers/web/handle-dialog.d.ts
-declare class HandleDialogHandler extends Handler$1<Browser, Action<'alert'>> {
-  handle(): Promise<{
-    status: "success";
-  }>;
-}
-//#endregion
 //#region src/handlers/web/hit-key.d.ts
 declare class HitKeyHandler extends Handler$1<Browser, Action<'hit key'>> {
   handle(): Promise<{
@@ -9848,7 +9868,6 @@ declare const handlers: {
     evaluate: typeof EvaluateHandler;
     find: typeof FindHandler$1;
     focus: typeof FocusHandler$1;
-    alert: typeof HandleDialogHandler;
     'hit key': typeof HitKeyHandler;
     hover: typeof HoverHandler;
     navigate: typeof NavigateHandler;
@@ -9901,7 +9920,6 @@ declare const handlers: {
     "hit key": never;
     search: never;
     hover: never;
-    alert: never;
     navigate: never;
     "navigate pdf": never;
     refresh: never;