@regressionbot/sdk 2.5.0 → 2.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -74,6 +74,14 @@ the builder, intent-aware verdicts, environment gates, baseline policies, and
74
74
  scheduling. `scheduleHourUtc` needs API 2.7.0 or later — on an older API the
75
75
  field is accepted and ignored, and the schedule stays anchored to its first run.
76
76
 
77
+ ### 2.5.1
78
+
79
+ - **`ProjectConfig.aiPromptInstructions` and `aiSummaryThreshold` are now marked
80
+ `@deprecated`.** The API itself has deprecated both — DOM-engine results (2026-09-28 on)
81
+ never read `aiPromptInstructions`, and are summarised whenever they changed regardless of
82
+ `aiSummaryThreshold`. Both are still typed and still round-trip; only the doc comments
83
+ changed.
84
+
77
85
  ### 2.5.0
78
86
 
79
87
  - **`updateProject()` now returns `baselinesInvalidated`.** The API has always sent it
package/dist/types.d.ts CHANGED
@@ -57,9 +57,9 @@ export interface ProjectConfig {
57
57
  };
58
58
  /** Pages captured in parallel, 1–20. Absent means the API's default of 4. */
59
59
  concurrency?: number;
60
- /** Extra instructions handed to the model that writes change summaries. Max 1000 characters. */
60
+ /** @deprecated Fed only the screenshot-reading AI, which DOM-engine results (2026-09-28 on) never reach. No longer in the dashboard. */
61
61
  aiPromptInstructions?: string;
62
- /** Diff percentage below which a regression is skipped by the AI pass. Defaults to 0.01. */
62
+ /** @deprecated DOM-engine results (2026-09-28 on) are summarised whenever they changed, so this floor only affects older results. */
63
63
  aiSummaryThreshold?: number;
64
64
  /**
65
65
  * `approved` (default): a person accepts a run and its captures become the baseline.
@@ -134,8 +134,9 @@ export interface ProjectConfigUpdate {
134
134
  * take the API's default of 4 — the load lands on the site being captured.
135
135
  */
136
136
  concurrency?: number;
137
- /** Max 1000 characters. */
137
+ /** @deprecated Fed only the screenshot-reading AI, which DOM-engine results (2026-09-28 on) never reach. No longer in the dashboard. Max 1000 characters. */
138
138
  aiPromptInstructions?: string;
139
+ /** @deprecated DOM-engine results (2026-09-28 on) are summarised whenever they changed, so this floor only affects older results. */
139
140
  aiSummaryThreshold?: number;
140
141
  baselinePolicy?: BaselinePolicy;
141
142
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@regressionbot/sdk",
3
- "version": "2.5.0",
3
+ "version": "2.5.1",
4
4
  "description": "The official SDK for regressionbot.com - the simplest way to automate visual regression testing.",
5
5
  "homepage": "https://regressionbot.com",
6
6
  "repository": {