@clipboard-health/testing-core 0.1.0

package/README.md

@@ -0,0 +1,21 @@
+# @clipboard-health/testing-core <!-- omit from toc -->
+
+Core utilities for testing Clipboard Health's software.
+
+## Table of contents <!-- omit from toc -->
+
+- [Install](#install)
+- [Usage](#usage)
+- [Local development commands](#local-development-commands)
+
+## Install
+
+```bash
+npm install @clipboard-health/testing-core
+```
+
+## Usage
+
+## Local development commands
+
+See [`package.json`](./package.json) `scripts` for a list of commands.

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@clipboard-health/testing-core",
+  "description": "Core utilities for testing Clipboard Health's software.",
+  "version": "0.1.0",
+  "dependencies": {
+    "tslib": "2.8.0",
+    "zod": "3.23.8"
+  },
+  "keywords": [],
+  "license": "MIT",
+  "main": "./src/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "typings": "./src/index.d.ts",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./lib/expectToBeDefined";
+export * from "./lib/expectToBeSafeParseError";
+export * from "./lib/expectToBeSafeParseSuccess";

package/src/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/expectToBeDefined"), exports);
+tslib_1.__exportStar(require("./lib/expectToBeSafeParseError"), exports);
+tslib_1.__exportStar(require("./lib/expectToBeSafeParseSuccess"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

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

package/src/lib/expectToBeDefined.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Asserts and narrows the type for defined values.
+ *
+ * @throws {AssertionError} for null or undefined values.
+ */
+export declare function expectToBeDefined<T>(value: T | undefined): asserts value is T;

package/src/lib/expectToBeDefined.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectToBeDefined = expectToBeDefined;
+const node_assert_1 = require("node:assert");
+/**
+ * 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");
+}
+//# sourceMappingURL=expectToBeDefined.js.map

package/src/lib/expectToBeDefined.js.map

@@ -0,0 +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"}

package/src/lib/expectToBeSafeParseError.d.ts

@@ -0,0 +1,7 @@
+import { type SafeParseError, type SafeParseReturnType } from "zod";
+/**
+ * Asserts and narrows the type for Zod SafeParseReturnType to a SafeParseError.
+ *
+ * @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

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

package/src/lib/expectToBeSafeParseError.js.map

@@ -0,0 +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"}

package/src/lib/expectToBeSafeParseSuccess.d.ts

@@ -0,0 +1,7 @@
+import { type SafeParseReturnType, type SafeParseSuccess } from "zod";
+/**
+ * Asserts and narrows the type for Zod SafeParseReturnType to a SafeParseSuccess.
+ *
+ * @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

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

package/src/lib/expectToBeSafeParseSuccess.js.map

@@ -0,0 +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"}