@regressionbot/sdk 2.7.0 → 2.9.0
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 +16 -0
- package/dist/types.d.ts +14 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -38,6 +38,22 @@ npm install @regressionbot/sdk
|
|
|
38
38
|
|
|
39
39
|
## Migration from 1.x
|
|
40
40
|
|
|
41
|
+
### 2.9.0
|
|
42
|
+
|
|
43
|
+
- **`approve()`'s `warning` can now be `'BASELINE_OUTDATED'`**, alongside `'NO_BASELINE'`. A
|
|
44
|
+
job-level approve returns it when some pages were skipped because another job updated their
|
|
45
|
+
baseline first; `conflictedUrls` lists them and `message` says how many advanced. The API has
|
|
46
|
+
always returned this; the type only knew `'NO_BASELINE'`.
|
|
47
|
+
|
|
48
|
+
### 2.8.0
|
|
49
|
+
|
|
50
|
+
- **`JobSummary.runSummaryPoints`** (`string[] | null`) — the run summary as a list, one
|
|
51
|
+
short sentence per change, at most four, the change on the most pages first. This is what
|
|
52
|
+
the scheduled-run email and the dashboard's run view show. Null exactly when `runSummary`
|
|
53
|
+
is. A run summarized before this field existed has one point, its paragraph.
|
|
54
|
+
- **`JobSummary.runSummary`** is now one paragraph rather than two or three sentences; its
|
|
55
|
+
doc comment is updated to match. No type change.
|
|
56
|
+
|
|
41
57
|
### 2.7.0
|
|
42
58
|
|
|
43
59
|
Needs API 2.10.0 or later for `fidelity`/`scopeNote` to be populated. On an older API these
|
package/dist/types.d.ts
CHANGED
|
@@ -584,12 +584,18 @@ export interface JobSummary {
|
|
|
584
584
|
errorMessage: string;
|
|
585
585
|
}>;
|
|
586
586
|
/**
|
|
587
|
-
* An AI summary of the whole run
|
|
588
|
-
*
|
|
589
|
-
*
|
|
590
|
-
* record; this is a reading of them.
|
|
587
|
+
* An AI summary of the whole run as one paragraph, written once when the run finished
|
|
588
|
+
* from the exact edits in `regressions`. Null when nothing changed or none could be
|
|
589
|
+
* written. The changes are the record; this is a reading of them.
|
|
591
590
|
*/
|
|
592
591
|
runSummary: string | null;
|
|
592
|
+
/**
|
|
593
|
+
* The same summary as a list: one short sentence per change, at most four, the change
|
|
594
|
+
* on the most pages first. This is what opens the scheduled-run email and the
|
|
595
|
+
* dashboard's run view. Null exactly when `runSummary` is. A run summarized before this
|
|
596
|
+
* field existed has one point, its paragraph.
|
|
597
|
+
*/
|
|
598
|
+
runSummaryPoints: string[] | null;
|
|
593
599
|
/** Whole-job roll-up of how the changes line up with the run's stated intent. */
|
|
594
600
|
intentAssessment: IntentAssessment;
|
|
595
601
|
/** The intent this run was given, echoed back. */
|
|
@@ -647,8 +653,10 @@ export interface ApproveResult {
|
|
|
647
653
|
conflictedUrls?: string[];
|
|
648
654
|
/** One page only: what approvePage or rejectPage wrote on that page's result. */
|
|
649
655
|
triageStatus?: 'APPROVED' | 'REJECTED';
|
|
650
|
-
/**
|
|
651
|
-
|
|
656
|
+
/** `'NO_BASELINE'`: there was no stored baseline to advance into — the decision was still recorded.
|
|
657
|
+
* `'BASELINE_OUTDATED'`: job-level approve skipped some pages because another job updated their
|
|
658
|
+
* baseline first; they are listed in `conflictedUrls`. */
|
|
659
|
+
warning?: 'NO_BASELINE' | 'BASELINE_OUTDATED';
|
|
652
660
|
/** Explains `warning` when present. */
|
|
653
661
|
note?: string;
|
|
654
662
|
/** One page only, and only when `warning` is `'NO_BASELINE'`: always `false`. */
|
package/package.json
CHANGED