@brandlab-digital/conformance 1.0.0-rc.15 → 1.0.0-rc.17

package/dist/analytics-contract.d.ts

@@ -0,0 +1,20 @@
+export declare const BRANDLAB_ANALYTICS_V3_RULESET_ID = "analytics-v3@1.0.0-rc.17";
+export interface BrandlabAnalyticsV3Issue {
+    ruleId: string;
+    surface: "analytics";
+    severity: "blocker" | "warning" | "info";
+    evidenceKind: "static";
+    path?: string;
+    line?: number;
+    expected: string;
+    actual: string;
+    remediation: string;
+}
+export interface BrandlabAnalyticsV3Inspection {
+    rulesetId: typeof BRANDLAB_ANALYTICS_V3_RULESET_ID;
+    websiteCallsDeclared: boolean;
+    leadDiagnosticsDeclared: boolean;
+    issues: BrandlabAnalyticsV3Issue[];
+}
+export declare function inspectBrandlabAnalyticsV3(root: string): BrandlabAnalyticsV3Inspection;
+//# sourceMappingURL=analytics-contract.d.ts.map

package/dist/analytics-contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics-contract.d.ts","sourceRoot":"","sources":["../src/analytics-contract.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,gCAAgC,6BACjB,CAAC;AAE7B,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,WAAW,CAAC;IACrB,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IACzC,YAAY,EAAE,QAAQ,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,6BAA6B;IAC5C,SAAS,EAAE,OAAO,gCAAgC,CAAC;IACnD,oBAAoB,EAAE,OAAO,CAAC;IAC9B,uBAAuB,EAAE,OAAO,CAAC;IACjC,MAAM,EAAE,wBAAwB,EAAE,CAAC;CACpC;AAaD,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,6BAA6B,CAkDtF"}

package/dist/analytics-contract.js

@@ -0,0 +1,211 @@
+import { existsSync, readFileSync, readdirSync } from "node:fs";
+import { extname, join, relative } from "node:path";
+import * as ts from "typescript";
+export const BRANDLAB_ANALYTICS_V3_RULESET_ID = "analytics-v3@1.0.0-rc.17";
+const SOURCE_EXTENSIONS = new Set([".js", ".jsx", ".mjs", ".ts", ".tsx"]);
+const SKIPPED_DIRECTORIES = new Set([
+    ".git",
+    ".next",
+    ".turbo",
+    "coverage",
+    "dist",
+    "generated",
+    "node_modules",
+]);
+export function inspectBrandlabAnalyticsV3(root) {
+    const sourceRoot = join(root, "src");
+    const files = existsSync(sourceRoot) ? walkSourceFiles(sourceRoot) : [];
+    const sources = files.map((path) => ({
+        path,
+        relativePath: relative(root, path).split(/[/\\]/).join("/"),
+        source: readFileSync(path, "utf8"),
+    }));
+    const issues = [];
+    const inspections = sources.map((entry) => inspectAnalyticsSource(entry, issues));
+    const websiteCallsDeclared = inspections.some((inspection) => inspection.websiteCallsDeclared);
+    const leadDiagnosticsDeclared = inspections.some((inspection) => inspection.leadDiagnosticsDeclared);
+    if (websiteCallsDeclared) {
+        const sharedGoogleTagRendered = inspections.some((inspection) => inspection.sharedGoogleTagRendered);
+        if (!sharedGoogleTagRendered) {
+            issues.push(analyticsIssue({
+                ruleId: "brandlab-analytics-website-call-renderer",
+                expected: "Projects declaring websiteCalls render BrandlabGoogleTag from @brandlab-digital/site-next/analytics/google-tag.",
+                actual: "The website-call contract is declared without the shared Google tag renderer.",
+                remediation: "Render BrandlabGoogleTag once from the root layout and pass the verified public business phone number.",
+            }));
+        }
+    }
+    if (leadDiagnosticsDeclared) {
+        const sharedDiagnosticsCalled = inspections.some((inspection) => inspection.sharedDiagnosticCalled);
+        if (!sharedDiagnosticsCalled) {
+            issues.push(analyticsIssue({
+                ruleId: "brandlab-analytics-lead-diagnostics-unused",
+                expected: "An enabled leadDiagnostics contract is consumed through at least one shared helper.",
+                actual: "leadDiagnostics is enabled but no shared diagnostic helper is imported.",
+                remediation: "Instrument the intended form or CTA through the shared helpers, or remove the unused opt-in.",
+            }));
+        }
+    }
+    return {
+        rulesetId: BRANDLAB_ANALYTICS_V3_RULESET_ID,
+        websiteCallsDeclared,
+        leadDiagnosticsDeclared,
+        issues: issues.sort((first, second) => first.ruleId.localeCompare(second.ruleId) ||
+            (first.path ?? "").localeCompare(second.path ?? "") ||
+            (first.line ?? 0) - (second.line ?? 0)),
+    };
+}
+function inspectAnalyticsSource(entry, issues) {
+    const sourceFile = ts.createSourceFile(entry.path, entry.source, ts.ScriptTarget.Latest, true, scriptKind(entry.path));
+    const googleTagBindings = new Set();
+    const diagnosticBindings = new Set();
+    const emittedRules = new Set();
+    let websiteCallsDeclared = false;
+    let leadDiagnosticsDeclared = false;
+    let sharedGoogleTagRendered = false;
+    let sharedDiagnosticCalled = false;
+    for (const statement of sourceFile.statements) {
+        if (!ts.isImportDeclaration(statement) || !ts.isStringLiteral(statement.moduleSpecifier))
+            continue;
+        const imports = statement.importClause?.namedBindings;
+        if (!imports || !ts.isNamedImports(imports))
+            continue;
+        for (const specifier of imports.elements) {
+            const importedName = specifier.propertyName?.text ?? specifier.name.text;
+            if (statement.moduleSpecifier.text === "@brandlab-digital/site-next/analytics/google-tag" &&
+                importedName === "BrandlabGoogleTag") {
+                googleTagBindings.add(specifier.name.text);
+            }
+            if (statement.moduleSpecifier.text === "@brandlab-digital/site-next/analytics" &&
+                ["trackLeadFormStart", "trackLeadFormError", "trackLeadCtaClick"].includes(importedName)) {
+                diagnosticBindings.add(specifier.name.text);
+            }
+        }
+    }
+    const emitIssue = (node, options) => {
+        if (emittedRules.has(options.ruleId))
+            return;
+        emittedRules.add(options.ruleId);
+        issues.push(analyticsIssue({
+            ...options,
+            path: entry.relativePath,
+            line: sourceFile.getLineAndCharacterOfPosition(node.getStart(sourceFile)).line + 1,
+            actual: `A local implementation appears in ${entry.relativePath}.`,
+        }));
+    };
+    const visit = (node) => {
+        if (ts.isPropertyAssignment(node)) {
+            const name = propertyName(node.name);
+            if (name === "websiteCalls" && ts.isObjectLiteralExpression(node.initializer)) {
+                websiteCallsDeclared = true;
+            }
+            if (name === "leadDiagnostics" &&
+                ts.isObjectLiteralExpression(node.initializer) &&
+                node.initializer.properties.some((property) => ts.isPropertyAssignment(property) &&
+                    propertyName(property.name) === "enabled" &&
+                    property.initializer.kind === ts.SyntaxKind.TrueKeyword)) {
+                leadDiagnosticsDeclared = true;
+            }
+            if (name === "phone_conversion_number") {
+                emitIssue(node, {
+                    ruleId: "brandlab-analytics-local-website-call-snippet",
+                    expected: "Website-call forwarding configuration is rendered by BrandlabGoogleTag.",
+                    remediation: "Remove the local phone snippet and use @brandlab-digital/site-next/analytics/google-tag.",
+                });
+            }
+        }
+        if ((ts.isJsxOpeningElement(node) || ts.isJsxSelfClosingElement(node)) &&
+            ts.isIdentifier(node.tagName) &&
+            googleTagBindings.has(node.tagName.text)) {
+            sharedGoogleTagRendered = true;
+        }
+        if (ts.isCallExpression(node)) {
+            if (ts.isIdentifier(node.expression) &&
+                diagnosticBindings.has(node.expression.text)) {
+                sharedDiagnosticCalled = true;
+            }
+            if (ts.isPropertyAccessExpression(node.expression) &&
+                node.expression.name.text === "createElement" &&
+                node.arguments[0] &&
+                ts.isIdentifier(node.arguments[0]) &&
+                googleTagBindings.has(node.arguments[0].text)) {
+                sharedGoogleTagRendered = true;
+            }
+            const eventName = gtagEventName(node);
+            if (["lead_form_start", "lead_form_error", "lead_cta_click"].includes(eventName ?? "")) {
+                emitIssue(node, {
+                    ruleId: "brandlab-analytics-local-lead-diagnostic",
+                    expected: "Lead diagnostics use the privacy-safe shared analytics helpers.",
+                    remediation: "Use trackLeadFormStart, trackLeadFormError or trackLeadCtaClick from @brandlab-digital/site-next/analytics.",
+                });
+            }
+            if (eventName === "conversion") {
+                emitIssue(node, {
+                    ruleId: "brandlab-analytics-local-ads-conversion",
+                    expected: "Direct form conversion transport stays inside the shared accepted-delivery runtime.",
+                    remediation: "Remove the local Google Ads conversion event and use trackDeliveredContact or trackDeliveredContactWithEnhancedConversions.",
+                });
+            }
+        }
+        ts.forEachChild(node, visit);
+    };
+    visit(sourceFile);
+    return {
+        websiteCallsDeclared,
+        leadDiagnosticsDeclared,
+        sharedGoogleTagRendered,
+        sharedDiagnosticCalled,
+    };
+}
+function propertyName(name) {
+    return ts.isIdentifier(name) || ts.isStringLiteral(name) || ts.isNumericLiteral(name)
+        ? name.text
+        : null;
+}
+function gtagEventName(node) {
+    const callee = node.expression;
+    const isGtag = (ts.isIdentifier(callee) && callee.text === "gtag") ||
+        (ts.isPropertyAccessExpression(callee) && callee.name.text === "gtag");
+    if (!isGtag || node.arguments.length < 2)
+        return null;
+    const command = node.arguments[0];
+    const event = node.arguments[1];
+    return command && ts.isStringLiteralLike(command) && command.text === "event" &&
+        event && ts.isStringLiteralLike(event)
+        ? event.text
+        : null;
+}
+function scriptKind(path) {
+    switch (extname(path)) {
+        case ".tsx": return ts.ScriptKind.TSX;
+        case ".jsx": return ts.ScriptKind.JSX;
+        case ".js":
+        case ".mjs": return ts.ScriptKind.JS;
+        default: return ts.ScriptKind.TS;
+    }
+}
+function analyticsIssue(options) {
+    return {
+        surface: "analytics",
+        severity: "blocker",
+        evidenceKind: "static",
+        ...options,
+    };
+}
+function walkSourceFiles(directory) {
+    const files = [];
+    for (const entry of readdirSync(directory, { withFileTypes: true })) {
+        if (entry.isSymbolicLink())
+            continue;
+        const path = join(directory, entry.name);
+        if (entry.isDirectory()) {
+            if (!SKIPPED_DIRECTORIES.has(entry.name))
+                files.push(...walkSourceFiles(path));
+            continue;
+        }
+        if (entry.isFile() && SOURCE_EXTENSIONS.has(extname(entry.name)))
+            files.push(path);
+    }
+    return files.sort();
+}
+//# sourceMappingURL=analytics-contract.js.map

package/dist/analytics-contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics-contract.js","sourceRoot":"","sources":["../src/analytics-contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjC,MAAM,CAAC,MAAM,gCAAgC,GAC3C,0BAA0B,CAAC;AAqB7B,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAC1E,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC;IAClC,MAAM;IACN,OAAO;IACP,QAAQ;IACR,UAAU;IACV,MAAM;IACN,WAAW;IACX,cAAc;CACf,CAAC,CAAC;AAEH,MAAM,UAAU,0BAA0B,CAAC,IAAY;IACrD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACnC,IAAI;QACJ,YAAY,EAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QAC3D,MAAM,EAAE,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC;KACnC,CAAC,CAAC,CAAC;IACJ,MAAM,MAAM,GAA+B,EAAE,CAAC;IAC9C,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,sBAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAClF,MAAM,oBAAoB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAC/F,MAAM,uBAAuB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;IAErG,IAAI,oBAAoB,EAAE,CAAC;QACzB,MAAM,uBAAuB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;QACrG,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;gBACzB,MAAM,EAAE,0CAA0C;gBAClD,QAAQ,EACN,iHAAiH;gBACnH,MAAM,EAAE,+EAA+E;gBACvF,WAAW,EACT,wGAAwG;aAC3G,CAAC,CAAC,CAAC;QACN,CAAC;IACH,CAAC;IAED,IAAI,uBAAuB,EAAE,CAAC;QAC5B,MAAM,uBAAuB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC;QACpG,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;gBACzB,MAAM,EAAE,4CAA4C;gBACpD,QAAQ,EAAE,qFAAqF;gBAC/F,MAAM,EAAE,yEAAyE;gBACjF,WAAW,EACT,8FAA8F;aACjG,CAAC,CAAC,CAAC;QACN,CAAC;IACH,CAAC;IAED,OAAO;QACL,SAAS,EAAE,gCAAgC;QAC3C,oBAAoB;QACpB,uBAAuB;QACvB,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CACpC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC;YACzC,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACnD,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,CACvC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAC7B,KAA6D,EAC7D,MAAkC;IAElC,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CACpC,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,MAAM,EACZ,EAAE,CAAC,YAAY,CAAC,MAAM,EACtB,IAAI,EACJ,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CACvB,CAAC;IACF,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC5C,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC7C,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;IACvC,IAAI,oBAAoB,GAAG,KAAK,CAAC;IACjC,IAAI,uBAAuB,GAAG,KAAK,CAAC;IACpC,IAAI,uBAAuB,GAAG,KAAK,CAAC;IACpC,IAAI,sBAAsB,GAAG,KAAK,CAAC;IAEnC,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;QAC9C,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,eAAe,CAAC;YAAE,SAAS;QACnG,MAAM,OAAO,GAAG,SAAS,CAAC,YAAY,EAAE,aAAa,CAAC;QACtD,IAAI,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC;YAAE,SAAS;QACtD,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACzC,MAAM,YAAY,GAAG,SAAS,CAAC,YAAY,EAAE,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;YACzE,IACE,SAAS,CAAC,eAAe,CAAC,IAAI,KAAK,kDAAkD;gBACrF,YAAY,KAAK,mBAAmB,EACpC,CAAC;gBACD,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7C,CAAC;YACD,IACE,SAAS,CAAC,eAAe,CAAC,IAAI,KAAK,uCAAuC;gBAC1E,CAAC,oBAAoB,EAAE,oBAAoB,EAAE,mBAAmB,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,EACxF,CAAC;gBACD,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAG,CAChB,IAAa,EACb,OAA8E,EAC9E,EAAE;QACF,IAAI,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,OAAO;QAC7C,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;YACzB,GAAG,OAAO;YACV,IAAI,EAAE,KAAK,CAAC,YAAY;YACxB,IAAI,EAAE,UAAU,CAAC,6BAA6B,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC;YAClF,MAAM,EAAE,qCAAqC,KAAK,CAAC,YAAY,GAAG;SACnE,CAAC,CAAC,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,EAAE;QAC9B,IAAI,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrC,IAAI,IAAI,KAAK,cAAc,IAAI,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC9E,oBAAoB,GAAG,IAAI,CAAC;YAC9B,CAAC;YACD,IACE,IAAI,KAAK,iBAAiB;gBAC1B,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,WAAW,CAAC;gBAC9C,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC5C,EAAE,CAAC,oBAAoB,CAAC,QAAQ,CAAC;oBACjC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,SAAS;oBACzC,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW,CACxD,EACD,CAAC;gBACD,uBAAuB,GAAG,IAAI,CAAC;YACjC,CAAC;YACD,IAAI,IAAI,KAAK,yBAAyB,EAAE,CAAC;gBACvC,SAAS,CAAC,IAAI,EAAE;oBACd,MAAM,EAAE,+CAA+C;oBACvD,QAAQ,EAAE,yEAAyE;oBACnF,WAAW,EACT,0FAA0F;iBAC7F,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,IACE,CAAC,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;YAClE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC;YAC7B,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EACxC,CAAC;YACD,uBAAuB,GAAG,IAAI,CAAC;QACjC,CAAC;QAED,IAAI,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,IACE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC;gBAChC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAC5C,CAAC;gBACD,sBAAsB,GAAG,IAAI,CAAC;YAChC,CAAC;YACD,IACE,EAAE,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC;gBAC9C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,eAAe;gBAC7C,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;gBACjB,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAClC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAC7C,CAAC;gBACD,uBAAuB,GAAG,IAAI,CAAC;YACjC,CAAC;YAED,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;YACtC,IAAI,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC;gBACvF,SAAS,CAAC,IAAI,EAAE;oBACd,MAAM,EAAE,0CAA0C;oBAClD,QAAQ,EAAE,iEAAiE;oBAC3E,WAAW,EACT,6GAA6G;iBAChH,CAAC,CAAC;YACL,CAAC;YACD,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;gBAC/B,SAAS,CAAC,IAAI,EAAE;oBACd,MAAM,EAAE,yCAAyC;oBACjD,QAAQ,EAAE,qFAAqF;oBAC/F,WAAW,EACT,6HAA6H;iBAChI,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC,CAAC;IACF,KAAK,CAAC,UAAU,CAAC,CAAC;IAElB,OAAO;QACL,oBAAoB;QACpB,uBAAuB;QACvB,uBAAuB;QACvB,sBAAsB;KACvB,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAqB;IACzC,OAAO,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC;QACnF,CAAC,CAAC,IAAI,CAAC,IAAI;QACX,CAAC,CAAC,IAAI,CAAC;AACX,CAAC;AAED,SAAS,aAAa,CAAC,IAAuB;IAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;IAC/B,MAAM,MAAM,GACV,CAAC,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC;QACnD,CAAC,EAAE,CAAC,0BAA0B,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;IACzE,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACtD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAChC,OAAO,OAAO,IAAI,EAAE,CAAC,mBAAmB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO;QAC3E,KAAK,IAAI,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC;QACtC,CAAC,CAAC,KAAK,CAAC,IAAI;QACZ,CAAC,CAAC,IAAI,CAAC;AACX,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,QAAQ,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,KAAK,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC;QACtC,KAAK,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC;QACtC,KAAK,KAAK,CAAC;QACX,KAAK,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;QACrC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC;IACnC,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CACrB,OAAgF;IAEhF,OAAO;QACL,OAAO,EAAE,WAAW;QACpB,QAAQ,EAAE,SAAS;QACnB,YAAY,EAAE,QAAQ;QACtB,GAAG,OAAO;KACX,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,SAAiB;IACxC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QACpE,IAAI,KAAK,CAAC,cAAc,EAAE;YAAE,SAAS;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YAC/E,SAAS;QACX,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrF,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;AACtB,CAAC"}

package/dist/project-documentation.d.ts

@@ -0,0 +1,28 @@
+export declare const BRANDLAB_PROJECT_DOCUMENTATION_RULESET_ID = "architecture-v5-project-documentation@1.0.0-rc.17";
+export interface BrandlabProjectDocumentationIssue {
+    ruleId: string;
+    surface: "documentation" | "security";
+    severity: "blocker" | "warning" | "info";
+    evidenceKind: "static";
+    path?: string;
+    line?: number;
+    expected: string;
+    actual: string;
+    remediation: string;
+}
+export interface BrandlabProjectDocumentationReport {
+    rulesetId: typeof BRANDLAB_PROJECT_DOCUMENTATION_RULESET_ID;
+    files: Readonly<Record<string, {
+        bytes: number;
+        lines: number;
+    } | null>>;
+    issues: BrandlabProjectDocumentationIssue[];
+}
+export interface InspectBrandlabProjectDocumentationOptions {
+    /** Portfolio and OS adapters may require this when design work is in scope. */
+    requireDesign?: boolean;
+    /** Portfolio and OS adapters may require this for managed SEO, Ads or content work. */
+    requireStrategy?: boolean;
+}
+export declare function inspectBrandlabProjectDocumentation(root: string, options?: InspectBrandlabProjectDocumentationOptions): BrandlabProjectDocumentationReport;
+//# sourceMappingURL=project-documentation.d.ts.map

package/dist/project-documentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-documentation.d.ts","sourceRoot":"","sources":["../src/project-documentation.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,yCAAyC,sDACD,CAAC;AAEtD,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,eAAe,GAAG,UAAU,CAAC;IACtC,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;IACzC,YAAY,EAAE,QAAQ,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD,SAAS,EAAE,OAAO,yCAAyC,CAAC;IAC5D,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC,CAAC,CAAC;IACzE,MAAM,EAAE,iCAAiC,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,0CAA0C;IACzD,+EAA+E;IAC/E,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,uFAAuF;IACvF,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AA6DD,wBAAgB,mCAAmC,CACjD,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,0CAA+C,GACvD,kCAAkC,CA+IpC"}