@etsoo/shared 1.1.89 → 1.1.90

package/README.md

@@ -272,6 +272,8 @@ String and other related utilities
 |replaceNullOrEmpty|Replace null or empty with default value|
 |setLabels|Set source with new labels|
 |snakeNameToWord|Snake name to works, 'snake_name' to 'Snake Name'|
+|sortByFavor|Sort array by favored values|
+|sortByFieldFavor|Sort array by favored field values|
 |trim|Trim chars|
 |trimEnd|Trim end chars|
 |trimStart|Trim start chars|

package/__tests__/Utils.ts

@@ -228,6 +228,29 @@ test('Tests for getResult', () => {
     expect(valueResult).toBe(5);
 });
 
+test('Tests for sortByFavor', () => {
+    const items = [1, 2, 3, 4, 5, 6, 7];
+    expect(Utils.sortByFavor(items, [5, 1, 3])).toStrictEqual([
+        5, 1, 3, 2, 4, 6, 7
+    ]);
+});
+
+test('Tests for sortByFieldFavor', () => {
+    const options = [
+        { id: 'a', name: 'a1' },
+        { id: 'b', name: 'b2' },
+        { id: 'c', name: 'c3' },
+        { id: 'd', name: 'd4' },
+        { id: 'e', name: 'e5' },
+        { id: 'f', name: 'f6' }
+    ];
+    expect(
+        Utils.sortByFieldFavor(options, 'id', ['e', 'a', 'c']).map(
+            (option) => option.name
+        )
+    ).toStrictEqual(['e5', 'a1', 'c3', 'b2', 'd4', 'f6']);
+});
+
 test('Tests for trim', () => {
     expect(Utils.trim('//a/', '/')).toBe('a');
     expect(Utils.trim('/*/a/', ...['/', '*'])).toBe('a');

package/lib/cjs/Utils.d.ts

@@ -254,6 +254,21 @@ export declare namespace Utils {
      * @param firstOnly Only convert the first word to upper case
      */
     const snakeNameToWord: (name: string, firstOnly?: boolean) => string;
+    /**
+     * Sort array by favored values
+     * @param items Items
+     * @param favored Favored values
+     * @returns Sorted array
+     */
+    const sortByFavor: <T>(items: T[], favored: T[]) => T[];
+    /**
+     * Sort array by favored field values
+     * @param items Items
+     * @param field Field to sort
+     * @param favored Favored field values
+     * @returns Sorted array
+     */
+    const sortByFieldFavor: <T, F extends keyof T>(items: T[], field: F, favored: T[F][]) => T[];
     /**
      * Trim chars
      * @param input Input string

package/lib/cjs/Utils.js

@@ -487,6 +487,42 @@ var Utils;
         }
         return items.map((part) => part.formatInitial(true)).join(' ');
     };
+    function getSortValue(n1, n2) {
+        if (n1 === n2)
+            return 0;
+        if (n1 === -1)
+            return 1;
+        if (n2 === -1)
+            return -1;
+        return n1 - n2;
+    }
+    /**
+     * Sort array by favored values
+     * @param items Items
+     * @param favored Favored values
+     * @returns Sorted array
+     */
+    Utils.sortByFavor = (items, favored) => {
+        return items.sort((r1, r2) => {
+            const n1 = favored.indexOf(r1);
+            const n2 = favored.indexOf(r2);
+            return getSortValue(n1, n2);
+        });
+    };
+    /**
+     * Sort array by favored field values
+     * @param items Items
+     * @param field Field to sort
+     * @param favored Favored field values
+     * @returns Sorted array
+     */
+    Utils.sortByFieldFavor = (items, field, favored) => {
+        return items.sort((r1, r2) => {
+            const n1 = favored.indexOf(r1[field]);
+            const n2 = favored.indexOf(r2[field]);
+            return getSortValue(n1, n2);
+        });
+    };
     /**
      * Trim chars
      * @param input Input string

package/lib/mjs/Utils.d.ts

@@ -254,6 +254,21 @@ export declare namespace Utils {
      * @param firstOnly Only convert the first word to upper case
      */
     const snakeNameToWord: (name: string, firstOnly?: boolean) => string;
+    /**
+     * Sort array by favored values
+     * @param items Items
+     * @param favored Favored values
+     * @returns Sorted array
+     */
+    const sortByFavor: <T>(items: T[], favored: T[]) => T[];
+    /**
+     * Sort array by favored field values
+     * @param items Items
+     * @param field Field to sort
+     * @param favored Favored field values
+     * @returns Sorted array
+     */
+    const sortByFieldFavor: <T, F extends keyof T>(items: T[], field: F, favored: T[F][]) => T[];
     /**
      * Trim chars
      * @param input Input string

package/lib/mjs/Utils.js

@@ -481,6 +481,42 @@ export var Utils;
         }
         return items.map((part) => part.formatInitial(true)).join(' ');
     };
+    function getSortValue(n1, n2) {
+        if (n1 === n2)
+            return 0;
+        if (n1 === -1)
+            return 1;
+        if (n2 === -1)
+            return -1;
+        return n1 - n2;
+    }
+    /**
+     * Sort array by favored values
+     * @param items Items
+     * @param favored Favored values
+     * @returns Sorted array
+     */
+    Utils.sortByFavor = (items, favored) => {
+        return items.sort((r1, r2) => {
+            const n1 = favored.indexOf(r1);
+            const n2 = favored.indexOf(r2);
+            return getSortValue(n1, n2);
+        });
+    };
+    /**
+     * Sort array by favored field values
+     * @param items Items
+     * @param field Field to sort
+     * @param favored Favored field values
+     * @returns Sorted array
+     */
+    Utils.sortByFieldFavor = (items, field, favored) => {
+        return items.sort((r1, r2) => {
+            const n1 = favored.indexOf(r1[field]);
+            const n2 = favored.indexOf(r2[field]);
+            return getSortValue(n1, n2);
+        });
+    };
     /**
      * Trim chars
      * @param input Input string

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.89",
+    "version": "1.1.90",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -56,8 +56,8 @@
     "devDependencies": {
         "@types/jest": "^29.4.0",
         "@types/lodash.isequal": "^4.5.6",
-        "jest": "^29.4.3",
-        "jest-environment-jsdom": "^29.4.3",
+        "jest": "^29.5.0",
+        "jest-environment-jsdom": "^29.5.0",
         "ts-jest": "^29.0.5",
         "typescript": "^4.9.5"
     },

package/src/Utils.ts

@@ -661,6 +661,46 @@ export namespace Utils {
         return items.map((part) => part.formatInitial(true)).join(' ');
     };
 
+    function getSortValue(n1: number, n2: number) {
+        if (n1 === n2) return 0;
+        if (n1 === -1) return 1;
+        if (n2 === -1) return -1;
+        return n1 - n2;
+    }
+
+    /**
+     * Sort array by favored values
+     * @param items Items
+     * @param favored Favored values
+     * @returns Sorted array
+     */
+    export const sortByFavor = <T>(items: T[], favored: T[]) => {
+        return items.sort((r1, r2) => {
+            const n1 = favored.indexOf(r1);
+            const n2 = favored.indexOf(r2);
+            return getSortValue(n1, n2);
+        });
+    };
+
+    /**
+     * Sort array by favored field values
+     * @param items Items
+     * @param field Field to sort
+     * @param favored Favored field values
+     * @returns Sorted array
+     */
+    export const sortByFieldFavor = <T, F extends keyof T>(
+        items: T[],
+        field: F,
+        favored: T[F][]
+    ) => {
+        return items.sort((r1, r2) => {
+            const n1 = favored.indexOf(r1[field]);
+            const n2 = favored.indexOf(r2[field]);
+            return getSortValue(n1, n2);
+        });
+    };
+
     /**
      * Trim chars
      * @param input Input string