snapdrift 0.8.2 → 0.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "snapdrift",
-  "version": "0.8.2",
+  "version": "0.10.0",
   "private": false,
   "type": "module",
   "description": "SnapDrift captures, compares, and reports UI drift for Playwright-based app checks.",
@@ -25,12 +25,15 @@
   "scripts": {
     "lint": "eslint .",
     "typecheck": "tsc --project tsconfig.json",
+    "check:package-types": "node scripts/check-package-types.mjs",
+    "check:package-runtime": "node scripts/check-package-runtime.mjs",
     "validate:actions": "node scripts/validate-actions.mjs",
     "validate:release": "node scripts/validate-release.mjs",
+    "check:pin-stale": "node scripts/check-pin-stale.mjs",
     "test": "NODE_OPTIONS='--experimental-vm-modules' jest",
     "test:coverage": "NODE_OPTIONS='--experimental-vm-modules' jest --coverage --runInBand",
     "pack:check": "npm pack --dry-run --cache .npm-cache",
-    "ci": "npm run lint && npm run typecheck && npm run validate:actions && npm run test:coverage && npm run pack:check"
+    "ci": "npm run lint && npm run typecheck && npm run check:package-types && npm run check:package-runtime && npm run validate:actions && npm run test:coverage && npm run pack:check"
   },
   "engines": {
     "node": ">=22"
@@ -41,7 +44,6 @@
   "devDependencies": {
     "@eslint/js": "^10.0.1",
     "@types/jest": "^30.0.0",
-    "@types/js-yaml": "^4.0.9",
     "@types/node": "^26.1.0",
     "@types/pngjs": "^6.0.5",
     "eslint": "^10.2.0",
@@ -80,9 +82,11 @@
     "./lib/provider.mjs": "./lib/provider.mjs",
     "./lib/outage-policy.mjs": "./lib/outage-policy.mjs",
     "./lib/snap-provider.mjs": "./lib/snap-provider.mjs",
-    "./lib/migrate-baselines.mjs": "./lib/migrate-baselines.mjs",
-    "./lib/init-from-action.mjs": "./lib/init-from-action.mjs"
-  },
+     "./lib/migrate-baselines.mjs": "./lib/migrate-baselines.mjs",
+     "./lib/init-from-action.mjs": "./lib/init-from-action.mjs",
+     "./lib/resolve-baseline-paths.mjs": "./lib/resolve-baseline-paths.mjs",
+     "./lib/resolve-baseline-artifact.mjs": "./lib/resolve-baseline-artifact.mjs"
+   },
   "files": [
     "action.yml",
     "actions/",
@@ -98,11 +102,11 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@snapdrift/adapter-fs": "^1.0.1",
-    "@snapdrift/adapter-report-md": "^1.1.0",
-    "@snapdrift/compare-core": "^1.0.0",
-    "@snapdrift/manifest": "^1.2.0",
-    "js-yaml": "^5.2.1",
+    "@snapdrift/adapter-fs": "^1.2.0",
+    "@snapdrift/adapter-report-md": "^1.2.0",
+    "@snapdrift/compare-core": "^1.1.0",
+    "@snapdrift/manifest": "^1.4.0",
+    "js-yaml": "^5.4.0",
     "playwright": "^1.59.1",
     "pngjs": "^7.0.0"
   }

package/types/visual-diff-types.d.ts

@@ -1,8 +1,13 @@
+import type { SnapConfig } from '@snapdrift/manifest';
+
 /** Object-shaped data decoded from an external JSON or YAML boundary. */
 export type JsonObject = Record<string, any>;
 
 export type VisualViewportPreset = 'desktop' | 'mobile';
-export interface VisualCustomViewport { width: number; height: number; }
+export interface VisualCustomViewport {
+  width: number;
+  height: number;
+}
 export type VisualViewport = VisualViewportPreset | VisualCustomViewport;
 
 export interface VisualRegressionSelectionConfig {
@@ -10,6 +15,24 @@ export interface VisualRegressionSelectionConfig {
   sharedExact?: string[];
 }
 
+export interface ComparisonPolicy {
+  version: 1;
+  threshold: number;
+}
+
+export interface ComparisonDimensions {
+  width: number;
+  height: number;
+}
+
+export interface ComparisonMetadata {
+  baseline: ComparisonDimensions;
+  current: ComparisonDimensions;
+  canvas: ComparisonDimensions;
+  dimensionsChanged: boolean;
+  totalPixels: number;
+}
+
 export interface VisualRegressionRouteConfig {
   id: string;
   path: string;
@@ -29,6 +52,7 @@ export interface VisualRegressionConfig {
   diff: {
     threshold: number;
     mode: 'report-only' | 'fail-on-changes' | 'fail-on-incomplete' | 'strict';
+    comparisonPolicy?: ComparisonPolicy;
   };
   selection?: VisualRegressionSelectionConfig;
   provider?: 'local' | 'snap';
@@ -86,6 +110,8 @@ export interface SnapRunMetadata {
   runId: string;
   projectId: string;
   purpose: 'baseline' | 'capture' | 'diff';
+  /** Exact comparison policy acknowledged by Snap for updated clients. */
+  comparisonPolicy?: ComparisonPolicy;
   /** CI source branch for hosted baseline runs; omitted for ordinary diff runs. */
   refBranch?: string;
   /** Resolved 40-character CI commit for hosted baseline runs. */
@@ -139,6 +165,8 @@ export interface VisualDiffChangedItem {
   totalPixels: number;
   mismatchRatio: number;
   status: 'changed';
+  comparison?: ComparisonMetadata;
+  diffImagePath?: string;
 }
 
 export interface VisualDiffSummary {
@@ -165,6 +193,7 @@ export interface VisualDiffSummary {
   missing: VisualDiffMissingItem[];
   errors: VisualDiffErrorItem[];
   dimensionChanges: VisualDiffDimensionItem[];
+  comparisonPolicy?: ComparisonPolicy;
   message?: string;
   /** Link to the provider's run detail page. Set by SnapProvider during diff(); undefined for LocalProvider. */
   dashboardUrl?: string;