@regressionbot/sdk 2.10.0 → 2.10.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
@@ -38,6 +38,16 @@ npm install @regressionbot/sdk
38
38
 
39
39
  ## Migration from 1.x
40
40
 
41
+ ### 2.10.1
42
+
43
+ Documentation only; no change to any type's shape or any method.
44
+
45
+ - **`ResultAssessment.reason` can be `deferred`**: the verdict pass ran short of time for that page
46
+ and will retry it.
47
+ - **`autoApprove` with a `runContext`**: auto-approve fires only if every changed page has an AI
48
+ verdict (a page skipped under `aiSummaryThreshold` counts as having none); otherwise the run is
49
+ held for review.
50
+
41
51
  ### 2.10.0
42
52
 
43
53
  Needs the current production API for these fields to be populated. On an older API they are simply absent.
@@ -496,7 +506,7 @@ const status = await job.waitForCompletion(3000, (s) => {
496
506
 
497
507
  ### Auto-Approval
498
508
 
499
- Set `.autoApprove()` to automatically promote screenshots to baselines when the job completes. Useful for scheduled health checks or first-run baseline seeding.
509
+ Set `.autoApprove()` to automatically promote screenshots to baselines when the job completes. Useful for scheduled health checks or first-run baseline seeding. When the run carries a `runContext`, auto-approve fires only if every changed page has an AI verdict (a page skipped under `aiSummaryThreshold` counts as having none); otherwise the run is held for review.
500
510
 
501
511
  ```typescript
502
512
  const job = await rb
package/dist/index.d.ts CHANGED
@@ -47,6 +47,7 @@ export declare class RegressionBot {
47
47
  /** CSS injected before screenshotting. Max 4096 characters. */
48
48
  customCss?: string;
49
49
  concurrency?: number;
50
+ /** Automatically promote all captures to baselines. When the run carries an intent (`runContext`), auto-approve fires only if every changed page has an AI verdict (a page skipped under `aiSummaryThreshold` counts as having none); otherwise the run is held for review. */
50
51
  autoApprove?: boolean;
51
52
  /** What this run is testing, used to judge whether changes were intended. */
52
53
  runContext?: RunContext;
@@ -94,6 +95,7 @@ export declare class JobBuilder {
94
95
  * raising it is a load decision about someone else's environment.
95
96
  */
96
97
  concurrency(n: number): this;
98
+ /** Automatically promote all captures to baselines. When the run carries an intent (`runContext`), auto-approve fires only if every changed page has an AI verdict (a page skipped under `aiSummaryThreshold` counts as having none); otherwise the run is held for review. */
97
99
  autoApprove(val?: boolean): this;
98
100
  mask(selectors: string[]): this;
99
101
  /**
package/dist/index.js CHANGED
@@ -145,6 +145,7 @@ class JobBuilder {
145
145
  this.manifest.concurrency = n;
146
146
  return this;
147
147
  }
148
+ /** Automatically promote all captures to baselines. When the run carries an intent (`runContext`), auto-approve fires only if every changed page has an AI verdict (a page skipped under `aiSummaryThreshold` counts as having none); otherwise the run is held for review. */
148
149
  autoApprove(val = true) {
149
150
  this.manifest.autoApprove = val;
150
151
  return this;
package/dist/types.d.ts CHANGED
@@ -750,9 +750,9 @@ export interface ResultAssessment {
750
750
  status: AssessmentStatus;
751
751
  /**
752
752
  * Why, when status is not `assessed`. One of no_intent, analysis_in_progress, timeout,
753
- * model_error, malformed_response, incomplete_response, capped, pass_error,
753
+ * model_error, malformed_response, incomplete_response, capped, deferred, pass_error,
754
754
  * pass_interrupted, no_assessor, summary_failed, below_ai_threshold, not_analysed,
755
- * not_reached.
755
+ * not_reached. `deferred` means the analysis ran short of time and will be retried.
756
756
  */
757
757
  reason?: string;
758
758
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@regressionbot/sdk",
3
- "version": "2.10.0",
3
+ "version": "2.10.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": {