@clipboard-health/testing-core 0.17.1 → 0.18.0

package/README.md

@@ -37,7 +37,7 @@ This library's helpers narrow types:
 <embedex source="packages/testing-core/examples/expectToBeDefined.ts">
 
 ```ts
-import { ok } from "node:assert/strict";
+import { strictEqual } from "node:assert/strict";
 
 import { expectToBeDefined } from "@clipboard-health/testing-core";
 
@@ -50,7 +50,7 @@ expectToBeDefined(value);
 
 // Narrowed to `string`
 const { length } = value;
-ok(length === 2);
+strictEqual(length, 2);
 ```
 
 </embedex>
@@ -58,7 +58,7 @@ ok(length === 2);
 <embedex source="packages/testing-core/examples/expectToBeLeft.ts">
 
 ```ts
-import { ok } from "node:assert/strict";
+import { strictEqual } from "node:assert/strict";
 
 import { expectToBeLeft } from "@clipboard-health/testing-core";
 import { either as E } from "@clipboard-health/util-ts";
@@ -75,7 +75,7 @@ const value = divide(10, 0);
 expectToBeLeft(value);
 
 // Narrowed to Left
-ok(value.left === "Cannot divide by zero");
+strictEqual(value.left, "Cannot divide by zero");
 ```
 
 </embedex>
@@ -83,7 +83,7 @@ ok(value.left === "Cannot divide by zero");
 <embedex source="packages/testing-core/examples/expectToBeRight.ts">
 
 ```ts
-import { ok } from "node:assert/strict";
+import { strictEqual } from "node:assert/strict";
 
 import { expectToBeRight } from "@clipboard-health/testing-core";
 import { either as E } from "@clipboard-health/util-ts";
@@ -100,7 +100,57 @@ const value = divide(10, 2);
 expectToBeRight(value);
 
 // Narrowed to Right
-ok(value.right === 5);
+strictEqual(value.right, 5);
+```
+
+</embedex>
+
+<embedex source="packages/testing-core/examples/expectToBeFailure.ts">
+
+```ts
+import { strictEqual } from "node:assert/strict";
+
+import { expectToBeFailure } from "@clipboard-health/testing-core";
+import { failure, type ServiceResult, success } from "@clipboard-health/util-ts";
+
+function validateAge(age: number): ServiceResult<number> {
+  if (age < 0) {
+    return failure({ issues: [{ code: "INVALID_AGE", message: "Age cannot be negative" }] });
+  }
+
+  return success(age);
+}
+
+const result = validateAge(-5);
+expectToBeFailure(result);
+
+// Narrowed to Left (Failure)
+strictEqual(result.left.issues[0]?.message, "Age cannot be negative");
+```
+
+</embedex>
+
+<embedex source="packages/testing-core/examples/expectToBeSuccess.ts">
+
+```ts
+import { strictEqual } from "node:assert/strict";
+
+import { expectToBeSuccess } from "@clipboard-health/testing-core";
+import { failure, type ServiceResult, success } from "@clipboard-health/util-ts";
+
+function validateAge(age: number): ServiceResult<number> {
+  if (age < 0) {
+    return failure({ issues: [{ code: "INVALID_AGE", message: "Age cannot be negative" }] });
+  }
+
+  return success(age);
+}
+
+const result = validateAge(25);
+expectToBeSuccess(result);
+
+// Narrowed to Right (Success)
+strictEqual(result.right, 25);
 ```
 
 </embedex>
@@ -108,7 +158,7 @@ ok(value.right === 5);
 <embedex source="packages/testing-core/examples/expectToBeSafeParseError.ts">
 
 ```ts
-import { ok } from "node:assert/strict";
+import { strictEqual } from "node:assert/strict";
 
 import { expectToBeDefined, expectToBeSafeParseError } from "@clipboard-health/testing-core";
 import { z } from "zod";
@@ -123,7 +173,7 @@ const firstIssue = value.error.issues[0];
 expectToBeDefined(firstIssue);
 
 // Narrowed to `ZodIssue`
-ok(firstIssue.message === "Expected string, received number");
+strictEqual(firstIssue.message, "Expected string, received number");
 ```
 
 </embedex>
@@ -131,7 +181,7 @@ ok(firstIssue.message === "Expected string, received number");
 <embedex source="packages/testing-core/examples/expectToBeSafeParseSuccess.ts">
 
 ```ts
-import { ok } from "node:assert/strict";
+import { strictEqual } from "node:assert/strict";
 
 import { expectToBeSafeParseSuccess } from "@clipboard-health/testing-core";
 import { z } from "zod";
@@ -142,7 +192,7 @@ const value = schema.safeParse({ name: "hi" });
 expectToBeSafeParseSuccess(value);
 
 // Narrowed to `SafeParseSuccess`
-ok(value.data.name === "hi");
+strictEqual(value.data.name, "hi");
 ```
 
 </embedex>

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@clipboard-health/testing-core",
   "description": "TypeScript-friendly testing utilities.",
-  "version": "0.17.1",
+  "version": "0.18.0",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "dependencies": {
-    "@clipboard-health/util-ts": "3.8.1",
+    "@clipboard-health/util-ts": "3.9.0",
     "tslib": "2.8.1"
   },
   "devDependencies": {

package/src/index.d.ts

@@ -1,5 +1,7 @@
 export * from "./lib/expectToBeDefined";
+export * from "./lib/expectToBeFailure";
 export * from "./lib/expectToBeLeft";
 export * from "./lib/expectToBeRight";
 export * from "./lib/expectToBeSafeParseError";
 export * from "./lib/expectToBeSafeParseSuccess";
+export * from "./lib/expectToBeSuccess";

package/src/index.js

@@ -2,8 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./lib/expectToBeDefined"), exports);
+tslib_1.__exportStar(require("./lib/expectToBeFailure"), exports);
 tslib_1.__exportStar(require("./lib/expectToBeLeft"), exports);
 tslib_1.__exportStar(require("./lib/expectToBeRight"), exports);
 tslib_1.__exportStar(require("./lib/expectToBeSafeParseError"), exports);
 tslib_1.__exportStar(require("./lib/expectToBeSafeParseSuccess"), exports);
+tslib_1.__exportStar(require("./lib/expectToBeSuccess"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/testing-core/src/index.ts"],"names":[],"mappings":";;;AAAA,kEAAwC;AACxC,+DAAqC;AACrC,gEAAsC;AACtC,yEAA+C;AAC/C,2EAAiD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/testing-core/src/index.ts"],"names":[],"mappings":";;;AAAA,kEAAwC;AACxC,kEAAwC;AACxC,+DAAqC;AACrC,gEAAsC;AACtC,yEAA+C;AAC/C,2EAAiD;AACjD,kEAAwC"}

package/src/lib/expectToBeFailure.d.ts

@@ -0,0 +1,5 @@
+import { type either as E, type Failure, type ServiceError, type ServiceResult } from "@clipboard-health/util-ts";
+/**
+ * Alias for {@link expectToBeLeft}
+ */
+export declare function expectToBeFailure<A>(value: ServiceResult<A> | undefined): asserts value is E.Left<ServiceError> & Failure<ServiceError>;

package/src/lib/expectToBeFailure.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectToBeFailure = expectToBeFailure;
+const strict_1 = require("node:assert/strict");
+const util_ts_1 = require("@clipboard-health/util-ts");
+const expectToBeLeft_1 = require("./expectToBeLeft");
+/**
+ * Alias for {@link expectToBeLeft}
+ */
+function expectToBeFailure(value) {
+    (0, expectToBeLeft_1.expectToBeLeft)(value);
+    (0, strict_1.ok)((0, util_ts_1.isFailure)(value));
+}
+//# sourceMappingURL=expectToBeFailure.js.map

package/src/lib/expectToBeFailure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expectToBeFailure.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeFailure.ts"],"names":[],"mappings":";;AAeA,8CAKC;AApBD,+CAAwC;AAExC,uDAMmC;AAEnC,qDAAkD;AAElD;;GAEG;AACH,SAAgB,iBAAiB,CAC/B,KAAmC;IAEnC,IAAA,+BAAc,EAAC,KAAK,CAAC,CAAC;IACtB,IAAA,WAAE,EAAC,IAAA,mBAAS,EAAC,KAAK,CAAC,CAAC,CAAC;AACvB,CAAC"}

package/src/lib/expectToBeSuccess.d.ts

@@ -0,0 +1,5 @@
+import { type either as E, type ServiceResult, type Success } from "@clipboard-health/util-ts";
+/**
+ * Alias for {@link expectToBeRight}
+ */
+export declare function expectToBeSuccess<A>(value: ServiceResult<A> | undefined): asserts value is E.Right<A> & Success<A>;

package/src/lib/expectToBeSuccess.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectToBeSuccess = expectToBeSuccess;
+const strict_1 = require("node:assert/strict");
+const util_ts_1 = require("@clipboard-health/util-ts");
+const expectToBeRight_1 = require("./expectToBeRight");
+/**
+ * Alias for {@link expectToBeRight}
+ */
+function expectToBeSuccess(value) {
+    (0, expectToBeRight_1.expectToBeRight)(value);
+    (0, strict_1.ok)((0, util_ts_1.isSuccess)(value));
+}
+//# sourceMappingURL=expectToBeSuccess.js.map

package/src/lib/expectToBeSuccess.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expectToBeSuccess.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeSuccess.ts"],"names":[],"mappings":";;AAcA,8CAKC;AAnBD,+CAAwC;AAExC,uDAKmC;AAEnC,uDAAoD;AAEpD;;GAEG;AACH,SAAgB,iBAAiB,CAC/B,KAAmC;IAEnC,IAAA,iCAAe,EAAC,KAAK,CAAC,CAAC;IACvB,IAAA,WAAE,EAAC,IAAA,mBAAS,EAAC,KAAK,CAAC,CAAC,CAAC;AACvB,CAAC"}