@clipboard-health/testing-core 0.3.1 → 0.4.0

package/README.md

@@ -62,14 +62,14 @@ ok(length === 2);
 import { ok } from "node:assert/strict";
 
 import { expectToBeLeft } from "@clipboard-health/testing-core";
-import { type Either, left, right } from "@clipboard-health/util-typescript";
+import { either as E } from "@clipboard-health/util-typescript";
 
-function divide(numerator: number, denominator: number): Either<string, number> {
+function divide(numerator: number, denominator: number): E.Either<string, number> {
   if (denominator === 0) {
-    return left("Cannot divide by zero");
+    return E.left("Cannot divide by zero");
   }
 
-  return right(numerator / denominator);
+  return E.right(numerator / denominator);
 }
 
 const value = divide(10, 0);
@@ -87,14 +87,14 @@ ok(value.left === "Cannot divide by zero");
 import { ok } from "node:assert/strict";
 
 import { expectToBeRight } from "@clipboard-health/testing-core";
-import { type Either, left, right } from "@clipboard-health/util-typescript";
+import { either as E } from "@clipboard-health/util-typescript";
 
-function divide(numerator: number, denominator: number): Either<string, number> {
+function divide(numerator: number, denominator: number): E.Either<string, number> {
   if (denominator === 0) {
-    return left("Cannot divide by zero");
+    return E.left("Cannot divide by zero");
   }
 
-  return right(numerator / denominator);
+  return E.right(numerator / denominator);
 }
 
 const value = divide(10, 2);

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@clipboard-health/testing-core",
   "description": "TypeScript-friendly testing utilities.",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "dependencies": {
-    "@clipboard-health/util-typescript": "0.1.1",
+    "@clipboard-health/util-typescript": "0.2.0",
     "tslib": "2.8.0",
     "zod": "3.23.8"
   },

package/src/lib/expectToBeDefined.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.expectToBeDefined = expectToBeDefined;
-const node_assert_1 = require("node:assert");
+const strict_1 = require("node:assert/strict");
 /**
  * Asserts and narrows the type for defined values.
  *
  * @throws {AssertionError} for null or undefined values.
  */
 function expectToBeDefined(value) {
-    (0, node_assert_1.ok)(value !== undefined && value !== null, "Expected value to be defined, got null or undefined");
+    (0, strict_1.ok)(value !== undefined && value !== null, "Expected value to be defined, got null or undefined");
 }
 //# sourceMappingURL=expectToBeDefined.js.map

package/src/lib/expectToBeDefined.js.map

@@ -1 +1 @@
-{"version":3,"file":"expectToBeDefined.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeDefined.ts"],"names":[],"mappings":";;AAOA,8CAEC;AATD,6CAAiC;AAEjC;;;;GAIG;AACH,SAAgB,iBAAiB,CAAI,KAAoB;IACvD,IAAA,gBAAE,EAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,qDAAqD,CAAC,CAAC;AACnG,CAAC"}
+{"version":3,"file":"expectToBeDefined.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeDefined.ts"],"names":[],"mappings":";;AAOA,8CAEC;AATD,+CAAwC;AAExC;;;;GAIG;AACH,SAAgB,iBAAiB,CAAI,KAAoB;IACvD,IAAA,WAAE,EAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,qDAAqD,CAAC,CAAC;AACnG,CAAC"}

package/src/lib/expectToBeLeft.d.ts

@@ -1,2 +1,7 @@
-import { type Either, type Left } from "@clipboard-health/util-typescript";
-export declare function expectToBeLeft<E, A>(value: Either<E, A> | undefined): asserts value is Left<E>;
+import { either as E } from "@clipboard-health/util-typescript";
+/**
+ * Asserts and narrows the type of the provided Either value to Left.
+ * @param value - The Either value to check
+ * @throws {AssertionError} If the value is undefined or not a Left
+ */
+export declare function expectToBeLeft<E, A>(value: E.Either<E, A> | undefined): asserts value is E.Left<E>;

package/src/lib/expectToBeLeft.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.expectToBeLeft = expectToBeLeft;
-const node_assert_1 = require("node:assert");
+const strict_1 = require("node:assert/strict");
 const util_typescript_1 = require("@clipboard-health/util-typescript");
 const expectToBeDefined_1 = require("./expectToBeDefined");
+/**
+ * Asserts and narrows the type of the provided Either value to Left.
+ * @param value - The Either value to check
+ * @throws {AssertionError} If the value is undefined or not a Left
+ */
 function expectToBeLeft(value) {
     (0, expectToBeDefined_1.expectToBeDefined)(value);
-    (0, node_assert_1.ok)((0, util_typescript_1.isLeft)(value));
+    (0, strict_1.ok)(util_typescript_1.either.isLeft(value));
 }
 //# sourceMappingURL=expectToBeLeft.js.map

package/src/lib/expectToBeLeft.js.map

@@ -1 +1 @@
-{"version":3,"file":"expectToBeLeft.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeLeft.ts"],"names":[],"mappings":";;AAMA,wCAGC;AATD,6CAAiC;AAEjC,uEAAmF;AAEnF,2DAAwD;AAExD,SAAgB,cAAc,CAAO,KAA+B;IAClE,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,gBAAE,EAAC,IAAA,wBAAM,EAAC,KAAK,CAAC,CAAC,CAAC;AACpB,CAAC"}
+{"version":3,"file":"expectToBeLeft.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeLeft.ts"],"names":[],"mappings":";;AAWA,wCAKC;AAhBD,+CAAwC;AAExC,uEAAgE;AAEhE,2DAAwD;AAExD;;;;GAIG;AACH,SAAgB,cAAc,CAC5B,KAAiC;IAEjC,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,WAAE,EAAC,wBAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACtB,CAAC"}

package/src/lib/expectToBeNone.d.ts

@@ -1,2 +1,7 @@
-import { type None, type Option } from "@clipboard-health/util-typescript";
-export declare function expectToBeNone<A>(value: Option<A> | undefined): asserts value is None;
+import { option as O } from "@clipboard-health/util-typescript";
+/**
+ * Asserts and narrows the type of the provided Option value to None.
+ * @param value - The Option value to check
+ * @throws {AssertionError} If the value is undefined or not a None
+ */
+export declare function expectToBeNone<A>(value: O.Option<A> | undefined): asserts value is O.None;

package/src/lib/expectToBeNone.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.expectToBeNone = expectToBeNone;
-const node_assert_1 = require("node:assert");
+const strict_1 = require("node:assert/strict");
 const util_typescript_1 = require("@clipboard-health/util-typescript");
 const expectToBeDefined_1 = require("./expectToBeDefined");
+/**
+ * Asserts and narrows the type of the provided Option value to None.
+ * @param value - The Option value to check
+ * @throws {AssertionError} If the value is undefined or not a None
+ */
 function expectToBeNone(value) {
     (0, expectToBeDefined_1.expectToBeDefined)(value);
-    (0, node_assert_1.ok)((0, util_typescript_1.isNone)(value));
+    (0, strict_1.ok)(util_typescript_1.option.isNone(value));
 }
 //# sourceMappingURL=expectToBeNone.js.map

package/src/lib/expectToBeNone.js.map

@@ -1 +1 @@
-{"version":3,"file":"expectToBeNone.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeNone.ts"],"names":[],"mappings":";;AAMA,wCAGC;AATD,6CAAiC;AAEjC,uEAAmF;AAEnF,2DAAwD;AAExD,SAAgB,cAAc,CAAI,KAA4B;IAC5D,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,gBAAE,EAAC,IAAA,wBAAM,EAAC,KAAK,CAAC,CAAC,CAAC;AACpB,CAAC"}
+{"version":3,"file":"expectToBeNone.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeNone.ts"],"names":[],"mappings":";;AAWA,wCAGC;AAdD,+CAAwC;AAExC,uEAAgE;AAEhE,2DAAwD;AAExD;;;;GAIG;AACH,SAAgB,cAAc,CAAI,KAA8B;IAC9D,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,WAAE,EAAC,wBAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACtB,CAAC"}

package/src/lib/expectToBeRight.d.ts

@@ -1,2 +1,7 @@
-import { type Either, type Right } from "@clipboard-health/util-typescript";
-export declare function expectToBeRight<A, E>(value: Either<E, A> | undefined): asserts value is Right<A>;
+import { either as E } from "@clipboard-health/util-typescript";
+/**
+ * Asserts and narrows the type of the provided Either value to Right.
+ * @param value - The Either value to check
+ * @throws {AssertionError} If the value is undefined or not a Right
+ */
+export declare function expectToBeRight<A, E>(value: E.Either<E, A> | undefined): asserts value is E.Right<A>;

package/src/lib/expectToBeRight.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.expectToBeRight = expectToBeRight;
-const node_assert_1 = require("node:assert");
+const strict_1 = require("node:assert/strict");
 const util_typescript_1 = require("@clipboard-health/util-typescript");
 const expectToBeDefined_1 = require("./expectToBeDefined");
+/**
+ * Asserts and narrows the type of the provided Either value to Right.
+ * @param value - The Either value to check
+ * @throws {AssertionError} If the value is undefined or not a Right
+ */
 function expectToBeRight(value) {
     (0, expectToBeDefined_1.expectToBeDefined)(value);
-    (0, node_assert_1.ok)((0, util_typescript_1.isRight)(value));
+    (0, strict_1.ok)(util_typescript_1.either.isRight(value));
 }
 //# sourceMappingURL=expectToBeRight.js.map

package/src/lib/expectToBeRight.js.map

@@ -1 +1 @@
-{"version":3,"file":"expectToBeRight.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeRight.ts"],"names":[],"mappings":";;AAMA,0CAGC;AATD,6CAAiC;AAEjC,uEAAqF;AAErF,2DAAwD;AAExD,SAAgB,eAAe,CAAO,KAA+B;IACnE,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,gBAAE,EAAC,IAAA,yBAAO,EAAC,KAAK,CAAC,CAAC,CAAC;AACrB,CAAC"}
+{"version":3,"file":"expectToBeRight.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeRight.ts"],"names":[],"mappings":";;AAWA,0CAKC;AAhBD,+CAAwC;AAExC,uEAAgE;AAEhE,2DAAwD;AAExD;;;;GAIG;AACH,SAAgB,eAAe,CAC7B,KAAiC;IAEjC,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,WAAE,EAAC,wBAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AACvB,CAAC"}

package/src/lib/expectToBeSafeParseError.d.ts

@@ -1,7 +1,7 @@
 import { type SafeParseError, type SafeParseReturnType } from "zod";
 /**
  * Asserts and narrows the type for Zod SafeParseReturnType to a SafeParseError.
- *
+ * @param value - The SafeParseReturnType value to check
  * @throws {AssertionError} for SafeParseSuccess.
  */
 export declare function expectToBeSafeParseError<Input, Output>(value: Readonly<SafeParseReturnType<Input, Output>>): asserts value is SafeParseError<Input>;

package/src/lib/expectToBeSafeParseError.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.expectToBeSafeParseError = expectToBeSafeParseError;
-const node_assert_1 = require("node:assert");
+const strict_1 = require("node:assert/strict");
 const expectToBeDefined_1 = require("./expectToBeDefined");
 /**
  * Asserts and narrows the type for Zod SafeParseReturnType to a SafeParseError.
- *
+ * @param value - The SafeParseReturnType value to check
  * @throws {AssertionError} for SafeParseSuccess.
  */
 function expectToBeSafeParseError(value) {
     (0, expectToBeDefined_1.expectToBeDefined)(value);
-    (0, node_assert_1.ok)(!value.success, "Expected SafeParseError, got SafeParseSuccess");
+    (0, strict_1.ok)(!value.success, "Expected SafeParseError, got SafeParseSuccess");
 }
 //# sourceMappingURL=expectToBeSafeParseError.js.map

package/src/lib/expectToBeSafeParseError.js.map

@@ -1 +1 @@
-{"version":3,"file":"expectToBeSafeParseError.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeSafeParseError.ts"],"names":[],"mappings":";;AAWA,4DAKC;AAhBD,6CAAiC;AAIjC,2DAAwD;AAExD;;;;GAIG;AACH,SAAgB,wBAAwB,CACtC,KAAmD;IAEnD,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,gBAAE,EAAC,CAAC,KAAK,CAAC,OAAO,EAAE,+CAA+C,CAAC,CAAC;AACtE,CAAC"}
+{"version":3,"file":"expectToBeSafeParseError.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeSafeParseError.ts"],"names":[],"mappings":";;AAWA,4DAKC;AAhBD,+CAAwC;AAIxC,2DAAwD;AAExD;;;;GAIG;AACH,SAAgB,wBAAwB,CACtC,KAAmD;IAEnD,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,WAAE,EAAC,CAAC,KAAK,CAAC,OAAO,EAAE,+CAA+C,CAAC,CAAC;AACtE,CAAC"}

package/src/lib/expectToBeSafeParseSuccess.d.ts

@@ -1,7 +1,7 @@
 import { type SafeParseReturnType, type SafeParseSuccess } from "zod";
 /**
  * Asserts and narrows the type for Zod SafeParseReturnType to a SafeParseSuccess.
- *
+ * @param value - The SafeParseReturnType value to check
  * @throws {AssertionError} for SafeParseError.
  */
 export declare function expectToBeSafeParseSuccess<Input, Output>(value: Readonly<SafeParseReturnType<Input, Output>>): asserts value is SafeParseSuccess<Output>;

package/src/lib/expectToBeSafeParseSuccess.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.expectToBeSafeParseSuccess = expectToBeSafeParseSuccess;
-const node_assert_1 = require("node:assert");
+const strict_1 = require("node:assert/strict");
 const expectToBeDefined_1 = require("./expectToBeDefined");
 /**
  * Asserts and narrows the type for Zod SafeParseReturnType to a SafeParseSuccess.
- *
+ * @param value - The SafeParseReturnType value to check
  * @throws {AssertionError} for SafeParseError.
  */
 function expectToBeSafeParseSuccess(value) {
     (0, expectToBeDefined_1.expectToBeDefined)(value);
-    (0, node_assert_1.ok)(value.success, "Expected SafeParseSuccess, got SafeParseError");
+    (0, strict_1.ok)(value.success, "Expected SafeParseSuccess, got SafeParseError");
 }
 //# sourceMappingURL=expectToBeSafeParseSuccess.js.map

package/src/lib/expectToBeSafeParseSuccess.js.map

@@ -1 +1 @@
-{"version":3,"file":"expectToBeSafeParseSuccess.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeSafeParseSuccess.ts"],"names":[],"mappings":";;AAWA,gEAKC;AAhBD,6CAAiC;AAIjC,2DAAwD;AAExD;;;;GAIG;AACH,SAAgB,0BAA0B,CACxC,KAAmD;IAEnD,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,gBAAE,EAAC,KAAK,CAAC,OAAO,EAAE,+CAA+C,CAAC,CAAC;AACrE,CAAC"}
+{"version":3,"file":"expectToBeSafeParseSuccess.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeSafeParseSuccess.ts"],"names":[],"mappings":";;AAWA,gEAKC;AAhBD,+CAAwC;AAIxC,2DAAwD;AAExD;;;;GAIG;AACH,SAAgB,0BAA0B,CACxC,KAAmD;IAEnD,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,WAAE,EAAC,KAAK,CAAC,OAAO,EAAE,+CAA+C,CAAC,CAAC;AACrE,CAAC"}

package/src/lib/expectToBeSome.d.ts

@@ -1,2 +1,7 @@
-import { type Option, type Some } from "@clipboard-health/util-typescript";
-export declare function expectToBeSome<A>(value: Option<A> | undefined): asserts value is Some<A>;
+import { option as O } from "@clipboard-health/util-typescript";
+/**
+ * Asserts and narrows the type of the provided Option value to Some.
+ * @param value - The Option value to check
+ * @throws {AssertionError} If the value is undefined or not Some
+ */
+export declare function expectToBeSome<A>(value: O.Option<A> | undefined): asserts value is O.Some<A>;

package/src/lib/expectToBeSome.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.expectToBeSome = expectToBeSome;
-const node_assert_1 = require("node:assert");
+const strict_1 = require("node:assert/strict");
 const util_typescript_1 = require("@clipboard-health/util-typescript");
 const expectToBeDefined_1 = require("./expectToBeDefined");
+/**
+ * Asserts and narrows the type of the provided Option value to Some.
+ * @param value - The Option value to check
+ * @throws {AssertionError} If the value is undefined or not Some
+ */
 function expectToBeSome(value) {
     (0, expectToBeDefined_1.expectToBeDefined)(value);
-    (0, node_assert_1.ok)((0, util_typescript_1.isSome)(value));
+    (0, strict_1.ok)(util_typescript_1.option.isSome(value));
 }
 //# sourceMappingURL=expectToBeSome.js.map

package/src/lib/expectToBeSome.js.map

@@ -1 +1 @@
-{"version":3,"file":"expectToBeSome.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeSome.ts"],"names":[],"mappings":";;AAMA,wCAGC;AATD,6CAAiC;AAEjC,uEAAmF;AAEnF,2DAAwD;AAExD,SAAgB,cAAc,CAAI,KAA4B;IAC5D,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,gBAAE,EAAC,IAAA,wBAAM,EAAC,KAAK,CAAC,CAAC,CAAC;AACpB,CAAC"}
+{"version":3,"file":"expectToBeSome.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/expectToBeSome.ts"],"names":[],"mappings":";;AAWA,wCAGC;AAdD,+CAAwC;AAExC,uEAAgE;AAEhE,2DAAwD;AAExD;;;;GAIG;AACH,SAAgB,cAAc,CAAI,KAA8B;IAC9D,IAAA,qCAAiB,EAAC,KAAK,CAAC,CAAC;IACzB,IAAA,WAAE,EAAC,wBAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACtB,CAAC"}