@keboola/validate-ui 0.2.0 → 0.4.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/cli.cjs CHANGED
@@ -1,16 +1,17 @@
1
1
  #!/usr/bin/env node
2
2
  'use strict';
3
3
 
4
+ var promises = require('fs/promises');
4
5
  var path = require('path');
5
6
  var process2 = require('process');
6
7
  var playwright = require('playwright');
7
- var axe = require('axe-core');
8
8
  var zod = require('zod');
9
+ var axe = require('axe-core');
9
10
  var Anthropic = require('@anthropic-ai/sdk');
10
11
  var pixelmatch = require('pixelmatch');
11
12
  var pngjs = require('pngjs');
13
+ var brandRegistry = require('@keboola/brand-registry');
12
14
  var fs = require('fs');
13
- var promises = require('fs/promises');
14
15
  var http = require('http');
15
16
 
16
17
  function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
@@ -20,6 +21,441 @@ var axe__default = /*#__PURE__*/_interopDefault(axe);
20
21
  var Anthropic__default = /*#__PURE__*/_interopDefault(Anthropic);
21
22
  var pixelmatch__default = /*#__PURE__*/_interopDefault(pixelmatch);
22
23
 
24
+ // src/prepare-screenshot.ts
25
+ var disableAnimations = async (page) => {
26
+ await page.addStyleTag({
27
+ content: `*, *::before, *::after {
28
+ animation-duration: 0s !important;
29
+ animation-delay: 0s !important;
30
+ transition-duration: 0s !important;
31
+ transition-delay: 0s !important;
32
+ caret-color: transparent !important;
33
+ }`
34
+ });
35
+ };
36
+ var parkMouseOffElements = async (page) => {
37
+ await page.mouse.move(0, 0);
38
+ };
39
+ var waitForFonts = async (page) => {
40
+ await page.evaluate(() => document.fonts.ready.then(() => void 0));
41
+ };
42
+ var prepareForScreenshot = async (page) => {
43
+ await disableAnimations(page);
44
+ await parkMouseOffElements(page);
45
+ await waitForFonts(page);
46
+ };
47
+
48
+ // src/capture.ts
49
+ var DESKTOP_VIEWPORT = { label: "desktop", width: 1280, height: 800 };
50
+ var DEFAULT_TIMEOUT_MS = 3e4;
51
+ var attachRecorders = (page) => {
52
+ const consoleEntries = [];
53
+ const networkEntries = [];
54
+ page.on("console", (message) => {
55
+ consoleEntries.push({
56
+ type: message.type(),
57
+ text: message.text(),
58
+ location: message.location().url || void 0
59
+ });
60
+ });
61
+ page.on("pageerror", (error) => {
62
+ consoleEntries.push({ type: "pageerror", text: error.message });
63
+ });
64
+ page.on("requestfailed", (request) => {
65
+ networkEntries.push({
66
+ url: request.url(),
67
+ method: request.method(),
68
+ status: 0,
69
+ failure: request.failure()?.errorText
70
+ });
71
+ });
72
+ page.on("response", (response) => {
73
+ networkEntries.push({
74
+ url: response.url(),
75
+ method: response.request().method(),
76
+ status: response.status()
77
+ });
78
+ });
79
+ return { console: consoleEntries, network: networkEntries };
80
+ };
81
+ var capturePage = async (page, url, viewport, timeoutMs = DEFAULT_TIMEOUT_MS) => {
82
+ const recorders = attachRecorders(page);
83
+ await page.setViewportSize({ width: viewport.width, height: viewport.height });
84
+ await page.goto(url, { waitUntil: "networkidle", timeout: timeoutMs });
85
+ await prepareForScreenshot(page);
86
+ const screenshot = await page.screenshot({ fullPage: true });
87
+ const dom = await page.content();
88
+ const renderedText = (await page.evaluate(() => document.body.innerText)).trim();
89
+ return {
90
+ url,
91
+ viewport,
92
+ screenshot,
93
+ dom,
94
+ renderedText,
95
+ console: recorders.console,
96
+ network: recorders.network
97
+ };
98
+ };
99
+
100
+ // src/compare/dedup.ts
101
+ var groupKey = (finding) => `${finding.kind}::${finding.valueSignature}`;
102
+ var dedupeSharedChrome = (perRoute) => {
103
+ const routesByGroup = /* @__PURE__ */ new Map();
104
+ for (const { route, findings } of perRoute) {
105
+ for (const finding of findings) {
106
+ const key = groupKey(finding);
107
+ const routes = routesByGroup.get(key) ?? /* @__PURE__ */ new Set();
108
+ routes.add(route);
109
+ routesByGroup.set(key, routes);
110
+ }
111
+ }
112
+ const sharedGroups = new Set(
113
+ [...routesByGroup].filter(([, routes]) => routes.size >= 2).map(([key]) => key)
114
+ );
115
+ const sharedChrome = [];
116
+ const seenShared = /* @__PURE__ */ new Set();
117
+ const trimmedPerRoute = perRoute.map(({ route, findings }) => ({
118
+ route,
119
+ findings: findings.filter((finding) => !sharedGroups.has(groupKey(finding)))
120
+ }));
121
+ for (const { findings } of perRoute) {
122
+ for (const finding of findings) {
123
+ const key = groupKey(finding);
124
+ if (!sharedGroups.has(key) || seenShared.has(key)) continue;
125
+ seenShared.add(key);
126
+ const routes = [...routesByGroup.get(key) ?? []].sort();
127
+ sharedChrome.push({
128
+ ...finding,
129
+ message: `${finding.message} (shared across ${routes.length} routes: ${routes.join(", ")})`
130
+ });
131
+ }
132
+ }
133
+ return { sharedChrome, perRoute: trimmedPerRoute };
134
+ };
135
+
136
+ // src/compare/diff.ts
137
+ var matchesGlob = (pattern, value) => {
138
+ if (!pattern.includes("*")) return pattern === value;
139
+ const escaped = pattern.replace(/[.+?^${}()|[\]\\]/g, "\\$&").replace(/\*/g, ".*");
140
+ return new RegExp(`^${escaped}$`).test(value);
141
+ };
142
+ var multisetMissing = (from, to) => {
143
+ const remaining = /* @__PURE__ */ new Map();
144
+ for (const value of to) remaining.set(value, (remaining.get(value) ?? 0) + 1);
145
+ const missing = [];
146
+ for (const value of from) {
147
+ const count = remaining.get(value) ?? 0;
148
+ if (count > 0) remaining.set(value, count - 1);
149
+ else missing.push(value);
150
+ }
151
+ return missing;
152
+ };
153
+ var signature = (regionKey, tokens) => `${regionKey}::${[...tokens].sort().join("|")}`;
154
+ var regionRemovalRule = (rules, key) => rules.find(
155
+ (rule) => rule.value === void 0 && rule.region !== void 0 && matchesGlob(rule.region, key)
156
+ );
157
+ var valueRuleMatches = (rule, key, value) => rule.value !== void 0 && matchesGlob(rule.value, value) && (rule.region === void 0 || matchesGlob(rule.region, key));
158
+ var removedFinding = (region, rule) => ({
159
+ regionKey: region.key,
160
+ kind: "region-removed",
161
+ valueSignature: signature(region.key, region.values),
162
+ message: rule === void 0 ? `region "${region.label}" was removed` : `region "${region.label}" removed as expected`,
163
+ severity: rule === void 0 ? "serious" : "minor",
164
+ ...rule !== void 0 && { suppressed: { reason: rule.reason } }
165
+ });
166
+ var degradedFinding = (region) => ({
167
+ regionKey: region.key,
168
+ kind: "region-degraded",
169
+ valueSignature: signature(region.key, [region.state]),
170
+ message: `region "${region.label}" degraded to ${region.state} state \u2014 not compared as value loss`,
171
+ severity: "minor"
172
+ });
173
+ var addedFinding = (region) => ({
174
+ regionKey: region.key,
175
+ kind: "region-added",
176
+ valueSignature: signature(region.key, []),
177
+ message: `region "${region.label}" is new`,
178
+ severity: "minor"
179
+ });
180
+ var diffRegionValues = (oldRegion, newRegion, rules) => {
181
+ const missing = multisetMissing(oldRegion.values, newRegion.values);
182
+ if (missing.length === 0) return [];
183
+ const active = [];
184
+ const suppressed = [];
185
+ const reasons = /* @__PURE__ */ new Set();
186
+ for (const value of missing) {
187
+ const rule = rules.find((r) => valueRuleMatches(r, newRegion.key, value));
188
+ if (rule === void 0) active.push(value);
189
+ else {
190
+ suppressed.push(value);
191
+ reasons.add(rule.reason);
192
+ }
193
+ }
194
+ const findings = [];
195
+ if (active.length > 0) {
196
+ findings.push({
197
+ regionKey: newRegion.key,
198
+ kind: "value-missing",
199
+ valueSignature: signature(newRegion.key, active),
200
+ message: `region "${newRegion.label}" is missing ${active.length} value(s)`,
201
+ severity: "moderate",
202
+ detail: active.join(", ")
203
+ });
204
+ }
205
+ if (suppressed.length > 0) {
206
+ findings.push({
207
+ regionKey: newRegion.key,
208
+ kind: "value-missing",
209
+ valueSignature: signature(newRegion.key, suppressed),
210
+ message: `region "${newRegion.label}" is missing ${suppressed.length} expected value(s)`,
211
+ severity: "minor",
212
+ detail: suppressed.join(", "),
213
+ suppressed: { reason: [...reasons].join("; ") }
214
+ });
215
+ }
216
+ return findings;
217
+ };
218
+ var diffSnapshots = (oldSnap, newSnap, config = {}) => {
219
+ const rules = config.expectedAbsent ?? [];
220
+ const newByKey = new Map(newSnap.regions.map((region) => [region.key, region]));
221
+ const oldKeys = new Set(oldSnap.regions.map((region) => region.key));
222
+ const findings = [];
223
+ for (const oldRegion of oldSnap.regions) {
224
+ const newRegion = newByKey.get(oldRegion.key);
225
+ if (newRegion === void 0) {
226
+ findings.push(removedFinding(oldRegion, regionRemovalRule(rules, oldRegion.key)));
227
+ continue;
228
+ }
229
+ if (oldRegion.state === "ok" && newRegion.state !== "ok") {
230
+ findings.push(degradedFinding(newRegion));
231
+ continue;
232
+ }
233
+ findings.push(...diffRegionValues(oldRegion, newRegion, rules));
234
+ }
235
+ for (const newRegion of newSnap.regions) {
236
+ if (!oldKeys.has(newRegion.key)) findings.push(addedFinding(newRegion));
237
+ }
238
+ return findings;
239
+ };
240
+ var comparePass = (findings) => !findings.some(
241
+ (f) => f.suppressed === void 0 && (f.severity === "serious" || f.severity === "critical")
242
+ );
243
+
244
+ // src/compare/regions.ts
245
+ var CANDIDATE_SELECTOR = [
246
+ "[data-region]",
247
+ "main",
248
+ "nav",
249
+ "header",
250
+ "aside",
251
+ "footer",
252
+ "section[aria-label]",
253
+ "[role=main]",
254
+ "[role=navigation]",
255
+ "[role=banner]",
256
+ "[role=complementary]",
257
+ "[role=contentinfo]",
258
+ "[role=region]"
259
+ ].join(",");
260
+ var DEFAULT_EMPTY_MARKERS = [
261
+ "no data",
262
+ "no results",
263
+ "nothing to show",
264
+ "nothing here",
265
+ "get started"
266
+ ];
267
+ var DEFAULT_ERROR_MARKERS = [
268
+ "something went wrong",
269
+ "failed to load",
270
+ "could not load",
271
+ "unavailable",
272
+ "try again"
273
+ ];
274
+ var extractRegions = async (page, config = {}) => {
275
+ const emptyMarkers = [...DEFAULT_EMPTY_MARKERS, ...config.emptyStateMarkers ?? []];
276
+ const errorMarkers = [...DEFAULT_ERROR_MARKERS, ...config.errorStateMarkers ?? []];
277
+ return page.evaluate(
278
+ ({ selector, emptyMarkers: emptyMarkers2, errorMarkers: errorMarkers2 }) => {
279
+ const STATES = ["ok", "empty", "error", "loading"];
280
+ const isState = (value) => STATES.includes(value);
281
+ const slugify = (raw) => raw.toLowerCase().trim().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "").slice(0, 60) || "region";
282
+ const roleOf = (el) => {
283
+ const explicit = el.getAttribute("role");
284
+ if (explicit !== null && explicit !== "") return explicit;
285
+ const tag = el.tagName.toLowerCase();
286
+ if (tag === "main") return "main";
287
+ if (tag === "nav") return "navigation";
288
+ if (tag === "aside") return "complementary";
289
+ if (tag === "header" || tag === "footer") {
290
+ if (el.closest("main,nav,section,article,aside") !== null) return void 0;
291
+ return tag === "header" ? "banner" : "contentinfo";
292
+ }
293
+ return void 0;
294
+ };
295
+ const headingOf = (el) => {
296
+ const heading = el.querySelector("h1,h2,h3,h4,h5,h6");
297
+ const text = heading?.textContent?.trim();
298
+ return text !== void 0 && text !== "" ? text : void 0;
299
+ };
300
+ const keyOf = (el) => {
301
+ const region = el.getAttribute("data-region");
302
+ if (region !== null && region !== "") return slugify(region);
303
+ const testid = el.getAttribute("data-testid");
304
+ if (testid !== null && testid !== "") return slugify(testid);
305
+ const role = roleOf(el);
306
+ if (role !== void 0) return role;
307
+ const label = el.getAttribute("aria-label");
308
+ if (label !== null && label !== "") return slugify(label);
309
+ const heading = headingOf(el);
310
+ if (heading !== void 0) return slugify(heading);
311
+ return slugify(el.tagName);
312
+ };
313
+ const labelOf = (el, key) => {
314
+ const label = el.getAttribute("aria-label");
315
+ if (label !== null && label.trim() !== "") return label.trim();
316
+ const heading = headingOf(el);
317
+ if (heading !== void 0) return heading;
318
+ const testid = el.getAttribute("data-testid");
319
+ if (testid !== null && testid !== "") return testid;
320
+ return key;
321
+ };
322
+ const textOf = (el) => (el.innerText || el.textContent || "").trim();
323
+ const stateOf = (el, text) => {
324
+ const explicit = (el.getAttribute("data-state") ?? "").toLowerCase();
325
+ if (isState(explicit)) return explicit;
326
+ const lower = text.toLowerCase();
327
+ if (errorMarkers2.some((marker) => lower.includes(marker))) return "error";
328
+ if (lower.includes("loading")) return "loading";
329
+ if (emptyMarkers2.some((marker) => lower.includes(marker))) return "empty";
330
+ return "ok";
331
+ };
332
+ const valuesOf = (text) => (text.match(/-?\$?\s?\d[\d,]*(?:\.\d+)?%?/g) ?? []).map((token) => token.replace(/[$\s,]/g, "")).filter((token) => token !== "" && token !== "-");
333
+ const qualifies = (el) => {
334
+ const dataRegion = el.getAttribute("data-region");
335
+ if (dataRegion !== null && dataRegion !== "") {
336
+ const parent = el.parentElement;
337
+ return parent === null || parent.closest("[data-region]") === null;
338
+ }
339
+ return el.querySelector(selector) === null && el.closest("[data-region]") === null;
340
+ };
341
+ const candidates = Array.from(document.querySelectorAll(selector));
342
+ const regions = candidates.filter(qualifies);
343
+ const elements = regions.length > 0 ? regions : [document.body];
344
+ const used = {};
345
+ const uniqueKey = (key) => {
346
+ const count = (used[key] ?? 0) + 1;
347
+ used[key] = count;
348
+ return count === 1 ? key : `${key}-${count}`;
349
+ };
350
+ return elements.map((el) => {
351
+ const text = textOf(el);
352
+ const key = uniqueKey(keyOf(el));
353
+ return {
354
+ key,
355
+ label: labelOf(el, key),
356
+ state: stateOf(el, text),
357
+ values: valuesOf(text)
358
+ };
359
+ });
360
+ },
361
+ { selector: CANDIDATE_SELECTOR, emptyMarkers, errorMarkers }
362
+ );
363
+ };
364
+ var REGION_STATES = ["ok", "empty", "error", "loading"];
365
+ var Region = zod.z.object({
366
+ /** Stable id: data-region → data-testid → role → aria-label → heading slug. */
367
+ key: zod.z.string(),
368
+ /** Human label for the report. */
369
+ label: zod.z.string(),
370
+ state: zod.z.enum(REGION_STATES),
371
+ /** Normalized numeric / currency / percent tokens found in the region. */
372
+ values: zod.z.array(zod.z.string())
373
+ });
374
+ var CompareSnapshot = zod.z.object({
375
+ /** Route the snapshot was captured at, e.g. `/financials`. */
376
+ route: zod.z.string(),
377
+ regions: zod.z.array(Region)
378
+ }).refine(
379
+ (snap) => new Set(snap.regions.map((region) => region.key)).size === snap.regions.length,
380
+ {
381
+ message: "region keys must be unique"
382
+ }
383
+ );
384
+ var ExpectedAbsentRule = zod.z.object({
385
+ region: zod.z.string().optional(),
386
+ value: zod.z.string().optional(),
387
+ reason: zod.z.string().min(1)
388
+ }).refine((rule) => rule.region !== void 0 || rule.value !== void 0, {
389
+ message: "expectedAbsent rule needs at least one of `region` or `value`"
390
+ });
391
+ var CompareConfig = zod.z.object({
392
+ expectedAbsent: zod.z.array(ExpectedAbsentRule).optional(),
393
+ emptyStateMarkers: zod.z.array(zod.z.string()).optional(),
394
+ errorStateMarkers: zod.z.array(zod.z.string()).optional()
395
+ });
396
+
397
+ // src/compare/snapshot.ts
398
+ var captureSnapshot = async (page, route, config) => ({
399
+ route,
400
+ regions: await extractRegions(page, config)
401
+ });
402
+ var loadSnapshot = async (path) => {
403
+ const raw = await promises.readFile(path, "utf8");
404
+ return CompareSnapshot.parse(JSON.parse(raw));
405
+ };
406
+
407
+ // src/compare/runner.ts
408
+ var DEFAULT_TIMEOUT_MS2 = 3e4;
409
+ var joinUrl = (base, route) => `${base.replace(/\/$/, "")}/${route.replace(/^\//, "")}`;
410
+ var routeSnapshotFile = (route) => `${route.replace(/^\//, "").replace(/\/+$/, "").replace(/\//g, "_") || "index"}.json`;
411
+ var compareRoutes = async (options) => {
412
+ if (options.oldBaseUrl === void 0 === (options.oldSnapshotDir === void 0)) {
413
+ throw new Error("compareRoutes: provide exactly one of oldBaseUrl or oldSnapshotDir");
414
+ }
415
+ const viewport = options.viewport ?? DESKTOP_VIEWPORT;
416
+ const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS2;
417
+ const browser = options.browser ?? await playwright.chromium.launch();
418
+ const ownsBrowser = options.browser === void 0;
419
+ const { oldBaseUrl, oldSnapshotDir } = options;
420
+ const snapshotUrl = async (url, route) => {
421
+ const context = await browser.newContext({
422
+ viewport: { width: viewport.width, height: viewport.height }
423
+ });
424
+ const page = await context.newPage();
425
+ try {
426
+ await page.goto(url, { waitUntil: "networkidle", timeout: timeoutMs });
427
+ await prepareForScreenshot(page);
428
+ return await captureSnapshot(page, route, options.config);
429
+ } finally {
430
+ await context.close();
431
+ }
432
+ };
433
+ const oldSnapshotFor = (route) => {
434
+ if (oldBaseUrl !== void 0) return snapshotUrl(joinUrl(oldBaseUrl, route), route);
435
+ if (oldSnapshotDir !== void 0) {
436
+ return loadSnapshot(path.join(oldSnapshotDir, routeSnapshotFile(route)));
437
+ }
438
+ throw new Error("compareRoutes: provide exactly one of oldBaseUrl or oldSnapshotDir");
439
+ };
440
+ try {
441
+ const perRoute = [];
442
+ for (const route of options.routes) {
443
+ const oldSnapshot = await oldSnapshotFor(route);
444
+ const newSnapshot = await snapshotUrl(joinUrl(options.newBaseUrl, route), route);
445
+ perRoute.push({ route, findings: diffSnapshots(oldSnapshot, newSnapshot, options.config) });
446
+ }
447
+ const { sharedChrome, perRoute: trimmed } = dedupeSharedChrome(perRoute);
448
+ const routes = trimmed.map(({ route, findings }) => ({
449
+ route,
450
+ findings,
451
+ pass: comparePass(findings)
452
+ }));
453
+ const pass = comparePass(sharedChrome) && routes.every((route) => route.pass);
454
+ return { routes, sharedChrome, pass };
455
+ } finally {
456
+ if (ownsBrowser) await browser.close();
457
+ }
458
+ };
23
459
  var IMPACTS = ["critical", "serious", "moderate", "minor"];
24
460
  var toSeverity = (impact) => impact && IMPACTS.includes(impact) ? impact : "minor";
25
461
  var wcagTag = (tags) => tags.find((tag) => tag.startsWith("wcag")) ?? tags[0];
@@ -174,6 +610,28 @@ ${domExcerpt}`
174
610
  }
175
611
  };
176
612
 
613
+ // src/axes/compare.ts
614
+ var skip2 = (message) => ({
615
+ axis: "compare",
616
+ pass: true,
617
+ findings: [{ message, severity: "minor" }]
618
+ });
619
+ var compareAxis = {
620
+ name: "compare",
621
+ run: async (context) => {
622
+ const { comparison, compareConfig, page } = context;
623
+ if (comparison === void 0) {
624
+ return skip2("no comparison snapshot provided; old-vs-new not assessed");
625
+ }
626
+ if (page === void 0) {
627
+ return skip2("compare needs a live page to extract the new snapshot");
628
+ }
629
+ const newSnapshot = await captureSnapshot(page, comparison.route, compareConfig);
630
+ const findings = diffSnapshots(comparison, newSnapshot, compareConfig);
631
+ return { axis: "compare", pass: comparePass(findings), findings };
632
+ }
633
+ };
634
+
177
635
  // src/axes/runtime-health.ts
178
636
  var ERROR_MARKERS = [
179
637
  "something went wrong",
@@ -312,6 +770,11 @@ var altBrandFinding = (screenshot, altScreenshot, brand) => {
312
770
  }
313
771
  return null;
314
772
  };
773
+ var interactiveContrastFindings = (brand) => brandRegistry.checkInteractiveContrast(brand).map((warning) => ({
774
+ message: `brand '${brand.id}' ${warning.message}`,
775
+ severity: "moderate",
776
+ detail: `${warning.foreground} on ${warning.background} (${warning.palette})`
777
+ }));
315
778
  var overflowFinding = async (page) => {
316
779
  const overflows = await page.evaluate(
317
780
  () => document.documentElement.scrollWidth > document.documentElement.clientWidth
@@ -338,6 +801,8 @@ var visualBrandAxis = {
338
801
  DEFAULT_ALT_BRAND
339
802
  );
340
803
  if (finding !== null) findings.push(finding);
804
+ const altBrand = brandRegistry.brands.find((brand) => brand.id === DEFAULT_ALT_BRAND);
805
+ if (altBrand !== void 0) findings.push(...interactiveContrastFindings(altBrand));
341
806
  }
342
807
  if (page !== void 0) {
343
808
  const finding = await overflowFinding(page);
@@ -353,85 +818,10 @@ var ALL_AXES = [
353
818
  runtimeHealthAxis,
354
819
  accessibilityAxis,
355
820
  visualBrandAxis,
356
- briefConformanceAxis
821
+ briefConformanceAxis,
822
+ compareAxis
357
823
  ];
358
824
 
359
- // src/prepare-screenshot.ts
360
- var disableAnimations = async (page) => {
361
- await page.addStyleTag({
362
- content: `*, *::before, *::after {
363
- animation-duration: 0s !important;
364
- animation-delay: 0s !important;
365
- transition-duration: 0s !important;
366
- transition-delay: 0s !important;
367
- caret-color: transparent !important;
368
- }`
369
- });
370
- };
371
- var parkMouseOffElements = async (page) => {
372
- await page.mouse.move(0, 0);
373
- };
374
- var waitForFonts = async (page) => {
375
- await page.evaluate(() => document.fonts.ready.then(() => void 0));
376
- };
377
- var prepareForScreenshot = async (page) => {
378
- await disableAnimations(page);
379
- await parkMouseOffElements(page);
380
- await waitForFonts(page);
381
- };
382
-
383
- // src/capture.ts
384
- var DESKTOP_VIEWPORT = { label: "desktop", width: 1280, height: 800 };
385
- var DEFAULT_TIMEOUT_MS = 3e4;
386
- var attachRecorders = (page) => {
387
- const consoleEntries = [];
388
- const networkEntries = [];
389
- page.on("console", (message) => {
390
- consoleEntries.push({
391
- type: message.type(),
392
- text: message.text(),
393
- location: message.location().url || void 0
394
- });
395
- });
396
- page.on("pageerror", (error) => {
397
- consoleEntries.push({ type: "pageerror", text: error.message });
398
- });
399
- page.on("requestfailed", (request) => {
400
- networkEntries.push({
401
- url: request.url(),
402
- method: request.method(),
403
- status: 0,
404
- failure: request.failure()?.errorText
405
- });
406
- });
407
- page.on("response", (response) => {
408
- networkEntries.push({
409
- url: response.url(),
410
- method: response.request().method(),
411
- status: response.status()
412
- });
413
- });
414
- return { console: consoleEntries, network: networkEntries };
415
- };
416
- var capturePage = async (page, url, viewport, timeoutMs = DEFAULT_TIMEOUT_MS) => {
417
- const recorders = attachRecorders(page);
418
- await page.setViewportSize({ width: viewport.width, height: viewport.height });
419
- await page.goto(url, { waitUntil: "networkidle", timeout: timeoutMs });
420
- await prepareForScreenshot(page);
421
- const screenshot = await page.screenshot({ fullPage: true });
422
- const dom = await page.content();
423
- const renderedText = (await page.evaluate(() => document.body.innerText)).trim();
424
- return {
425
- url,
426
- viewport,
427
- screenshot,
428
- dom,
429
- renderedText,
430
- console: recorders.console,
431
- network: recorders.network
432
- };
433
- };
434
-
435
825
  // src/aggregate.ts
436
826
  var runAxes = async (axes, context) => {
437
827
  const verdicts = [];
@@ -473,6 +863,8 @@ var validate = async (options) => {
473
863
  browser,
474
864
  brief: options.brief,
475
865
  baseline: options.baseline,
866
+ comparison: options.comparison,
867
+ compareConfig: options.compareConfig,
476
868
  captureUnderBrand: async (brand) => {
477
869
  const brandContext = await browser.newContext({
478
870
  viewport: { width: viewport.width, height: viewport.height }
@@ -572,16 +964,24 @@ var HELP = `@keboola/validate-ui \u2014 closed-loop validation for generated Keb
572
964
  Usage:
573
965
  validate-ui --url <url> [--brief <text>] [--json]
574
966
  validate-ui --serve <dir> [--route <path>] [--brief <text>] [--json]
967
+ validate-ui compare --new <baseUrl> (--old <baseUrl> | --old-snapshots <dir>) --routes <a,b,c> [--config <file>] [--json]
575
968
 
576
969
  Options:
577
- --url <url> Render and validate a running URL
578
- --serve <dir> Serve a built SPA dir (e.g. apps/boilerplate/dist) and validate it
579
- --route <path> Route to open when using --serve (default: /)
580
- --brief <text> The brief the UI was generated from (feeds brief-conformance)
581
- --json Emit the aggregate verdict as JSON
582
- --help, -h Show this help
970
+ --url <url> Render and validate a running URL
971
+ --serve <dir> Serve a built SPA dir (e.g. apps/boilerplate/dist) and validate it
972
+ --route <path> Route to open when using --serve (default: /)
973
+ --brief <text> The brief the UI was generated from (feeds brief-conformance)
974
+ --json Emit the verdict as JSON
975
+ --help, -h Show this help
583
976
 
584
- Exit code is 0 when every axis passes, 1 otherwise.
977
+ compare options:
978
+ --new <baseUrl> Base URL of the new build
979
+ --old <baseUrl> Base URL of the old build (booted live)
980
+ --old-snapshots <dir> Directory of recorded old snapshots (alternative to --old)
981
+ --routes <a,b,c> Comma-separated routes to compare
982
+ --config <file> JSON compare config (expectedAbsent allowlist + state markers)
983
+
984
+ Exit code is 0 when every axis / route passes, 1 otherwise.
585
985
  `;
586
986
  var flagValue = (argv, name) => {
587
987
  const index = argv.indexOf(name);
@@ -599,14 +999,71 @@ var formatText = (verdict) => {
599
999
  }
600
1000
  return lines.join("\n");
601
1001
  };
1002
+ var formatCompareFinding = (finding) => {
1003
+ const tag = finding.suppressed !== void 0 ? " (suppressed)" : "";
1004
+ const detail = finding.detail !== void 0 ? ` \u2014 ${finding.detail}` : "";
1005
+ return ` [${finding.severity}] ${finding.message}${detail}${tag}`;
1006
+ };
1007
+ var formatCompare = (result) => {
1008
+ const lines = [`validate-ui compare ${result.pass ? "PASS" : "FAIL"}`];
1009
+ if (result.sharedChrome.length > 0) {
1010
+ lines.push(" shared across routes:");
1011
+ for (const finding of result.sharedChrome) lines.push(formatCompareFinding(finding));
1012
+ }
1013
+ for (const route of result.routes) {
1014
+ lines.push(` ${route.pass ? "\u2713" : "\u2717"} ${route.route}`);
1015
+ for (const finding of route.findings) lines.push(formatCompareFinding(finding));
1016
+ }
1017
+ return lines.join("\n");
1018
+ };
1019
+ var loadCompareConfig = async (path$1) => {
1020
+ if (path$1 === void 0) return void 0;
1021
+ return CompareConfig.parse(JSON.parse(await promises.readFile(path.resolve(path$1), "utf8")));
1022
+ };
1023
+ var runCompare = async (argv, asJson) => {
1024
+ const newBaseUrl = flagValue(argv, "--new");
1025
+ const oldBaseUrl = flagValue(argv, "--old");
1026
+ const oldSnapshotDir = flagValue(argv, "--old-snapshots");
1027
+ const routes = flagValue(argv, "--routes")?.split(",").map((route) => route.trim()).filter((route) => route !== "");
1028
+ if (newBaseUrl === void 0 || routes === void 0 || routes.length === 0) {
1029
+ process2__default.default.stderr.write("validate-ui compare: --new and --routes are required\n\n" + HELP);
1030
+ process2__default.default.exitCode = 1;
1031
+ return;
1032
+ }
1033
+ if (oldBaseUrl !== void 0 && oldSnapshotDir !== void 0) {
1034
+ process2__default.default.stderr.write(
1035
+ "validate-ui compare: pass only one of --old or --old-snapshots\n\n" + HELP
1036
+ );
1037
+ process2__default.default.exitCode = 1;
1038
+ return;
1039
+ }
1040
+ const config = await loadCompareConfig(flagValue(argv, "--config"));
1041
+ const base = { newBaseUrl, routes, config };
1042
+ let result;
1043
+ if (oldBaseUrl !== void 0) {
1044
+ result = await compareRoutes({ ...base, oldBaseUrl });
1045
+ } else if (oldSnapshotDir !== void 0) {
1046
+ result = await compareRoutes({ ...base, oldSnapshotDir });
1047
+ } else {
1048
+ process2__default.default.stderr.write("validate-ui compare: provide --old or --old-snapshots\n\n" + HELP);
1049
+ process2__default.default.exitCode = 1;
1050
+ return;
1051
+ }
1052
+ process2__default.default.stdout.write((asJson ? JSON.stringify(result, null, 2) : formatCompare(result)) + "\n");
1053
+ process2__default.default.exitCode = result.pass ? 0 : 1;
1054
+ };
602
1055
  var main = async () => {
603
1056
  const argv = process2__default.default.argv.slice(2);
604
1057
  if (argv.includes("--help") || argv.includes("-h") || argv.length === 0) {
605
1058
  process2__default.default.stdout.write(HELP);
606
1059
  return;
607
1060
  }
608
- const brief = flagValue(argv, "--brief");
609
1061
  const asJson = argv.includes("--json");
1062
+ if (argv[0] === "compare") {
1063
+ await runCompare(argv.slice(1), asJson);
1064
+ return;
1065
+ }
1066
+ const brief = flagValue(argv, "--brief");
610
1067
  const serveDir = flagValue(argv, "--serve");
611
1068
  let url = flagValue(argv, "--url");
612
1069
  let server;