@immense/vue-pom-generator 1.0.92 → 1.0.93

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 CHANGED
@@ -594,6 +594,22 @@ This is where most people need precision.
594
594
 
595
595
  Every `.ts` file in `customPoms.dir` is available for import from the generated TypeScript output.
596
596
 
597
+ Handwritten helpers that extend the generator runtime should use its public entry point:
598
+
599
+ ```ts
600
+ import { BasePage } from "@immense/vue-pom-generator/playwright/runtime";
601
+
602
+ export class DataGrid extends BasePage {
603
+ async selectFirstRow(): Promise<void> {
604
+ await this.page.getByRole("row").nth(1).click();
605
+ }
606
+ }
607
+ ```
608
+
609
+ Do not import from a consumer's generated `_pom-runtime` directory. That directory is regenerated
610
+ and is an implementation detail of the emitted files; the package export is the stable contract for
611
+ handwritten POMs.
612
+
597
613
  - in aggregated mode, helper files become imports in the shared aggregate
598
614
  - in split mode, each generated file imports only the helpers it actually needs
599
615
 
package/RELEASE_NOTES.md CHANGED
@@ -1,119 +1,36 @@
1
- I'll verify the actual merged PRs in the release window by querying the repository directly, and
2
- check the git log between the tags.
1
+ I'll verify the actual release contents before writing notes, since the provided PR list appears
2
+ much longer than the diff suggests.
3
3
 
4
- Let me check the v1.0.91 tag to understand the boundary, and verify the PR merge details.
4
+ v1.0.92's tip is #54, so only #56 is new in v1.0.93. Let me inspect the actual diff for accurate
5
+ notes.
5
6
 
6
- Let me retry those queries.
7
-
8
- Now I understand the picture. The v1.0.91 tag is at commit #53, so v1.0.92 contains only PR #54. Let
9
- me examine the key changed files to write accurate release notes.
10
-
11
- Let me check the diagnostics module and README changes to round out the picture.
12
-
13
- I now have a complete picture. v1.0.91 was tagged at PR #53's commit, so v1.0.92 contains only PR
14
- #54. Let me write the release notes.
7
+ Verification complete: v1.0.92 was tagged at #54's merge, so v1.0.93 contains only PR #56. Here are
8
+ the release notes.
15
9
 
16
10
  Highlights
17
11
 
18
- - Fast, actionable Playwright failure diagnostics — generated fixtures now capture the full failure
19
- state (URL, rendered test IDs, accessibility snapshot, console errors, failed requests, HTTP
20
- response bodies, active action, and POM method catalog) before the browser context is destroyed,
21
- within a five-second budget.
22
- - Bundled Playwright reporter — a new @immense/vue-pom-generator/playwright/reporter subpath prints
23
- diagnostics as one bounded, LLM-friendly stdout block and emits a structured JSON attachment.
24
- - Generated POM manifest — a new pom-manifest.g.ts artifact maps Vue source/test IDs to their
25
- generated methods, consumable at runtime by the diagnostics layer.
26
- - Composable recommended ESLint config — recommendedPlaywrightConfig composes generator-specific
27
- rules with eslint-plugin-playwright, banning manual waits, networkidle, selector waits, forced
28
- actions, and non-web-first assertions.
29
- - Five-second action failure budget — generated actions now fail fast instead of waiting out
30
- Playwright's default timeout, and redundant runtime waits have been removed.
31
- - Finite-animation awareness — generated clicks await finite CSS animations on the target's
32
- ancestor chain (bounded to five seconds); infinite decorative animations are ignored.
12
+ - New public package entry point @immense/vue-pom-generator/playwright/runtime exposes the BasePage
13
+ runtime for handwritten POMs to extend.
14
+ - README documents the stable runtime contract and warns against importing from the regenerated
15
+ _pom-runtime directory.
16
+ - Packed smoke check now verifies the runtime entry exports BasePage and ObjectId from a packed
17
+ install.
33
18
 
34
19
  Changes
35
20
 
36
- Diagnostics & Reporting
37
-
38
- - Added class-generation/diagnostics.ts — installs a failure-capture wrapper around the browser
39
- page that gathers URL/title, rendered test IDs with visible/enabled state, the best-matching POM and
40
- its method catalog, the most recent generated action and expected test-id candidates, an
41
- accessibility snapshot, buffered console/page errors, failed requests, bounded HTTP failure bodies,
42
- a screenshot, and a JSON attachment.
43
- - Added playwright/reporter.ts — a Playwright reporter that reads the diagnostics attachment and
44
- prints a single bounded stdout block; ends with a file-and-line-targeted rerun command including
45
- --max-failures=1.
46
- - Exported a new package subpath @immense/vue-pom-generator/playwright/reporter.
47
- - Method availability is reported descriptively (absent, hidden, disabled) rather than as errors,
48
- so conditional UI states remain obvious without false failures.
49
-
50
- POM Manifest
51
-
52
- - Added pom-manifest.g.ts — a Node-importable map from Vue source/test IDs to generated methods,
53
- consumed by the diagnostics layer to report method availability.
54
- - Introduced manifest types (PomManifest, PomManifestComponent, PomManifestMethod,
55
- PomManifestEntry) in the diagnostics module.
56
- - Updated manifest-generator.ts to emit the new manifest artifact alongside existing POM output.
57
-
58
- ESLint
59
-
60
- - Added recommendedPlaywrightConfig — a composable flat config that merges
61
- eslint-plugin-playwright's recommended rules with the generator's own rules.
62
- - Enabled playwright/no-wait-for-timeout, playwright/no-networkidle,
63
- playwright/no-wait-for-selector, playwright/no-force-option, and
64
- playwright/prefer-web-first-assertions as errors.
65
- - Banned low-level POM action helpers (clickByTestId, clickLocator) via the no-raw-locator-action
66
- rule.
67
- - Added scrollIntoViewIfNeeded to the recognized locator-action set.
68
- - Restructured the plugin export to include a configs record alongside rules.
69
- - Added eslint-plugin-playwright (^2.11.0) as a runtime dependency.
70
-
71
- Action & Animation Behavior
72
-
73
- - Generated actions now fail within a five-second total budget; redundant runtime waits removed.
74
- - Generated clicks await finite CSS animations on the target's ancestor chain before proceeding,
75
- bounded to five seconds; infinite decorative animations are ignored.
76
- - Animations and presentation delays are disabled by default; recording/demo projects opt in via
77
- the generated animation fixture option.
78
-
79
- Codegen & Navigation
80
-
81
- - Centralized router navigation emission in route-navigation-codegen.ts; cold pages now boot the
82
- application, wait for Vue Router's initial navigation to settle, then use router.push, while warm
83
- pages use the same awaited push without re-booting.
84
- - Tightened fragment, wrapper, radio, checkbox, pointer, and transitive-POM codegen behavior
85
- uncovered by consumer testing.
86
- - Updated class-generation/base-page.ts, class-generation/index.ts, class-generation/pointer.ts,
87
- class-generation/playwright-types.ts, method-generation.ts, transform.ts, and router-bridge.ts to
88
- support the above.
89
-
90
- Plugin & Build
91
-
92
- - Updated plugin/internal-plugins.ts, plugin/internal/build-plugin.ts, and
93
- plugin/internal/dev-plugin.ts for manifest and reporter integration.
94
- - Updated vite.config.ts and scripts/packed-smoke-check.mjs accordingly.
95
-
96
- Documentation
97
-
98
- - Expanded README.md with sections on fast Playwright failures, the bundled reporter, the POM
99
- manifest, recommended lint rules, and animation handling.
100
-
101
- Breaking Changes
102
-
103
- - New peer dependency — @playwright/test (>=1.61.0 <2) is now a required peer dependency.
104
- - Five-second action budget — generated actions fail within five seconds instead of relying on
105
- Playwright's default timeout; tests depending on longer timeouts will fail sooner.
106
- - Animations disabled by default — presentation delays are off unless explicitly opted in via the
107
- generated animation fixture option.
21
+ - Packaging: Added the ./playwright/runtime subpath export (types/import/require) pointing at
22
+ dist/class-generation/base-page.d.ts and dist/playwright/runtime.{mjs,cjs}.
23
+ - Build: Registered the playwright/runtime source entry in vite.config.ts.
24
+ - Docs: Documented importing BasePage from the public runtime entry for handwritten helpers, and
25
+ clarified that a consumer's generated _pom-runtime directory is an implementation detail that should
26
+ not be imported directly.
108
27
 
109
28
  Pull Requests Included
110
29
 
111
- - ]8;id=md-1fivfqz;https://github.com/immense/vue-pom-generator/pull/54#54 — Add fast, actionable Playwright diagnostics]8;;]8;; (@dkattan)]8;;
30
+ - ]8;id=md-1g2un4x;https://github.com/immense/vue-pom-generator/pull/56#56 feat(playwright): export POM runtime]8;;]8;; (@dkattan)]8;;
112
31
 
113
32
  Testing
114
33
 
115
- Validated per the PR: npm test (401 passed), npm run typecheck, npm run lint, npm run smoke:pack,
116
- and a full Immy Aspire-backed Playwright suite with --max-failures=1 (passed in 4m37s). New test
117
- suites added for diagnostics (tests/playwright-diagnostics.test.ts) and the reporter
118
- (tests/playwright-reporter.test.ts), plus tests/method-generation.test.ts.
34
+ - Extended scripts/packed-smoke-check.mjs to assert the public runtime entry exports BasePage and
35
+ ObjectId from a packed tarball install.
119
36