doc-detective-common 4.24.0 → 4.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +2272 -242
- package/dist/schemas/schemas.json +2272 -242
- package/dist/types/generated/record_v3.d.ts +38 -5
- package/dist/types/generated/record_v3.d.ts.map +1 -1
- package/dist/types/generated/step_v3.d.ts +106 -73
- package/dist/types/generated/step_v3.d.ts.map +1 -1
- package/dist/types/generated/test_v3.d.ts +266 -200
- package/dist/types/generated/test_v3.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Do not edit manually
|
|
4
4
|
*/
|
|
5
5
|
/**
|
|
6
|
-
* Start recording. Must be followed by a `stopRecord` step. The `browser` engine captures the Chrome viewport (works under concurrency); the `ffmpeg` engine captures the screen and supports any application. Supported extensions: [ '.mp4', '.webm', '.gif' ]
|
|
6
|
+
* Start recording. Must be followed by a `stopRecord` step. The `browser` engine captures the Chrome viewport (works under concurrency); the `ffmpeg` engine captures the screen and supports any application. On Android/iOS contexts, recording captures the device screen through the device itself — `engine` doesn't apply. Supported extensions: [ '.mp4', '.webm', '.gif' ]
|
|
7
7
|
*/
|
|
8
8
|
export type Record = RecordSimple | RecordDetailed | RecordBoolean;
|
|
9
9
|
/**
|
|
@@ -38,6 +38,18 @@ export type ByIndex1 = number;
|
|
|
38
38
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
39
39
|
*/
|
|
40
40
|
export type ByName1 = string;
|
|
41
|
+
/**
|
|
42
|
+
* Which app window to act on. Omit to use the active window. Apps have windows, no tabs.
|
|
43
|
+
*/
|
|
44
|
+
export type AppWindowSelector = ByIndex2 | ByName2 | ByCriteria2;
|
|
45
|
+
/**
|
|
46
|
+
* Index in creation order. Negative counts from the end; `-1` is the newest (e.g. a dialog the app just opened).
|
|
47
|
+
*/
|
|
48
|
+
export type ByIndex2 = number;
|
|
49
|
+
/**
|
|
50
|
+
* Assigned window name. The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
51
|
+
*/
|
|
52
|
+
export type ByName2 = string;
|
|
41
53
|
/**
|
|
42
54
|
* Recording engine to use. Either a string shorthand selecting the engine with defaults, or an object for full control. If unset, defaults to the `browser` engine when a visible Chrome context is available and to `ffmpeg` otherwise.
|
|
43
55
|
*/
|
|
@@ -47,14 +59,14 @@ export type RecordingEngine = RecordingEngineSimple | RecordingEngineDetailed;
|
|
|
47
59
|
*/
|
|
48
60
|
export type RecordingEngineSimple = "browser" | "ffmpeg";
|
|
49
61
|
/**
|
|
50
|
-
* If `true`, starts recording — auto-selecting the `browser` engine for a visible Chrome context and the `ffmpeg` engine otherwise. If `false`, doesn't record.
|
|
62
|
+
* If `true`, starts recording — auto-selecting the `browser` engine for a visible Chrome context, the device screen on Android/iOS contexts, and the `ffmpeg` engine otherwise. If `false`, doesn't record.
|
|
51
63
|
*/
|
|
52
64
|
export type RecordBoolean = boolean;
|
|
53
65
|
export interface RecordDetailed {
|
|
54
66
|
/**
|
|
55
|
-
* The browser window/tab to record. Omit to record the active
|
|
67
|
+
* The browser window/tab or app window to record. Omit to record the active surface. The targeted surface stays focused afterward. App surfaces use the object form ({ "app": … }) and are captured via the `ffmpeg` engine, cropped to the app window by default.
|
|
56
68
|
*/
|
|
57
|
-
surface?: SurfaceByBrowserEngine | BrowserSurface;
|
|
69
|
+
surface?: SurfaceByBrowserEngine | BrowserSurface | AppSurface;
|
|
58
70
|
/**
|
|
59
71
|
* File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`.
|
|
60
72
|
*/
|
|
@@ -122,13 +134,34 @@ export interface ByCriteria1 {
|
|
|
122
134
|
*/
|
|
123
135
|
url?: string;
|
|
124
136
|
}
|
|
137
|
+
export interface AppSurface {
|
|
138
|
+
/**
|
|
139
|
+
* Name of an app surface opened by `startSurface` (its `name`, or the default derived from the app identifier).
|
|
140
|
+
*/
|
|
141
|
+
app: string;
|
|
142
|
+
window?: AppWindowSelector;
|
|
143
|
+
}
|
|
144
|
+
export interface ByCriteria2 {
|
|
145
|
+
/**
|
|
146
|
+
* Assigned window name.
|
|
147
|
+
*/
|
|
148
|
+
name?: string;
|
|
149
|
+
/**
|
|
150
|
+
* Index in creation order. Negative counts from the end.
|
|
151
|
+
*/
|
|
152
|
+
index?: number;
|
|
153
|
+
/**
|
|
154
|
+
* Window title to match. Substring, or /regex/.
|
|
155
|
+
*/
|
|
156
|
+
title?: string;
|
|
157
|
+
}
|
|
125
158
|
export interface RecordingEngineDetailed {
|
|
126
159
|
/**
|
|
127
160
|
* Recording engine. `browser` records the Chrome viewport (concurrency-safe); `ffmpeg` records the screen and supports any application.
|
|
128
161
|
*/
|
|
129
162
|
name: "browser" | "ffmpeg";
|
|
130
163
|
/**
|
|
131
|
-
* What the `ffmpeg` engine captures. `display` records the full screen, `window` the active window, `viewport` the browser content area. Ignored by the `browser` engine, which always captures its tab. `window` and `viewport` are best-effort (captured full-screen, then cropped).
|
|
164
|
+
* What the `ffmpeg` engine captures. `display` records the full screen, `window` the active window, `viewport` the browser content area. Ignored by the `browser` engine, which always captures its tab. `window` and `viewport` are best-effort (captured full-screen, then cropped). If unset, defaults to `window` when the recording's `surface` is an app surface and to `display` otherwise. `viewport` doesn't apply to app surfaces (they have no browser viewport).
|
|
132
165
|
*/
|
|
133
166
|
target?: "display" | "window" | "viewport";
|
|
134
167
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"record_v3.d.ts","sourceRoot":"","sources":["../../../src/types/generated/record_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,aAAa,CAAC;AACnE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;AACzF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;AAC9D;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAC5B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC;AAClE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,uBAAuB,CAAC;AAC9E;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,QAAQ,CAAC;AACzD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC;AAEpC,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,GAAG,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"record_v3.d.ts","sourceRoot":"","sources":["../../../src/types/generated/record_v3.ts"],"names":[],"mappings":"AACA;;;GAGG;AAEH;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG,cAAc,GAAG,aAAa,CAAC;AACnE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;AACzF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;AAC9D;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAC5B;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC;AAClE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,OAAO,GAAG,WAAW,CAAC;AACjE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC9B;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,uBAAuB,CAAC;AAC9E;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,SAAS,GAAG,QAAQ,CAAC;AACzD;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC;AAEpC,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,GAAG,cAAc,GAAG,UAAU,CAAC;IAC/D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC7D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,GAAG,CAAC,EAAE,kBAAkB,CAAC;CAC1B;AACD,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AACD,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AACD,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AACD,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAC;IAC3C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd"}
|
|
@@ -775,7 +775,7 @@ export type Routing47 = {
|
|
|
775
775
|
[k: string]: unknown;
|
|
776
776
|
};
|
|
777
777
|
/**
|
|
778
|
-
* Start recording. Must be followed by a `stopRecord` step. The `browser` engine captures the Chrome viewport (works under concurrency); the `ffmpeg` engine captures the screen and supports any application. Supported extensions: [ '.mp4', '.webm', '.gif' ]
|
|
778
|
+
* Start recording. Must be followed by a `stopRecord` step. The `browser` engine captures the Chrome viewport (works under concurrency); the `ffmpeg` engine captures the screen and supports any application. On Android/iOS contexts, recording captures the device screen through the device itself — `engine` doesn't apply. Supported extensions: [ '.mp4', '.webm', '.gif' ]
|
|
779
779
|
*/
|
|
780
780
|
export type Record1 = RecordSimple | RecordDetailed | RecordBoolean;
|
|
781
781
|
/**
|
|
@@ -810,6 +810,18 @@ export type ByIndex11 = number;
|
|
|
810
810
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
811
811
|
*/
|
|
812
812
|
export type ByName11 = string;
|
|
813
|
+
/**
|
|
814
|
+
* Which app window to act on. Omit to use the active window. Apps have windows, no tabs.
|
|
815
|
+
*/
|
|
816
|
+
export type AppWindowSelector2 = ByIndex12 | ByName12 | ByCriteria12;
|
|
817
|
+
/**
|
|
818
|
+
* Index in creation order. Negative counts from the end; `-1` is the newest (e.g. a dialog the app just opened).
|
|
819
|
+
*/
|
|
820
|
+
export type ByIndex12 = number;
|
|
821
|
+
/**
|
|
822
|
+
* Assigned window name. The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
823
|
+
*/
|
|
824
|
+
export type ByName12 = string;
|
|
813
825
|
/**
|
|
814
826
|
* Recording engine to use. Either a string shorthand selecting the engine with defaults, or an object for full control. If unset, defaults to the `browser` engine when a visible Chrome context is available and to `ffmpeg` otherwise.
|
|
815
827
|
*/
|
|
@@ -819,7 +831,7 @@ export type RecordingEngine = RecordingEngineSimple | RecordingEngineDetailed;
|
|
|
819
831
|
*/
|
|
820
832
|
export type RecordingEngineSimple = "browser" | "ffmpeg";
|
|
821
833
|
/**
|
|
822
|
-
* If `true`, starts recording — auto-selecting the `browser` engine for a visible Chrome context and the `ffmpeg` engine otherwise. If `false`, doesn't record.
|
|
834
|
+
* If `true`, starts recording — auto-selecting the `browser` engine for a visible Chrome context, the device screen on Android/iOS contexts, and the `ffmpeg` engine otherwise. If `false`, doesn't record.
|
|
823
835
|
*/
|
|
824
836
|
export type RecordBoolean = boolean;
|
|
825
837
|
/**
|
|
@@ -909,7 +921,7 @@ export type CloseSurface1 = Surface1 | [Surface2, ...Surface2[]];
|
|
|
909
921
|
/**
|
|
910
922
|
* The surface a step acts on. Omit to act on the active surface. Supports background processes, browser windows/tabs, and native app windows.
|
|
911
923
|
*/
|
|
912
|
-
export type Surface1 = SurfaceByName1 | ProcessSurface1 | BrowserSurface5 |
|
|
924
|
+
export type Surface1 = SurfaceByName1 | ProcessSurface1 | BrowserSurface5 | AppSurface3;
|
|
913
925
|
/**
|
|
914
926
|
* Name of the surface. A browser engine keyword (chrome|firefox|safari|webkit|edge) targets that browser; any other string names a background process. To target a browser window or tab, use the object form ({ "browser": …, "window": …, "tab": … }) — a plain string is never a window/tab name.
|
|
915
927
|
*/
|
|
@@ -917,43 +929,43 @@ export type SurfaceByName1 = string;
|
|
|
917
929
|
/**
|
|
918
930
|
* Which window to act on. Omit to use the active window.
|
|
919
931
|
*/
|
|
920
|
-
export type WindowTabSelector10 =
|
|
932
|
+
export type WindowTabSelector10 = ByIndex13 | ByName13 | ByCriteria13;
|
|
921
933
|
/**
|
|
922
934
|
* Index in creation order. Negative counts from the end; `-1` is the newest.
|
|
923
935
|
*/
|
|
924
|
-
export type
|
|
936
|
+
export type ByIndex13 = number;
|
|
925
937
|
/**
|
|
926
938
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
927
939
|
*/
|
|
928
|
-
export type
|
|
940
|
+
export type ByName13 = string;
|
|
929
941
|
/**
|
|
930
942
|
* Which tab to act on. Omit to use the active tab. Without `window`, the selector searches every tab in creation order — including tabs the page opened itself.
|
|
931
943
|
*/
|
|
932
|
-
export type WindowTabSelector11 =
|
|
944
|
+
export type WindowTabSelector11 = ByIndex14 | ByName14 | ByCriteria14;
|
|
933
945
|
/**
|
|
934
946
|
* Index in creation order. Negative counts from the end; `-1` is the newest.
|
|
935
947
|
*/
|
|
936
|
-
export type
|
|
948
|
+
export type ByIndex14 = number;
|
|
937
949
|
/**
|
|
938
950
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
939
951
|
*/
|
|
940
|
-
export type
|
|
952
|
+
export type ByName14 = string;
|
|
941
953
|
/**
|
|
942
954
|
* Which app window to act on. Omit to use the active window. Apps have windows, no tabs.
|
|
943
955
|
*/
|
|
944
|
-
export type
|
|
956
|
+
export type AppWindowSelector3 = ByIndex15 | ByName15 | ByCriteria15;
|
|
945
957
|
/**
|
|
946
958
|
* Index in creation order. Negative counts from the end; `-1` is the newest (e.g. a dialog the app just opened).
|
|
947
959
|
*/
|
|
948
|
-
export type
|
|
960
|
+
export type ByIndex15 = number;
|
|
949
961
|
/**
|
|
950
962
|
* Assigned window name. The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
951
963
|
*/
|
|
952
|
-
export type
|
|
964
|
+
export type ByName15 = string;
|
|
953
965
|
/**
|
|
954
966
|
* The surface a step acts on. Omit to act on the active surface. Supports background processes, browser windows/tabs, and native app windows.
|
|
955
967
|
*/
|
|
956
|
-
export type Surface2 = SurfaceByName2 | ProcessSurface2 | BrowserSurface6 |
|
|
968
|
+
export type Surface2 = SurfaceByName2 | ProcessSurface2 | BrowserSurface6 | AppSurface4;
|
|
957
969
|
/**
|
|
958
970
|
* Name of the surface. A browser engine keyword (chrome|firefox|safari|webkit|edge) targets that browser; any other string names a background process. To target a browser window or tab, use the object form ({ "browser": …, "window": …, "tab": … }) — a plain string is never a window/tab name.
|
|
959
971
|
*/
|
|
@@ -961,39 +973,39 @@ export type SurfaceByName2 = string;
|
|
|
961
973
|
/**
|
|
962
974
|
* Which window to act on. Omit to use the active window.
|
|
963
975
|
*/
|
|
964
|
-
export type WindowTabSelector12 =
|
|
976
|
+
export type WindowTabSelector12 = ByIndex16 | ByName16 | ByCriteria16;
|
|
965
977
|
/**
|
|
966
978
|
* Index in creation order. Negative counts from the end; `-1` is the newest.
|
|
967
979
|
*/
|
|
968
|
-
export type
|
|
980
|
+
export type ByIndex16 = number;
|
|
969
981
|
/**
|
|
970
982
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
971
983
|
*/
|
|
972
|
-
export type
|
|
984
|
+
export type ByName16 = string;
|
|
973
985
|
/**
|
|
974
986
|
* Which tab to act on. Omit to use the active tab. Without `window`, the selector searches every tab in creation order — including tabs the page opened itself.
|
|
975
987
|
*/
|
|
976
|
-
export type WindowTabSelector13 =
|
|
988
|
+
export type WindowTabSelector13 = ByIndex17 | ByName17 | ByCriteria17;
|
|
977
989
|
/**
|
|
978
990
|
* Index in creation order. Negative counts from the end; `-1` is the newest.
|
|
979
991
|
*/
|
|
980
|
-
export type
|
|
992
|
+
export type ByIndex17 = number;
|
|
981
993
|
/**
|
|
982
994
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
983
995
|
*/
|
|
984
|
-
export type
|
|
996
|
+
export type ByName17 = string;
|
|
985
997
|
/**
|
|
986
998
|
* Which app window to act on. Omit to use the active window. Apps have windows, no tabs.
|
|
987
999
|
*/
|
|
988
|
-
export type
|
|
1000
|
+
export type AppWindowSelector4 = ByIndex18 | ByName18 | ByCriteria18;
|
|
989
1001
|
/**
|
|
990
1002
|
* Index in creation order. Negative counts from the end; `-1` is the newest (e.g. a dialog the app just opened).
|
|
991
1003
|
*/
|
|
992
|
-
export type
|
|
1004
|
+
export type ByIndex18 = number;
|
|
993
1005
|
/**
|
|
994
1006
|
* Assigned window name. The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
995
1007
|
*/
|
|
996
|
-
export type
|
|
1008
|
+
export type ByName18 = string;
|
|
997
1009
|
/**
|
|
998
1010
|
* A condition expression, or an array of expressions combined with logical AND.
|
|
999
1011
|
*/
|
|
@@ -1122,27 +1134,27 @@ export type SurfaceByBrowserEngine4 = "chrome" | "firefox" | "safari" | "webkit"
|
|
|
1122
1134
|
/**
|
|
1123
1135
|
* Which window to act on. Omit to use the active window.
|
|
1124
1136
|
*/
|
|
1125
|
-
export type WindowTabSelector14 =
|
|
1137
|
+
export type WindowTabSelector14 = ByIndex19 | ByName19 | ByCriteria19;
|
|
1126
1138
|
/**
|
|
1127
1139
|
* Index in creation order. Negative counts from the end; `-1` is the newest.
|
|
1128
1140
|
*/
|
|
1129
|
-
export type
|
|
1141
|
+
export type ByIndex19 = number;
|
|
1130
1142
|
/**
|
|
1131
1143
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
1132
1144
|
*/
|
|
1133
|
-
export type
|
|
1145
|
+
export type ByName19 = string;
|
|
1134
1146
|
/**
|
|
1135
1147
|
* Which tab to act on. Omit to use the active tab. Without `window`, the selector searches every tab in creation order — including tabs the page opened itself.
|
|
1136
1148
|
*/
|
|
1137
|
-
export type WindowTabSelector15 =
|
|
1149
|
+
export type WindowTabSelector15 = ByIndex20 | ByName20 | ByCriteria20;
|
|
1138
1150
|
/**
|
|
1139
1151
|
* Index in creation order. Negative counts from the end; `-1` is the newest.
|
|
1140
1152
|
*/
|
|
1141
|
-
export type
|
|
1153
|
+
export type ByIndex20 = number;
|
|
1142
1154
|
/**
|
|
1143
1155
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
1144
1156
|
*/
|
|
1145
|
-
export type
|
|
1157
|
+
export type ByName20 = string;
|
|
1146
1158
|
/**
|
|
1147
1159
|
* A condition expression, or an array of expressions combined with logical AND.
|
|
1148
1160
|
*/
|
|
@@ -1237,39 +1249,39 @@ export type SurfaceByBrowserEngine5 = "chrome" | "firefox" | "safari" | "webkit"
|
|
|
1237
1249
|
/**
|
|
1238
1250
|
* Which window to act on. Omit to use the active window.
|
|
1239
1251
|
*/
|
|
1240
|
-
export type WindowTabSelector16 =
|
|
1252
|
+
export type WindowTabSelector16 = ByIndex21 | ByName21 | ByCriteria21;
|
|
1241
1253
|
/**
|
|
1242
1254
|
* Index in creation order. Negative counts from the end; `-1` is the newest.
|
|
1243
1255
|
*/
|
|
1244
|
-
export type
|
|
1256
|
+
export type ByIndex21 = number;
|
|
1245
1257
|
/**
|
|
1246
1258
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
1247
1259
|
*/
|
|
1248
|
-
export type
|
|
1260
|
+
export type ByName21 = string;
|
|
1249
1261
|
/**
|
|
1250
1262
|
* Which tab to act on. Omit to use the active tab. Without `window`, the selector searches every tab in creation order — including tabs the page opened itself.
|
|
1251
1263
|
*/
|
|
1252
|
-
export type WindowTabSelector17 =
|
|
1264
|
+
export type WindowTabSelector17 = ByIndex22 | ByName22 | ByCriteria22;
|
|
1253
1265
|
/**
|
|
1254
1266
|
* Index in creation order. Negative counts from the end; `-1` is the newest.
|
|
1255
1267
|
*/
|
|
1256
|
-
export type
|
|
1268
|
+
export type ByIndex22 = number;
|
|
1257
1269
|
/**
|
|
1258
1270
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
1259
1271
|
*/
|
|
1260
|
-
export type
|
|
1272
|
+
export type ByName22 = string;
|
|
1261
1273
|
/**
|
|
1262
1274
|
* Which app window to act on. Omit to use the active window. Apps have windows, no tabs.
|
|
1263
1275
|
*/
|
|
1264
|
-
export type
|
|
1276
|
+
export type AppWindowSelector5 = ByIndex23 | ByName23 | ByCriteria23;
|
|
1265
1277
|
/**
|
|
1266
1278
|
* Index in creation order. Negative counts from the end; `-1` is the newest (e.g. a dialog the app just opened).
|
|
1267
1279
|
*/
|
|
1268
|
-
export type
|
|
1280
|
+
export type ByIndex23 = number;
|
|
1269
1281
|
/**
|
|
1270
1282
|
* Assigned window name. The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
1271
1283
|
*/
|
|
1272
|
-
export type
|
|
1284
|
+
export type ByName23 = string;
|
|
1273
1285
|
/**
|
|
1274
1286
|
* Browser engine keyword. Targets that browser. Steps that can only ever act on a browser (not a background process) restrict the bare-string form to this enum, so a process name here is rejected at validation time instead of failing at runtime.
|
|
1275
1287
|
*/
|
|
@@ -1277,39 +1289,39 @@ export type SurfaceByBrowserEngine6 = "chrome" | "firefox" | "safari" | "webkit"
|
|
|
1277
1289
|
/**
|
|
1278
1290
|
* Which window to act on. Omit to use the active window.
|
|
1279
1291
|
*/
|
|
1280
|
-
export type WindowTabSelector18 =
|
|
1292
|
+
export type WindowTabSelector18 = ByIndex24 | ByName24 | ByCriteria24;
|
|
1281
1293
|
/**
|
|
1282
1294
|
* Index in creation order. Negative counts from the end; `-1` is the newest.
|
|
1283
1295
|
*/
|
|
1284
|
-
export type
|
|
1296
|
+
export type ByIndex24 = number;
|
|
1285
1297
|
/**
|
|
1286
1298
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
1287
1299
|
*/
|
|
1288
|
-
export type
|
|
1300
|
+
export type ByName24 = string;
|
|
1289
1301
|
/**
|
|
1290
1302
|
* Which tab to act on. Omit to use the active tab. Without `window`, the selector searches every tab in creation order — including tabs the page opened itself.
|
|
1291
1303
|
*/
|
|
1292
|
-
export type WindowTabSelector19 =
|
|
1304
|
+
export type WindowTabSelector19 = ByIndex25 | ByName25 | ByCriteria25;
|
|
1293
1305
|
/**
|
|
1294
1306
|
* Index in creation order. Negative counts from the end; `-1` is the newest.
|
|
1295
1307
|
*/
|
|
1296
|
-
export type
|
|
1308
|
+
export type ByIndex25 = number;
|
|
1297
1309
|
/**
|
|
1298
1310
|
* Name assigned when the window/tab was opened (goTo `newTab`/`newWindow`). The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
1299
1311
|
*/
|
|
1300
|
-
export type
|
|
1312
|
+
export type ByName25 = string;
|
|
1301
1313
|
/**
|
|
1302
1314
|
* Which app window to act on. Omit to use the active window. Apps have windows, no tabs.
|
|
1303
1315
|
*/
|
|
1304
|
-
export type
|
|
1316
|
+
export type AppWindowSelector6 = ByIndex26 | ByName26 | ByCriteria26;
|
|
1305
1317
|
/**
|
|
1306
1318
|
* Index in creation order. Negative counts from the end; `-1` is the newest (e.g. a dialog the app just opened).
|
|
1307
1319
|
*/
|
|
1308
|
-
export type
|
|
1320
|
+
export type ByIndex26 = number;
|
|
1309
1321
|
/**
|
|
1310
1322
|
* Assigned window name. The integer branch is listed first because Ajv validates with coerceTypes — string-first would coerce integer indexes into name strings.
|
|
1311
1323
|
*/
|
|
1312
|
-
export type
|
|
1324
|
+
export type ByName26 = string;
|
|
1313
1325
|
/**
|
|
1314
1326
|
* A condition expression, or an array of expressions combined with logical AND.
|
|
1315
1327
|
*/
|
|
@@ -3571,9 +3583,9 @@ export interface Record {
|
|
|
3571
3583
|
}
|
|
3572
3584
|
export interface RecordDetailed {
|
|
3573
3585
|
/**
|
|
3574
|
-
* The browser window/tab to record. Omit to record the active
|
|
3586
|
+
* The browser window/tab or app window to record. Omit to record the active surface. The targeted surface stays focused afterward. App surfaces use the object form ({ "app": … }) and are captured via the `ffmpeg` engine, cropped to the app window by default.
|
|
3575
3587
|
*/
|
|
3576
|
-
surface?: SurfaceByBrowserEngine3 | BrowserSurface4;
|
|
3588
|
+
surface?: SurfaceByBrowserEngine3 | BrowserSurface4 | AppSurface2;
|
|
3577
3589
|
/**
|
|
3578
3590
|
* File path of the recording. Supports the `.mp4`, `.webm`, and `.gif` extensions. If not specified, the file name is the ID of the step, and the extension is `.mp4`.
|
|
3579
3591
|
*/
|
|
@@ -3641,13 +3653,34 @@ export interface ByCriteria11 {
|
|
|
3641
3653
|
*/
|
|
3642
3654
|
url?: string;
|
|
3643
3655
|
}
|
|
3656
|
+
export interface AppSurface2 {
|
|
3657
|
+
/**
|
|
3658
|
+
* Name of an app surface opened by `startSurface` (its `name`, or the default derived from the app identifier).
|
|
3659
|
+
*/
|
|
3660
|
+
app: string;
|
|
3661
|
+
window?: AppWindowSelector2;
|
|
3662
|
+
}
|
|
3663
|
+
export interface ByCriteria12 {
|
|
3664
|
+
/**
|
|
3665
|
+
* Assigned window name.
|
|
3666
|
+
*/
|
|
3667
|
+
name?: string;
|
|
3668
|
+
/**
|
|
3669
|
+
* Index in creation order. Negative counts from the end.
|
|
3670
|
+
*/
|
|
3671
|
+
index?: number;
|
|
3672
|
+
/**
|
|
3673
|
+
* Window title to match. Substring, or /regex/.
|
|
3674
|
+
*/
|
|
3675
|
+
title?: string;
|
|
3676
|
+
}
|
|
3644
3677
|
export interface RecordingEngineDetailed {
|
|
3645
3678
|
/**
|
|
3646
3679
|
* Recording engine. `browser` records the Chrome viewport (concurrency-safe); `ffmpeg` records the screen and supports any application.
|
|
3647
3680
|
*/
|
|
3648
3681
|
name: "browser" | "ffmpeg";
|
|
3649
3682
|
/**
|
|
3650
|
-
* What the `ffmpeg` engine captures. `display` records the full screen, `window` the active window, `viewport` the browser content area. Ignored by the `browser` engine, which always captures its tab. `window` and `viewport` are best-effort (captured full-screen, then cropped).
|
|
3683
|
+
* What the `ffmpeg` engine captures. `display` records the full screen, `window` the active window, `viewport` the browser content area. Ignored by the `browser` engine, which always captures its tab. `window` and `viewport` are best-effort (captured full-screen, then cropped). If unset, defaults to `window` when the recording's `surface` is an app surface and to `display` otherwise. `viewport` doesn't apply to app surfaces (they have no browser viewport).
|
|
3651
3684
|
*/
|
|
3652
3685
|
target?: "display" | "window" | "viewport";
|
|
3653
3686
|
/**
|
|
@@ -3953,7 +3986,7 @@ export interface BrowserSurface5 {
|
|
|
3953
3986
|
window?: WindowTabSelector10;
|
|
3954
3987
|
tab?: WindowTabSelector11;
|
|
3955
3988
|
}
|
|
3956
|
-
export interface
|
|
3989
|
+
export interface ByCriteria13 {
|
|
3957
3990
|
/**
|
|
3958
3991
|
* Name assigned when the window/tab was opened.
|
|
3959
3992
|
*/
|
|
@@ -3971,7 +4004,7 @@ export interface ByCriteria12 {
|
|
|
3971
4004
|
*/
|
|
3972
4005
|
url?: string;
|
|
3973
4006
|
}
|
|
3974
|
-
export interface
|
|
4007
|
+
export interface ByCriteria14 {
|
|
3975
4008
|
/**
|
|
3976
4009
|
* Name assigned when the window/tab was opened.
|
|
3977
4010
|
*/
|
|
@@ -3989,14 +4022,14 @@ export interface ByCriteria13 {
|
|
|
3989
4022
|
*/
|
|
3990
4023
|
url?: string;
|
|
3991
4024
|
}
|
|
3992
|
-
export interface
|
|
4025
|
+
export interface AppSurface3 {
|
|
3993
4026
|
/**
|
|
3994
4027
|
* Name of an app surface opened by `startSurface` (its `name`, or the default derived from the app identifier).
|
|
3995
4028
|
*/
|
|
3996
4029
|
app: string;
|
|
3997
|
-
window?:
|
|
4030
|
+
window?: AppWindowSelector3;
|
|
3998
4031
|
}
|
|
3999
|
-
export interface
|
|
4032
|
+
export interface ByCriteria15 {
|
|
4000
4033
|
/**
|
|
4001
4034
|
* Assigned window name.
|
|
4002
4035
|
*/
|
|
@@ -4028,7 +4061,7 @@ export interface BrowserSurface6 {
|
|
|
4028
4061
|
window?: WindowTabSelector12;
|
|
4029
4062
|
tab?: WindowTabSelector13;
|
|
4030
4063
|
}
|
|
4031
|
-
export interface
|
|
4064
|
+
export interface ByCriteria16 {
|
|
4032
4065
|
/**
|
|
4033
4066
|
* Name assigned when the window/tab was opened.
|
|
4034
4067
|
*/
|
|
@@ -4046,7 +4079,7 @@ export interface ByCriteria15 {
|
|
|
4046
4079
|
*/
|
|
4047
4080
|
url?: string;
|
|
4048
4081
|
}
|
|
4049
|
-
export interface
|
|
4082
|
+
export interface ByCriteria17 {
|
|
4050
4083
|
/**
|
|
4051
4084
|
* Name assigned when the window/tab was opened.
|
|
4052
4085
|
*/
|
|
@@ -4064,14 +4097,14 @@ export interface ByCriteria16 {
|
|
|
4064
4097
|
*/
|
|
4065
4098
|
url?: string;
|
|
4066
4099
|
}
|
|
4067
|
-
export interface
|
|
4100
|
+
export interface AppSurface4 {
|
|
4068
4101
|
/**
|
|
4069
4102
|
* Name of an app surface opened by `startSurface` (its `name`, or the default derived from the app identifier).
|
|
4070
4103
|
*/
|
|
4071
4104
|
app: string;
|
|
4072
|
-
window?:
|
|
4105
|
+
window?: AppWindowSelector4;
|
|
4073
4106
|
}
|
|
4074
|
-
export interface
|
|
4107
|
+
export interface ByCriteria18 {
|
|
4075
4108
|
/**
|
|
4076
4109
|
* Assigned window name.
|
|
4077
4110
|
*/
|
|
@@ -4628,7 +4661,7 @@ export interface BrowserSurface7 {
|
|
|
4628
4661
|
window?: WindowTabSelector14;
|
|
4629
4662
|
tab?: WindowTabSelector15;
|
|
4630
4663
|
}
|
|
4631
|
-
export interface
|
|
4664
|
+
export interface ByCriteria19 {
|
|
4632
4665
|
/**
|
|
4633
4666
|
* Name assigned when the window/tab was opened.
|
|
4634
4667
|
*/
|
|
@@ -4646,7 +4679,7 @@ export interface ByCriteria18 {
|
|
|
4646
4679
|
*/
|
|
4647
4680
|
url?: string;
|
|
4648
4681
|
}
|
|
4649
|
-
export interface
|
|
4682
|
+
export interface ByCriteria20 {
|
|
4650
4683
|
/**
|
|
4651
4684
|
* Name assigned when the window/tab was opened.
|
|
4652
4685
|
*/
|
|
@@ -4951,7 +4984,7 @@ export interface SwipeDirectional {
|
|
|
4951
4984
|
/**
|
|
4952
4985
|
* The browser window/tab or app window this step acts on. Omit to act on the active tab. The targeted surface stays focused afterward. App surfaces use the object form ({ "app": … }).
|
|
4953
4986
|
*/
|
|
4954
|
-
surface?: SurfaceByBrowserEngine5 | BrowserSurface8 |
|
|
4987
|
+
surface?: SurfaceByBrowserEngine5 | BrowserSurface8 | AppSurface5;
|
|
4955
4988
|
}
|
|
4956
4989
|
export interface BrowserSurface8 {
|
|
4957
4990
|
/**
|
|
@@ -4965,7 +4998,7 @@ export interface BrowserSurface8 {
|
|
|
4965
4998
|
window?: WindowTabSelector16;
|
|
4966
4999
|
tab?: WindowTabSelector17;
|
|
4967
5000
|
}
|
|
4968
|
-
export interface
|
|
5001
|
+
export interface ByCriteria21 {
|
|
4969
5002
|
/**
|
|
4970
5003
|
* Name assigned when the window/tab was opened.
|
|
4971
5004
|
*/
|
|
@@ -4983,7 +5016,7 @@ export interface ByCriteria20 {
|
|
|
4983
5016
|
*/
|
|
4984
5017
|
url?: string;
|
|
4985
5018
|
}
|
|
4986
|
-
export interface
|
|
5019
|
+
export interface ByCriteria22 {
|
|
4987
5020
|
/**
|
|
4988
5021
|
* Name assigned when the window/tab was opened.
|
|
4989
5022
|
*/
|
|
@@ -5001,14 +5034,14 @@ export interface ByCriteria21 {
|
|
|
5001
5034
|
*/
|
|
5002
5035
|
url?: string;
|
|
5003
5036
|
}
|
|
5004
|
-
export interface
|
|
5037
|
+
export interface AppSurface5 {
|
|
5005
5038
|
/**
|
|
5006
5039
|
* Name of an app surface opened by `startSurface` (its `name`, or the default derived from the app identifier).
|
|
5007
5040
|
*/
|
|
5008
5041
|
app: string;
|
|
5009
|
-
window?:
|
|
5042
|
+
window?: AppWindowSelector5;
|
|
5010
5043
|
}
|
|
5011
|
-
export interface
|
|
5044
|
+
export interface ByCriteria23 {
|
|
5012
5045
|
/**
|
|
5013
5046
|
* Assigned window name.
|
|
5014
5047
|
*/
|
|
@@ -5032,7 +5065,7 @@ export interface SwipePointToPoint {
|
|
|
5032
5065
|
/**
|
|
5033
5066
|
* The browser window/tab or app window this step acts on. Omit to act on the active tab. The targeted surface stays focused afterward. App surfaces use the object form ({ "app": … }).
|
|
5034
5067
|
*/
|
|
5035
|
-
surface?: SurfaceByBrowserEngine6 | BrowserSurface9 |
|
|
5068
|
+
surface?: SurfaceByBrowserEngine6 | BrowserSurface9 | AppSurface6;
|
|
5036
5069
|
}
|
|
5037
5070
|
/**
|
|
5038
5071
|
* A pixel coordinate on the surface, measured from its top-left corner (0, 0).
|
|
@@ -5072,7 +5105,7 @@ export interface BrowserSurface9 {
|
|
|
5072
5105
|
window?: WindowTabSelector18;
|
|
5073
5106
|
tab?: WindowTabSelector19;
|
|
5074
5107
|
}
|
|
5075
|
-
export interface
|
|
5108
|
+
export interface ByCriteria24 {
|
|
5076
5109
|
/**
|
|
5077
5110
|
* Name assigned when the window/tab was opened.
|
|
5078
5111
|
*/
|
|
@@ -5090,7 +5123,7 @@ export interface ByCriteria23 {
|
|
|
5090
5123
|
*/
|
|
5091
5124
|
url?: string;
|
|
5092
5125
|
}
|
|
5093
|
-
export interface
|
|
5126
|
+
export interface ByCriteria25 {
|
|
5094
5127
|
/**
|
|
5095
5128
|
* Name assigned when the window/tab was opened.
|
|
5096
5129
|
*/
|
|
@@ -5108,14 +5141,14 @@ export interface ByCriteria24 {
|
|
|
5108
5141
|
*/
|
|
5109
5142
|
url?: string;
|
|
5110
5143
|
}
|
|
5111
|
-
export interface
|
|
5144
|
+
export interface AppSurface6 {
|
|
5112
5145
|
/**
|
|
5113
5146
|
* Name of an app surface opened by `startSurface` (its `name`, or the default derived from the app identifier).
|
|
5114
5147
|
*/
|
|
5115
5148
|
app: string;
|
|
5116
|
-
window?:
|
|
5149
|
+
window?: AppWindowSelector6;
|
|
5117
5150
|
}
|
|
5118
|
-
export interface
|
|
5151
|
+
export interface ByCriteria26 {
|
|
5119
5152
|
/**
|
|
5120
5153
|
* Assigned window name.
|
|
5121
5154
|
*/
|