@regressionbot/sdk 2.7.0 → 2.8.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 CHANGED
@@ -38,6 +38,15 @@ npm install @regressionbot/sdk
38
38
 
39
39
  ## Migration from 1.x
40
40
 
41
+ ### 2.8.0
42
+
43
+ - **`JobSummary.runSummaryPoints`** (`string[] | null`) — the run summary as a list, one
44
+ short sentence per change, at most four, the change on the most pages first. This is what
45
+ the scheduled-run email and the dashboard's run view show. Null exactly when `runSummary`
46
+ is. A run summarized before this field existed has one point, its paragraph.
47
+ - **`JobSummary.runSummary`** is now one paragraph rather than two or three sentences; its
48
+ doc comment is updated to match. No type change.
49
+
41
50
  ### 2.7.0
42
51
 
43
52
  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, two or three sentences, written once when the run
588
- * finished from the exact edits in `regressions` (the same text opens the scheduled-run
589
- * email). Null when nothing changed or none could be written. The changes are the
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. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@regressionbot/sdk",
3
- "version": "2.7.0",
3
+ "version": "2.8.0",
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": {