open-local-audit 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to Open Local Audit will be documented here.
+
+## v0.1.0 - 2026-05-08
+
+- Project documentation and release planning created.
+- Initial TypeScript CLI scaffold added.
+- JSON and Markdown report generation added.
+- Initial audit rule set and Vitest coverage added.
+- Example report artifacts added.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TORUT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,96 @@
+# Open Local Audit
+
+Open Local Audit is an open-source website and local presence auditor for small businesses. It turns public website signals into practical reports for outreach, customer education, and implementation work.
+
+## Current stage
+
+Initial CLI implementation and release preparation. The project can run a single URL audit and produce JSON or Markdown output, but it is not published to npm yet.
+
+## Business purpose
+
+Open Local Audit produces evidence-backed mini audits for local businesses. The tool should be useful as open-source software while keeping paid value in implementation, redesign, maintenance, and custom reporting.
+
+## Product principles
+
+- Evidence first: every recommendation should point to a concrete finding.
+- Ethical scanning: only scan user-provided public URLs and avoid Google Maps scraping.
+- Small-business language: reports should be readable by non-technical owners.
+- Developer quality: deterministic checks, clear CLI output, tests, and release notes.
+- Commercial clarity: the open-source scanner is useful; paid work is execution and support.
+
+## Proposed first stack
+
+- Runtime: Node.js with TypeScript.
+- CLI framework: `commander` or `cac`.
+- Validation: `zod`.
+- HTML parsing: `cheerio`.
+- Browser rendering: Playwright where static parsing is not enough.
+- Storage: no persistence by default; optional JSON/Markdown outputs.
+- Test runner: Vitest.
+- Package manager: npm unless implementation chooses pnpm before first commit.
+
+## Documents
+
+- [Product brief](./docs/product-brief.md)
+- [Technical architecture](./docs/technical-architecture.md)
+- [MVP roadmap](./docs/mvp-roadmap.md)
+- [Security and ethics](./docs/security-and-ethics.md)
+- [Go-to-market plan](./docs/go-to-market.md)
+- [Audit checklist](./docs/research/audit-checklist.md)
+- [Release readiness](./docs/release/release-readiness.md)
+- [npm publishing plan](./docs/release/npm-publishing.md)
+- [Project operating standard](./docs/operations/project-standard.md)
+- [Decision log](./docs/operations/decision-log.md)
+
+## Local development
+
+Install dependencies and run the checks:
+
+```bash
+npm install
+npm test
+npm run lint
+npm run build
+```
+
+Run the CLI locally:
+
+```bash
+npm start -- https://example.com --format markdown
+```
+
+After building, run the compiled CLI:
+
+```bash
+node dist/cli.js https://example.com --format json --pretty
+```
+
+## First implementation milestone
+
+The first implementation milestone is a CLI that accepts one URL and outputs:
+
+- JSON report.
+- Markdown report.
+- Score summary.
+- Evidence table.
+- Clear owner-readable recommendations.
+
+Example target command:
+
+```bash
+open-local-audit https://example.com --format markdown --out report.md
+```
+
+Example report artifacts are available under [`examples/reports`](./examples/reports).
+
+## GitHub and npm release intent
+
+The project should be prepared for:
+
+- Public GitHub repository.
+- Clear README and examples.
+- MIT license, unless maintainers choose a different license before the first public release.
+- GitHub Actions for lint, tests, build, and release checks.
+- npm package after the CLI has real tests and example reports.
+
+No npm package should be published until the release checklist in `docs/release/release-readiness.md` is complete.

package/dist/audit.d.ts

@@ -0,0 +1,3 @@
+import type { AuditOptions, AuditReport, PageSnapshot } from "./types.js";
+export declare function auditSnapshot(snapshot: PageSnapshot, scannedAt?: string): AuditReport;
+export declare function auditUrl(url: string, options?: Partial<AuditOptions>): Promise<AuditReport>;

package/dist/audit.js

@@ -0,0 +1,126 @@
+import { runRules } from "./rules.js";
+const defaultOptions = {
+    timeoutMs: 10000,
+    maxRedirects: 5
+};
+const categories = [
+    "technical-health",
+    "search-basics",
+    "mobile-usability",
+    "trust-contact"
+];
+function normalizeHeaders(headers) {
+    const output = {};
+    headers.forEach((value, key) => {
+        output[key] = value;
+    });
+    return output;
+}
+async function fetchWithRedirects(url, options) {
+    let currentUrl = url;
+    for (let redirectCount = 0; redirectCount <= options.maxRedirects; redirectCount += 1) {
+        const controller = new AbortController();
+        const timeout = setTimeout(() => controller.abort(), options.timeoutMs);
+        try {
+            const response = await fetch(currentUrl, {
+                redirect: "manual",
+                signal: controller.signal,
+                headers: {
+                    "user-agent": "open-local-audit/0.1 (+https://github.com/Esquetta/open-local-audit)"
+                }
+            });
+            const location = response.headers.get("location");
+            if (location && response.status >= 300 && response.status < 400) {
+                currentUrl = new URL(location, currentUrl).toString();
+                continue;
+            }
+            return {
+                url,
+                finalUrl: response.url || currentUrl,
+                statusCode: response.status,
+                headers: normalizeHeaders(response.headers),
+                html: await response.text()
+            };
+        }
+        finally {
+            clearTimeout(timeout);
+        }
+    }
+    throw new Error(`Exceeded redirect limit of ${options.maxRedirects}`);
+}
+function summarize(reportFindings) {
+    return {
+        totalFindings: reportFindings.length,
+        high: reportFindings.filter((finding) => finding.severity === "high").length,
+        medium: reportFindings.filter((finding) => finding.severity === "medium").length,
+        low: reportFindings.filter((finding) => finding.severity === "low").length,
+        info: reportFindings.filter((finding) => finding.severity === "info").length
+    };
+}
+function scoreCategories(reportFindings) {
+    const labels = {
+        "technical-health": "Technical health",
+        "search-basics": "Search basics",
+        "mobile-usability": "Mobile and usability",
+        "trust-contact": "Trust and contact readiness"
+    };
+    return Object.fromEntries(categories.map((category) => {
+        const findings = reportFindings.filter((finding) => finding.category === category);
+        const penalty = findings.reduce((total, finding) => {
+            if (finding.severity === "high") {
+                return total + 25;
+            }
+            if (finding.severity === "medium") {
+                return total + 15;
+            }
+            if (finding.severity === "low") {
+                return total + 8;
+            }
+            return total + 3;
+        }, 0);
+        return [
+            category,
+            {
+                label: labels[category],
+                max: 100,
+                score: Math.max(0, 100 - penalty)
+            }
+        ];
+    }));
+}
+export function auditSnapshot(snapshot, scannedAt = new Date().toISOString()) {
+    const findings = runRules(snapshot);
+    const recommendations = findings.map((finding) => finding.recommendation);
+    return {
+        url: snapshot.url,
+        finalUrl: snapshot.finalUrl,
+        scannedAt,
+        statusCode: snapshot.statusCode,
+        summary: summarize(findings),
+        scores: scoreCategories(findings),
+        findings,
+        recommendations: Array.from(new Set(recommendations)),
+        evidence: [
+            {
+                label: "Status code",
+                value: `${snapshot.statusCode}`
+            },
+            {
+                label: "Final URL",
+                value: snapshot.finalUrl
+            },
+            {
+                label: "Content type",
+                value: snapshot.headers["content-type"] ?? "Unknown"
+            }
+        ]
+    };
+}
+export async function auditUrl(url, options = {}) {
+    const snapshot = await fetchWithRedirects(url, {
+        ...defaultOptions,
+        ...options
+    });
+    return auditSnapshot(snapshot);
+}
+//# sourceMappingURL=audit.js.map

package/dist/audit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit.js","sourceRoot":"","sources":["../src/audit.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,cAAc,GAAiB;IACnC,SAAS,EAAE,KAAK;IAChB,YAAY,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,UAAU,GAAsB;IACpC,kBAAkB;IAClB,eAAe;IACf,kBAAkB;IAClB,eAAe;CAChB,CAAC;AAEF,SAAS,gBAAgB,CAAC,OAAgB;IACxC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,kBAAkB,CAAC,GAAW,EAAE,OAAqB;IAClE,IAAI,UAAU,GAAG,GAAG,CAAC;IAErB,KAAK,IAAI,aAAa,GAAG,CAAC,EAAE,aAAa,IAAI,OAAO,CAAC,YAAY,EAAE,aAAa,IAAI,CAAC,EAAE,CAAC;QACtF,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAExE,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,UAAU,EAAE;gBACvC,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,OAAO,EAAE;oBACP,YAAY,EAAE,sEAAsE;iBACrF;aACF,CAAC,CAAC;YAEH,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAClD,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBAChE,UAAU,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACtD,SAAS;YACX,CAAC;YAED,OAAO;gBACL,GAAG;gBACH,QAAQ,EAAE,QAAQ,CAAC,GAAG,IAAI,UAAU;gBACpC,UAAU,EAAE,QAAQ,CAAC,MAAM;gBAC3B,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAC3C,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE;aAC5B,CAAC;QACJ,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,8BAA8B,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;AACxE,CAAC;AAED,SAAS,SAAS,CAAC,cAA2C;IAC5D,OAAO;QACL,aAAa,EAAE,cAAc,CAAC,MAAM;QACpC,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,MAAM;QAC5E,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,MAAM;QAChF,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC,MAAM;QAC1E,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,MAAM;KAC7E,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,cAA2C;IAClE,MAAM,MAAM,GAAoC;QAC9C,kBAAkB,EAAE,kBAAkB;QACtC,eAAe,EAAE,eAAe;QAChC,kBAAkB,EAAE,sBAAsB;QAC1C,eAAe,EAAE,6BAA6B;KAC/C,CAAC;IAEF,OAAO,MAAM,CAAC,WAAW,CACvB,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC1B,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;QACnF,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjD,IAAI,OAAO,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;gBAChC,OAAO,KAAK,GAAG,EAAE,CAAC;YACpB,CAAC;YACD,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,KAAK,GAAG,EAAE,CAAC;YACpB,CAAC;YACD,IAAI,OAAO,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;gBAC/B,OAAO,KAAK,GAAG,CAAC,CAAC;YACnB,CAAC;YACD,OAAO,KAAK,GAAG,CAAC,CAAC;QACnB,CAAC,EAAE,CAAC,CAAC,CAAC;QAEN,OAAO;YACL,QAAQ;YACR;gBACE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC;gBACvB,GAAG,EAAE,GAAG;gBACR,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC;aAClC;SACF,CAAC;IACJ,CAAC,CAAC,CAC+B,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAsB,EAAE,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;IACxF,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACpC,MAAM,eAAe,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAE1E,OAAO;QACL,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,SAAS;QACT,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,OAAO,EAAE,SAAS,CAAC,QAAQ,CAAC;QAC5B,MAAM,EAAE,eAAe,CAAC,QAAQ,CAAC;QACjC,QAAQ;QACR,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,eAAe,CAAC,CAAC;QACrD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,aAAa;gBACpB,KAAK,EAAE,GAAG,QAAQ,CAAC,UAAU,EAAE;aAChC;YACD;gBACE,KAAK,EAAE,WAAW;gBAClB,KAAK,EAAE,QAAQ,CAAC,QAAQ;aACzB;YACD;gBACE,KAAK,EAAE,cAAc;gBACrB,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,SAAS;aACrD;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,GAAW,EAAE,UAAiC,EAAE;IAC7E,MAAM,QAAQ,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE;QAC7C,GAAG,cAAc;QACjB,GAAG,OAAO;KACX,CAAC,CAAC;IAEH,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC"}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,40 @@
+#!/usr/bin/env node
+import { writeFile } from "node:fs/promises";
+import { Command } from "commander";
+import { auditUrl } from "./audit.js";
+import { renderJsonReport, renderMarkdownReport } from "./reporters.js";
+import { cliOptionsSchema, inputUrlSchema } from "./schema.js";
+const program = new Command();
+program
+    .name("open-local-audit")
+    .description("Audit a public local-business website and generate an evidence-backed report.")
+    .argument("<url>", "HTTP or HTTPS URL to audit")
+    .option("-f, --format <format>", "output format: json or markdown", "markdown")
+    .option("-o, --out <path>", "write report to a file instead of stdout")
+    .option("--timeout <ms>", "request timeout in milliseconds", "10000")
+    .option("--max-redirects <count>", "maximum redirects to follow", "5")
+    .option("--pretty", "pretty-print JSON output", false)
+    .action(async (rawUrl, rawOptions) => {
+    try {
+        const url = inputUrlSchema.parse(rawUrl);
+        const options = cliOptionsSchema.parse(rawOptions);
+        const report = await auditUrl(url, {
+            timeoutMs: options.timeout,
+            maxRedirects: options.maxRedirects
+        });
+        const output = options.format === "json" ? renderJsonReport(report, options.pretty) : renderMarkdownReport(report);
+        if (options.out) {
+            await writeFile(options.out, output, "utf8");
+        }
+        else {
+            process.stdout.write(output);
+        }
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : "Unknown error";
+        process.stderr.write(`open-local-audit: ${message}\n`);
+        process.exitCode = 1;
+    }
+});
+program.parseAsync();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE/D,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,kBAAkB,CAAC;KACxB,WAAW,CAAC,+EAA+E,CAAC;KAC5F,QAAQ,CAAC,OAAO,EAAE,4BAA4B,CAAC;KAC/C,MAAM,CAAC,uBAAuB,EAAE,iCAAiC,EAAE,UAAU,CAAC;KAC9E,MAAM,CAAC,kBAAkB,EAAE,0CAA0C,CAAC;KACtE,MAAM,CAAC,gBAAgB,EAAE,iCAAiC,EAAE,OAAO,CAAC;KACpE,MAAM,CAAC,yBAAyB,EAAE,6BAA6B,EAAE,GAAG,CAAC;KACrE,MAAM,CAAC,UAAU,EAAE,0BAA0B,EAAE,KAAK,CAAC;KACrD,MAAM,CAAC,KAAK,EAAE,MAAc,EAAE,UAAmB,EAAE,EAAE;IACpD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACzC,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,GAAG,EAAE;YACjC,SAAS,EAAE,OAAO,CAAC,OAAO;YAC1B,YAAY,EAAE,OAAO,CAAC,YAAY;SACnC,CAAC,CAAC;QAEH,MAAM,MAAM,GACV,OAAO,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAEtG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YAChB,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;QACzE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,OAAO,IAAI,CAAC,CAAC;QACvD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,UAAU,EAAE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { auditUrl, auditSnapshot } from "./audit.js";
+export { renderJsonReport, renderMarkdownReport } from "./reporters.js";
+export type { AuditOptions, AuditReport, AuditSummary, Evidence, Finding, FindingCategory, PageSnapshot, Score, Severity } from "./types.js";

package/dist/index.js

@@ -0,0 +1,3 @@
+export { auditUrl, auditSnapshot } from "./audit.js";
+export { renderJsonReport, renderMarkdownReport } from "./reporters.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/reporters.d.ts

@@ -0,0 +1,3 @@
+import type { AuditReport } from "./types.js";
+export declare function renderJsonReport(report: AuditReport, pretty?: boolean): string;
+export declare function renderMarkdownReport(report: AuditReport): string;

package/dist/reporters.js

@@ -0,0 +1,58 @@
+function escapeCell(value) {
+    return value.replace(/\|/g, "\\|").replace(/\r?\n/g, " ");
+}
+function severityRank(finding) {
+    const ranks = {
+        high: 0,
+        medium: 1,
+        low: 2,
+        info: 3
+    };
+    return ranks[finding.severity];
+}
+export function renderJsonReport(report, pretty = true) {
+    return `${JSON.stringify(report, null, pretty ? 2 : 0)}\n`;
+}
+export function renderMarkdownReport(report) {
+    const findings = [...report.findings].sort((left, right) => severityRank(left) - severityRank(right));
+    const lines = [
+        `# Open Local Audit Report`,
+        "",
+        `- URL: ${report.url}`,
+        `- Final URL: ${report.finalUrl}`,
+        `- Scanned at: ${report.scannedAt}`,
+        `- Status code: ${report.statusCode}`,
+        "",
+        "## Score Summary",
+        "",
+        "| Category | Score |",
+        "| --- | ---: |",
+        ...Object.values(report.scores).map((score) => `| ${escapeCell(score.label)} | ${score.score}/${score.max} |`),
+        "",
+        "## Findings",
+        ""
+    ];
+    if (findings.length === 0) {
+        lines.push("No findings were detected by the current rule set.", "");
+    }
+    else {
+        lines.push("| Severity | Finding | Evidence | Recommendation |", "| --- | --- | --- | --- |");
+        for (const finding of findings) {
+            const evidence = finding.evidence.map((item) => `${item.label}: ${item.value}`).join("; ");
+            lines.push(`| ${finding.severity} | ${escapeCell(finding.title)} | ${escapeCell(evidence)} | ${escapeCell(finding.recommendation)} |`);
+        }
+        lines.push("");
+    }
+    lines.push("## Recommendations", "");
+    if (report.recommendations.length === 0) {
+        lines.push("- Keep monitoring the page as content and templates change.");
+    }
+    else {
+        for (const recommendation of report.recommendations) {
+            lines.push(`- ${recommendation}`);
+        }
+    }
+    lines.push("");
+    return `${lines.join("\n")}\n`;
+}
+//# sourceMappingURL=reporters.js.map

package/dist/reporters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporters.js","sourceRoot":"","sources":["../src/reporters.ts"],"names":[],"mappings":"AAEA,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,YAAY,CAAC,OAAgB;IACpC,MAAM,KAAK,GAAG;QACZ,IAAI,EAAE,CAAC;QACP,MAAM,EAAE,CAAC;QACT,GAAG,EAAE,CAAC;QACN,IAAI,EAAE,CAAC;KACR,CAAC;IAEF,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAmB,EAAE,MAAM,GAAG,IAAI;IACjE,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAAmB;IACtD,MAAM,QAAQ,GAAG,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IACtG,MAAM,KAAK,GAAa;QACtB,2BAA2B;QAC3B,EAAE;QACF,UAAU,MAAM,CAAC,GAAG,EAAE;QACtB,gBAAgB,MAAM,CAAC,QAAQ,EAAE;QACjC,iBAAiB,MAAM,CAAC,SAAS,EAAE;QACnC,kBAAkB,MAAM,CAAC,UAAU,EAAE;QACrC,EAAE;QACF,kBAAkB;QAClB,EAAE;QACF,sBAAsB;QACtB,gBAAgB;QAChB,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC;QAC9G,EAAE;QACF,aAAa;QACb,EAAE;KACH,CAAC;IAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,oDAAoD,EAAE,EAAE,CAAC,CAAC;IACvE,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,oDAAoD,EAAE,2BAA2B,CAAC,CAAC;QAC9F,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3F,KAAK,CAAC,IAAI,CACR,KAAK,OAAO,CAAC,QAAQ,MAAM,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,UAAU,CAAC,QAAQ,CAAC,MAAM,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAC3H,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;IACrC,IAAI,MAAM,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxC,KAAK,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;IAC5E,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,cAAc,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;YACpD,KAAK,CAAC,IAAI,CAAC,KAAK,cAAc,EAAE,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC"}

package/dist/rules.d.ts

@@ -0,0 +1,3 @@
+import type { Finding, PageSnapshot } from "./types.js";
+export declare function runRules(snapshot: PageSnapshot): Finding[];
+export declare const ruleCount: number;

package/dist/rules.js

@@ -0,0 +1,199 @@
+import { load } from "cheerio";
+function finding(rule, context) {
+    return {
+        id: rule.id,
+        title: rule.title,
+        severity: rule.severity,
+        category: rule.category,
+        source: rule.source,
+        recommendation: rule.recommendation,
+        evidence: [
+            {
+                label: rule.source,
+                value: rule.evidence(context)
+            }
+        ]
+    };
+}
+function hasLink($, matcher) {
+    return $("a")
+        .toArray()
+        .some((element) => matcher($(element).attr("href") ?? ""));
+}
+function hasJsonLdType($, matcher) {
+    return $('script[type="application/ld+json"]')
+        .toArray()
+        .some((element) => {
+        const raw = $(element).text();
+        try {
+            const parsed = JSON.parse(raw);
+            const nodes = Array.isArray(parsed) ? parsed : [parsed];
+            return nodes.some((node) => {
+                if (!node || typeof node !== "object") {
+                    return false;
+                }
+                const typeValue = node["@type"];
+                const types = Array.isArray(typeValue) ? typeValue : [typeValue];
+                return types.some((type) => typeof type === "string" && matcher(type));
+            });
+        }
+        catch {
+            return false;
+        }
+    });
+}
+const rules = [
+    {
+        id: "http-status-ok",
+        title: "Page does not return a successful HTTP status",
+        category: "technical-health",
+        severity: "high",
+        source: "HTTP status",
+        recommendation: "Return a 2xx status for the audited page before investing in content or SEO work.",
+        check: ({ snapshot }) => snapshot.statusCode >= 200 && snapshot.statusCode < 300,
+        evidence: ({ snapshot }) => `${snapshot.statusCode}`
+    },
+    {
+        id: "https-enabled",
+        title: "Final URL is not HTTPS",
+        category: "technical-health",
+        severity: "high",
+        source: "Final URL",
+        recommendation: "Serve the public site over HTTPS and redirect plain HTTP traffic to the secure URL.",
+        check: ({ snapshot }) => snapshot.finalUrl.startsWith("https://"),
+        evidence: ({ snapshot }) => snapshot.finalUrl
+    },
+    {
+        id: "title-present",
+        title: "Page title is missing",
+        category: "search-basics",
+        severity: "medium",
+        source: "HTML title",
+        recommendation: "Add a clear title that includes the business name, service, and location where useful.",
+        check: ({ $ }) => $("title").first().text().trim().length > 0,
+        evidence: ({ $ }) => $("title").first().text().trim() || "Missing"
+    },
+    {
+        id: "meta-description-present",
+        title: "Meta description is missing",
+        category: "search-basics",
+        severity: "medium",
+        source: "Meta description",
+        recommendation: "Add a short owner-readable meta description that explains the service and location.",
+        check: ({ $ }) => $('meta[name="description"]').attr("content")?.trim().length ? true : false,
+        evidence: ({ $ }) => $('meta[name="description"]').attr("content")?.trim() || "Missing"
+    },
+    {
+        id: "viewport-present",
+        title: "Viewport tag is missing",
+        category: "mobile-usability",
+        severity: "high",
+        source: "Viewport meta tag",
+        recommendation: "Add a responsive viewport tag so mobile browsers render the page correctly.",
+        check: ({ $ }) => $('meta[name="viewport"]').attr("content")?.trim().length ? true : false,
+        evidence: ({ $ }) => $('meta[name="viewport"]').attr("content")?.trim() || "Missing"
+    },
+    {
+        id: "single-h1",
+        title: "Page should have one clear H1",
+        category: "search-basics",
+        severity: "medium",
+        source: "H1 count",
+        recommendation: "Use one visible H1 that clearly names the core service or business.",
+        check: ({ $ }) => $("h1").length === 1 && $("h1").first().text().trim().length > 0,
+        evidence: ({ $ }) => `${$("h1").length} H1 elements`
+    },
+    {
+        id: "canonical-present",
+        title: "Canonical URL is missing",
+        category: "search-basics",
+        severity: "low",
+        source: "Canonical link",
+        recommendation: "Add a canonical link to reduce duplicate URL confusion.",
+        check: ({ $ }) => $('link[rel="canonical"]').attr("href")?.trim().length ? true : false,
+        evidence: ({ $ }) => $('link[rel="canonical"]').attr("href")?.trim() || "Missing"
+    },
+    {
+        id: "phone-link-present",
+        title: "Phone action is missing",
+        category: "trust-contact",
+        severity: "high",
+        source: "Contact links",
+        recommendation: "Add a tappable phone link using the tel: format.",
+        check: ({ $ }) => hasLink($, (href) => href.toLowerCase().startsWith("tel:")),
+        evidence: () => "No tel: link found"
+    },
+    {
+        id: "email-link-present",
+        title: "Email action is missing",
+        category: "trust-contact",
+        severity: "low",
+        source: "Contact links",
+        recommendation: "Add an email link if email is an expected contact path for the business.",
+        check: ({ $ }) => hasLink($, (href) => href.toLowerCase().startsWith("mailto:")),
+        evidence: () => "No mailto: link found"
+    },
+    {
+        id: "whatsapp-link-present",
+        title: "WhatsApp action is missing",
+        category: "trust-contact",
+        severity: "low",
+        source: "Contact links",
+        recommendation: "Add a WhatsApp action if customers commonly use WhatsApp for bookings or questions.",
+        check: ({ $ }) => hasLink($, (href) => /wa\.me|whatsapp/i.test(href)),
+        evidence: () => "No WhatsApp link found"
+    },
+    {
+        id: "localbusiness-schema-present",
+        title: "LocalBusiness structured data is missing",
+        category: "search-basics",
+        severity: "medium",
+        source: "JSON-LD",
+        recommendation: "Add LocalBusiness schema when the page represents a local business location.",
+        check: ({ $ }) => hasJsonLdType($, (type) => type.endsWith("LocalBusiness") || type === "LocalBusiness"),
+        evidence: () => "No LocalBusiness JSON-LD type found"
+    },
+    {
+        id: "map-link-present",
+        title: "Map or directions link is missing",
+        category: "trust-contact",
+        severity: "medium",
+        source: "Links",
+        recommendation: "Add a map or directions link so visitors can confirm the business location quickly.",
+        check: ({ $ }) => hasLink($, (href) => /google\.com\/maps|maps\.app\.goo\.gl|bing\.com\/maps|directions/i.test(href)),
+        evidence: () => "No map or directions link found"
+    },
+    {
+        id: "image-alt-coverage",
+        title: "Some images are missing alt text",
+        category: "mobile-usability",
+        severity: "low",
+        source: "Image alt text",
+        recommendation: "Add useful alt text to meaningful images and leave decorative images empty intentionally.",
+        check: ({ $ }) => {
+            const images = $("img").toArray();
+            if (images.length === 0) {
+                return true;
+            }
+            return images.every((element) => $(element).attr("alt") !== undefined);
+        },
+        evidence: ({ $ }) => {
+            const images = $("img").length;
+            const missing = $("img")
+                .toArray()
+                .filter((element) => $(element).attr("alt") === undefined).length;
+            return `${missing} of ${images} images missing alt attributes`;
+        }
+    }
+];
+export function runRules(snapshot) {
+    const $ = load(snapshot.html);
+    const context = {
+        $,
+        snapshot,
+        text: $("body").text().replace(/\s+/g, " ").trim()
+    };
+    return rules.filter((rule) => !rule.check(context)).map((rule) => finding(rule, context));
+}
+export const ruleCount = rules.length;
+//# sourceMappingURL=rules.js.map

package/dist/rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../src/rules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAmB,MAAM,SAAS,CAAC;AAoBhD,SAAS,OAAO,CAAC,IAAU,EAAE,OAAoB;IAC/C,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,cAAc,EAAE,IAAI,CAAC,cAAc;QACnC,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,IAAI,CAAC,MAAM;gBAClB,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;aAC9B;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,CAAa,EAAE,OAAkC;IAChE,OAAO,CAAC,CAAC,GAAG,CAAC;SACV,OAAO,EAAE;SACT,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,aAAa,CAAC,CAAa,EAAE,OAAkC;IACtE,OAAO,CAAC,CAAC,oCAAoC,CAAC;SAC3C,OAAO,EAAE;SACT,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;QAChB,MAAM,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAY,CAAC;YAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YAExD,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACzB,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACtC,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,MAAM,SAAS,GAAI,IAA8B,CAAC,OAAO,CAAC,CAAC;gBAC3D,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;gBACjE,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;YACzE,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,KAAK,GAAW;IACpB;QACE,EAAE,EAAE,gBAAgB;QACpB,KAAK,EAAE,+CAA+C;QACtD,QAAQ,EAAE,kBAAkB;QAC5B,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,aAAa;QACrB,cAAc,EAAE,mFAAmF;QACnG,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,IAAI,GAAG,IAAI,QAAQ,CAAC,UAAU,GAAG,GAAG;QAChF,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,UAAU,EAAE;KACrD;IACD;QACE,EAAE,EAAE,eAAe;QACnB,KAAK,EAAE,wBAAwB;QAC/B,QAAQ,EAAE,kBAAkB;QAC5B,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,WAAW;QACnB,cAAc,EAAE,qFAAqF;QACrG,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC;QACjE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ;KAC9C;IACD;QACE,EAAE,EAAE,eAAe;QACnB,KAAK,EAAE,uBAAuB;QAC9B,QAAQ,EAAE,eAAe;QACzB,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,YAAY;QACpB,cAAc,EAAE,wFAAwF;QACxG,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC;QAC7D,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,SAAS;KACnE;IACD;QACE,EAAE,EAAE,0BAA0B;QAC9B,KAAK,EAAE,6BAA6B;QACpC,QAAQ,EAAE,eAAe;QACzB,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,kBAAkB;QAC1B,cAAc,EAAE,qFAAqF;QACrG,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;QAC7F,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,SAAS;KACxF;IACD;QACE,EAAE,EAAE,kBAAkB;QACtB,KAAK,EAAE,yBAAyB;QAChC,QAAQ,EAAE,kBAAkB;QAC5B,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,mBAAmB;QAC3B,cAAc,EAAE,6EAA6E;QAC7F,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;QAC1F,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,SAAS;KACrF;IACD;QACE,EAAE,EAAE,WAAW;QACf,KAAK,EAAE,+BAA+B;QACtC,QAAQ,EAAE,eAAe;QACzB,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,UAAU;QAClB,cAAc,EAAE,qEAAqE;QACrF,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC;QAClF,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,cAAc;KACrD;IACD;QACE,EAAE,EAAE,mBAAmB;QACvB,KAAK,EAAE,0BAA0B;QACjC,QAAQ,EAAE,eAAe;QACzB,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,gBAAgB;QACxB,cAAc,EAAE,yDAAyD;QACzE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;QACvF,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,SAAS;KAClF;IACD;QACE,EAAE,EAAE,oBAAoB;QACxB,KAAK,EAAE,yBAAyB;QAChC,QAAQ,EAAE,eAAe;QACzB,QAAQ,EAAE,MAAM;QAChB,MAAM,EAAE,eAAe;QACvB,cAAc,EAAE,kDAAkD;QAClE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC7E,QAAQ,EAAE,GAAG,EAAE,CAAC,oBAAoB;KACrC;IACD;QACE,EAAE,EAAE,oBAAoB;QACxB,KAAK,EAAE,yBAAyB;QAChC,QAAQ,EAAE,eAAe;QACzB,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,eAAe;QACvB,cAAc,EAAE,0EAA0E;QAC1F,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChF,QAAQ,EAAE,GAAG,EAAE,CAAC,uBAAuB;KACxC;IACD;QACE,EAAE,EAAE,uBAAuB;QAC3B,KAAK,EAAE,4BAA4B;QACnC,QAAQ,EAAE,eAAe;QACzB,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,eAAe;QACvB,cAAc,EAAE,qFAAqF;QACrG,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrE,QAAQ,EAAE,GAAG,EAAE,CAAC,wBAAwB;KACzC;IACD;QACE,EAAE,EAAE,8BAA8B;QAClC,KAAK,EAAE,0CAA0C;QACjD,QAAQ,EAAE,eAAe;QACzB,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,SAAS;QACjB,cAAc,EAAE,8EAA8E;QAC9F,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,IAAI,KAAK,eAAe,CAAC;QACxG,QAAQ,EAAE,GAAG,EAAE,CAAC,qCAAqC;KACtD;IACD;QACE,EAAE,EAAE,kBAAkB;QACtB,KAAK,EAAE,mCAAmC;QAC1C,QAAQ,EAAE,eAAe;QACzB,QAAQ,EAAE,QAAQ;QAClB,MAAM,EAAE,OAAO;QACf,cAAc,EAAE,qFAAqF;QACrG,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,kEAAkE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrH,QAAQ,EAAE,GAAG,EAAE,CAAC,iCAAiC;KAClD;IACD;QACE,EAAE,EAAE,oBAAoB;QACxB,KAAK,EAAE,kCAAkC;QACzC,QAAQ,EAAE,kBAAkB;QAC5B,QAAQ,EAAE,KAAK;QACf,MAAM,EAAE,gBAAgB;QACxB,cAAc,EAAE,2FAA2F;QAC3G,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE;YACf,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;YAClC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAC;YACd,CAAC;YAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC,CAAC;QACzE,CAAC;QACD,QAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE;YAClB,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;YAC/B,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC;iBACrB,OAAO,EAAE;iBACT,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;YAEpE,OAAO,GAAG,OAAO,OAAO,MAAM,gCAAgC,CAAC;QACjE,CAAC;KACF;CACF,CAAC;AAEF,MAAM,UAAU,QAAQ,CAAC,QAAsB;IAC7C,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,OAAO,GAAgB;QAC3B,CAAC;QACD,QAAQ;QACR,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE;KACnD,CAAC;IAEF,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC"}

package/dist/schema.d.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+export declare const inputUrlSchema: z.ZodEffects<z.ZodPipeline<z.ZodEffects<z.ZodString, string, string>, z.ZodString>, string, string>;
+export declare const outputFormatSchema: z.ZodEnum<["json", "markdown"]>;
+export declare const cliOptionsSchema: z.ZodObject<{
+    format: z.ZodDefault<z.ZodEnum<["json", "markdown"]>>;
+    out: z.ZodOptional<z.ZodString>;
+    timeout: z.ZodDefault<z.ZodNumber>;
+    maxRedirects: z.ZodDefault<z.ZodNumber>;
+    pretty: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    maxRedirects: number;
+    format: "json" | "markdown";
+    timeout: number;
+    pretty: boolean;
+    out?: string | undefined;
+}, {
+    maxRedirects?: number | undefined;
+    format?: "json" | "markdown" | undefined;
+    out?: string | undefined;
+    timeout?: number | undefined;
+    pretty?: boolean | undefined;
+}>;

package/dist/schema.js

@@ -0,0 +1,24 @@
+import { z } from "zod";
+export const inputUrlSchema = z
+    .string()
+    .trim()
+    .min(1, "URL is required")
+    .transform((value) => {
+    if (/^https?:\/\//i.test(value)) {
+        return value;
+    }
+    return `https://${value}`;
+})
+    .pipe(z.string().url("URL must be a valid HTTP or HTTPS URL"))
+    .refine((value) => /^https?:\/\//i.test(value), {
+    message: "Only HTTP and HTTPS URLs are supported"
+});
+export const outputFormatSchema = z.enum(["json", "markdown"]);
+export const cliOptionsSchema = z.object({
+    format: outputFormatSchema.default("markdown"),
+    out: z.string().optional(),
+    timeout: z.coerce.number().int().positive().max(60000).default(10000),
+    maxRedirects: z.coerce.number().int().min(0).max(10).default(5),
+    pretty: z.boolean().default(false)
+});
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,IAAI,EAAE;KACN,GAAG,CAAC,CAAC,EAAE,iBAAiB,CAAC;KACzB,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;IACnB,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,WAAW,KAAK,EAAE,CAAC;AAC5B,CAAC,CAAC;KACD,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;KAC7D,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;IAC9C,OAAO,EAAE,wCAAwC;CAClD,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;AAE/D,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,MAAM,EAAE,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC;IAC9C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IACrE,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/D,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CACnC,CAAC,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,49 @@
+export type Severity = "high" | "medium" | "low" | "info";
+export type FindingCategory = "technical-health" | "search-basics" | "mobile-usability" | "trust-contact";
+export interface Evidence {
+    label: string;
+    value: string;
+}
+export interface Finding {
+    id: string;
+    title: string;
+    severity: Severity;
+    category: FindingCategory;
+    evidence: Evidence[];
+    recommendation: string;
+    source: string;
+}
+export interface Score {
+    label: string;
+    score: number;
+    max: number;
+}
+export interface AuditSummary {
+    totalFindings: number;
+    high: number;
+    medium: number;
+    low: number;
+    info: number;
+}
+export interface AuditReport {
+    url: string;
+    finalUrl: string;
+    scannedAt: string;
+    statusCode: number;
+    summary: AuditSummary;
+    scores: Record<FindingCategory, Score>;
+    findings: Finding[];
+    recommendations: string[];
+    evidence: Evidence[];
+}
+export interface PageSnapshot {
+    url: string;
+    finalUrl: string;
+    statusCode: number;
+    headers: Record<string, string>;
+    html: string;
+}
+export interface AuditOptions {
+    timeoutMs: number;
+    maxRedirects: number;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "open-local-audit",
+  "version": "0.1.0",
+  "description": "Open-source website and local presence auditor for small businesses.",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "open-local-audit": "dist/cli.js"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "start": "tsx src/cli.ts"
+  },
+  "keywords": [
+    "local-seo",
+    "website-audit",
+    "small-business",
+    "cli",
+    "seo",
+    "accessibility",
+    "structured-data",
+    "local-business"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esquetta/open-local-audit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Esquetta/open-local-audit/issues"
+  },
+  "homepage": "https://github.com/Esquetta/open-local-audit#readme",
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "cheerio": "^1.0.0",
+    "commander": "^12.1.0",
+    "zod": "^3.24.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.2",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2",
+    "vitest": "^4.1.5"
+  }
+}