@nifrajs/e2e 0.0.0-stage → 5.14.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.
Files changed (84) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/LICENSE +21 -0
  3. package/README.md +127 -2
  4. package/dist/agent.d.ts +119 -0
  5. package/dist/agent.d.ts.map +1 -0
  6. package/dist/agent.js +312 -0
  7. package/dist/agent.js.map +1 -0
  8. package/dist/cache.d.ts +84 -0
  9. package/dist/cache.d.ts.map +1 -0
  10. package/dist/cache.js +162 -0
  11. package/dist/cache.js.map +1 -0
  12. package/dist/decision.d.ts +54 -0
  13. package/dist/decision.d.ts.map +1 -0
  14. package/dist/decision.js +122 -0
  15. package/dist/decision.js.map +1 -0
  16. package/dist/engine.d.ts +75 -0
  17. package/dist/engine.d.ts.map +1 -0
  18. package/dist/engine.js +13 -0
  19. package/dist/engine.js.map +1 -0
  20. package/dist/evidence.d.ts +14 -0
  21. package/dist/evidence.d.ts.map +1 -0
  22. package/dist/evidence.js +49 -0
  23. package/dist/evidence.js.map +1 -0
  24. package/dist/expect.d.ts +28 -0
  25. package/dist/expect.d.ts.map +1 -0
  26. package/dist/expect.js +88 -0
  27. package/dist/expect.js.map +1 -0
  28. package/dist/fake.d.ts +35 -0
  29. package/dist/fake.d.ts.map +1 -0
  30. package/dist/fake.js +124 -0
  31. package/dist/fake.js.map +1 -0
  32. package/dist/index.d.ts +11 -0
  33. package/dist/index.d.ts.map +1 -0
  34. package/dist/index.js +8 -0
  35. package/dist/index.js.map +1 -0
  36. package/dist/internal/record.d.ts +3 -0
  37. package/dist/internal/record.d.ts.map +1 -0
  38. package/dist/internal/record.js +4 -0
  39. package/dist/internal/record.js.map +1 -0
  40. package/dist/locator.d.ts +53 -0
  41. package/dist/locator.d.ts.map +1 -0
  42. package/dist/locator.js +102 -0
  43. package/dist/locator.js.map +1 -0
  44. package/dist/params.d.ts +44 -0
  45. package/dist/params.d.ts.map +1 -0
  46. package/dist/params.js +93 -0
  47. package/dist/params.js.map +1 -0
  48. package/dist/playwright.d.ts +72 -0
  49. package/dist/playwright.d.ts.map +1 -0
  50. package/dist/playwright.js +165 -0
  51. package/dist/playwright.js.map +1 -0
  52. package/dist/replay.d.ts +34 -0
  53. package/dist/replay.d.ts.map +1 -0
  54. package/dist/replay.js +105 -0
  55. package/dist/replay.js.map +1 -0
  56. package/dist/route.d.ts +7 -0
  57. package/dist/route.d.ts.map +1 -0
  58. package/dist/route.js +20 -0
  59. package/dist/route.js.map +1 -0
  60. package/dist/session.d.ts +62 -0
  61. package/dist/session.d.ts.map +1 -0
  62. package/dist/session.js +98 -0
  63. package/dist/session.js.map +1 -0
  64. package/dist/snapshot.d.ts +8 -0
  65. package/dist/snapshot.d.ts.map +1 -0
  66. package/dist/snapshot.js +44 -0
  67. package/dist/snapshot.js.map +1 -0
  68. package/package.json +73 -4
  69. package/src/agent.ts +525 -0
  70. package/src/cache.ts +229 -0
  71. package/src/decision.ts +152 -0
  72. package/src/engine.ts +92 -0
  73. package/src/evidence.ts +58 -0
  74. package/src/expect.ts +171 -0
  75. package/src/fake.ts +185 -0
  76. package/src/index.ts +64 -0
  77. package/src/internal/record.ts +5 -0
  78. package/src/locator.ts +157 -0
  79. package/src/params.ts +128 -0
  80. package/src/playwright.ts +237 -0
  81. package/src/replay.ts +153 -0
  82. package/src/route.ts +26 -0
  83. package/src/session.ts +178 -0
  84. package/src/snapshot.ts +46 -0
@@ -0,0 +1,28 @@
1
+ import { Locator, type LocatorContext } from "./locator.js";
2
+ export interface MatcherOptions {
3
+ /** Overrides the session's `assertionTimeout` for this assertion, in ms. */
4
+ readonly timeout?: number;
5
+ }
6
+ /** Anything with a current URL; `E2ESession` is one. */
7
+ export interface UrlSource {
8
+ readonly context: LocatorContext;
9
+ url(): Promise<string>;
10
+ /** Path plus query of the current URL. */
11
+ path(): Promise<string>;
12
+ }
13
+ export interface LocatorMatchers {
14
+ toBeVisible(options?: MatcherOptions): Promise<void>;
15
+ toBeHidden(options?: MatcherOptions): Promise<void>;
16
+ toHaveText(expected: string | RegExp, options?: MatcherOptions): Promise<void>;
17
+ toContainText(expected: string | RegExp, options?: MatcherOptions): Promise<void>;
18
+ toHaveCount(expected: number, options?: MatcherOptions): Promise<void>;
19
+ toHaveValue(expected: string | RegExp, options?: MatcherOptions): Promise<void>;
20
+ readonly not: LocatorMatchers;
21
+ }
22
+ export interface UrlMatchers {
23
+ toHaveURL(expected: string | RegExp, options?: MatcherOptions): Promise<void>;
24
+ readonly not: UrlMatchers;
25
+ }
26
+ export declare function expect(subject: Locator): LocatorMatchers;
27
+ export declare function expect(subject: UrlSource): UrlMatchers;
28
+ //# sourceMappingURL=expect.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"expect.d.ts","sourceRoot":"","sources":["../src/expect.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAA;AAE3D,MAAM,WAAW,cAAc;IAC7B,4EAA4E;IAC5E,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED,wDAAwD;AACxD,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAA;IAChC,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IACtB,0CAA0C;IAC1C,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpD,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACnD,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9E,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACjF,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACtE,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/E,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAA;CAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7E,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAA;CAC1B;AAyID,wBAAgB,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe,CAAA;AACzD,wBAAgB,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,WAAW,CAAA"}
package/dist/expect.js ADDED
@@ -0,0 +1,88 @@
1
+ import { E2EError } from "./engine.js";
2
+ import { Locator } from "./locator.js";
3
+ const normalize = (text) => text.replace(/\s+/g, " ").trim();
4
+ function matches(received, expected, substring) {
5
+ if (typeof expected !== "string")
6
+ return expected.test(received);
7
+ return substring
8
+ ? normalize(received).includes(normalize(expected))
9
+ : normalize(received) === normalize(expected);
10
+ }
11
+ function single(states, check) {
12
+ const [only] = states;
13
+ if (only === undefined)
14
+ return { pass: false, received: "no element" };
15
+ if (states.length > 1) {
16
+ return { pass: false, received: `${states.length} elements, expected one`, indeterminate: true };
17
+ }
18
+ return check(only);
19
+ }
20
+ async function retry(context, timeout, negate, describe, evaluate) {
21
+ const deadline = context.clock.now() + timeout;
22
+ for (;;) {
23
+ const outcome = await evaluate();
24
+ if (outcome.indeterminate !== true && outcome.pass !== negate) {
25
+ await context.onCheck?.(true);
26
+ return;
27
+ }
28
+ const remaining = deadline - context.clock.now();
29
+ if (remaining <= 0) {
30
+ await context.onCheck?.(false);
31
+ throw new E2EError("EXPECT_FAILED", `expected ${negate ? "not " : ""}${describe}, received ${outcome.received} (after ${timeout} ms)`);
32
+ }
33
+ await context.clock.sleep(Math.min(context.pollInterval, remaining));
34
+ }
35
+ }
36
+ function locatorMatchers(locator, negate) {
37
+ const { context } = locator;
38
+ const run = (describe, options, evaluate) => retry(context, options?.timeout ?? context.assertionTimeout, negate, `${locator.describe()} ${describe}`, async () => evaluate(await locator.states()));
39
+ return {
40
+ toBeVisible: (options) => run("to be visible", options, (states) => single(states, (s) => ({ pass: s.visible, received: s.visible ? "visible" : "hidden" }))),
41
+ toBeHidden: (options) => run("to be hidden", options, (states) => {
42
+ const shown = states.filter((s) => s.visible).length;
43
+ return { pass: shown === 0, received: `${shown} visible` };
44
+ }),
45
+ toHaveText: (expected, options) => run(`to have text ${String(expected)}`, options, (states) => single(states, (s) => ({
46
+ pass: matches(s.text, expected, false),
47
+ received: JSON.stringify(normalize(s.text)),
48
+ }))),
49
+ toContainText: (expected, options) => run(`to contain text ${String(expected)}`, options, (states) => single(states, (s) => ({
50
+ pass: matches(s.text, expected, true),
51
+ received: JSON.stringify(normalize(s.text)),
52
+ }))),
53
+ toHaveCount: (expected, options) => run(`to have count ${expected}`, options, (states) => ({
54
+ pass: states.length === expected,
55
+ received: String(states.length),
56
+ })),
57
+ toHaveValue: (expected, options) => run(`to have value ${String(expected)}`, options, (states) => single(states, (s) => {
58
+ const value = s.value ?? "";
59
+ return {
60
+ pass: typeof expected === "string" ? value === expected : expected.test(value),
61
+ received: JSON.stringify(value),
62
+ };
63
+ })),
64
+ get not() {
65
+ return locatorMatchers(locator, !negate);
66
+ },
67
+ };
68
+ }
69
+ function urlMatchers(source, negate) {
70
+ return {
71
+ toHaveURL: (expected, options) => retry(source.context, options?.timeout ?? source.context.assertionTimeout, negate, `URL to be ${String(expected)}`, async () => {
72
+ const received = typeof expected === "string" && expected.startsWith("/")
73
+ ? await source.path()
74
+ : await source.url();
75
+ return {
76
+ pass: typeof expected === "string" ? received === expected : expected.test(received),
77
+ received,
78
+ };
79
+ }),
80
+ get not() {
81
+ return urlMatchers(source, !negate);
82
+ },
83
+ };
84
+ }
85
+ export function expect(subject) {
86
+ return subject instanceof Locator ? locatorMatchers(subject, false) : urlMatchers(subject, false);
87
+ }
88
+ //# sourceMappingURL=expect.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"expect.js","sourceRoot":"","sources":["../src/expect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAqB,MAAM,aAAa,CAAA;AACzD,OAAO,EAAE,OAAO,EAAuB,MAAM,cAAc,CAAA;AAqC3D,MAAM,SAAS,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;AAE5E,SAAS,OAAO,CAAC,QAAgB,EAAE,QAAyB,EAAE,SAAkB;IAC9E,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAChE,OAAO,SAAS;QACd,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACnD,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAA;AACjD,CAAC;AAED,SAAS,MAAM,CAAC,MAA+B,EAAE,KAAuC;IACtF,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAA;IACrB,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAA;IACtE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,MAAM,yBAAyB,EAAE,aAAa,EAAE,IAAI,EAAE,CAAA;IAClG,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,CAAA;AACpB,CAAC;AAED,KAAK,UAAU,KAAK,CAClB,OAAuB,EACvB,OAAe,EACf,MAAe,EACf,QAAgB,EAChB,QAAgC;IAEhC,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,OAAO,CAAA;IAC9C,SAAS,CAAC;QACR,MAAM,OAAO,GAAG,MAAM,QAAQ,EAAE,CAAA;QAChC,IAAI,OAAO,CAAC,aAAa,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC9D,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAA;YAC7B,OAAM;QACR,CAAC;QACD,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAA;QAChD,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;YACnB,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAA;YAC9B,MAAM,IAAI,QAAQ,CAChB,eAAe,EACf,YAAY,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,cAAc,OAAO,CAAC,QAAQ,WAAW,OAAO,MAAM,CAClG,CAAA;QACH,CAAC;QACD,MAAM,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAA;IACtE,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,OAAgB,EAAE,MAAe;IACxD,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;IAC3B,MAAM,GAAG,GAAG,CACV,QAAgB,EAChB,OAAmC,EACnC,QAAsD,EACvC,EAAE,CACjB,KAAK,CACH,OAAO,EACP,OAAO,EAAE,OAAO,IAAI,OAAO,CAAC,gBAAgB,EAC5C,MAAM,EACN,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,QAAQ,EAAE,EACnC,KAAK,IAAI,EAAE,CAAC,QAAQ,CAAC,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAC7C,CAAA;IACH,OAAO;QACL,WAAW,EAAE,CAAC,OAAO,EAAE,EAAE,CACvB,GAAG,CAAC,eAAe,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CACvC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CACzF;QACH,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE,CACtB,GAAG,CAAC,cAAc,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE;YACtC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAA;YACpD,OAAO,EAAE,IAAI,EAAE,KAAK,KAAK,CAAC,EAAE,QAAQ,EAAE,GAAG,KAAK,UAAU,EAAE,CAAA;QAC5D,CAAC,CAAC;QACJ,UAAU,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CAChC,GAAG,CAAC,gBAAgB,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAC1D,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACrB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC;YACtC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC5C,CAAC,CAAC,CACJ;QACH,aAAa,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CACnC,GAAG,CAAC,mBAAmB,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAC7D,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACrB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC;YACrC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SAC5C,CAAC,CAAC,CACJ;QACH,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CACjC,GAAG,CAAC,iBAAiB,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACrD,IAAI,EAAE,MAAM,CAAC,MAAM,KAAK,QAAQ;YAChC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;SAChC,CAAC,CAAC;QACL,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CACjC,GAAG,CAAC,iBAAiB,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAC3D,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE;YACnB,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,EAAE,CAAA;YAC3B,OAAO;gBACL,IAAI,EAAE,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC9E,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;aAChC,CAAA;QACH,CAAC,CAAC,CACH;QACH,IAAI,GAAG;YACL,OAAO,eAAe,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAA;QAC1C,CAAC;KACF,CAAA;AACH,CAAC;AAED,SAAS,WAAW,CAAC,MAAiB,EAAE,MAAe;IACrD,OAAO;QACL,SAAS,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CAC/B,KAAK,CACH,MAAM,CAAC,OAAO,EACd,OAAO,EAAE,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,EACnD,MAAM,EACN,aAAa,MAAM,CAAC,QAAQ,CAAC,EAAE,EAC/B,KAAK,IAAI,EAAE;YACT,MAAM,QAAQ,GACZ,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC;gBACtD,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE;gBACrB,CAAC,CAAC,MAAM,MAAM,CAAC,GAAG,EAAE,CAAA;YACxB,OAAO;gBACL,IAAI,EAAE,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACpF,QAAQ;aACT,CAAA;QACH,CAAC,CACF;QACH,IAAI,GAAG;YACL,OAAO,WAAW,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAA;QACrC,CAAC;KACF,CAAA;AACH,CAAC;AAID,MAAM,UAAU,MAAM,CAAC,OAA4B;IACjD,OAAO,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;AACnG,CAAC"}
package/dist/fake.d.ts ADDED
@@ -0,0 +1,35 @@
1
+ import { type ElementAction, type EngineFactory } from "./engine.js";
2
+ /** A node of the in-memory page tree the fake engine matches locators against. */
3
+ export interface FakeNode {
4
+ role?: string;
5
+ /** Accessible name, matched by `getByRole(role, name)`. */
6
+ name?: string;
7
+ /** Own text, matched by `getByText`. */
8
+ text?: string;
9
+ testId?: string;
10
+ /** Label text, matched by `getByLabel`. */
11
+ label?: string;
12
+ value?: string;
13
+ hidden?: boolean;
14
+ children?: FakeNode[];
15
+ }
16
+ export interface FakeLogEntry {
17
+ readonly kind: "goto" | ElementAction["kind"];
18
+ readonly detail: string;
19
+ }
20
+ export interface FakeEngineOptions {
21
+ /** Pages by `pathname + search`, falling back to bare `pathname`. */
22
+ readonly pages: Readonly<Record<string, readonly FakeNode[]>>;
23
+ /** Runs after a tap or press on the matched node; return a path to navigate to it. */
24
+ readonly onAct?: (node: FakeNode, action: ElementAction) => string | undefined;
25
+ }
26
+ /**
27
+ * An in-memory engine for tests of code built on `@nifrajs/e2e`: no browser, same locator
28
+ * semantics (case-insensitive substring unless `exact`). It does not wait; an `act` on a missing
29
+ * element throws at once.
30
+ */
31
+ export declare function fakeEngine(options: FakeEngineOptions): {
32
+ factory: EngineFactory;
33
+ log: FakeLogEntry[];
34
+ };
35
+ //# sourceMappingURL=fake.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fake.d.ts","sourceRoot":"","sources":["../src/fake.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,aAAa,EAGlB,KAAK,aAAa,EAGnB,MAAM,aAAa,CAAA;AAEpB,kFAAkF;AAClF,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAA;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAA;IAC7C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,qEAAqE;IACrE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,QAAQ,EAAE,CAAC,CAAC,CAAA;IAC7D,sFAAsF;IACtF,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,KAAK,MAAM,GAAG,SAAS,CAAA;CAC/E;AAuFD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG;IACtD,OAAO,EAAE,aAAa,CAAA;IACtB,GAAG,EAAE,YAAY,EAAE,CAAA;CACpB,CAsDA"}
package/dist/fake.js ADDED
@@ -0,0 +1,124 @@
1
+ import { E2EError, } from "./engine.js";
2
+ const normalize = (text) => text.replace(/\s+/g, " ").trim();
3
+ function textMatches(value, wanted, exact) {
4
+ return exact === true
5
+ ? normalize(value) === normalize(wanted)
6
+ : normalize(value).toLowerCase().includes(normalize(wanted).toLowerCase());
7
+ }
8
+ function textOf(node) {
9
+ return [node.text, ...(node.children ?? []).map(textOf)]
10
+ .filter((part) => part !== undefined && part !== "")
11
+ .join(" ");
12
+ }
13
+ function descend(nodes, hidden) {
14
+ return nodes.flatMap((node) => {
15
+ const isHidden = hidden || node.hidden === true;
16
+ return [{ node, visible: !isHidden }, ...descend(node.children ?? [], isHidden)];
17
+ });
18
+ }
19
+ function accepts(step, found) {
20
+ const { node } = found;
21
+ switch (step.kind) {
22
+ case "role":
23
+ return (node.role === step.role &&
24
+ (step.name === undefined || textMatches(node.name ?? "", step.name, step.exact)));
25
+ case "label":
26
+ return node.label !== undefined && textMatches(node.label, step.text, step.exact);
27
+ case "text":
28
+ return node.text !== undefined && textMatches(node.text, step.text, step.exact);
29
+ case "testId":
30
+ return node.testId === step.id;
31
+ case "hasText":
32
+ return textMatches(textOf(node), step.text, false);
33
+ case "nth":
34
+ return true;
35
+ }
36
+ }
37
+ function run(roots, selector) {
38
+ let scope = [{ node: { children: [...roots] }, visible: true }];
39
+ for (const step of selector) {
40
+ if (step.kind === "hasText") {
41
+ scope = scope.filter((found) => accepts(step, found));
42
+ continue;
43
+ }
44
+ if (step.kind === "nth") {
45
+ scope = scope.slice(step.index, step.index + 1);
46
+ continue;
47
+ }
48
+ const seen = new Set();
49
+ scope = scope
50
+ .flatMap((found) => descend(found.node.children ?? [], !found.visible))
51
+ .filter((found) => accepts(step, found) && !seen.has(found.node) && seen.add(found.node));
52
+ }
53
+ return scope;
54
+ }
55
+ function outline(nodes, depth) {
56
+ return nodes.flatMap((node) => {
57
+ if (node.hidden === true)
58
+ return [];
59
+ const indent = " ".repeat(depth);
60
+ const head = node.role ?? (node.text === undefined ? undefined : "text");
61
+ const name = node.role !== undefined && node.name !== undefined ? ` "${node.name}"` : "";
62
+ const own = node.text === undefined ? "" : `: ${node.text}`;
63
+ const children = outline(node.children ?? [], head === undefined ? depth : depth + 1);
64
+ return head === undefined ? children : [`${indent}- ${head}${name}${own}`, ...children];
65
+ });
66
+ }
67
+ function stateOf(found) {
68
+ const text = textOf(found.node);
69
+ return found.node.value === undefined
70
+ ? { visible: found.visible, text }
71
+ : { visible: found.visible, text, value: found.node.value };
72
+ }
73
+ export function fakeEngine(options) {
74
+ const log = [];
75
+ const factory = async () => {
76
+ let current = "";
77
+ let tree = [];
78
+ const engine = {
79
+ async goto(url) {
80
+ const target = new URL(url);
81
+ const key = `${target.pathname}${target.search}`;
82
+ const page = options.pages[key] ?? options.pages[target.pathname];
83
+ if (page === undefined)
84
+ throw new E2EError("NAVIGATION_FAILED", `no fake page for ${key}`);
85
+ log.push({ kind: "goto", detail: key });
86
+ current = url;
87
+ tree = structuredClone([...page]);
88
+ },
89
+ async url() {
90
+ return current;
91
+ },
92
+ async resolve(selector) {
93
+ return run(tree, selector).map(stateOf);
94
+ },
95
+ async snapshot() {
96
+ return outline(tree, 0).join("\n");
97
+ },
98
+ async act(selector, action) {
99
+ const found = run(tree, selector).filter((candidate) => candidate.visible);
100
+ const [match] = found;
101
+ if (match === undefined)
102
+ throw new E2EError("LOCATOR_NOT_FOUND", `no visible element for ${JSON.stringify(selector)}`);
103
+ if (found.length > 1)
104
+ throw new E2EError("LOCATOR_AMBIGUOUS", `${found.length} elements for ${JSON.stringify(selector)}`);
105
+ const { node } = match;
106
+ log.push({
107
+ kind: action.kind,
108
+ detail: action.kind === "fill" ? action.value : action.kind === "press" ? action.key : "",
109
+ });
110
+ if (action.kind === "fill") {
111
+ node.value = action.value;
112
+ return;
113
+ }
114
+ const next = options.onAct?.(node, action);
115
+ if (next !== undefined)
116
+ await engine.goto(new URL(next, current).href);
117
+ },
118
+ async close() { },
119
+ };
120
+ return engine;
121
+ };
122
+ return { factory, log };
123
+ }
124
+ //# sourceMappingURL=fake.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fake.js","sourceRoot":"","sources":["../src/fake.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,GAOT,MAAM,aAAa,CAAA;AAkCpB,MAAM,SAAS,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;AAE5E,SAAS,WAAW,CAAC,KAAa,EAAE,MAAc,EAAE,KAA0B;IAC5E,OAAO,KAAK,KAAK,IAAI;QACnB,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC,MAAM,CAAC;QACxC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC,CAAA;AAC9E,CAAC;AAED,SAAS,MAAM,CAAC,IAAc;IAC5B,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;SACrD,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,EAAE,CAAC;SACnD,IAAI,CAAC,GAAG,CAAC,CAAA;AACd,CAAC;AAED,SAAS,OAAO,CAAC,KAA0B,EAAE,MAAe;IAC1D,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC5B,MAAM,QAAQ,GAAG,MAAM,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAA;QAC/C,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAA;IAClF,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,IAAU,EAAE,KAAY;IACvC,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IACtB,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,MAAM;YACT,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;gBACvB,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CACjF,CAAA;QACH,KAAK,OAAO;YACV,OAAO,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QACnF,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;QACjF,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,CAAA;QAChC,KAAK,SAAS;YACZ,OAAO,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QACpD,KAAK,KAAK;YACR,OAAO,IAAI,CAAA;IACf,CAAC;AACH,CAAC;AAED,SAAS,GAAG,CAAC,KAA0B,EAAE,QAAkB;IACzD,IAAI,KAAK,GAAY,CAAC,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IACxE,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;YACrD,SAAQ;QACV,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YACxB,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;YAC/C,SAAQ;QACV,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAY,CAAA;QAChC,KAAK,GAAG,KAAK;aACV,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aACtE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;IAC7F,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,SAAS,OAAO,CAAC,KAA0B,EAAE,KAAa;IACxD,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC5B,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI;YAAE,OAAO,EAAE,CAAA;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACjC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;QACxE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;QACxF,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,EAAE,CAAA;QAC3D,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;QACrF,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,KAAK,IAAI,GAAG,IAAI,GAAG,GAAG,EAAE,EAAE,GAAG,QAAQ,CAAC,CAAA;IACzF,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,KAAY;IAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAC/B,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS;QACnC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE;QAClC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;AAC/D,CAAC;AAOD,MAAM,UAAU,UAAU,CAAC,OAA0B;IAInD,MAAM,GAAG,GAAmB,EAAE,CAAA;IAC9B,MAAM,OAAO,GAAkB,KAAK,IAAI,EAAE;QACxC,IAAI,OAAO,GAAG,EAAE,CAAA;QAChB,IAAI,IAAI,GAAe,EAAE,CAAA;QACzB,MAAM,MAAM,GAAW;YACrB,KAAK,CAAC,IAAI,CAAC,GAAG;gBACZ,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;gBAC3B,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,CAAA;gBAChD,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;gBACjE,IAAI,IAAI,KAAK,SAAS;oBAAE,MAAM,IAAI,QAAQ,CAAC,mBAAmB,EAAE,oBAAoB,GAAG,EAAE,CAAC,CAAA;gBAC1F,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;gBACvC,OAAO,GAAG,GAAG,CAAA;gBACb,IAAI,GAAG,eAAe,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;YACnC,CAAC;YACD,KAAK,CAAC,GAAG;gBACP,OAAO,OAAO,CAAA;YAChB,CAAC;YACD,KAAK,CAAC,OAAO,CAAC,QAAQ;gBACpB,OAAO,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;YACzC,CAAC;YACD,KAAK,CAAC,QAAQ;gBACZ,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACpC,CAAC;YACD,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM;gBACxB,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;gBAC1E,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAA;gBACrB,IAAI,KAAK,KAAK,SAAS;oBACrB,MAAM,IAAI,QAAQ,CAChB,mBAAmB,EACnB,0BAA0B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CACrD,CAAA;gBACH,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;oBAClB,MAAM,IAAI,QAAQ,CAChB,mBAAmB,EACnB,GAAG,KAAK,CAAC,MAAM,iBAAiB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAC3D,CAAA;gBACH,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;gBACtB,GAAG,CAAC,IAAI,CAAC;oBACP,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,MAAM,EAAE,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;iBAC1F,CAAC,CAAA;gBACF,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBAC3B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;oBACzB,OAAM;gBACR,CAAC;gBACD,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBAC1C,IAAI,IAAI,KAAK,SAAS;oBAAE,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAA;YACxE,CAAC;YACD,KAAK,CAAC,KAAK,KAAI,CAAC;SACjB,CAAA;QACD,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;IACD,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,CAAA;AACzB,CAAC"}
@@ -0,0 +1,11 @@
1
+ export type { ActionRecord, ActOptions, ActRequest, ActResult, Agent, AgentReport, E2EModel, ExtractOptions, ExtractRequest, HandOff, JudgeRequest, ModelRequest, StepOptions, WaitForOptions, } from "./agent.js";
2
+ export { formatReport } from "./agent.js";
3
+ export { type CacheEntry, type CacheMode, type CacheOptions, type CacheStore, fileCacheStore, memoryCacheStore, type RecordedAction, } from "./cache.js";
4
+ export type { ActDecision, PerformedDecision, Target, Verdict } from "./decision.js";
5
+ export { type Clock, E2EError, type E2EErrorCode, type ElementAction, type ElementState, type Engine, type EngineFactory, type EngineInit, type HydrationMode, type Selector, type Step, } from "./engine.js";
6
+ export { expect, type LocatorMatchers, type MatcherOptions, type UrlMatchers, type UrlSource, } from "./expect.js";
7
+ export { Locator, type LocatorContext, type RoleOptions, Screen, type TextOptions, } from "./locator.js";
8
+ export { type Param, type Params, Secret, Unique, unique } from "./params.js";
9
+ export type { StopReason } from "./replay.js";
10
+ export { type E2EOptions, type E2ESession, e2e, type OpenArgs, type OpenOptions, type PathParams, } from "./session.js";
11
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,YAAY,EACZ,UAAU,EACV,UAAU,EACV,SAAS,EACT,KAAK,EACL,WAAW,EACX,QAAQ,EACR,cAAc,EACd,cAAc,EACd,OAAO,EACP,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,cAAc,GACf,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,EACL,KAAK,UAAU,EACf,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,cAAc,EACd,gBAAgB,EAChB,KAAK,cAAc,GACpB,MAAM,YAAY,CAAA;AACnB,YAAY,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AACpF,OAAO,EACL,KAAK,KAAK,EACV,QAAQ,EACR,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,IAAI,GACV,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,MAAM,EACN,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,SAAS,GACf,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,OAAO,EACP,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,MAAM,EACN,KAAK,WAAW,GACjB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAC7E,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EACL,KAAK,UAAU,EACf,KAAK,UAAU,EACf,GAAG,EACH,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,UAAU,GAChB,MAAM,cAAc,CAAA"}
package/dist/index.js ADDED
@@ -0,0 +1,8 @@
1
+ export { formatReport } from "./agent.js";
2
+ export { fileCacheStore, memoryCacheStore, } from "./cache.js";
3
+ export { E2EError, } from "./engine.js";
4
+ export { expect, } from "./expect.js";
5
+ export { Locator, Screen, } from "./locator.js";
6
+ export { Secret, Unique, unique } from "./params.js";
7
+ export { e2e, } from "./session.js";
8
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,EAKL,cAAc,EACd,gBAAgB,GAEjB,MAAM,YAAY,CAAA;AAEnB,OAAO,EAEL,QAAQ,GAUT,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,MAAM,GAKP,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,OAAO,EAGP,MAAM,GAEP,MAAM,cAAc,CAAA;AACrB,OAAO,EAA2B,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAE7E,OAAO,EAGL,GAAG,GAIJ,MAAM,cAAc,CAAA"}
@@ -0,0 +1,3 @@
1
+ /** A non-null, non-array object. The prototype is not checked: a `Date` or a `Map` passes. */
2
+ export declare function isRecord(value: unknown): value is Record<string, unknown>;
3
+ //# sourceMappingURL=record.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../../src/internal/record.ts"],"names":[],"mappings":"AAAA,8FAA8F;AAE9F,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE"}
@@ -0,0 +1,4 @@
1
+ export function isRecord(value) {
2
+ return typeof value === "object" && value !== null && !Array.isArray(value);
3
+ }
4
+ //# sourceMappingURL=record.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"record.js","sourceRoot":"","sources":["../../src/internal/record.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC7E,CAAC"}
@@ -0,0 +1,53 @@
1
+ import type { Clock, ElementState, Engine, Selector } from "./engine.js";
2
+ export interface LocatorContext {
3
+ readonly engine: Engine;
4
+ readonly clock: Clock;
5
+ readonly actionTimeout: number;
6
+ readonly assertionTimeout: number;
7
+ readonly pollInterval: number;
8
+ /** Told when an assertion passes or fails, so the replay cache learns whether the steps before it held. */
9
+ readonly onCheck?: ((passed: boolean) => Promise<void>) | undefined;
10
+ }
11
+ export interface TextOptions {
12
+ readonly exact?: boolean;
13
+ }
14
+ export interface RoleOptions extends TextOptions {
15
+ readonly name?: string;
16
+ }
17
+ interface Finders {
18
+ getByRole(role: string, nameOrOptions?: string | RoleOptions): Locator;
19
+ getByLabel(text: string, options?: TextOptions): Locator;
20
+ getByText(text: string, options?: TextOptions): Locator;
21
+ getByTestId(id: string): Locator;
22
+ }
23
+ export declare class Locator implements Finders {
24
+ #private;
25
+ readonly context: LocatorContext;
26
+ readonly selector: Selector;
27
+ constructor(context: LocatorContext, selector: Selector);
28
+ getByRole(role: string, nameOrOptions?: string | RoleOptions): Locator;
29
+ getByLabel(text: string, options?: TextOptions): Locator;
30
+ getByText(text: string, options?: TextOptions): Locator;
31
+ getByTestId(id: string): Locator;
32
+ nth(index: number): Locator;
33
+ filter(options: {
34
+ readonly hasText: string;
35
+ }): Locator;
36
+ states(): Promise<readonly ElementState[]>;
37
+ count(): Promise<number>;
38
+ tap(): Promise<void>;
39
+ fill(value: string): Promise<void>;
40
+ press(key: string): Promise<void>;
41
+ describe(): string;
42
+ }
43
+ /** The page root: every chain starts here. */
44
+ export declare class Screen implements Finders {
45
+ #private;
46
+ constructor(context: LocatorContext);
47
+ getByRole(role: string, nameOrOptions?: string | RoleOptions): Locator;
48
+ getByLabel(text: string, options?: TextOptions): Locator;
49
+ getByText(text: string, options?: TextOptions): Locator;
50
+ getByTestId(id: string): Locator;
51
+ }
52
+ export {};
53
+ //# sourceMappingURL=locator.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"locator.d.ts","sourceRoot":"","sources":["../src/locator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAQ,MAAM,aAAa,CAAA;AAE9E,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;IACrB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;IACjC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,2GAA2G;IAC3G,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,SAAS,CAAA;CACpE;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,UAAU,OAAO;IACf,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO,CAAA;IACtE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAA;IACxD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAA;IACvD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAA;CACjC;AAmBD,qBAAa,OAAQ,YAAW,OAAO;;IACrC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAA;IAChC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;gBAEf,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ;IASvD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO;IAItE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO;IAIxD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO;IAIvD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAIhC,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAI3B,MAAM,CAAC,OAAO,EAAE;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO;IAItD,MAAM,IAAI,OAAO,CAAC,SAAS,YAAY,EAAE,CAAC;IAIpC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;IAI9B,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAIpB,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQlC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQjC,QAAQ,IAAI,MAAM;CAGnB;AAqBD,8CAA8C;AAC9C,qBAAa,MAAO,YAAW,OAAO;;gBAGxB,OAAO,EAAE,cAAc;IAInC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,OAAO;IAItE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO;IAIxD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO;IAIvD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;CAGjC"}
@@ -0,0 +1,102 @@
1
+ function roleStep(role, nameOrOptions) {
2
+ const options = typeof nameOrOptions === "string" ? { name: nameOrOptions } : nameOrOptions;
3
+ const step = {
4
+ kind: "role",
5
+ role,
6
+ };
7
+ if (options?.name !== undefined)
8
+ step.name = options.name;
9
+ if (options?.exact !== undefined)
10
+ step.exact = options.exact;
11
+ return step;
12
+ }
13
+ function textStep(kind, text, options) {
14
+ const step = { kind, text };
15
+ if (options?.exact !== undefined)
16
+ step.exact = options.exact;
17
+ return step;
18
+ }
19
+ export class Locator {
20
+ context;
21
+ selector;
22
+ constructor(context, selector) {
23
+ this.context = context;
24
+ this.selector = selector;
25
+ }
26
+ #then(step) {
27
+ return new Locator(this.context, [...this.selector, step]);
28
+ }
29
+ getByRole(role, nameOrOptions) {
30
+ return this.#then(roleStep(role, nameOrOptions));
31
+ }
32
+ getByLabel(text, options) {
33
+ return this.#then(textStep("label", text, options));
34
+ }
35
+ getByText(text, options) {
36
+ return this.#then(textStep("text", text, options));
37
+ }
38
+ getByTestId(id) {
39
+ return this.#then({ kind: "testId", id });
40
+ }
41
+ nth(index) {
42
+ return this.#then({ kind: "nth", index });
43
+ }
44
+ filter(options) {
45
+ return this.#then({ kind: "hasText", text: options.hasText });
46
+ }
47
+ states() {
48
+ return this.context.engine.resolve(this.selector);
49
+ }
50
+ async count() {
51
+ return (await this.states()).length;
52
+ }
53
+ tap() {
54
+ return this.context.engine.act(this.selector, { kind: "tap" }, this.context.actionTimeout);
55
+ }
56
+ fill(value) {
57
+ return this.context.engine.act(this.selector, { kind: "fill", value }, this.context.actionTimeout);
58
+ }
59
+ press(key) {
60
+ return this.context.engine.act(this.selector, { kind: "press", key }, this.context.actionTimeout);
61
+ }
62
+ describe() {
63
+ return this.selector.map(describeStep).join(" >> ");
64
+ }
65
+ }
66
+ function describeStep(step) {
67
+ switch (step.kind) {
68
+ case "role":
69
+ return step.name === undefined
70
+ ? `role=${step.role}`
71
+ : `role=${step.role}[name="${step.name}"]`;
72
+ case "label":
73
+ return `label="${step.text}"`;
74
+ case "text":
75
+ return `text="${step.text}"`;
76
+ case "testId":
77
+ return `testId="${step.id}"`;
78
+ case "hasText":
79
+ return `hasText="${step.text}"`;
80
+ case "nth":
81
+ return `nth=${step.index}`;
82
+ }
83
+ }
84
+ export class Screen {
85
+ #root;
86
+ constructor(context) {
87
+ this.#root = new Locator(context, []);
88
+ }
89
+ getByRole(role, nameOrOptions) {
90
+ return this.#root.getByRole(role, nameOrOptions);
91
+ }
92
+ getByLabel(text, options) {
93
+ return this.#root.getByLabel(text, options);
94
+ }
95
+ getByText(text, options) {
96
+ return this.#root.getByText(text, options);
97
+ }
98
+ getByTestId(id) {
99
+ return this.#root.getByTestId(id);
100
+ }
101
+ }
102
+ //# sourceMappingURL=locator.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"locator.js","sourceRoot":"","sources":["../src/locator.ts"],"names":[],"mappings":"AA2BA,SAAS,QAAQ,CAAC,IAAY,EAAE,aAA+C;IAC7E,MAAM,OAAO,GAAG,OAAO,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,aAAa,CAAA;IAC3F,MAAM,IAAI,GAAmE;QAC3E,IAAI,EAAE,MAAM;QACZ,IAAI;KACL,CAAA;IACD,IAAI,OAAO,EAAE,IAAI,KAAK,SAAS;QAAE,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA;IACzD,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS;QAAE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;IAC5D,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,QAAQ,CAAC,IAAsB,EAAE,IAAY,EAAE,OAAgC;IACtF,MAAM,IAAI,GAA8D,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IACtF,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS;QAAE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;IAC5D,OAAO,IAAI,CAAA;AACb,CAAC;AAED,MAAM,OAAO,OAAO;IACT,OAAO,CAAgB;IACvB,QAAQ,CAAU;IAE3B,YAAY,OAAuB,EAAE,QAAkB;QACrD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;IAED,KAAK,CAAC,IAAU;QACd,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;IAC5D,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,aAAoC;QAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAA;IAClD,CAAC;IAED,UAAU,CAAC,IAAY,EAAE,OAAqB;QAC5C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IACrD,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,OAAqB;QAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IACpD,CAAC;IAED,WAAW,CAAC,EAAU;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAA;IAC3C,CAAC;IAED,GAAG,CAAC,KAAa;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;IAC3C,CAAC;IAED,MAAM,CAAC,OAAqC;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IAC/D,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACnD,CAAC;IAED,KAAK,CAAC,KAAK;QACT,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAA;IACrC,CAAC;IAED,GAAG;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;IAC5F,CAAC;IAED,IAAI,CAAC,KAAa;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAC5B,IAAI,CAAC,QAAQ,EACb,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,EACvB,IAAI,CAAC,OAAO,CAAC,aAAa,CAC3B,CAAA;IACH,CAAC;IAED,KAAK,CAAC,GAAW;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAC5B,IAAI,CAAC,QAAQ,EACb,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,EACtB,IAAI,CAAC,OAAO,CAAC,aAAa,CAC3B,CAAA;IACH,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IACrD,CAAC;CACF;AAED,SAAS,YAAY,CAAC,IAAU;IAC9B,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS;gBAC5B,CAAC,CAAC,QAAQ,IAAI,CAAC,IAAI,EAAE;gBACrB,CAAC,CAAC,QAAQ,IAAI,CAAC,IAAI,UAAU,IAAI,CAAC,IAAI,IAAI,CAAA;QAC9C,KAAK,OAAO;YACV,OAAO,UAAU,IAAI,CAAC,IAAI,GAAG,CAAA;QAC/B,KAAK,MAAM;YACT,OAAO,SAAS,IAAI,CAAC,IAAI,GAAG,CAAA;QAC9B,KAAK,QAAQ;YACX,OAAO,WAAW,IAAI,CAAC,EAAE,GAAG,CAAA;QAC9B,KAAK,SAAS;YACZ,OAAO,YAAY,IAAI,CAAC,IAAI,GAAG,CAAA;QACjC,KAAK,KAAK;YACR,OAAO,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;IAC9B,CAAC;AACH,CAAC;AAGD,MAAM,OAAO,MAAM;IACR,KAAK,CAAS;IAEvB,YAAY,OAAuB;QACjC,IAAI,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IACvC,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,aAAoC;QAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;IAClD,CAAC;IAED,UAAU,CAAC,IAAY,EAAE,OAAqB;QAC5C,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAC7C,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,OAAqB;QAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAC5C,CAAC;IAED,WAAW,CAAC,EAAU;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;IACnC,CAAC;CACF"}
@@ -0,0 +1,44 @@
1
+ /**
2
+ * A value a step may use but the model must never read: it is typed into the page by name, and
3
+ * `String(secret)`, `JSON.stringify(secret)` and template literals all print the name only.
4
+ */
5
+ export declare class Secret {
6
+ #private;
7
+ readonly name: string;
8
+ constructor(name: string, value: string);
9
+ /** Read by the step runner when it types the value; nothing else should call it. */
10
+ static reveal(secret: Secret): string;
11
+ toJSON(): string;
12
+ toString(): string;
13
+ }
14
+ /**
15
+ * Run-varying data (a generated email, a timestamp). The model and the page get the value; the replay
16
+ * cache keys on the fact that it varies, so a new value does not miss, and re-types the new value.
17
+ */
18
+ export declare class Unique {
19
+ readonly value: string;
20
+ constructor(value: string);
21
+ toString(): string;
22
+ }
23
+ export declare function unique(value: string | number): Unique;
24
+ export type Param = string | number | boolean | Secret | Unique;
25
+ export type Params = Readonly<Record<string, Param>>;
26
+ /** `{name}` becomes the param's value, except a secret, which stays `{name}` and is listed by name. */
27
+ export declare function forModel(text: string, params: Params): {
28
+ readonly text: string;
29
+ readonly secrets: readonly string[];
30
+ };
31
+ /** `{name}` becomes the real value, a secret's included. Run only on text headed for the page. */
32
+ export declare function forPage(text: string, params: Params): string;
33
+ /** A secret and the name it was given, which is the placeholder that stands in for its value. */
34
+ export type NamedSecret = readonly [name: string, secret: Secret];
35
+ /** Every secret value in `text` replaced by its placeholder, so a page that echoes one cannot leak it. */
36
+ export declare function redactSecrets(text: string, secrets: readonly NamedSecret[]): string;
37
+ export declare function redact(text: string, params: Params): string;
38
+ /** The params as a replay-cache key sees them: plain values by value, a secret or a unique by kind. */
39
+ export declare function keyParams(params: Params): string;
40
+ /** Every unique value found literally in `text` turned back into its `{name}`, so a recording survives a new value. */
41
+ export declare function templatize(text: string, params: Params): string;
42
+ /** `{name}` becomes the current value of a unique param; any other placeholder stays. */
43
+ export declare function fillUnique(text: string, params: Params): string;
44
+ //# sourceMappingURL=params.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../src/params.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,MAAM;;IACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;gBAGT,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAKvC,oFAAoF;IACpF,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAIrC,MAAM,IAAI,MAAM;IAIhB,QAAQ,IAAI,MAAM;CAGnB;AAED;;;GAGG;AACH,qBAAa,MAAM;IACjB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;gBAEV,KAAK,EAAE,MAAM;IAIzB,QAAQ,IAAI,MAAM;CAGnB;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAErD;AAED,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;AAC/D,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAA;AAIpD,uGAAuG;AACvG,wBAAgB,QAAQ,CACtB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,GACb;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAYhE;AAED,kGAAkG;AAClG,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAM5D;AAED,iGAAiG;AACjG,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;AAEjE,0GAA0G;AAC1G,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,WAAW,EAAE,GAAG,MAAM,CAOnF;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAM3D;AAED,uGAAuG;AACvG,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQhD;AAED,uHAAuH;AACvH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAO/D;AAED,yFAAyF;AACzF,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAK/D"}