@immense/vue-pom-generator 1.0.120 → 1.0.122
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/README.md +20 -0
- package/RELEASE_NOTES.md +27 -28
- package/class-generation/base-page.ts +2 -0
- package/class-generation/pointer.ts +101 -4
- package/dist/class-generation/base-page.d.ts +2 -0
- package/dist/class-generation/base-page.d.ts.map +1 -1
- package/dist/class-generation/pointer.d.ts +55 -1
- package/dist/class-generation/pointer.d.ts.map +1 -1
- package/dist/index.cjs +71 -23
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +71 -23
- package/dist/index.mjs.map +1 -1
- package/dist/playwright/runtime.cjs +20 -4
- package/dist/playwright/runtime.cjs.map +1 -1
- package/dist/playwright/runtime.mjs +20 -4
- package/dist/playwright/runtime.mjs.map +1 -1
- package/dist/plugin/internal-plugins.d.ts.map +1 -1
- package/dist/plugin/runtime/annotator/plugin.d.ts +15 -0
- package/dist/plugin/runtime/annotator/plugin.d.ts.map +1 -1
- package/dist/tests/annotator-sources.test.d.ts +2 -0
- package/dist/tests/annotator-sources.test.d.ts.map +1 -0
- package/package.json +1 -1
- package/plugin/runtime/annotator/plugin.ts +69 -1
package/README.md
CHANGED
|
@@ -1079,6 +1079,26 @@ const brandCallout: CalloutRenderer = {
|
|
|
1079
1079
|
setDefaultCalloutRenderer(brandCallout);
|
|
1080
1080
|
```
|
|
1081
1081
|
|
|
1082
|
+
To act around what page objects do, such as moving a video camera with the pointer, register action hooks. Every page object, generated or handwritten, calls them around each pointer move, click and text input, and waits for each one before it continues. They are read as each action runs, so a fixture can set them for one test and pass `undefined` to `setActionHooks` afterwards. Move hooks run only while animations are enabled, since nothing moves otherwise; a pointer's first move, with no position yet, places it on its target (`from` equals `to`).
|
|
1083
|
+
|
|
1084
|
+
```ts
|
|
1085
|
+
import { setActionHooks } from "@immense/vue-pom-generator/playwright/runtime";
|
|
1086
|
+
|
|
1087
|
+
setActionHooks({
|
|
1088
|
+
// Zoom out before the pointer travels, then in on the target once it stops.
|
|
1089
|
+
async beforeMove({ from, to }) { await camera.show(spanning(from, to)); },
|
|
1090
|
+
async afterMove({ box }) { await camera.show(box); },
|
|
1091
|
+
async afterClick() { await camera.hold(); },
|
|
1092
|
+
async beforeInput({ box }) { if (box) await camera.show(box); },
|
|
1093
|
+
});
|
|
1094
|
+
```
|
|
1095
|
+
|
|
1096
|
+
| Hook | Runs | Gets |
|
|
1097
|
+
| --- | --- | --- |
|
|
1098
|
+
| `beforeMove`, `afterMove` | before the pointer starts moving, after it stops | `page`, `target`, `box`, `from`, `to`, `durationMilliseconds` |
|
|
1099
|
+
| `beforeClick`, `afterClick` | before the click, after it (and after the click instrumentation wait) | `page`, `target`, `box` |
|
|
1100
|
+
| `beforeInput`, `afterInput` | before the text is typed or filled, after it | `page`, `target`, `box`, `text` |
|
|
1101
|
+
|
|
1082
1102
|
The example below uses the optional floating-ui renderer so the callout can auto-place around nearby UI and point back to the target with an arrow.
|
|
1083
1103
|
|
|
1084
1104
|
Example floating-ui callout sequence captured from the Playwright fixture coverage:
|
package/RELEASE_NOTES.md
CHANGED
|
@@ -1,41 +1,40 @@
|
|
|
1
|
-
|
|
2
|
-
details.
|
|
1
|
+
v1.0.121 already contains #86–#88, so this release covers only #89. Let me review its diff.
|
|
3
2
|
|
|
4
3
|
Highlights
|
|
5
4
|
|
|
6
|
-
-
|
|
7
|
-
|
|
8
|
-
-
|
|
9
|
-
|
|
10
|
-
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
off
|
|
15
|
-
- Generation fails fast if the option is enabled without fixtures, or if an unnamed route's pattern
|
|
16
|
-
can't be resolved into the route tree
|
|
5
|
+
- Built apps now show the source component of any element in the annotator — not just ones carrying
|
|
6
|
+
a test id.
|
|
7
|
+
- Static text, slot content, and teleported content no longer show "Unable to find component file
|
|
8
|
+
path." in production/preview builds.
|
|
9
|
+
- Every compiled SFC now gets its source path (__file, relative to the Vite root) when the
|
|
10
|
+
annotator is enabled, matching dev-server behavior.
|
|
11
|
+
- Builds with the annotator now define __VUE_PROD_DEVTOOLS__, restoring Vue's element-to-component
|
|
12
|
+
links that production builds normally omit.
|
|
17
13
|
|
|
18
14
|
Changes
|
|
19
15
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
-
|
|
30
|
-
|
|
31
|
-
|
|
16
|
+
Annotator
|
|
17
|
+
|
|
18
|
+
- Added a new vue-pom-generator:annotator-sources Vite plugin that appends __file to each exported
|
|
19
|
+
SFC component in builds, including components wrapped by _export_sfc (]8;id=md-1f7mfct;https://github.com/immense/vue-pom-generator/pull/89#89]8;;]8;;).]8;;
|
|
20
|
+
- Enables __VUE_PROD_DEVTOOLS__ in annotator builds so the annotator can walk Vue's
|
|
21
|
+
__vueParentComponent links in production bundles (]8;id=md-1f7mfct;https://github.com/immense/vue-pom-generator/pull/89#89]8;;]8;;).]8;;
|
|
22
|
+
|
|
23
|
+
Build tooling
|
|
24
|
+
|
|
25
|
+
- The source plugin applies to client builds only — dev server and SSR (vite build --ssr) are
|
|
26
|
+
excluded (]8;id=md-1f7mfct;https://github.com/immense/vue-pom-generator/pull/89#89]8;;]8;;).]8;;
|
|
27
|
+
- Packed smoke check now verifies the browser bundle contains component source paths and Vue's
|
|
28
|
+
element-to-component links (]8;id=md-1f7mfct;https://github.com/immense/vue-pom-generator/pull/89#89]8;;]8;;).]8;;
|
|
32
29
|
|
|
33
30
|
Pull Requests Included
|
|
34
31
|
|
|
35
|
-
- ]8;id=md-
|
|
32
|
+
- ]8;id=md-1f7mfct;https://github.com/immense/vue-pom-generator/pull/89#89]8;;]8;; — fix(annotator): name the source component of any element in built apps (@darrenator[bot])]8;;
|
|
36
33
|
|
|
37
34
|
Testing
|
|
38
35
|
|
|
39
|
-
- Added
|
|
40
|
-
|
|
36
|
+
- Added unit tests for __file injection (_export_sfc and direct exports), non-component modules,
|
|
37
|
+
and client-build-only plugin application.
|
|
38
|
+
- Extended the packed smoke check to assert source paths and devtools links are present in the
|
|
39
|
+
browser bundle.
|
|
41
40
|
|
|
@@ -10,6 +10,8 @@ import { Pointer, type AfterPointerClick, type AfterPointerClickInfo, type Point
|
|
|
10
10
|
// Part of the public `playwright/runtime` entry, whose source is this file.
|
|
11
11
|
export { setDefaultCalloutRenderer } from "./callout";
|
|
12
12
|
export type { CalloutRenderer, CalloutRenderRequest } from "./callout";
|
|
13
|
+
export { setActionHooks } from "./pointer";
|
|
14
|
+
export type { ActionBox, ActionHookContext, ActionHooks, InputHookContext, PointerMoveHookContext } from "./pointer";
|
|
13
15
|
|
|
14
16
|
const POM_ACTIVE_ACTION_REGISTRY = Symbol.for("@immense/vue-pom-generator.active-action-registry");
|
|
15
17
|
const CHECKABLE_CONTROL_SELECTOR = 'input[type="checkbox"], input[type="radio"]';
|
|
@@ -20,8 +20,9 @@ const __PW_POINTER_PNG__ =
|
|
|
20
20
|
|
|
21
21
|
const __pw_pointer_positions__ = new WeakMap<object, { x: number; y: number }>();
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
23
|
+
/** Where the page's pointer is; undefined until its first move, so that move places it instead of gliding in. */
|
|
24
|
+
function __pw_get_pointer_pos__(page: PwPage): { x: number; y: number } | undefined {
|
|
25
|
+
return __pw_pointer_positions__.get(page as object);
|
|
25
26
|
}
|
|
26
27
|
|
|
27
28
|
function __pw_set_pointer_pos__(page: PwPage, x: number, y: number): void {
|
|
@@ -133,6 +134,75 @@ export interface AfterPointerClickInfo {
|
|
|
133
134
|
|
|
134
135
|
export type AfterPointerClick = (info: AfterPointerClickInfo) => void | Promise<void>;
|
|
135
136
|
|
|
137
|
+
// ---------------------------------------------------------------------------
|
|
138
|
+
// Action hooks
|
|
139
|
+
// ---------------------------------------------------------------------------
|
|
140
|
+
|
|
141
|
+
/** A box in viewport pixels. */
|
|
142
|
+
export interface ActionBox {
|
|
143
|
+
x: number;
|
|
144
|
+
y: number;
|
|
145
|
+
width: number;
|
|
146
|
+
height: number;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
/** The element an action is on, and its box once scrolled into view (null when it has none). */
|
|
150
|
+
export interface ActionHookContext {
|
|
151
|
+
page: PwPage;
|
|
152
|
+
target: PwLocator;
|
|
153
|
+
box: ActionBox | null;
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
/**
|
|
157
|
+
* A pointer move to the center of `box`. `from` is where the pointer was; on its first move it has no position yet,
|
|
158
|
+
* so `from` equals `to` and the pointer is placed there instead of gliding.
|
|
159
|
+
*/
|
|
160
|
+
export interface PointerMoveHookContext extends ActionHookContext {
|
|
161
|
+
box: ActionBox;
|
|
162
|
+
from: { x: number; y: number };
|
|
163
|
+
to: { x: number; y: number };
|
|
164
|
+
/** How long the glide takes; 0 when the pointer is placed without one. */
|
|
165
|
+
durationMilliseconds: number;
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
/** Text typed or filled into `target`. */
|
|
169
|
+
export interface InputHookContext extends ActionHookContext {
|
|
170
|
+
text: string;
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Called around each pointer move, click and text input a page object performs, and awaited: the action continues once
|
|
175
|
+
* the hook resolves. For example, a video camera can pan to where the pointer is going before it moves and zoom in on
|
|
176
|
+
* the target after it arrives. Move hooks run only while animations are enabled, since nothing moves otherwise.
|
|
177
|
+
*/
|
|
178
|
+
export interface ActionHooks {
|
|
179
|
+
beforeMove?: (context: PointerMoveHookContext) => void | Promise<void>;
|
|
180
|
+
afterMove?: (context: PointerMoveHookContext) => void | Promise<void>;
|
|
181
|
+
beforeClick?: (context: ActionHookContext) => void | Promise<void>;
|
|
182
|
+
afterClick?: (context: ActionHookContext) => void | Promise<void>;
|
|
183
|
+
beforeInput?: (context: InputHookContext) => void | Promise<void>;
|
|
184
|
+
afterInput?: (context: InputHookContext) => void | Promise<void>;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
// Kept on globalThis so the package's runtime entry and the runtime copied next to the
|
|
188
|
+
// generated POMs share one set, whichever copy the setter is imported from.
|
|
189
|
+
const ACTION_HOOKS = Symbol.for("@immense/vue-pom-generator.action-hooks");
|
|
190
|
+
|
|
191
|
+
type ActionHooksGlobal = typeof globalThis & { [ACTION_HOOKS]?: ActionHooks };
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Sets the process-wide action hooks every page object, generated or handwritten, calls around its pointer moves,
|
|
195
|
+
* clicks and text input. They are read as each action runs, so they can change between tests. Pass `undefined` to
|
|
196
|
+
* remove them.
|
|
197
|
+
*/
|
|
198
|
+
export function setActionHooks(hooks: ActionHooks | undefined): void {
|
|
199
|
+
(globalThis as ActionHooksGlobal)[ACTION_HOOKS] = hooks;
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
function actionHooks(): ActionHooks | undefined {
|
|
203
|
+
return (globalThis as ActionHooksGlobal)[ACTION_HOOKS];
|
|
204
|
+
}
|
|
205
|
+
|
|
136
206
|
const __pw_default_pointer_renderer__: PointerRenderer = {
|
|
137
207
|
overlayIds: [__PW_POINTER_ID__],
|
|
138
208
|
async ensure(page) {
|
|
@@ -142,7 +212,8 @@ const __pw_default_pointer_renderer__: PointerRenderer = {
|
|
|
142
212
|
);
|
|
143
213
|
if (exists) return;
|
|
144
214
|
|
|
145
|
-
|
|
215
|
+
// A new pointer, such as after a page load, has no position until its first move places it.
|
|
216
|
+
__pw_pointer_positions__.delete(page as object);
|
|
146
217
|
|
|
147
218
|
await page.evaluate(
|
|
148
219
|
({ id, src }: { id: string; src: string }) => {
|
|
@@ -352,6 +423,7 @@ export class Pointer {
|
|
|
352
423
|
|
|
353
424
|
const opts = animationOptions;
|
|
354
425
|
const animEnabled = opts.enabled !== false;
|
|
426
|
+
const hooks = actionHooks();
|
|
355
427
|
if (executeClick) {
|
|
356
428
|
await this.waitForFiniteAncestorAnimations(locator);
|
|
357
429
|
}
|
|
@@ -368,15 +440,18 @@ export class Pointer {
|
|
|
368
440
|
if (extraDelay > 0) await this.page.waitForTimeout(extraDelay);
|
|
369
441
|
|
|
370
442
|
let clickedTestId: string | undefined;
|
|
443
|
+
const click = hooks && executeClick ? await this.hookContext(locator) : undefined;
|
|
371
444
|
if (executeClick) {
|
|
372
445
|
if (options?.afterClick) {
|
|
373
446
|
try { clickedTestId = await this.getTestId(locator); } catch { /* noop */ }
|
|
374
447
|
}
|
|
448
|
+
if (click) await hooks?.beforeClick?.(click);
|
|
375
449
|
await locator.first().click();
|
|
376
450
|
}
|
|
377
451
|
if (options?.afterClick) {
|
|
378
452
|
await options.afterClick({ testId: clickedTestId, instrumented: Boolean(clickedTestId) });
|
|
379
453
|
}
|
|
454
|
+
if (click) await hooks?.afterClick?.(click);
|
|
380
455
|
return;
|
|
381
456
|
}
|
|
382
457
|
|
|
@@ -399,13 +474,23 @@ export class Pointer {
|
|
|
399
474
|
|
|
400
475
|
// Move the pointer to the target element.
|
|
401
476
|
const box = await locator.first().boundingBox();
|
|
477
|
+
let move: PointerMoveHookContext | undefined;
|
|
402
478
|
if (box) {
|
|
403
479
|
const endX = box.x + box.width / 2;
|
|
404
480
|
const endY = box.y + box.height / 2;
|
|
405
|
-
const { x: startX, y: startY } = __pw_get_pointer_pos__(this.page);
|
|
481
|
+
const { x: startX, y: startY } = __pw_get_pointer_pos__(this.page) ?? { x: endX, y: endY };
|
|
406
482
|
const distance = Math.sqrt((endX - startX) ** 2 + (endY - startY) ** 2);
|
|
407
483
|
|
|
408
484
|
const shouldAnimate = moveDurationMs > 0 && distance > 0;
|
|
485
|
+
move = {
|
|
486
|
+
page: this.page,
|
|
487
|
+
target: locator,
|
|
488
|
+
box,
|
|
489
|
+
from: { x: startX, y: startY },
|
|
490
|
+
to: { x: endX, y: endY },
|
|
491
|
+
durationMilliseconds: shouldAnimate ? moveDurationMs : 0,
|
|
492
|
+
};
|
|
493
|
+
await hooks?.beforeMove?.(move);
|
|
409
494
|
await this.renderer.move(this.page, {
|
|
410
495
|
animate: shouldAnimate,
|
|
411
496
|
durationMilliseconds: moveDurationMs,
|
|
@@ -432,6 +517,7 @@ export class Pointer {
|
|
|
432
517
|
}
|
|
433
518
|
|
|
434
519
|
__pw_set_pointer_pos__(this.page, endX, endY);
|
|
520
|
+
await hooks?.afterMove?.(move);
|
|
435
521
|
}
|
|
436
522
|
else {
|
|
437
523
|
await this.callout.hide();
|
|
@@ -442,7 +528,9 @@ export class Pointer {
|
|
|
442
528
|
if (totalDelay > 0) await this.page.waitForTimeout(totalDelay);
|
|
443
529
|
|
|
444
530
|
let clickedTestId: string | undefined;
|
|
531
|
+
const click = hooks && executeClick ? { page: this.page, target: locator, box } : undefined;
|
|
445
532
|
if (executeClick) {
|
|
533
|
+
if (click) await hooks?.beforeClick?.(click);
|
|
446
534
|
// Brief scale-down "press" animation on the pointer image.
|
|
447
535
|
if (moveDurationMs > 0) {
|
|
448
536
|
const pressDur = Math.max(80, Math.round(moveDurationMs / 3));
|
|
@@ -458,6 +546,11 @@ export class Pointer {
|
|
|
458
546
|
if (options?.afterClick) {
|
|
459
547
|
await options.afterClick({ testId: clickedTestId, instrumented: Boolean(clickedTestId) });
|
|
460
548
|
}
|
|
549
|
+
if (click) await hooks?.afterClick?.(click);
|
|
550
|
+
}
|
|
551
|
+
|
|
552
|
+
private async hookContext(locator: PwLocator): Promise<ActionHookContext> {
|
|
553
|
+
return { page: this.page, target: locator, box: await locator.first().boundingBox() };
|
|
461
554
|
}
|
|
462
555
|
|
|
463
556
|
public async animateCursorToElementAndClickAndFill(
|
|
@@ -476,6 +569,9 @@ export class Pointer {
|
|
|
476
569
|
const locator = this.toLocator(target);
|
|
477
570
|
const editableLocator = await this.resolveEditableLocator(locator);
|
|
478
571
|
const typeDelayMs = animationOptions.keyboard?.typeDelayMilliseconds ?? 100;
|
|
572
|
+
const hooks = actionHooks();
|
|
573
|
+
const input = hooks ? { ...(await this.hookContext(editableLocator)), text } : undefined;
|
|
574
|
+
if (input) await hooks?.beforeInput?.(input);
|
|
479
575
|
|
|
480
576
|
if (animationOptions.enabled !== false && typeDelayMs > 0) {
|
|
481
577
|
// Clear existing content, then type character-by-character so keystrokes are visible.
|
|
@@ -485,5 +581,6 @@ export class Pointer {
|
|
|
485
581
|
else {
|
|
486
582
|
await editableLocator.fill(text);
|
|
487
583
|
}
|
|
584
|
+
if (input) await hooks?.afterInput?.(input);
|
|
488
585
|
}
|
|
489
586
|
}
|
|
@@ -4,6 +4,8 @@ import type { CalloutRenderer } from "./callout";
|
|
|
4
4
|
import { type AfterPointerClick, type PointerRenderer } from "./pointer";
|
|
5
5
|
export { setDefaultCalloutRenderer } from "./callout";
|
|
6
6
|
export type { CalloutRenderer, CalloutRenderRequest } from "./callout";
|
|
7
|
+
export { setActionHooks } from "./pointer";
|
|
8
|
+
export type { ActionBox, ActionHookContext, ActionHooks, InputHookContext, PointerMoveHookContext } from "./pointer";
|
|
7
9
|
/**
|
|
8
10
|
* A chainable, thenable wrapper around a page object.
|
|
9
11
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"base-page.d.ts","sourceRoot":"","sources":["../../class-generation/base-page.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,yBAAyB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAKvF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAW,KAAK,iBAAiB,EAA8B,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AAG9G,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAC;AACtD,YAAY,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"base-page.d.ts","sourceRoot":"","sources":["../../class-generation/base-page.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,yBAAyB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAKvF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAW,KAAK,iBAAiB,EAA8B,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AAG9G,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAC;AACtD,YAAY,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,YAAY,EAAE,SAAS,EAAE,iBAAiB,EAAE,WAAW,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAiCrH;;;;;;;;GAQG;AACH;;;GAGG;AACH,KAAK,UAAU,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,IAAI;KACxC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,EAAE,GACzD,CAAC,SAAS,aAAa,GAAG,kBAAkB,GAAG,YAAY,GAC3D,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GACxC,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,GAC7B,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACnB,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,GACvB,CAAC,CAAC,CAAC,CAAC;CACP,CAAC;AAEF,KAAK,eAAe,CAAC,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,GACxD,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GACvC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACnB,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACrB,CAAC,CAAC,CAAC,CAAC;CACP,CAAC;AAEF,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,MAAM,IAAI,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AAEzE,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AAEjE,MAAM,WAAW,eAAe;IAC9B,0EAA0E;IAC1E,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,SAAS,CAAC,EAAE;QACV,OAAO,CAAC,EAAE,eAAe,CAAC;QAC1B,OAAO,CAAC,EAAE,eAAe,CAAC;KAC3B,CAAC;IACF,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;gBAEV,GAAG,EAAE,MAAM;IAOvB,QAAQ,IAAI,MAAM;IAIlB,KAAK,IAAI,MAAM;IAIf,KAAK,IAAI,MAAM;CAWvB;AAED;;;GAGG;AACH,qBAAa,QAAQ;IACnB,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAE3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA+B;IAEvD;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAY;IAEnC;;;;;OAKG;IACH,SAAS,KAAK,IAAI,IAAI,IAAI,CAEzB;IAED;;OAEG;gBACgB,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe;IAa1D,IAAW,UAAU,IAAI,IAAI,CAAC,YAAY,CAAC,CAE1C;IAED;;;;;;OAMG;IACI,UAAU,CAAC,OAAO,CAAC,EAAE,yBAAyB,GAAG,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAIxE,4BAA4B;IA0G1C,OAAO,CAAC,oBAAoB;IAS5B,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAInD,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO;IAK1E,OAAO,CAAC,cAAc;IAKtB,qFAAqF;IACrF,SAAS,CAAC,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,OAAO;IAMnF,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO;cAIxD,2BAA2B,CACzC,OAAO,EAAE,SAAS,MAAM,EAAE,EAC1B,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,aAAa,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,CAAC;IAuBnB,SAAS,CAAC,eAAe,CACvB,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,SAAS,MAAM,EAAE,GACjC,IAAI;IAIP,SAAS,CAAC,0BAA0B,CAClC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,OAAO;IAYV;;OAEG;cACa,sBAAsB,CACpC,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,YAAY,GAAE,OAAc,EAC5B,OAAO,GAAE,MAAa,EACtB,cAAc,GAAE,MAAW,EAC3B,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,iBAAiB,CAAC;KAChC,GACA,OAAO,CAAC,IAAI,CAAC;IAIH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9E,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1E,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAIzC;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,IAAI,SAAS,MAAM,EAAE,UAAU,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,SAAS,GAAG,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC;IAiB5F,WAAW,CAAC,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;IAmBhE,gBAAgB,CAAC,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAKhF;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAsKxE;;;OAGG;IACU,aAAa,CACxB,MAAM,EAAE,MAAM,EACd,cAAc,GAAE,MAAW,EAC3B,IAAI,GAAE,OAAc,EACpB,WAAW,CAAC,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,qBAAqB,CAAC,EAAE,OAAO,CAAA;KAAE,GACvF,OAAO,CAAC,IAAI,CAAC;IA+CH,YAAY,CAAC,OAAO,EAAE,SAAS,EAAE,cAAc,GAAE,MAAW,EAAE,IAAI,GAAE,OAAc,GAAG,OAAO,CAAC,IAAI,CAAC;cAK/F,wBAAwB,CACtC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,cAAc,GAAE,MAAW,EAC3B,IAAI,GAAE,OAAc,EACpB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/F,OAAO,CAAC,IAAI,CAAC;cASA,iBAAiB,CAC/B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,cAAc,GAAE,MAAW,EAC3B,WAAW,CAAC,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GACtD,OAAO,CAAC,IAAI,CAAC;IAOhB;;;OAGG;cACa,qBAAqB,CACnC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,cAAc,GAAE,MAAW,EAC3B,WAAW,CAAC,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GACtD,OAAO,CAAC,IAAI,CAAC;IAeH,kBAAkB,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,cAAc,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;cAK7F,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/F;;;;OAIG;cACa,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzE;;;;OAIG;cACa,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAInE;;;;OAIG;cACa,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAIvE;;;;;;OAMG;cACa,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5F;;;OAGG;cACa,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5D;;;;OAIG;cACa,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG7E"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Callout, type ElementTarget } from "./callout";
|
|
2
|
-
import type { PwPage } from "./playwright-types";
|
|
2
|
+
import type { PwLocator, PwPage } from "./playwright-types";
|
|
3
3
|
export interface PointerMoveRequest {
|
|
4
4
|
animate: boolean;
|
|
5
5
|
durationMilliseconds: number;
|
|
@@ -68,6 +68,59 @@ export interface AfterPointerClickInfo {
|
|
|
68
68
|
instrumented: boolean;
|
|
69
69
|
}
|
|
70
70
|
export type AfterPointerClick = (info: AfterPointerClickInfo) => void | Promise<void>;
|
|
71
|
+
/** A box in viewport pixels. */
|
|
72
|
+
export interface ActionBox {
|
|
73
|
+
x: number;
|
|
74
|
+
y: number;
|
|
75
|
+
width: number;
|
|
76
|
+
height: number;
|
|
77
|
+
}
|
|
78
|
+
/** The element an action is on, and its box once scrolled into view (null when it has none). */
|
|
79
|
+
export interface ActionHookContext {
|
|
80
|
+
page: PwPage;
|
|
81
|
+
target: PwLocator;
|
|
82
|
+
box: ActionBox | null;
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* A pointer move to the center of `box`. `from` is where the pointer was; on its first move it has no position yet,
|
|
86
|
+
* so `from` equals `to` and the pointer is placed there instead of gliding.
|
|
87
|
+
*/
|
|
88
|
+
export interface PointerMoveHookContext extends ActionHookContext {
|
|
89
|
+
box: ActionBox;
|
|
90
|
+
from: {
|
|
91
|
+
x: number;
|
|
92
|
+
y: number;
|
|
93
|
+
};
|
|
94
|
+
to: {
|
|
95
|
+
x: number;
|
|
96
|
+
y: number;
|
|
97
|
+
};
|
|
98
|
+
/** How long the glide takes; 0 when the pointer is placed without one. */
|
|
99
|
+
durationMilliseconds: number;
|
|
100
|
+
}
|
|
101
|
+
/** Text typed or filled into `target`. */
|
|
102
|
+
export interface InputHookContext extends ActionHookContext {
|
|
103
|
+
text: string;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Called around each pointer move, click and text input a page object performs, and awaited: the action continues once
|
|
107
|
+
* the hook resolves. For example, a video camera can pan to where the pointer is going before it moves and zoom in on
|
|
108
|
+
* the target after it arrives. Move hooks run only while animations are enabled, since nothing moves otherwise.
|
|
109
|
+
*/
|
|
110
|
+
export interface ActionHooks {
|
|
111
|
+
beforeMove?: (context: PointerMoveHookContext) => void | Promise<void>;
|
|
112
|
+
afterMove?: (context: PointerMoveHookContext) => void | Promise<void>;
|
|
113
|
+
beforeClick?: (context: ActionHookContext) => void | Promise<void>;
|
|
114
|
+
afterClick?: (context: ActionHookContext) => void | Promise<void>;
|
|
115
|
+
beforeInput?: (context: InputHookContext) => void | Promise<void>;
|
|
116
|
+
afterInput?: (context: InputHookContext) => void | Promise<void>;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Sets the process-wide action hooks every page object, generated or handwritten, calls around its pointer moves,
|
|
120
|
+
* clicks and text input. They are read as each action runs, so they can change between tests. Pass `undefined` to
|
|
121
|
+
* remove them.
|
|
122
|
+
*/
|
|
123
|
+
export declare function setActionHooks(hooks: ActionHooks | undefined): void;
|
|
71
124
|
export declare class Pointer {
|
|
72
125
|
private readonly page;
|
|
73
126
|
private readonly testIdAttribute;
|
|
@@ -90,6 +143,7 @@ export declare class Pointer {
|
|
|
90
143
|
animateCursorToElement(target: ElementTarget, executeClick?: boolean, delayMs?: number, annotationText?: string, options?: {
|
|
91
144
|
afterClick?: AfterPointerClick;
|
|
92
145
|
}): Promise<void>;
|
|
146
|
+
private hookContext;
|
|
93
147
|
animateCursorToElementAndClickAndFill(target: ElementTarget, text: string, executeClick?: boolean, delayMs?: number, annotationText?: string, options?: {
|
|
94
148
|
afterClick?: AfterPointerClick;
|
|
95
149
|
}): Promise<void>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pointer.d.ts","sourceRoot":"","sources":["../../class-generation/pointer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAuB,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAC7E,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"pointer.d.ts","sourceRoot":"","sources":["../../class-generation/pointer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAuB,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAC7E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AA8B5D,MAAM,WAAW,kBAAkB;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IACnC,oBAAoB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnE,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrE;AAMD,MAAM,WAAW,0BAA0B;IAC1C;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,6CAA6C;IAC7C,OAAO,CAAC,EAAE;QACT;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,eAAe,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,CAAC;QAE7E;;;WAGG;QACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;KAChC,CAAC;IAEF,uCAAuC;IACvC,QAAQ,CAAC,EAAE;QACV;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;KAC/B,CAAC;CACF;AASD,wBAAgB,6BAA6B,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI,CAavF;AAED,MAAM,WAAW,qBAAqB;IACrC,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,YAAY,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,qBAAqB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAMtF,gCAAgC;AAChC,MAAM,WAAW,SAAS;IACzB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CACf;AAED,gGAAgG;AAChG,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,CAAC;IAClB,GAAG,EAAE,SAAS,GAAG,IAAI,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,iBAAiB;IAChE,GAAG,EAAE,SAAS,CAAC;IACf,IAAI,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/B,EAAE,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7B,0EAA0E;IAC1E,oBAAoB,EAAE,MAAM,CAAC;CAC7B;AAED,0CAA0C;AAC1C,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IAC1D,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC3B,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnE,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClE,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClE,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE;AAQD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI,CAEnE;AA2GD,qBAAa,OAAO;IACnB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;gBAExB,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,eAAe;IAUvG,OAAO,CAAC,SAAS;YAIH,SAAS;IAMvB;;;;;;;OAOG;YACW,+BAA+B;YAiC/B,iBAAiB;YAmBjB,sBAAsB;IAmBvB,sBAAsB,CAClC,MAAM,EAAE,aAAa,EACrB,YAAY,GAAE,OAAc,EAC5B,OAAO,GAAE,MAAa,EACtB,cAAc,GAAE,MAAW,EAC3B,OAAO,CAAC,EAAE;QACT,UAAU,CAAC,EAAE,iBAAiB,CAAC;KAC/B,GACC,OAAO,CAAC,IAAI,CAAC;YAoIF,WAAW;IAIZ,qCAAqC,CACjD,MAAM,EAAE,aAAa,EACrB,IAAI,EAAE,MAAM,EACZ,YAAY,GAAE,OAAc,EAC5B,OAAO,GAAE,MAAa,EACtB,cAAc,GAAE,MAAW,EAC3B,OAAO,CAAC,EAAE;QACT,UAAU,CAAC,EAAE,iBAAiB,CAAC;KAC/B,GACC,OAAO,CAAC,IAAI,CAAC;CAqBhB"}
|