@clipboard-health/util-ts 2.12.0 → 2.13.0

package/README.md

@@ -28,8 +28,7 @@ See `./src/lib` for each utility.
 
 <!-- prettier-ignore -->
 ```ts
-// ./examples/serviceError.ts
-
+// packages/util-ts/examples/serviceError.ts
 import { deepEqual, equal } from "node:assert/strict";
 
 import { ERROR_CODES, ServiceError } from "@clipboard-health/util-ts";
@@ -116,8 +115,7 @@ try {
 
 <!-- prettier-ignore -->
 ```ts
-// ./examples/serviceResult.ts
-
+// packages/util-ts/examples/serviceResult.ts
 import { ok } from "node:assert/strict";
 
 import {
@@ -154,9 +152,7 @@ ok(E.isRight(validateUser({ email: "user@example.com", phone: "555-555-5555" }))
 
 <!-- prettier-ignore -->
 ```ts
-// ./examples/pipe.ts
-
-// packages/util-ts/src/lib/functional/pipe.ts
+// packages/util-ts/examples/pipe.ts
 import { equal } from "node:assert/strict";
 
 import { pipe } from "@clipboard-health/util-ts";
@@ -177,9 +173,7 @@ equal(result, "Hello World");
 
 <!-- prettier-ignore -->
 ```ts
-// ./examples/option.ts
-
-// packages/util-ts/src/lib/functional/option.ts
+// packages/util-ts/examples/option.ts
 import { equal } from "node:assert/strict";
 
 import { option as O, pipe } from "@clipboard-health/util-ts";
@@ -210,9 +204,7 @@ equal(result, "Result is 0.1");
 
 <!-- prettier-ignore -->
 ```ts
-// ./examples/either.ts
-
-// packages/util-ts/src/lib/functional/either.ts
+// packages/util-ts/examples/either.ts
 import { equal } from "node:assert/strict";
 
 import { either as E, pipe } from "@clipboard-health/util-ts";

package/package.json

@@ -1,22 +1,28 @@
 {
   "name": "@clipboard-health/util-ts",
   "description": "TypeScript utilities.",
-  "version": "2.12.0",
+  "version": "2.13.0",
+  "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "dependencies": {
     "tslib": "2.8.0"
   },
   "devDependencies": {
-    "type-fest": "4.26.1",
+    "type-fest": "4.27.0",
     "zod": "3.23.8"
   },
-  "keywords": [],
+  "keywords": [
+    "typescript",
+    "utility"
+  ],
   "license": "MIT",
   "main": "./src/index.js",
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "embed": "embedme README.md"
+  "repository": {
+    "directory": "packages/util-ts",
+    "type": "git",
+    "url": "git+https://github.com/ClipboardHealth/core-utils.git"
   },
   "type": "commonjs",
   "typings": "./src/index.d.ts",

package/src/lib/errors/cbhError.d.ts

@@ -5,7 +5,7 @@ import * as E from "../functional/either";
  *
  * @see {@link https://www.notion.so/BP-REST-API-f769b7fe745c4cf38f6eca2e9ad8a843?pvs=4#e0b4e9ea30f041409ce39505650098ea}
  */
-declare const ERROR_STATUS_CODES: readonly [400, 401, 403, 404, 409, 422, 429, 500];
+export declare const ERROR_STATUS_CODES: readonly [400, 401, 403, 404, 409, 422, 429, 500];
 /**
  * @deprecated Use {@link ErrorCode} instead.
  */
@@ -30,4 +30,3 @@ export declare class CbhError extends Error {
  * @deprecated Use {@link failure} instead.
  */
 export declare function toLeft<A = never>(issues: Arrayable<CbhIssue> | string): E.Either<CbhError, A>;
-export {};

package/src/lib/errors/cbhError.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CbhError = void 0;
+exports.CbhError = exports.ERROR_STATUS_CODES = void 0;
 exports.toLeft = toLeft;
 const tslib_1 = require("tslib");
 const E = tslib_1.__importStar(require("../functional/either"));
@@ -9,7 +9,7 @@ const E = tslib_1.__importStar(require("../functional/either"));
  *
  * @see {@link https://www.notion.so/BP-REST-API-f769b7fe745c4cf38f6eca2e9ad8a843?pvs=4#e0b4e9ea30f041409ce39505650098ea}
  */
-const ERROR_STATUS_CODES = [400, 401, 403, 404, 409, 422, 429, 500];
+exports.ERROR_STATUS_CODES = [400, 401, 403, 404, 409, 422, 429, 500];
 /**
  * @deprecated Use {@link ServiceError} instead.
  */

package/src/lib/errors/cbhError.js.map

@@ -1 +1 @@
-{"version":3,"file":"cbhError.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/errors/cbhError.ts"],"names":[],"mappings":";;;AAqDA,wBAEC;;AArDD,gEAA0C;AAE1C;;;;GAIG;AACH,MAAM,kBAAkB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAU,CAAC;AAiB7E;;GAEG;AACH,MAAa,QAAS,SAAQ,KAAK;IACjB,MAAM,CAAsB;IAE5C,YAAY,eAA6C;QACvD,MAAM,EAAE,GACN,OAAO,eAAe,KAAK,QAAQ;YACjC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;YAChC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC;gBAC9B,CAAC,CAAC,eAAe;gBACjB,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;QAE1B,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;QACpD,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;QAC7E,6FAA6F;QAC7F,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAElD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;IACzB,CAAC;CACF;AAnBD,4BAmBC;AAED;;GAEG;AACH,SAAgB,MAAM,CAAY,MAAoC;IACpE,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACtC,CAAC"}
+{"version":3,"file":"cbhError.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/errors/cbhError.ts"],"names":[],"mappings":";;;AAqDA,wBAEC;;AArDD,gEAA0C;AAE1C;;;;GAIG;AACU,QAAA,kBAAkB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAU,CAAC;AAiBpF;;GAEG;AACH,MAAa,QAAS,SAAQ,KAAK;IACjB,MAAM,CAAsB;IAE5C,YAAY,eAA6C;QACvD,MAAM,EAAE,GACN,OAAO,eAAe,KAAK,QAAQ;YACjC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;YAChC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC;gBAC9B,CAAC,CAAC,eAAe;gBACjB,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;QAE1B,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;QACpD,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;QAC7E,6FAA6F;QAC7F,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAElD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;IACzB,CAAC;CACF;AAnBD,4BAmBC;AAED;;GAEG;AACH,SAAgB,MAAM,CAAY,MAAoC;IACpE,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACtC,CAAC"}

package/src/lib/errors/serviceError.d.ts

@@ -71,7 +71,7 @@ declare const ERROR_METADATA: {
     };
 };
 type Status = (typeof ERROR_METADATA)[keyof typeof ERROR_METADATA]["status"];
-interface Issue extends ServiceIssue {
+export interface Issue extends ServiceIssue {
     code: Required<ServiceIssue>["code"];
     title: string;
 }

package/src/lib/functional/either.d.ts

@@ -9,7 +9,7 @@ export type Right<A> = Readonly<{
 /**
  * A value of `Either` type `Left<E>` or type `Right<A>`; a disjoint union.
  *
- * A common use case is as an alternative to {@link Option} where `Left<E>` contains useful
+ * A common use case is as an alternative to `Option` where `Left<E>` contains useful
  * information. Convention dictates that `Left<E>` is used for failure and `Right<A>` for success.
  * To help remember, the success case is "right"; it's the result you want.
  *
@@ -53,7 +53,7 @@ export declare function left<E, A = never>(left: E): Either<E, A>;
 /**
  * Constructs an `Either` holding a `Right<A>`, representing a success.
  *
- * @param value - The value to wrap in a `Right`
+ * @param right - The value to wrap in a `Right`
  * @returns A `Right` containing the value
  */
 export declare function right<A, E = never>(right: A): Either<E, A>;
@@ -98,8 +98,8 @@ export declare function flatMap<E, A, B>(f: (right: A) => Either<E, B>): (either
  * Safely extracts the value from an `Either` with a fallback. Use this function when you need to
  * convert an `Either<E, A>` to an `A`, providing a default value for the `Left` case.
  *
- * @param defaultValue - The value to return if the `Either` is `Left`
- * @returns The contained value if `Right`, `defaultValue` if `Left`
+ * @param onLeft - The value to return if the `Either` is `Left`
+ * @returns The contained value if `Right`, the result of `onLeft` if `Left`
  */
 export declare function getOrElse<E, A>(onLeft: (left: E) => A): (either: Either<E, A>) => A;
 /**

package/src/lib/functional/either.js

@@ -21,7 +21,7 @@ function left(left) {
 /**
  * Constructs an `Either` holding a `Right<A>`, representing a success.
  *
- * @param value - The value to wrap in a `Right`
+ * @param right - The value to wrap in a `Right`
  * @returns A `Right` containing the value
  */
 function right(right) {
@@ -78,8 +78,8 @@ function flatMap(f) {
  * Safely extracts the value from an `Either` with a fallback. Use this function when you need to
  * convert an `Either<E, A>` to an `A`, providing a default value for the `Left` case.
  *
- * @param defaultValue - The value to return if the `Either` is `Left`
- * @returns The contained value if `Right`, `defaultValue` if `Left`
+ * @param onLeft - The value to return if the `Either` is `Left`
+ * @returns The contained value if `Right`, the result of `onLeft` if `Left`
  */
 function getOrElse(onLeft) {
     return (either) => (isRight(either) ? either.right : onLeft(either.left));

package/src/lib/functional/pipe.d.ts

@@ -1,29 +1,3 @@
-/**
- * Pipes a value through a series of functions from left to right. Currently supports up to 10
- * functions.
- *
- * @param a - The initial value to transform
- * @param fs - Functions to apply sequentially
- * @returns The final transformed value
- * @example
- * ```ts
- * // packages/util-ts/examples/pipe.ts
- * import { equal } from "node:assert/strict";
- *
- * import { pipe } from "@clipboard-health/util-ts";
- *
- * const result = pipe(
- *   "  hello world  ",
- *   (s) => s.trim(),
- *   (s) => s.split(" "),
- *   (array) => array.map((word) => word.charAt(0).toUpperCase() + word.slice(1)),
- *   (array) => array.join(" "),
- * );
- *
- * equal(result, "Hello World");
- *
- * ```
- */
 export declare function pipe<A>(a: A): A;
 export declare function pipe<A, B>(a: A, ab: (a: A) => B): B;
 export declare function pipe<A, B, C>(a: A, ab: (a: A) => B, bc: (b: B) => C): C;

package/src/lib/functional/pipe.js

@@ -1,6 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pipe = pipe;
+/**
+ * Pipes a value through a series of functions from left to right. Currently supports up to 10
+ * functions.
+ *
+ * @param a - The initial value to transform
+ * @param fs - Functions to apply sequentially
+ * @returns The final transformed value
+ * @example
+ * ```ts
+ * // packages/util-ts/examples/pipe.ts
+ * import { equal } from "node:assert/strict";
+ *
+ * import { pipe } from "@clipboard-health/util-ts";
+ *
+ * const result = pipe(
+ *   "  hello world  ",
+ *   (s) => s.trim(),
+ *   (s) => s.split(" "),
+ *   (array) => array.map((word) => word.charAt(0).toUpperCase() + word.slice(1)),
+ *   (array) => array.join(" "),
+ * );
+ *
+ * equal(result, "Hello World");
+ *
+ * ```
+ */
 function pipe(a, ...fs) {
     return fs.reduce((accumulator, f) => f(accumulator), a);
 }

package/src/lib/functional/pipe.js.map

@@ -1 +1 @@
-{"version":3,"file":"pipe.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/functional/pipe.ts"],"names":[],"mappings":";;AAuFA,oBAEC;AAFD,SAAgB,IAAI,CAAC,CAAU,EAAE,GAAG,EAAkC;IACpE,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;AAC1D,CAAC"}
+{"version":3,"file":"pipe.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/functional/pipe.ts"],"names":[],"mappings":";;AAuFA,oBAEC;AA5BD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,IAAI,CAAC,CAAU,EAAE,GAAG,EAAkC;IACpE,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;AAC1D,CAAC"}