@flakiness/sdk 0.152.0 → 0.153.0

package/README.md

@@ -40,8 +40,8 @@ const report: FlakinessReport.Report = {
       location: { file: 'test.spec.ts', line: 10, column: 1 },
       attempts: [{
         environmentIdx: 0,
+        status: 'passed',
         expectedStatus: 'passed',
-        actualStatus: 'passed',
         duration: 100 as FlakinessReport.DurationMS,
       }],
     }],
@@ -87,11 +87,12 @@ Use this entry point when you need to process or manipulate reports in browser-b
 - **`ReportUtils`** - Namespace with utilities for report creation and manipulation:
   - `createEnvironment()` - Create environment objects with system information
   - `normalizeReport()` - Deduplicate environments, suites, and tests
-  - `createTestStepSnippetsInplace()` - Generate code snippets for test steps
+  - `collectSources()` - Extract source code snippets for locations in the report
   - `stripAnsi()` - Remove ANSI escape codes from strings
   - `visitTests()` - Recursively visit all tests in a report
   - `createFileAttachment()` / `createDataAttachment()` - Create report attachments
-- **`SystemUtilizationSampler`** - Monitor and record CPU/memory utilization during test runs
+- **`CPUUtilization`** - Track CPU utilization over time via periodic sampling
+- **`RAMUtilization`** - Track RAM utilization over time via periodic sampling
 
 ### Working with Reports
 - **`showReport()`** - Start a local server and open the report in your browser

package/lib/browser.js

@@ -5,13 +5,14 @@ var __export = (target, all) => {
 };
 
 // src/browser.ts
-import { FlakinessReport } from "@flakiness/flakiness-report";
+import { FlakinessReport as FlakinessReport2 } from "@flakiness/flakiness-report";
 
 // src/reportUtilsBrowser.ts
 var reportUtilsBrowser_exports = {};
 __export(reportUtilsBrowser_exports, {
   normalizeReport: () => normalizeReport,
   stripAnsi: () => stripAnsi,
+  validateReport: () => validateReport,
   visitTests: () => visitTests
 });
 
@@ -173,6 +174,24 @@ function computeTestId(test, suiteId) {
   });
 }
 
+// src/validateReport.ts
+import { Schema } from "@flakiness/flakiness-report";
+import z from "zod";
+function validateReport(report) {
+  const validation = Schema.Report.safeParse(report);
+  if (!validation.success) {
+    const MAX_ISSUES = 5;
+    const allIssues = validation.error.issues;
+    const shownIssues = allIssues.slice(0, MAX_ISSUES);
+    const remaining = allIssues.length - shownIssues.length;
+    const base = [z.prettifyError(new z.ZodError(shownIssues))];
+    if (remaining > 0)
+      base.push(`... and ${remaining} more issue${remaining === 1 ? "" : "s"} ...`);
+    return base.join("\n");
+  }
+  return void 0;
+}
+
 // src/stripAnsi.ts
 var ansiRegex = new RegExp("[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))", "g");
 function stripAnsi(str) {
@@ -195,7 +214,7 @@ function visitTests(report, testVisitor) {
     visitSuite(suite, []);
 }
 export {
-  FlakinessReport,
+  FlakinessReport2 as FlakinessReport,
   reportUtilsBrowser_exports as ReportUtils
 };
 //# sourceMappingURL=browser.js.map

package/lib/index.js

@@ -5,7 +5,7 @@ var __export = (target, all) => {
 };
 
 // src/index.ts
-import { FlakinessReport } from "@flakiness/flakiness-report";
+import { FlakinessReport as FlakinessReport2, Schema as Schema2 } from "@flakiness/flakiness-report";
 
 // src/ciUtils.ts
 var CIUtils;
@@ -473,6 +473,7 @@ __export(reportUtils_exports, {
   createFileAttachment: () => createFileAttachment,
   normalizeReport: () => normalizeReport,
   stripAnsi: () => stripAnsi,
+  validateReport: () => validateReport,
   visitTests: () => visitTests
 });
 
@@ -777,6 +778,24 @@ function computeTestId(test, suiteId) {
   });
 }
 
+// src/validateReport.ts
+import { Schema } from "@flakiness/flakiness-report";
+import z from "zod";
+function validateReport(report) {
+  const validation = Schema.Report.safeParse(report);
+  if (!validation.success) {
+    const MAX_ISSUES = 5;
+    const allIssues = validation.error.issues;
+    const shownIssues = allIssues.slice(0, MAX_ISSUES);
+    const remaining = allIssues.length - shownIssues.length;
+    const base = [z.prettifyError(new z.ZodError(shownIssues))];
+    if (remaining > 0)
+      base.push(`... and ${remaining} more issue${remaining === 1 ? "" : "s"} ...`);
+    return base.join("\n");
+  }
+  return void 0;
+}
+
 // src/stripAnsi.ts
 var ansiRegex = new RegExp("[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))", "g");
 function stripAnsi(str) {
@@ -1311,10 +1330,11 @@ export {
   CIUtils,
   CPUUtilization,
   FlakinessProjectConfig,
-  FlakinessReport,
+  FlakinessReport2 as FlakinessReport,
   GitWorktree,
   RAMUtilization,
   reportUtils_exports as ReportUtils,
+  Schema2 as Schema,
   showReport,
   uploadReport,
   writeReport

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/sdk",
-  "version": "0.152.0",
+  "version": "0.153.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -37,10 +37,11 @@
     "typescript": "^5.6.2"
   },
   "dependencies": {
-    "@flakiness/flakiness-report": "^0.18.0",
+    "@flakiness/flakiness-report": "^0.20.0",
     "chalk": "^5.6.2",
     "debug": "^4.4.3",
     "open": "^10.2.0",
-    "stable-hash": "^0.0.6"
+    "stable-hash": "^0.0.6",
+    "zod": "^4.3.5"
   }
 }

package/types/src/index.d.ts

@@ -1,4 +1,4 @@
-export { FlakinessReport } from '@flakiness/flakiness-report';
+export { FlakinessReport, Schema } from '@flakiness/flakiness-report';
 export { CIUtils } from './ciUtils.js';
 export { CPUUtilization } from './cpuUtilization.js';
 export { GitWorktree } from './gitWorktree.js';

package/types/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAG9D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAGhD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAGtE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAGhD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC"}

package/types/src/reportUtils.d.ts

@@ -1,6 +1,7 @@
 export { collectSources } from './collectSources.js';
 export { createEnvironment } from './createEnvironment.js';
 export { normalizeReport } from './normalizeReport.js';
+export { validateReport } from './validateReport.js';
 export { stripAnsi } from './stripAnsi.js';
 export { createDataAttachment, createFileAttachment } from './uploadReport.js';
 export type { Attachment, DataAttachment, FileAttachment } from './uploadReport.js';

package/types/src/reportUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reportUtils.d.ts","sourceRoot":"","sources":["../../src/reportUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,UAAU,EAAE,cAAc,EAC1B,cAAc,EACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"reportUtils.d.ts","sourceRoot":"","sources":["../../src/reportUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACV,UAAU,EAAE,cAAc,EAC1B,cAAc,EACf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC"}

package/types/src/reportUtilsBrowser.d.ts

@@ -1,4 +1,5 @@
 export { normalizeReport } from './normalizeReport.js';
+export { validateReport } from './validateReport.js';
 export { stripAnsi } from './stripAnsi.js';
 export { visitTests } from './visitTests.js';
 //# sourceMappingURL=reportUtilsBrowser.d.ts.map

package/types/src/reportUtilsBrowser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reportUtilsBrowser.d.ts","sourceRoot":"","sources":["../../src/reportUtilsBrowser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"reportUtilsBrowser.d.ts","sourceRoot":"","sources":["../../src/reportUtilsBrowser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC"}

package/types/src/validateReport.d.ts

@@ -0,0 +1,9 @@
+import { FlakinessReport } from '@flakiness/flakiness-report';
+/**
+ * Validates a report object against the Flakiness Report schema.
+ *
+ * @param report - The report object to validate
+ * @returns A formatted error string if validation fails, or `undefined` if the report is valid
+ */
+export declare function validateReport(report: FlakinessReport.Report): string | undefined;
+//# sourceMappingURL=validateReport.d.ts.map

package/types/src/validateReport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateReport.d.ts","sourceRoot":"","sources":["../../src/validateReport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAU,MAAM,6BAA6B,CAAC;AAGtE;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,GAAG,MAAM,GAAC,SAAS,CAe/E"}