@onivoro/isomorphic-common 22.0.5 → 24.0.0

package/dist/libs/server/common/libs/server/common/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@onivoro/server-common",
+  "version": "23.0.0",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "@onivoro/isomorphic-common": "23.0.0",
+    "@onivoro/server-b2b-orm": "23.0.0",
+    "tslib": "^2.3.0"
+  }
+}

package/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: 'lib-isomorphic-common',
+  preset: '../../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../../coverage/libs/isomorphic/common',
+};

package/package.json

@@ -1,41 +1,10 @@
 {
-    "name": "@onivoro/isomorphic-common",
-    "version": "22.0.5",
-    "repository": {
-        "url": "git+https://github.com/onivoro/isomorphic-common.git"
-    },
-    "main": "dist/cjs/index.js",
-    "module": "dist/esm/index.js",
-    "types": "dist/types/index.d.ts",
-    "files": [
-        "dist/*"
-    ],
-    "scripts": {
-        "onx": "onx",
-        "build": "onx Build",
-        "deploy": "onx Publish",
-        "test": "onx Test",
-        "update": "onx Update"
-    },
-    "exports": {
-        ".": {
-            "types": "./dist/types/index.d.ts",
-            "require": "./dist/cjs/index.js",
-            "import": "./dist/esm/index.js",
-            "default": "./dist/esm/lib.js"
-        }
-    },
-    "onx": {
-        "platform": "isomorphic",
-        "module": "commonjs"
-    },
-    "devDependencies": {
-        "@onivoro/cli": "^22.0.8",
-        "@types/jest": "*",
-        "typescript": "*"
-    },
-    "engines": {
-        "node": "22.10.0",
-        "npm": "10.9.0"
-    }
+  "name": "@onivoro/isomorphic-common",
+  "version": "24.0.0",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  }
 }

package/project.json

@@ -0,0 +1,23 @@
+{
+  "name": "lib-isomorphic-common",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/isomorphic/common/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/isomorphic/common",
+        "main": "libs/isomorphic/common/src/index.ts",
+        "tsConfig": "libs/isomorphic/common/tsconfig.lib.json",
+        "assets": [
+          "libs/isomorphic/common/README.md",
+          "libs/isomorphic/common/package.json"
+        ],
+        "declaration": true
+      }
+    }
+  },
+  "tags": []
+}

package/{dist/cjs/index.d.ts → src/index.ts}

@@ -1,7 +1,43 @@
-export * from './lib/constants/decimal-regex.constant';
+export * from './lib/constants/api-id-header.constant';
+export * from './lib/constants/api-key-header.constant';
+export * from './lib/constants/auth-cookie-name.constant';
+export * from './lib/constants/regexes.constant';
+
+export * from './lib/functions/arrange-act-assert.function';
+export * from './lib/functions/mock-calls.function';
+
+export * from './lib/functions/chunk.function';
+export * from './lib/functions/format-usd.function';
+export * from './lib/functions/get-date-last-month.function';
+export * from './lib/functions/get-date-range-for-month.function';
+export * from './lib/functions/get-user-full-name.function';
+export * from './lib/functions/is-valid-date.function';
+export * from './lib/functions/map-entities-to-options.function';
+export * from './lib/functions/map-enum-to-array-of-values.function';
+export * from './lib/functions/map-enum-to-lookup-array.function';
+export * from './lib/functions/map-enum-to-options.function';
+export * from './lib/functions/remove-element-at-index.function';
+export * from './lib/functions/round.function';
+export * from './lib/functions/sort-by-created-at.function';
+export * from './lib/functions/sort-by-full-name.function';
+export * from './lib/functions/sort-by-id.function';
+export * from './lib/functions/sort-by-name.function';
+export * from './lib/functions/sort-numbers.function';
+export * from './lib/functions/split-date-range-into-days.function';
+export * from './lib/functions/use-date.function';
+
+export * from './lib/types/access-token.interface';
+export * from './lib/types/company.type';
+export * from './lib/types/createable.type';
+export * from './lib/types/keys-of.type';
+export * from './lib/types/lookup.interface';
+export * from './lib/types/nameable.type';
+
 export * from './lib/constants/millis-per-day.constant';
 export * from './lib/constants/millis-per-hour.constant';
 export * from './lib/constants/millis-per-minute.constant';
+export * from './lib/constants/regexes.constant';
+
 export * from './lib/functions/add-offset.function';
 export * from './lib/functions/camel-case.function';
 export * from './lib/functions/convert-object-to-literal.function';
@@ -37,7 +73,8 @@ export * from './lib/functions/try-parse-date.function';
 export * from './lib/functions/unicode-words.const';
 export * from './lib/functions/upper-first.function';
 export * from './lib/functions/words.function';
-export * from './lib/interfaces/axios-wrapped-nest-exception.interface';
-export * from './lib/interfaces/entity-provider.interface';
-export * from './lib/interfaces/keys-of.type';
-export * from './lib/interfaces/lookup.interface';
+
+export * from './lib/types/axios-wrapped-nest-exception.interface';
+export * from './lib/types/entity-provider.interface';
+export * from './lib/types/keys-of.type';
+export * from './lib/types/lookup.interface';

package/src/lib/constants/api-id-header.constant.ts

@@ -0,0 +1 @@
+export const apiIdHeader = 'x-api-id';

package/src/lib/constants/api-key-header.constant.ts

@@ -0,0 +1 @@
+export const apiKeyHeader = 'x-api-key';

package/src/lib/constants/auth-cookie-name.constant.ts

@@ -0,0 +1,2 @@
+// TODO: REMOVE THIS BAD PATTERN OF HAVING LOWER LEVEL LIBS AWARE OF HIGHER ORDER LIBS/APPS
+export const authCookieName = 'token';

package/src/lib/constants/millis-per-day.constant.ts

@@ -0,0 +1,3 @@
+import { MILLIS_PER_HOUR } from "./millis-per-hour.constant";
+
+export const MILLIS_PER_DAY = MILLIS_PER_HOUR * 24;

package/src/lib/constants/millis-per-hour.constant.ts

@@ -0,0 +1,3 @@
+import { MILLIS_PER_MINUTE } from "./millis-per-minute.constant";
+
+export const MILLIS_PER_HOUR = MILLIS_PER_MINUTE * 60;

package/src/lib/constants/millis-per-minute.constant.ts

@@ -0,0 +1 @@
+export const MILLIS_PER_MINUTE = 1000 * 60;

package/src/lib/constants/regexes.constant.ts

@@ -0,0 +1,30 @@
+export const oneOrMoreSpaces = /\s{1,}/g;
+export const multipleSpaces = /\s{2,}/g;
+export const comma = /,/g;
+export const dashesLettersNumbers = /^([a-z]|-|\d)*$/i;
+export const dashesLettersNumbersSpaces = /^([a-z]|-|\s|\d)*$/i;
+export const zip = /^\d{5}$/;
+export const phone = /^\d{3}-\d{3}-\d{4}$/;
+export const phonePlusOne = /^\+1\d{10}$/;
+export const code = /^\d{6}$/;
+export const url = /(https?:\/\/|https?:\/\/).*\..+/;
+export const protocol = /https?:\/\/|https?:\/\//;
+export const firstSpaceLast = /[a-z]+\s[a-z]+([a-z]|')+[a-z]+/i;
+export const passwordNumber = /\d/;
+export const passwordUpper = /[A-Z]/;
+export const passwordLower = /[a-z]/;
+export const passwordSpecial = /\^|\$|\*|\.|\?|-|!|@|#|%|>|<|:|;|_|~|\+|=/;
+export const ssn = /^\d{3}-\d{2}-\d{4}$/;
+export const numeric = /^(\d|\.)*$/;
+export const duns = /^\d{9}$/;
+export const lastFourSocial = /^\d{4}$/;
+export const ein = /^\d{2}-\d{7}$/;
+export const stateShort = /^[A-Z]{2}$/;
+export const email = /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
+export const domain = /^(?!:\/\/)([a-zA-Z0-9-_]{1,63}\.)+[a-zA-Z]{2,63}$/;
+export const emailDomain = /^[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/;
+export const v4 = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/;
+export const dateIso8601 = /^\d{4}-\d{1,2}-\d{1,2}$/;
+export const dateIso8601WithTime = /^\d{4}-\d{1,2}-\d{1,2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/;
+export const decimalRegex = /(\d|\.)/g;
+export const slashR = /\r/g;

package/src/lib/functions/__snapshots__/chunk.function.spec.ts.snap

@@ -0,0 +1,94 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`chunk given 1, returns an array of arrays 1`] = `
+[
+  [
+    "one",
+    "two",
+    "three",
+    "four",
+    "five",
+    "six",
+    "seven",
+    "eight",
+  ],
+]
+`;
+
+exports[`chunk given 2, returns an array of arrays 1`] = `
+[
+  [
+    "one",
+    "two",
+    "three",
+    "four",
+  ],
+  [
+    "five",
+    "six",
+    "seven",
+    "eight",
+  ],
+]
+`;
+
+exports[`chunk given 3, returns an array of arrays 1`] = `
+[
+  [
+    "one",
+    "two",
+    "three",
+  ],
+  [
+    "four",
+    "five",
+    "six",
+  ],
+  [
+    "seven",
+    "eight",
+  ],
+]
+`;
+
+exports[`chunk given 4, returns an array of arrays 1`] = `
+[
+  [
+    "one",
+    "two",
+  ],
+  [
+    "three",
+    "four",
+  ],
+  [
+    "five",
+    "six",
+  ],
+  [
+    "seven",
+    "eight",
+  ],
+]
+`;
+
+exports[`chunk given 5, returns an array of arrays 1`] = `
+[
+  [
+    "one",
+    "two",
+  ],
+  [
+    "three",
+    "four",
+  ],
+  [
+    "five",
+    "six",
+  ],
+  [
+    "seven",
+    "eight",
+  ],
+]
+`;

package/src/lib/functions/__snapshots__/split-date-range-into-days.function.spec.ts.snap

@@ -0,0 +1,50 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`splitDateRangeIntoDays given {"from":"","to":""}, returns an array of days 1`] = `[]`;
+
+exports[`splitDateRangeIntoDays given {"from":"2024-01-01","to":"2024-01-01"}, returns an array of days 1`] = `
+[
+  "2024-01-01",
+]
+`;
+
+exports[`splitDateRangeIntoDays given {"from":"2024-01-01","to":"2024-02-01"}, returns an array of days 1`] = `
+[
+  "2024-01-01",
+  "2024-01-02",
+  "2024-01-03",
+  "2024-01-04",
+  "2024-01-05",
+  "2024-01-06",
+  "2024-01-07",
+  "2024-01-08",
+  "2024-01-09",
+  "2024-01-10",
+  "2024-01-11",
+  "2024-01-12",
+  "2024-01-13",
+  "2024-01-14",
+  "2024-01-15",
+  "2024-01-16",
+  "2024-01-17",
+  "2024-01-18",
+  "2024-01-19",
+  "2024-01-20",
+  "2024-01-21",
+  "2024-01-22",
+  "2024-01-23",
+  "2024-01-24",
+  "2024-01-25",
+  "2024-01-26",
+  "2024-01-27",
+  "2024-01-28",
+  "2024-01-29",
+  "2024-01-30",
+  "2024-01-31",
+  "2024-02-01",
+]
+`;
+
+exports[`splitDateRangeIntoDays given {"from":"2025-01-01","to":""}, returns an array of days 1`] = `[]`;
+
+exports[`splitDateRangeIntoDays given {"from":"asdf","to":"2345"}, returns an array of days 1`] = `[]`;

package/src/lib/functions/add-offset.function.spec.ts

@@ -0,0 +1,12 @@
+import { addOffset } from './add-offset.function';
+
+describe('addOffset', () => {
+    describe('GIVEN input is partial or full ISO8601', () => {
+        it.each([
+            '2023-12-23',
+            '2023-12-23T00:00:00.000',
+        ])('%j', (input) => {
+            expect(addOffset(input)).toMatchSnapshot();
+        });
+    });
+});

package/src/lib/functions/add-offset.function.ts

@@ -0,0 +1,14 @@
+import { MILLIS_PER_MINUTE } from '../constants/millis-per-minute.constant';
+import { tryParseDate } from './try-parse-date.function';
+
+export function addOffset(input: string | Date | undefined | null): Date | undefined {
+    const parsed = tryParseDate(input);
+
+    if(!parsed) {
+        return;
+    }
+
+    const offset = (parsed).getTimezoneOffset();
+
+    return new Date(parsed.valueOf() + offset * MILLIS_PER_MINUTE);
+}

package/src/lib/functions/arrange-act-assert.function.ts

@@ -0,0 +1,23 @@
+// YOU MUST AWAIT THIS FUNCTION WHEN INVOKING IT!!!
+
+// TODO: PUT THIS IN A TEST-ONLY LIBRARY => LIBS/ISO/JEST
+
+export async function arrangeActAssert<TArrangeOutput, TActOutput>({ arrange, act, assert }: { arrange: () => TArrangeOutput, act: (_: TArrangeOutput) => TActOutput, assert: (_: TArrangeOutput & { result: TActOutput }) => any }) {
+    const arrangeOutput = arrange();
+
+    const actInput = isPromise(arrangeOutput) ? await arrangeOutput : arrangeOutput;
+
+    const actOutput = act(actInput);
+
+    const assertInput = isPromise(actOutput) ? await actOutput : actOutput;
+
+    const assertOutput = assert({ ...actInput, result: assertInput });
+
+    const returnValue = isPromise(assertOutput) ? await assertOutput : assertOutput;
+
+    return returnValue;
+}
+
+function isPromise(value: any) {
+    return (typeof value?.then) === 'function';
+}

package/src/lib/functions/camel-case.function.ts

@@ -0,0 +1,30 @@
+// https://github.com/lodash/lodash/blob/main/src/camelCase.ts
+
+import { toString } from './to-string.function';
+import { upperFirst } from './upper-first.function';
+import { words } from './words.function';
+
+/**
+ * Converts `string` to [camel case](https://en.wikipedia.org/wiki/CamelCase).
+ *
+ * @since 3.0.0
+ * @category String
+ * @param {string} [string=''] The string to convert.
+ * @returns {string} Returns the camel cased string.
+ * @see lowerCase, kebabCase, snakeCase, startCase, upperCase, upperFirst
+ * @example
+ *
+ * camelCase('Foo Bar')
+ * // => 'fooBar'
+ *
+ * camelCase('--foo-bar--')
+ * // => 'fooBar'
+ *
+ * camelCase('__FOO_BAR__')
+ * // => 'fooBar'
+ */
+export const camelCase = (string: string): string =>
+    (words(toString(string).replace(/['\u2019]/g, '')) as string[]).reduce((result: string, word: string, index: number) => {
+        word = word.toLowerCase();
+        return result + (index ? upperFirst(word) : word);
+    }, '');

package/src/lib/functions/chunk.function.spec.ts

@@ -0,0 +1,20 @@
+import { chunk } from './chunk.function';
+import { arrangeActAssert } from '../functions/arrange-act-assert.function';
+
+const array = ['one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight'];
+
+describe('chunk', () => {
+    it.each([
+        [1],
+        [2],
+        [3],
+        [4],
+        [5],
+    ])('given %j, returns an array of arrays', async (_) => await arrangeActAssert({
+        arrange: () => ({ subject: chunk }),
+        act: ({ subject }) => subject(array, _),
+        assert: ({ result }) => {
+            expect(result).toMatchSnapshot();
+        }
+    }));
+});

package/src/lib/functions/chunk.function.ts

@@ -0,0 +1,25 @@
+export function chunk<T>(array: T[], numDivisions: number): T[][] {
+    if (numDivisions <= 0) {
+        throw new Error('Number of divisions must be greater than or equal to 0');
+    }
+
+    if (array.length === 0) {
+        return [];
+    }
+
+    const result: T[][] = [];
+    const chunkSize = Math.ceil(array.length / numDivisions);
+
+    for (let i = 0; i < array.length; i += chunkSize) {
+        result.push(array.slice(i, i + chunkSize));
+    }
+
+    while (result.length > numDivisions) {
+        const lastChunk = result.pop();
+        if (lastChunk) {
+            result[result.length - 1].push(...lastChunk);
+        }
+    }
+
+    return result;
+}

package/src/lib/functions/convert-object-to-literal.function.spec.ts

@@ -0,0 +1,16 @@
+import { convertObjectToLiteral } from './convert-object-to-literal.function';
+
+const qty = 337;
+const price = 100;
+const product = 'flux-capacitor';
+
+describe('convertObjectToLiteral', () => {
+  it.each([[(k, v) => `${k}=${v}`, ' AND ', { qty, price, product }]])(
+    'converts an object to a string',
+    (literalFn, delimiter, obj) => {
+      expect(
+        convertObjectToLiteral(literalFn, delimiter, obj)
+      ).toMatchSnapshot();
+    }
+  );
+});

package/src/lib/functions/convert-object-to-literal.function.ts

@@ -0,0 +1,10 @@
+export function convertObjectToLiteral(
+  literalFn: (k: string, v: any) => string,
+  delimiter: string,
+  keyValuePairs: Record<string, any>
+) {
+  return Object.entries(keyValuePairs)
+    .filter(([, v]) => !!v || v === 0 || v === false)
+    .map(([k, v]) => literalFn(k, v?.toString?.()))
+    .join(delimiter);
+}

package/src/lib/functions/format-usd.function.ts

@@ -0,0 +1,4 @@
+export function formatUsd(rawAmount?: number | string) {
+    const amount = Number(rawAmount) || 0;
+    return new Intl.NumberFormat('en-US', { style: 'currency', currency: 'USD' }).format(amount);
+  }

package/src/lib/functions/from-boolean-string.function.ts

@@ -0,0 +1,3 @@
+export function fromBooleanString(value?: string) {
+  return value === 'true';
+}

package/src/lib/functions/from-calendar-date.function.spec.ts

@@ -0,0 +1,11 @@
+import { fromCalendarDate } from './from-calendar-date.function';
+
+describe('fromCalendarDate', () => {
+    describe('GIVEN input is partial or full ISO8601', () => {
+        it.each([
+            '2023-12-23',
+        ])('%j', (input) => {
+            expect(fromCalendarDate(input)).toMatchSnapshot();
+        });
+    });
+});

package/src/lib/functions/from-calendar-date.function.ts

@@ -0,0 +1,5 @@
+import { addOffset } from "./add-offset.function";
+
+export function fromCalendarDate(input: string | Date | undefined | null): Date | null {
+    return addOffset(input) || null;
+}

package/src/lib/functions/from-csv-string.function.ts

@@ -0,0 +1,3 @@
+export function fromCsvString(value?: string) {
+  return value ? value.split(',').map((v) => v.trim()) : [];
+}

package/src/lib/functions/get-date-last-month.function.ts

@@ -0,0 +1,6 @@
+import { MILLIS_PER_DAY } from "../constants/millis-per-day.constant";
+
+export function getDateLastMonth() {
+    const days = new Date().getUTCDate() + 1;
+    return new Date(Date.now() - (MILLIS_PER_DAY * days));
+}

package/src/lib/functions/get-date-range-for-month.function copy.ts

@@ -0,0 +1,8 @@
+import { MILLIS_PER_DAY } from "../constants/millis-per-day.constant";
+
+export function getDateRangeForMonth(year: number, month: number) {
+    const startDate = new Date(+Date.UTC(year, month + -1, 0) + MILLIS_PER_DAY);
+    const endDate = new Date(+Date.UTC(year, month + 0, 0) + MILLIS_PER_DAY);
+
+    return { startDate, endDate };
+}

package/src/lib/functions/get-date-range-for-month.function.ts

@@ -0,0 +1,8 @@
+import { MILLIS_PER_DAY } from "../constants/millis-per-day.constant";
+
+export function getDateRangeForMonth(year: number, month: number) {
+    const startDate = new Date(+Date.UTC(year, month + -1, 0) + MILLIS_PER_DAY);
+    const endDate = new Date(+Date.UTC(year, month + 0, 0) + MILLIS_PER_DAY);
+
+    return { startDate, endDate };
+}

package/src/lib/functions/get-tag.function.ts

@@ -0,0 +1,10 @@
+// https://github.com/lodash/lodash/blob/main/src/.internal/getTag.ts
+
+const toString = Object.prototype.toString
+
+export function getTag(value: any): string {
+    if (value == null) {
+        return value === undefined ? '[object Undefined]' : '[object Null]'
+    }
+    return toString.call(value)
+}

package/src/lib/functions/get-user-full-name.function.ts

@@ -0,0 +1,5 @@
+import { TNameable } from "../types/nameable.type";
+
+export function getUserFullName(user: TNameable | undefined): string {
+    return `${user?.firstName} ${user?.lastName}`;
+}

package/src/lib/functions/is-symbol.function.ts

@@ -0,0 +1,11 @@
+// https://github.com/lodash/lodash/blob/main/src/isSymbol.ts
+
+import { getTag } from './get-tag.function';
+
+export function isSymbol(value: any): boolean {
+    const type = typeof value;
+    return (
+        type === 'symbol' ||
+        (type === 'object' && value != null && getTag(value) === '[object Symbol]')
+    );
+}

package/src/lib/functions/is-valid-date.function.ts

@@ -0,0 +1,5 @@
+export function isValidDate(dateString: string | Date) {
+    const date = new Date(dateString);
+
+    return (date instanceof Date && !isNaN(date.getTime())) ? date : undefined;
+}

package/src/lib/functions/kebab-case.function.ts

@@ -0,0 +1,5 @@
+import { snakeCase } from "./snake-case.function";
+
+export function kebabCase(string: string) {
+  return snakeCase(string).replace(/_/g, '-');
+}

package/src/lib/functions/map-entities-to-options.function.ts

@@ -0,0 +1,11 @@
+export function mapEntitiesToOptions<TEntity extends { name?: string, id: string }>(
+    entities: Record<string, TEntity>,
+    ids: string[],
+    includeBlank = true,
+) {
+    const entityArray = ids?.length ? (ids?.map((value => ({ value, display: entities[value].name || entities[value].id })))) : [];
+
+    return includeBlank
+        ? [{ display: '', value: '' }, ...entityArray]
+        : entityArray;
+}

package/src/lib/functions/map-enum-to-array-of-values.function copy.ts

@@ -0,0 +1,3 @@
+export function mapEnumToArrayOfValues(enumeration: any): any {
+    return Object.entries(enumeration).map(([key, value]) => value) as string[];
+}

package/src/lib/functions/map-enum-to-array-of-values.function.ts

@@ -0,0 +1,3 @@
+export function mapEnumToArrayOfValues(enumeration: any): any {
+    return Object.entries(enumeration).map(([key, value]) => value) as string[];
+}