feat: move report validation to SDK

Author: aslushnikov

package-lock.json

@@ -37,10 +37,11 @@
     "typescript": "^5.6.2"
   },
   "dependencies": {
-    "@flakiness/flakiness-report": "^0.19.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.json

@@ -1,5 +1,5 @@
 // Report type & validation
-export { FlakinessReport, validateReport } from '@flakiness/flakiness-report';
+export { FlakinessReport, Schema } from '@flakiness/flakiness-report';
 
 // Building report
 export { CIUtils } from './ciUtils.js';

src/index.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,

src/reportUtils.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';
 

src/reportUtilsBrowser.ts

@@ -0,0 +1,26 @@
+import { FlakinessReport, Schema } from '@flakiness/flakiness-report';
+import z from 'zod';
+
+/**
+ * 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 function validateReport(report: FlakinessReport.Report): string|undefined {
+  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 undefined;
+}
+