@etsoo/shared 1.1.67 → 1.1.69

package/README.md

@@ -218,6 +218,8 @@ String and other related utilities
 |charsToNumber|Base64 chars to number|
 |correctTypes|Correct object's property value type|
 |equals|Two values equal|
+|exclude|Exclude specific items|
+|excludeAsync|Async exclude specific items|
 |formatInitial|Format inital character to lower case or upper case|
 |formatString|Format string with parameters|
 |getDataChanges|Get data changed fields with input data updated|

package/__tests__/Utils.ts

@@ -9,6 +9,8 @@ test('Tests for addBlankItem', () => {
     expect(options.length).toBe(3);
     expect(options[0].id).toBe('');
     expect(options[0].name).toBe('---');
+    Utils.addBlankItem(options, 'id', 'name');
+    expect(options.length).toBe(3);
 });
 
 test('Tests for correctTypes', () => {
@@ -65,6 +67,16 @@ test('Tests for getDataChanges', () => {
     expect(input.amount).toBeUndefined();
 });
 
+test('Tests for exclude', () => {
+    const options = [
+        { id1: 1, name: 'a' },
+        { id1: 2, name: 'b' }
+    ];
+    const result = Utils.exclude(options, 'id1', 1);
+    expect(result.length).toBe(1);
+    expect(result[0].id1).toBe(2);
+});
+
 test('Tests for formatInitial', () => {
     expect(Utils.formatInitial('HelloWorld')).toBe('helloWorld');
     expect('HelloWorld'.formatInitial(false)).toBe('helloWorld');

package/lib/cjs/Utils.d.ts

@@ -53,7 +53,7 @@ export declare namespace Utils {
      * @param labelField Label field, default is label
      * @param blankLabel Blank label, default is ---
      */
-    function addBlankItem<T extends object>(options: T[], idField?: string | keyof T, labelField?: unknown, blankLabel?: string): void;
+    function addBlankItem<T extends object>(options: T[], idField?: string | keyof T, labelField?: unknown, blankLabel?: string): T[];
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars
@@ -75,6 +75,26 @@ export declare namespace Utils {
      * @param strict Strict level, 0 with ==, 1 === but null equal undefined, 2 ===
      */
     function equals(v1: unknown, v2: unknown, strict?: number): boolean;
+    /**
+     * Exclude specific items
+     * @param items Items
+     * @param field Filter field
+     * @param excludedValues Excluded values
+     * @returns Result
+     */
+    function exclude<T extends {
+        [P in D]: DataTypes.IdType;
+    }, D extends string = 'id'>(items: T[], field: D, ...excludedValues: T[D][]): T[];
+    /**
+     * Async exclude specific items
+     * @param items Items
+     * @param field Filter field
+     * @param excludedValues Excluded values
+     * @returns Result
+     */
+    function excludeAsync<T extends {
+        [P in D]: DataTypes.IdType;
+    }, D extends string = 'id'>(items: Promise<T[] | undefined>, field: D, ...excludedValues: T[D][]): Promise<T[] | undefined>;
     /**
      * Format inital character to lower case or upper case
      * @param input Input string

package/lib/cjs/Utils.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Utils = void 0;
 const DataTypes_1 = require("./DataTypes");
@@ -60,11 +69,16 @@ var Utils;
      * @param blankLabel Blank label, default is ---
      */
     function addBlankItem(options, idField, labelField, blankLabel) {
-        const blankItem = {
-            [idField !== null && idField !== void 0 ? idField : 'id']: '',
-            [typeof labelField === 'string' ? labelField : 'label']: blankLabel !== null && blankLabel !== void 0 ? blankLabel : '---'
-        };
-        options.unshift(blankItem);
+        // Avoid duplicate blank items
+        idField !== null && idField !== void 0 ? idField : (idField = 'id');
+        if (options.length === 0 || Reflect.get(options[0], idField) !== '') {
+            const blankItem = {
+                [idField]: '',
+                [typeof labelField === 'string' ? labelField : 'label']: blankLabel !== null && blankLabel !== void 0 ? blankLabel : '---'
+            };
+            options.unshift(blankItem);
+        }
+        return options;
     }
     Utils.addBlankItem = addBlankItem;
     /**
@@ -122,6 +136,33 @@ var Utils;
         return v1 === v2;
     }
     Utils.equals = equals;
+    /**
+     * Exclude specific items
+     * @param items Items
+     * @param field Filter field
+     * @param excludedValues Excluded values
+     * @returns Result
+     */
+    function exclude(items, field, ...excludedValues) {
+        return items.filter((item) => !excludedValues.includes(item[field]));
+    }
+    Utils.exclude = exclude;
+    /**
+     * Async exclude specific items
+     * @param items Items
+     * @param field Filter field
+     * @param excludedValues Excluded values
+     * @returns Result
+     */
+    function excludeAsync(items, field, ...excludedValues) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield items;
+            if (result == null)
+                return result;
+            return exclude(result, field, ...excludedValues);
+        });
+    }
+    Utils.excludeAsync = excludeAsync;
     /**
      * Format inital character to lower case or upper case
      * @param input Input string

package/lib/mjs/Utils.d.ts

@@ -53,7 +53,7 @@ export declare namespace Utils {
      * @param labelField Label field, default is label
      * @param blankLabel Blank label, default is ---
      */
-    function addBlankItem<T extends object>(options: T[], idField?: string | keyof T, labelField?: unknown, blankLabel?: string): void;
+    function addBlankItem<T extends object>(options: T[], idField?: string | keyof T, labelField?: unknown, blankLabel?: string): T[];
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars
@@ -75,6 +75,26 @@ export declare namespace Utils {
      * @param strict Strict level, 0 with ==, 1 === but null equal undefined, 2 ===
      */
     function equals(v1: unknown, v2: unknown, strict?: number): boolean;
+    /**
+     * Exclude specific items
+     * @param items Items
+     * @param field Filter field
+     * @param excludedValues Excluded values
+     * @returns Result
+     */
+    function exclude<T extends {
+        [P in D]: DataTypes.IdType;
+    }, D extends string = 'id'>(items: T[], field: D, ...excludedValues: T[D][]): T[];
+    /**
+     * Async exclude specific items
+     * @param items Items
+     * @param field Filter field
+     * @param excludedValues Excluded values
+     * @returns Result
+     */
+    function excludeAsync<T extends {
+        [P in D]: DataTypes.IdType;
+    }, D extends string = 'id'>(items: Promise<T[] | undefined>, field: D, ...excludedValues: T[D][]): Promise<T[] | undefined>;
     /**
      * Format inital character to lower case or upper case
      * @param input Input string

package/lib/mjs/Utils.js

@@ -1,3 +1,12 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 import { DataTypes } from './DataTypes';
 String.prototype.format = function (...parameters) {
     let template = this;
@@ -57,11 +66,16 @@ export var Utils;
      * @param blankLabel Blank label, default is ---
      */
     function addBlankItem(options, idField, labelField, blankLabel) {
-        const blankItem = {
-            [idField !== null && idField !== void 0 ? idField : 'id']: '',
-            [typeof labelField === 'string' ? labelField : 'label']: blankLabel !== null && blankLabel !== void 0 ? blankLabel : '---'
-        };
-        options.unshift(blankItem);
+        // Avoid duplicate blank items
+        idField !== null && idField !== void 0 ? idField : (idField = 'id');
+        if (options.length === 0 || Reflect.get(options[0], idField) !== '') {
+            const blankItem = {
+                [idField]: '',
+                [typeof labelField === 'string' ? labelField : 'label']: blankLabel !== null && blankLabel !== void 0 ? blankLabel : '---'
+            };
+            options.unshift(blankItem);
+        }
+        return options;
     }
     Utils.addBlankItem = addBlankItem;
     /**
@@ -119,6 +133,33 @@ export var Utils;
         return v1 === v2;
     }
     Utils.equals = equals;
+    /**
+     * Exclude specific items
+     * @param items Items
+     * @param field Filter field
+     * @param excludedValues Excluded values
+     * @returns Result
+     */
+    function exclude(items, field, ...excludedValues) {
+        return items.filter((item) => !excludedValues.includes(item[field]));
+    }
+    Utils.exclude = exclude;
+    /**
+     * Async exclude specific items
+     * @param items Items
+     * @param field Filter field
+     * @param excludedValues Excluded values
+     * @returns Result
+     */
+    function excludeAsync(items, field, ...excludedValues) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield items;
+            if (result == null)
+                return result;
+            return exclude(result, field, ...excludedValues);
+        });
+    }
+    Utils.excludeAsync = excludeAsync;
     /**
      * Format inital character to lower case or upper case
      * @param input Input string

package/package.json

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

package/src/Utils.ts

@@ -125,12 +125,18 @@ export namespace Utils {
         labelField?: unknown,
         blankLabel?: string
     ) {
-        const blankItem: any = {
-            [idField ?? 'id']: '',
-            [typeof labelField === 'string' ? labelField : 'label']:
-                blankLabel ?? '---'
-        };
-        options.unshift(blankItem);
+        // Avoid duplicate blank items
+        idField ??= 'id';
+        if (options.length === 0 || Reflect.get(options[0], idField) !== '') {
+            const blankItem: any = {
+                [idField]: '',
+                [typeof labelField === 'string' ? labelField : 'label']:
+                    blankLabel ?? '---'
+            };
+            options.unshift(blankItem);
+        }
+
+        return options;
     }
 
     /**
@@ -193,6 +199,36 @@ export namespace Utils {
         return v1 === v2;
     }
 
+    /**
+     * Exclude specific items
+     * @param items Items
+     * @param field Filter field
+     * @param excludedValues Excluded values
+     * @returns Result
+     */
+    export function exclude<
+        T extends { [P in D]: DataTypes.IdType },
+        D extends string = 'id'
+    >(items: T[], field: D, ...excludedValues: T[D][]) {
+        return items.filter((item) => !excludedValues.includes(item[field]));
+    }
+
+    /**
+     * Async exclude specific items
+     * @param items Items
+     * @param field Filter field
+     * @param excludedValues Excluded values
+     * @returns Result
+     */
+    export async function excludeAsync<
+        T extends { [P in D]: DataTypes.IdType },
+        D extends string = 'id'
+    >(items: Promise<T[] | undefined>, field: D, ...excludedValues: T[D][]) {
+        const result = await items;
+        if (result == null) return result;
+        return exclude(result, field, ...excludedValues);
+    }
+
     /**
      * Format inital character to lower case or upper case
      * @param input Input string