@etsoo/shared 1.1.57 → 1.1.59

package/README.md

@@ -100,6 +100,7 @@ Data type definitions and type safe functions. ListItemType and ListItemType1 ar
 |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|
 |KeyCollection|Key collection, like { key1: {}, key2: {} }|
 |Keys|Get specific type keys|
 |ObjType|Generic object type|
@@ -130,6 +131,7 @@ Data type definitions and type safe functions. ListItemType and ListItemType1 ar
 |isBasicName|Check the type is a basic type or not (type guard)|
 |isSimpleObject|Is the target a simple object, all values are simple type (Type guard)|
 |isSimpleType|Is the input value simple type, include null and undefined|
+|jsonReplacer|JSON.stringify replacer with full path|
 
 
 ## DateUtils

package/__tests__/DataTypes.ts

@@ -154,3 +154,29 @@ test('Tests for IdDefaultType', () => {
     const v1 = test<D, LabelDefaultType<D>>(data, 'label');
     expect(v1).toBe('label');
 });
+
+test('Tests for jsonReplacer', () => {
+    const obj = { a: 1, b: 'hello', c: { c1: 'C1', c2: false, c3: 128 } };
+
+    const json1 = JSON.stringify(
+        obj,
+        DataTypes.jsonReplacer(function (key, value, path) {
+            if (['', 'a'].includes(key)) {
+                return value;
+            }
+            return undefined;
+        })
+    );
+    expect(json1).toBe('{"a":1}');
+
+    const json2 = JSON.stringify(
+        obj,
+        DataTypes.jsonReplacer(function (key, value, path) {
+            if (['', 'c'].includes(key) || path === 'c.c2') {
+                return value;
+            }
+            return undefined;
+        })
+    );
+    expect(json2).toBe('{"c":{"c2":false}}');
+});

package/lib/cjs/DataTypes.d.ts

@@ -173,6 +173,15 @@ export declare namespace DataTypes {
          */
         label: string;
     };
+    /**
+     * Item with id and name property
+     */
+    type IdNameItem<T extends IdType = number> = IdItem<T> & {
+        /**
+         * name field
+         */
+        name: string;
+    };
     /**
      * Item with id and label dynamic type
      */
@@ -330,6 +339,11 @@ export declare namespace DataTypes {
      * @param includeArray Is array included, first non null element shoud also be basic type
      */
     function isSimpleType(input: unknown, includeArray?: boolean): boolean;
+    /**
+     * JSON.stringify replacer with full path
+     * https://stackoverflow.com/questions/61681176/json-stringify-replacer-how-to-get-full-path
+     */
+    function jsonReplacer(replacer: (this: any, key: string, value: any, path: string) => any): (this: any, key: any, value: any) => any;
 }
 /**
  * List item with number id type

package/lib/cjs/DataTypes.js

@@ -391,4 +391,18 @@ var DataTypes;
         return true;
     }
     DataTypes.isSimpleType = isSimpleType;
+    /**
+     * JSON.stringify replacer with full path
+     * https://stackoverflow.com/questions/61681176/json-stringify-replacer-how-to-get-full-path
+     */
+    function jsonReplacer(replacer) {
+        const m = new Map();
+        return function (key, value) {
+            const path = m.get(this) + (Array.isArray(this) ? `[${key}]` : '.' + key);
+            if (value === Object(value))
+                m.set(value, path);
+            return replacer.call(this, key, value, path.replace(/undefined\.\.?/, ''));
+        };
+    }
+    DataTypes.jsonReplacer = jsonReplacer;
 })(DataTypes = exports.DataTypes || (exports.DataTypes = {}));

package/lib/mjs/DataTypes.d.ts

@@ -173,6 +173,15 @@ export declare namespace DataTypes {
          */
         label: string;
     };
+    /**
+     * Item with id and name property
+     */
+    type IdNameItem<T extends IdType = number> = IdItem<T> & {
+        /**
+         * name field
+         */
+        name: string;
+    };
     /**
      * Item with id and label dynamic type
      */
@@ -330,6 +339,11 @@ export declare namespace DataTypes {
      * @param includeArray Is array included, first non null element shoud also be basic type
      */
     function isSimpleType(input: unknown, includeArray?: boolean): boolean;
+    /**
+     * JSON.stringify replacer with full path
+     * https://stackoverflow.com/questions/61681176/json-stringify-replacer-how-to-get-full-path
+     */
+    function jsonReplacer(replacer: (this: any, key: string, value: any, path: string) => any): (this: any, key: any, value: any) => any;
 }
 /**
  * List item with number id type

package/lib/mjs/DataTypes.js

@@ -388,4 +388,18 @@ export var DataTypes;
         return true;
     }
     DataTypes.isSimpleType = isSimpleType;
+    /**
+     * JSON.stringify replacer with full path
+     * https://stackoverflow.com/questions/61681176/json-stringify-replacer-how-to-get-full-path
+     */
+    function jsonReplacer(replacer) {
+        const m = new Map();
+        return function (key, value) {
+            const path = m.get(this) + (Array.isArray(this) ? `[${key}]` : '.' + key);
+            if (value === Object(value))
+                m.set(value, path);
+            return replacer.call(this, key, value, path.replace(/undefined\.\.?/, ''));
+        };
+    }
+    DataTypes.jsonReplacer = jsonReplacer;
 })(DataTypes || (DataTypes = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.57",
+    "version": "1.1.59",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -54,15 +54,15 @@
     },
     "homepage": "https://github.com/ETSOO/Shared#readme",
     "devDependencies": {
-        "@types/jest": "^29.0.3",
-        "@typescript-eslint/eslint-plugin": "^5.37.0",
-        "@typescript-eslint/parser": "^5.37.0",
-        "eslint": "^8.23.1",
+        "@types/jest": "^29.1.1",
+        "@typescript-eslint/eslint-plugin": "^5.38.1",
+        "@typescript-eslint/parser": "^5.38.1",
+        "eslint": "^8.24.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.26.0",
-        "jest": "^29.0.3",
-        "jest-environment-jsdom": "^29.0.3",
-        "ts-jest": "^29.0.1",
-        "typescript": "^4.8.3"
+        "jest": "^29.1.2",
+        "jest-environment-jsdom": "^29.1.2",
+        "ts-jest": "^29.0.3",
+        "typescript": "^4.8.4"
     }
 }

package/src/DataTypes.ts

@@ -219,6 +219,16 @@ export namespace DataTypes {
         label: string;
     };
 
+    /**
+     * Item with id and name property
+     */
+    export type IdNameItem<T extends IdType = number> = IdItem<T> & {
+        /**
+         * name field
+         */
+        name: string;
+    };
+
     /**
      * Item with id and label dynamic type
      */
@@ -657,6 +667,29 @@ export namespace DataTypes {
 
         return true;
     }
+
+    /**
+     * JSON.stringify replacer with full path
+     * https://stackoverflow.com/questions/61681176/json-stringify-replacer-how-to-get-full-path
+     */
+    export function jsonReplacer(
+        replacer: (this: any, key: string, value: any, path: string) => any
+    ) {
+        const m = new Map();
+
+        return function (this: any, key: any, value: any) {
+            const path =
+                m.get(this) + (Array.isArray(this) ? `[${key}]` : '.' + key);
+            if (value === Object(value)) m.set(value, path);
+
+            return replacer.call(
+                this,
+                key,
+                value,
+                path.replace(/undefined\.\.?/, '')
+            );
+        };
+    }
 }
 
 /**