@etsoo/shared 1.1.19 → 1.1.20

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|

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
      */

package/lib/cjs/DomUtils.d.ts

@@ -55,7 +55,13 @@ export declare namespace DomUtils {
      * @param culture Detected culture
      */
     const getCulture: (items: DataTypes.CultureDefinition[], culture: string) => Readonly<{
-        readonly name: string;
+        readonly name: string; /**
+         * Cast data to target type
+         * @param source Source data
+         * @param template Template for generation
+         * @param keepSource Means even the template does not include the definition, still keep the item
+         * @returns Result
+         */
         readonly label: string;
         readonly resources: Readonly<DataTypes.StringRecord>;
         readonly compatibleName?: string[] | undefined;

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
      */

package/lib/mjs/DomUtils.d.ts

@@ -55,7 +55,13 @@ export declare namespace DomUtils {
      * @param culture Detected culture
      */
     const getCulture: (items: DataTypes.CultureDefinition[], culture: string) => Readonly<{
-        readonly name: string;
+        readonly name: string; /**
+         * Cast data to target type
+         * @param source Source data
+         * @param template Template for generation
+         * @param keepSource Means even the template does not include the definition, still keep the item
+         * @returns Result
+         */
         readonly label: string;
         readonly resources: Readonly<DataTypes.StringRecord>;
         readonly compatibleName?: string[] | undefined;

package/package.json

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

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
      */