@etsoo/shared 1.1.18 → 1.1.21

package/README.md

@@ -68,6 +68,7 @@ Data type definitions and type safe functions
 |IdType|Number and string combination id type|
 |IdItem|Item with id or id generator|
 |IdLabelItem|Item with id and label|
+|KeyCollection|Key collection, like { key1: {}, key2: {} }|
 |Simple|Basic or basic array type|
 |SimpleEnum|Simple type enum|
 |SimpleNames|Simple type names|
@@ -190,5 +191,6 @@ String and other related utilities
 |objectUpdated|Get the new object's updated fields contrast to the previous object|
 |parseString|Parse string (JSON) to specific type|
 |removeNonLetters|Remove non letters (0-9, a-z, A-Z)|
+|replaceNullOrEmpty|Replace null or empty with default value|
 |setLabels|Set source with new labels|
 |snakeNameToWord|Snake name to works, 'snake_name' to 'Snake Name'|

package/__tests__/Utils.ts

@@ -126,6 +126,12 @@ test('Tests for removeNonLetters', () => {
     expect(input.removeNonLetters()).toBe(result);
 });
 
+test('Tests for replaceNullOrEmpty', () => {
+    expect(Utils.replaceNullOrEmpty('a', 's')).toBe('a');
+    expect(Utils.replaceNullOrEmpty(null, 's')).toBe('s');
+    expect(Utils.replaceNullOrEmpty(' ', 's')).toBe('s');
+});
+
 test('Tests for objectEqual', () => {
     const obj1 = { a: 1, b: 'abc', c: true, d: null, f: [1, 2] };
     const obj2 = { a: '1', b: 'abc', c: true, f: [1, 2] };

package/lib/cjs/DataTypes.d.ts

@@ -120,6 +120,12 @@ export declare namespace DataTypes {
     type AddOrEditType<T, Editing extends boolean> = (Editing extends true ? T : Partial<T>) & {
         changedFields?: string[];
     };
+    /**
+     * Key collection, like { key1: {}, key2: {} }
+     */
+    type KeyCollection<K extends readonly string[], I extends {}> = {
+        [index in K[number]]: I;
+    };
     /**
      * Enum value type
      */
@@ -177,7 +183,7 @@ export declare namespace DataTypes {
     /**
      * Culture definiton
      */
-    type CultureDefinition = Readonly<{
+    type CultureDefinition<T extends {} = StringRecord> = Readonly<{
         /**
          * Name, like zh-CN
          */
@@ -189,7 +195,7 @@ export declare namespace DataTypes {
         /**
          * Resources
          */
-        readonly resources: Readonly<StringRecord>;
+        readonly resources: Readonly<T>;
         /**
          * Compatible names
          */

package/lib/cjs/DomUtils.d.ts

@@ -54,10 +54,15 @@ export declare namespace DomUtils {
      * @param items Available cultures
      * @param culture Detected culture
      */
-    const getCulture: (items: DataTypes.CultureDefinition[], culture: string) => Readonly<{
+    const getCulture: <T extends {}>(items: Readonly<{
         readonly name: string;
         readonly label: string;
-        readonly resources: Readonly<DataTypes.StringRecord>;
+        readonly resources: Readonly<T>;
+        readonly compatibleName?: string[] | undefined;
+    }>[], culture: string) => Readonly<{
+        readonly name: string;
+        readonly label: string;
+        readonly resources: Readonly<T>;
         readonly compatibleName?: string[] | undefined;
     }> | undefined;
     /**

package/lib/cjs/Utils.d.ts

@@ -189,6 +189,13 @@ export declare namespace Utils {
      * @returns Result
      */
     const removeNonLetters: (input?: string | undefined) => string | undefined;
+    /**
+     * Replace null or empty with default value
+     * @param input Input string
+     * @param defaultValue Default value
+     * @returns Result
+     */
+    const replaceNullOrEmpty: (input: string | null | undefined, defaultValue: string) => string;
     /**
      * Set source with new labels
      * @param source Source

package/lib/cjs/Utils.js

@@ -371,6 +371,17 @@ var Utils;
     Utils.removeNonLetters = (input) => {
         return input === null || input === void 0 ? void 0 : input.removeNonLetters();
     };
+    /**
+     * Replace null or empty with default value
+     * @param input Input string
+     * @param defaultValue Default value
+     * @returns Result
+     */
+    Utils.replaceNullOrEmpty = (input, defaultValue) => {
+        if (input == null || input.trim() === '')
+            return defaultValue;
+        return input;
+    };
     /**
      * Set source with new labels
      * @param source Source

package/lib/mjs/DataTypes.d.ts

@@ -120,6 +120,12 @@ export declare namespace DataTypes {
     type AddOrEditType<T, Editing extends boolean> = (Editing extends true ? T : Partial<T>) & {
         changedFields?: string[];
     };
+    /**
+     * Key collection, like { key1: {}, key2: {} }
+     */
+    type KeyCollection<K extends readonly string[], I extends {}> = {
+        [index in K[number]]: I;
+    };
     /**
      * Enum value type
      */
@@ -177,7 +183,7 @@ export declare namespace DataTypes {
     /**
      * Culture definiton
      */
-    type CultureDefinition = Readonly<{
+    type CultureDefinition<T extends {} = StringRecord> = Readonly<{
         /**
          * Name, like zh-CN
          */
@@ -189,7 +195,7 @@ export declare namespace DataTypes {
         /**
          * Resources
          */
-        readonly resources: Readonly<StringRecord>;
+        readonly resources: Readonly<T>;
         /**
          * Compatible names
          */

package/lib/mjs/DomUtils.d.ts

@@ -54,10 +54,15 @@ export declare namespace DomUtils {
      * @param items Available cultures
      * @param culture Detected culture
      */
-    const getCulture: (items: DataTypes.CultureDefinition[], culture: string) => Readonly<{
+    const getCulture: <T extends {}>(items: Readonly<{
         readonly name: string;
         readonly label: string;
-        readonly resources: Readonly<DataTypes.StringRecord>;
+        readonly resources: Readonly<T>;
+        readonly compatibleName?: string[] | undefined;
+    }>[], culture: string) => Readonly<{
+        readonly name: string;
+        readonly label: string;
+        readonly resources: Readonly<T>;
         readonly compatibleName?: string[] | undefined;
     }> | undefined;
     /**

package/lib/mjs/Utils.d.ts

@@ -189,6 +189,13 @@ export declare namespace Utils {
      * @returns Result
      */
     const removeNonLetters: (input?: string | undefined) => string | undefined;
+    /**
+     * Replace null or empty with default value
+     * @param input Input string
+     * @param defaultValue Default value
+     * @returns Result
+     */
+    const replaceNullOrEmpty: (input: string | null | undefined, defaultValue: string) => string;
     /**
      * Set source with new labels
      * @param source Source

package/lib/mjs/Utils.js

@@ -368,6 +368,17 @@ export var Utils;
     Utils.removeNonLetters = (input) => {
         return input === null || input === void 0 ? void 0 : input.removeNonLetters();
     };
+    /**
+     * Replace null or empty with default value
+     * @param input Input string
+     * @param defaultValue Default value
+     * @returns Result
+     */
+    Utils.replaceNullOrEmpty = (input, defaultValue) => {
+        if (input == null || input.trim() === '')
+            return defaultValue;
+        return input;
+    };
     /**
      * Set source with new labels
      * @param source Source

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.18",
+    "version": "1.1.21",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -55,11 +55,11 @@
     "dependencies": {},
     "devDependencies": {
         "@types/jest": "^27.4.1",
-        "@typescript-eslint/eslint-plugin": "^5.16.0",
-        "@typescript-eslint/parser": "^5.16.0",
-        "eslint": "^8.11.0",
+        "@typescript-eslint/eslint-plugin": "^5.20.0",
+        "@typescript-eslint/parser": "^5.20.0",
+        "eslint": "^8.14.0",
         "eslint-config-airbnb-base": "^15.0.0",
-        "eslint-plugin-import": "^2.25.4",
+        "eslint-plugin-import": "^2.26.0",
         "jest": "^27.5.1",
         "ts-jest": "^27.1.4",
         "typescript": "^4.6.3"

package/src/DataTypes.ts

@@ -156,6 +156,13 @@ export namespace DataTypes {
         Editing extends boolean
     > = (Editing extends true ? T : Partial<T>) & { changedFields?: string[] };
 
+    /**
+     * Key collection, like { key1: {}, key2: {} }
+     */
+    export type KeyCollection<K extends readonly string[], I extends {}> = {
+        [index in K[number]]: I;
+    };
+
     /**
      * Enum value type
      */
@@ -230,7 +237,7 @@ export namespace DataTypes {
     /**
      * Culture definiton
      */
-    export type CultureDefinition = Readonly<{
+    export type CultureDefinition<T extends {} = StringRecord> = Readonly<{
         /**
          * Name, like zh-CN
          */
@@ -244,7 +251,7 @@ export namespace DataTypes {
         /**
          * Resources
          */
-        readonly resources: Readonly<StringRecord>;
+        readonly resources: Readonly<T>;
 
         /**
          * Compatible names

package/src/DomUtils.ts

@@ -281,8 +281,8 @@ export namespace DomUtils {
      * @param items Available cultures
      * @param culture Detected culture
      */
-    export const getCulture = (
-        items: DataTypes.CultureDefinition[],
+    export const getCulture = <T extends {}>(
+        items: DataTypes.CultureDefinition<T>[],
         culture: string
     ) => {
         if (items.length === 0) {

package/src/Utils.ts

@@ -516,6 +516,20 @@ export namespace Utils {
         return input?.removeNonLetters();
     };
 
+    /**
+     * Replace null or empty with default value
+     * @param input Input string
+     * @param defaultValue Default value
+     * @returns Result
+     */
+    export const replaceNullOrEmpty = (
+        input: string | null | undefined,
+        defaultValue: string
+    ) => {
+        if (input == null || input.trim() === '') return defaultValue;
+        return input;
+    };
+
     /**
      * Set source with new labels
      * @param source Source