@strictly/vitest 0.0.0-stage → 0.0.41

package/README.md

@@ -1,3 +1,19 @@
-# Temporary Holding Version
+# @strictly/vitest
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Vitest assertions that narrow types, so tests can carry on without casts or non-null assertions.
+
+```ts
+import { expectDefined } from '@strictly/vitest'
+
+const user = users.find(({ id }) => id === 1)
+expectDefined(user)
+expect(user.name).toBe('Ada')
+```
+
+- `expectDefined(v)` and `expectDefinedAndReturn(v)` narrow away `null` and `undefined`
+- `expectEquals(v1, v2)` narrows `v1` to the type of `v2`
+- `expectInstanceOf(v, Class)` narrows `v` to an instance of `Class`
+- `expectTruthy(b)` narrows `b` to `true`
+- `expectPendingPromise(p)` asserts that `p` has not settled within a timeout
+
+The same assertions, backed by `storybook/test`, are exported from `@strictly/storybook` for use in story play functions.

package/dist/index.cjs

@@ -0,0 +1,35 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let vitest = require("vitest");
+//#region src/expect.ts
+function expectEquals(v1, v2) {
+	(0, vitest.expect)(v1).toEqual(v2);
+}
+function expectTruthy(b) {
+	(0, vitest.expect)(b).toBeTruthy();
+}
+function expectDefined(v) {
+	(0, vitest.expect)(v).toBeDefined();
+}
+function expectInstanceOf(instance, constructor) {
+	(0, vitest.expect)(instance).toBeInstanceOf(constructor);
+}
+function expectDefinedAndReturn(v) {
+	expectDefined(v);
+	return v;
+}
+function pendingAfter(milliseconds) {
+	return new Promise((resolve) => {
+		setTimeout(() => resolve("pending"), milliseconds);
+	});
+}
+async function expectPendingPromise(p, timeoutMilliseconds = 500) {
+	const state = await Promise.race([p.then(() => "fulfilled", () => "rejected"), pendingAfter(timeoutMilliseconds)]);
+	(0, vitest.expect)(state).toBe("pending");
+}
+//#endregion
+exports.expectDefined = expectDefined;
+exports.expectDefinedAndReturn = expectDefinedAndReturn;
+exports.expectEquals = expectEquals;
+exports.expectInstanceOf = expectInstanceOf;
+exports.expectPendingPromise = expectPendingPromise;
+exports.expectTruthy = expectTruthy;

package/dist/index.d.cts

@@ -0,0 +1,13 @@
+export declare function expectDefined<V>(v: V): asserts v is NonNullable<V>;
+
+export declare function expectDefinedAndReturn<V>(v: V): NonNullable<V>;
+
+export declare function expectEquals<V1, V2 extends V1>(v1: V1, v2: V2): asserts v1 is V2;
+
+export declare function expectInstanceOf<V1, V2 extends V1>(instance: V1, constructor: abstract new (...args: never[]) => V2): asserts instance is V2;
+
+export declare function expectPendingPromise<V>(p: Promise<V>, timeoutMilliseconds?: number): Promise<void>;
+
+export declare function expectTruthy(b: boolean): asserts b is true;
+
+export { }

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+export declare function expectDefined<V>(v: V): asserts v is NonNullable<V>;
+
+export declare function expectDefinedAndReturn<V>(v: V): NonNullable<V>;
+
+export declare function expectEquals<V1, V2 extends V1>(v1: V1, v2: V2): asserts v1 is V2;
+
+export declare function expectInstanceOf<V1, V2 extends V1>(instance: V1, constructor: abstract new (...args: never[]) => V2): asserts instance is V2;
+
+export declare function expectPendingPromise<V>(p: Promise<V>, timeoutMilliseconds?: number): Promise<void>;
+
+export declare function expectTruthy(b: boolean): asserts b is true;
+
+export { }

package/dist/index.js

@@ -0,0 +1,29 @@
+import { expect } from "vitest";
+//#region src/expect.ts
+function expectEquals(v1, v2) {
+	expect(v1).toEqual(v2);
+}
+function expectTruthy(b) {
+	expect(b).toBeTruthy();
+}
+function expectDefined(v) {
+	expect(v).toBeDefined();
+}
+function expectInstanceOf(instance, constructor) {
+	expect(instance).toBeInstanceOf(constructor);
+}
+function expectDefinedAndReturn(v) {
+	expectDefined(v);
+	return v;
+}
+function pendingAfter(milliseconds) {
+	return new Promise((resolve) => {
+		setTimeout(() => resolve("pending"), milliseconds);
+	});
+}
+async function expectPendingPromise(p, timeoutMilliseconds = 500) {
+	const state = await Promise.race([p.then(() => "fulfilled", () => "rejected"), pendingAfter(timeoutMilliseconds)]);
+	expect(state).toBe("pending");
+}
+//#endregion
+export { expectDefined, expectDefinedAndReturn, expectEquals, expectInstanceOf, expectPendingPromise, expectTruthy };

package/package.json

@@ -1,6 +1,51 @@
 {
+  "author": "Chris <chris.glover@gmail.com> (@madmaw)",
+  "description": "Vitest assertion helpers that narrow types",
+  "devDependencies": {
+    "vite-plus": "1.0.0",
+    "vitest": "5.0.1",
+    "@strictly/typescript": "0.0.41",
+    "@strictly/vite": "0.0.41"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/madmaw/strictly/tree/main/support/vitest",
+  "keywords": [
+    "vitest"
+  ],
+  "license": "MIT",
+  "main": "./dist/index.js",
   "name": "@strictly/vitest",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "peerDependencies": {
+    "vitest": "^5.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "directory": "support/vitest",
+    "type": "git",
+    "url": "git+https://github.com/madmaw/strictly.git"
+  },
+  "type": "module",
+  "version": "0.0.41",
+  "scripts": {
+    "build": "vp build --configLoader runner",
+    "check-types": "tsc -b",
+    "clean": "del-cli dist .out"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "types": "./dist/index.d.ts"
 }