@cleaver/breakcheck-core 0.2.4 → 0.3.0

package/README.md

@@ -20,6 +20,63 @@ Node.js 22 or newer is required.
 
 ---
 
+## Project configuration and storage
+
+The core package does not implicitly read `breakcheck.config.json`; library
+callers choose configuration explicitly. `resolveProjectConfig` loads and
+validates version-1 and version-2 JSON files, while `writeProjectConfig`
+creates one with exclusive file creation:
+
+```typescript
+import {
+  resolveProjectConfig,
+  writeProjectConfig,
+} from "@cleaver/breakcheck-core";
+
+const project = await resolveProjectConfig({
+  configPath: "./breakcheck.config.json",
+});
+await writeProjectConfig("./new-breakcheck.config.json", {
+  version: 1,
+  baseUrl: "https://example.com",
+  storageDir: ".breakcheck",
+});
+```
+
+Config paths resolve relative to the config file. `storageDir` is the artifact
+root containing `snapshots/` and `comparisons`; Crawlee's temporary datasets
+and queues are separate. An omitted storage option in the operational API
+keeps the legacy `findRootDir()` behavior. To use another root, pass the same
+`{ storageDir }` option to each operation:
+
+```typescript
+const storage = { storageDir: "/work/site/.breakcheck" };
+await createSnapshotFromConfig(snapshotConfig, storage);
+await listSnapshots(storage);
+await runComparison(comparisonConfig, storage);
+await startViewServer("v1-vs-v2-comparison", 8080, storage);
+```
+
+Changing the storage root does not migrate existing artifacts.
+
+### Compiling a rules DSL
+
+Use `compileRulesDsl` to parse and validate a directory containing
+`rules.breakcheck`. It returns the intermediate `RulesDocument` shape used
+by the rules engine; the runtime-only `Ruleset.name` metadata is not included.
+
+```javascript
+import { compileRulesDsl } from "@cleaver/breakcheck-core";
+
+const document = await compileRulesDsl("./my-rules");
+console.log(JSON.stringify(document, null, 2));
+```
+
+Relative directories resolve from `process.cwd()`. Syntax and engine
+validation errors reject the promise before a document is returned.
+
+---
+
 ## API Usage
 
 The `@cleaver/breakcheck-core` library exposes a set of simple, asynchronous functions to manage the entire workflow.
@@ -66,6 +123,82 @@ async function takeSnapshot() {
 takeSnapshot();
 ```
 
+#### Crawling an exact path list
+
+Programmatic callers can set `SnapshotConfig.urlPaths` to supply an in-memory
+manifest. It uses the same root-relative path format as `--url-file` and
+switches off link discovery. Only the listed paths are requested; the base
+path `/` must be included explicitly when needed.
+
+```javascript
+const snapshotConfig = {
+  baseUrl: "https://example.com",
+  name: "selected-pages",
+  urlPaths: ["/", "/about-me", "/blog/the-nephew-effect"],
+  crawlSettings: {
+    baseUrl: "https://example.com",
+    crawlerType: "cheerio",
+    maxConcurrency: 5,
+  },
+};
+
+const result = await createSnapshotFromConfig(snapshotConfig);
+```
+
+`urlPaths` is validated against `baseUrl`; entries must be root-relative and
+same-origin, and duplicates are removed in first-seen order. An invalid or
+empty manifest fails before crawling. File and stdin reading are CLI concerns;
+the core API receives the already-created array.
+
+### Exact-route regression checks
+
+`runSiteCheck` captures only the supplied routes, verifies crawl coverage, then
+compares them with a stored baseline using the same comparison engine as
+`runComparison`. Added or removed routes count as differences. The core API
+does not start a site; the CLI handles preparation and server lifecycle. The
+route list scopes page comparisons and added/removed route results, so snapshot
+changes outside the manifest do not affect a route-scoped check.
+
+```typescript
+import { runSiteCheck } from "@cleaver/breakcheck-core";
+
+const result = await runSiteCheck(
+  {
+    baseUrl: "http://127.0.0.1:4000",
+    name: "check-local-run-1",
+    baselineSnapshotId: "site-baseline",
+    routes: ["/", "/about"],
+    crawlSettings: {
+      baseUrl: "http://127.0.0.1:4000",
+      crawlerType: "cheerio",
+      maxConcurrency: 5,
+    },
+    ruleset: "./rules",
+  },
+  { storageDir: "./.breakcheck" },
+);
+```
+
+The result status is `passed`, `differences`, or `failed`. The generated after
+snapshot and detailed comparison remain in the configured storage directory.
+`updateSnapshotRoutesFromConfig` is a separate API for explicitly replacing
+selected baseline routes; it stages and validates the new pages before
+committing them and preserves routes outside the selected list. Pass an
+`AbortSignal` in `OperationOptions` to cancel an active crawl; baseline updates
+check cancellation before replacing the stored routes.
+
+### Configuring Logs
+
+The core package uses pretty Pino logs by default. Call `configureLogger` before
+starting a workflow to select JSON output or a different log level. Crawlee
+messages emitted during snapshotting use the same configured logger.
+
+```javascript
+import { configureLogger } from "@cleaver/breakcheck-core";
+
+configureLogger({ useJsonLogs: true });
+```
+
 ### Listing Snapshots
 
 You can get a list of all locally saved snapshots using the `listSnapshots` function.
@@ -84,7 +217,7 @@ async function showSnapshots() {
   console.log("Available Snapshots:");
   snapshots.forEach((snapshot) => {
     console.log(
-      `- ${snapshot.name} (${snapshot.pageCount} pages, created on ${snapshot.date})`
+      `- ${snapshot.name} (${snapshot.pageCount} pages, created on ${snapshot.date})`,
     );
   });
 }

package/dist/api/index.d.ts

@@ -1,10 +1,15 @@
 import { logger } from "../lib/logger.js";
-import type { ComparisonConfig, ComparisonSummary, SnapshotConfig, SnapshotResult } from "../types/api.js";
+import type { ComparisonConfig, ComparisonSummary, SiteCheckConfig, SiteCheckResult, SnapshotRouteUpdateResult, SnapshotConfig, SnapshotResult, OperationOptions, StorageOptions } from "../types/api.js";
+import type { RulesDocument } from "../types/rules.js";
 /**
  * Creates a snapshot of a website based on the provided configuration.
  * Orchestrates calls to Crawler and Snapshot Manager.
  */
-export declare function createSnapshotFromConfig(config: SnapshotConfig): Promise<SnapshotResult>;
+export declare function createSnapshotFromConfig(config: SnapshotConfig, options?: OperationOptions): Promise<SnapshotResult>;
+/** Runs one exact-route regression check against a stored baseline snapshot. */
+export declare function runSiteCheck(config: SiteCheckConfig, options?: OperationOptions): Promise<SiteCheckResult>;
+/** Crawls selected routes and atomically merges them into a stored baseline. */
+export declare function updateSnapshotRoutesFromConfig(config: SnapshotConfig, baselineSnapshotId: string, options?: OperationOptions): Promise<SnapshotRouteUpdateResult>;
 /**
  * Starts a snapshot job and returns the job status.
  */
@@ -16,9 +21,22 @@ export declare function createSnapshotFromConfig(config: SnapshotConfig): Promis
  * Orchestrates calls to Snapshot Manager, Rules Engine Parser (if needed),
  * DOM Processor, and Diff Engine.
  */
-export declare function runComparison(config: ComparisonConfig): Promise<ComparisonSummary>;
+export declare function runComparison(config: ComparisonConfig, options?: StorageOptions): Promise<ComparisonSummary>;
+/**
+ * Parses and validates a rules.breakcheck directory into the intermediate
+ * JSON document used by the rules engine.
+ */
+export declare function compileRulesDsl(rulesDirectory: string): Promise<RulesDocument>;
 /**
  * Lists all available snapshots with their details
  */
-export declare function listSnapshots(): Promise<import("../index.js").SnapshotSummary[]>;
-export { logger, type ComparisonConfig, type SnapshotConfig };
+export declare function listSnapshots(options?: StorageOptions): Promise<import("../index.js").SnapshotSummary[]>;
+/** Deletes one named snapshot. */
+export declare function deleteSnapshot(name: string, options?: StorageOptions): Promise<boolean>;
+/** Deletes all snapshots and returns the names that were removed. */
+export declare function deleteAllSnapshots(options?: StorageOptions): Promise<string[]>;
+/** Deletes one named comparison. */
+export declare function deleteComparison(name: string, options?: StorageOptions): Promise<boolean>;
+/** Deletes all comparisons and returns the names that were removed. */
+export declare function deleteAllComparisons(options?: StorageOptions): Promise<string[]>;
+export { logger, type ComparisonConfig, type OperationOptions, type SiteCheckConfig, type SiteCheckResult, type SnapshotRouteUpdateResult, type SnapshotConfig, type StorageOptions, };

package/dist/api/index.js

@@ -2,14 +2,37 @@ import { compareSnapshots } from "../core/compare/index.js";
 import { ComparisonRepository } from "../core/compare/classes/ComparisonRepository.js";
 import { RulesEngine } from "../core/rules/RulesEngine.js";
 import { createSnapshot, SnapshotRepository } from "../core/snapshot/index.js";
+import { runSiteCheck as runSiteCheckWorkflow } from "../core/check/index.js";
+import { updateSnapshotRoutes } from "../core/snapshot/update-routes.js";
 import { logger } from "../lib/logger.js";
+import { resolveStorageContext } from "../lib/storage.js";
+import { processRulesDsl } from "../core/rules/RulesDsl.js";
 /**
  * Creates a snapshot of a website based on the provided configuration.
  * Orchestrates calls to Crawler and Snapshot Manager.
  */
-export async function createSnapshotFromConfig(config) {
-    const snapshotRepository = await SnapshotRepository.create();
-    return createSnapshot(config, snapshotRepository);
+export async function createSnapshotFromConfig(config, options = {}) {
+    const storageContext = await resolveStorageContext(options.storageDir);
+    const snapshotRepository = SnapshotRepository.createWithStorageContext(storageContext);
+    return createSnapshot(config, snapshotRepository, options.signal);
+}
+/** Runs one exact-route regression check against a stored baseline snapshot. */
+export async function runSiteCheck(config, options = {}) {
+    const storageContext = await resolveStorageContext(options.storageDir);
+    const snapshotRepository = SnapshotRepository.createWithStorageContext(storageContext);
+    return runSiteCheckWorkflow(config, {
+        snapshotRepository,
+        createSnapshot: (snapshotConfig, signal) => createSnapshot(snapshotConfig, snapshotRepository, signal),
+        runComparison: (comparisonConfig) => runComparison(comparisonConfig, {
+            storageDir: storageContext.storageDir,
+        }),
+    }, options.signal);
+}
+/** Crawls selected routes and atomically merges them into a stored baseline. */
+export async function updateSnapshotRoutesFromConfig(config, baselineSnapshotId, options = {}) {
+    const storageContext = await resolveStorageContext(options.storageDir);
+    const snapshotRepository = SnapshotRepository.createWithStorageContext(storageContext);
+    return updateSnapshotRoutes(config, baselineSnapshotId, snapshotRepository, (snapshotConfig, signal) => createSnapshot(snapshotConfig, snapshotRepository, signal), options.signal);
 }
 /**
  * Starts a snapshot job and returns the job status.
@@ -28,16 +51,17 @@ export async function createSnapshotFromConfig(config) {
  * Orchestrates calls to Snapshot Manager, Rules Engine Parser (if needed),
  * DOM Processor, and Diff Engine.
  */
-export async function runComparison(config) {
-    const snapshotRepository = await SnapshotRepository.create();
+export async function runComparison(config, options = {}) {
+    const storageContext = await resolveStorageContext(options.storageDir);
+    const snapshotRepository = SnapshotRepository.createWithStorageContext(storageContext);
     const rulesEngine = await RulesEngine.create(config.ruleset);
-    const comparisonRepository = await ComparisonRepository.create(config.comparisonName, {
+    const comparisonRepository = await ComparisonRepository.createWithStorageContext(config.comparisonName, {
         beforeSnapshotId: config.beforeSnapshotId,
         afterSnapshotId: config.afterSnapshotId,
         rulesUsedIdentifier: typeof config.ruleset === "string"
             ? config.ruleset
             : config.ruleset?.name,
-    });
+    }, storageContext);
     const diff = await compareSnapshots(config, snapshotRepository, comparisonRepository, rulesEngine);
     // Convert SnapshotDiff to ComparisonSummary
     return {
@@ -58,12 +82,49 @@ export async function runComparison(config) {
         resultsPath: diff.resultsPath,
     };
 }
+/**
+ * Parses and validates a rules.breakcheck directory into the intermediate
+ * JSON document used by the rules engine.
+ */
+export async function compileRulesDsl(rulesDirectory) {
+    const ruleset = await processRulesDsl(rulesDirectory);
+    await RulesEngine.create(ruleset);
+    return {
+        rules: ruleset.rules,
+        regions: ruleset.regions ?? [],
+    };
+}
 /**
  * Lists all available snapshots with their details
  */
-export async function listSnapshots() {
-    const snapshotRepository = await SnapshotRepository.create();
+export async function listSnapshots(options = {}) {
+    const storageContext = await resolveStorageContext(options.storageDir);
+    const snapshotRepository = SnapshotRepository.createWithStorageContext(storageContext);
     return snapshotRepository.listSnapshots();
 }
-export { logger };
+/** Deletes one named snapshot. */
+export async function deleteSnapshot(name, options = {}) {
+    const storageContext = await resolveStorageContext(options.storageDir);
+    const snapshotRepository = SnapshotRepository.createWithStorageContext(storageContext);
+    return snapshotRepository.deleteSnapshot(name);
+}
+/** Deletes all snapshots and returns the names that were removed. */
+export async function deleteAllSnapshots(options = {}) {
+    const storageContext = await resolveStorageContext(options.storageDir);
+    const snapshotRepository = SnapshotRepository.createWithStorageContext(storageContext);
+    return snapshotRepository.deleteAllSnapshots();
+}
+/** Deletes one named comparison. */
+export async function deleteComparison(name, options = {}) {
+    const storageContext = await resolveStorageContext(options.storageDir);
+    const comparisonRepository = ComparisonRepository.openWithStorageContext(storageContext);
+    return comparisonRepository.deleteComparison(name);
+}
+/** Deletes all comparisons and returns the names that were removed. */
+export async function deleteAllComparisons(options = {}) {
+    const storageContext = await resolveStorageContext(options.storageDir);
+    const comparisonRepository = ComparisonRepository.openWithStorageContext(storageContext);
+    return comparisonRepository.deleteAllComparisons();
+}
+export { logger, };
 //# sourceMappingURL=index.js.map

package/dist/api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,iDAAiD,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAQ1C;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,MAAsB;IAEtB,MAAM,kBAAkB,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,CAAC;IAC7D,OAAO,cAAc,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;AACpD,CAAC;AAED;;GAEG;AACH,0BAA0B;AAC1B,2BAA2B;AAC3B,2CAA2C;AAE3C;;GAEG;AACH,8BAA8B;AAC9B,kBAAkB;AAClB,2CAA2C;AAE3C;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAwB;IAExB,MAAM,kBAAkB,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,CAAC;IAC7D,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,oBAAoB,GAAG,MAAM,oBAAoB,CAAC,MAAM,CAC5D,MAAM,CAAC,cAAc,EACrB;QACE,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,mBAAmB,EACjB,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ;YAChC,CAAC,CAAC,MAAM,CAAC,OAAO;YAChB,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI;KAC3B,CACF,CAAC;IAEF,MAAM,IAAI,GAAG,MAAM,gBAAgB,CACjC,MAAM,EACN,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,CACZ,CAAC;IAEF,4CAA4C;IAC5C,OAAO;QACL,YAAY,EAAE,MAAM,CAAC,cAAc;QACnC,MAAM,EAAE,WAAW;QACnB,aAAa,EAAE,IAAI,CAAC,aAAa;QACjC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;QAC3C,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;QAC/C,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,uBAAuB,EAAE,EAAE;QAC3B,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,WAAW,EAAE,IAAI,CAAC,WAAW;KAC9B,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa;IACjC,MAAM,kBAAkB,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,CAAC;IAC7D,OAAO,kBAAkB,CAAC,aAAa,EAAE,CAAC;AAC5C,CAAC;AAED,OAAO,EAAE,MAAM,EAA8C,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,iDAAiD,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,YAAY,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAa1D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAE5D;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,MAAsB,EACtB,OAAO,GAAqB,EAAE;IAE9B,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,MAAM,kBAAkB,GACtB,kBAAkB,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,cAAc,CAAC,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;AACpE,CAAC;AAED,gFAAgF;AAChF,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuB,EACvB,OAAO,GAAqB,EAAE;IAE9B,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,MAAM,kBAAkB,GACtB,kBAAkB,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,oBAAoB,CACzB,MAAM,EACN;QACE,kBAAkB;QAClB,cAAc,EAAE,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,CACzC,cAAc,CAAC,cAAc,EAAE,kBAAkB,EAAE,MAAM,CAAC;QAC5D,aAAa,EAAE,CAAC,gBAAgB,EAAE,EAAE,CAClC,aAAa,CAAC,gBAAgB,EAAE;YAC9B,UAAU,EAAE,cAAc,CAAC,UAAU;SACtC,CAAC;KACL,EACD,OAAO,CAAC,MAAM,CACf,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAClD,MAAsB,EACtB,kBAA0B,EAC1B,OAAO,GAAqB,EAAE;IAE9B,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,MAAM,kBAAkB,GACtB,kBAAkB,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,oBAAoB,CACzB,MAAM,EACN,kBAAkB,EAClB,kBAAkB,EAClB,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,CACzB,cAAc,CAAC,cAAc,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAC5D,OAAO,CAAC,MAAM,CACf,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,0BAA0B;AAC1B,2BAA2B;AAC3B,2CAA2C;AAE3C;;GAEG;AACH,8BAA8B;AAC9B,kBAAkB;AAClB,2CAA2C;AAE3C;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAwB,EACxB,OAAO,GAAmB,EAAE;IAE5B,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,MAAM,kBAAkB,GACtB,kBAAkB,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAC9D,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC7D,MAAM,oBAAoB,GACxB,MAAM,oBAAoB,CAAC,wBAAwB,CACjD,MAAM,CAAC,cAAc,EACrB;QACE,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,mBAAmB,EACjB,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ;YAChC,CAAC,CAAC,MAAM,CAAC,OAAO;YAChB,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI;KAC3B,EACD,cAAc,CACf,CAAC;IAEJ,MAAM,IAAI,GAAG,MAAM,gBAAgB,CACjC,MAAM,EACN,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,CACZ,CAAC;IAEF,4CAA4C;IAC5C,OAAO;QACL,YAAY,EAAE,MAAM,CAAC,cAAc;QACnC,MAAM,EAAE,WAAW;QACnB,aAAa,EAAE,IAAI,CAAC,aAAa;QACjC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;QAC3C,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;QAC/C,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,uBAAuB,EAAE,EAAE;QAC3B,eAAe,EAAE,IAAI,CAAC,eAAe;QACrC,WAAW,EAAE,IAAI,CAAC,WAAW;KAC9B,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,cAAsB;IAEtB,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,cAAc,CAAC,CAAC;IACtD,MAAM,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAClC,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;KAC/B,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAO,GAAmB,EAAE;IAC9D,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,MAAM,kBAAkB,GACtB,kBAAkB,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,kBAAkB,CAAC,aAAa,EAAE,CAAC;AAC5C,CAAC;AAED,kCAAkC;AAClC,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,IAAY,EACZ,OAAO,GAAmB,EAAE;IAE5B,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,MAAM,kBAAkB,GACtB,kBAAkB,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,kBAAkB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;AACjD,CAAC;AAED,qEAAqE;AACrE,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,OAAO,GAAmB,EAAE;IAE5B,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,MAAM,kBAAkB,GACtB,kBAAkB,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,kBAAkB,CAAC,kBAAkB,EAAE,CAAC;AACjD,CAAC;AAED,oCAAoC;AACpC,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,IAAY,EACZ,OAAO,GAAmB,EAAE;IAE5B,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,MAAM,oBAAoB,GACxB,oBAAoB,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,oBAAoB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;AACrD,CAAC;AAED,uEAAuE;AACvE,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAO,GAAmB,EAAE;IAE5B,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvE,MAAM,oBAAoB,GACxB,oBAAoB,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;IAC9D,OAAO,oBAAoB,CAAC,oBAAoB,EAAE,CAAC;AACrD,CAAC;AAED,OAAO,EACL,MAAM,GAQP,CAAC"}

package/dist/core/check/index.d.ts

@@ -0,0 +1,9 @@
+import type { ComparisonConfig, ComparisonSummary, SiteCheckConfig, SiteCheckResult, SnapshotConfig, SnapshotResult } from "../../types/api.js";
+import type { SnapshotRepository } from "../snapshot/classes/SnapshotRepository.js";
+export interface SiteCheckOperations {
+    snapshotRepository: SnapshotRepository;
+    createSnapshot: (config: SnapshotConfig, signal?: AbortSignal) => Promise<SnapshotResult>;
+    runComparison: (config: ComparisonConfig) => Promise<ComparisonSummary>;
+}
+/** Runs an exact-route regression check using the supplied core operations. */
+export declare function runSiteCheck(config: SiteCheckConfig, operations: SiteCheckOperations, signal?: AbortSignal): Promise<SiteCheckResult>;

package/dist/core/check/index.js

@@ -0,0 +1,116 @@
+import { resolveUrlPaths } from "../crawler/url-paths.js";
+import { validateSnapshotRoutes } from "../snapshot/route-coverage.js";
+/** Runs an exact-route regression check using the supplied core operations. */
+export async function runSiteCheck(config, operations, signal) {
+    signal?.throwIfAborted();
+    if (config.name === config.baselineSnapshotId) {
+        throw new Error("The check snapshot name must differ from the baseline snapshot ID.");
+    }
+    if ((config.crawlSettings.includePatterns?.length ?? 0) > 0 ||
+        (config.crawlSettings.excludePatterns?.length ?? 0) > 0) {
+        throw new Error("Exact-route checks cannot use crawl includePatterns or excludePatterns.");
+    }
+    const manifest = resolveUrlPaths(config.baseUrl, config.routes);
+    if (manifest.issues.length > 0) {
+        throw new Error(manifest.issues.map((issue) => issue.message).join("; "));
+    }
+    await operations.snapshotRepository.loadSnapshot(config.baselineSnapshotId);
+    signal?.throwIfAborted();
+    const snapshotResult = await operations.createSnapshot({
+        baseUrl: config.baseUrl,
+        name: config.name,
+        urlPaths: manifest.paths,
+        crawlSettings: {
+            ...config.crawlSettings,
+            baseUrl: config.baseUrl,
+            includePatterns: [],
+            excludePatterns: [],
+        },
+    }, signal);
+    if (snapshotResult.status === "failed") {
+        return {
+            status: "failed",
+            baseUrl: config.baseUrl,
+            baselineSnapshotId: config.baselineSnapshotId,
+            snapshotId: snapshotResult.snapshotId,
+            routes: manifest.paths,
+            crawlErrors: snapshotResult.errors.map((error) => ({
+                url: config.baseUrl,
+                message: error.message,
+                ...(error.statusCode === undefined
+                    ? {}
+                    : { statusCode: error.statusCode }),
+            })),
+            errors: [snapshotResult.message],
+        };
+    }
+    signal?.throwIfAborted();
+    const afterSnapshot = await operations.snapshotRepository.loadSnapshot(snapshotResult.snapshotId);
+    const failures = snapshotResult.errors.map((error) => `${error.url}: ${error.message}`);
+    failures.push(...(await validateSnapshotRoutes(afterSnapshot, manifest.paths)));
+    signal?.throwIfAborted();
+    if (failures.length > 0) {
+        return {
+            status: "failed",
+            baseUrl: config.baseUrl,
+            baselineSnapshotId: config.baselineSnapshotId,
+            snapshotId: snapshotResult.snapshotId,
+            routes: manifest.paths,
+            crawlErrors: snapshotResult.errors,
+            errors: failures,
+        };
+    }
+    let comparison;
+    try {
+        comparison = await operations.runComparison({
+            beforeSnapshotId: config.baselineSnapshotId,
+            afterSnapshotId: snapshotResult.snapshotId,
+            comparisonName: config.name,
+            ruleset: config.ruleset,
+            urls: manifest.paths,
+        });
+    }
+    catch (error) {
+        return {
+            status: "failed",
+            baseUrl: config.baseUrl,
+            baselineSnapshotId: config.baselineSnapshotId,
+            snapshotId: snapshotResult.snapshotId,
+            routes: manifest.paths,
+            crawlErrors: [],
+            errors: [error instanceof Error ? error.message : String(error)],
+        };
+    }
+    if (signal?.aborted)
+        signal.throwIfAborted();
+    if (comparison.pagesWithErrors > 0) {
+        return {
+            status: "failed",
+            baseUrl: config.baseUrl,
+            baselineSnapshotId: config.baselineSnapshotId,
+            snapshotId: snapshotResult.snapshotId,
+            routes: manifest.paths,
+            crawlErrors: [],
+            errors: [
+                `Comparison could not process ${comparison.pagesWithErrors} page(s).`,
+            ],
+            comparison,
+        };
+    }
+    const status = comparison.pagesWithDifferences > 0 ||
+        comparison.newUrls.length > 0 ||
+        comparison.removedUrls.length > 0
+        ? "differences"
+        : "passed";
+    return {
+        status,
+        baseUrl: config.baseUrl,
+        baselineSnapshotId: config.baselineSnapshotId,
+        snapshotId: snapshotResult.snapshotId,
+        routes: manifest.paths,
+        crawlErrors: [],
+        errors: [],
+        comparison,
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/core/check/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/check/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAqBvE,+EAA+E;AAC/E,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuB,EACvB,UAA+B,EAC/B,MAAoB;IAEpB,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,kBAAkB,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;IACJ,CAAC;IACD,IACE,CAAC,MAAM,CAAC,aAAa,CAAC,eAAe,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC;QACvD,CAAC,MAAM,CAAC,aAAa,CAAC,eAAe,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,EACvD,CAAC;QACD,MAAM,IAAI,KAAK,CACb,yEAAyE,CAC1E,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAChE,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,UAAU,CAAC,kBAAkB,CAAC,YAAY,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAC5E,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,cAAc,CACpD;QACE,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,QAAQ,EAAE,QAAQ,CAAC,KAAK;QACxB,aAAa,EAAE;YACb,GAAG,MAAM,CAAC,aAAa;YACvB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,eAAe,EAAE,EAAE;YACnB,eAAe,EAAE,EAAE;SACpB;KACF,EACD,MAAM,CACP,CAAC;IAEF,IAAI,cAAc,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QACvC,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;YAC7C,UAAU,EAAE,cAAc,CAAC,UAAU;YACrC,MAAM,EAAE,QAAQ,CAAC,KAAK;YACtB,WAAW,EAAE,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAc,EAAE,CAAC,CAAC;gBAC7D,GAAG,EAAE,MAAM,CAAC,OAAO;gBACnB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,GAAG,CAAC,KAAK,CAAC,UAAU,KAAK,SAAS;oBAChC,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC;aACtC,CAAC,CAAC;YACH,MAAM,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC;SACjC,CAAC;IACJ,CAAC;IAED,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,MAAM,aAAa,GAAG,MAAM,UAAU,CAAC,kBAAkB,CAAC,YAAY,CACpE,cAAc,CAAC,UAAU,CAC1B,CAAC;IACF,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,GAAG,CACxC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,KAAK,CAAC,OAAO,EAAE,CAC5C,CAAC;IACF,QAAQ,CAAC,IAAI,CACX,GAAG,CAAC,MAAM,sBAAsB,CAAC,aAAa,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CACjE,CAAC;IAEF,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;YAC7C,UAAU,EAAE,cAAc,CAAC,UAAU;YACrC,MAAM,EAAE,QAAQ,CAAC,KAAK;YACtB,WAAW,EAAE,cAAc,CAAC,MAAM;YAClC,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,IAAI,UAA6B,CAAC;IAClC,IAAI,CAAC;QACH,UAAU,GAAG,MAAM,UAAU,CAAC,aAAa,CAAC;YAC1C,gBAAgB,EAAE,MAAM,CAAC,kBAAkB;YAC3C,eAAe,EAAE,cAAc,CAAC,UAAU;YAC1C,cAAc,EAAE,MAAM,CAAC,IAAI;YAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,IAAI,EAAE,QAAQ,CAAC,KAAK;SACrB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;YAC7C,UAAU,EAAE,cAAc,CAAC,UAAU;YACrC,MAAM,EAAE,QAAQ,CAAC,KAAK;YACtB,WAAW,EAAE,EAAE;YACf,MAAM,EAAE,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACjE,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,EAAE,OAAO;QAAE,MAAM,CAAC,cAAc,EAAE,CAAC;IAC7C,IAAI,UAAU,CAAC,eAAe,GAAG,CAAC,EAAE,CAAC;QACnC,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;YAC7C,UAAU,EAAE,cAAc,CAAC,UAAU;YACrC,MAAM,EAAE,QAAQ,CAAC,KAAK;YACtB,WAAW,EAAE,EAAE;YACf,MAAM,EAAE;gBACN,gCAAgC,UAAU,CAAC,eAAe,WAAW;aACtE;YACD,UAAU;SACX,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GACV,UAAU,CAAC,oBAAoB,GAAG,CAAC;QACnC,UAAU,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;QAC7B,UAAU,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;QAC/B,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,QAAQ,CAAC;IACf,OAAO;QACL,MAAM;QACN,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,UAAU,EAAE,cAAc,CAAC,UAAU;QACrC,MAAM,EAAE,QAAQ,CAAC,KAAK;QACtB,WAAW,EAAE,EAAE;QACf,MAAM,EAAE,EAAE;QACV,UAAU;KACX,CAAC;AACJ,CAAC"}

package/dist/core/compare/classes/ComparisonRepository.d.ts

@@ -1,3 +1,4 @@
+import { type StorageContext } from "../../../lib/storage.js";
 import { ComparisonIndex, ComparisonMetadata, PageDiff } from "../../../types/compare.js";
 export declare class ComparisonRepository {
     private readonly comparisonsDir;
@@ -9,6 +10,12 @@ export declare class ComparisonRepository {
      * Creates a new comparison repository instance and initializes it with the given name and metadata.
      */
     static create(name: string, metadata: ComparisonMetadata, comparisonsDir?: string): Promise<ComparisonRepository>;
+    /** Creates and initializes a comparison in a shared artifact context. */
+    static createWithStorageContext(name: string, metadata: ComparisonMetadata, storageContext: StorageContext): Promise<ComparisonRepository>;
+    /** Opens the comparison store without initializing a named comparison. */
+    static open(comparisonsDir?: string): Promise<ComparisonRepository>;
+    /** Opens a comparison store in a shared artifact context. */
+    static openWithStorageContext(storageContext: StorageContext): ComparisonRepository;
     /**
      * Initializes a new comparison, creating directories and saving initial metadata.
      */
@@ -22,4 +29,8 @@ export declare class ComparisonRepository {
      */
     finalizeComparison(): Promise<string>;
     getIndex(): ComparisonIndex;
+    /** Deletes one named comparison without removing the storage root. */
+    deleteComparison(name: string): Promise<boolean>;
+    /** Deletes all direct child comparison directories and returns their names. */
+    deleteAllComparisons(): Promise<string[]>;
 }

package/dist/core/compare/classes/ComparisonRepository.js

@@ -3,6 +3,7 @@ import * as path from "path";
 import { promisify } from "util";
 import * as zlib from "zlib";
 import { findRootDir } from "../../../lib/root.js";
+import { deleteAllStorageEntries, deleteStorageEntry, resolveStorageEntry, } from "../../../lib/storage.js";
 const gzip = promisify(zlib.gzip);
 export class ComparisonRepository {
     comparisonsDir;
@@ -16,18 +17,31 @@ export class ComparisonRepository {
      * Creates a new comparison repository instance and initializes it with the given name and metadata.
      */
     static async create(name, metadata, comparisonsDir) {
-        const rootDir = await findRootDir();
-        const defaultComparisonsDir = path.join(rootDir, "comparisons");
-        const instance = new ComparisonRepository(comparisonsDir || defaultComparisonsDir);
+        const instance = await ComparisonRepository.open(comparisonsDir);
         await instance.initialize(name, metadata);
         return instance;
     }
+    /** Creates and initializes a comparison in a shared artifact context. */
+    static async createWithStorageContext(name, metadata, storageContext) {
+        const instance = ComparisonRepository.openWithStorageContext(storageContext);
+        await instance.initialize(name, metadata);
+        return instance;
+    }
+    /** Opens the comparison store without initializing a named comparison. */
+    static async open(comparisonsDir) {
+        const resolvedComparisonsDir = comparisonsDir ?? path.join(await findRootDir(), "comparisons");
+        return new ComparisonRepository(resolvedComparisonsDir);
+    }
+    /** Opens a comparison store in a shared artifact context. */
+    static openWithStorageContext(storageContext) {
+        return new ComparisonRepository(storageContext.comparisonsDir);
+    }
     /**
      * Initializes a new comparison, creating directories and saving initial metadata.
      */
     async initialize(name, metadata) {
+        this.comparisonDir = resolveStorageEntry(this.comparisonsDir, name, "comparison");
         await fs.mkdir(this.comparisonsDir, { recursive: true });
-        this.comparisonDir = path.join(this.comparisonsDir, name);
         this.diffsDir = path.join(this.comparisonDir, "diffs");
         // Clean up previous results
         await fs.rm(this.comparisonDir, { recursive: true, force: true });
@@ -73,5 +87,13 @@ export class ComparisonRepository {
     getIndex() {
         return this.index;
     }
+    /** Deletes one named comparison without removing the storage root. */
+    async deleteComparison(name) {
+        return deleteStorageEntry(this.comparisonsDir, name, "comparison");
+    }
+    /** Deletes all direct child comparison directories and returns their names. */
+    async deleteAllComparisons() {
+        return deleteAllStorageEntries(this.comparisonsDir, "comparison");
+    }
 }
 //# sourceMappingURL=ComparisonRepository.js.map

package/dist/core/compare/classes/ComparisonRepository.js.map

@@ -1 +1 @@
-{"version":3,"file":"ComparisonRepository.js","sourceRoot":"","sources":["../../../../src/core/compare/classes/ComparisonRepository.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAOnD,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAElC,MAAM,OAAO,oBAAoB;IACd,cAAc,CAAS;IAChC,aAAa,CAAU;IACvB,QAAQ,CAAU;IAClB,KAAK,GAAoB,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAS,EAAE,CAAC;IAEnE,YAAoB,cAAsB;QACxC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,IAAY,EACZ,QAA4B,EAC5B,cAAuB;QAEvB,MAAM,OAAO,GAAG,MAAM,WAAW,EAAE,CAAC;QACpC,MAAM,qBAAqB,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,IAAI,oBAAoB,CACvC,cAAc,IAAI,qBAAqB,CACxC,CAAC;QACF,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,UAAU,CACtB,IAAY,EACZ,QAA4B;QAE5B,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QAC1D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAEvD,4BAA4B;QAC5B,MAAM,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAElE,2BAA2B;QAC3B,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACxD,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEnD,qCAAqC;QACrC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;QACpE,MAAM,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG;YACpB,GAAG,QAAQ;YACX,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,UAAU,EAAE,CAAC;YACb,oBAAoB,EAAE,CAAC;SACxB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,QAAkB;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,QAAQ,GACZ,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC;QAC/D,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC;QAEnE,eAAe;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG;YAC9B,QAAQ;YACR,cAAc,EAAE,QAAQ,CAAC,cAAc;SACxC,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACjC,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QAC7C,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB;QACtB,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QAC9D,MAAM,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF"}
+{"version":3,"file":"ComparisonRepository.js","sourceRoot":"","sources":["../../../../src/core/compare/classes/ComparisonRepository.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,GAEpB,MAAM,yBAAyB,CAAC;AAOjC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAElC,MAAM,OAAO,oBAAoB;IACd,cAAc,CAAS;IAChC,aAAa,CAAU;IACvB,QAAQ,CAAU;IAClB,KAAK,GAAoB,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAS,EAAE,CAAC;IAEnE,YAAoB,cAAsB;QACxC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,IAAY,EACZ,QAA4B,EAC5B,cAAuB;QAEvB,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACjE,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,yEAAyE;IACzE,MAAM,CAAC,KAAK,CAAC,wBAAwB,CACnC,IAAY,EACZ,QAA4B,EAC5B,cAA8B;QAE9B,MAAM,QAAQ,GACZ,oBAAoB,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;QAC9D,MAAM,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,0EAA0E;IAC1E,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,cAAuB;QACvC,MAAM,sBAAsB,GAC1B,cAAc,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,WAAW,EAAE,EAAE,aAAa,CAAC,CAAC;QAClE,OAAO,IAAI,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;IAC1D,CAAC;IAED,6DAA6D;IAC7D,MAAM,CAAC,sBAAsB,CAC3B,cAA8B;QAE9B,OAAO,IAAI,oBAAoB,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,UAAU,CACtB,IAAY,EACZ,QAA4B;QAE5B,IAAI,CAAC,aAAa,GAAG,mBAAmB,CACtC,IAAI,CAAC,cAAc,EACnB,IAAI,EACJ,YAAY,CACb,CAAC;QACF,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAEvD,4BAA4B;QAC5B,MAAM,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAElE,2BAA2B;QAC3B,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACxD,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEnD,qCAAqC;QACrC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;QACpE,MAAM,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG;YACpB,GAAG,QAAQ;YACX,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,UAAU,EAAE,CAAC;YACb,oBAAoB,EAAE,CAAC;SACxB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,QAAkB;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,QAAQ,GACZ,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC;QAC/D,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC;QAEnE,eAAe;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG;YAC9B,QAAQ;YACR,cAAc,EAAE,QAAQ,CAAC,cAAc;SACxC,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACjC,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;YAC5B,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QAC7C,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB;QACtB,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;QAC9D,MAAM,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,gBAAgB,CAAC,IAAY;QACjC,OAAO,kBAAkB,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;IACrE,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,oBAAoB;QACxB,OAAO,uBAAuB,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IACpE,CAAC;CACF"}

package/dist/core/compare/index.js

@@ -9,13 +9,20 @@ export async function comparePage(before, after) {
     const beautify = jsbeautify.html;
     const beautifyOptions = {
         indent_size: 2,
-        preserve_newlines: true,
-        unformatted: ["a", "span", "b", "strong", "i", "em"],
+        preserve_newlines: false,
+        unformatted: ["span", "b", "strong", "i", "em"],
     };
     const beforeContent = beautify(before.content, beautifyOptions);
     const afterContent = beautify(after.content, beautifyOptions);
     const patch = createPatch(url, beforeContent, afterContent);
-    const differences = diffLines(beforeContent, afterContent);
+    const differences = diffLines(beforeContent, afterContent).map((change) => {
+        const { added, removed, ...unchangedFields } = change;
+        return {
+            ...unchangedFields,
+            ...(added ? { added } : {}),
+            ...(removed ? { removed } : {}),
+        };
+    });
     const hasDifferences = differences.some((diff) => diff.added || diff.removed);
     return { url, differences, hasDifferences, patch };
 }
@@ -31,15 +38,20 @@ export async function compareSnapshots(config, snapshotRepository, comparisonRep
     const beforeUrls = Object.keys(beforeSnapshot.index.urls);
     const afterUrls = new Set(Object.keys(afterSnapshot.index.urls));
     const urlsToCompare = config.urls || beforeUrls;
+    const requestedUrls = config.urls === undefined ? undefined : new Set(config.urls);
     const rulesUsedIdentifier = typeof config.ruleset === "string" ? config.ruleset : config.ruleset?.name;
     // Find new and removed URLs
-    const newUrls = [...afterUrls].filter((url) => !beforeUrls.includes(url));
-    const removedUrls = beforeUrls.filter((url) => !afterUrls.has(url));
+    const newUrls = [...afterUrls].filter((url) => !beforeUrls.includes(url) &&
+        (requestedUrls === undefined || requestedUrls.has(url)));
+    const removedUrls = beforeUrls.filter((url) => !afterUrls.has(url) &&
+        (requestedUrls === undefined || requestedUrls.has(url)));
     let pagesWithErrors = 0;
     // Compare pages one by one
     for (const url of urlsToCompare) {
         if (!afterUrls.has(url))
             continue; // Skip URLs not in the "after" snapshot
+        if (!beforeSnapshot.index.urls[url])
+            continue; // New URLs are reported above
         const beforePage = await beforeSnapshot.getPage(url);
         const afterPage = await afterSnapshot.getPage(url);
         if (!beforePage || !afterPage) {
@@ -61,7 +73,11 @@ export async function compareSnapshots(config, snapshotRepository, comparisonRep
     // Return the summary data
     return {
         status: "completed",
-        overallResult: finalIndex.metadata.pagesWithDifferences > 0 ? "fail" : "pass",
+        overallResult: finalIndex.metadata.pagesWithDifferences > 0 ||
+            newUrls.length > 0 ||
+            removedUrls.length > 0
+            ? "fail"
+            : "pass",
         beforeSnapshotId: config.beforeSnapshotId,
         afterSnapshotId: config.afterSnapshotId,
         rulesUsedIdentifier,