@nzila/sdk 0.1.5 → 0.1.7

package/README.md

@@ -25,6 +25,16 @@ Subpaths such as `@nzila/sdk/vitest` need **`moduleResolution`** set to **`bundl
 
 `@nzila/sdk@0.1.4+` also ships root `.d.ts` shims and `typesVersions` for broader editor support.
 
+### Vitest: tests hang or never start?
+
+Use the **tuple** from `nzilaVitestReporter()` — do **not** put `new NzilaVitestReporter()` in `vitest.config.ts`. Worker pools cannot serialize class instances.
+
+```ts
+reporters: ["default", nzilaVitestReporter({ webhookUrl, apiKey, appName })],
+```
+
+Equivalent: `reporters: ["default", ["@nzila/sdk/vitest", { … }]]`.
+
 ### Reporters not sending?
 
 1. Set **`NZILA_WEBHOOK_URL`**, **`NZILA_API_KEY`**, and **`NZILA_APP_NAME`** (must match the project app name in the dashboard), or pass them in the reporter constructor.
@@ -63,13 +73,13 @@ After you sign in on [nzila-kappa.vercel.app](https://nzila-kappa.vercel.app), t
 **Tests (CI):**
 
 ```ts
-import NzilaVitestReporter from "@nzila/sdk/vitest";
+import { nzilaVitestReporter } from "@nzila/sdk/vitest";
 
 export default defineConfig({
   test: {
     reporters: [
       "default",
-      new NzilaVitestReporter({
+      nzilaVitestReporter({
         webhookUrl: process.env.NZILA_WEBHOOK_URL!,
         apiKey: process.env.NZILA_API_KEY!,
         appName: "my-app",

package/dist/collect-vitest-tests.d.ts

@@ -1,5 +1,29 @@
-import type { TestModule } from "vitest/node";
 import type { NzilaClientOptions, NzilaTestCase } from "./types.js";
+/** Duck-typed Vitest 3 test tree (no `vitest/node` import — safe for worker load). */
+type VitestTestNode = {
+    name: string;
+    parent: {
+        type: string;
+        name: string;
+        parent: VitestTestNode["parent"];
+    };
+    result(): {
+        state: string;
+        errors?: {
+            message?: string;
+            stack?: string;
+        }[];
+    };
+    diagnostic(): {
+        duration?: number;
+    } | undefined;
+};
+type VitestTestModule = {
+    children?: {
+        allTests(): Iterable<VitestTestNode>;
+    };
+};
 /** Collect finished tests from Vitest 3+ `TestModule` reporters API. */
-export declare function collectTestsFromVitestModules(modules: ReadonlyArray<TestModule>, options: NzilaClientOptions, runStartedAt: Date): NzilaTestCase[];
+export declare function collectTestsFromVitestModules(modules: ReadonlyArray<VitestTestModule>, options: NzilaClientOptions, runStartedAt: Date): NzilaTestCase[];
+export {};
 //# sourceMappingURL=collect-vitest-tests.d.ts.map

package/dist/collect-vitest-tests.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collect-vitest-tests.d.ts","sourceRoot":"","sources":["../src/collect-vitest-tests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAY,UAAU,EAAa,MAAM,aAAa,CAAC;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAmB,MAAM,YAAY,CAAC;AAmBrF,wEAAwE;AACxE,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,EAClC,OAAO,EAAE,kBAAkB,EAC3B,YAAY,EAAE,IAAI,GACjB,aAAa,EAAE,CAuCjB"}
+{"version":3,"file":"collect-vitest-tests.d.ts","sourceRoot":"","sources":["../src/collect-vitest-tests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAmB,MAAM,YAAY,CAAC;AAErF,sFAAsF;AACtF,KAAK,cAAc,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAA;KAAE,CAAC;IACzE,MAAM,IAAI;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE;YAAE,OAAO,CAAC,EAAE,MAAM,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,CAAC;IAC7E,UAAU,IAAI;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;CACjD,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACtB,QAAQ,CAAC,EAAE;QACT,QAAQ,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC;KACtC,CAAC;CACH,CAAC;AAsBF,wEAAwE;AACxE,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,aAAa,CAAC,gBAAgB,CAAC,EACxC,OAAO,EAAE,kBAAkB,EAC3B,YAAY,EAAE,IAAI,GACjB,aAAa,EAAE,CAyCjB"}

package/dist/collect-vitest-tests.js

@@ -1,7 +1,11 @@
 function describePathFor(test) {
     const path = [];
     let parent = test.parent;
-    while (parent.type === "suite") {
+    const seen = new Set();
+    while (parent?.type === "suite") {
+        if (seen.has(parent))
+            break;
+        seen.add(parent);
         path.unshift(parent.name);
         parent = parent.parent;
     }
@@ -22,7 +26,10 @@ export function collectTestsFromVitestModules(modules, options, runStartedAt) {
     const tests = [];
     const now = new Date().toISOString();
     for (const mod of modules) {
-        for (const test of mod.children.allTests()) {
+        const allTests = mod.children?.allTests?.();
+        if (!allTests)
+            continue;
+        for (const test of allTests) {
             const result = test.result();
             if (result.state === "pending")
                 continue;

package/dist/vitest-reporter.d.ts

@@ -1,21 +1,31 @@
 import type { File } from "@vitest/runner";
-import type { Reporter, TestModule } from "vitest/node";
 import type { NzilaClientOptions } from "./types.js";
 /**
  * Vitest reporter that POSTs one webhook per finished run via {@link sendNzilaRun}.
  * Supports Vitest 3+ (`onTestRunEnd`) and legacy `onFinished` file tasks.
  */
-export default class NzilaVitestReporter implements Reporter {
+export default class NzilaVitestReporter {
     private readonly options;
     private startedAt;
     private sent;
     private readonly runId;
     constructor(options: NzilaClientOptions);
-    onTestRunEnd(testModules: ReadonlyArray<TestModule>): void;
+    onTestRunEnd(testModules: ReadonlyArray<unknown>, _unhandledErrors?: ReadonlyArray<unknown>, _reason?: string): void;
     /** @deprecated Vitest 2 — still invoked in some setups */
-    onFinished(files?: File[], _errors?: unknown[]): void;
+    onFinished(files: File[], _errors: unknown[], _coverage?: unknown): void;
     private sendPayload;
     private walkTasks;
     private mapStatus;
 }
+/** Vitest `reporters` entry — load by package name (works with `pool: forks` / `threads`). */
+export declare const NZILA_VITEST_REPORTER: "@nzila/sdk/vitest";
+export type NzilaVitestReporterEntry = [
+    typeof NZILA_VITEST_REPORTER,
+    NzilaClientOptions
+];
+/**
+ * Returns `['@nzila/sdk/vitest', options]` for `defineConfig({ test: { reporters } })`.
+ * Do **not** use `new NzilaVitestReporter()` in config — worker pools cannot serialize instances.
+ */
+export declare function nzilaVitestReporter(options: NzilaClientOptions): NzilaVitestReporterEntry;
 //# sourceMappingURL=vitest-reporter.d.ts.map

package/dist/vitest-reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vitest-reporter.d.ts","sourceRoot":"","sources":["../src/vitest-reporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAQ,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAKxD,OAAO,KAAK,EAAE,kBAAkB,EAAmD,MAAM,YAAY,CAAC;AAEtG;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ;IAC1D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0C;IAClE,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;gBAEnB,OAAO,EAAE,kBAAkB;IAKvC,YAAY,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC;IAKnD,0DAA0D;IAC1D,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE;YAQhC,WAAW;IA2BzB,OAAO,CAAC,SAAS;IAyCjB,OAAO,CAAC,SAAS;CAMlB"}
+{"version":3,"file":"vitest-reporter.d.ts","sourceRoot":"","sources":["../src/vitest-reporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAQ,MAAM,gBAAgB,CAAC;AAKjD,OAAO,KAAK,EAAE,kBAAkB,EAAmD,MAAM,YAAY,CAAC;AAEtG;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAmB;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0C;IAClE,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;gBAEnB,OAAO,EAAE,kBAAkB;IAKvC,YAAY,CACV,WAAW,EAAE,aAAa,CAAC,OAAO,CAAC,EACnC,gBAAgB,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,EACzC,OAAO,CAAC,EAAE,MAAM;IAUlB,0DAA0D;IAC1D,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,SAAS,CAAC,EAAE,OAAO;YAQnD,WAAW;IA2BzB,OAAO,CAAC,SAAS;IAyCjB,OAAO,CAAC,SAAS;CAMlB;AAED,8FAA8F;AAC9F,eAAO,MAAM,qBAAqB,EAAG,mBAA4B,CAAC;AAElE,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,qBAAqB;IAC5B,kBAAkB;CACnB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,kBAAkB,GAC1B,wBAAwB,CAE1B"}

package/dist/vitest-reporter.js

@@ -13,12 +13,12 @@ export default class NzilaVitestReporter {
         this.options = resolveClientOptions(options);
         this.runId = this.options.runId ?? randomUUID();
     }
-    onTestRunEnd(testModules) {
+    onTestRunEnd(testModules, _unhandledErrors, _reason) {
         const tests = collectTestsFromVitestModules(testModules, this.options, this.startedAt);
         void this.sendPayload(tests);
     }
     /** @deprecated Vitest 2 — still invoked in some setups */
-    onFinished(files, _errors) {
+    onFinished(files, _errors, _coverage) {
         const tests = [];
         for (const file of files ?? []) {
             this.walkTasks(file.tasks, file.name.split("/").slice(0, -1), tests);
@@ -94,3 +94,12 @@ export default class NzilaVitestReporter {
         return "pending";
     }
 }
+/** Vitest `reporters` entry — load by package name (works with `pool: forks` / `threads`). */
+export const NZILA_VITEST_REPORTER = "@nzila/sdk/vitest";
+/**
+ * Returns `['@nzila/sdk/vitest', options]` for `defineConfig({ test: { reporters } })`.
+ * Do **not** use `new NzilaVitestReporter()` in config — worker pools cannot serialize instances.
+ */
+export function nzilaVitestReporter(options) {
+    return [NZILA_VITEST_REPORTER, options];
+}

package/examples/vitest.config.example.ts

@@ -3,13 +3,13 @@
  * Nzila repo uses examples/vitest.config.ts (and backend/frontend-specific configs).
  */
 import { defineConfig } from "vitest/config";
-import NzilaVitestReporter from "@nzila/sdk/vitest";
+import { nzilaVitestReporter } from "@nzila/sdk/vitest";
 
 export default defineConfig({
   test: {
     reporters: [
       "default",
-      new NzilaVitestReporter({
+      nzilaVitestReporter({
         webhookUrl: process.env.NZILA_WEBHOOK_URL ?? "http://localhost:3000/api/webhooks/tests",
         apiKey: process.env.NZILA_API_KEY!,
         appName: process.env.NZILA_APP_NAME ?? "my-app",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nzila/sdk",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Send test runs to Nzila, trace live feature errors, and onboard via npx @nzila/sdk.",
   "type": "module",
   "license": "MIT",

package/vitest.d.ts

@@ -1,2 +1,19 @@
-export { default } from "./dist/vitest-reporter.js";
+import type { NzilaClientOptions } from "./dist/types.js";
+
+export const NZILA_VITEST_REPORTER: "@nzila/sdk/vitest";
+
+export type NzilaVitestReporterEntry = [typeof NZILA_VITEST_REPORTER, NzilaClientOptions];
+
+/** Use in `reporters: ["default", nzilaVitestReporter({ ... })]` — not `new NzilaVitestReporter()`. */
+export function nzilaVitestReporter(
+  options: NzilaClientOptions,
+): NzilaVitestReporterEntry;
+
+/** @see nzilaVitestReporter — default export is the reporter class (loaded by Vitest from the tuple). */
+declare class NzilaVitestReporter {
+  constructor(options: NzilaClientOptions);
+}
+
+export default NzilaVitestReporter;
+
 export * from "./dist/vitest-reporter.js";