@ploaness/governance 1.12.0 → 1.13.0

package/dist/browser-exemptions.d.ts

@@ -0,0 +1,107 @@
+import { type BrowserFinding, type FindingPlace } from './browser-findings.js';
+import { type LayoutNode, type LayoutSnapshot } from './layout-snapshot.js';
+/** The attribute naming the rules an element is exempt from. */
+export declare const EXEMPTION_ATTRIBUTE: string;
+/** The attribute stating why. */
+export declare const EXEMPTION_REASON_ATTRIBUTE: string;
+/** The rule name of a malformed or stale exemption. */
+export declare const EXEMPTION_RULE: string;
+/**
+ * The rules an element can be exempted from: those that judge one element. A rule that judges the
+ * whole page - an error, a failed request, a font, stability - has no element to carry an exemption.
+ */
+export declare const EXEMPTIBLE_RULES: readonly string[];
+/**
+ * The rule names an exemption attribute carries.
+ * @param value the attribute value, or undefined when it is absent.
+ * @returns each name once, in the order written.
+ */
+export declare const exemptionRules: (value: string | undefined) => readonly string[];
+/** An exemption an element declares. */
+export interface DeclaredExemption {
+    readonly location: string;
+    /** The element's position in its document, the same across viewports, states and engines. */
+    readonly key: string;
+    readonly label: string;
+    readonly rules: readonly string[];
+}
+/** One rule an exemption excused at least once. */
+export interface UsedExemption {
+    readonly location: string;
+    readonly key: string;
+    readonly rule: string;
+}
+/**
+ * The exemption that excuses a rule for an element: its own, or the nearest ancestor's.
+ * @param snapshot the measured page.
+ * @param node the element the rule judged.
+ * @param rule the rule.
+ * @returns the element carrying the exemption, or undefined when nothing excuses it.
+ */
+export declare const exemptingNode: (snapshot: LayoutSnapshot, node: LayoutNode, rule: string) => LayoutNode | undefined;
+/** A finding a rule would report, before exemptions are applied. */
+export interface CandidateFinding {
+    readonly rule: string;
+    /** The elements the finding is about. Any of them, or an ancestor of any, can excuse it. */
+    readonly subjects: readonly LayoutNode[];
+    readonly message: string;
+}
+/** What applying exemptions leaves: the findings still reported, and the exemptions that excused one. */
+export interface ExemptedFindings {
+    readonly findings: readonly BrowserFinding[];
+    readonly used: readonly UsedExemption[];
+}
+/**
+ * Drop every candidate an exemption excuses, recording which exemption did.
+ * @param snapshot the measured page.
+ * @param place where it was measured.
+ * @param candidates what the rules found.
+ * @returns the findings still reported and the exemptions used.
+ */
+export declare const applyExemptions: (snapshot: LayoutSnapshot, place: FindingPlace, candidates: readonly CandidateFinding[]) => ExemptedFindings;
+/**
+ * The exemptions a measured page declares.
+ * @param snapshot the measured page.
+ * @param location the route or story the page is.
+ * @returns one entry per element carrying the attribute.
+ */
+export declare const declaredExemptions: (snapshot: LayoutSnapshot, location: string) => readonly DeclaredExemption[];
+/**
+ * The malformed exemptions on a measured page: an unknown rule name, or no reason.
+ * @param snapshot the measured page.
+ * @param place where it was measured.
+ * @returns one finding per malformed exemption.
+ */
+export declare const malformedExemptions: (snapshot: LayoutSnapshot, place: FindingPlace) => readonly BrowserFinding[];
+/**
+ * The exemption rules that excused nothing anywhere they were judged.
+ * @param declared every exemption the run saw.
+ * @param used every exemption that excused a finding.
+ * @param judgedRules the rules the run actually applied; a rule that never ran cannot prove anything stale.
+ * @param engine the engine to report the finding under.
+ * @returns one finding per stale rule name on one element.
+ */
+export declare const staleExemptions: (declared: readonly DeclaredExemption[], used: readonly UsedExemption[], judgedRules: readonly string[], engine: string) => readonly BrowserFinding[];
+/** An element carrying an exemption, as the page describes it for a finding on it or a descendant. */
+export interface ExemptionCarrier {
+    readonly key: string;
+    readonly label: string;
+    /** The raw attribute value. */
+    readonly rules: string;
+    readonly reason: string;
+}
+/** What judging one element-level finding against the exemptions above it yields. */
+export interface CarriedJudgement {
+    /** The finding, or undefined when an exemption excused it. */
+    readonly finding: BrowserFinding | undefined;
+    readonly used: readonly UsedExemption[];
+    readonly declared: readonly DeclaredExemption[];
+}
+/**
+ * Judge a finding on one element against the exemptions on it and its ancestors.
+ * @param finding the finding, as the rule reported it.
+ * @param carriers the exemptions on the element or an ancestor, nearest first.
+ * @returns the finding unless excused, the exemption that excused it, and every exemption seen.
+ */
+export declare const judgeCarried: (finding: BrowserFinding, carriers: readonly ExemptionCarrier[]) => CarriedJudgement;
+//# sourceMappingURL=browser-exemptions.d.ts.map

package/dist/browser-exemptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-exemptions.d.ts","sourceRoot":"","sources":["../src/browser-exemptions.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,YAAY,EAAa,MAAM,uBAAuB,CAAA;AACzF,OAAO,EAAS,KAAK,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAElF,gEAAgE;AAChE,eAAO,MAAM,mBAAmB,EAAE,MAA+B,CAAA;AAEjE,iCAAiC;AACjC,eAAO,MAAM,0BAA0B,EAAE,MAAsC,CAAA;AAE/E,uDAAuD;AACvD,eAAO,MAAM,cAAc,EAAE,MAAoB,CAAA;AAEjD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAkB7C,CAAA;AAID;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,MAAM,GAAG,SAAS,KAAG,SAAS,MAAM,EAEzE,CAAA;AAED,wCAAwC;AACxC,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,6FAA6F;IAC7F,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;CAClC;AAED,mDAAmD;AACnD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,UAAU,cAAc,EAAE,MAAM,UAAU,EAAE,MAAM,MAAM,KAAG,UAAU,GAAG,SAMrG,CAAA;AAED,oEAAoE;AACpE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,4FAA4F;IAC5F,QAAQ,CAAC,QAAQ,EAAE,SAAS,UAAU,EAAE,CAAA;IACxC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CACzB;AAED,yGAAyG;AACzG,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,QAAQ,EAAE,SAAS,cAAc,EAAE,CAAA;IAC5C,QAAQ,CAAC,IAAI,EAAE,SAAS,aAAa,EAAE,CAAA;CACxC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAC1B,UAAU,cAAc,EACxB,OAAO,YAAY,EACnB,YAAY,SAAS,gBAAgB,EAAE,KACtC,gBA+BF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,cAAc,EAAE,UAAU,MAAM,KAAG,SAAS,iBAAiB,EAUrG,CAAA;AAEL;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,UAAU,cAAc,EAAE,OAAO,YAAY,KAAG,SAAS,cAAc,EAgCvG,CAAA;AAEJ;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,GAC1B,UAAU,SAAS,iBAAiB,EAAE,EACtC,MAAM,SAAS,aAAa,EAAE,EAC9B,aAAa,SAAS,MAAM,EAAE,EAC9B,QAAQ,MAAM,KACb,SAAS,cAAc,EA4BzB,CAAA;AAED,sGAAsG;AACtG,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,+BAA+B;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AAED,qFAAqF;AACrF,MAAM,WAAW,gBAAgB;IAC/B,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,cAAc,GAAG,SAAS,CAAA;IAC5C,QAAQ,CAAC,IAAI,EAAE,SAAS,aAAa,EAAE,CAAA;IACvC,QAAQ,CAAC,QAAQ,EAAE,SAAS,iBAAiB,EAAE,CAAA;CAChD;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,SAAS,cAAc,EAAE,UAAU,SAAS,gBAAgB,EAAE,KAAG,gBAgB7F,CAAA"}

package/dist/browser-exemptions.js

@@ -0,0 +1,163 @@
+// Per-element exemptions from the browser rules, and the checks that keep them honest.
+//
+// An exemption names the rules it excuses, space separated, in `data-ploaness-layout`, and says why in
+// `data-ploaness-layout-reason`. It is judged across everything one run measured: an exemption that
+// excused nothing in any pass, viewport, engine or state is stale, because the design it was written
+// for is gone and it now only hides whatever defect appears there next.
+import { findingAt } from './browser-findings.js';
+import { keyOf } from './layout-snapshot.js';
+/** The attribute naming the rules an element is exempt from. */
+export const EXEMPTION_ATTRIBUTE = 'data-ploaness-layout';
+/** The attribute stating why. */
+export const EXEMPTION_REASON_ATTRIBUTE = 'data-ploaness-layout-reason';
+/** The rule name of a malformed or stale exemption. */
+export const EXEMPTION_RULE = 'exemption';
+/**
+ * The rules an element can be exempted from: those that judge one element. A rule that judges the
+ * whole page - an error, a failed request, a font, stability - has no element to carry an exemption.
+ */
+export const EXEMPTIBLE_RULES = [
+    'attached',
+    'overflow',
+    'text-overlap',
+    'clipped-text',
+    'obscured',
+    'focus-obscured',
+    'text-spacing',
+    'text-resize',
+    'small-text',
+    'image-load',
+    'image-distorted',
+    'image-upscaled',
+    'media-space',
+    'focus-visible',
+    'focus-contrast',
+    'focus-order',
+    'disclosure-keyboard',
+];
+const WHITESPACE = /\s+/u;
+/**
+ * The rule names an exemption attribute carries.
+ * @param value the attribute value, or undefined when it is absent.
+ * @returns each name once, in the order written.
+ */
+export const exemptionRules = (value) => [
+    ...new Set((value ?? '').split(WHITESPACE).filter((name) => name.length > 0)),
+];
+/**
+ * The exemption that excuses a rule for an element: its own, or the nearest ancestor's.
+ * @param snapshot the measured page.
+ * @param node the element the rule judged.
+ * @param rule the rule.
+ * @returns the element carrying the exemption, or undefined when nothing excuses it.
+ */
+export const exemptingNode = (snapshot, node, rule) => {
+    if (exemptionRules(node.exemption).includes(rule)) {
+        return node;
+    }
+    const parent = snapshot.nodes[node.parent];
+    return parent === undefined ? undefined : exemptingNode(snapshot, parent, rule);
+};
+/**
+ * Drop every candidate an exemption excuses, recording which exemption did.
+ * @param snapshot the measured page.
+ * @param place where it was measured.
+ * @param candidates what the rules found.
+ * @returns the findings still reported and the exemptions used.
+ */
+export const applyExemptions = (snapshot, place, candidates) => {
+    const judged = candidates.map((candidate) => ({
+        candidate,
+        by: candidate.subjects.flatMap((subject) => {
+            const node = exemptingNode(snapshot, subject, candidate.rule);
+            return node === undefined ? [] : [node];
+        }),
+    }));
+    return {
+        findings: judged
+            .filter((entry) => entry.by.length === 0)
+            .map((entry) => findingAt(place, entry.candidate.rule, entry.candidate.message, entry.candidate.subjects.map((subject) => subject.index))),
+        used: judged.flatMap((entry) => entry.by.map((node) => ({
+            location: place.location,
+            key: keyOf(snapshot, node),
+            rule: entry.candidate.rule,
+        }))),
+    };
+};
+/**
+ * The exemptions a measured page declares.
+ * @param snapshot the measured page.
+ * @param location the route or story the page is.
+ * @returns one entry per element carrying the attribute.
+ */
+export const declaredExemptions = (snapshot, location) => snapshot.nodes
+    .filter((node) => node.exemption !== undefined)
+    .map((node) => ({
+    location,
+    key: keyOf(snapshot, node),
+    label: node.label,
+    rules: exemptionRules(node.exemption),
+}));
+/**
+ * The malformed exemptions on a measured page: an unknown rule name, or no reason.
+ * @param snapshot the measured page.
+ * @param place where it was measured.
+ * @returns one finding per malformed exemption.
+ */
+export const malformedExemptions = (snapshot, place) => snapshot.nodes.flatMap((node) => {
+    if (node.exemption === undefined) {
+        return [];
+    }
+    const rules = exemptionRules(node.exemption);
+    const unknown = rules.filter((rule) => !EXEMPTIBLE_RULES.includes(rule));
+    return [
+        ...(rules.length === 0
+            ? [findingAt(place, EXEMPTION_RULE, `${EXEMPTION_ATTRIBUTE} names no rule on ${node.label}`, [node.index])]
+            : []),
+        ...unknown.map((rule) => findingAt(place, EXEMPTION_RULE, `unknown rule "${rule}" in ${EXEMPTION_ATTRIBUTE} on ${node.label}; ` +
+            `the exemptible rules are ${EXEMPTIBLE_RULES.join(', ')}`, [node.index])),
+        ...(node.exemptionReason.length === 0
+            ? [
+                findingAt(place, EXEMPTION_RULE, `layout exemption without a reason on ${node.label}; state it in ${EXEMPTION_REASON_ATTRIBUTE}`, [node.index]),
+            ]
+            : []),
+    ];
+});
+/**
+ * The exemption rules that excused nothing anywhere they were judged.
+ * @param declared every exemption the run saw.
+ * @param used every exemption that excused a finding.
+ * @param judgedRules the rules the run actually applied; a rule that never ran cannot prove anything stale.
+ * @param engine the engine to report the finding under.
+ * @returns one finding per stale rule name on one element.
+ */
+export const staleExemptions = (declared, used, judgedRules, engine) => {
+    const usedKeys = new Set(used.map((entry) => `${entry.location}|${entry.key}|${entry.rule}`));
+    const distinct = declared.filter((entry, index) => declared.findIndex((other) => other.location === entry.location && other.key === entry.key) === index);
+    return distinct.flatMap((entry) => entry.rules
+        .filter((rule) => EXEMPTIBLE_RULES.includes(rule) &&
+        judgedRules.includes(rule) &&
+        !usedKeys.has(`${entry.location}|${entry.key}|${rule}`))
+        .map((rule) => findingAt({ location: entry.location, state: 'every', engine, viewport: undefined }, EXEMPTION_RULE, `stale layout exemption "${rule}" on ${entry.label}: it excuses nothing in any pass, viewport, ` +
+        `engine or state; remove it from ${EXEMPTION_ATTRIBUTE}`)));
+};
+/**
+ * Judge a finding on one element against the exemptions on it and its ancestors.
+ * @param finding the finding, as the rule reported it.
+ * @param carriers the exemptions on the element or an ancestor, nearest first.
+ * @returns the finding unless excused, the exemption that excused it, and every exemption seen.
+ */
+export const judgeCarried = (finding, carriers) => {
+    const excusing = carriers.find((carrier) => exemptionRules(carrier.rules).includes(finding.rule));
+    return {
+        finding: excusing === undefined ? finding : undefined,
+        used: excusing === undefined ? [] : [{ location: finding.location, key: excusing.key, rule: finding.rule }],
+        declared: carriers.map((carrier) => ({
+            location: finding.location,
+            key: carrier.key,
+            label: carrier.label,
+            rules: exemptionRules(carrier.rules),
+        })),
+    };
+};
+//# sourceMappingURL=browser-exemptions.js.map

package/dist/browser-exemptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-exemptions.js","sourceRoot":"","sources":["../src/browser-exemptions.ts"],"names":[],"mappings":"AAAA,uFAAuF;AACvF,EAAE;AACF,uGAAuG;AACvG,oGAAoG;AACpG,qGAAqG;AACrG,wEAAwE;AACxE,OAAO,EAA0C,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACzF,OAAO,EAAE,KAAK,EAAwC,MAAM,sBAAsB,CAAA;AAElF,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAW,sBAAsB,CAAA;AAEjE,iCAAiC;AACjC,MAAM,CAAC,MAAM,0BAA0B,GAAW,6BAA6B,CAAA;AAE/E,uDAAuD;AACvD,MAAM,CAAC,MAAM,cAAc,GAAW,WAAW,CAAA;AAEjD;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAsB;IACjD,UAAU;IACV,UAAU;IACV,cAAc;IACd,cAAc;IACd,UAAU;IACV,gBAAgB;IAChB,cAAc;IACd,aAAa;IACb,YAAY;IACZ,YAAY;IACZ,iBAAiB;IACjB,gBAAgB;IAChB,aAAa;IACb,eAAe;IACf,gBAAgB;IAChB,aAAa;IACb,qBAAqB;CACtB,CAAA;AAED,MAAM,UAAU,GAAW,MAAM,CAAA;AAEjC;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAyB,EAAqB,EAAE,CAAC;IAC9E,GAAG,IAAI,GAAG,CAAS,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,IAAY,EAAW,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;CACvG,CAAA;AAkBD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAAwB,EAAE,IAAgB,EAAE,IAAY,EAA0B,EAAE;IAChH,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAClD,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,MAAM,GAA2B,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAClE,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;AACjF,CAAC,CAAA;AAgBD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,QAAwB,EACxB,KAAmB,EACnB,UAAuC,EACrB,EAAE;IACpB,MAAM,MAAM,GACV,UAAU,CAAC,GAAG,CAAC,CAAC,SAA2B,EAAE,EAAE,CAAC,CAAC;QAC/C,SAAS;QACT,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAmB,EAAyB,EAAE;YAC5E,MAAM,IAAI,GAA2B,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,CAAA;YACrF,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QACzC,CAAC,CAAC;KACH,CAAC,CAAC,CAAA;IACL,OAAO;QACL,QAAQ,EAAE,MAAM;aACb,MAAM,CAAC,CAAC,KAAK,EAAW,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC;aACjD,GAAG,CACF,CAAC,KAAK,EAAkB,EAAE,CACxB,SAAS,CACP,KAAK,EACL,KAAK,CAAC,SAAS,CAAC,IAAI,EACpB,KAAK,CAAC,SAAS,CAAC,OAAO,EACvB,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAmB,EAAU,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAC7E,CACJ;QACH,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAA4B,EAAE,CACvD,KAAK,CAAC,EAAE,CAAC,GAAG,CACV,CAAC,IAAgB,EAAiB,EAAE,CAAC,CAAC;YACpC,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC;YAC1B,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,IAAI;SAC3B,CAAC,CACH,CACF;KACF,CAAA;AACH,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,QAAwB,EAAE,QAAgB,EAAgC,EAAE,CAC7G,QAAQ,CAAC,KAAK;KACX,MAAM,CAAC,CAAC,IAAgB,EAAW,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC;KACnE,GAAG,CACF,CAAC,IAAgB,EAAqB,EAAE,CAAC,CAAC;IACxC,QAAQ;IACR,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC;IAC1B,KAAK,EAAE,IAAI,CAAC,KAAK;IACjB,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC;CACtC,CAAC,CACH,CAAA;AAEL;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,QAAwB,EAAE,KAAmB,EAA6B,EAAE,CAC9G,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAgB,EAA6B,EAAE;IACrE,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,KAAK,GAAsB,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC/D,MAAM,OAAO,GAAsB,KAAK,CAAC,MAAM,CAAC,CAAC,IAAY,EAAW,EAAE,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;IAC5G,OAAO;QACL,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;YACpB,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,mBAAmB,qBAAqB,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3G,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,OAAO,CAAC,GAAG,CACZ,CAAC,IAAY,EAAkB,EAAE,CAC/B,SAAS,CACP,KAAK,EACL,cAAc,EACd,iBAAiB,IAAI,QAAQ,mBAAmB,OAAO,IAAI,CAAC,KAAK,IAAI;YACnE,4BAA4B,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAC3D,CAAC,IAAI,CAAC,KAAK,CAAC,CACb,CACJ;QACD,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC;YACnC,CAAC,CAAC;gBACE,SAAS,CACP,KAAK,EACL,cAAc,EACd,wCAAwC,IAAI,CAAC,KAAK,iBAAiB,0BAA0B,EAAE,EAC/F,CAAC,IAAI,CAAC,KAAK,CAAC,CACb;aACF;YACH,CAAC,CAAC,EAAE,CAAC;KACR,CAAA;AACH,CAAC,CAAC,CAAA;AAEJ;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,QAAsC,EACtC,IAA8B,EAC9B,WAA8B,EAC9B,MAAc,EACa,EAAE;IAC7B,MAAM,QAAQ,GAAwB,IAAI,GAAG,CAC3C,IAAI,CAAC,GAAG,CAAC,CAAC,KAAoB,EAAU,EAAE,CAAC,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAC3F,CAAA;IACD,MAAM,QAAQ,GAAiC,QAAQ,CAAC,MAAM,CAC5D,CAAC,KAAwB,EAAE,KAAa,EAAW,EAAE,CACnD,QAAQ,CAAC,SAAS,CAChB,CAAC,KAAwB,EAAW,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,GAAG,KAAK,KAAK,CAAC,GAAG,CACpG,KAAK,KAAK,CACd,CAAA;IACD,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAwB,EAA6B,EAAE,CAC9E,KAAK,CAAC,KAAK;SACR,MAAM,CACL,CAAC,IAAY,EAAW,EAAE,CACxB,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC/B,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC1B,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC,CAC1D;SACA,GAAG,CACF,CAAC,IAAY,EAAkB,EAAE,CAC/B,SAAS,CACP,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,EACzE,cAAc,EACd,2BAA2B,IAAI,QAAQ,KAAK,CAAC,KAAK,8CAA8C;QAC9F,mCAAmC,mBAAmB,EAAE,CAC3D,CACJ,CACJ,CAAA;AACH,CAAC,CAAA;AAmBD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAuB,EAAE,QAAqC,EAAoB,EAAE;IAC/G,MAAM,QAAQ,GAAiC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAyB,EAAW,EAAE,CAClG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CACrD,CAAA;IACD,OAAO;QACL,OAAO,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;QACrD,IAAI,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QAC3G,QAAQ,EAAE,QAAQ,CAAC,GAAG,CACpB,CAAC,OAAyB,EAAqB,EAAE,CAAC,CAAC;YACjD,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC;SACrC,CAAC,CACH;KACF,CAAA;AACH,CAAC,CAAA"}

package/dist/browser-findings.d.ts

@@ -0,0 +1,54 @@
+/** A viewport a finding was measured at. */
+export interface FindingViewport {
+    readonly width: number;
+    readonly height: number;
+}
+/** One defect a browser rule found. */
+export interface BrowserFinding {
+    /** The rule's name, as an exemption names it. */
+    readonly rule: string;
+    /** The route path, or `story:<id>` for a Storybook story. */
+    readonly location: string;
+    /** What the page was doing: `resting`, `hover`, `focus`, `dark`, `text-spacing`, and so on. */
+    readonly state: string;
+    /** The browser engine: `chromium`, `firefox` or `webkit`. */
+    readonly engine: string;
+    /** The viewport, or undefined for a finding that holds at every viewport. */
+    readonly viewport: FindingViewport | undefined;
+    /** What is wrong, with the element it is wrong on and the values measured. */
+    readonly message: string;
+    /** The elements to outline in the failure screenshot, as measured-node indices. */
+    readonly elements: readonly number[];
+}
+/** Where a finding was measured, without its rule and message. */
+export type FindingPlace = Pick<BrowserFinding, 'location' | 'state' | 'engine' | 'viewport'>;
+/**
+ * The text line a finding is reported as.
+ * @param finding the finding.
+ * @returns `[rule] location @WxH (engine, state): message`.
+ */
+export declare const findingLine: (finding: BrowserFinding) => string;
+/**
+ * A finding at a place.
+ * @param place where it was measured.
+ * @param rule the rule's name.
+ * @param message what is wrong.
+ * @param elements the measured-node indices to outline.
+ * @returns the finding.
+ */
+export declare const findingAt: (place: FindingPlace, rule: string, message: string, elements?: readonly number[]) => BrowserFinding;
+/**
+ * The findings with their duplicate lines removed, in the order they were found.
+ * @param findings every finding, possibly repeated across measurements.
+ * @returns one finding per distinct line.
+ */
+export declare const distinctFindings: (findings: readonly BrowserFinding[]) => readonly BrowserFinding[];
+/**
+ * The distinct places among a set of findings, which is where a failure screenshot is taken.
+ * @param findings the findings.
+ * @returns one entry per location, state, engine and viewport, with the elements to outline there.
+ */
+export declare const failingPlaces: (findings: readonly BrowserFinding[]) => readonly (FindingPlace & {
+    readonly elements: readonly number[];
+})[];
+//# sourceMappingURL=browser-findings.d.ts.map

package/dist/browser-findings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-findings.d.ts","sourceRoot":"","sources":["../src/browser-findings.ts"],"names":[],"mappings":"AAMA,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AAED,uCAAuC;AACvC,MAAM,WAAW,cAAc;IAC7B,iDAAiD;IACjD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,6DAA6D;IAC7D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,+FAA+F;IAC/F,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,6DAA6D;IAC7D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,EAAE,eAAe,GAAG,SAAS,CAAA;IAC9C,8EAA8E;IAC9E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,mFAAmF;IACnF,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;CACrC;AAED,kEAAkE;AAClE,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,EAAE,UAAU,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC,CAAA;AAK7F;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,SAAS,cAAc,KAAG,MAEO,CAAA;AAE7D;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,GACpB,OAAO,YAAY,EACnB,MAAM,MAAM,EACZ,SAAS,MAAM,EACf,WAAU,SAAS,MAAM,EAAO,KAC/B,cAAyD,CAAA;AAE5D;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,UAAU,SAAS,cAAc,EAAE,KAAG,SAAS,cAAc,EAK7F,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,GACxB,UAAU,SAAS,cAAc,EAAE,KAClC,SAAS,CAAC,YAAY,GAAG;IAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAAC,EAoBpE,CAAA"}

package/dist/browser-findings.js

@@ -0,0 +1,52 @@
+// The one shape every browser rule reports in, and the one line it is printed as.
+//
+// The sweep runs many passes over many pages, states, viewports and engines, and an agent reading a
+// failure has to know which of them produced it before it can reproduce it. Every rule therefore
+// reports the same fields, and the line printed for it names each of them in the same order.
+const viewportText = (viewport) => viewport === undefined ? '' : ` @${String(viewport.width)}x${String(viewport.height)}`;
+/**
+ * The text line a finding is reported as.
+ * @param finding the finding.
+ * @returns `[rule] location @WxH (engine, state): message`.
+ */
+export const findingLine = (finding) => `[${finding.rule}] ${finding.location}${viewportText(finding.viewport)} ` +
+    `(${finding.engine}, ${finding.state}): ${finding.message}`;
+/**
+ * A finding at a place.
+ * @param place where it was measured.
+ * @param rule the rule's name.
+ * @param message what is wrong.
+ * @param elements the measured-node indices to outline.
+ * @returns the finding.
+ */
+export const findingAt = (place, rule, message, elements = []) => ({ ...place, rule, message, elements });
+/**
+ * The findings with their duplicate lines removed, in the order they were found.
+ * @param findings every finding, possibly repeated across measurements.
+ * @returns one finding per distinct line.
+ */
+export const distinctFindings = (findings) => {
+    const lines = findings.map((finding) => findingLine(finding));
+    return findings.filter((finding, index) => lines.indexOf(findingLine(finding)) === index);
+};
+/**
+ * The distinct places among a set of findings, which is where a failure screenshot is taken.
+ * @param findings the findings.
+ * @returns one entry per location, state, engine and viewport, with the elements to outline there.
+ */
+export const failingPlaces = (findings) => {
+    const keyOf = (finding) => `${finding.location}|${finding.state}|${finding.engine}|${viewportText(finding.viewport)}`;
+    const firsts = findings.filter((finding, index) => findings.findIndex((other) => keyOf(other) === keyOf(finding)) === index);
+    return firsts.map((first) => ({
+        location: first.location,
+        state: first.state,
+        engine: first.engine,
+        viewport: first.viewport,
+        elements: [
+            ...new Set(findings
+                .filter((finding) => keyOf(finding) === keyOf(first))
+                .flatMap((finding) => finding.elements)),
+        ],
+    }));
+};
+//# sourceMappingURL=browser-findings.js.map

package/dist/browser-findings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-findings.js","sourceRoot":"","sources":["../src/browser-findings.ts"],"names":[],"mappings":"AAAA,kFAAkF;AAClF,EAAE;AACF,oGAAoG;AACpG,iGAAiG;AACjG,6FAA6F;AA6B7F,MAAM,YAAY,GAAG,CAAC,QAAqC,EAAU,EAAE,CACrE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAA;AAExF;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAuB,EAAU,EAAE,CAC7D,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,QAAQ,GAAG,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG;IACzE,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,KAAK,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;AAE7D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,KAAmB,EACnB,IAAY,EACZ,OAAe,EACf,WAA8B,EAAE,EAChB,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAA;AAE5D;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAmC,EAA6B,EAAE;IACjG,MAAM,KAAK,GAAsB,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAuB,EAAU,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IACxG,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,OAAuB,EAAE,KAAa,EAAW,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,KAAK,CACnG,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,QAAmC,EACmC,EAAE;IACxE,MAAM,KAAK,GAAG,CAAC,OAAqB,EAAU,EAAE,CAC9C,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,IAAI,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAA;IAC5F,MAAM,MAAM,GAA8B,QAAQ,CAAC,MAAM,CACvD,CAAC,OAAuB,EAAE,KAAa,EAAW,EAAE,CAClD,QAAQ,CAAC,SAAS,CAAC,CAAC,KAAqB,EAAW,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,KAAK,CACpG,CAAA;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAqB,EAA2D,EAAE,CAAC,CAAC;QACrG,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,QAAQ,EAAE;YACR,GAAG,IAAI,GAAG,CACR,QAAQ;iBACL,MAAM,CAAC,CAAC,OAAuB,EAAW,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC;iBAC7E,OAAO,CAAC,CAAC,OAAuB,EAAqB,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAC7E;SACF;KACF,CAAC,CAAC,CAAA;AACL,CAAC,CAAA"}

package/dist/browser-health.d.ts

@@ -0,0 +1,45 @@
+/** No uncaught error, `console.error` or hydration warning while the page loads or is driven. */
+export declare const PAGE_ERROR_RULE: string;
+/** No subresource answering 4xx or 5xx, and no request the network guard blocked. */
+export declare const FAILED_REQUEST_RULE: string;
+/** Every crawled internal link answers. */
+export declare const BROKEN_LINK_RULE: string;
+/** The page settled and its geometry held still between two measurements. */
+export declare const PAGE_NOT_STABLE_RULE: string;
+/**
+ * The origins a page may load from: the application and every declared auxiliary server.
+ * @param urls the server URLs.
+ * @returns each origin once.
+ */
+export declare const allowedOrigins: (urls: readonly string[]) => readonly string[];
+/**
+ * Whether the network guard lets a request through.
+ * @param url the requested URL.
+ * @param origins the allowed origins.
+ * @returns true for an allowed origin and for a URL that never leaves the browser.
+ */
+export declare const isAllowedRequest: (url: string, origins: readonly string[]) => boolean;
+/** A console message as the browser reports it. */
+export interface ConsoleEntry {
+    readonly type: string;
+    readonly text: string;
+}
+/**
+ * The console messages that are page errors: every `console.error`, and any warning about hydration.
+ * @param entry the console message.
+ * @returns the message to report, or undefined when it is not a page error.
+ */
+export declare const consolePageError: (entry: ConsoleEntry) => string | undefined;
+/**
+ * A browser message cut to a length a report line can carry.
+ * @param text the message.
+ * @returns its first line, at most 300 characters.
+ */
+export declare const reportedText: (text: string) => string;
+/**
+ * Whether a response status is a failure.
+ * @param status the HTTP status.
+ * @returns true for 4xx and 5xx.
+ */
+export declare const isFailedStatus: (status: number) => boolean;
+//# sourceMappingURL=browser-health.d.ts.map

package/dist/browser-health.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-health.d.ts","sourceRoot":"","sources":["../src/browser-health.ts"],"names":[],"mappings":"AAQA,iGAAiG;AACjG,eAAO,MAAM,eAAe,EAAE,MAAqB,CAAA;AAEnD,qFAAqF;AACrF,eAAO,MAAM,mBAAmB,EAAE,MAAyB,CAAA;AAE3D,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB,EAAE,MAAsB,CAAA;AAErD,6EAA6E;AAC7E,eAAO,MAAM,oBAAoB,EAAE,MAA0B,CAAA;AAY7D;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,SAAS,MAAM,EAAE,KAAG,SAAS,MAAM,EAEvE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,EAAE,SAAS,SAAS,MAAM,EAAE,KAAG,OAO1E,CAAA;AAED,mDAAmD;AACnD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAQD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,YAAY,KAAG,MAAM,GAAG,SAK/D,CAAA;AAKD;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,KAAG,MAG3C,CAAA;AAID;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,QAAQ,MAAM,KAAG,OAA+B,CAAA"}

package/dist/browser-health.js

@@ -0,0 +1,80 @@
+// Runtime health: what the browser itself reports while a page loads and is driven.
+//
+// A page can pass every geometric and accessibility rule while it throws, fails to load a stylesheet,
+// or quietly depends on a third-party host. The browser reports each of these as an event, and these
+// rules turn each event into a finding. The guard rule is the reason the suite needs no internet: any
+// request outside the application and its declared auxiliary servers is blocked and reported, so a page
+// cannot pass on one machine and fail on another for a reason outside the repository.
+/** No uncaught error, `console.error` or hydration warning while the page loads or is driven. */
+export const PAGE_ERROR_RULE = 'page-error';
+/** No subresource answering 4xx or 5xx, and no request the network guard blocked. */
+export const FAILED_REQUEST_RULE = 'failed-request';
+/** Every crawled internal link answers. */
+export const BROKEN_LINK_RULE = 'broken-link';
+/** The page settled and its geometry held still between two measurements. */
+export const PAGE_NOT_STABLE_RULE = 'page-not-stable';
+const LOCAL_SCHEMES = new Set(['data:', 'blob:', 'about:']);
+const originOf = (url) => {
+    try {
+        return new URL(url).origin;
+    }
+    catch {
+        return undefined;
+    }
+};
+/**
+ * The origins a page may load from: the application and every declared auxiliary server.
+ * @param urls the server URLs.
+ * @returns each origin once.
+ */
+export const allowedOrigins = (urls) => [
+    ...new Set(urls.flatMap((url) => [originOf(url) ?? ''].filter(Boolean))),
+];
+/**
+ * Whether the network guard lets a request through.
+ * @param url the requested URL.
+ * @param origins the allowed origins.
+ * @returns true for an allowed origin and for a URL that never leaves the browser.
+ */
+export const isAllowedRequest = (url, origins) => {
+    const scheme = /^[a-z][a-z\d+.-]*:/iu.exec(url)?.[0]?.toLowerCase() ?? '';
+    if (LOCAL_SCHEMES.has(scheme)) {
+        return true;
+    }
+    const origin = originOf(url);
+    return origin !== undefined && origins.includes(origin);
+};
+// The browser logs a failed subresource as a console error too. It is reported once, as the failed
+// request it describes, with its URL and status.
+const RESOURCE_FAILURE = /^Failed to load resource\b/u;
+const HYDRATION = /hydrat/iu;
+/**
+ * The console messages that are page errors: every `console.error`, and any warning about hydration.
+ * @param entry the console message.
+ * @returns the message to report, or undefined when it is not a page error.
+ */
+export const consolePageError = (entry) => {
+    if (entry.type === 'error' && !RESOURCE_FAILURE.test(entry.text)) {
+        return `console.error: ${entry.text}`;
+    }
+    return entry.type === 'warning' && HYDRATION.test(entry.text) ? `hydration warning: ${entry.text}` : undefined;
+};
+/** The longest stretch of a browser message a finding repeats. */
+const MAX_MESSAGE = 300;
+/**
+ * A browser message cut to a length a report line can carry.
+ * @param text the message.
+ * @returns its first line, at most 300 characters.
+ */
+export const reportedText = (text) => {
+    const [firstLine = ''] = text.trim().split('\n', 1);
+    return firstLine.length > MAX_MESSAGE ? `${firstLine.slice(0, MAX_MESSAGE)}...` : firstLine;
+};
+const HTTP_ERROR = 400;
+/**
+ * Whether a response status is a failure.
+ * @param status the HTTP status.
+ * @returns true for 4xx and 5xx.
+ */
+export const isFailedStatus = (status) => status >= HTTP_ERROR;
+//# sourceMappingURL=browser-health.js.map

package/dist/browser-health.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-health.js","sourceRoot":"","sources":["../src/browser-health.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,EAAE;AACF,sGAAsG;AACtG,qGAAqG;AACrG,sGAAsG;AACtG,wGAAwG;AACxG,sFAAsF;AAEtF,iGAAiG;AACjG,MAAM,CAAC,MAAM,eAAe,GAAW,YAAY,CAAA;AAEnD,qFAAqF;AACrF,MAAM,CAAC,MAAM,mBAAmB,GAAW,gBAAgB,CAAA;AAE3D,2CAA2C;AAC3C,MAAM,CAAC,MAAM,gBAAgB,GAAW,aAAa,CAAA;AAErD,6EAA6E;AAC7E,MAAM,CAAC,MAAM,oBAAoB,GAAW,iBAAiB,CAAA;AAE7D,MAAM,aAAa,GAAwB,IAAI,GAAG,CAAS,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAA;AAExF,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAsB,EAAE;IACnD,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAA;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAuB,EAAqB,EAAE,CAAC;IAC5E,GAAG,IAAI,GAAG,CAAS,IAAI,CAAC,OAAO,CAAC,CAAC,GAAW,EAAqB,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;CAC5G,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAW,EAAE,OAA0B,EAAW,EAAE;IACnF,MAAM,MAAM,GAAW,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;IACjF,IAAI,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,MAAM,GAAuB,QAAQ,CAAC,GAAG,CAAC,CAAA;IAChD,OAAO,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;AACzD,CAAC,CAAA;AAQD,mGAAmG;AACnG,iDAAiD;AACjD,MAAM,gBAAgB,GAAW,6BAA6B,CAAA;AAE9D,MAAM,SAAS,GAAW,UAAU,CAAA;AAEpC;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAmB,EAAsB,EAAE;IAC1E,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACjE,OAAO,kBAAkB,KAAK,CAAC,IAAI,EAAE,CAAA;IACvC,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,sBAAsB,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;AAChH,CAAC,CAAA;AAED,kEAAkE;AAClE,MAAM,WAAW,GAAW,GAAG,CAAA;AAE/B;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAU,EAAE;IACnD,MAAM,CAAC,SAAS,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IACnD,OAAO,SAAS,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;AAC7F,CAAC,CAAA;AAED,MAAM,UAAU,GAAW,GAAG,CAAA;AAE9B;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAc,EAAW,EAAE,CAAC,MAAM,IAAI,UAAU,CAAA"}