@brandlab-digital/conformance 3.7.0 → 3.9.0

package/dist/site-system/rules/enquiry/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../../src/site-system/rules/enquiry/common.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAgC,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAE3E,qGAAqG;AACrG,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC5E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,uDAAuD;AACvD,MAAM,WAAW,kBAAkB;IACjC,wDAAwD;IACxD,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,UAAU;IACzB,yGAAyG;IACzG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;CAC5B;AAED,uHAAuH;AACvH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMlD;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,UAAU,EAAE,CAEzE;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,iBAAiB,CAE/G;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAEpG;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,GAAG,iBAAiB,CAE5F;AAED,mEAAmE;AACnE,wBAAgB,QAAQ,CACtB,OAAO,EAAE,iBAAiB,EAC1B,QAAQ,EAAE,SAAS,iBAAiB,EAAE,EACtC,WAAW,EAAE,MAAM,GAClB,iBAAiB,EAAE,CAErB;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,SAAiB,GAAG,MAAM,CAE3F;AAED,oHAAoH;AACpH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,WAAW,GAAG,WAAW,EAAE,CAQjE;AAED,wBAAgB,SAAS,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAEtD;AAED,qGAAqG;AACrG,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAYpD"}

package/dist/site-system/rules/enquiry/common.js

@@ -0,0 +1,59 @@
+import { attr, descendants, parseHtml } from "./html.js";
+/** A path as the route catalogue writes it: leading slash, no query or fragment, no trailing slash except for home. */
+export function normalisePath(path) {
+    let value = path.trim();
+    const cut = value.search(/[?#]/);
+    if (cut !== -1)
+        value = value.slice(0, cut);
+    value = `/${value}`.replace(/\/{2,}/g, "/");
+    return value.length > 1 ? value.replace(/\/$/, "") : value;
+}
+export function parsePages(pages) {
+    return pages.map((page) => ({ path: normalisePath(page.path), html: page.html, root: parseHtml(page.html) }));
+}
+export function fail(checkId, target, message) {
+    return target === undefined ? { checkId, status: "fail", message } : { checkId, status: "fail", target, message };
+}
+export function pass(checkId, message, target) {
+    return target === undefined ? { checkId, status: "pass", message } : { checkId, status: "pass", target, message };
+}
+export function notApplicable(checkId, message) {
+    return { checkId, status: "not-applicable", message };
+}
+/** The failures when there are any; otherwise one pass finding. */
+export function resultOf(checkId, failures, passMessage) {
+    return failures.length > 0 ? [...failures] : [pass(checkId, passMessage)];
+}
+export function plural(count, singular, pluralForm = `${singular}s`) {
+    return `${count} ${count === 1 ? singular : pluralForm}`;
+}
+/** The outermost `data-bl-section` elements of a page, in document order. A section nested in one is part of it. */
+export function topLevelSections(root) {
+    const sections = descendants(root).filter((element) => attr(element, "data-bl-section") !== undefined);
+    return sections.filter((section) => {
+        for (let parent = section.parent; parent && parent.tag !== "#root"; parent = parent.parent) {
+            if (attr(parent, "data-bl-section") !== undefined)
+                return false;
+        }
+        return true;
+    });
+}
+export function sectionId(section) {
+    return attr(section, "data-bl-section") ?? "";
+}
+/** Dollar figures in a piece of text, as numbers. A range such as "$450 to 900" counts both ends. */
+export function dollarFigures(text) {
+    const figures = [];
+    const figure = /\$\s?(\d{1,3}(?:,\d{3})+|\d+)(?:\.\d{1,2})?(?:\s*(?:-|–|—|to)\s*\$?\s?(\d{1,3}(?:,\d{3})+|\d+)(?:\.\d{1,2})?(?![\d,]*(?:%|[a-zA-Z])))?/g;
+    for (const match of text.matchAll(figure)) {
+        const first = Number(match[1].replace(/,/g, ""));
+        figures.push(first);
+        if (match[2] !== undefined) {
+            const second = Number(match[2].replace(/,/g, ""));
+            if (second >= first)
+                figures.push(second);
+        }
+    }
+    return figures;
+}
+//# sourceMappingURL=common.js.map

package/dist/site-system/rules/enquiry/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../../src/site-system/rules/enquiry/common.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAoB,MAAM,WAAW,CAAC;AAsB3E,uHAAuH;AACvH,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IACxB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACjC,IAAI,GAAG,KAAK,CAAC,CAAC;QAAE,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC5C,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAC5C,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,KAAgC;IACzD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AAChH,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,OAA0B,EAAE,MAA0B,EAAE,OAAe;IAC1F,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AACpH,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,OAA0B,EAAE,OAAe,EAAE,MAAe;IAC/E,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AACpH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,OAA0B,EAAE,OAAe;IACvE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,CAAC;AACxD,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,QAAQ,CACtB,OAA0B,EAC1B,QAAsC,EACtC,WAAmB;IAEnB,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,KAAa,EAAE,QAAgB,EAAE,UAAU,GAAG,GAAG,QAAQ,GAAG;IACjF,OAAO,GAAG,KAAK,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;AAC3D,CAAC;AAED,oHAAoH;AACpH,MAAM,UAAU,gBAAgB,CAAC,IAAiB;IAChD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,KAAK,SAAS,CAAC,CAAC;IACvG,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;QACjC,KAAK,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,IAAI,MAAM,CAAC,GAAG,KAAK,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;YAC3F,IAAI,IAAI,CAAC,MAAM,EAAE,iBAAiB,CAAC,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAC;QAClE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,OAAoB;IAC5C,OAAO,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,EAAE,CAAC;AAChD,CAAC;AAED,qGAAqG;AACrG,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAG,yIAAyI,CAAC;IACzJ,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QAClD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;YAClD,IAAI,MAAM,IAAI,KAAK;gBAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC","sourcesContent":["import type { SiteSystemCheckId, SiteSystemFinding } from \"../../checks.js\";\nimport { attr, descendants, parseHtml, type HtmlElement } from \"./html.js\";\n\n/** What every rendered rule receives: the sampled pages' server HTML and where the project lives. */\nexport interface EnquiryRuleInput {\n  readonly baseUrl: string;\n  readonly pages: readonly { readonly path: string; readonly html: string }[];\n  readonly projectRoot: string;\n}\n\n/** Options for tests; a real run uses the defaults. */\nexport interface EnquiryRuleOptions {\n  /** The date licences are judged on. Defaults to now. */\n  readonly asOf?: Date;\n}\n\nexport interface ParsedPage {\n  /** The page path, normalised: a leading slash, no trailing slash (except home), no query or fragment. */\n  readonly path: string;\n  readonly html: string;\n  readonly root: HtmlElement;\n}\n\n/** A path as the route catalogue writes it: leading slash, no query or fragment, no trailing slash except for home. */\nexport function normalisePath(path: string): string {\n  let value = path.trim();\n  const cut = value.search(/[?#]/);\n  if (cut !== -1) value = value.slice(0, cut);\n  value = `/${value}`.replace(/\\/{2,}/g, \"/\");\n  return value.length > 1 ? value.replace(/\\/$/, \"\") : value;\n}\n\nexport function parsePages(pages: EnquiryRuleInput[\"pages\"]): ParsedPage[] {\n  return pages.map((page) => ({ path: normalisePath(page.path), html: page.html, root: parseHtml(page.html) }));\n}\n\nexport function fail(checkId: SiteSystemCheckId, target: string | undefined, message: string): SiteSystemFinding {\n  return target === undefined ? { checkId, status: \"fail\", message } : { checkId, status: \"fail\", target, message };\n}\n\nexport function pass(checkId: SiteSystemCheckId, message: string, target?: string): SiteSystemFinding {\n  return target === undefined ? { checkId, status: \"pass\", message } : { checkId, status: \"pass\", target, message };\n}\n\nexport function notApplicable(checkId: SiteSystemCheckId, message: string): SiteSystemFinding {\n  return { checkId, status: \"not-applicable\", message };\n}\n\n/** The failures when there are any; otherwise one pass finding. */\nexport function resultOf(\n  checkId: SiteSystemCheckId,\n  failures: readonly SiteSystemFinding[],\n  passMessage: string,\n): SiteSystemFinding[] {\n  return failures.length > 0 ? [...failures] : [pass(checkId, passMessage)];\n}\n\nexport function plural(count: number, singular: string, pluralForm = `${singular}s`): string {\n  return `${count} ${count === 1 ? singular : pluralForm}`;\n}\n\n/** The outermost `data-bl-section` elements of a page, in document order. A section nested in one is part of it. */\nexport function topLevelSections(root: HtmlElement): HtmlElement[] {\n  const sections = descendants(root).filter((element) => attr(element, \"data-bl-section\") !== undefined);\n  return sections.filter((section) => {\n    for (let parent = section.parent; parent && parent.tag !== \"#root\"; parent = parent.parent) {\n      if (attr(parent, \"data-bl-section\") !== undefined) return false;\n    }\n    return true;\n  });\n}\n\nexport function sectionId(section: HtmlElement): string {\n  return attr(section, \"data-bl-section\") ?? \"\";\n}\n\n/** Dollar figures in a piece of text, as numbers. A range such as \"$450 to 900\" counts both ends. */\nexport function dollarFigures(text: string): number[] {\n  const figures: number[] = [];\n  const figure = /\\$\\s?(\\d{1,3}(?:,\\d{3})+|\\d+)(?:\\.\\d{1,2})?(?:\\s*(?:-|–|—|to)\\s*\\$?\\s?(\\d{1,3}(?:,\\d{3})+|\\d+)(?:\\.\\d{1,2})?(?![\\d,]*(?:%|[a-zA-Z])))?/g;\n  for (const match of text.matchAll(figure)) {\n    const first = Number(match[1]!.replace(/,/g, \"\"));\n    figures.push(first);\n    if (match[2] !== undefined) {\n      const second = Number(match[2].replace(/,/g, \"\"));\n      if (second >= first) figures.push(second);\n    }\n  }\n  return figures;\n}\n"]}

package/dist/site-system/rules/enquiry/e1-recorded-titles.d.ts

@@ -0,0 +1,8 @@
+import type { SiteSystemFinding } from "../../checks.js";
+import { type ParsedPage } from "./common.js";
+export declare const E1_RECORD_PATH = "docs/recorded-titles.json";
+export type RecordedTitles = ReadonlyMap<string, string>;
+/** Reads the record. Returns null when it does not exist and a string when it cannot be read. */
+export declare function readRecordedTitles(projectRoot: string): RecordedTitles | string | null;
+export declare function checkE1(pages: readonly ParsedPage[], projectRoot: string): SiteSystemFinding[];
+//# sourceMappingURL=e1-recorded-titles.d.ts.map

package/dist/site-system/rules/enquiry/e1-recorded-titles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"e1-recorded-titles.d.ts","sourceRoot":"","sources":["../../../../src/site-system/rules/enquiry/e1-recorded-titles.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAwD,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAGpG,eAAO,MAAM,cAAc,8BAA8B,CAAC;AAE1D,MAAM,MAAM,cAAc,GAAG,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEzD,iGAAiG;AACjG,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,cAAc,GAAG,MAAM,GAAG,IAAI,CAkBtF;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,EAAE,WAAW,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAsB9F"}

package/dist/site-system/rules/enquiry/e1-recorded-titles.js

@@ -0,0 +1,59 @@
+/**
+ * E1 (recorded titles): a page whose title the site has recorded keeps that title word for word.
+ *
+ * The record is `docs/recorded-titles.json`, an object of page path to title, taken from the live site before a
+ * rebuild or an adoption pass. A page that is not in the record is not judged here (the title pattern part of E1 is
+ * separate). Without the record there is nothing to compare, so the rule is not applicable.
+ */
+import { existsSync, readFileSync } from "node:fs";
+import { join } from "node:path";
+import { fail, normalisePath, notApplicable, plural, resultOf } from "./common.js";
+import { documentTitle, normaliseText } from "./html.js";
+export const E1_RECORD_PATH = "docs/recorded-titles.json";
+/** Reads the record. Returns null when it does not exist and a string when it cannot be read. */
+export function readRecordedTitles(projectRoot) {
+    const file = join(projectRoot, E1_RECORD_PATH);
+    if (!existsSync(file))
+        return null;
+    let parsed;
+    try {
+        parsed = JSON.parse(readFileSync(file, "utf8"));
+    }
+    catch {
+        return `${E1_RECORD_PATH} is not valid JSON.`;
+    }
+    if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) {
+        return `${E1_RECORD_PATH} must be an object of page path to title.`;
+    }
+    const titles = new Map();
+    for (const [path, title] of Object.entries(parsed)) {
+        if (typeof title !== "string" || !title.trim())
+            return `${E1_RECORD_PATH} has no title for ${path}.`;
+        titles.set(normalisePath(path), normaliseText(title));
+    }
+    return titles;
+}
+export function checkE1(pages, projectRoot) {
+    const recorded = readRecordedTitles(projectRoot);
+    if (recorded === null)
+        return [notApplicable("E1", `The site has no ${E1_RECORD_PATH}, so there are no recorded titles to keep.`)];
+    if (typeof recorded === "string")
+        return [fail("E1", E1_RECORD_PATH, recorded)];
+    const failures = [];
+    let compared = 0;
+    for (const page of pages) {
+        const expected = recorded.get(page.path);
+        if (expected === undefined)
+            continue;
+        compared += 1;
+        const actual = documentTitle(page.root);
+        if (actual !== expected) {
+            failures.push(fail("E1", page.path, `The title of ${page.path} is ${actual === null ? "missing" : `"${actual}"`}; the recorded title is "${expected}" and stays as it is.`));
+        }
+    }
+    if (compared === 0) {
+        return [notApplicable("E1", `None of the ${plural(recorded.size, "recorded title")} is for a sampled page.`)];
+    }
+    return resultOf("E1", failures, `Checked ${plural(compared, "recorded title")} on sampled pages: all are unchanged.`);
+}
+//# sourceMappingURL=e1-recorded-titles.js.map

package/dist/site-system/rules/enquiry/e1-recorded-titles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"e1-recorded-titles.js","sourceRoot":"","sources":["../../../../src/site-system/rules/enquiry/e1-recorded-titles.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAmB,MAAM,aAAa,CAAC;AACpG,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAEzD,MAAM,CAAC,MAAM,cAAc,GAAG,2BAA2B,CAAC;AAI1D,iGAAiG;AACjG,MAAM,UAAU,kBAAkB,CAAC,WAAmB;IACpD,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;IAC/C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACnC,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,cAAc,qBAAqB,CAAC;IAChD,CAAC;IACD,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACnE,OAAO,GAAG,cAAc,2CAA2C,CAAC;IACtE,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACnD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;YAAE,OAAO,GAAG,cAAc,qBAAqB,IAAI,GAAG,CAAC;QACrG,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,KAA4B,EAAE,WAAmB;IACvE,MAAM,QAAQ,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;IACjD,IAAI,QAAQ,KAAK,IAAI;QAAE,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,mBAAmB,cAAc,4CAA4C,CAAC,CAAC,CAAC;IACnI,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEhF,MAAM,QAAQ,GAAwB,EAAE,CAAC;IACzC,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,QAAQ,KAAK,SAAS;YAAE,SAAS;QACrC,QAAQ,IAAI,CAAC,CAAC;QACd,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YACxB,QAAQ,CAAC,IAAI,CACX,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,gBAAgB,IAAI,CAAC,IAAI,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,MAAM,GAAG,4BAA4B,QAAQ,uBAAuB,CAAC,CAC9J,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,eAAe,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAChH,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,MAAM,CAAC,QAAQ,EAAE,gBAAgB,CAAC,uCAAuC,CAAC,CAAC;AACxH,CAAC","sourcesContent":["/**\n * E1 (recorded titles): a page whose title the site has recorded keeps that title word for word.\n *\n * The record is `docs/recorded-titles.json`, an object of page path to title, taken from the live site before a\n * rebuild or an adoption pass. A page that is not in the record is not judged here (the title pattern part of E1 is\n * separate). Without the record there is nothing to compare, so the rule is not applicable.\n */\nimport { existsSync, readFileSync } from \"node:fs\";\nimport { join } from \"node:path\";\nimport type { SiteSystemFinding } from \"../../checks.js\";\nimport { fail, normalisePath, notApplicable, plural, resultOf, type ParsedPage } from \"./common.js\";\nimport { documentTitle, normaliseText } from \"./html.js\";\n\nexport const E1_RECORD_PATH = \"docs/recorded-titles.json\";\n\nexport type RecordedTitles = ReadonlyMap<string, string>;\n\n/** Reads the record. Returns null when it does not exist and a string when it cannot be read. */\nexport function readRecordedTitles(projectRoot: string): RecordedTitles | string | null {\n  const file = join(projectRoot, E1_RECORD_PATH);\n  if (!existsSync(file)) return null;\n  let parsed: unknown;\n  try {\n    parsed = JSON.parse(readFileSync(file, \"utf8\"));\n  } catch {\n    return `${E1_RECORD_PATH} is not valid JSON.`;\n  }\n  if (!parsed || typeof parsed !== \"object\" || Array.isArray(parsed)) {\n    return `${E1_RECORD_PATH} must be an object of page path to title.`;\n  }\n  const titles = new Map<string, string>();\n  for (const [path, title] of Object.entries(parsed)) {\n    if (typeof title !== \"string\" || !title.trim()) return `${E1_RECORD_PATH} has no title for ${path}.`;\n    titles.set(normalisePath(path), normaliseText(title));\n  }\n  return titles;\n}\n\nexport function checkE1(pages: readonly ParsedPage[], projectRoot: string): SiteSystemFinding[] {\n  const recorded = readRecordedTitles(projectRoot);\n  if (recorded === null) return [notApplicable(\"E1\", `The site has no ${E1_RECORD_PATH}, so there are no recorded titles to keep.`)];\n  if (typeof recorded === \"string\") return [fail(\"E1\", E1_RECORD_PATH, recorded)];\n\n  const failures: SiteSystemFinding[] = [];\n  let compared = 0;\n  for (const page of pages) {\n    const expected = recorded.get(page.path);\n    if (expected === undefined) continue;\n    compared += 1;\n    const actual = documentTitle(page.root);\n    if (actual !== expected) {\n      failures.push(\n        fail(\"E1\", page.path, `The title of ${page.path} is ${actual === null ? \"missing\" : `\"${actual}\"`}; the recorded title is \"${expected}\" and stays as it is.`),\n      );\n    }\n  }\n  if (compared === 0) {\n    return [notApplicable(\"E1\", `None of the ${plural(recorded.size, \"recorded title\")} is for a sampled page.`)];\n  }\n  return resultOf(\"E1\", failures, `Checked ${plural(compared, \"recorded title\")} on sampled pages: all are unchanged.`);\n}\n"]}

package/dist/site-system/rules/enquiry/e9-cost-guides.d.ts

@@ -0,0 +1,22 @@
+/**
+ * E9: every cost guide carries at least 8 dollar figures in a table cell or price element (Site System v2 §9.2, §13.2).
+ *
+ * A cost guide is a guide page (`/blog/…`, `/guides/…`) with "cost" in its path, or one that carries a `price-guide`
+ * section, and that has a price table or a `price-guide` section to count figures in. A guides hub such as
+ * `/blog/cost-guides` has neither, and a service page's own price summary is not a guide, so neither is held to the 8.
+ * Only rendered figures count: a band hidden because it is unconfirmed is not in the HTML, so it cannot count.
+ */
+import type { SiteSystemFinding } from "../../checks.js";
+import { type ParsedPage } from "./common.js";
+import { type HtmlElement } from "./html.js";
+export declare const E9_MIN_FIGURES = 8;
+/** The first path segment of a guide page. */
+export declare const E9_GUIDE_ROOTS: readonly ["blog", "guides", "guide"];
+/** `data-slot` values that mark a price shown outside a table. */
+export declare const E9_PRICE_SLOTS: readonly ["price", "price-low", "price-high", "price-range", "range", "amount"];
+export declare function isGuidePath(path: string): boolean;
+export declare function isCostGuide(page: ParsedPage): boolean;
+/** The dollar figures a page shows in table cells and price elements. A price inside a cell is counted once. */
+export declare function priceFigures(root: HtmlElement): number[];
+export declare function checkE9(pages: readonly ParsedPage[]): SiteSystemFinding[];
+//# sourceMappingURL=e9-cost-guides.d.ts.map

package/dist/site-system/rules/enquiry/e9-cost-guides.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"e9-cost-guides.d.ts","sourceRoot":"","sources":["../../../../src/site-system/rules/enquiry/e9-cost-guides.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAwD,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AACpG,OAAO,EAA6B,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AAExE,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,8CAA8C;AAC9C,eAAO,MAAM,cAAc,sCAAuC,CAAC;AAEnE,kEAAkE;AAClE,eAAO,MAAM,cAAc,iFAAkF,CAAC;AAE9G,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAGjD;AAOD,wBAAgB,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAKrD;AASD,gHAAgH;AAChH,wBAAgB,YAAY,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,CAQxD;AAED,wBAAgB,OAAO,CAAC,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,iBAAiB,EAAE,CAUzE"}

package/dist/site-system/rules/enquiry/e9-cost-guides.js

@@ -0,0 +1,55 @@
+import { dollarFigures, fail, notApplicable, plural, resultOf } from "./common.js";
+import { attr, descendants, textOf } from "./html.js";
+export const E9_MIN_FIGURES = 8;
+/** The first path segment of a guide page. */
+export const E9_GUIDE_ROOTS = ["blog", "guides", "guide"];
+/** `data-slot` values that mark a price shown outside a table. */
+export const E9_PRICE_SLOTS = ["price", "price-low", "price-high", "price-range", "range", "amount"];
+export function isGuidePath(path) {
+    const [first, ...rest] = path.split("/").filter(Boolean);
+    return first !== undefined && rest.length > 0 && E9_GUIDE_ROOTS.includes(first);
+}
+function hasCostInPath(path) {
+    const slug = path.split("/").filter(Boolean).slice(1).join("-");
+    return slug.split("-").some((word) => word === "cost" || word === "costs");
+}
+export function isCostGuide(page) {
+    if (!isGuidePath(page.path))
+        return false;
+    const hasPriceGuideSection = descendants(page.root).some((element) => attr(element, "data-bl-section") === "price-guide");
+    const hasPriceTable = hasPriceGuideSection || descendants(page.root).some((element) => element.tag === "table");
+    return hasPriceTable && (hasCostInPath(page.path) || hasPriceGuideSection);
+}
+function isPriceElement(element) {
+    if (element.tag === "td" || element.tag === "th")
+        return true;
+    const slot = attr(element, "data-slot");
+    if (slot !== undefined && E9_PRICE_SLOTS.includes(slot))
+        return true;
+    return attr(element, "data-bl") === "price" || attr(element, "itemprop") === "price";
+}
+/** The dollar figures a page shows in table cells and price elements. A price inside a cell is counted once. */
+export function priceFigures(root) {
+    const elements = descendants(root).filter(isPriceElement);
+    const priced = new Set(elements);
+    const outermost = elements.filter((element) => {
+        for (let parent = element.parent; parent; parent = parent.parent)
+            if (priced.has(parent))
+                return false;
+        return true;
+    });
+    return outermost.flatMap((element) => dollarFigures(textOf(element)));
+}
+export function checkE9(pages) {
+    const guides = pages.filter(isCostGuide);
+    if (guides.length === 0)
+        return [notApplicable("E9", "None of the sampled pages is a cost guide.")];
+    const failures = guides.flatMap((page) => {
+        const count = priceFigures(page.root).length;
+        return count >= E9_MIN_FIGURES
+            ? []
+            : [fail("E9", page.path, `The cost guide at ${page.path} shows ${plural(count, "dollar figure")} in its price table; it needs at least ${E9_MIN_FIGURES}.`)];
+    });
+    return resultOf("E9", failures, `Checked ${plural(guides.length, "cost guide")}: each shows at least ${E9_MIN_FIGURES} dollar figures.`);
+}
+//# sourceMappingURL=e9-cost-guides.js.map

package/dist/site-system/rules/enquiry/e9-cost-guides.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"e9-cost-guides.js","sourceRoot":"","sources":["../../../../src/site-system/rules/enquiry/e9-cost-guides.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAmB,MAAM,aAAa,CAAC;AACpG,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAoB,MAAM,WAAW,CAAC;AAExE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC;AAEhC,8CAA8C;AAC9C,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAU,CAAC;AAEnE,kEAAkE;AAClE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAC;AAE9G,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACzD,OAAO,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAK,cAAoC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACzG,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,OAAO,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAgB;IAC1C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1C,MAAM,oBAAoB,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,KAAK,aAAa,CAAC,CAAC;IAC1H,MAAM,aAAa,GAAG,oBAAoB,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,KAAK,OAAO,CAAC,CAAC;IAChH,OAAO,aAAa,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,CAAC;AAC7E,CAAC;AAED,SAAS,cAAc,CAAC,OAAoB;IAC1C,IAAI,OAAO,CAAC,GAAG,KAAK,IAAI,IAAI,OAAO,CAAC,GAAG,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACxC,IAAI,IAAI,KAAK,SAAS,IAAK,cAAoC,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC5F,OAAO,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,KAAK,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,KAAK,OAAO,CAAC;AACvF,CAAC;AAED,gHAAgH;AAChH,MAAM,UAAU,YAAY,CAAC,IAAiB;IAC5C,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAC1D,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjC,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;QAC5C,KAAK,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM;YAAE,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAAE,OAAO,KAAK,CAAC;QACvG,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,KAA4B;IAClD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACzC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,4CAA4C,CAAC,CAAC,CAAC;IACpG,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAuB,EAAE;QAC5D,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;QAC7C,OAAO,KAAK,IAAI,cAAc;YAC5B,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,qBAAqB,IAAI,CAAC,IAAI,UAAU,MAAM,CAAC,KAAK,EAAE,eAAe,CAAC,0CAA0C,cAAc,GAAG,CAAC,CAAC,CAAC;IACjK,CAAC,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,WAAW,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,yBAAyB,cAAc,kBAAkB,CAAC,CAAC;AAC3I,CAAC","sourcesContent":["/**\n * E9: every cost guide carries at least 8 dollar figures in a table cell or price element (Site System v2 §9.2, §13.2).\n *\n * A cost guide is a guide page (`/blog/…`, `/guides/…`) with \"cost\" in its path, or one that carries a `price-guide`\n * section, and that has a price table or a `price-guide` section to count figures in. A guides hub such as\n * `/blog/cost-guides` has neither, and a service page's own price summary is not a guide, so neither is held to the 8.\n * Only rendered figures count: a band hidden because it is unconfirmed is not in the HTML, so it cannot count.\n */\nimport type { SiteSystemFinding } from \"../../checks.js\";\nimport { dollarFigures, fail, notApplicable, plural, resultOf, type ParsedPage } from \"./common.js\";\nimport { attr, descendants, textOf, type HtmlElement } from \"./html.js\";\n\nexport const E9_MIN_FIGURES = 8;\n\n/** The first path segment of a guide page. */\nexport const E9_GUIDE_ROOTS = [\"blog\", \"guides\", \"guide\"] as const;\n\n/** `data-slot` values that mark a price shown outside a table. */\nexport const E9_PRICE_SLOTS = [\"price\", \"price-low\", \"price-high\", \"price-range\", \"range\", \"amount\"] as const;\n\nexport function isGuidePath(path: string): boolean {\n  const [first, ...rest] = path.split(\"/\").filter(Boolean);\n  return first !== undefined && rest.length > 0 && (E9_GUIDE_ROOTS as readonly string[]).includes(first);\n}\n\nfunction hasCostInPath(path: string): boolean {\n  const slug = path.split(\"/\").filter(Boolean).slice(1).join(\"-\");\n  return slug.split(\"-\").some((word) => word === \"cost\" || word === \"costs\");\n}\n\nexport function isCostGuide(page: ParsedPage): boolean {\n  if (!isGuidePath(page.path)) return false;\n  const hasPriceGuideSection = descendants(page.root).some((element) => attr(element, \"data-bl-section\") === \"price-guide\");\n  const hasPriceTable = hasPriceGuideSection || descendants(page.root).some((element) => element.tag === \"table\");\n  return hasPriceTable && (hasCostInPath(page.path) || hasPriceGuideSection);\n}\n\nfunction isPriceElement(element: HtmlElement): boolean {\n  if (element.tag === \"td\" || element.tag === \"th\") return true;\n  const slot = attr(element, \"data-slot\");\n  if (slot !== undefined && (E9_PRICE_SLOTS as readonly string[]).includes(slot)) return true;\n  return attr(element, \"data-bl\") === \"price\" || attr(element, \"itemprop\") === \"price\";\n}\n\n/** The dollar figures a page shows in table cells and price elements. A price inside a cell is counted once. */\nexport function priceFigures(root: HtmlElement): number[] {\n  const elements = descendants(root).filter(isPriceElement);\n  const priced = new Set(elements);\n  const outermost = elements.filter((element) => {\n    for (let parent = element.parent; parent; parent = parent.parent) if (priced.has(parent)) return false;\n    return true;\n  });\n  return outermost.flatMap((element) => dollarFigures(textOf(element)));\n}\n\nexport function checkE9(pages: readonly ParsedPage[]): SiteSystemFinding[] {\n  const guides = pages.filter(isCostGuide);\n  if (guides.length === 0) return [notApplicable(\"E9\", \"None of the sampled pages is a cost guide.\")];\n  const failures = guides.flatMap((page): SiteSystemFinding[] => {\n    const count = priceFigures(page.root).length;\n    return count >= E9_MIN_FIGURES\n      ? []\n      : [fail(\"E9\", page.path, `The cost guide at ${page.path} shows ${plural(count, \"dollar figure\")} in its price table; it needs at least ${E9_MIN_FIGURES}.`)];\n  });\n  return resultOf(\"E9\", failures, `Checked ${plural(guides.length, \"cost guide\")}: each shows at least ${E9_MIN_FIGURES} dollar figures.`);\n}\n"]}

package/dist/site-system/rules/enquiry/html.d.ts

@@ -0,0 +1,53 @@
+/**
+ * A small tolerant HTML reader for the rendered rules. It reads the server HTML a crawler receives, builds the
+ * element tree and answers the few questions the rules ask: attributes, descendants, text and the lines a person
+ * reads. It is not a browser: it does not run scripts, apply CSS or repair every invalid document.
+ */
+export interface HtmlText {
+    type: "text";
+    text: string;
+    parent: HtmlElement | null;
+}
+export interface HtmlElement {
+    type: "element";
+    tag: string;
+    attrs: Record<string, string>;
+    children: HtmlNode[];
+    parent: HtmlElement | null;
+}
+export type HtmlNode = HtmlElement | HtmlText;
+export declare function decodeEntities(value: string): string;
+/** Collapses runs of whitespace, non-breaking spaces included, and trims. */
+export declare function normaliseText(value: string): string;
+/** Parses server HTML into a tree under a synthetic `#root` element. Never throws. */
+export declare function parseHtml(html: string): HtmlElement;
+/** Every element below `node`, in document order. */
+export declare function descendants(node: HtmlElement): HtmlElement[];
+export declare function attr(element: HtmlElement, name: string): string | undefined;
+export declare function ancestors(element: HtmlElement): HtmlElement[];
+export declare function closest(element: HtmlElement, test: (candidate: HtmlElement) => boolean): HtmlElement | null;
+/** Whether the element, or an ancestor, is hidden from people: `hidden` or `aria-hidden="true"`. */
+export declare function isHiddenFromPeople(element: HtmlElement): boolean;
+/**
+ * The text a person reads inside an element, whitespace collapsed. Blocks are separated by a space. Inline parts join
+ * with no space ("$" then "450" reads "$450") unless `spaced` is set, which puts a space at every element boundary
+ * so that "4.9" in one span and "132 reviews" in the next do not run together.
+ */
+export declare function textOf(element: HtmlElement, spaced?: boolean, skip?: (element: HtmlElement) => boolean): string;
+export interface ReadableLine {
+    text: string;
+    /** The `href` of every link in the line. */
+    hrefs: string[];
+}
+/**
+ * The lines of text a person reads in an element: inline parts join, every block starts a new line. Subtrees that are
+ * hidden (`hidden`, `aria-hidden="true"`) are left out, and each line keeps the links it contains.
+ */
+export declare function readableLines(element: HtmlElement): ReadableLine[];
+/** The text of each line a person reads in an element. */
+export declare function linesOf(element: HtmlElement): string[];
+/** The page's `<title>` text, or null when it has none. */
+export declare function documentTitle(root: HtmlElement): string | null;
+/** The visible name of a form control: its label, `aria-label` or `aria-labelledby` text. Empty when it has none. */
+export declare function accessibleLabel(control: HtmlElement, scope: HtmlElement): string;
+//# sourceMappingURL=html.d.ts.map

package/dist/site-system/rules/enquiry/html.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.d.ts","sourceRoot":"","sources":["../../../../src/site-system/rules/enquiry/html.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,MAAM,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC;AAuC9C,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQpD;AAED,6EAA6E;AAC7E,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEnD;AAkBD,sFAAsF;AACtF,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAwFnD;AAED,qDAAqD;AACrD,wBAAgB,WAAW,CAAC,IAAI,EAAE,WAAW,GAAG,WAAW,EAAE,CAW5D;AAED,wBAAgB,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE3E;AAED,wBAAgB,SAAS,CAAC,OAAO,EAAE,WAAW,GAAG,WAAW,EAAE,CAI7D;AAED,wBAAgB,OAAO,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,WAAW,KAAK,OAAO,GAAG,WAAW,GAAG,IAAI,CAK3G;AAED,oGAAoG;AACpG,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAQ,EAAE,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,GAAG,MAAM,CAE7G;AAgBD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAOD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,WAAW,GAAG,YAAY,EAAE,CA+BlE;AAED,0DAA0D;AAC1D,wBAAgB,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,EAAE,CAEtD;AAED,2DAA2D;AAC3D,wBAAgB,aAAa,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAI9D;AAED,qHAAqH;AACrH,wBAAgB,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,GAAG,MAAM,CAqBhF"}

package/dist/site-system/rules/enquiry/html.js

@@ -0,0 +1,294 @@
+/**
+ * A small tolerant HTML reader for the rendered rules. It reads the server HTML a crawler receives, builds the
+ * element tree and answers the few questions the rules ask: attributes, descendants, text and the lines a person
+ * reads. It is not a browser: it does not run scripts, apply CSS or repair every invalid document.
+ */
+const VOID_TAGS = new Set([
+    "area", "base", "br", "col", "embed", "hr", "img", "input", "link", "meta", "param", "source", "track", "wbr",
+]);
+/** Elements whose content is not markup: kept as text, never part of what a person reads. */
+const RAW_TEXT_TAGS = new Set(["script", "style"]);
+/** Elements whose content is text with entities and no markup. */
+const ESCAPABLE_RAW_TEXT_TAGS = new Set(["textarea", "title"]);
+/** Opening the key closes an open element of one of the listed tags when it is the innermost one. */
+const IMPLIED_END = {
+    li: ["li"],
+    dt: ["dt", "dd"],
+    dd: ["dt", "dd"],
+    tr: ["tr", "td", "th"],
+    td: ["td", "th"],
+    th: ["td", "th"],
+    option: ["option"],
+    optgroup: ["option", "optgroup"],
+    p: ["p"],
+};
+/** Elements that read as part of the line they sit in. Every other element starts a new line. */
+const INLINE_TAGS = new Set([
+    "a", "abbr", "b", "bdi", "bdo", "cite", "code", "data", "dfn", "em", "i", "kbd", "mark", "q", "s", "samp", "small",
+    "span", "strong", "sub", "sup", "time", "u", "var", "wbr",
+]);
+/** Elements whose text a person never reads as page copy. */
+const NON_READABLE_TAGS = new Set(["script", "style", "template", "noscript", "select", "option", "head", "svg"]);
+const NAMED_ENTITIES = {
+    amp: "&", lt: "<", gt: ">", quot: "\"", apos: "'", nbsp: " ", dollar: "$", pound: "£", ndash: "–",
+    mdash: "—", hellip: "…", rsquo: "’", lsquo: "‘", ldquo: "“", rdquo: "”", times: "×",
+    copy: "©", bull: "•", middot: "·", check: "✓", star: "☆",
+};
+export function decodeEntities(value) {
+    return value.replace(/&(#x[0-9a-f]+|#\d+|[a-z][a-z0-9]*);/gi, (match, body) => {
+        if (body[0] === "#") {
+            const code = body[1] === "x" || body[1] === "X" ? Number.parseInt(body.slice(2), 16) : Number.parseInt(body.slice(1), 10);
+            return Number.isFinite(code) && code > 0 && code <= 0x10ffff ? String.fromCodePoint(code) : match;
+        }
+        return NAMED_ENTITIES[body.toLowerCase()] ?? match;
+    });
+}
+/** Collapses runs of whitespace, non-breaking spaces included, and trims. */
+export function normaliseText(value) {
+    return value.replace(/[\s ]+/g, " ").trim();
+}
+const ATTRIBUTE = /([^\s"'<>/=]+)(?:\s*=\s*(?:"([^"]*)"|'([^']*)'|([^\s"'=<>`]+)))?/g;
+function parseAttributes(source) {
+    const attrs = {};
+    for (const match of source.matchAll(ATTRIBUTE)) {
+        const name = match[1].toLowerCase();
+        if (Object.hasOwn(attrs, name))
+            continue;
+        attrs[name] = decodeEntities(match[2] ?? match[3] ?? match[4] ?? "");
+    }
+    return attrs;
+}
+function createElement(tag, attrs, parent) {
+    return { type: "element", tag, attrs, children: [], parent };
+}
+/** Parses server HTML into a tree under a synthetic `#root` element. Never throws. */
+export function parseHtml(html) {
+    const root = createElement("#root", {}, null);
+    const stack = [root];
+    const top = () => stack[stack.length - 1];
+    const addText = (text) => {
+        if (text)
+            top().children.push({ type: "text", text, parent: top() });
+    };
+    let index = 0;
+    while (index < html.length) {
+        const open = html.indexOf("<", index);
+        if (open === -1) {
+            addText(decodeEntities(html.slice(index)));
+            break;
+        }
+        if (open > index)
+            addText(decodeEntities(html.slice(index, open)));
+        if (html.startsWith("<!--", open)) {
+            const close = html.indexOf("-->", open + 4);
+            index = close === -1 ? html.length : close + 3;
+            continue;
+        }
+        if (html[open + 1] === "!" || html[open + 1] === "?") {
+            const close = html.indexOf(">", open + 2);
+            index = close === -1 ? html.length : close + 1;
+            continue;
+        }
+        if (html[open + 1] === "/") {
+            const close = html.indexOf(">", open + 2);
+            const tag = html.slice(open + 2, close === -1 ? html.length : close).trim().toLowerCase();
+            index = close === -1 ? html.length : close + 1;
+            for (let depth = stack.length - 1; depth > 0; depth -= 1) {
+                if (stack[depth].tag === tag) {
+                    stack.length = depth;
+                    break;
+                }
+            }
+            continue;
+        }
+        const tagMatch = /^<([a-zA-Z][a-zA-Z0-9:-]*)/.exec(html.slice(open, open + 64));
+        if (!tagMatch) {
+            addText("<");
+            index = open + 1;
+            continue;
+        }
+        // The tag ends at the first ">" outside a quoted attribute value.
+        let cursor = open + tagMatch[0].length;
+        let quote = "";
+        while (cursor < html.length) {
+            const character = html[cursor];
+            if (quote) {
+                if (character === quote)
+                    quote = "";
+            }
+            else if (character === "\"" || character === "'") {
+                quote = character;
+            }
+            else if (character === ">") {
+                break;
+            }
+            cursor += 1;
+        }
+        const tag = tagMatch[1].toLowerCase();
+        const rawAttributes = html.slice(open + tagMatch[0].length, cursor);
+        const selfClosing = rawAttributes.trimEnd().endsWith("/");
+        index = Math.min(cursor + 1, html.length);
+        const implied = IMPLIED_END[tag];
+        if (implied && stack.length > 1 && implied.includes(top().tag))
+            stack.pop();
+        const element = createElement(tag, parseAttributes(selfClosing ? rawAttributes.trimEnd().slice(0, -1) : rawAttributes), top());
+        top().children.push(element);
+        if (VOID_TAGS.has(tag) || selfClosing)
+            continue;
+        if (RAW_TEXT_TAGS.has(tag) || ESCAPABLE_RAW_TEXT_TAGS.has(tag)) {
+            const closing = new RegExp(`</${tag}\\s*>`, "gi");
+            closing.lastIndex = index;
+            const close = closing.exec(html);
+            const end = close ? close.index : html.length;
+            const content = html.slice(index, end);
+            element.children.push({
+                type: "text",
+                text: ESCAPABLE_RAW_TEXT_TAGS.has(tag) ? decodeEntities(content) : content,
+                parent: element,
+            });
+            index = close ? close.index + close[0].length : html.length;
+            continue;
+        }
+        stack.push(element);
+    }
+    return root;
+}
+/** Every element below `node`, in document order. */
+export function descendants(node) {
+    const found = [];
+    const visit = (current) => {
+        for (const child of current.children) {
+            if (child.type !== "element")
+                continue;
+            found.push(child);
+            visit(child);
+        }
+    };
+    visit(node);
+    return found;
+}
+export function attr(element, name) {
+    return Object.hasOwn(element.attrs, name) ? element.attrs[name] : undefined;
+}
+export function ancestors(element) {
+    const found = [];
+    for (let current = element.parent; current && current.tag !== "#root"; current = current.parent)
+        found.push(current);
+    return found;
+}
+export function closest(element, test) {
+    for (let current = element; current && current.tag !== "#root"; current = current.parent) {
+        if (test(current))
+            return current;
+    }
+    return null;
+}
+/** Whether the element, or an ancestor, is hidden from people: `hidden` or `aria-hidden="true"`. */
+export function isHiddenFromPeople(element) {
+    return closest(element, (candidate) => attr(candidate, "hidden") !== undefined || attr(candidate, "aria-hidden") === "true") !== null;
+}
+/**
+ * The text a person reads inside an element, whitespace collapsed. Blocks are separated by a space. Inline parts join
+ * with no space ("$" then "450" reads "$450") unless `spaced` is set, which puts a space at every element boundary
+ * so that "4.9" in one span and "132 reviews" in the next do not run together.
+ */
+export function textOf(element, spaced = false, skip) {
+    return normaliseText(collectText(element, spaced, skip));
+}
+function collectText(element, spaced, skip) {
+    let text = "";
+    for (const child of element.children) {
+        if (child.type === "text") {
+            text += child.text;
+            continue;
+        }
+        if (NON_READABLE_TAGS.has(child.tag) || skip?.(child))
+            continue;
+        const inline = !spaced && INLINE_TAGS.has(child.tag);
+        text += (inline ? "" : " ") + collectText(child, spaced, skip) + (inline ? "" : " ");
+    }
+    return text;
+}
+/** Hidden from people by `hidden` or `aria-hidden="true"` on the element itself. */
+function hiddenItself(element) {
+    return attr(element, "hidden") !== undefined || attr(element, "aria-hidden") === "true";
+}
+/**
+ * The lines of text a person reads in an element: inline parts join, every block starts a new line. Subtrees that are
+ * hidden (`hidden`, `aria-hidden="true"`) are left out, and each line keeps the links it contains.
+ */
+export function readableLines(element) {
+    const lines = [];
+    let current = "";
+    let hrefs = [];
+    const flush = () => {
+        const text = normaliseText(current);
+        if (text)
+            lines.push({ text, hrefs });
+        current = "";
+        hrefs = [];
+    };
+    const visit = (node) => {
+        for (const child of node.children) {
+            if (child.type === "text") {
+                current += child.text;
+                continue;
+            }
+            if (NON_READABLE_TAGS.has(child.tag) || hiddenItself(child))
+                continue;
+            if (child.tag === "br") {
+                flush();
+                continue;
+            }
+            if (child.tag === "a")
+                hrefs.push(attr(child, "href") ?? "");
+            const inline = INLINE_TAGS.has(child.tag);
+            if (!inline)
+                flush();
+            visit(child);
+            if (!inline)
+                flush();
+        }
+    };
+    visit(element);
+    flush();
+    return lines;
+}
+/** The text of each line a person reads in an element. */
+export function linesOf(element) {
+    return readableLines(element).map((line) => line.text);
+}
+/** The page's `<title>` text, or null when it has none. */
+export function documentTitle(root) {
+    const title = descendants(root).find((element) => element.tag === "title");
+    if (!title)
+        return null;
+    return normaliseText(title.children.map((child) => (child.type === "text" ? child.text : "")).join(""));
+}
+/** The visible name of a form control: its label, `aria-label` or `aria-labelledby` text. Empty when it has none. */
+export function accessibleLabel(control, scope) {
+    const ariaLabel = attr(control, "aria-label");
+    if (ariaLabel)
+        return normaliseText(ariaLabel);
+    const labelledBy = attr(control, "aria-labelledby");
+    const elements = descendants(scope);
+    if (labelledBy) {
+        const text = labelledBy
+            .split(/\s+/)
+            .map((id) => elements.find((element) => attr(element, "id") === id))
+            .filter((element) => element !== undefined)
+            .map((element) => textOf(element))
+            .join(" ");
+        if (text)
+            return normaliseText(text);
+    }
+    const id = attr(control, "id");
+    if (id) {
+        const label = elements.find((element) => element.tag === "label" && attr(element, "for") === id);
+        if (label)
+            return textOf(label);
+    }
+    const wrapping = closest(control, (candidate) => candidate.tag === "label");
+    return wrapping ? textOf(wrapping) : "";
+}
+//# sourceMappingURL=html.js.map