@brandlab-digital/conformance 3.7.0 → 3.8.0

package/dist/site-system/config.js

@@ -0,0 +1,214 @@
+/**
+ * What the ready gate reads from brandlab.config.ts: the Site System tier, the exceptions record and the
+ * representative routes. The file is parsed, never executed, so these fields must be written literally (as
+ * `defineBrandlabProject` requires anyway).
+ */
+import { existsSync, readFileSync } from "node:fs";
+import { join } from "node:path";
+import ts from "typescript";
+import { SITE_SYSTEM_TIERS } from "./checks.js";
+const CONFIG_FILE = "brandlab.config.ts";
+const SITE_SYSTEM_KEYS = new Set(["tier", "newBuild", "samples", "labels", "freeQuotes", "thirdParties", "phones"]);
+const HOSTNAME_PATTERN = /^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$/;
+const TEL_HREF_PATTERN = /^tel:\+?\d{6,15}$/;
+const NOT_LITERAL = Symbol("not literal");
+export function readSiteSystemProjectConfig(root) {
+    const path = join(root, CONFIG_FILE);
+    if (!existsSync(path))
+        throw new Error(`${CONFIG_FILE} is missing, so the ready gate cannot tell which tier applies.`);
+    return parseSiteSystemProjectConfig(readFileSync(path, "utf8"));
+}
+/** Throws when siteSystem is present but unreadable or invalid: a declared tier must never be skipped silently. */
+export function parseSiteSystemProjectConfig(text) {
+    const source = ts.createSourceFile(CONFIG_FILE, text, ts.ScriptTarget.Latest, true, ts.ScriptKind.TS);
+    const config = findProjectObject(source);
+    if (!config) {
+        throw new Error(`${CONFIG_FILE} has no literal defineBrandlabProject({ ... }) call.`);
+    }
+    const problems = [];
+    const complete = config.properties.every(isPlainProperty);
+    if (!complete) {
+        problems.push(`defineBrandlabProject({ ... }) in ${CONFIG_FILE} spreads or computes a member, so the ready gate cannot read it in full; write every field literally.`);
+    }
+    const projectId = literal(property(config, "projectId"));
+    const siteSystemNode = property(config, "siteSystem");
+    const siteSystem = siteSystemNode === undefined ? null : readSiteSystem(literal(siteSystemNode));
+    const exceptionsNode = property(config, "exceptions");
+    let exceptions = [];
+    if (exceptionsNode !== undefined) {
+        const value = literal(exceptionsNode);
+        if (!Array.isArray(value)) {
+            problems.push(`The exceptions in ${CONFIG_FILE} are not written as a literal list, so none were applied.`);
+        }
+        else {
+            exceptions = value.flatMap((entry, index) => {
+                const exception = readException(entry);
+                if (!exception)
+                    problems.push(`exceptions[${index}] in ${CONFIG_FILE} has no literal ruleId, rationale, evidence and reviewTrigger, so it was not applied.`);
+                return exception ? [exception] : [];
+            });
+        }
+    }
+    const searchCertification = literal(property(config, "searchCertification"));
+    const routes = isRecord(searchCertification) ? searchCertification.representativeRoutes : undefined;
+    const representativeRoutes = {};
+    if (isRecord(routes)) {
+        for (const [name, path] of Object.entries(routes)) {
+            if (typeof path === "string" && path.startsWith("/"))
+                representativeRoutes[name] = path;
+        }
+    }
+    else if (property(config, "searchCertification") !== undefined) {
+        problems.push(`searchCertification.representativeRoutes in ${CONFIG_FILE} is not literal, so only the home page was sampled from it.`);
+    }
+    return {
+        projectId: typeof projectId === "string" ? projectId : null,
+        siteSystem,
+        exceptions,
+        representativeRoutes,
+        complete,
+        problems,
+    };
+}
+/** `key: value` or `key` with an identifier or string key; spreads, computed keys and methods are not. */
+function isPlainProperty(member) {
+    if (ts.isShorthandPropertyAssignment(member))
+        return !member.objectAssignmentInitializer;
+    return ts.isPropertyAssignment(member) && (ts.isIdentifier(member.name) || ts.isStringLiteralLike(member.name));
+}
+function readSiteSystem(value) {
+    if (value === NOT_LITERAL || !isRecord(value)) {
+        throw new Error(`siteSystem in ${CONFIG_FILE} must be written as a literal object, for example siteSystem: { tier: 'shell' }.`);
+    }
+    const unknown = Object.keys(value).filter((key) => !SITE_SYSTEM_KEYS.has(key));
+    if (unknown.length > 0)
+        throw new Error(`siteSystem in ${CONFIG_FILE} contains unsupported keys: ${unknown.join(", ")}.`);
+    if (!SITE_SYSTEM_TIERS.includes(value.tier)) {
+        throw new Error(`siteSystem.tier in ${CONFIG_FILE} must be ${SITE_SYSTEM_TIERS.join(", ")}.`);
+    }
+    if (value.newBuild !== undefined && typeof value.newBuild !== "boolean") {
+        throw new Error(`siteSystem.newBuild in ${CONFIG_FILE} must be true or false.`);
+    }
+    if (value.samples !== undefined &&
+        (!Array.isArray(value.samples) || value.samples.some((path) => typeof path !== "string" || !path.startsWith("/")))) {
+        throw new Error(`siteSystem.samples in ${CONFIG_FILE} must be a literal list of root-relative paths.`);
+    }
+    if (value.freeQuotes !== undefined && typeof value.freeQuotes !== "boolean") {
+        throw new Error(`siteSystem.freeQuotes in ${CONFIG_FILE} must be true or false.`);
+    }
+    return {
+        tier: value.tier,
+        newBuild: value.newBuild === true,
+        samples: value.samples ?? [],
+        labels: stringList(value.labels, "labels", "non-empty labels", (label) => label.trim().length > 0),
+        freeQuotes: value.freeQuotes ?? null,
+        thirdParties: stringList(value.thirdParties, "thirdParties", "hostnames such as www.youtube.com", (host) => HOSTNAME_PATTERN.test(host)),
+        phones: stringList(value.phones, "phones", "tel: links such as tel:+61290001234", (href) => TEL_HREF_PATTERN.test(href)),
+    };
+}
+/** A literal list of unique strings that each pass `valid`, or [] when absent. */
+function stringList(value, key, expected, valid) {
+    if (value === undefined)
+        return [];
+    if (!Array.isArray(value) ||
+        value.some((item) => typeof item !== "string" || !valid(item)) ||
+        new Set(value).size !== value.length) {
+        throw new Error(`siteSystem.${key} in ${CONFIG_FILE} must be a literal list of unique ${expected}.`);
+    }
+    return value;
+}
+function readException(value) {
+    if (!isRecord(value))
+        return null;
+    const { ruleId, rationale, evidence, expiresAt, reviewTrigger } = value;
+    if (typeof ruleId !== "string" || !ruleId.trim() ||
+        typeof rationale !== "string" ||
+        typeof evidence !== "string" ||
+        typeof reviewTrigger !== "string" ||
+        (expiresAt !== undefined && typeof expiresAt !== "string")) {
+        return null;
+    }
+    return { ruleId, rationale, evidence, reviewTrigger, ...(expiresAt !== undefined ? { expiresAt } : {}) };
+}
+function findProjectObject(source) {
+    let found;
+    const visit = (node) => {
+        if (found)
+            return;
+        if (ts.isCallExpression(node)) {
+            const callee = node.expression;
+            const name = ts.isIdentifier(callee) ? callee.text : ts.isPropertyAccessExpression(callee) ? callee.name.text : null;
+            const argument = node.arguments[0] ? unwrap(node.arguments[0]) : undefined;
+            if (name === "defineBrandlabProject" && argument && ts.isObjectLiteralExpression(argument)) {
+                found = argument;
+                return;
+            }
+        }
+        ts.forEachChild(node, visit);
+    };
+    visit(source);
+    return found;
+}
+function property(object, name) {
+    for (const member of object.properties) {
+        if (ts.isShorthandPropertyAssignment(member) && member.name.text === name)
+            return member.name;
+        if (!ts.isPropertyAssignment(member))
+            continue;
+        const key = member.name;
+        if ((ts.isIdentifier(key) || ts.isStringLiteralLike(key)) && key.text === name)
+            return member.initializer;
+    }
+    return undefined;
+}
+function unwrap(node) {
+    let current = node;
+    while (ts.isParenthesizedExpression(current) ||
+        ts.isAsExpression(current) ||
+        ts.isSatisfiesExpression(current) ||
+        ts.isNonNullExpression(current) ||
+        ts.isTypeAssertionExpression(current)) {
+        current = current.expression;
+    }
+    return current;
+}
+/** The JSON value of a literal expression, or NOT_LITERAL when any part is computed. */
+function literal(node) {
+    if (!node)
+        return undefined;
+    const value = unwrap(node);
+    if (ts.isStringLiteralLike(value))
+        return value.text;
+    if (ts.isNumericLiteral(value))
+        return Number(value.text);
+    if (value.kind === ts.SyntaxKind.TrueKeyword)
+        return true;
+    if (value.kind === ts.SyntaxKind.FalseKeyword)
+        return false;
+    if (value.kind === ts.SyntaxKind.NullKeyword)
+        return null;
+    if (ts.isArrayLiteralExpression(value)) {
+        const items = value.elements.map((element) => (ts.isSpreadElement(element) ? NOT_LITERAL : literal(element)));
+        return items.includes(NOT_LITERAL) ? NOT_LITERAL : items;
+    }
+    if (ts.isObjectLiteralExpression(value)) {
+        const object = {};
+        for (const member of value.properties) {
+            if (!ts.isPropertyAssignment(member))
+                return NOT_LITERAL;
+            const key = member.name;
+            if (!ts.isIdentifier(key) && !ts.isStringLiteralLike(key))
+                return NOT_LITERAL;
+            const item = literal(member.initializer);
+            if (item === NOT_LITERAL)
+                return NOT_LITERAL;
+            object[key.text] = item;
+        }
+        return object;
+    }
+    return NOT_LITERAL;
+}
+function isRecord(value) {
+    return Boolean(value) && typeof value === "object" && !Array.isArray(value);
+}
+//# sourceMappingURL=config.js.map

package/dist/site-system/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/site-system/config.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAuB,MAAM,aAAa,CAAC;AAwCrE,MAAM,WAAW,GAAG,oBAAoB,CAAC;AACzC,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;AACpH,MAAM,gBAAgB,GAAG,uEAAuE,CAAC;AACjG,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAC7C,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;AAE1C,MAAM,UAAU,2BAA2B,CAAC,IAAY;IACtD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACrC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,gEAAgE,CAAC,CAAC;IACvH,OAAO,4BAA4B,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,mHAAmH;AACnH,MAAM,UAAU,4BAA4B,CAAC,IAAY;IACvD,MAAM,MAAM,GAAG,EAAE,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IACtG,MAAM,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACzC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,sDAAsD,CAAC,CAAC;IACxF,CAAC;IACD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAC1D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,QAAQ,CAAC,IAAI,CAAC,qCAAqC,WAAW,uGAAuG,CAAC,CAAC;IACzK,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IAEzD,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;IAEjG,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACtD,IAAI,UAAU,GAA0B,EAAE,CAAC;IAC3C,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,qBAAqB,WAAW,2DAA2D,CAAC,CAAC;QAC7G,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;gBAC1C,MAAM,SAAS,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;gBACvC,IAAI,CAAC,SAAS;oBAAE,QAAQ,CAAC,IAAI,CAAC,cAAc,KAAK,QAAQ,WAAW,uFAAuF,CAAC,CAAC;gBAC7J,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACtC,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAC7E,MAAM,MAAM,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;IACpG,MAAM,oBAAoB,GAA2B,EAAE,CAAC;IACxD,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,oBAAoB,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QAC1F,CAAC;IACH,CAAC;SAAM,IAAI,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,KAAK,SAAS,EAAE,CAAC;QACjE,QAAQ,CAAC,IAAI,CAAC,+CAA+C,WAAW,6DAA6D,CAAC,CAAC;IACzI,CAAC;IAED,OAAO;QACL,SAAS,EAAE,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI;QAC3D,UAAU;QACV,UAAU;QACV,oBAAoB;QACpB,QAAQ;QACR,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,0GAA0G;AAC1G,SAAS,eAAe,CAAC,MAAmC;IAC1D,IAAI,EAAE,CAAC,6BAA6B,CAAC,MAAM,CAAC;QAAE,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAC;IACzF,OAAO,EAAE,CAAC,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AAClH,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,KAAK,KAAK,WAAW,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,iBAAiB,WAAW,kFAAkF,CAAC,CAAC;IAClI,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,WAAW,+BAA+B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1H,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAsB,CAAC,EAAE,CAAC;QAC9D,MAAM,IAAI,KAAK,CAAC,sBAAsB,WAAW,YAAY,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChG,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACxE,MAAM,IAAI,KAAK,CAAC,0BAA0B,WAAW,yBAAyB,CAAC,CAAC;IAClF,CAAC;IACD,IACE,KAAK,CAAC,OAAO,KAAK,SAAS;QAC3B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAClH,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,iDAAiD,CAAC,CAAC;IACzG,CAAC;IACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QAC5E,MAAM,IAAI,KAAK,CAAC,4BAA4B,WAAW,yBAAyB,CAAC,CAAC;IACpF,CAAC;IACD,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,IAAsB;QAClC,QAAQ,EAAE,KAAK,CAAC,QAAQ,KAAK,IAAI;QACjC,OAAO,EAAG,KAAK,CAAC,OAAgC,IAAI,EAAE;QACtD,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;QAClG,UAAU,EAAG,KAAK,CAAC,UAAkC,IAAI,IAAI;QAC7D,YAAY,EAAE,UAAU,CAAC,KAAK,CAAC,YAAY,EAAE,cAAc,EAAE,mCAAmC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxI,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,qCAAqC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KACzH,CAAC;AACJ,CAAC;AAED,kFAAkF;AAClF,SAAS,UAAU,CAAC,KAAc,EAAE,GAAW,EAAE,QAAgB,EAAE,KAAgC;IACjG,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACnC,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,MAAM,EACpC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,cAAc,GAAG,OAAO,WAAW,qCAAqC,QAAQ,GAAG,CAAC,CAAC;IACvG,CAAC;IACD,OAAO,KAAiB,CAAC;AAC3B,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAClC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;IACxE,IACE,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;QAC5C,OAAO,SAAS,KAAK,QAAQ;QAC7B,OAAO,QAAQ,KAAK,QAAQ;QAC5B,OAAO,aAAa,KAAK,QAAQ;QACjC,CAAC,SAAS,KAAK,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,CAAC,EAC1D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;AAC3G,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAqB;IAC9C,IAAI,KAA6C,CAAC;IAClD,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,EAAE;QAC9B,IAAI,KAAK;YAAE,OAAO;QAClB,IAAI,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;YAC/B,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YACrH,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3E,IAAI,IAAI,KAAK,uBAAuB,IAAI,QAAQ,IAAI,EAAE,CAAC,yBAAyB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3F,KAAK,GAAG,QAAQ,CAAC;gBACjB,OAAO;YACT,CAAC;QACH,CAAC;QACD,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,KAAK,CAAC,MAAM,CAAC,CAAC;IACd,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CAAC,MAAkC,EAAE,IAAY;IAChE,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QACvC,IAAI,EAAE,CAAC,6BAA6B,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI;YAAE,OAAO,MAAM,CAAC,IAAI,CAAC;QAC9F,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,MAAM,CAAC;YAAE,SAAS;QAC/C,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI;YAAE,OAAO,MAAM,CAAC,WAAW,CAAC;IAC5G,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,MAAM,CAAC,IAAmB;IACjC,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,OACE,EAAE,CAAC,yBAAyB,CAAC,OAAO,CAAC;QACrC,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC;QAC1B,EAAE,CAAC,qBAAqB,CAAC,OAAO,CAAC;QACjC,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC;QAC/B,EAAE,CAAC,yBAAyB,CAAC,OAAO,CAAC,EACrC,CAAC;QACD,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC;IAC/B,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,wFAAwF;AACxF,SAAS,OAAO,CAAC,IAA+B;IAC9C,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,IAAI,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC;IACrD,IAAI,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1D,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAC1D,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,YAAY;QAAE,OAAO,KAAK,CAAC;IAC5D,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAC1D,IAAI,EAAE,CAAC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC9G,OAAO,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3D,CAAC;IACD,IAAI,EAAE,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC;QACxC,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACtC,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,MAAM,CAAC;gBAAE,OAAO,WAAW,CAAC;YACzD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;YACxB,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC;gBAAE,OAAO,WAAW,CAAC;YAC9E,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;YACzC,IAAI,IAAI,KAAK,WAAW;gBAAE,OAAO,WAAW,CAAC;YAC7C,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QAC1B,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC","sourcesContent":["/**\n * What the ready gate reads from brandlab.config.ts: the Site System tier, the exceptions record and the\n * representative routes. The file is parsed, never executed, so these fields must be written literally (as\n * `defineBrandlabProject` requires anyway).\n */\nimport { existsSync, readFileSync } from \"node:fs\";\nimport { join } from \"node:path\";\nimport ts from \"typescript\";\nimport { SITE_SYSTEM_TIERS, type SiteSystemTier } from \"./checks.js\";\n\nexport interface SiteSystemSettings {\n  readonly tier: SiteSystemTier;\n  /** A new build or redesign: D4 blocks whatever the tier. */\n  readonly newBuild: boolean;\n  /** Extra pages to sample for the rendered checks. */\n  readonly samples: readonly string[];\n  /** Quote and call-to-action labels recorded for this site, beyond the closed list (C5). */\n  readonly labels: readonly string[];\n  /** Whether the business offers free quotes; null when not recorded. */\n  readonly freeQuotes: boolean | null;\n  /** Third-party hostnames the site may load (B1). */\n  readonly thirdParties: readonly string[];\n  /** Extra tel: links the site legitimately shows (C10). */\n  readonly phones: readonly string[];\n}\n\n/** A Romie-owned holdout; `ruleId` names the check it covers. */\nexport interface SiteSystemException {\n  readonly ruleId: string;\n  readonly rationale: string;\n  readonly evidence: string;\n  readonly expiresAt?: string;\n  readonly reviewTrigger: string;\n}\n\nexport interface SiteSystemProjectConfig {\n  readonly projectId: string | null;\n  /** Null when the site has not adopted Site System v2: nothing in the gate blocks. */\n  readonly siteSystem: SiteSystemSettings | null;\n  readonly exceptions: readonly SiteSystemException[];\n  /** `searchCertification.representativeRoutes` (home, contact, service, location, blog). */\n  readonly representativeRoutes: Readonly<Record<string, string>>;\n  /** False when defineBrandlabProject({ ... }) spreads or computes a member, so a tier could be hidden. */\n  readonly complete: boolean;\n  /** Fields that could not be read; the gate reports them and carries on without them. */\n  readonly problems: readonly string[];\n}\n\nconst CONFIG_FILE = \"brandlab.config.ts\";\nconst SITE_SYSTEM_KEYS = new Set([\"tier\", \"newBuild\", \"samples\", \"labels\", \"freeQuotes\", \"thirdParties\", \"phones\"]);\nconst HOSTNAME_PATTERN = /^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$/;\nconst TEL_HREF_PATTERN = /^tel:\\+?\\d{6,15}$/;\nconst NOT_LITERAL = Symbol(\"not literal\");\n\nexport function readSiteSystemProjectConfig(root: string): SiteSystemProjectConfig {\n  const path = join(root, CONFIG_FILE);\n  if (!existsSync(path)) throw new Error(`${CONFIG_FILE} is missing, so the ready gate cannot tell which tier applies.`);\n  return parseSiteSystemProjectConfig(readFileSync(path, \"utf8\"));\n}\n\n/** Throws when siteSystem is present but unreadable or invalid: a declared tier must never be skipped silently. */\nexport function parseSiteSystemProjectConfig(text: string): SiteSystemProjectConfig {\n  const source = ts.createSourceFile(CONFIG_FILE, text, ts.ScriptTarget.Latest, true, ts.ScriptKind.TS);\n  const config = findProjectObject(source);\n  if (!config) {\n    throw new Error(`${CONFIG_FILE} has no literal defineBrandlabProject({ ... }) call.`);\n  }\n  const problems: string[] = [];\n  const complete = config.properties.every(isPlainProperty);\n  if (!complete) {\n    problems.push(`defineBrandlabProject({ ... }) in ${CONFIG_FILE} spreads or computes a member, so the ready gate cannot read it in full; write every field literally.`);\n  }\n\n  const projectId = literal(property(config, \"projectId\"));\n\n  const siteSystemNode = property(config, \"siteSystem\");\n  const siteSystem = siteSystemNode === undefined ? null : readSiteSystem(literal(siteSystemNode));\n\n  const exceptionsNode = property(config, \"exceptions\");\n  let exceptions: SiteSystemException[] = [];\n  if (exceptionsNode !== undefined) {\n    const value = literal(exceptionsNode);\n    if (!Array.isArray(value)) {\n      problems.push(`The exceptions in ${CONFIG_FILE} are not written as a literal list, so none were applied.`);\n    } else {\n      exceptions = value.flatMap((entry, index) => {\n        const exception = readException(entry);\n        if (!exception) problems.push(`exceptions[${index}] in ${CONFIG_FILE} has no literal ruleId, rationale, evidence and reviewTrigger, so it was not applied.`);\n        return exception ? [exception] : [];\n      });\n    }\n  }\n\n  const searchCertification = literal(property(config, \"searchCertification\"));\n  const routes = isRecord(searchCertification) ? searchCertification.representativeRoutes : undefined;\n  const representativeRoutes: Record<string, string> = {};\n  if (isRecord(routes)) {\n    for (const [name, path] of Object.entries(routes)) {\n      if (typeof path === \"string\" && path.startsWith(\"/\")) representativeRoutes[name] = path;\n    }\n  } else if (property(config, \"searchCertification\") !== undefined) {\n    problems.push(`searchCertification.representativeRoutes in ${CONFIG_FILE} is not literal, so only the home page was sampled from it.`);\n  }\n\n  return {\n    projectId: typeof projectId === \"string\" ? projectId : null,\n    siteSystem,\n    exceptions,\n    representativeRoutes,\n    complete,\n    problems,\n  };\n}\n\n/** `key: value` or `key` with an identifier or string key; spreads, computed keys and methods are not. */\nfunction isPlainProperty(member: ts.ObjectLiteralElementLike): boolean {\n  if (ts.isShorthandPropertyAssignment(member)) return !member.objectAssignmentInitializer;\n  return ts.isPropertyAssignment(member) && (ts.isIdentifier(member.name) || ts.isStringLiteralLike(member.name));\n}\n\nfunction readSiteSystem(value: unknown): SiteSystemSettings {\n  if (value === NOT_LITERAL || !isRecord(value)) {\n    throw new Error(`siteSystem in ${CONFIG_FILE} must be written as a literal object, for example siteSystem: { tier: 'shell' }.`);\n  }\n  const unknown = Object.keys(value).filter((key) => !SITE_SYSTEM_KEYS.has(key));\n  if (unknown.length > 0) throw new Error(`siteSystem in ${CONFIG_FILE} contains unsupported keys: ${unknown.join(\", \")}.`);\n  if (!SITE_SYSTEM_TIERS.includes(value.tier as SiteSystemTier)) {\n    throw new Error(`siteSystem.tier in ${CONFIG_FILE} must be ${SITE_SYSTEM_TIERS.join(\", \")}.`);\n  }\n  if (value.newBuild !== undefined && typeof value.newBuild !== \"boolean\") {\n    throw new Error(`siteSystem.newBuild in ${CONFIG_FILE} must be true or false.`);\n  }\n  if (\n    value.samples !== undefined &&\n    (!Array.isArray(value.samples) || value.samples.some((path) => typeof path !== \"string\" || !path.startsWith(\"/\")))\n  ) {\n    throw new Error(`siteSystem.samples in ${CONFIG_FILE} must be a literal list of root-relative paths.`);\n  }\n  if (value.freeQuotes !== undefined && typeof value.freeQuotes !== \"boolean\") {\n    throw new Error(`siteSystem.freeQuotes in ${CONFIG_FILE} must be true or false.`);\n  }\n  return {\n    tier: value.tier as SiteSystemTier,\n    newBuild: value.newBuild === true,\n    samples: (value.samples as string[] | undefined) ?? [],\n    labels: stringList(value.labels, \"labels\", \"non-empty labels\", (label) => label.trim().length > 0),\n    freeQuotes: (value.freeQuotes as boolean | undefined) ?? null,\n    thirdParties: stringList(value.thirdParties, \"thirdParties\", \"hostnames such as www.youtube.com\", (host) => HOSTNAME_PATTERN.test(host)),\n    phones: stringList(value.phones, \"phones\", \"tel: links such as tel:+61290001234\", (href) => TEL_HREF_PATTERN.test(href)),\n  };\n}\n\n/** A literal list of unique strings that each pass `valid`, or [] when absent. */\nfunction stringList(value: unknown, key: string, expected: string, valid: (item: string) => boolean): string[] {\n  if (value === undefined) return [];\n  if (\n    !Array.isArray(value) ||\n    value.some((item) => typeof item !== \"string\" || !valid(item)) ||\n    new Set(value).size !== value.length\n  ) {\n    throw new Error(`siteSystem.${key} in ${CONFIG_FILE} must be a literal list of unique ${expected}.`);\n  }\n  return value as string[];\n}\n\nfunction readException(value: unknown): SiteSystemException | null {\n  if (!isRecord(value)) return null;\n  const { ruleId, rationale, evidence, expiresAt, reviewTrigger } = value;\n  if (\n    typeof ruleId !== \"string\" || !ruleId.trim() ||\n    typeof rationale !== \"string\" ||\n    typeof evidence !== \"string\" ||\n    typeof reviewTrigger !== \"string\" ||\n    (expiresAt !== undefined && typeof expiresAt !== \"string\")\n  ) {\n    return null;\n  }\n  return { ruleId, rationale, evidence, reviewTrigger, ...(expiresAt !== undefined ? { expiresAt } : {}) };\n}\n\nfunction findProjectObject(source: ts.SourceFile): ts.ObjectLiteralExpression | undefined {\n  let found: ts.ObjectLiteralExpression | undefined;\n  const visit = (node: ts.Node) => {\n    if (found) return;\n    if (ts.isCallExpression(node)) {\n      const callee = node.expression;\n      const name = ts.isIdentifier(callee) ? callee.text : ts.isPropertyAccessExpression(callee) ? callee.name.text : null;\n      const argument = node.arguments[0] ? unwrap(node.arguments[0]) : undefined;\n      if (name === \"defineBrandlabProject\" && argument && ts.isObjectLiteralExpression(argument)) {\n        found = argument;\n        return;\n      }\n    }\n    ts.forEachChild(node, visit);\n  };\n  visit(source);\n  return found;\n}\n\nfunction property(object: ts.ObjectLiteralExpression, name: string): ts.Expression | undefined {\n  for (const member of object.properties) {\n    if (ts.isShorthandPropertyAssignment(member) && member.name.text === name) return member.name;\n    if (!ts.isPropertyAssignment(member)) continue;\n    const key = member.name;\n    if ((ts.isIdentifier(key) || ts.isStringLiteralLike(key)) && key.text === name) return member.initializer;\n  }\n  return undefined;\n}\n\nfunction unwrap(node: ts.Expression): ts.Expression {\n  let current = node;\n  while (\n    ts.isParenthesizedExpression(current) ||\n    ts.isAsExpression(current) ||\n    ts.isSatisfiesExpression(current) ||\n    ts.isNonNullExpression(current) ||\n    ts.isTypeAssertionExpression(current)\n  ) {\n    current = current.expression;\n  }\n  return current;\n}\n\n/** The JSON value of a literal expression, or NOT_LITERAL when any part is computed. */\nfunction literal(node: ts.Expression | undefined): unknown {\n  if (!node) return undefined;\n  const value = unwrap(node);\n  if (ts.isStringLiteralLike(value)) return value.text;\n  if (ts.isNumericLiteral(value)) return Number(value.text);\n  if (value.kind === ts.SyntaxKind.TrueKeyword) return true;\n  if (value.kind === ts.SyntaxKind.FalseKeyword) return false;\n  if (value.kind === ts.SyntaxKind.NullKeyword) return null;\n  if (ts.isArrayLiteralExpression(value)) {\n    const items = value.elements.map((element) => (ts.isSpreadElement(element) ? NOT_LITERAL : literal(element)));\n    return items.includes(NOT_LITERAL) ? NOT_LITERAL : items;\n  }\n  if (ts.isObjectLiteralExpression(value)) {\n    const object: Record<string, unknown> = {};\n    for (const member of value.properties) {\n      if (!ts.isPropertyAssignment(member)) return NOT_LITERAL;\n      const key = member.name;\n      if (!ts.isIdentifier(key) && !ts.isStringLiteralLike(key)) return NOT_LITERAL;\n      const item = literal(member.initializer);\n      if (item === NOT_LITERAL) return NOT_LITERAL;\n      object[key.text] = item;\n    }\n    return object;\n  }\n  return NOT_LITERAL;\n}\n\nfunction isRecord(value: unknown): value is Record<string, unknown> {\n  return Boolean(value) && typeof value === \"object\" && !Array.isArray(value);\n}\n"]}

package/dist/site-system/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The Site System v2 ready gate: the check registry, the rule-module interface `brandlab-ready` runs, the step
+ * records and the ready report.
+ */
+export { SITE_SYSTEM_CHECKS, SITE_SYSTEM_TIERS, siteSystemCheckBlocks, type SiteSystemCheck, type SiteSystemCheckId, type SiteSystemCheckKind, type SiteSystemCheckScope, type SiteSystemFinding, type SiteSystemTier, } from "./checks.js";
+export { parseSiteSystemProjectConfig, readSiteSystemProjectConfig, type SiteSystemException, type SiteSystemProjectConfig, type SiteSystemSettings, } from "./config.js";
+export { readSiteSystemJourneyReport, siteSystemCheckIdsInTitle, type SiteSystemJourneyResults, } from "./playwright-report.js";
+export { appendSiteSystemRecord, latestSiteSystemRecords, readSiteSystemRecords, SITE_SYSTEM_RECORD_PATHS, SITE_SYSTEM_RECORDS_SCHEMA, type SiteSystemRecord, type SiteSystemRecordsDocument, } from "./records.js";
+export { buildSiteSystemReadyReport, isExceptionExpired, renderSiteSystemReadyMarkdown, SITE_SYSTEM_READY_REPORT_PATHS, SITE_SYSTEM_READY_SCHEMA, type BuildSiteSystemReadyReportInput, type SiteSystemReadyCheck, type SiteSystemReadyException, type SiteSystemReadyInputs, type SiteSystemReadyReport, type SiteSystemReadyStatus, type SiteSystemReadyStep, type SiteSystemReadyVerdict, type SiteSystemVerifyResult, } from "./report.js";
+export { SITE_SYSTEM_RENDERED_RUNNERS } from "./rule-modules.js";
+export { isSiteSystemFinding, runSiteSystemRenderedRunners, type SiteSystemRenderedInput, type SiteSystemRenderedRunner, } from "./runners.js";
+export { builtPageFile, loadSiteSystemPages, planSiteSystemSamplePaths, resolveStreamedHtml, type SiteSystemFetch, type SiteSystemPage, type SiteSystemPageLoad, } from "./samples.js";
+export { SITE_SYSTEM_HUMAN_STEPS, SITE_SYSTEM_LAUNCH_STEPS, SITE_SYSTEM_RECORDED_CHECK_IDS, siteSystemRecordFile, type SiteSystemHumanStepId, type SiteSystemLaunchStepId, type SiteSystemRecordFile, type SiteSystemStep, } from "./steps.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/site-system/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/site-system/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,EACrB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,4BAA4B,EAC5B,2BAA2B,EAC3B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,2BAA2B,EAC3B,yBAAyB,EACzB,KAAK,wBAAwB,GAC9B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,0BAA0B,EAC1B,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,GAC/B,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,6BAA6B,EAC7B,8BAA8B,EAC9B,wBAAwB,EACxB,KAAK,+BAA+B,EACpC,KAAK,oBAAoB,EACzB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,GAC5B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EACL,mBAAmB,EACnB,4BAA4B,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,GAC9B,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,kBAAkB,GACxB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,oBAAoB,EACpB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,cAAc,GACpB,MAAM,YAAY,CAAC"}

package/dist/site-system/index.js

@@ -0,0 +1,14 @@
+/**
+ * The Site System v2 ready gate: the check registry, the rule-module interface `brandlab-ready` runs, the step
+ * records and the ready report.
+ */
+export { SITE_SYSTEM_CHECKS, SITE_SYSTEM_TIERS, siteSystemCheckBlocks, } from "./checks.js";
+export { parseSiteSystemProjectConfig, readSiteSystemProjectConfig, } from "./config.js";
+export { readSiteSystemJourneyReport, siteSystemCheckIdsInTitle, } from "./playwright-report.js";
+export { appendSiteSystemRecord, latestSiteSystemRecords, readSiteSystemRecords, SITE_SYSTEM_RECORD_PATHS, SITE_SYSTEM_RECORDS_SCHEMA, } from "./records.js";
+export { buildSiteSystemReadyReport, isExceptionExpired, renderSiteSystemReadyMarkdown, SITE_SYSTEM_READY_REPORT_PATHS, SITE_SYSTEM_READY_SCHEMA, } from "./report.js";
+export { SITE_SYSTEM_RENDERED_RUNNERS } from "./rule-modules.js";
+export { isSiteSystemFinding, runSiteSystemRenderedRunners, } from "./runners.js";
+export { builtPageFile, loadSiteSystemPages, planSiteSystemSamplePaths, resolveStreamedHtml, } from "./samples.js";
+export { SITE_SYSTEM_HUMAN_STEPS, SITE_SYSTEM_LAUNCH_STEPS, SITE_SYSTEM_RECORDED_CHECK_IDS, siteSystemRecordFile, } from "./steps.js";
+//# sourceMappingURL=index.js.map

package/dist/site-system/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/site-system/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,GAOtB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,4BAA4B,EAC5B,2BAA2B,GAI5B,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,2BAA2B,EAC3B,yBAAyB,GAE1B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,0BAA0B,GAG3B,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,6BAA6B,EAC7B,8BAA8B,EAC9B,wBAAwB,GAUzB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EACL,mBAAmB,EACnB,4BAA4B,GAG7B,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,GAIpB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,8BAA8B,EAC9B,oBAAoB,GAKrB,MAAM,YAAY,CAAC","sourcesContent":["/**\n * The Site System v2 ready gate: the check registry, the rule-module interface `brandlab-ready` runs, the step\n * records and the ready report.\n */\nexport {\n  SITE_SYSTEM_CHECKS,\n  SITE_SYSTEM_TIERS,\n  siteSystemCheckBlocks,\n  type SiteSystemCheck,\n  type SiteSystemCheckId,\n  type SiteSystemCheckKind,\n  type SiteSystemCheckScope,\n  type SiteSystemFinding,\n  type SiteSystemTier,\n} from \"./checks.js\";\nexport {\n  parseSiteSystemProjectConfig,\n  readSiteSystemProjectConfig,\n  type SiteSystemException,\n  type SiteSystemProjectConfig,\n  type SiteSystemSettings,\n} from \"./config.js\";\nexport {\n  readSiteSystemJourneyReport,\n  siteSystemCheckIdsInTitle,\n  type SiteSystemJourneyResults,\n} from \"./playwright-report.js\";\nexport {\n  appendSiteSystemRecord,\n  latestSiteSystemRecords,\n  readSiteSystemRecords,\n  SITE_SYSTEM_RECORD_PATHS,\n  SITE_SYSTEM_RECORDS_SCHEMA,\n  type SiteSystemRecord,\n  type SiteSystemRecordsDocument,\n} from \"./records.js\";\nexport {\n  buildSiteSystemReadyReport,\n  isExceptionExpired,\n  renderSiteSystemReadyMarkdown,\n  SITE_SYSTEM_READY_REPORT_PATHS,\n  SITE_SYSTEM_READY_SCHEMA,\n  type BuildSiteSystemReadyReportInput,\n  type SiteSystemReadyCheck,\n  type SiteSystemReadyException,\n  type SiteSystemReadyInputs,\n  type SiteSystemReadyReport,\n  type SiteSystemReadyStatus,\n  type SiteSystemReadyStep,\n  type SiteSystemReadyVerdict,\n  type SiteSystemVerifyResult,\n} from \"./report.js\";\nexport { SITE_SYSTEM_RENDERED_RUNNERS } from \"./rule-modules.js\";\nexport {\n  isSiteSystemFinding,\n  runSiteSystemRenderedRunners,\n  type SiteSystemRenderedInput,\n  type SiteSystemRenderedRunner,\n} from \"./runners.js\";\nexport {\n  builtPageFile,\n  loadSiteSystemPages,\n  planSiteSystemSamplePaths,\n  resolveStreamedHtml,\n  type SiteSystemFetch,\n  type SiteSystemPage,\n  type SiteSystemPageLoad,\n} from \"./samples.js\";\nexport {\n  SITE_SYSTEM_HUMAN_STEPS,\n  SITE_SYSTEM_LAUNCH_STEPS,\n  SITE_SYSTEM_RECORDED_CHECK_IDS,\n  siteSystemRecordFile,\n  type SiteSystemHumanStepId,\n  type SiteSystemLaunchStepId,\n  type SiteSystemRecordFile,\n  type SiteSystemStep,\n} from \"./steps.js\";\n"]}

package/dist/site-system/journeys/access.d.ts

@@ -0,0 +1,7 @@
+import { type SiteSystemJourneyPlan } from './plan.js';
+/** The shortest side a primary action (call, quote, Menu) may have on a phone, with half a pixel for rounding. */
+export declare const PRIMARY_TARGET_PX = 44;
+export declare function defineAccessJourneys(plan: SiteSystemJourneyPlan, runs: ReadonlySet<string>, options: {
+    chromiumOnly: () => void;
+}): void;
+//# sourceMappingURL=access.d.ts.map

package/dist/site-system/journeys/access.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"access.d.ts","sourceRoot":"","sources":["../../../src/site-system/journeys/access.ts"],"names":[],"mappings":"AAsBA,OAAO,EAA6F,KAAK,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAGlJ,kHAAkH;AAClH,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAgCpC,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE;IAAE,YAAY,EAAE,MAAM,IAAI,CAAA;CAAE,GAAG,IAAI,CAoNxI"}

package/dist/site-system/journeys/access.js

@@ -0,0 +1,263 @@
+/**
+ * K3 to K6 in the browser. K3: text contrast (axe `color-contrast`: 4.5:1, 3:1 for large text) and the non-text
+ * contrast of icon-only controls (3:1) in the header, menu panels, drawer and footer. K4: primary actions (call, quote,
+ * Menu) at least 44 px on phones; every other target 24 px or spaced (axe `target-size`). K5: Tab through every
+ * focusable element at 390 px; none is ever fully hidden under the sticky header or the call bar (in every browser
+ * project the site runs). K6: the phone and quote actions in one order in the header, the hero and the call bar.
+ */
+import { expect, test } from '@playwright/test';
+import { describeAxe, mainNavigation, menuDisclosures, note, openSitePage, panelLocator, panelOpen, raiseTimeout, runAxe, siteFooter, siteHeader, waitUntil, } from './browser.js';
+import { SITE_SYSTEM_DESKTOP_VIEWPORT, SITE_SYSTEM_PHONE_VIEWPORT, siteSystemJourneyTitle as title } from './plan.js';
+import { callBarLinks, menuButton, openDrawer } from './shell.js';
+/** The shortest side a primary action (call, quote, Menu) may have on a phone, with half a pixel for rounding. */
+export const PRIMARY_TARGET_PX = 44;
+const SCOPE = Object.freeze({
+    header: '[data-brandlab-journey~="header"]',
+    nav: '[data-brandlab-journey~="nav"]',
+    panel: '[data-brandlab-journey~="panel"]',
+    drawer: '[data-brandlab-journey~="drawer"]',
+    footer: '[data-brandlab-journey~="footer"]',
+    callBar: '[data-brandlab-journey~="call-bar"]',
+});
+async function iconProblems(region, label) {
+    if (!(await region.count()))
+        return [];
+    const result = await region.evaluate((element) => window.__brandlabSiteSystem.iconContrastProblems(element));
+    return result.problems.map((problem) => `${label}: ${problem}`);
+}
+/** Open each desktop panel in turn and run `check` while it is open. */
+async function withEachPanel(page, plan, check) {
+    const nav = await mainNavigation(page, plan);
+    if (!nav)
+        return;
+    for (const disclosure of await menuDisclosures(nav)) {
+        await disclosure.trigger.click();
+        if (!(await waitUntil(() => panelOpen(page, disclosure), 500)))
+            continue;
+        await page.waitForTimeout(250);
+        await panelLocator(page, disclosure.panelId).evaluate((panel) => window.__brandlabSiteSystem.markElement(panel, 'panel'));
+        await check(disclosure.label);
+        await disclosure.trigger.click();
+        await page.waitForTimeout(100);
+    }
+}
+export function defineAccessJourneys(plan, runs, options) {
+    const quote = { source: plan.quoteName.source, flags: plan.quoteName.flags };
+    test.describe('contrast, targets and order', () => {
+        options.chromiumOnly();
+        if (runs.has('K3')) {
+            test(title('K3', 'text and icons in the header, menu panels and footer meet contrast at 1440 px'), async ({ page }, testInfo) => {
+                await page.setViewportSize({ ...SITE_SYSTEM_DESKTOP_VIEWPORT });
+                await openSitePage(page, plan.home, plan);
+                const header = await siteHeader(page);
+                const footer = await siteFooter(page);
+                await mainNavigation(page, plan);
+                const problems = [];
+                const text = await runAxe(page, [SCOPE.header, SCOPE.nav, SCOPE.footer], { rules: ['color-contrast'] });
+                let unmeasured = text.incomplete;
+                problems.push(...describeAxe(text.violations));
+                problems.push(...(await iconProblems(header, 'header')), ...(await iconProblems(footer, 'footer')));
+                await withEachPanel(page, plan, async (label) => {
+                    const open = await runAxe(page, [SCOPE.panel], { rules: ['color-contrast'] });
+                    unmeasured += open.incomplete;
+                    problems.push(...describeAxe(open.violations).map((line) => `${label} open: ${line}`));
+                    problems.push(...(await iconProblems(page.locator(SCOPE.panel).filter({ visible: true }).first(), `${label} panel`)));
+                });
+                note(testInfo, `axe could not measure ${unmeasured} colour result(s) (text over images or overlapping layers); review them by eye`);
+                expect([...new Set(problems)]).toEqual([]);
+            });
+            test(title('K3', 'text and icons in the phone header, drawer and footer meet contrast at 390 px'), async ({ page }, testInfo) => {
+                await page.setViewportSize({ ...SITE_SYSTEM_PHONE_VIEWPORT });
+                await openSitePage(page, plan.home, plan);
+                const header = await siteHeader(page);
+                const footer = await siteFooter(page);
+                const problems = [];
+                const text = await runAxe(page, [SCOPE.header, SCOPE.footer], { rules: ['color-contrast'] });
+                let unmeasured = text.incomplete;
+                problems.push(...describeAxe(text.violations));
+                problems.push(...(await iconProblems(header, 'header')), ...(await iconProblems(footer, 'footer')));
+                const button = menuButton(header, plan);
+                if (await button.count()) {
+                    const drawer = await openDrawer(page, button, 'click');
+                    if (drawer) {
+                        const group = drawer.locator('button[aria-expanded="false"], summary').filter({ visible: true }).first();
+                        if (await group.count())
+                            await group.click();
+                        await page.waitForTimeout(150);
+                        const inDrawer = await runAxe(page, [SCOPE.drawer], { rules: ['color-contrast'] });
+                        unmeasured += inDrawer.incomplete;
+                        problems.push(...describeAxe(inDrawer.violations).map((line) => `drawer: ${line}`));
+                        problems.push(...(await iconProblems(drawer, 'drawer')));
+                    }
+                }
+                note(testInfo, `axe could not measure ${unmeasured} colour result(s) (text over images or overlapping layers); review them by eye`);
+                expect([...new Set(problems)]).toEqual([]);
+            });
+        }
+        if (runs.has('K4')) {
+            test(title('K4', 'the call, quote and Menu actions are at least 44 px on phones'), async ({ page }, testInfo) => {
+                raiseTimeout(testInfo, 180_000);
+                await page.setViewportSize({ ...SITE_SYSTEM_PHONE_VIEWPORT });
+                const problems = [];
+                const measure = async (label, finder) => {
+                    const targets = await page.evaluate(finder, quote);
+                    for (const target of targets) {
+                        if (target.width < PRIMARY_TARGET_PX - 0.5 || target.height < PRIMARY_TARGET_PX - 0.5) {
+                            problems.push(`${label}: ${target.description} is ${Math.round(target.width)} x ${Math.round(target.height)} px (primary actions need 44 x 44)`);
+                        }
+                    }
+                    return targets.length;
+                };
+                for (const path of [plan.home, ...plan.money]) {
+                    await openSitePage(page, path, plan);
+                    const header = await siteHeader(page);
+                    await measure(`${path} header`, (name) => {
+                        const helpers = window.__brandlabSiteSystem;
+                        const root = document.querySelector('[data-brandlab-journey~="header"]');
+                        if (!root)
+                            return [];
+                        const targets = [...Array.from(root.querySelectorAll('a[href^="tel:"]')).filter(helpers.isRendered), ...helpers.quoteActions(root, name)];
+                        return targets.map((element) => ({ description: helpers.describeElement(element), ...element.getBoundingClientRect().toJSON() }));
+                    });
+                    const menu = menuButton(header, plan);
+                    if (await menu.count()) {
+                        const box = await menu.boundingBox();
+                        if (box && (box.width < PRIMARY_TARGET_PX - 0.5 || box.height < PRIMARY_TARGET_PX - 0.5))
+                            problems.push(`${path} header: the Menu button is ${Math.round(box.width)} x ${Math.round(box.height)} px (primary actions need 44 x 44)`);
+                    }
+                    await measure(`${path} hero`, (name) => {
+                        const helpers = window.__brandlabSiteSystem;
+                        const hero = helpers.heroRegion(name);
+                        if (!hero)
+                            return [];
+                        const targets = [...Array.from(hero.querySelectorAll('a[href^="tel:"]')).filter(helpers.isRendered), ...helpers.quoteActions(hero, name)];
+                        return targets.map((element) => ({ description: helpers.describeElement(element), ...element.getBoundingClientRect().toJSON() }));
+                    });
+                    if (path === plan.home && (await menu.count())) {
+                        if (await openDrawer(page, menu, 'click')) {
+                            await measure('drawer', (name) => {
+                                const helpers = window.__brandlabSiteSystem;
+                                const drawer = document.querySelector('[data-brandlab-journey~="drawer"]');
+                                if (!drawer)
+                                    return [];
+                                const targets = [...Array.from(drawer.querySelectorAll('a[href^="tel:"]')).filter(helpers.isRendered), ...helpers.quoteActions(drawer, name)];
+                                return targets.map((element) => ({ description: helpers.describeElement(element), ...element.getBoundingClientRect().toJSON() }));
+                            });
+                            await page.keyboard.press('Escape');
+                            await page.waitForTimeout(200);
+                        }
+                    }
+                    if (await callBarLinks(page)) {
+                        await measure(`${path} call bar`, (name) => {
+                            const helpers = window.__brandlabSiteSystem;
+                            const bar = document.querySelector('[data-brandlab-journey~="call-bar"]');
+                            if (!bar)
+                                return [];
+                            const targets = [...Array.from(bar.querySelectorAll('a[href^="tel:"]')).filter(helpers.isRendered), ...helpers.quoteActions(bar, name)];
+                            return targets.map((element) => ({ description: helpers.describeElement(element), ...element.getBoundingClientRect().toJSON() }));
+                        });
+                    }
+                }
+                expect([...new Set(problems)]).toEqual([]);
+            });
+            test(title('K4', 'every other target in the header, panels, drawer and footer is at least 24 px or spaced apart'), async ({ page }) => {
+                const problems = [];
+                await page.setViewportSize({ ...SITE_SYSTEM_DESKTOP_VIEWPORT });
+                await openSitePage(page, plan.home, plan);
+                await siteHeader(page);
+                await siteFooter(page);
+                await mainNavigation(page, plan);
+                problems.push(...describeAxe((await runAxe(page, [SCOPE.header, SCOPE.nav, SCOPE.footer], { rules: ['target-size'] })).violations).map((line) => `1440 px: ${line}`));
+                await withEachPanel(page, plan, async (label) => {
+                    problems.push(...describeAxe((await runAxe(page, [SCOPE.panel], { rules: ['target-size'] })).violations).map((line) => `1440 px, ${label} open: ${line}`));
+                });
+                await page.setViewportSize({ ...SITE_SYSTEM_PHONE_VIEWPORT });
+                await openSitePage(page, plan.home, plan);
+                const header = await siteHeader(page);
+                await siteFooter(page);
+                problems.push(...describeAxe((await runAxe(page, [SCOPE.header, SCOPE.footer], { rules: ['target-size'] })).violations).map((line) => `390 px: ${line}`));
+                const menu = menuButton(header, plan);
+                if ((await menu.count()) && (await openDrawer(page, menu, 'click'))) {
+                    problems.push(...describeAxe((await runAxe(page, [SCOPE.drawer], { rules: ['target-size'] })).violations).map((line) => `390 px drawer: ${line}`));
+                }
+                expect([...new Set(problems)]).toEqual([]);
+            });
+        }
+        if (runs.has('K6')) {
+            for (const path of plan.sampled) {
+                test(title('K6', `the phone and quote actions keep the ${plan.actionOrder} order in the header, hero and call bar on ${path}`), async ({ page }, testInfo) => {
+                    raiseTimeout(testInfo, 180_000);
+                    const problems = [];
+                    const seen = [];
+                    const record = (where, order) => {
+                        if (order === 'incomplete')
+                            return;
+                        seen.push(`${where}: ${order}`);
+                        if (order !== plan.actionOrder)
+                            problems.push(`${where} shows the ${order === 'phone-first' ? 'phone before the quote' : 'quote before the phone'} (the site's order is ${plan.actionOrder})`);
+                    };
+                    for (const viewport of [SITE_SYSTEM_DESKTOP_VIEWPORT, SITE_SYSTEM_PHONE_VIEWPORT]) {
+                        await page.setViewportSize({ ...viewport });
+                        await openSitePage(page, path, plan);
+                        const header = await siteHeader(page);
+                        if (await header.count())
+                            record(`${viewport.width} px header`, await header.evaluate((element, name) => window.__brandlabSiteSystem.actionOrder(element, name), quote));
+                        record(`${viewport.width} px hero`, await page.evaluate((name) => {
+                            const hero = window.__brandlabSiteSystem.heroRegion(name);
+                            return hero ? window.__brandlabSiteSystem.actionOrder(hero, name) : 'incomplete';
+                        }, quote));
+                        if (viewport.width < 1024 && (await callBarLinks(page))) {
+                            record(`${viewport.width} px call bar`, await page.locator(SCOPE.callBar).first().evaluate((element, name) => window.__brandlabSiteSystem.actionOrder(element, name), quote));
+                        }
+                    }
+                    note(testInfo, seen.length ? `Orders seen: ${seen.join('; ')}` : 'No region shows both the phone and the quote action.');
+                    if (path === plan.home && !seen.some((entry) => entry.startsWith(`${SITE_SYSTEM_DESKTOP_VIEWPORT.width} px`))) {
+                        problems.push(`at ${SITE_SYSTEM_DESKTOP_VIEWPORT.width} px no region of the home page shows both the phone and the quote action, so their order cannot be checked`);
+                    }
+                    expect(problems).toEqual([]);
+                });
+            }
+        }
+    });
+    if (runs.has('K5')) {
+        test.describe('focus at 390 px', () => {
+            for (const path of plan.sampled) {
+                test(title('K5', `focus is never hidden under the sticky header or call bar on ${path} at 390 px`), async ({ page, browserName }, testInfo) => {
+                    raiseTimeout(testInfo, 240_000);
+                    await page.setViewportSize({ ...SITE_SYSTEM_PHONE_VIEWPORT });
+                    await openSitePage(page, path, plan);
+                    await siteHeader(page);
+                    const reachable = await page.evaluate(() => window.__brandlabSiteSystem.tabbableCount());
+                    const limit = Math.min(plan.maxTabStops, reachable + 10);
+                    // WebKit on macOS moves focus to links only with Option held.
+                    const key = browserName === 'webkit' && process.platform === 'darwin' ? 'Alt+Tab' : 'Tab';
+                    const hidden = [];
+                    let stops = 0;
+                    let outside = 0;
+                    for (let press = 0; press < limit; press += 1) {
+                        await page.keyboard.press(key);
+                        // Measure one frame later: a bar that hides on its observer's next frame is not caught mid-transition.
+                        const step = await page.evaluate(() => window.__brandlabSiteSystem.focusStepAfterFrame());
+                        if (step.repeat)
+                            break;
+                        if (step.done) {
+                            outside += 1;
+                            if (outside >= 2)
+                                break;
+                            continue;
+                        }
+                        stops += 1;
+                        if (step.obscured)
+                            hidden.push(`${step.obscured} is hidden under the ${step.covered}`);
+                    }
+                    if (stops >= plan.maxTabStops)
+                        note(testInfo, `${path}: stopped after ${plan.maxTabStops} Tab presses (about ${reachable} focusable elements); raise maxTabStops to walk the rest`);
+                    note(testInfo, `${path}: ${stops} focus stop(s) checked in ${browserName}`);
+                    expect(stops, `${path}: Tab reached no element`).toBeGreaterThan(0);
+                    expect(hidden).toEqual([]);
+                });
+            }
+        });
+    }
+}
+//# sourceMappingURL=access.js.map