@brillout/json-serializer 0.5.10 → 0.5.12

package/dist/cjs/stringify.d.ts

@@ -1,16 +1,20 @@
 export { stringify };
 export { isJsonSerializerError };
-import { type Iterable } from './utils/replacerWithPath';
+import { type Iterable, type Path } from './utils/replacerWithPath';
 declare function stringify(value: unknown, { forbidReactElements, space, valueName, sortObjectKeys, replacer: replacerUserProvided, }?: {
     forbidReactElements?: boolean;
     space?: number;
     valueName?: string;
     sortObjectKeys?: boolean;
-    replacer?: (this: Iterable, key: string, value: unknown, path: string) => void | {
+    replacer?: (this: Iterable, key: string, value: unknown) => void | {
         replacement: unknown;
     };
 }): string;
-type JsonSerializerError = Error & {
-    messageCore: string;
+type ErrAddendum = {
+    messageCore: `cannot serialize ${string} because it's a function` | `cannot serialize ${string} because it's a React element`;
+    value: unknown;
+    path: Path;
+    pathString: string;
+    subjectName: string;
 };
-declare function isJsonSerializerError(thing: unknown): thing is JsonSerializerError;
+declare function isJsonSerializerError(thing: unknown): thing is Error & ErrAddendum;

package/dist/cjs/stringify.js

@@ -6,27 +6,40 @@ const isReactElement_1 = require("./utils/isReactElement");
 const isCallable_1 = require("./utils/isCallable");
 const isObject_1 = require("./utils/isObject");
 const replacerWithPath_1 = require("./utils/replacerWithPath");
-function stringify(value, { forbidReactElements, space, valueName, sortObjectKeys, replacer: replacerUserProvided, } = {}) {
+function stringify(value, { forbidReactElements, space, valueName, sortObjectKeys, 
+// Used by Vike: https://github.com/vikejs/vike/blob/b4ba6b70e6bdc2e1f460c0d2e4c3faae5d0a733c/vike/node/plugin/plugins/importUserCode/v1-design/getConfigValuesSerialized.ts#L78
+replacer: replacerUserProvided, } = {}) {
     // 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, (0, replacerWithPath_1.replacerWithPath)(replacer, !valueName), space);
+    const serializer = (val) => JSON.stringify(val, (0, replacerWithPath_1.replacerWithPath)(replacer), space);
     return serializer(value);
     function replacer(key, value, path) {
         {
-            const ret = replacerUserProvided === null || replacerUserProvided === void 0 ? void 0 : replacerUserProvided.call(this, key, value, path);
+            const ret = replacerUserProvided === null || replacerUserProvided === void 0 ? void 0 : replacerUserProvided.call(this, key, value);
             if (ret)
                 return ret.replacement;
         }
         if (forbidReactElements && (0, isReactElement_1.isReactElement)(value)) {
-            throw genErr(genErrMsg('React element', path, valueName));
+            throw genErr({
+                value,
+                valueType: 'React element',
+                path,
+                rootValueName: valueName,
+            });
         }
         if ((0, isCallable_1.isCallable)(value)) {
             const functionName = value.name;
-            throw genErr(genErrMsg('function', path, valueName, path.length === 0 ? functionName : undefined));
+            throw genErr({
+                value,
+                valueType: 'function',
+                path,
+                rootValueName: valueName,
+                problematicValueName: path.length === 0 ? functionName : undefined,
+            });
         }
         const valueOriginal = this[key];
         for (const { is, serialize } of types_1.types.slice().reverse()) {
@@ -48,32 +61,61 @@ function stringify(value, { forbidReactElements, space, valueName, sortObjectKey
     }
 }
 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,
+function genErr({ value, valueType, path, rootValueName, problematicValueName, }) {
+    const subjectName = getSubjectName({ path, rootValueName, problematicValueName });
+    const messageCore = `cannot serialize ${subjectName} because it's a ${valueType}`;
+    const err = new Error(`[@brillout/json-serializer](https://github.com/brillout/json-serializer) ${messageCore}.`);
+    const pathString = getPathString(path, false);
+    const errAddendum = {
         [stamp]: true,
-    });
+        messageCore,
+        value,
+        path,
+        pathString,
+        subjectName,
+    };
+    Object.assign(err, errAddendum);
     return err;
 }
+const stamp = '_isJsonSerializerError';
 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';
+function getSubjectName({ path, rootValueName, problematicValueName, }) {
+    const pathString = getPathString(path, !rootValueName);
+    let subjectName;
+    if (!pathString) {
+        subjectName = rootValueName || problematicValueName || 'value';
     }
     else {
         if (problematicValueName) {
-            subject = problematicValueName + ' at ';
+            subjectName = problematicValueName + ' at ';
         }
         else {
-            subject = '';
+            subjectName = '';
         }
-        subject = subject + (rootValueName || '') + path;
+        subjectName = subjectName + (rootValueName || '') + pathString;
     }
-    return `cannot serialize ${subject} because it's a ${valueType}`;
+    return subjectName;
+}
+function getPathString(path, canBeFirstKey) {
+    const pathString = path
+        .map((key, i) => {
+        if (typeof key === 'number') {
+            return `[${key}]`;
+        }
+        if (i === 0 && canBeFirstKey && isKeyDotNotationCompatible(key)) {
+            return key;
+        }
+        return getPropAccessNotation(key);
+    })
+        .join('');
+    return pathString;
+}
+function getPropAccessNotation(key) {
+    return typeof key === 'string' && isKeyDotNotationCompatible(key) ? `.${key}` : `[${JSON.stringify(key)}]`;
+}
+function isKeyDotNotationCompatible(key) {
+    return /^[a-z0-9\$_]+$/i.test(key);
 }

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

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

package/dist/cjs/utils/isKeyDotNotationCompatible.js

@@ -1,7 +1 @@
 "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/replacerWithPath.d.ts

@@ -1,5 +1,7 @@
 export { replacerWithPath };
 export type { Iterable };
+export type { Path };
+type Path = (string | number)[];
 type Iterable = Record<string, unknown>;
-type Replacer = (this: Iterable, key: string, value: unknown, path: string) => unknown;
-declare function replacerWithPath(replacer: Replacer, canBeFirstKey: boolean): (this: Iterable, key: string, value: unknown) => unknown;
+type Replacer = (this: Iterable, key: string, value: unknown, path: Path) => unknown;
+declare function replacerWithPath(replacer: Replacer): (this: Iterable, key: string, value: unknown) => unknown;

package/dist/cjs/utils/replacerWithPath.js

@@ -1,15 +1,18 @@
 "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();
+function replacerWithPath(replacer) {
+    const pathMap = 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) : '');
+        var _a;
+        const pathPrevious = (_a = pathMap.get(this)) !== null && _a !== void 0 ? _a : [];
+        const path = [...pathPrevious];
+        if (key !== '') {
+            const pathEntry = !Array.isArray(this) ? key : parseInt(key, 10);
+            path.push(pathEntry);
+        }
         if (isIterable(value))
-            paths.set(value, path);
+            pathMap.set(value, path);
         return replacer.call(this, key, value, path);
     };
 }
@@ -17,10 +20,3 @@ 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/parse.js

@@ -1,4 +1,5 @@
 export { parse };
+// Used by Vike: https://github.com/vikejs/vike/blob/b4ba6b70e6bdc2e1f460c0d2e4c3faae5d0a733c/vike/shared/page-configs/serialize/parseConfigValuesSerialized.ts#L13
 export { parseTransform };
 import { types } from './types';
 function parse(str) {

package/dist/esm/stringify.d.ts

@@ -1,16 +1,20 @@
 export { stringify };
 export { isJsonSerializerError };
-import { type Iterable } from './utils/replacerWithPath';
+import { type Iterable, type Path } from './utils/replacerWithPath';
 declare function stringify(value: unknown, { forbidReactElements, space, valueName, sortObjectKeys, replacer: replacerUserProvided, }?: {
     forbidReactElements?: boolean;
     space?: number;
     valueName?: string;
     sortObjectKeys?: boolean;
-    replacer?: (this: Iterable, key: string, value: unknown, path: string) => void | {
+    replacer?: (this: Iterable, key: string, value: unknown) => void | {
         replacement: unknown;
     };
 }): string;
-type JsonSerializerError = Error & {
-    messageCore: string;
+type ErrAddendum = {
+    messageCore: `cannot serialize ${string} because it's a function` | `cannot serialize ${string} because it's a React element`;
+    value: unknown;
+    path: Path;
+    pathString: string;
+    subjectName: string;
 };
-declare function isJsonSerializerError(thing: unknown): thing is JsonSerializerError;
+declare function isJsonSerializerError(thing: unknown): thing is Error & ErrAddendum;

package/dist/esm/stringify.js

@@ -5,27 +5,40 @@ import { isReactElement } from './utils/isReactElement';
 import { isCallable } from './utils/isCallable';
 import { isObject } from './utils/isObject';
 import { replacerWithPath } from './utils/replacerWithPath';
-function stringify(value, { forbidReactElements, space, valueName, sortObjectKeys, replacer: replacerUserProvided, } = {}) {
+function stringify(value, { forbidReactElements, space, valueName, sortObjectKeys, 
+// Used by Vike: https://github.com/vikejs/vike/blob/b4ba6b70e6bdc2e1f460c0d2e4c3faae5d0a733c/vike/node/plugin/plugins/importUserCode/v1-design/getConfigValuesSerialized.ts#L78
+replacer: replacerUserProvided, } = {}) {
     // 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, replacerWithPath(replacer, !valueName), space);
+    const serializer = (val) => JSON.stringify(val, replacerWithPath(replacer), space);
     return serializer(value);
     function replacer(key, value, path) {
         {
-            const ret = replacerUserProvided?.call(this, key, value, path);
+            const ret = replacerUserProvided?.call(this, key, value);
             if (ret)
                 return ret.replacement;
         }
         if (forbidReactElements && isReactElement(value)) {
-            throw genErr(genErrMsg('React element', path, valueName));
+            throw genErr({
+                value,
+                valueType: 'React element',
+                path,
+                rootValueName: valueName,
+            });
         }
         if (isCallable(value)) {
             const functionName = value.name;
-            throw genErr(genErrMsg('function', path, valueName, path.length === 0 ? functionName : undefined));
+            throw genErr({
+                value,
+                valueType: 'function',
+                path,
+                rootValueName: valueName,
+                problematicValueName: path.length === 0 ? functionName : undefined,
+            });
         }
         const valueOriginal = this[key];
         for (const { is, serialize } of types.slice().reverse()) {
@@ -46,31 +59,60 @@ function stringify(value, { forbidReactElements, space, valueName, sortObjectKey
         return value;
     }
 }
-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,
+function genErr({ value, valueType, path, rootValueName, problematicValueName, }) {
+    const subjectName = getSubjectName({ path, rootValueName, problematicValueName });
+    const messageCore = `cannot serialize ${subjectName} because it's a ${valueType}`;
+    const err = new Error(`[@brillout/json-serializer](https://github.com/brillout/json-serializer) ${messageCore}.`);
+    const pathString = getPathString(path, false);
+    const errAddendum = {
         [stamp]: true,
-    });
+        messageCore,
+        value,
+        path,
+        pathString,
+        subjectName,
+    };
+    Object.assign(err, errAddendum);
     return err;
 }
+const stamp = '_isJsonSerializerError';
 function isJsonSerializerError(thing) {
     return isObject(thing) && thing[stamp] === true;
 }
-function genErrMsg(valueType, path, rootValueName, problematicValueName) {
-    let subject;
-    if (!path) {
-        subject = rootValueName || problematicValueName || 'value';
+function getSubjectName({ path, rootValueName, problematicValueName, }) {
+    const pathString = getPathString(path, !rootValueName);
+    let subjectName;
+    if (!pathString) {
+        subjectName = rootValueName || problematicValueName || 'value';
     }
     else {
         if (problematicValueName) {
-            subject = problematicValueName + ' at ';
+            subjectName = problematicValueName + ' at ';
         }
         else {
-            subject = '';
+            subjectName = '';
         }
-        subject = subject + (rootValueName || '') + path;
+        subjectName = subjectName + (rootValueName || '') + pathString;
     }
-    return `cannot serialize ${subject} because it's a ${valueType}`;
+    return subjectName;
+}
+function getPathString(path, canBeFirstKey) {
+    const pathString = path
+        .map((key, i) => {
+        if (typeof key === 'number') {
+            return `[${key}]`;
+        }
+        if (i === 0 && canBeFirstKey && isKeyDotNotationCompatible(key)) {
+            return key;
+        }
+        return getPropAccessNotation(key);
+    })
+        .join('');
+    return pathString;
+}
+function getPropAccessNotation(key) {
+    return typeof key === 'string' && isKeyDotNotationCompatible(key) ? `.${key}` : `[${JSON.stringify(key)}]`;
+}
+function isKeyDotNotationCompatible(key) {
+    return /^[a-z0-9\$_]+$/i.test(key);
 }

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

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

package/dist/esm/utils/isKeyDotNotationCompatible.js

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

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

@@ -1,5 +1,7 @@
 export { replacerWithPath };
 export type { Iterable };
+export type { Path };
+type Path = (string | number)[];
 type Iterable = Record<string, unknown>;
-type Replacer = (this: Iterable, key: string, value: unknown, path: string) => unknown;
-declare function replacerWithPath(replacer: Replacer, canBeFirstKey: boolean): (this: Iterable, key: string, value: unknown) => unknown;
+type Replacer = (this: Iterable, key: string, value: unknown, path: Path) => unknown;
+declare function replacerWithPath(replacer: Replacer): (this: Iterable, key: string, value: unknown) => unknown;

package/dist/esm/utils/replacerWithPath.js

@@ -1,23 +1,18 @@
 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();
+function replacerWithPath(replacer) {
+    const pathMap = new WeakMap();
     return function (key, value) {
-        const prefix = paths.get(this);
-        const path = (prefix ?? '') + (key ? getPropAccessNotation(key, this, !prefix && canBeFirstKey) : '');
+        const pathPrevious = pathMap.get(this) ?? [];
+        const path = [...pathPrevious];
+        if (key !== '') {
+            const pathEntry = !Array.isArray(this) ? key : parseInt(key, 10);
+            path.push(pathEntry);
+        }
         if (isIterable(value))
-            paths.set(value, path);
+            pathMap.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,6 +1,6 @@
 {
   "name": "@brillout/json-serializer",
-  "version": "0.5.10",
+  "version": "0.5.12",
   "description": "Same as JSON but with added support for `Date`, `undefined`, `Map`, `Set`, and more.",
   "main": "./index.mjs",
   "exports": {
@@ -29,22 +29,20 @@
     "test": "vitest",
     "========= Build readme.md": "",
     "docs": "mdocs",
-    "========= Clean": "",
-    "// Remove all generated files": "",
-    "clean": "git clean -Xdf",
-    "reset": "pnpm run clean && pnpm install && pnpm run build",
     "========= Formatting": "",
     "format": "pnpm run format:biome",
     "format:prettier": "git ls-files | egrep '\\.(json|js|jsx|css|ts|tsx|vue|mjs|cjs)$' | grep --invert-match package.json | xargs pnpm exec prettier --write",
     "format:biome": "biome format --write .",
     "format:check": "biome format . || echo Fix formatting by running: $ pnpm -w run format",
     "========= Release": "",
-    "release": "release-me patch"
+    "release": "release-me patch",
+    "========= Reset": "",
+    "reset": "git clean -Xdf && pnpm install && pnpm run build"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.7.2",
     "@brillout/mdocs": "^0.1.30",
-    "@brillout/release-me": "^0.3.7",
+    "@brillout/release-me": "^0.3.8",
     "@types/node": "^20.5.6",
     "@types/react": "^18.2.21",
     "lodash.isequal": "^4.5.0",
@@ -53,7 +51,6 @@
     "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": {

package/parse.js

@@ -8,4 +8,4 @@
 // prettier-ignore
 // biome-ignore format:
 exports.parse = require('./dist/cjs/parse.js').parse;
-exports.parseTransform = require('./dist/cjs/parse.js').parseTransform;
+exports.parseTransform = require('./dist/cjs/parse.js').parseTransform