@clipboard-health/util-ts 2.9.6 → 2.10.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/util-ts",
   "description": "TypeScript utilities.",
-  "version": "2.9.6",
+  "version": "2.10.0",
   "dependencies": {
     "tslib": "2.8.0"
   },

package/src/index.d.ts

@@ -1,20 +1,8 @@
-export * from "./lib/arrays/head";
-export * from "./lib/arrays/nonEmptyArray";
+export * from "./lib/arrays";
 export * from "./lib/deepFreeze";
-export * from "./lib/errors/cbhError";
-export * from "./lib/errors/isError";
-export * from "./lib/errors/serviceError";
-export * from "./lib/errors/toError";
-export * from "./lib/errors/toErrorMessage";
+export * from "./lib/errors";
 export * from "./lib/forceCast";
-export * from "./lib/functional/cbhResponse";
-export * as either from "./lib/functional/either";
-export * as option from "./lib/functional/option";
-export * from "./lib/functional/pipe";
-export * from "./lib/functional/serviceResult";
-export * from "./lib/nullish/isDefined";
-export * from "./lib/nullish/isNil";
-export * from "./lib/nullish/nullToUndefined";
-export * from "./lib/strings/isString";
-export * from "./lib/strings/stringify";
+export * from "./lib/functional";
+export * from "./lib/nullish";
+export * from "./lib/strings";
 export * from "./lib/types";

package/src/index.js

@@ -1,25 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.option = exports.either = void 0;
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./lib/arrays/head"), exports);
-tslib_1.__exportStar(require("./lib/arrays/nonEmptyArray"), exports);
+tslib_1.__exportStar(require("./lib/arrays"), exports);
 tslib_1.__exportStar(require("./lib/deepFreeze"), exports);
-tslib_1.__exportStar(require("./lib/errors/cbhError"), exports);
-tslib_1.__exportStar(require("./lib/errors/isError"), exports);
-tslib_1.__exportStar(require("./lib/errors/serviceError"), exports);
-tslib_1.__exportStar(require("./lib/errors/toError"), exports);
-tslib_1.__exportStar(require("./lib/errors/toErrorMessage"), exports);
+tslib_1.__exportStar(require("./lib/errors"), exports);
 tslib_1.__exportStar(require("./lib/forceCast"), exports);
-tslib_1.__exportStar(require("./lib/functional/cbhResponse"), exports);
-exports.either = tslib_1.__importStar(require("./lib/functional/either"));
-exports.option = tslib_1.__importStar(require("./lib/functional/option"));
-tslib_1.__exportStar(require("./lib/functional/pipe"), exports);
-tslib_1.__exportStar(require("./lib/functional/serviceResult"), exports);
-tslib_1.__exportStar(require("./lib/nullish/isDefined"), exports);
-tslib_1.__exportStar(require("./lib/nullish/isNil"), exports);
-tslib_1.__exportStar(require("./lib/nullish/nullToUndefined"), exports);
-tslib_1.__exportStar(require("./lib/strings/isString"), exports);
-tslib_1.__exportStar(require("./lib/strings/stringify"), exports);
+tslib_1.__exportStar(require("./lib/functional"), exports);
+tslib_1.__exportStar(require("./lib/nullish"), exports);
+tslib_1.__exportStar(require("./lib/strings"), exports);
 tslib_1.__exportStar(require("./lib/types"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/util-ts/src/index.ts"],"names":[],"mappings":";;;;AAAA,4DAAkC;AAClC,qEAA2C;AAC3C,2DAAiC;AACjC,gEAAsC;AACtC,+DAAqC;AACrC,oEAA0C;AAC1C,+DAAqC;AACrC,sEAA4C;AAC5C,0DAAgC;AAChC,uEAA6C;AAC7C,0EAAkD;AAClD,0EAAkD;AAClD,gEAAsC;AACtC,yEAA+C;AAC/C,kEAAwC;AACxC,8DAAoC;AACpC,wEAA8C;AAC9C,iEAAuC;AACvC,kEAAwC;AACxC,sDAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/util-ts/src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B;AAC7B,2DAAiC;AACjC,uDAA6B;AAC7B,0DAAgC;AAChC,2DAAiC;AACjC,wDAA8B;AAC9B,wDAA8B;AAC9B,sDAA4B"}

package/src/lib/arrays/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./head";
+export * from "./nonEmptyArray";

package/src/lib/arrays/index.js

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

package/src/lib/arrays/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/arrays/index.ts"],"names":[],"mappings":";;;AAAA,iDAAuB;AACvB,0DAAgC"}

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

@@ -0,0 +1,5 @@
+export * from "./cbhError";
+export * from "./isError";
+export * from "./serviceError";
+export * from "./toError";
+export * from "./toErrorMessage";

package/src/lib/errors/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./cbhError"), exports);
+tslib_1.__exportStar(require("./isError"), exports);
+tslib_1.__exportStar(require("./serviceError"), exports);
+tslib_1.__exportStar(require("./toError"), exports);
+tslib_1.__exportStar(require("./toErrorMessage"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/errors/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,oDAA0B;AAC1B,yDAA+B;AAC/B,oDAA0B;AAC1B,2DAAiC"}

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

@@ -81,6 +81,6 @@ export declare function getOrElse<E, A>(onLeft: (left: E) => A): (either: Either
  *
  * @param onLeft - Function to handle the `Left` case
  * @param onRight - Function to handle the `Right` case
- * @returns The result of `Either` `onLeft` or `onRight` based on the `Either` state
+ * @returns The result of either `onLeft` or `onRight` based on the `Either` state
  */
-export declare function match<E, A, B>(onLeft: (left: E) => B, onRight: (right: A) => B): (either: Either<E, A>) => B;
+export declare function match<E, A, B, C>(onLeft: (left: E) => B, onRight: (right: A) => C): (either: Either<E, A>) => B | C;

package/src/lib/functional/either.js

@@ -89,7 +89,7 @@ function getOrElse(onLeft) {
  *
  * @param onLeft - Function to handle the `Left` case
  * @param onRight - Function to handle the `Right` case
- * @returns The result of `Either` `onLeft` or `onRight` based on the `Either` state
+ * @returns The result of either `onLeft` or `onRight` based on the `Either` state
  */
 function match(onLeft, onRight) {
     return (either) => (isRight(either) ? onRight(either.right) : onLeft(either.left));

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

@@ -0,0 +1,5 @@
+export * from "./cbhResponse";
+export * as either from "./either";
+export * as option from "./option";
+export * from "./pipe";
+export * from "./serviceResult";

package/src/lib/functional/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.option = exports.either = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./cbhResponse"), exports);
+exports.either = tslib_1.__importStar(require("./either"));
+exports.option = tslib_1.__importStar(require("./option"));
+tslib_1.__exportStar(require("./pipe"), exports);
+tslib_1.__exportStar(require("./serviceResult"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/functional/index.ts"],"names":[],"mappings":";;;;AAAA,wDAA8B;AAC9B,2DAAmC;AACnC,2DAAmC;AACnC,iDAAuB;AACvB,0DAAgC"}

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

@@ -68,4 +68,12 @@ export declare function getOrElse<A>(defaultValue: A): (option: Option<A>) => A;
  * @param onSome - Function to handle the `Some` case
  * @returns The result of either `onNone` or `onSome` based on the `Option` state
  */
-export declare function match<A, B>(onNone: () => B, onSome: (value: A) => B): (option: Option<A>) => B;
+export declare function match<A, B, C>(onNone: () => B, onSome: (value: A) => C): (option: Option<A>) => B | C;
+/**
+ * Converts a nullable value to an `Option`. If the value is `null` or `undefined`, returns `None`.
+ * Otherwise, returns `Some(value)`.
+ *
+ * @param value - The value to convert
+ * @returns An `Option` representing the nullable value
+ */
+export declare function fromNullable<A>(value: A | null | undefined): Option<A>;

package/src/lib/functional/option.js

@@ -8,6 +8,8 @@ exports.map = map;
 exports.flatMap = flatMap;
 exports.getOrElse = getOrElse;
 exports.match = match;
+exports.fromNullable = fromNullable;
+const nullish_1 = require("../nullish");
 /**
  * Constructs an `Option` of `None`, representing a missing value.
  */
@@ -79,4 +81,15 @@ function getOrElse(defaultValue) {
 function match(onNone, onSome) {
     return (option) => (isSome(option) ? onSome(option.value) : onNone());
 }
+/**
+ * Converts a nullable value to an `Option`. If the value is `null` or `undefined`, returns `None`.
+ * Otherwise, returns `Some(value)`.
+ *
+ * @param value - The value to convert
+ * @returns An `Option` representing the nullable value
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+function fromNullable(value) {
+    return (0, nullish_1.isNil)(value) ? exports.none : some(value);
+}
 //# sourceMappingURL=option.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"option.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/functional/option.ts"],"names":[],"mappings":";;;AA4BA,oBAEC;AAQD,wBAEC;AAQD,wBAEC;AASD,kBAEC;AASD,0BAEC;AASD,8BAEC;AASD,sBAEC;AA7ED;;GAEG;AACU,QAAA,IAAI,GAAS,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAE5C;;;;;GAKG;AACH,SAAgB,IAAI,CAAI,KAAQ;IAC9B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,MAAM,CAAI,MAAiB;IACzC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,MAAM,CAAI,MAAiB;IACzC,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,GAAG,CAAO,CAAc;IACtC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,YAAI,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAAO,CAAsB;IAClD,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAI,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,SAAS,CAAI,YAAe;IAC1C,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,KAAK,CAAO,MAAe,EAAE,MAAuB;IAClE,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AACxE,CAAC"}
+{"version":3,"file":"option.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/functional/option.ts"],"names":[],"mappings":";;;AA8BA,oBAEC;AAQD,wBAEC;AAQD,wBAEC;AASD,kBAEC;AASD,0BAEC;AASD,8BAEC;AASD,sBAKC;AAUD,oCAEC;AA/GD,wCAAmC;AAmBnC;;GAEG;AACU,QAAA,IAAI,GAAS,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAE5C;;;;;GAKG;AACH,SAAgB,IAAI,CAAI,KAAQ;IAC9B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,MAAM,CAAI,MAAiB;IACzC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,MAAM,CAAI,MAAiB;IACzC,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,GAAG,CAAO,CAAc;IACtC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,YAAI,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAAO,CAAsB;IAClD,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAI,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,SAAS,CAAI,YAAe;IAC1C,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,KAAK,CACnB,MAAe,EACf,MAAuB;IAEvB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;GAMG;AACH,wDAAwD;AACxD,SAAgB,YAAY,CAAI,KAA2B;IACzD,OAAO,IAAA,eAAK,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,YAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC3C,CAAC"}

package/src/lib/nullish/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./isDefined";
+export * from "./isNil";
+export * from "./nullToUndefined";

package/src/lib/nullish/index.js

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

package/src/lib/nullish/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/nullish/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,kDAAwB;AACxB,4DAAkC"}

package/src/lib/strings/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./isString";
+export * from "./stringify";

package/src/lib/strings/index.js

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

package/src/lib/strings/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/util-ts/src/lib/strings/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,sDAA4B"}