@clipboard-health/util-ts 2.2.7 → 2.2.8

package/src/lib/to-error.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isError = isError;
+exports.toError = toError;
+exports.toErrorMessage = toErrorMessage;
+const is_string_1 = require("./is-string");
+const stringify_1 = require("./stringify");
+function isError(error) {
+    return error instanceof Error;
+}
+function toError(error) {
+    if (isError(error))
+        return error;
+    try {
+        return new Error((0, is_string_1.isString)(error) ? error : (0, stringify_1.stringify)(error));
+    }
+    catch {
+        return new Error(String(error));
+    }
+}
+function toErrorMessage(error) {
+    return toError(error).message;
+}
+//# sourceMappingURL=to-error.js.map

package/src/lib/to-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-error.js","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/to-error.ts"],"names":[],"mappings":";;AAGA,0BAEC;AAED,0BAQC;AAED,wCAEC;AAnBD,2CAAuC;AACvC,2CAAwC;AAExC,SAAgB,OAAO,CAAC,KAAc;IACpC,OAAO,KAAK,YAAY,KAAK,CAAC;AAChC,CAAC;AAED,SAAgB,OAAO,CAAC,KAAc;IACpC,IAAI,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAEjC,IAAI,CAAC;QACH,OAAO,IAAI,KAAK,CAAC,IAAA,oBAAQ,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAA,qBAAS,EAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAClC,CAAC;AACH,CAAC;AAED,SAAgB,cAAc,CAAC,KAAc;IAC3C,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;AAChC,CAAC"}

package/.eslintrc.json

@@ -1,12 +0,0 @@
-{
-  "extends": ["../../.eslintrc.json"],
-  "ignorePatterns": ["!**/*"],
-  "parserOptions": {
-    "project": "tsconfig.lint.json",
-    "tsconfigRootDir": "packages/util-ts"
-  },
-  "rules": {
-    // Block node dependencies so this library is usable in the browser.
-    "no-restricted-imports": ["error", { "patterns": ["node:*"] }]
-  }
-}

package/jest.config.ts

@@ -1,18 +0,0 @@
-export default {
-  coveragePathIgnorePatterns: [],
-  coverageThreshold: {
-    global: {
-      branches: 100,
-      functions: 100,
-      lines: 100,
-      statements: 100,
-    },
-  },
-  displayName: "util-ts",
-  moduleFileExtensions: ["ts", "js"],
-  preset: "../../jest.preset.js",
-  setupFiles: ["../../jest.setup.js"],
-  transform: {
-    "^.+\\.[tj]s$": ["ts-jest", { tsconfig: "<rootDir>/tsconfig.spec.json" }],
-  },
-};

package/project.json

@@ -1,33 +0,0 @@
-{
-  "name": "util-ts",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "projectType": "library",
-  "sourceRoot": "packages/util-ts/src",
-  "tags": ["scope:no-external-imports"],
-  "targets": {
-    "build": {
-      "executor": "@nx/js:tsc",
-      "options": {
-        "assets": ["packages/util-ts/*.md"],
-        "main": "packages/util-ts/src/index.js",
-        "outputPath": "dist/packages/util-ts",
-        "tsConfig": "packages/util-ts/tsconfig.lib.json"
-      },
-      "outputs": ["{options.outputPath}"]
-    },
-    "lint": {
-      "executor": "@nx/eslint:lint",
-      "options": {
-        "maxWarnings": 0
-      }
-    },
-    "test": {
-      "executor": "@nx/jest:jest",
-      "options": {
-        "jestConfig": "packages/util-ts/jest.config.ts",
-        "passWithNoTests": false
-      },
-      "outputs": ["{projectRoot}/coverage"]
-    }
-  }
-}

package/src/lib/cbh-error.spec.ts

@@ -1,30 +0,0 @@
-import { CbhError } from "./cbh-error";
-
-describe("CbhError", () => {
-  it("returns proper defaults", () => {
-    const message = "boom";
-    const statusCode = 500;
-
-    const error = new CbhError({ message, statusCode });
-
-    expect(error.name).toBe("CbhError");
-    expect(error.message).toBe(message);
-    expect(error.issues[0]?.statusCode).toBe(statusCode);
-  });
-
-  it("sets the cause", () => {
-    const cause = new Error("cause");
-
-    const error = new CbhError({ message: "boom", cause });
-
-    expect(error.cause).toBe(cause);
-  });
-
-  it("accpets an array", () => {
-    const message = "boom";
-
-    const error = new CbhError([{ message }]);
-
-    expect(error.message).toBe(message);
-  });
-});

package/src/lib/cbh-error.ts

@@ -1,26 +0,0 @@
-import { type OneOrNonEmptyArray, toNonEmptyArray } from "./non-empty-array";
-
-const ERROR_STATUS_CODES = [400, 401, 403, 404, 409, 422, 429, 500] as const;
-export type ErrorStatusCode = (typeof ERROR_STATUS_CODES)[number];
-
-export interface CbhIssue {
-  cause?: Error;
-  id?: string;
-  message: string;
-  statusCode?: ErrorStatusCode;
-}
-
-export class CbhError extends Error {
-  public readonly issues: CbhIssue[];
-
-  constructor(issues: OneOrNonEmptyArray<CbhIssue>) {
-    const is = toNonEmptyArray(issues);
-    const first = is[0];
-    super(first?.message, { cause: first?.cause });
-    // See https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#example
-    Object.setPrototypeOf(this, new.target.prototype);
-
-    this.issues = is;
-    this.name = "CbhError";
-  }
-}

package/src/lib/cbh-response.spec.ts

@@ -1,25 +0,0 @@
-import { CbhError } from "./cbh-error";
-import { toErrorCbhResponse, toSuccessCbhResponse } from "./cbh-response";
-
-describe("toErrorCbhResponse", () => {
-  it("returns error", () => {
-    const message = "boom";
-
-    const response = toErrorCbhResponse({ message });
-
-    expect(response).toEqual({
-      success: false,
-      error: new CbhError({ message }),
-    });
-  });
-});
-
-describe("toSuccessCbhResponse", () => {
-  it("returns success", () => {
-    const message = "success";
-
-    const response = toSuccessCbhResponse({ message });
-
-    expect(response).toEqual({ success: true, data: { message } });
-  });
-});

package/src/lib/cbh-response.ts

@@ -1,15 +0,0 @@
-import { CbhError, type CbhIssue } from "./cbh-error";
-import type { OneOrNonEmptyArray } from "./non-empty-array";
-
-export type CbhResponse<T> = { success: true; data: T } | { success: false; error: CbhError };
-
-export function toErrorCbhResponse(issues: OneOrNonEmptyArray<CbhIssue>): {
-  success: false;
-  error: CbhError;
-} {
-  return { success: false, error: new CbhError(issues) };
-}
-
-export function toSuccessCbhResponse<T>(data: T): { success: true; data: T } {
-  return { success: true, data };
-}

package/src/lib/defined-utils.spec.ts

@@ -1,35 +0,0 @@
-import { isDefined, isNullOrUndefined } from "./defined-utils";
-
-const DEFINED_TEST_CASES = ["gandalf", " ", "", 42, 0, -0];
-
-describe("isNullOrUndefined", () => {
-  it.each(DEFINED_TEST_CASES)("returns false for (%s)", (value) => {
-    expect(isNullOrUndefined(value)).toBe(false);
-  });
-
-  it("returns true if null", () => {
-    // eslint-disable-next-line unicorn/no-null
-    expect(isNullOrUndefined(null)).toBe(true);
-  });
-
-  it("returns true if undefined", () => {
-    // eslint-disable-next-line unicorn/no-useless-undefined
-    expect(isNullOrUndefined(undefined)).toBe(true);
-  });
-});
-
-describe("isDefined", () => {
-  it.each(DEFINED_TEST_CASES)("returns true for (%s)", (value) => {
-    expect(isDefined(value)).toBe(true);
-  });
-
-  it("returns false if undefined", () => {
-    // eslint-disable-next-line unicorn/no-null
-    expect(isDefined(null)).toBe(false);
-  });
-
-  it("returns false if null", () => {
-    // eslint-disable-next-line unicorn/no-useless-undefined
-    expect(isDefined(undefined)).toBe(false);
-  });
-});

package/src/lib/delay.spec.ts

@@ -1,11 +0,0 @@
-import { delay } from "./delay";
-
-describe("delay", () => {
-  it("should wait for the specified time", async () => {
-    const start = Date.now();
-
-    await delay(10);
-
-    expect(Date.now() - start).toBeGreaterThanOrEqual(10);
-  });
-});

package/src/lib/delay.ts

@@ -1,5 +0,0 @@
-export async function delay(milliseconds: number): Promise<void> {
-  await new Promise((resolve) => {
-    setTimeout(resolve, milliseconds);
-  });
-}

package/src/lib/either.spec.ts

@@ -1,23 +0,0 @@
-import * as E from "./either";
-
-describe("Either", () => {
-  it("left works", () => {
-    const error = new Error("boom");
-    const either = E.left(error) as E.Left<Error>;
-
-    expect(E.isLeft(either)).toBe(true);
-    expect(E.isRight(either)).toBe(false);
-    expect(either.isRight).toBe(false);
-    expect(either.left).toBe(error);
-  });
-
-  it("right works", () => {
-    const value = "my-value";
-    const either = E.right(value) as E.Right<string>;
-
-    expect(E.isRight(either)).toBe(true);
-    expect(E.isLeft(either)).toBe(false);
-    expect(either.isRight).toBe(true);
-    expect(either.right).toBe(value);
-  });
-});

package/src/lib/force-cast.spec.ts

@@ -1,8 +0,0 @@
-import { forceCast } from "./force-cast";
-
-describe("forceCast", () => {
-  it("doesn't actually change type", () => {
-    const a: number = forceCast<number>("a");
-    expect(typeof a).toBe("string");
-  });
-});

package/src/lib/force-cast.ts

@@ -1,4 +0,0 @@
-/** Force cast to the provided type. */
-export function forceCast<T>(value: unknown): T {
-  return value as T;
-}

package/src/lib/head.spec.ts

@@ -1,21 +0,0 @@
-import { head } from "./head";
-
-describe("head", () => {
-  it("returns head of list", () => {
-    expect(head([1, 2])).toBe(1);
-  });
-
-  it("returns undefined if empty list", () => {
-    // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
-    expect(head([])).toBeUndefined();
-  });
-
-  it("returns undefined if passed", () => {
-    expect(head()).toBeUndefined();
-  });
-
-  it("returns value if not an array", () => {
-    const value = { hi: "there" };
-    expect(head(value)).toEqual(value);
-  });
-});

package/src/lib/head.ts

@@ -1,5 +0,0 @@
-export type OneOrArray<T> = T | T[];
-
-export function head<T>(value?: OneOrArray<T>): T | undefined {
-  return Array.isArray(value) ? value[0] : (value ?? undefined);
-}

package/src/lib/identity.spec.ts

@@ -1,17 +0,0 @@
-import { identity } from "./identity";
-
-describe("identity", () => {
-  it("returns the provided input", () => {
-    expect(identity(1)).toBe(1);
-    expect(identity("text")).toBe("text");
-    expect(identity({})).toStrictEqual({});
-  });
-
-  it("should correctly infer the type", () => {
-    const a = 1;
-    expect(typeof a).toBe("number");
-
-    const b = identity(a);
-    expect(typeof b).toBe("number");
-  });
-});

package/src/lib/is-string.spec.ts

@@ -1,11 +0,0 @@
-import { isString } from "./is-string";
-
-describe("isString", () => {
-  it("returns true", () => {
-    expect(isString("hi")).toBe(true);
-  });
-
-  it("returns false", () => {
-    expect(isString({})).toBe(false);
-  });
-});

package/src/lib/is-string.ts

@@ -1,3 +0,0 @@
-export function isString(value: unknown): value is string {
-  return typeof value === "string" || value instanceof String;
-}

package/src/lib/non-empty-array.ts

@@ -1,7 +0,0 @@
-export type NonEmptyArray<T> = [T, ...T[]];
-
-export type OneOrNonEmptyArray<T> = T | NonEmptyArray<T>;
-
-export function toNonEmptyArray<T>(value: OneOrNonEmptyArray<T>): NonEmptyArray<T> {
-  return Array.isArray(value) ? value : [value];
-}

package/src/lib/null-to-undefined.spec.ts

@@ -1,33 +0,0 @@
-import { nullToUndefined } from "./null-to-undefined";
-
-describe("nullToUndefined", () => {
-  it("returns undefined", async () => {
-    // eslint-disable-next-line unicorn/no-null
-    expect(await nullToUndefined(Promise.resolve(null))).toBeUndefined();
-  });
-
-  it("returns value", async () => {
-    const expected = "hi";
-
-    expect(await nullToUndefined(Promise.resolve(expected))).toBe(expected);
-  });
-
-  it("supports PromiseLike objects", async () => {
-    const expected = "hello";
-
-    const promiseLike: PromiseLike<string> = {
-      // eslint-disable-next-line unicorn/no-thenable
-      then: function <TResult1, TResult2>(
-        onfulfilled?: ((value: string) => TResult1 | PromiseLike<TResult1>) | undefined,
-      ): PromiseLike<TResult1 | TResult2> {
-        if (onfulfilled) {
-          return Promise.resolve(onfulfilled(expected));
-        }
-
-        return Promise.reject();
-      },
-    };
-
-    expect(await nullToUndefined(promiseLike)).toBe(expected);
-  });
-});

package/src/lib/option.spec.ts

@@ -1,24 +0,0 @@
-import * as O from "./option";
-
-const { none, some } = O;
-
-describe("Option", () => {
-  it("none is not some", () => {
-    const option = none;
-
-    expect(O.isNone(option)).toBe(true);
-    expect(O.isSome(option)).toBe(false);
-    expect(option.isSome).toBe(false);
-  });
-
-  it("some is some", () => {
-    const value = "my-value";
-
-    const option = some(value);
-
-    expect(O.isNone(option)).toBe(false);
-    expect(O.isSome(option)).toBe(true);
-    expect(option.isSome).toBe(true);
-    expect(option.value).toBe(value);
-  });
-});

package/src/lib/stringify.spec.ts

@@ -1,11 +0,0 @@
-import { stringify } from "./stringify";
-
-describe("stringify", () => {
-  test.each([
-    [1n, '"1"'],
-    [{ a: 1 }, '{"a":1}'],
-    [{ a: 1n }, '{"a":"1"}'],
-  ])("stringify(%i, %i)", (value, expected) => {
-    expect(stringify(value)).toBe(expected);
-  });
-});

package/src/lib/stringify.ts

@@ -1,5 +0,0 @@
-export function stringify(value: unknown): string {
-  return JSON.stringify(value, (_, value: unknown) =>
-    typeof value === "bigint" ? String(value) : value,
-  );
-}

package/src/lib/to-error.spec.ts

@@ -1,28 +0,0 @@
-import { stringify } from "./stringify";
-import { toErrorMessage } from "./to-error";
-
-const MESSAGE = "hi";
-
-describe("toErrorMessage", () => {
-  it("returns message", () => {
-    expect(toErrorMessage(new Error(MESSAGE))).toEqual(MESSAGE);
-  });
-
-  it("returns message if non-error object", () => {
-    const error = { hello: MESSAGE };
-
-    expect(toErrorMessage(error)).toEqual(stringify(error));
-  });
-
-  it("returns message if unable to stringify", () => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const circularReference = { a: { b: "c" }, d: {} } as any;
-    circularReference.a.d = circularReference.a;
-
-    expect(toErrorMessage(circularReference)).toBe("[object Object]");
-  });
-
-  it("returns message if string", () => {
-    expect(toErrorMessage(MESSAGE)).toEqual(MESSAGE);
-  });
-});

package/src/lib/to-error.ts

@@ -1,20 +0,0 @@
-import { isString } from "./is-string";
-import { stringify } from "./stringify";
-
-export function isError(error: unknown): error is Error {
-  return error instanceof Error;
-}
-
-export function toError(error: unknown): Error {
-  if (isError(error)) return error;
-
-  try {
-    return new Error(isString(error) ? error : stringify(error));
-  } catch {
-    return new Error(String(error));
-  }
-}
-
-export function toErrorMessage(error: unknown): string {
-  return toError(error).message;
-}

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc"
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.lint.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.lint.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "types": ["jest", "node"]
-  },
-  "include": ["."]
-}

package/tsconfig.spec.json

@@ -1,13 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "types": ["jest", "node"]
-  },
-  "include": [
-    "jest.config.ts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.d.ts",
-    "src/lib/types.ts"
-  ]
-}

package/typedoc.json

@@ -1,4 +0,0 @@
-{
-  "extends": ["../../typedoc.base.json"],
-  "entryPoints": ["src/index.ts"]
-}