@cleaver/breakcheck-core 0.2.4 → 0.3.0

package/dist/lib/storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../src/lib/storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AASxC,qEAAqE;AACrE,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,UAAmB;IAEnB,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,CAAC,MAAM,WAAW,EAAE,CAAC,CAAC,CAAC;IAC7E,OAAO;QACL,UAAU,EAAE,kBAAkB;QAC9B,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,WAAW,CAAC;QACxD,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,aAAa,CAAC;KAC7D,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,CACL,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAC5E,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,UAAkB,EAClB,IAAY,EACZ,IAAY;IAEZ,IACE,IAAI,CAAC,MAAM,KAAK,CAAC;QACjB,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;QACxB,IAAI,KAAK,GAAG;QACZ,IAAI,KAAK,IAAI;QACb,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAClB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EACnB,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,UAAU,IAAI,2CAA2C,CACzE,CAAC;IACJ,CAAC;IAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACpD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;IAC7D,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,kBAAkB,EAAE,CAAC;QACvD,MAAM,IAAI,KAAK,CACb,WAAW,IAAI,UAAU,IAAI,oDAAoD,CAClF,CAAC;IACJ,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,UAAkB,EAClB,IAAY,EACZ,IAAY;IAEZ,MAAM,SAAS,GAAG,mBAAmB,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAE9D,IAAI,UAAU,CAAC;IACf,IAAI,CAAC;QACH,UAAU,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,gBAAgB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACvD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,KAAK,IAAI,2BAA2B,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,UAAkB;IAElB,IAAI,OAAO,CAAC;IACZ,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,gBAAgB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACvD,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,OAAO,OAAO;SACX,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;SACtC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;SAC1B,IAAI,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,UAAkB,EAClB,IAAY;IAEZ,MAAM,KAAK,GAAG,MAAM,sBAAsB,CAAC,UAAU,CAAC,CAAC;IACvD,MAAM,YAAY,GAAa,EAAE,CAAC;IAElC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,MAAM,kBAAkB,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YACrD,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/dist/types/api.d.ts

@@ -34,9 +34,56 @@ export interface SnapshotConfig {
     name: string;
     /** Crawler configuration to use */
     crawlSettings: CrawlerConfig;
+    /**
+     * Optional root-relative paths to crawl exactly. When provided, link
+     * discovery is disabled and the base URL is not added automatically.
+     */
+    urlPaths?: string[];
     /** Optional path to generate a URL list file */
     urlListPath?: string;
 }
+/** Configuration for an exact-route regression check against a baseline. */
+export interface SiteCheckConfig {
+    /** Base URL for the site being checked. */
+    baseUrl: string;
+    /** Unique name used for the after snapshot and saved comparison. */
+    name: string;
+    /** Snapshot id containing the checked-in baseline. */
+    baselineSnapshotId: string;
+    /** Exact root-relative routes to request. */
+    routes: string[];
+    /** Crawler settings; URL filters are not used for exact route checks. */
+    crawlSettings: CrawlerConfig;
+    /** Optional rules directory or inline ruleset. */
+    ruleset?: ComparisonConfig["ruleset"];
+}
+export type SiteCheckStatus = "passed" | "differences" | "failed";
+/** Structured result returned by the public site-check API. */
+export interface SiteCheckResult {
+    status: SiteCheckStatus;
+    baseUrl: string;
+    baselineSnapshotId: string;
+    snapshotId?: string;
+    routes: string[];
+    crawlErrors: CrawlError[];
+    errors: string[];
+    comparison?: ComparisonSummary;
+}
+/** Result of updating selected routes in an existing baseline snapshot. */
+export interface SnapshotRouteUpdateResult {
+    snapshotId: string;
+    updatedRoutes: string[];
+    pageCount: number;
+}
+/** Optional artifact-storage context for public operations. */
+export interface StorageOptions {
+    /** Directory containing the `snapshots/` and `comparisons/` stores. */
+    storageDir?: string;
+}
+/** Storage settings and cooperative cancellation for long-running operations. */
+export interface OperationOptions extends StorageOptions {
+    signal?: AbortSignal;
+}
 interface SnapshotJobBase {
     snapshotId: string;
 }

package/dist/types/compare.d.ts

@@ -2,9 +2,12 @@
 import { Change } from "diff";
 /**
  * Represents a single difference found between two page snapshots
- * This is equivalent to the Change type from the diff package
+ * This retains the optional change flags exposed by earlier diff releases.
  */
-export type LineDiff = Change;
+export type LineDiff = Omit<Change, "added" | "removed"> & {
+    added?: boolean;
+    removed?: boolean;
+};
 /**
  * Represents the complete diff result for a single page
  */

package/dist/types/config.d.ts

@@ -0,0 +1,72 @@
+import type { CrawlerType } from "./api.js";
+/** The supported project configuration schema versions. */
+export type ProjectConfigVersion = 1 | 2;
+/** Crawl defaults that may be persisted in a project configuration file. */
+export interface ProjectCrawlConfig {
+    crawlerType?: CrawlerType;
+    maxDepth?: number;
+    maxConcurrency?: number;
+    includePatterns?: string[];
+    excludePatterns?: string[];
+}
+/** Comparison defaults that may be persisted in a project configuration file. */
+export interface ProjectComparisonConfig {
+    rulesDir?: string;
+}
+/** A command passed to Node's process launcher without shell interpretation. */
+export type ProjectCommand = string[];
+/** Local site lifecycle settings for `breakcheck check`. */
+export interface ProjectCheckServerConfig {
+    start: ProjectCommand;
+    stop?: ProjectCommand;
+    cwd?: string;
+    env?: Record<string, string>;
+    readyPath?: string;
+    timeoutMs?: number;
+}
+/** Settings for a repeatable exact-route regression check. */
+export interface ProjectCheckConfig {
+    routesFile: string;
+    baselineSnapshot: string;
+    prepare?: ProjectCommand[];
+    server?: ProjectCheckServerConfig;
+    reportDir?: string;
+}
+/** The JSON shape accepted by `breakcheck.config.json`. */
+export interface ProjectConfig {
+    version: ProjectConfigVersion;
+    baseUrl?: string;
+    storageDir?: string;
+    crawl?: ProjectCrawlConfig;
+    comparison?: ProjectComparisonConfig;
+    check?: ProjectCheckConfig;
+}
+/** A validated project configuration together with the file that supplied it. */
+export interface LoadedProjectConfig {
+    configPath: string;
+    config: ProjectConfig;
+}
+/** Options controlling explicit configuration selection and discovery. */
+export interface ProjectConfigLoadOptions {
+    cwd?: string;
+    configPath?: string;
+    noConfig?: boolean;
+}
+/** A validated configuration with paths resolved for downstream operations. */
+export interface ResolvedProjectConfig {
+    configPath?: string;
+    storageDir: string;
+    baseUrl?: string;
+    crawl: ProjectCrawlConfig;
+    rulesDir?: string;
+    check?: ResolvedProjectCheckConfig;
+}
+/** Check configuration with filesystem paths resolved from the config file. */
+export interface ResolvedProjectCheckConfig extends Omit<ProjectCheckConfig, "routesFile" | "reportDir" | "server"> {
+    configDirectory: string;
+    routesFile: string;
+    reportDir: string;
+    server?: Omit<ProjectCheckServerConfig, "cwd"> & {
+        cwd: string;
+    };
+}

package/dist/types/config.js

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

package/dist/types/config.js.map

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

package/dist/types/rules.d.ts

@@ -72,11 +72,16 @@ export interface Region {
     name: string;
 }
 /**
- * The root structure of the JSON rules document
+ * The serialized JSON document produced from the rules DSL.
  */
-export interface Ruleset {
-    name: string;
+export interface RulesDocument {
     rules: Rule[];
     /** Named regions are optional for backwards-compatible inline rulesets. */
     regions?: Region[];
 }
+/**
+ * A named runtime ruleset used by comparisons.
+ */
+export interface Ruleset extends RulesDocument {
+    name: string;
+}

package/dist/types/rules.js.map

@@ -1 +1 @@
-{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../src/types/rules.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,0BAA0B,CAAC"}
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../src/types/rules.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,0BAA0B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cleaver/breakcheck-core",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "type": "module",
   "engines": {
     "node": ">=22"
@@ -32,16 +32,17 @@
     "dev": "tsc -w"
   },
   "dependencies": {
-    "cheerio": "1.0.0-rc.12",
+    "cheerio": "^1.2.0",
     "chevrotain": "^13.2.0",
-    "crawlee": "^3.18.1",
-    "diff": "^5.2.2",
+    "crawlee": "^3.18.2",
+    "diff": "^9.0.0",
     "diff2html": "^3.4.56",
-    "express": "^5.2.1",
-    "find-up": "^7.0.0",
-    "js-beautify": "^1.15.4",
-    "pino": "^9.14.0",
-    "pino-pretty": "^11.2.1",
-    "playwright": "^1.62.1"
+    "domhandler": "^5.0.3",
+    "express": "^5.3.0",
+    "find-up": "^8.0.0",
+    "js-beautify": "^2.0.3",
+    "pino": "^10.4.0",
+    "pino-pretty": "^13.2.0",
+    "playwright": "^1.64.0"
   }
 }