@evolu/vitest 2.0.0 → 2.0.2

package/README.md

@@ -2,7 +2,12 @@
 
 Vitest assertions for Evolu.
 
+Evolu uses `node:test` with the platform-agnostic assertions from
+`@evolu/common` for Node-only unit and integration tests. This package remains
+available for projects that use Vitest and want Result assertions with Vitest
+semantics.
+
 ## Documentation
 
-For detailed information and usage examples, please visit
-[evolu.dev](https://www.evolu.dev).
+See Evolu's [testing convention](https://www.evolu.dev/docs/testing) for runner
+and assertion guidance.

package/dist/src/BrowserConfig.d.ts

@@ -1,5 +1,4 @@
-declare const allBrowserNames: readonly ["chromium", "firefox", "webkit"];
-type BrowserName = (typeof allBrowserNames)[number];
+type BrowserName = "chromium" | "firefox" | "webkit";
 interface BrowserInstance {
     readonly browser: BrowserName;
 }

package/dist/src/BrowserConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserConfig.d.ts","sourceRoot":"","sources":["../../src/BrowserConfig.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,eAAe,YAAI,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAU,CAAC;AAEnE,KAAK,WAAW,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpD,UAAU,eAAe;IACvB,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;CAC/B;AAaD,eAAO,MAAM,sBAAsB,wBAGhC;IACD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,KAAG,KAAK,CAAC,eAAe,CAIU,CAAC"}
+{"version":3,"file":"BrowserConfig.d.ts","sourceRoot":"","sources":["../../src/BrowserConfig.ts"],"names":[],"mappings":"AAAA,KAAK,WAAW,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC;AAErD,UAAU,eAAe;IACvB,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;CAC/B;AAkBD,eAAO,MAAM,sBAAsB,wBAGhC;IACD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,KAAG,KAAK,CAAC,eAAe,CAIU,CAAC"}

package/dist/src/BrowserConfig.js

@@ -1,11 +1,15 @@
-const allBrowserNames = ["chromium", "firefox", "webkit"];
 // V8 coverage only works with Chromium.
 const chromiumBrowserNames = ["chromium"];
+const compatibilityBrowserNames = [
+    "firefox",
+    "webkit",
+];
 const browserNamesByMode = {
+    chromium: ["chromium"],
     firefox: ["firefox"],
     webkit: ["webkit"],
     "firefox-webkit": ["firefox", "webkit"],
 };
 export const createBrowserInstances = ({ coverage, mode, }) => (coverage
     ? chromiumBrowserNames
-    : (browserNamesByMode[mode] ?? allBrowserNames)).map((browser) => ({ browser }));
+    : (browserNamesByMode[mode] ?? compatibilityBrowserNames)).map((browser) => ({ browser }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evolu/vitest",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Vitest assertions for Evolu",
   "keywords": [
     "evolu",
@@ -26,24 +26,25 @@
   },
   "files": [
     "dist/src/**",
+    "!dist/**/*.test.*",
     "src/**",
     "README.md"
   ],
   "devDependencies": {
-    "@evolu/common": "8.6.0",
-    "@evolu/typescript-config": "0.1.0",
+    "@evolu/common": "8.10.0",
+    "@evolu/typescript-config": "0.1.1",
     "@typescript/native": "npm:typescript@^7.0.2",
     "vitest": "^4.1.11"
   },
   "peerDependencies": {
-    "@evolu/common": "^8.0.0",
+    "@evolu/common": "^8.10.0",
     "vitest": "^4.1.2"
   },
   "publishConfig": {
     "access": "public"
   },
   "engines": {
-    "node": ">=24.0.0"
+    "node": ">=24.20.0"
   },
   "sideEffects": false,
   "scripts": {

package/src/BrowserConfig.test.ts

@@ -0,0 +1,34 @@
+import { assertEqual } from "@evolu/common";
+import { describe, it } from "node:test";
+import { createBrowserInstances } from "./BrowserConfig.ts";
+
+describe("createBrowserInstances", () => {
+  it("uses Chromium for coverage", () => {
+    assertEqual(createBrowserInstances({ coverage: true, mode: "" }), [
+      { browser: "chromium" },
+    ]);
+  });
+
+  it("defaults to Firefox and WebKit without coverage", () => {
+    assertEqual(createBrowserInstances({ coverage: false, mode: "" }), [
+      { browser: "firefox" },
+      { browser: "webkit" },
+    ]);
+  });
+
+  it("selects browsers by mode", () => {
+    assertEqual(createBrowserInstances({ coverage: false, mode: "chromium" }), [
+      { browser: "chromium" },
+    ]);
+    assertEqual(createBrowserInstances({ coverage: false, mode: "firefox" }), [
+      { browser: "firefox" },
+    ]);
+    assertEqual(createBrowserInstances({ coverage: false, mode: "webkit" }), [
+      { browser: "webkit" },
+    ]);
+    assertEqual(
+      createBrowserInstances({ coverage: false, mode: "firefox-webkit" }),
+      [{ browser: "firefox" }, { browser: "webkit" }],
+    );
+  });
+});

package/src/BrowserConfig.ts

@@ -1,6 +1,4 @@
-const allBrowserNames = ["chromium", "firefox", "webkit"] as const;
-
-type BrowserName = (typeof allBrowserNames)[number];
+type BrowserName = "chromium" | "firefox" | "webkit";
 
 interface BrowserInstance {
   readonly browser: BrowserName;
@@ -8,10 +6,15 @@ interface BrowserInstance {
 
 // V8 coverage only works with Chromium.
 const chromiumBrowserNames: ReadonlyArray<BrowserName> = ["chromium"];
+const compatibilityBrowserNames: ReadonlyArray<BrowserName> = [
+  "firefox",
+  "webkit",
+];
 
 const browserNamesByMode: Readonly<
   Record<string, ReadonlyArray<BrowserName> | undefined>
 > = {
+  chromium: ["chromium"],
   firefox: ["firefox"],
   webkit: ["webkit"],
   "firefox-webkit": ["firefox", "webkit"],
@@ -26,5 +29,5 @@ export const createBrowserInstances = ({
 }): Array<BrowserInstance> =>
   (coverage
     ? chromiumBrowserNames
-    : (browserNamesByMode[mode] ?? allBrowserNames)
+    : (browserNamesByMode[mode] ?? compatibilityBrowserNames)
   ).map((browser) => ({ browser }));

package/src/index.test.ts

@@ -0,0 +1,74 @@
+import {
+  assertThrowsInstanceOf,
+  assertType,
+  err,
+  type Err,
+  ok,
+  type Ok,
+  type Result,
+} from "@evolu/common";
+import { describe, it } from "node:test";
+import { expectErr, expectOk } from "./index.ts";
+
+const createOkResult = (): Result<number, string> => ok(42);
+const createErrResult = (): Result<number, string> => err("error");
+
+describe("expectOk", () => {
+  it("accepts an Ok and narrows the Result", () => {
+    const result = createOkResult();
+
+    expectOk(result, 42);
+
+    assertType<typeof result, Ok<number>>();
+  });
+
+  it("rejects an Err", () => {
+    assertThrowsInstanceOf(() => expectOk(createErrResult(), 42), Error);
+  });
+
+  it("rejects an unexpected value", () => {
+    assertThrowsInstanceOf(() => expectOk(createOkResult(), 41), Error);
+  });
+
+  it("narrows a heterogeneous Result union", () => {
+    const createResult = ():
+      Result<number, "NumberError"> | Result<string, "StringError"> => ok(42);
+    const result = createResult();
+
+    expectOk(result, 42);
+
+    assertType<typeof result, Ok<number> | Ok<string>>();
+  });
+});
+
+describe("expectErr", () => {
+  it("accepts an Err and narrows the Result", () => {
+    const result = createErrResult();
+
+    expectErr(result, "error");
+
+    assertType<typeof result, Err<string>>();
+  });
+
+  it("rejects an Ok", () => {
+    assertThrowsInstanceOf(() => expectErr(createOkResult(), "error"), Error);
+  });
+
+  it("rejects an unexpected error", () => {
+    assertThrowsInstanceOf(
+      () => expectErr(createErrResult(), "another error"),
+      Error,
+    );
+  });
+
+  it("narrows a heterogeneous Result union", () => {
+    const createResult = ():
+      Result<number, "NumberError"> | Result<string, "StringError"> =>
+      err("NumberError");
+    const result = createResult();
+
+    expectErr(result, "NumberError");
+
+    assertType<typeof result, Err<"NumberError"> | Err<"StringError">>();
+  });
+});