@brillout/json-serializer 0.5.5 → 0.5.7

package/dist/cjs/stringify.d.ts

@@ -1,7 +1,12 @@
 export { stringify };
+export { isJsonSerializerError };
 declare function stringify(value: unknown, { forbidReactElements, space, valueName, sortObjectKeys }?: {
     forbidReactElements?: boolean;
     space?: number;
     valueName?: string;
     sortObjectKeys?: boolean;
 }): string;
+type JsonSerializerError = Error & {
+    messageCore: string;
+};
+declare function isJsonSerializerError(thing: unknown): thing is JsonSerializerError;

package/dist/cjs/stringify.js

@@ -1,30 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringify = void 0;
+exports.isJsonSerializerError = exports.stringify = void 0;
 const types_1 = require("./types");
 const isReactElement_1 = require("./utils/isReactElement");
 const isCallable_1 = require("./utils/isCallable");
 const isObject_1 = require("./utils/isObject");
-function stringify(value, { forbidReactElements, space, valueName = 'value', sortObjectKeys } = {}) {
-    const path = [];
+const replacerWithPath_1 = require("./utils/replacerWithPath");
+function stringify(value, { forbidReactElements, space, valueName, sortObjectKeys } = {}) {
     // The only error `JSON.stringify()` can throw is `TypeError "cyclic object value"`.
     // - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#exceptions
     // - This means we have total of 3 possible errors while serializing:
     //    - Cyclic references
     //    - Functions
     //    - React elements
-    const serializer = (val) => JSON.stringify(val, replacer, space);
+    const serializer = (val) => JSON.stringify(val, (0, replacerWithPath_1.replacerWithPath)(replacer, !valueName), space);
     return serializer(value);
-    function replacer(key, value) {
-        if (key !== '') {
-            path.push(key);
-        }
+    function replacer(key, value, path) {
         if (forbidReactElements && (0, isReactElement_1.isReactElement)(value)) {
-            throw new Error(genErrMsg('React element'));
+            throw genErr(genErrMsg('React element', path, valueName));
         }
         if ((0, isCallable_1.isCallable)(value)) {
             const functionName = value.name;
-            throw new Error(genErrMsg('function', path.length === 0 ? functionName : undefined));
+            throw genErr(genErrMsg('function', path, valueName, path.length === 0 ? functionName : undefined));
         }
         const valueOriginal = this[key];
         for (const { is, serialize } of types_1.types.slice().reverse()) {
@@ -44,11 +41,34 @@ function stringify(value, { forbidReactElements, space, valueName = 'value', sor
         }
         return value;
     }
-    function genErrMsg(valueType, valName) {
-        const name = valName ? ' `' + valName + '`' : '';
-        const location = path.length === 0 ? '' : ` ${name ? 'at ' : ''}\`${valueName}[${path.map((p) => `'${p}'`).join('][')}]\``;
-        const fallback = name === '' && location === '' ? ` ${valueName}` : '';
-        return `@brillout/json-serializer (https://github.com/brillout/json-serializer) cannot serialize${name}${location}${fallback} because it's a ${valueType}.`;
-    }
 }
 exports.stringify = stringify;
+const stamp = '_isJsonSerializerError';
+function genErr(errMsg) {
+    const err = new Error(`[@brillout/json-serializer](https://github.com/brillout/json-serializer) ${errMsg}.`);
+    Object.assign(err, {
+        messageCore: errMsg,
+        [stamp]: true
+    });
+    return err;
+}
+function isJsonSerializerError(thing) {
+    return (0, isObject_1.isObject)(thing) && thing[stamp] === true;
+}
+exports.isJsonSerializerError = isJsonSerializerError;
+function genErrMsg(valueType, path, rootValueName, problematicValueName) {
+    let subject;
+    if (!path) {
+        subject = rootValueName || problematicValueName || 'value';
+    }
+    else {
+        if (problematicValueName) {
+            subject = problematicValueName + ' at ';
+        }
+        else {
+            subject = '';
+        }
+        subject = subject + (rootValueName || '') + path;
+    }
+    return `cannot serialize ${subject} because it's a ${valueType}`;
+}

package/dist/cjs/types.d.ts

@@ -1,6 +1,6 @@
 export { types };
 declare const types: readonly [Type<undefined, unknown>, Type<number, unknown>, Type<number, unknown>, Type<number, unknown>, Type<Date, any>, Type<BigInt, any>, Type<RegExp, any>, Type<Map<any, any>, any[]>, Type<Set<unknown>, unknown[]>, Type<string, any>];
-declare type Type<T, IntermediateType> = {
+type Type<T, IntermediateType> = {
     is: (val: unknown) => asserts val is T;
     match: (str: string) => boolean;
     serialize: (val: T, serializer: (val: IntermediateType) => string) => string;

package/dist/cjs/utils/isKeyDotNotationCompatible.d.ts

@@ -0,0 +1 @@
+export declare function isKeyDotNotationCompatible(key: string): boolean;

package/dist/cjs/utils/isKeyDotNotationCompatible.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isKeyDotNotationCompatible = void 0;
+function isKeyDotNotationCompatible(key) {
+    return /^[a-z0-9\$_]+$/i.test(key);
+}
+exports.isKeyDotNotationCompatible = isKeyDotNotationCompatible;

package/dist/cjs/utils/isObject.d.ts

@@ -1,3 +1,3 @@
 export { isObject };
-declare type Object = Record<string, unknown>;
+type Object = Record<string, unknown>;
 declare function isObject(value: unknown): value is Object;

package/dist/cjs/utils/replacerWithPath.d.ts

@@ -0,0 +1,3 @@
+export { replacerWithPath };
+type Iterable = Record<string, unknown>;
+declare function replacerWithPath(replacer: (this: Iterable, key: string, value: unknown, path: string) => unknown, canBeFirstKey: boolean): (this: Iterable, key: string, value: unknown) => unknown;

package/dist/cjs/utils/replacerWithPath.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replacerWithPath = void 0;
+// https://stackoverflow.com/questions/61681176/json-stringify-replacer-how-to-get-full-path/63957172#63957172
+const isKeyDotNotationCompatible_1 = require("./isKeyDotNotationCompatible");
+function replacerWithPath(replacer, canBeFirstKey) {
+    const paths = new WeakMap();
+    return function (key, value) {
+        const prefix = paths.get(this);
+        const path = (prefix !== null && prefix !== void 0 ? prefix : '') + (key ? getPropAccessNotation(key, this, !prefix && canBeFirstKey) : '');
+        if (isIterable(value))
+            paths.set(value, path);
+        return replacer.call(this, key, value, path);
+    };
+}
+exports.replacerWithPath = replacerWithPath;
+function isIterable(value) {
+    return value === Object(value);
+}
+function getPropAccessNotation(key, obj, isFirstKey) {
+    if (Array.isArray(obj))
+        return `[${key}]`;
+    if ((0, isKeyDotNotationCompatible_1.isKeyDotNotationCompatible)(key))
+        return !isFirstKey ? `.${key}` : key; // Dot notation
+    return `[${JSON.stringify(key)}]`; // Bracket notation
+}

package/dist/esm/stringify.d.ts

@@ -1,7 +1,12 @@
 export { stringify };
+export { isJsonSerializerError };
 declare function stringify(value: unknown, { forbidReactElements, space, valueName, sortObjectKeys }?: {
     forbidReactElements?: boolean;
     space?: number;
     valueName?: string;
     sortObjectKeys?: boolean;
 }): string;
+type JsonSerializerError = Error & {
+    messageCore: string;
+};
+declare function isJsonSerializerError(thing: unknown): thing is JsonSerializerError;

package/dist/esm/stringify.js

@@ -1,28 +1,26 @@
 export { stringify };
+export { isJsonSerializerError };
 import { types } from './types';
 import { isReactElement } from './utils/isReactElement';
 import { isCallable } from './utils/isCallable';
 import { isObject } from './utils/isObject';
-function stringify(value, { forbidReactElements, space, valueName = 'value', sortObjectKeys } = {}) {
-    const path = [];
+import { replacerWithPath } from './utils/replacerWithPath';
+function stringify(value, { forbidReactElements, space, valueName, sortObjectKeys } = {}) {
     // The only error `JSON.stringify()` can throw is `TypeError "cyclic object value"`.
     // - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#exceptions
     // - This means we have total of 3 possible errors while serializing:
     //    - Cyclic references
     //    - Functions
     //    - React elements
-    const serializer = (val) => JSON.stringify(val, replacer, space);
+    const serializer = (val) => JSON.stringify(val, replacerWithPath(replacer, !valueName), space);
     return serializer(value);
-    function replacer(key, value) {
-        if (key !== '') {
-            path.push(key);
-        }
+    function replacer(key, value, path) {
         if (forbidReactElements && isReactElement(value)) {
-            throw new Error(genErrMsg('React element'));
+            throw genErr(genErrMsg('React element', path, valueName));
         }
         if (isCallable(value)) {
             const functionName = value.name;
-            throw new Error(genErrMsg('function', path.length === 0 ? functionName : undefined));
+            throw genErr(genErrMsg('function', path, valueName, path.length === 0 ? functionName : undefined));
         }
         const valueOriginal = this[key];
         for (const { is, serialize } of types.slice().reverse()) {
@@ -42,10 +40,32 @@ function stringify(value, { forbidReactElements, space, valueName = 'value', sor
         }
         return value;
     }
-    function genErrMsg(valueType, valName) {
-        const name = valName ? ' `' + valName + '`' : '';
-        const location = path.length === 0 ? '' : ` ${name ? 'at ' : ''}\`${valueName}[${path.map((p) => `'${p}'`).join('][')}]\``;
-        const fallback = name === '' && location === '' ? ` ${valueName}` : '';
-        return `@brillout/json-serializer (https://github.com/brillout/json-serializer) cannot serialize${name}${location}${fallback} because it's a ${valueType}.`;
+}
+const stamp = '_isJsonSerializerError';
+function genErr(errMsg) {
+    const err = new Error(`[@brillout/json-serializer](https://github.com/brillout/json-serializer) ${errMsg}.`);
+    Object.assign(err, {
+        messageCore: errMsg,
+        [stamp]: true
+    });
+    return err;
+}
+function isJsonSerializerError(thing) {
+    return isObject(thing) && thing[stamp] === true;
+}
+function genErrMsg(valueType, path, rootValueName, problematicValueName) {
+    let subject;
+    if (!path) {
+        subject = rootValueName || problematicValueName || 'value';
+    }
+    else {
+        if (problematicValueName) {
+            subject = problematicValueName + ' at ';
+        }
+        else {
+            subject = '';
+        }
+        subject = subject + (rootValueName || '') + path;
     }
+    return `cannot serialize ${subject} because it's a ${valueType}`;
 }

package/dist/esm/types.d.ts

@@ -1,6 +1,6 @@
 export { types };
 declare const types: readonly [Type<undefined, unknown>, Type<number, unknown>, Type<number, unknown>, Type<number, unknown>, Type<Date, any>, Type<BigInt, any>, Type<RegExp, any>, Type<Map<any, any>, any[]>, Type<Set<unknown>, unknown[]>, Type<string, any>];
-declare type Type<T, IntermediateType> = {
+type Type<T, IntermediateType> = {
     is: (val: unknown) => asserts val is T;
     match: (str: string) => boolean;
     serialize: (val: T, serializer: (val: IntermediateType) => string) => string;

package/dist/esm/utils/isKeyDotNotationCompatible.d.ts

@@ -0,0 +1 @@
+export declare function isKeyDotNotationCompatible(key: string): boolean;

package/dist/esm/utils/isKeyDotNotationCompatible.js

@@ -0,0 +1,3 @@
+export function isKeyDotNotationCompatible(key) {
+    return /^[a-z0-9\$_]+$/i.test(key);
+}

package/dist/esm/utils/isObject.d.ts

@@ -1,3 +1,3 @@
 export { isObject };
-declare type Object = Record<string, unknown>;
+type Object = Record<string, unknown>;
 declare function isObject(value: unknown): value is Object;

package/dist/esm/utils/replacerWithPath.d.ts

@@ -0,0 +1,3 @@
+export { replacerWithPath };
+type Iterable = Record<string, unknown>;
+declare function replacerWithPath(replacer: (this: Iterable, key: string, value: unknown, path: string) => unknown, canBeFirstKey: boolean): (this: Iterable, key: string, value: unknown) => unknown;

package/dist/esm/utils/replacerWithPath.js

@@ -0,0 +1,23 @@
+export { replacerWithPath };
+// https://stackoverflow.com/questions/61681176/json-stringify-replacer-how-to-get-full-path/63957172#63957172
+import { isKeyDotNotationCompatible } from './isKeyDotNotationCompatible';
+function replacerWithPath(replacer, canBeFirstKey) {
+    const paths = new WeakMap();
+    return function (key, value) {
+        const prefix = paths.get(this);
+        const path = (prefix ?? '') + (key ? getPropAccessNotation(key, this, !prefix && canBeFirstKey) : '');
+        if (isIterable(value))
+            paths.set(value, path);
+        return replacer.call(this, key, value, path);
+    };
+}
+function isIterable(value) {
+    return value === Object(value);
+}
+function getPropAccessNotation(key, obj, isFirstKey) {
+    if (Array.isArray(obj))
+        return `[${key}]`;
+    if (isKeyDotNotationCompatible(key))
+        return !isFirstKey ? `.${key}` : key; // Dot notation
+    return `[${JSON.stringify(key)}]`; // Bracket notation
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@brillout/json-serializer",
-  "version": "0.5.5",
+  "version": "0.5.7",
+  "dependencies": {},
   "description": "Same as JSON but with added support for `Date`, `undefined`, `Map`, `Set`, and more.",
   "main": "./index.mjs",
-  "license": "MIT",
   "exports": {
     ".": "./index.mjs",
     "./parse": {
@@ -20,7 +20,7 @@
   "scripts": {
     "dev": "pnpm run tsc:watch:cjs",
     "build": "pnpm run clean && pnpm run tsc:esm && pnpm run tsc:cjs",
-    "test": "self-import && node test/",
+    "test": "vitest",
     "docs": "mdocs",
     "tsc:esm": "tsc",
     "tsc:cjs": "tsc --project ./tsconfig.cjs.json",
@@ -33,11 +33,19 @@
   "devDependencies": {
     "@brillout/mdocs": "^0.1.30",
     "@brillout/release-me": "^0.0.5",
-    "@types/node": "17.0.13",
+    "@types/node": "^20.5.6",
+    "@types/react": "^18.2.21",
     "lodash.isequal": "^4.5.0",
     "react": "^17.0.2",
-    "self-import": "^1.0.1",
-    "typescript": "^4.8.2"
+    "typescript": "^5.2.2",
+    "vitest": "^0.34.3"
+  },
+  "packageManager": "pnpm@8.6.12",
+  "// Use @vitest/snapshot PR https://github.com/vitest-dev/vitest/pull/3961": "",
+  "pnpm": {
+    "overrides": {
+      "vitest>@vitest/snapshot": "npm:@brillout/vitest-snapshot@0.35.0-prerelease"
+    }
   },
   "files": [
     "dist/",
@@ -46,7 +54,7 @@
     "*.js"
   ],
   "repository": "github:brillout/json-serializer",
-  "packageManager": "pnpm@7.9.5",
+  "license": "MIT",
   "publishConfig": {
     "access": "public"
   }