@onivoro/isomorphic-common 22.0.3 → 22.0.5

package/dist/cjs/index.d.ts

@@ -5,14 +5,23 @@ export * from './lib/constants/millis-per-minute.constant';
 export * from './lib/functions/add-offset.function';
 export * from './lib/functions/camel-case.function';
 export * from './lib/functions/convert-object-to-literal.function';
+export * from './lib/functions/format-usd.function';
 export * from './lib/functions/from-boolean-string.function';
 export * from './lib/functions/from-calendar-date.function';
 export * from './lib/functions/from-csv-string.function';
+export * from './lib/functions/get-date-range-for-month.function';
+export * from './lib/functions/is-symbol.function';
+export * from './lib/functions/is-valid-date.function';
 export * from './lib/functions/kebab-case.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/money.function';
 export * from './lib/functions/parse-bool.function';
 export * from './lib/functions/properties-to-array.function';
 export * from './lib/functions/remove-alpha-chars.function';
+export * from './lib/functions/remove-element-at-index.function';
+export * from './lib/functions/round.function';
 export * from './lib/functions/sleep.function';
 export * from './lib/functions/sanitize-filename.function';
 export * from './lib/functions/snake-case.function';
@@ -31,3 +40,4 @@ 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';

package/dist/cjs/index.js

@@ -21,14 +21,23 @@ __exportStar(require("./lib/constants/millis-per-minute.constant"), exports);
 __exportStar(require("./lib/functions/add-offset.function"), exports);
 __exportStar(require("./lib/functions/camel-case.function"), exports);
 __exportStar(require("./lib/functions/convert-object-to-literal.function"), exports);
+__exportStar(require("./lib/functions/format-usd.function"), exports);
 __exportStar(require("./lib/functions/from-boolean-string.function"), exports);
 __exportStar(require("./lib/functions/from-calendar-date.function"), exports);
 __exportStar(require("./lib/functions/from-csv-string.function"), exports);
+__exportStar(require("./lib/functions/get-date-range-for-month.function"), exports);
+__exportStar(require("./lib/functions/is-symbol.function"), exports);
+__exportStar(require("./lib/functions/is-valid-date.function"), exports);
 __exportStar(require("./lib/functions/kebab-case.function"), exports);
+__exportStar(require("./lib/functions/map-enum-to-array-of-values.function"), exports);
+__exportStar(require("./lib/functions/map-enum-to-lookup-array.function"), exports);
+__exportStar(require("./lib/functions/map-enum-to-options.function"), exports);
 __exportStar(require("./lib/functions/money.function"), exports);
 __exportStar(require("./lib/functions/parse-bool.function"), exports);
 __exportStar(require("./lib/functions/properties-to-array.function"), exports);
 __exportStar(require("./lib/functions/remove-alpha-chars.function"), exports);
+__exportStar(require("./lib/functions/remove-element-at-index.function"), exports);
+__exportStar(require("./lib/functions/round.function"), exports);
 __exportStar(require("./lib/functions/sleep.function"), exports);
 __exportStar(require("./lib/functions/sanitize-filename.function"), exports);
 __exportStar(require("./lib/functions/snake-case.function"), exports);
@@ -47,3 +56,4 @@ __exportStar(require("./lib/functions/words.function"), exports);
 __exportStar(require("./lib/interfaces/axios-wrapped-nest-exception.interface"), exports);
 __exportStar(require("./lib/interfaces/entity-provider.interface"), exports);
 __exportStar(require("./lib/interfaces/keys-of.type"), exports);
+__exportStar(require("./lib/interfaces/lookup.interface"), exports);

package/dist/cjs/lib/functions/format-usd.function.d.ts

@@ -0,0 +1 @@
+export declare function formatUsd(rawAmount?: number | string): string;

package/dist/cjs/lib/functions/format-usd.function.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatUsd = formatUsd;
+function formatUsd(rawAmount) {
+    const amount = Number(rawAmount) || 0;
+    return new Intl.NumberFormat('en-US', { style: 'currency', currency: 'USD' }).format(amount);
+}

package/dist/cjs/lib/functions/get-date-range-for-month.function.d.ts

@@ -0,0 +1,4 @@
+export declare function getDateRangeForMonth(year: number, month: number): {
+    startDate: Date;
+    endDate: Date;
+};

package/dist/cjs/lib/functions/get-date-range-for-month.function.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDateRangeForMonth = getDateRangeForMonth;
+const millis_per_day_constant_1 = require("../constants/millis-per-day.constant");
+function getDateRangeForMonth(year, month) {
+    const startDate = new Date(+Date.UTC(year, month + -1, 0) + millis_per_day_constant_1.MILLIS_PER_DAY);
+    const endDate = new Date(+Date.UTC(year, month + 0, 0) + millis_per_day_constant_1.MILLIS_PER_DAY);
+    return { startDate, endDate };
+}

package/dist/cjs/lib/functions/is-valid-date.function.d.ts

@@ -0,0 +1 @@
+export declare function isValidDate(dateString: string | Date): Date | undefined;

package/dist/cjs/lib/functions/is-valid-date.function.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidDate = isValidDate;
+function isValidDate(dateString) {
+    const date = new Date(dateString);
+    return (date instanceof Date && !isNaN(date.getTime())) ? date : undefined;
+}

package/dist/cjs/lib/functions/map-enum-to-array-of-values.function.d.ts

@@ -0,0 +1 @@
+export declare function mapEnumToArrayOfValues(enumeration: any): any;

package/dist/cjs/lib/functions/map-enum-to-array-of-values.function.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapEnumToArrayOfValues = mapEnumToArrayOfValues;
+function mapEnumToArrayOfValues(enumeration) {
+    return Object.entries(enumeration).map(([key, value]) => value);
+}

package/dist/cjs/lib/functions/map-enum-to-lookup-array.function.d.ts

@@ -0,0 +1,2 @@
+import { ILookup } from "../interfaces/lookup.interface";
+export declare function mapEnumToLookupArray<TEnum extends object>(enumeration: TEnum): ILookup<string, string>[];

package/dist/cjs/lib/functions/map-enum-to-lookup-array.function.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapEnumToLookupArray = mapEnumToLookupArray;
+function mapEnumToLookupArray(enumeration) {
+    return Object.entries(enumeration)
+        .map(([key, value]) => ({ value, display: key.replace(/_/g, ' ') }));
+}

package/dist/cjs/lib/functions/map-enum-to-options.function.d.ts

@@ -0,0 +1,4 @@
+export declare function mapEnumToOptions<TEntity extends object>(enumeration: TEntity, includeBlank?: boolean): {
+    value: any;
+    display: string;
+}[];

package/dist/cjs/lib/functions/map-enum-to-options.function.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapEnumToOptions = mapEnumToOptions;
+function mapEnumToOptions(enumeration, includeBlank = true) {
+    const enumArray = Object.entries(enumeration).map(([key, value]) => ({ value, display: key.replace(/_/g, ' ') }));
+    return includeBlank
+        ? [{ display: '', value: '' }, ...enumArray]
+        : enumArray;
+}

package/dist/cjs/lib/functions/remove-element-at-index.function.d.ts

@@ -0,0 +1 @@
+export declare function removeElementAtIndex<T>(array: T[], indexToRemove: number): T[];

package/dist/cjs/lib/functions/remove-element-at-index.function.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeElementAtIndex = removeElementAtIndex;
+function removeElementAtIndex(array, indexToRemove) {
+    const newArray = [];
+    (array || []).forEach((element, index) => {
+        if (index !== indexToRemove) {
+            newArray.push(element);
+        }
+    });
+    return newArray;
+}

package/dist/cjs/lib/functions/round.function.d.ts

@@ -0,0 +1 @@
+export declare function round(numberToRound: number, scalingFactor: number): number;

package/dist/cjs/lib/functions/round.function.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.round = round;
+function round(numberToRound, scalingFactor) {
+    const scaledServingDose = numberToRound * scalingFactor;
+    return Math.round(scaledServingDose) / scalingFactor;
+}

package/dist/cjs/lib/interfaces/lookup.interface.d.ts

@@ -0,0 +1,4 @@
+export interface ILookup<TDisplay, TValue> {
+    display: TDisplay;
+    value: TValue;
+}

package/dist/cjs/lib/interfaces/lookup.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/index.d.ts

@@ -5,14 +5,23 @@ export * from './lib/constants/millis-per-minute.constant';
 export * from './lib/functions/add-offset.function';
 export * from './lib/functions/camel-case.function';
 export * from './lib/functions/convert-object-to-literal.function';
+export * from './lib/functions/format-usd.function';
 export * from './lib/functions/from-boolean-string.function';
 export * from './lib/functions/from-calendar-date.function';
 export * from './lib/functions/from-csv-string.function';
+export * from './lib/functions/get-date-range-for-month.function';
+export * from './lib/functions/is-symbol.function';
+export * from './lib/functions/is-valid-date.function';
 export * from './lib/functions/kebab-case.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/money.function';
 export * from './lib/functions/parse-bool.function';
 export * from './lib/functions/properties-to-array.function';
 export * from './lib/functions/remove-alpha-chars.function';
+export * from './lib/functions/remove-element-at-index.function';
+export * from './lib/functions/round.function';
 export * from './lib/functions/sleep.function';
 export * from './lib/functions/sanitize-filename.function';
 export * from './lib/functions/snake-case.function';
@@ -31,3 +40,4 @@ 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';

package/dist/esm/index.js

@@ -21,14 +21,23 @@ __exportStar(require("./lib/constants/millis-per-minute.constant"), exports);
 __exportStar(require("./lib/functions/add-offset.function"), exports);
 __exportStar(require("./lib/functions/camel-case.function"), exports);
 __exportStar(require("./lib/functions/convert-object-to-literal.function"), exports);
+__exportStar(require("./lib/functions/format-usd.function"), exports);
 __exportStar(require("./lib/functions/from-boolean-string.function"), exports);
 __exportStar(require("./lib/functions/from-calendar-date.function"), exports);
 __exportStar(require("./lib/functions/from-csv-string.function"), exports);
+__exportStar(require("./lib/functions/get-date-range-for-month.function"), exports);
+__exportStar(require("./lib/functions/is-symbol.function"), exports);
+__exportStar(require("./lib/functions/is-valid-date.function"), exports);
 __exportStar(require("./lib/functions/kebab-case.function"), exports);
+__exportStar(require("./lib/functions/map-enum-to-array-of-values.function"), exports);
+__exportStar(require("./lib/functions/map-enum-to-lookup-array.function"), exports);
+__exportStar(require("./lib/functions/map-enum-to-options.function"), exports);
 __exportStar(require("./lib/functions/money.function"), exports);
 __exportStar(require("./lib/functions/parse-bool.function"), exports);
 __exportStar(require("./lib/functions/properties-to-array.function"), exports);
 __exportStar(require("./lib/functions/remove-alpha-chars.function"), exports);
+__exportStar(require("./lib/functions/remove-element-at-index.function"), exports);
+__exportStar(require("./lib/functions/round.function"), exports);
 __exportStar(require("./lib/functions/sleep.function"), exports);
 __exportStar(require("./lib/functions/sanitize-filename.function"), exports);
 __exportStar(require("./lib/functions/snake-case.function"), exports);
@@ -47,3 +56,4 @@ __exportStar(require("./lib/functions/words.function"), exports);
 __exportStar(require("./lib/interfaces/axios-wrapped-nest-exception.interface"), exports);
 __exportStar(require("./lib/interfaces/entity-provider.interface"), exports);
 __exportStar(require("./lib/interfaces/keys-of.type"), exports);
+__exportStar(require("./lib/interfaces/lookup.interface"), exports);

package/dist/esm/lib/functions/format-usd.function.d.ts

@@ -0,0 +1 @@
+export declare function formatUsd(rawAmount?: number | string): string;

package/dist/esm/lib/functions/format-usd.function.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatUsd = formatUsd;
+function formatUsd(rawAmount) {
+    const amount = Number(rawAmount) || 0;
+    return new Intl.NumberFormat('en-US', { style: 'currency', currency: 'USD' }).format(amount);
+}

package/dist/esm/lib/functions/get-date-range-for-month.function.d.ts

@@ -0,0 +1,4 @@
+export declare function getDateRangeForMonth(year: number, month: number): {
+    startDate: Date;
+    endDate: Date;
+};

package/dist/esm/lib/functions/get-date-range-for-month.function.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDateRangeForMonth = getDateRangeForMonth;
+const millis_per_day_constant_1 = require("../constants/millis-per-day.constant");
+function getDateRangeForMonth(year, month) {
+    const startDate = new Date(+Date.UTC(year, month + -1, 0) + millis_per_day_constant_1.MILLIS_PER_DAY);
+    const endDate = new Date(+Date.UTC(year, month + 0, 0) + millis_per_day_constant_1.MILLIS_PER_DAY);
+    return { startDate, endDate };
+}

package/dist/esm/lib/functions/is-valid-date.function.d.ts

@@ -0,0 +1 @@
+export declare function isValidDate(dateString: string | Date): Date | undefined;

package/dist/esm/lib/functions/is-valid-date.function.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidDate = isValidDate;
+function isValidDate(dateString) {
+    const date = new Date(dateString);
+    return (date instanceof Date && !isNaN(date.getTime())) ? date : undefined;
+}

package/dist/esm/lib/functions/map-enum-to-array-of-values.function.d.ts

@@ -0,0 +1 @@
+export declare function mapEnumToArrayOfValues(enumeration: any): any;

package/dist/esm/lib/functions/map-enum-to-array-of-values.function.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapEnumToArrayOfValues = mapEnumToArrayOfValues;
+function mapEnumToArrayOfValues(enumeration) {
+    return Object.entries(enumeration).map(([key, value]) => value);
+}

package/dist/esm/lib/functions/map-enum-to-lookup-array.function.d.ts

@@ -0,0 +1,2 @@
+import { ILookup } from "../interfaces/lookup.interface";
+export declare function mapEnumToLookupArray<TEnum extends object>(enumeration: TEnum): ILookup<string, string>[];

package/dist/esm/lib/functions/map-enum-to-lookup-array.function.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapEnumToLookupArray = mapEnumToLookupArray;
+function mapEnumToLookupArray(enumeration) {
+    return Object.entries(enumeration)
+        .map(([key, value]) => ({ value, display: key.replace(/_/g, ' ') }));
+}

package/dist/esm/lib/functions/map-enum-to-options.function.d.ts

@@ -0,0 +1,4 @@
+export declare function mapEnumToOptions<TEntity extends object>(enumeration: TEntity, includeBlank?: boolean): {
+    value: any;
+    display: string;
+}[];

package/dist/esm/lib/functions/map-enum-to-options.function.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapEnumToOptions = mapEnumToOptions;
+function mapEnumToOptions(enumeration, includeBlank = true) {
+    const enumArray = Object.entries(enumeration).map(([key, value]) => ({ value, display: key.replace(/_/g, ' ') }));
+    return includeBlank
+        ? [{ display: '', value: '' }, ...enumArray]
+        : enumArray;
+}

package/dist/esm/lib/functions/remove-element-at-index.function.d.ts

@@ -0,0 +1 @@
+export declare function removeElementAtIndex<T>(array: T[], indexToRemove: number): T[];

package/dist/esm/lib/functions/remove-element-at-index.function.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeElementAtIndex = removeElementAtIndex;
+function removeElementAtIndex(array, indexToRemove) {
+    const newArray = [];
+    (array || []).forEach((element, index) => {
+        if (index !== indexToRemove) {
+            newArray.push(element);
+        }
+    });
+    return newArray;
+}

package/dist/esm/lib/functions/round.function.d.ts

@@ -0,0 +1 @@
+export declare function round(numberToRound: number, scalingFactor: number): number;

package/dist/esm/lib/functions/round.function.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.round = round;
+function round(numberToRound, scalingFactor) {
+    const scaledServingDose = numberToRound * scalingFactor;
+    return Math.round(scaledServingDose) / scalingFactor;
+}

package/dist/esm/lib/interfaces/lookup.interface.d.ts

@@ -0,0 +1,4 @@
+export interface ILookup<TDisplay, TValue> {
+    display: TDisplay;
+    value: TValue;
+}

package/dist/esm/lib/interfaces/lookup.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -5,14 +5,23 @@ export * from './lib/constants/millis-per-minute.constant';
 export * from './lib/functions/add-offset.function';
 export * from './lib/functions/camel-case.function';
 export * from './lib/functions/convert-object-to-literal.function';
+export * from './lib/functions/format-usd.function';
 export * from './lib/functions/from-boolean-string.function';
 export * from './lib/functions/from-calendar-date.function';
 export * from './lib/functions/from-csv-string.function';
+export * from './lib/functions/get-date-range-for-month.function';
+export * from './lib/functions/is-symbol.function';
+export * from './lib/functions/is-valid-date.function';
 export * from './lib/functions/kebab-case.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/money.function';
 export * from './lib/functions/parse-bool.function';
 export * from './lib/functions/properties-to-array.function';
 export * from './lib/functions/remove-alpha-chars.function';
+export * from './lib/functions/remove-element-at-index.function';
+export * from './lib/functions/round.function';
 export * from './lib/functions/sleep.function';
 export * from './lib/functions/sanitize-filename.function';
 export * from './lib/functions/snake-case.function';
@@ -31,3 +40,4 @@ 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';

package/dist/types/lib/functions/format-usd.function.d.ts

@@ -0,0 +1 @@
+export declare function formatUsd(rawAmount?: number | string): string;

package/dist/types/lib/functions/get-date-range-for-month.function.d.ts

@@ -0,0 +1,4 @@
+export declare function getDateRangeForMonth(year: number, month: number): {
+    startDate: Date;
+    endDate: Date;
+};

package/dist/types/lib/functions/is-valid-date.function.d.ts

@@ -0,0 +1 @@
+export declare function isValidDate(dateString: string | Date): Date | undefined;

package/dist/types/lib/functions/map-enum-to-array-of-values.function.d.ts

@@ -0,0 +1 @@
+export declare function mapEnumToArrayOfValues(enumeration: any): any;

package/dist/types/lib/functions/map-enum-to-lookup-array.function.d.ts

@@ -0,0 +1,2 @@
+import { ILookup } from "../interfaces/lookup.interface";
+export declare function mapEnumToLookupArray<TEnum extends object>(enumeration: TEnum): ILookup<string, string>[];

package/dist/types/lib/functions/map-enum-to-options.function.d.ts

@@ -0,0 +1,4 @@
+export declare function mapEnumToOptions<TEntity extends object>(enumeration: TEntity, includeBlank?: boolean): {
+    value: any;
+    display: string;
+}[];

package/dist/types/lib/functions/remove-element-at-index.function.d.ts

@@ -0,0 +1 @@
+export declare function removeElementAtIndex<T>(array: T[], indexToRemove: number): T[];

package/dist/types/lib/functions/round.function.d.ts

@@ -0,0 +1 @@
+export declare function round(numberToRound: number, scalingFactor: number): number;

package/dist/types/lib/interfaces/lookup.interface.d.ts

@@ -0,0 +1,4 @@
+export interface ILookup<TDisplay, TValue> {
+    display: TDisplay;
+    value: TValue;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@onivoro/isomorphic-common",
-    "version": "22.0.3",
+    "version": "22.0.5",
     "repository": {
         "url": "git+https://github.com/onivoro/isomorphic-common.git"
     },