@flakiness/sdk 3.1.0 → 3.2.0

package/README.md

@@ -91,6 +91,7 @@ Use this entry point when you need to process or manipulate reports in browser-b
 - **`GitWorktree`** - Git repository utilities for path conversion and commit information
 - **`ReportUtils`** - Namespace with utilities for report creation and manipulation:
   - `createEnvironment()` - Create environment objects with system information
+  - `detectRuntime()` - Detect the JS runtime (`node` / `bun` / `deno`) and its version; suitable for `Report.runtime`
   - `normalizeReport()` - Deduplicate environments, suites, and tests
   - `collectSources()` - Extract source code snippets for locations in the report
   - `stripAnsi()` - Remove ANSI escape codes from strings

package/lib/index.js

@@ -531,6 +531,7 @@ __export(reportUtils_exports, {
   createDataAttachment: () => createDataAttachment,
   createEnvironment: () => createEnvironment,
   createFileAttachment: () => createFileAttachment,
+  detectRuntime: () => detectRuntime,
   normalizeReport: () => normalizeReport,
   stripAnsi: () => stripAnsi,
   validateReport: () => validateReport,
@@ -680,6 +681,18 @@ function createEnvironment(options) {
   };
 }
 
+// src/detectRuntime.ts
+function detectRuntime() {
+  const g = globalThis;
+  if (g.Bun?.version)
+    return { name: "bun", version: g.Bun.version };
+  if (g.Deno?.version?.deno)
+    return { name: "deno", version: g.Deno.version.deno };
+  if (g.process?.versions?.node)
+    return { name: "node", version: g.process.versions.node };
+  return void 0;
+}
+
 // src/normalizeReport.ts
 import { FlakinessReport } from "@flakiness/flakiness-report";
 import stableObjectHash from "stable-hash";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/sdk",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "node": "^20.17.0 || >=22.9.0"
   },
   "devDependencies": {
-    "@flakiness/flakiness-report": "^0.31.0",
+    "@flakiness/flakiness-report": "^0.34.0",
     "@flakiness/playwright": "^1.3.3",
     "@playwright/test": "^1.58.2",
     "@types/debug": "^4.1.12",

package/types/src/detectRuntime.d.ts

@@ -0,0 +1,22 @@
+import { FlakinessReport } from '@flakiness/flakiness-report';
+/**
+ * Detects the JavaScript runtime executing the current process.
+ *
+ * Returns the runtime name (`bun`, `deno`, `node`) and its version, suitable for
+ * use as `FlakinessReport.Report.runtime`. Bun and Deno expose Node-compat
+ * versions on `process.versions.node`, so this probes their globals first to
+ * avoid mis-identifying them as Node.
+ *
+ * @returns {FlakinessReport.Report['runtime']} The detected runtime, or `undefined` if no
+ *   supported runtime is recognized (e.g., browser environments).
+ *
+ * @example
+ * ```typescript
+ * const report = ReportUtils.normalizeReport({
+ *   // ...
+ *   runtime: ReportUtils.detectRuntime(),
+ * });
+ * ```
+ */
+export declare function detectRuntime(): FlakinessReport.Report['runtime'];
+//# sourceMappingURL=detectRuntime.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"detectRuntime.d.ts","sourceRoot":"","sources":["../../src/detectRuntime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,aAAa,IAAI,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAgBjE"}

package/types/src/reportUtils.d.ts

@@ -1,5 +1,6 @@
 export { collectSources } from './collectSources.js';
 export { createEnvironment } from './createEnvironment.js';
+export { detectRuntime } from './detectRuntime.js';
 export { normalizeReport } from './normalizeReport.js';
 export { validateReport } from './validateReport.js';
 export { stripAnsi } from './stripAnsi.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,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"}
+{"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,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,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"}