@etsoo/shared 1.2.9 → 1.2.11

package/README.md

@@ -136,13 +136,16 @@ Data type definitions and type safe functions. ListItemType, ListItemType1 and L
 |Func<R>|Function type, R is return type|
 |HAlign|Horizontal align|
 |HAlignEnum|Horizontal align enum|
+|IdDefaultType|Id default type|
 |IdType|Number and string combination id type|
 |IdItem|Item with id or id generator|
 |IdLabelItem|Item with id and label|
 |IdLabelType|Item with id and label dynamic type|
 |IdNameItem|Item with id and name|
+|IdTitleItem|Item with id and title|
 |KeyCollection|Key collection, like { key1: {}, key2: {} }|
 |Keys|Get specific type keys|
+|LabelDefaultType|Label default type|
 |MConstructor|Mixins constructor|
 |ObjType|Generic object type|
 |Optional|Make properties optional|
@@ -155,6 +158,7 @@ Data type definitions and type safe functions. ListItemType, ListItemType1 and L
 |SimpleObject|Simple object, string key, simple type and null value Record|
 |StringDictionary|String key, string value Record|
 |StringRecord|String key, unknown value Record|
+|TitleDefaultType|Title default type|
 |VAlign|Vertical align|
 |VAlignEnum|Vertical align enum|
 |Methods||

package/__tests__/ArrayUtils.ts

@@ -62,3 +62,32 @@ test('Tests for maxItem / minItem', () => {
     const emptyItems: { id: string; amount: number }[] = [];
     expect(emptyItems.maxItem('amount')).toBeUndefined();
 });
+
+test('Tests for sortIds', () => {
+    const source = [
+        {
+            id: 'zh-Hans',
+            label: '中文（简体）, Chinese (Simplified)'
+        },
+        {
+            id: 'en',
+            label: '英语, English'
+        },
+        {
+            id: 'fr',
+            label: '法语, French'
+        },
+        {
+            id: 'de',
+            label: '德语, German'
+        },
+        {
+            id: 'zh-Hant',
+            label: '中文（繁体）, Chinese (Traditional)'
+        }
+    ];
+    source.sortByProperty('id', ['en', 'zh-Hans', 'zh-Hant']);
+
+    const ids = source.map((s) => s.id);
+    expect(ids).toStrictEqual(['en', 'zh-Hans', 'zh-Hant', 'fr', 'de']);
+});

package/lib/cjs/ArrayUtils.d.ts

@@ -27,6 +27,12 @@ declare global {
          * @param field Object field to calculate
          */
         minItem(field: T extends object ? DataTypes.Keys<T, number> : never): T | undefined;
+        /**
+         * Sort by property
+         * @param property Property
+         * @param values Property values
+         */
+        sortByProperty<P extends keyof T>(property: P, values: T[P][]): T[];
         /**
          * Sum number items or number item properties
          * @param field Object field to calculate

package/lib/cjs/ArrayUtils.js

@@ -41,6 +41,20 @@ Array.prototype.minItem = function (field) {
         return undefined;
     return this.reduce((prev, curr) => prev[field] < curr[field] ? prev : curr);
 };
+Array.prototype.sortByProperty = function (property, values) {
+    return this.sort((a, b) => {
+        const ai = values.indexOf(a[property]);
+        const bi = values.indexOf(b[property]);
+        if (ai === bi)
+            return 0;
+        if (ai < 0)
+            return bi;
+        else if (bi < 0)
+            return -ai;
+        else
+            return ai - bi;
+    });
+};
 Array.prototype.sum = function (field) {
     if (field == null) {
         return this.reduce((total, num) => total + num, 0);

package/lib/cjs/DataTypes.d.ts

@@ -224,6 +224,15 @@ export declare namespace DataTypes {
          */
         name: string;
     };
+    /**
+     * Item with id and title property
+     */
+    type IdTitleItem<T extends IdType = number> = IdItem<T> & {
+        /**
+         * title field
+         */
+        title: string;
+    };
     /**
      * Item with id and label dynamic type
      */
@@ -396,7 +405,7 @@ export type ListType = DataTypes.IdLabelItem<number>;
  */
 export type ListType1 = DataTypes.IdLabelItem<string>;
 /**
- * List item with compatible id and name / label
+ * List item with compatible id and name / label / title
  */
 export type ListType2 = {
     id: DataTypes.IdType;
@@ -404,6 +413,8 @@ export type ListType2 = {
     label: string;
 } | {
     name: string;
+} | {
+    title: string;
 });
 /**
  * Id default type
@@ -417,3 +428,9 @@ export type IdDefaultType<T extends object> = T extends {
 export type LabelDefaultType<T extends object> = T extends {
     label: string;
 } ? DataTypes.Keys<T, string> & 'label' : DataTypes.Keys<T, string>;
+/**
+ * Title default type
+ */
+export type TitleDefaultType<T extends object> = T extends {
+    title: string;
+} ? DataTypes.Keys<T, string> & 'title' : DataTypes.Keys<T, string>;

package/lib/mjs/ArrayUtils.d.ts

@@ -27,6 +27,12 @@ declare global {
          * @param field Object field to calculate
          */
         minItem(field: T extends object ? DataTypes.Keys<T, number> : never): T | undefined;
+        /**
+         * Sort by property
+         * @param property Property
+         * @param values Property values
+         */
+        sortByProperty<P extends keyof T>(property: P, values: T[P][]): T[];
         /**
          * Sum number items or number item properties
          * @param field Object field to calculate

package/lib/mjs/ArrayUtils.js

@@ -35,6 +35,20 @@ Array.prototype.minItem = function (field) {
         return undefined;
     return this.reduce((prev, curr) => prev[field] < curr[field] ? prev : curr);
 };
+Array.prototype.sortByProperty = function (property, values) {
+    return this.sort((a, b) => {
+        const ai = values.indexOf(a[property]);
+        const bi = values.indexOf(b[property]);
+        if (ai === bi)
+            return 0;
+        if (ai < 0)
+            return bi;
+        else if (bi < 0)
+            return -ai;
+        else
+            return ai - bi;
+    });
+};
 Array.prototype.sum = function (field) {
     if (field == null) {
         return this.reduce((total, num) => total + num, 0);

package/lib/mjs/DataTypes.d.ts

@@ -224,6 +224,15 @@ export declare namespace DataTypes {
          */
         name: string;
     };
+    /**
+     * Item with id and title property
+     */
+    type IdTitleItem<T extends IdType = number> = IdItem<T> & {
+        /**
+         * title field
+         */
+        title: string;
+    };
     /**
      * Item with id and label dynamic type
      */
@@ -396,7 +405,7 @@ export type ListType = DataTypes.IdLabelItem<number>;
  */
 export type ListType1 = DataTypes.IdLabelItem<string>;
 /**
- * List item with compatible id and name / label
+ * List item with compatible id and name / label / title
  */
 export type ListType2 = {
     id: DataTypes.IdType;
@@ -404,6 +413,8 @@ export type ListType2 = {
     label: string;
 } | {
     name: string;
+} | {
+    title: string;
 });
 /**
  * Id default type
@@ -417,3 +428,9 @@ export type IdDefaultType<T extends object> = T extends {
 export type LabelDefaultType<T extends object> = T extends {
     label: string;
 } ? DataTypes.Keys<T, string> & 'label' : DataTypes.Keys<T, string>;
+/**
+ * Title default type
+ */
+export type TitleDefaultType<T extends object> = T extends {
+    title: string;
+} ? DataTypes.Keys<T, string> & 'title' : DataTypes.Keys<T, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.2.9",
+    "version": "1.2.11",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/ArrayUtils.ts

@@ -50,6 +50,13 @@ declare global {
             field: T extends object ? DataTypes.Keys<T, number> : never
         ): T | undefined;
 
+        /**
+         * Sort by property
+         * @param property Property
+         * @param values Property values
+         */
+        sortByProperty<P extends keyof T>(property: P, values: T[P][]): T[];
+
         /**
          * Sum number items or number item properties
          * @param field Object field to calculate
@@ -134,6 +141,22 @@ Array.prototype.minItem = function <T>(
     );
 };
 
+Array.prototype.sortByProperty = function <T, P extends keyof T>(
+    this: Array<T>,
+    property: P,
+    values: T[P][]
+) {
+    return this.sort((a, b) => {
+        const ai = values.indexOf(a[property]);
+        const bi = values.indexOf(b[property]);
+
+        if (ai === bi) return 0;
+        if (ai < 0) return bi;
+        else if (bi < 0) return -ai;
+        else return ai - bi;
+    });
+};
+
 Array.prototype.sum = function <T>(
     this: Array<T>,
     field: T extends object ? DataTypes.Keys<T, number> : undefined

package/src/DataTypes.ts

@@ -278,6 +278,16 @@ export namespace DataTypes {
         name: string;
     };
 
+    /**
+     * Item with id and title property
+     */
+    export type IdTitleItem<T extends IdType = number> = IdItem<T> & {
+        /**
+         * title field
+         */
+        title: string;
+    };
+
     /**
      * Item with id and label dynamic type
      */
@@ -751,11 +761,11 @@ export type ListType = DataTypes.IdLabelItem<number>;
 export type ListType1 = DataTypes.IdLabelItem<string>;
 
 /**
- * List item with compatible id and name / label
+ * List item with compatible id and name / label / title
  */
 export type ListType2 = {
     id: DataTypes.IdType;
-} & ({ label: string } | { name: string });
+} & ({ label: string } | { name: string } | { title: string });
 
 /**
  * Id default type
@@ -770,3 +780,10 @@ export type IdDefaultType<T extends object> = T extends { id: number | string }
 export type LabelDefaultType<T extends object> = T extends { label: string }
     ? DataTypes.Keys<T, string> & 'label'
     : DataTypes.Keys<T, string>;
+
+/**
+ * Title default type
+ */
+export type TitleDefaultType<T extends object> = T extends { title: string }
+    ? DataTypes.Keys<T, string> & 'title'
+    : DataTypes.Keys<T, string>;