@etsoo/shared 1.1.98 → 1.2.0

package/README.md

@@ -103,7 +103,9 @@ Array related utilities
 |---:|---|
 |differences|Array 1 items do not exist in Array 2 or reverse match|
 |max|Get max number item or number item property|
+|maxItem|Get max field value item|
 |min|Get min number item or number item property|
+|minItem|Get min field value item|
 |sum|Sum number items or number item properties|
 |toUnique|Make all items are unique|
 

package/__tests__/ArrayUtils.ts

@@ -44,8 +44,21 @@ test('Tests for max / min fields', () => {
     const items = [
         { id: 1, label: 'a', amount: 3.14 },
         { id: 2, label: 'b', amount: 4.54 },
-        { id: 2, label: 'b', amount: 1.52 }
+        { id: 3, label: 'b', amount: 1.52 }
     ];
     expect(items.max('amount')).toBe(4.54);
     expect(items.min('amount')).toBe(1.52);
 });
+
+test('Tests for maxItem / minItem', () => {
+    const items = [
+        { id: 1, label: 'a', amount: 3.14 },
+        { id: 2, label: 'b', amount: 4.54 },
+        { id: 3, label: 'b', amount: 1.52 }
+    ];
+    expect(items.maxItem('amount')?.id).toBe(2);
+    expect(items.minItem('amount')?.id).toBe(3);
+
+    const emptyItems: { id: string; amount: number }[] = [];
+    expect(emptyItems.maxItem('amount')).toBeUndefined();
+});

package/lib/cjs/ArrayUtils.d.ts

@@ -12,11 +12,21 @@ declare global {
          * @param field Object field to calculate
          */
         max(...field: T extends number ? [undefined?] : T extends object ? [DataTypes.Keys<T, number>] : [never]): number;
+        /**
+         * Get max field value item
+         * @param field Object field to calculate
+         */
+        maxItem(field: T extends object ? DataTypes.Keys<T, number> : never): T | undefined;
         /**
          * Get min number item or number item property
          * @param field Object field to calculate
          */
         min(...field: T extends number ? [undefined?] : T extends object ? [DataTypes.Keys<T, number>] : [never]): number;
+        /**
+         * Get min field value item
+         * @param field Object field to calculate
+         */
+        minItem(field: T extends object ? DataTypes.Keys<T, number> : never): T | undefined;
         /**
          * Sum number items or number item properties
          * @param field Object field to calculate

package/lib/cjs/ArrayUtils.js

@@ -25,12 +25,22 @@ Array.prototype.max = function (field) {
     }
     return Math.max(...this.map((item) => item[field]));
 };
+Array.prototype.maxItem = function (field) {
+    if (this.length === 0)
+        return undefined;
+    return this.reduce((prev, curr) => prev[field] > curr[field] ? prev : curr);
+};
 Array.prototype.min = function (field) {
     if (field == null) {
         return Math.min(...this);
     }
     return Math.min(...this.map((item) => item[field]));
 };
+Array.prototype.minItem = function (field) {
+    if (this.length === 0)
+        return undefined;
+    return this.reduce((prev, curr) => prev[field] < curr[field] ? prev : curr);
+};
 Array.prototype.sum = function (field) {
     if (field == null) {
         return this.reduce((total, num) => total + num, 0);

package/lib/cjs/DateUtils.d.ts

@@ -19,6 +19,8 @@ export interface TimeSpan {
     totalMonths: number;
     totalYears: number;
 }
+type DateType = Date | string | null | undefined;
+type DateReturn<T extends DateType, R> = T extends Date ? R : R | undefined;
 export declare namespace DateUtils {
     /**
      * Day format, YYYY-MM-DD
@@ -43,13 +45,13 @@ export declare namespace DateUtils {
      * @param options Options
      * @param timeZone Time zone
      */
-    function format(input?: Date | string, locale?: string | string[], options?: FormatOptions, timeZone?: string): string | undefined;
+    function format<T extends DateType>(input: T, locale?: string | string[], options?: FormatOptions, timeZone?: string): DateReturn<T, string>;
     /**
      * Format to 'yyyy-MM-dd' or 'yyyy-MM-ddThh:mm:ss, especially used for date input min/max property
      * @param date Input date
      * @param hasSecondOrType 'undefined' for date only, 'false' for hour:minute only, 'true' for all, or input field type
      */
-    function formatForInput(date?: Date | string | null, hasSecondOrType?: boolean | string): string | undefined;
+    function formatForInput<T extends DateType>(date: T, hasSecondOrType?: boolean | string): DateReturn<T, string>;
     /**
      * Get month's days
      * @param year Year
@@ -75,7 +77,7 @@ export declare namespace DateUtils {
      * @param input Input string
      * @returns Date
      */
-    function parse(input?: Date | string | null): Date | undefined;
+    function parse<T extends DateType>(input: T): DateReturn<T, Date>;
     /**
      * Two dates are in the same day
      * @param d1 First date
@@ -91,3 +93,4 @@ export declare namespace DateUtils {
      */
     function sameMonth(d1?: Date | string | null, d2?: Date | string | null): boolean;
 }
+export {};

package/lib/cjs/DateUtils.js

@@ -101,8 +101,7 @@ var DateUtils;
         if (date == null || date === '')
             return undefined;
         // Parse string as date
-        if (typeof date === 'string')
-            date = new Date(date);
+        const dt = typeof date === 'string' ? new Date(date) : date;
         const hasSecond = typeof hasSecondOrType === 'string'
             ? hasSecondOrType === 'date'
                 ? undefined
@@ -110,20 +109,20 @@ var DateUtils;
             : hasSecondOrType;
         // Parts
         const parts = [
-            date.getFullYear(),
-            (date.getMonth() + 1).toString().padStart(2, '0'),
-            date.getDate().toString().padStart(2, '0')
+            dt.getFullYear(),
+            (dt.getMonth() + 1).toString().padStart(2, '0'),
+            dt.getDate().toString().padStart(2, '0')
         ];
         // Date
         const d = parts.join('-');
         if (hasSecond == null)
             return d;
         const hm = [
-            date.getHours().toString().padStart(2, '0'),
-            date.getMinutes().toString().padStart(2, '0')
+            dt.getHours().toString().padStart(2, '0'),
+            dt.getMinutes().toString().padStart(2, '0')
         ];
         if (hasSecond)
-            hm.push(date.getSeconds().toString().padStart(2, '0'));
+            hm.push(dt.getSeconds().toString().padStart(2, '0'));
         return `${d}T${hm.join(':')}`;
     }
     DateUtils.formatForInput = formatForInput;

package/lib/mjs/ArrayUtils.d.ts

@@ -12,11 +12,21 @@ declare global {
          * @param field Object field to calculate
          */
         max(...field: T extends number ? [undefined?] : T extends object ? [DataTypes.Keys<T, number>] : [never]): number;
+        /**
+         * Get max field value item
+         * @param field Object field to calculate
+         */
+        maxItem(field: T extends object ? DataTypes.Keys<T, number> : never): T | undefined;
         /**
          * Get min number item or number item property
          * @param field Object field to calculate
          */
         min(...field: T extends number ? [undefined?] : T extends object ? [DataTypes.Keys<T, number>] : [never]): number;
+        /**
+         * Get min field value item
+         * @param field Object field to calculate
+         */
+        minItem(field: T extends object ? DataTypes.Keys<T, number> : never): T | undefined;
         /**
          * Sum number items or number item properties
          * @param field Object field to calculate

package/lib/mjs/ArrayUtils.js

@@ -19,12 +19,22 @@ Array.prototype.max = function (field) {
     }
     return Math.max(...this.map((item) => item[field]));
 };
+Array.prototype.maxItem = function (field) {
+    if (this.length === 0)
+        return undefined;
+    return this.reduce((prev, curr) => prev[field] > curr[field] ? prev : curr);
+};
 Array.prototype.min = function (field) {
     if (field == null) {
         return Math.min(...this);
     }
     return Math.min(...this.map((item) => item[field]));
 };
+Array.prototype.minItem = function (field) {
+    if (this.length === 0)
+        return undefined;
+    return this.reduce((prev, curr) => prev[field] < curr[field] ? prev : curr);
+};
 Array.prototype.sum = function (field) {
     if (field == null) {
         return this.reduce((total, num) => total + num, 0);

package/lib/mjs/DateUtils.d.ts

@@ -19,6 +19,8 @@ export interface TimeSpan {
     totalMonths: number;
     totalYears: number;
 }
+type DateType = Date | string | null | undefined;
+type DateReturn<T extends DateType, R> = T extends Date ? R : R | undefined;
 export declare namespace DateUtils {
     /**
      * Day format, YYYY-MM-DD
@@ -43,13 +45,13 @@ export declare namespace DateUtils {
      * @param options Options
      * @param timeZone Time zone
      */
-    function format(input?: Date | string, locale?: string | string[], options?: FormatOptions, timeZone?: string): string | undefined;
+    function format<T extends DateType>(input: T, locale?: string | string[], options?: FormatOptions, timeZone?: string): DateReturn<T, string>;
     /**
      * Format to 'yyyy-MM-dd' or 'yyyy-MM-ddThh:mm:ss, especially used for date input min/max property
      * @param date Input date
      * @param hasSecondOrType 'undefined' for date only, 'false' for hour:minute only, 'true' for all, or input field type
      */
-    function formatForInput(date?: Date | string | null, hasSecondOrType?: boolean | string): string | undefined;
+    function formatForInput<T extends DateType>(date: T, hasSecondOrType?: boolean | string): DateReturn<T, string>;
     /**
      * Get month's days
      * @param year Year
@@ -75,7 +77,7 @@ export declare namespace DateUtils {
      * @param input Input string
      * @returns Date
      */
-    function parse(input?: Date | string | null): Date | undefined;
+    function parse<T extends DateType>(input: T): DateReturn<T, Date>;
     /**
      * Two dates are in the same day
      * @param d1 First date
@@ -91,3 +93,4 @@ export declare namespace DateUtils {
      */
     function sameMonth(d1?: Date | string | null, d2?: Date | string | null): boolean;
 }
+export {};

package/lib/mjs/DateUtils.js

@@ -98,8 +98,7 @@ export var DateUtils;
         if (date == null || date === '')
             return undefined;
         // Parse string as date
-        if (typeof date === 'string')
-            date = new Date(date);
+        const dt = typeof date === 'string' ? new Date(date) : date;
         const hasSecond = typeof hasSecondOrType === 'string'
             ? hasSecondOrType === 'date'
                 ? undefined
@@ -107,20 +106,20 @@ export var DateUtils;
             : hasSecondOrType;
         // Parts
         const parts = [
-            date.getFullYear(),
-            (date.getMonth() + 1).toString().padStart(2, '0'),
-            date.getDate().toString().padStart(2, '0')
+            dt.getFullYear(),
+            (dt.getMonth() + 1).toString().padStart(2, '0'),
+            dt.getDate().toString().padStart(2, '0')
         ];
         // Date
         const d = parts.join('-');
         if (hasSecond == null)
             return d;
         const hm = [
-            date.getHours().toString().padStart(2, '0'),
-            date.getMinutes().toString().padStart(2, '0')
+            dt.getHours().toString().padStart(2, '0'),
+            dt.getMinutes().toString().padStart(2, '0')
         ];
         if (hasSecond)
-            hm.push(date.getSeconds().toString().padStart(2, '0'));
+            hm.push(dt.getSeconds().toString().padStart(2, '0'));
         return `${d}T${hm.join(':')}`;
     }
     DateUtils.formatForInput = formatForInput;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.98",
+    "version": "1.2.0",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -59,7 +59,7 @@
         "jest": "^29.5.0",
         "jest-environment-jsdom": "^29.5.0",
         "ts-jest": "^29.1.0",
-        "typescript": "^5.0.3"
+        "typescript": "^5.0.4"
     },
     "dependencies": {
         "lodash.isequal": "^4.5.0"

package/src/ArrayUtils.ts

@@ -22,6 +22,14 @@ declare global {
                 : [never]
         ): number;
 
+        /**
+         * Get max field value item
+         * @param field Object field to calculate
+         */
+        maxItem(
+            field: T extends object ? DataTypes.Keys<T, number> : never
+        ): T | undefined;
+
         /**
          * Get min number item or number item property
          * @param field Object field to calculate
@@ -34,6 +42,14 @@ declare global {
                 : [never]
         ): number;
 
+        /**
+         * Get min field value item
+         * @param field Object field to calculate
+         */
+        minItem(
+            field: T extends object ? DataTypes.Keys<T, number> : never
+        ): T | undefined;
+
         /**
          * Sum number items or number item properties
          * @param field Object field to calculate
@@ -85,6 +101,17 @@ Array.prototype.max = function <T>(
     return Math.max(...this.map((item) => item[field] as number));
 };
 
+Array.prototype.maxItem = function <T>(
+    this: Array<T>,
+    field: T extends object ? DataTypes.Keys<T, number> : never
+) {
+    if (this.length === 0) return undefined;
+
+    return this.reduce((prev, curr) =>
+        prev[field] > curr[field] ? prev : curr
+    );
+};
+
 Array.prototype.min = function <T>(
     this: Array<T>,
     field: T extends object ? DataTypes.Keys<T, number> : undefined
@@ -96,6 +123,17 @@ Array.prototype.min = function <T>(
     return Math.min(...this.map((item) => item[field] as number));
 };
 
+Array.prototype.minItem = function <T>(
+    this: Array<T>,
+    field: T extends object ? DataTypes.Keys<T, number> : never
+) {
+    if (this.length === 0) return undefined;
+
+    return this.reduce((prev, curr) =>
+        prev[field] < curr[field] ? prev : curr
+    );
+};
+
 Array.prototype.sum = function <T>(
     this: Array<T>,
     field: T extends object ? DataTypes.Keys<T, number> : undefined

package/src/DateUtils.ts

@@ -63,6 +63,10 @@ export interface TimeSpan {
     totalYears: number;
 }
 
+type DateType = Date | string | null | undefined;
+
+type DateReturn<T extends DateType, R> = T extends Date ? R : R | undefined;
+
 export namespace DateUtils {
     /**
      * Day format, YYYY-MM-DD
@@ -103,17 +107,17 @@ export namespace DateUtils {
      * @param options Options
      * @param timeZone Time zone
      */
-    export function format(
-        input?: Date | string,
+    export function format<T extends DateType>(
+        input: T,
         locale?: string | string[],
         options?: FormatOptions,
         timeZone?: string
-    ) {
+    ): DateReturn<T, string> {
         // Parse
         const parsed = parse(input);
 
         // Null case
-        if (parsed == null) return undefined;
+        if (parsed == null) return <DateReturn<T, string>>undefined;
 
         // Default options
         options ??= DayFormat;
@@ -149,15 +153,16 @@ export namespace DateUtils {
      * @param date Input date
      * @param hasSecondOrType 'undefined' for date only, 'false' for hour:minute only, 'true' for all, or input field type
      */
-    export function formatForInput(
-        date?: Date | string | null,
+    export function formatForInput<T extends DateType>(
+        date: T,
         hasSecondOrType?: boolean | string
-    ) {
+    ): DateReturn<T, string> {
         // Return when null
-        if (date == null || date === '') return undefined;
+        if (date == null || date === '')
+            return <DateReturn<T, string>>undefined;
 
         // Parse string as date
-        if (typeof date === 'string') date = new Date(date);
+        const dt: Date = typeof date === 'string' ? new Date(date) : date;
 
         const hasSecond =
             typeof hasSecondOrType === 'string'
@@ -168,9 +173,9 @@ export namespace DateUtils {
 
         // Parts
         const parts = [
-            date.getFullYear(),
-            (date.getMonth() + 1).toString().padStart(2, '0'),
-            date.getDate().toString().padStart(2, '0')
+            dt.getFullYear(),
+            (dt.getMonth() + 1).toString().padStart(2, '0'),
+            dt.getDate().toString().padStart(2, '0')
         ];
 
         // Date
@@ -178,10 +183,10 @@ export namespace DateUtils {
         if (hasSecond == null) return d;
 
         const hm = [
-            date.getHours().toString().padStart(2, '0'),
-            date.getMinutes().toString().padStart(2, '0')
+            dt.getHours().toString().padStart(2, '0'),
+            dt.getMinutes().toString().padStart(2, '0')
         ];
-        if (hasSecond) hm.push(date.getSeconds().toString().padStart(2, '0'));
+        if (hasSecond) hm.push(dt.getSeconds().toString().padStart(2, '0'));
         return `${d}T${hm.join(':')}`;
     }
 
@@ -235,17 +240,17 @@ export namespace DateUtils {
      * @param input Input string
      * @returns Date
      */
-    export function parse(input?: Date | string | null) {
-        if (input == null) return undefined;
+    export function parse<T extends DateType>(input: T): DateReturn<T, Date> {
+        if (input == null) return <DateReturn<T, Date>>undefined;
         if (typeof input === 'string') {
             const f = input[0];
             if (f >= '0' && f <= '9' && /[-\/\s]/g.test(input)) {
                 const n = Date.parse(input);
                 if (!isNaN(n)) return new Date(n);
             }
-            return undefined;
+            return <DateReturn<T, Date>>undefined;
         }
-        return input;
+        return <Date>input;
     }
 
     /**