@applitools/nlp-web-runner 5.9.1 → 5.10.0

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

@@ -206,24 +206,13 @@ type CreateTargetAction = {
   type: 'create target';
   url?: StringExpression;
 };
-type CloseTargetAction = {
-  type: 'close target';
-};
 type CloseAction = {
   type: 'close';
-  element: ElementDescriptor | DialogDescriptor;
-};
-type SwitchTargetByIndexAction = {
-  type: 'switch target';
-  index: NumberExpression;
-};
-type SwitchTargetByTitleAction = {
-  type: 'switch target';
-  title: StringExpression;
+  element: ElementDescriptor | DialogDescriptor | ChromeTabDescriptor;
 };
-type SwitchTargetByPositionAction = {
-  type: 'switch target';
-  position: SequentialRelativePosition;
+type SwitchAction = {
+  type: 'switch';
+  element: ElementDescriptor | ChromeTabDescriptor;
 };
 type WaitAction = {
   type: 'wait';
@@ -241,7 +230,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 | ClickDialogElementAction | HoverAction | ScrollByDistanceAction | ScrollByFractionAction | ScrollToPositionAction | ScrollToElementAction | ScrollTheElementAction | 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 | CloseAction | SwitchAction | WaitAction | GoAction | FindAction | VisualCheckAction | IntentAction, {
   type: TType;
 }>;
 type Instruction = Action<any> | ControlFlow;
@@ -513,9 +502,27 @@ type DialogElementDescriptor = {
   isDialogElementDescriptor: true;
   title: 'ok' | 'cancel' | 'prompt';
 };
-type ChromeElementDescriptor = {
+type ChromeElementDescriptor = ChromeButtonDescriptor | ChromeTextboxDescriptor | ChromeTabDescriptor | ChromeTablistDescriptor;
+type ChromeButtonDescriptor = {
+  isChromeElementDescriptor: true;
+  type: 'button';
+  title: 'refresh' | 'back' | 'forward';
+};
+type ChromeTextboxDescriptor = {
+  isChromeElementDescriptor: true;
+  type: 'textbox';
+  title: 'url';
+};
+type ChromeTabDescriptor = {
+  isChromeElementDescriptor: true;
+  type: 'tab';
+  index?: NumberExpression;
+  title?: StringExpression;
+  position?: SequentialRelativePosition;
+};
+type ChromeTablistDescriptor = {
   isChromeElementDescriptor: true;
-  title: 'refresh' | 'back' | 'forward' | 'url';
+  type: 'tablist';
 };
 type ViewportDescriptor = {
   isViewportDescriptor: true;
@@ -525,8 +532,8 @@ 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 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';
+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' | 'tablist' | 'tabpanel';
+type ControlType = 'checkboxgroup' | 'checkbox' | 'radiogroup' | 'radio' | 'textbox' | 'combobox' | 'listbox' | 'option' | 'datepicker' | 'timepicker' | 'datetimepicker' | 'colorpicker' | 'filepicker' | 'slider' | 'inputbox' | 'selectbox' | 'valuebox' | 'button' | 'tab' | 'color';
 type ContentType = 'text' | 'link' | 'label' | 'logo' | 'image' | 'icon' | 'video' | 'paragraph';
 type HistoryDirection = 'back' | 'forward';
 type SequentialRelativePosition = 'next' | 'previous';
@@ -9233,8 +9240,20 @@ declare const ErrorCode: {
 };
 type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
 //#endregion
+//#region src/handlers/web/browser-tab.d.ts
+/** A {@link import('@applitools/nlp-parser').ChromeTabDescriptor} after expression evaluation. */
+type ResolvedChromeTabDescriptor = {
+  isChromeElementDescriptor: true;
+  type: 'tab';
+  index?: number;
+  title?: string;
+  position?: 'next' | 'previous';
+};
+/** Activates the browser tab the descriptor points at (the former `switch target` behavior). */
+declare function activateBrowserTab(automator: Browser, descriptor: ResolvedChromeTabDescriptor): Promise<void>;
+//#endregion
 //#region src/utils/evaluate-expression.d.ts
-type EvaluatedExpression<TValue> = TValue extends ExtractOperation ? Any : TValue extends NumberExpression ? number : TValue extends SizeOperation ? number : TValue extends KeysOperation ? string[] : TValue extends ValuesOperation | EntriesOperation ? Any[] : TValue extends Condition ? boolean : TValue extends OTP ? string : TValue extends RandomValue<string> ? string | string[] : TValue extends RandomValue<number> ? number : TValue extends Reference<infer TType extends Any> ? TType : TValue extends JSExpressionReference<infer TType extends Any> ? TType : TValue extends InterpolatedString ? string : TValue extends JSExpression ? string : TValue extends Structure ? Record<string, any> | any[] : TValue extends FileHandle ? string : TValue extends Pattern ? RegExp | Match : TValue extends ChromeElementDescriptor ? ChromeElementDescriptor : TValue extends ElementDescriptor ? ResolvedElementDescriptor : TValue;
+type EvaluatedExpression<TValue> = TValue extends ExtractOperation ? Any : TValue extends NumberExpression ? number : TValue extends SizeOperation ? number : TValue extends KeysOperation ? string[] : TValue extends ValuesOperation | EntriesOperation ? Any[] : TValue extends Condition ? boolean : TValue extends OTP ? string : TValue extends RandomValue<string> ? string | string[] : TValue extends RandomValue<number> ? number : TValue extends Reference<infer TType extends Any> ? TType : TValue extends JSExpressionReference<infer TType extends Any> ? TType : TValue extends InterpolatedString ? string : TValue extends JSExpression ? string : TValue extends Structure ? Record<string, any> | any[] : TValue extends FileHandle ? string : TValue extends Pattern ? RegExp | Match : TValue extends ChromeTabDescriptor ? ResolvedChromeTabDescriptor : TValue extends ChromeElementDescriptor ? ChromeElementDescriptor : TValue extends ElementDescriptor ? ResolvedElementDescriptor : TValue;
 //#endregion
 //#region src/handler.d.ts
 type HandlerOptions<TAutomator extends Automator, TInstruction extends Instruction> = {
@@ -9611,6 +9630,9 @@ declare class ClickHandler$1 extends Handler$1<Browser, Action<'click'>> {
   handle(): Promise<{
     status: "success";
   }>;
+  handleWithChromeTab(descriptor: ResolvedChromeTabDescriptor): Promise<{
+    status: "success";
+  }>;
   handleWithDialogElementDescriptor(descriptor: DialogElementDescriptor): Promise<{
     status: "success";
   }>;
@@ -9666,18 +9688,14 @@ declare class FocusHandler$1 extends Handler$1<Browser, Action<'focus'>> {
   }>;
 }
 //#endregion
-//#region src/handlers/web/close-target.d.ts
-declare class CloseTargetHandler extends Handler$1<Browser, Action<'close target'>> {
-  handle(): Promise<{
-    status: "success";
-  }>;
-}
-//#endregion
 //#region src/handlers/web/close.d.ts
 declare class CloseHandler extends Handler$1<Browser, CloseAction> {
   handle(): Promise<{
     status: "success";
   }>;
+  handleWithChromeTab(descriptor: ResolvedChromeTabDescriptor): Promise<{
+    status: "success";
+  }>;
 }
 //#endregion
 //#region src/handlers/web/create-target.d.ts
@@ -9812,11 +9830,14 @@ declare class SetValueHandler extends Handler$1<Browser, Action<'set value'>> {
   }>;
 }
 //#endregion
-//#region src/handlers/web/switch-target.d.ts
-declare class SwitchTargetHandler extends Handler$1<Browser, Action<'switch target'>> {
+//#region src/handlers/web/switch.d.ts
+declare class SwitchHandler extends Handler$1<Browser, Action<'switch'>> {
   handle(): Promise<{
     status: "success";
   }>;
+  handleWithChromeTab(descriptor: Parameters<typeof activateBrowserTab>[1]): Promise<{
+    status: "success";
+  }>;
 }
 //#endregion
 //#region src/handlers/mobile/check.d.ts
@@ -9878,7 +9899,6 @@ declare const handlers: {
     clear: typeof ClearHandler;
     click: typeof ClickHandler$1;
     close: typeof CloseHandler;
-    'close target': typeof CloseTargetHandler;
     'create target': typeof CreateTargetHandler;
     erase: typeof EraseHandler;
     evaluate: typeof EvaluateHandler;
@@ -9892,7 +9912,7 @@ declare const handlers: {
     scroll: typeof ScrollHandler$1;
     search: typeof SearchHandler;
     'set value': typeof SetValueHandler;
-    'switch target': typeof SwitchTargetHandler;
+    switch: typeof SwitchHandler;
     type: typeof TypeHandler$1;
     'visual check': typeof VisualCheckHandler;
     go: typeof GoHandler;
@@ -9940,9 +9960,8 @@ declare const handlers: {
     "navigate pdf": never;
     refresh: never;
     "create target": never;
-    "close target": never;
     close: never;
-    "switch target": never;
+    switch: never;
     go: never;
   };
 };