173 lines
3.8 KiB
TypeScript
173 lines
3.8 KiB
TypeScript
/**
|
|
* Copyright (c) Microsoft Corporation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
type Point = { x: number, y: number };
|
|
|
|
export type ActionName =
|
|
'check' |
|
|
'click' |
|
|
'closePage' |
|
|
'fill' |
|
|
'navigate' |
|
|
'openPage' |
|
|
'press' |
|
|
'select' |
|
|
'uncheck' |
|
|
'setInputFiles' |
|
|
'assertText' |
|
|
'assertValue' |
|
|
'assertChecked' |
|
|
'assertVisible' |
|
|
'assertSnapshot';
|
|
|
|
export type ActionBase = {
|
|
name: ActionName,
|
|
signals: Signal[],
|
|
ariaSnapshot?: string,
|
|
};
|
|
|
|
export type ActionWithSelector = ActionBase & {
|
|
selector: string,
|
|
ref?: string,
|
|
};
|
|
|
|
export type ClickAction = ActionWithSelector & {
|
|
name: 'click',
|
|
button: 'left' | 'middle' | 'right',
|
|
modifiers: number,
|
|
clickCount: number,
|
|
position?: Point,
|
|
};
|
|
|
|
export type CheckAction = ActionWithSelector & {
|
|
name: 'check',
|
|
};
|
|
|
|
export type UncheckAction = ActionWithSelector & {
|
|
name: 'uncheck',
|
|
};
|
|
|
|
export type FillAction = ActionWithSelector & {
|
|
name: 'fill',
|
|
text: string,
|
|
};
|
|
|
|
export type NavigateAction = ActionBase & {
|
|
name: 'navigate',
|
|
url: string,
|
|
};
|
|
|
|
export type OpenPageAction = ActionBase & {
|
|
name: 'openPage',
|
|
url: string,
|
|
};
|
|
|
|
export type ClosesPageAction = ActionBase & {
|
|
name: 'closePage',
|
|
};
|
|
|
|
export type PressAction = ActionWithSelector & {
|
|
name: 'press',
|
|
key: string,
|
|
modifiers: number,
|
|
};
|
|
|
|
export type SelectAction = ActionWithSelector & {
|
|
name: 'select',
|
|
options: string[],
|
|
};
|
|
|
|
export type SetInputFilesAction = ActionWithSelector & {
|
|
name: 'setInputFiles',
|
|
files: string[],
|
|
};
|
|
|
|
export type AssertTextAction = ActionWithSelector & {
|
|
name: 'assertText',
|
|
text: string,
|
|
substring: boolean,
|
|
};
|
|
|
|
export type AssertValueAction = ActionWithSelector & {
|
|
name: 'assertValue',
|
|
value: string,
|
|
};
|
|
|
|
export type AssertCheckedAction = ActionWithSelector & {
|
|
name: 'assertChecked',
|
|
checked: boolean,
|
|
};
|
|
|
|
export type AssertVisibleAction = ActionWithSelector & {
|
|
name: 'assertVisible',
|
|
};
|
|
|
|
export type AssertSnapshotAction = ActionWithSelector & {
|
|
name: 'assertSnapshot',
|
|
ariaSnapshot: string,
|
|
};
|
|
|
|
export type Action = ClickAction | CheckAction | ClosesPageAction | OpenPageAction | UncheckAction | FillAction | NavigateAction | PressAction | SelectAction | SetInputFilesAction | AssertTextAction | AssertValueAction | AssertCheckedAction | AssertVisibleAction | AssertSnapshotAction;
|
|
export type AssertAction = AssertCheckedAction | AssertValueAction | AssertTextAction | AssertVisibleAction | AssertSnapshotAction;
|
|
export type PerformOnRecordAction = ClickAction | CheckAction | UncheckAction | PressAction | SelectAction;
|
|
|
|
// Signals.
|
|
|
|
export type BaseSignal = {
|
|
};
|
|
|
|
export type NavigationSignal = BaseSignal & {
|
|
name: 'navigation',
|
|
url: string,
|
|
};
|
|
|
|
export type PopupSignal = BaseSignal & {
|
|
name: 'popup',
|
|
popupAlias: string,
|
|
};
|
|
|
|
export type DownloadSignal = BaseSignal & {
|
|
name: 'download',
|
|
downloadAlias: string,
|
|
};
|
|
|
|
export type DialogSignal = BaseSignal & {
|
|
name: 'dialog',
|
|
dialogAlias: string,
|
|
};
|
|
|
|
export type Signal = NavigationSignal | PopupSignal | DownloadSignal | DialogSignal;
|
|
|
|
export type FrameDescription = {
|
|
pageGuid: string;
|
|
pageAlias: string;
|
|
framePath: string[];
|
|
};
|
|
|
|
export type ActionInContext = {
|
|
frame: FrameDescription;
|
|
description?: string;
|
|
action: Action;
|
|
startTime: number;
|
|
endTime?: number;
|
|
};
|
|
|
|
export type SignalInContext = {
|
|
frame: FrameDescription;
|
|
signal: Signal;
|
|
timestamp: number;
|
|
};
|