json-with-bigint 3.3.4 → 3.5.0

package/README.md

@@ -2,7 +2,7 @@
 
 JS library that allows you to easily serialize and deserialize data with BigInt values
 
-## Why would I need JSON-with-BigInt?
+## Why would I need json-with-bigint?
 
 3 reasons:
 
@@ -10,7 +10,7 @@ JS library that allows you to easily serialize and deserialize data with BigInt
 2. Native JSON.stringify() and JSON.parse() methods in JS can't work with BigInt
 3. Other libraries and pieces of code that you'll find either can't solve this problem while supporting consistent round-trip operations (meaning, you will not get the same BigInt values if you serialize and then deserialize them) or requires you to specify which properties in JSON include BigInt values, or to change your JSON or the way you want to work with your data
 
-## Good things about JSON-with-BigInt
+## json-with-bigint advantages
 
 ✔️ Supports consistent round-trip operations with JSON
 
@@ -24,9 +24,9 @@ JSONParse(JSONStringify(data)).bigNumber === 9007199254740992n // true
 
 ✔️ No need to change your JSON or the way you want to work with your data
 
-✔️ You don't have to memorize this library's API, you already know it. Just skip the dot, and that's it (JSONParse(), JSONStringify())
+✔️ You don't have to memorize this library's API, you already know it. Just skip the dot, and that's it (`JSONParse()`, `JSONStringify()`)
 
-✔️ Parses and stringifies all other values other than big numbers the same way as native JSON methods in JS do. You can just replace every `JSON.parse` and `JSON.stringify` call in your project with functions from this library and it'll work.
+✔️ Parsed big number values are just regular BigInt. Parses and stringifies all other values other than big numbers the same way as native JSON methods in JS do. Signatures match too. You can just replace every `JSON.parse()` and `JSON.strinfigy()` in your project with `JSONParse()` and `JSONStringify()`, and it will work
 
 ✔️ Correctly parses float numbers and negative numbers
 
@@ -40,11 +40,15 @@ JSONParse(JSONStringify(data)).bigNumber === 9007199254740992n // true
 
 ✔️ Can be used as both ESM and CommonJS module
 
-✔️ Size: 776 bytes (minified and gzipped)
+✔️ No transpilers needed. Runs even in ES5 environments
 
-✔️ No dependencies
+✔️ Actively supported
 
-✔️ Covered by tests
+✔️ Size: 988 bytes (minified and gzipped)
+
+✔️ No dependencies. Even the dev ones
+
+✔️ Extensively covered by tests
 
 ## Getting Started
 

package/__tests__/performance.cjs

@@ -1,4 +1,6 @@
 // ------ Performance tests ------
+// To test both JSONParseV2() and JSONParse(), switch Node.js version (latest vs something old, like 12.3.0)
+
 const { performance } = require("perf_hooks");
 const { JSONParse, JSONStringify } = require("../json-with-bigint.cjs");
 

package/__tests__/unit.cjs

@@ -1,4 +1,6 @@
 // ------ Unit tests ------
+// To test both JSONParseV2() and JSONParse(), switch Node.js version (latest vs something old, like 12.3.0)
+
 const assert = require("assert");
 const { JSONStringify, JSONParse } = require("../json-with-bigint.cjs");
 

package/json-with-bigint.cjs

@@ -51,6 +51,45 @@ const JSONStringify = (value, replacer, space) => {
   return denoisedJSON;
 };
 
+/*
+  Function to check if the JSON.parse's context.source feature is supported.
+*/
+const isContextSourceSupported = () => {
+  let supported = false;
+
+  JSON.parse('{"test": 1}', (key, value, context) => {
+    if (key === "test" && context && context.source === "1") {
+      supported = true;
+    }
+    return value;
+  });
+
+  return supported;
+};
+
+/*
+  Faster (2x) and simpler function to parse JSON.
+  Based on JSON.parse's context.source feature, which is not universally available now.
+  Does not support the legacy custom format, used in the first version of this library.
+*/
+const JSONParseV2 = (text, reviver) => {
+  const intRegex = /^-?\d+$/;
+
+  return JSON.parse(text, (key, value, context) => {
+    const isBigNumber =
+      typeof value === "number" &&
+      (value > Number.MAX_SAFE_INTEGER || value < Number.MIN_SAFE_INTEGER);
+    const isInt = intRegex.test(context.source);
+    const isBigInt = isBigNumber && isInt;
+
+    if (isBigInt) return BigInt(context.source);
+
+    if (typeof reviver !== "function") return value;
+
+    return reviver(key, value, context);
+  });
+};
+
 /*
   Function to parse JSON.
   If JSON has number values greater than Number.MAX_SAFE_INTEGER, we convert those values to a custom format, then parse them to BigInt values.
@@ -59,6 +98,8 @@ const JSONStringify = (value, replacer, space) => {
 const JSONParse = (text, reviver) => {
   if (!text) return originalParse(text, reviver);
 
+  if (isContextSourceSupported()) return JSONParseV2(text, reviver); // Shortcut to a faster (2x) and simpler version
+
   const MAX_INT = Number.MAX_SAFE_INTEGER.toString();
   const MAX_DIGITS = MAX_INT.length;
   const stringsOrLargeNumbers =

package/json-with-bigint.d.cts

@@ -1,28 +1,3 @@
-type JsonObject = {
-  [x: string]: Json;
-};
+export const JSONStringify: typeof JSON.stringify;
 
-type JsonArray = Json[];
-
-export type Json =
-  | null
-  | undefined
-  | string
-  | number
-  | bigint
-  | boolean
-  | JsonObject
-  | {}
-  | JsonArray;
-
-export function JSONStringify(
-  data: Exclude<Json, undefined>,
-  space?: string | number
-): string;
-
-export function JSONStringify(
-  data: undefined,
-  space?: string | number
-): undefined;
-
-export function JSONParse<T extends Json = Json>(serializedData: string): T;
+export const JSONParse: typeof JSON.parse;

package/json-with-bigint.d.ts

@@ -1,28 +1,3 @@
-type JsonObject = {
-  [x: string]: Json;
-};
+export const JSONStringify: typeof JSON.stringify;
 
-type JsonArray = Json[];
-
-export type Json =
-  | null
-  | undefined
-  | string
-  | number
-  | bigint
-  | boolean
-  | JsonObject
-  | {}
-  | JsonArray;
-
-export function JSONStringify(
-  data: Exclude<Json, undefined>,
-  space?: string | number
-): string;
-
-export function JSONStringify(
-  data: undefined,
-  space?: string | number
-): undefined;
-
-export function JSONParse<T extends Json = Json>(serializedData: string): T;
+export const JSONParse: typeof JSON.parse;

package/json-with-bigint.js

@@ -51,6 +51,45 @@ export const JSONStringify = (value, replacer, space) => {
   return denoisedJSON;
 };
 
+/*
+  Function to check if the JSON.parse's context.source feature is supported.
+*/
+const isContextSourceSupported = () => {
+  let supported = false;
+
+  JSON.parse('{"test": 1}', (key, value, context) => {
+    if (key === "test" && context && context.source === "1") {
+      supported = true;
+    }
+    return value;
+  });
+
+  return supported;
+};
+
+/*
+  Faster (2x) and simpler function to parse JSON.
+  Based on JSON.parse's context.source feature, which is not universally available now.
+  Does not support the legacy custom format, used in the first version of this library.
+*/
+const JSONParseV2 = (text, reviver) => {
+  const intRegex = /^-?\d+$/;
+
+  return JSON.parse(text, (key, value, context) => {
+    const isBigNumber =
+      typeof value === "number" &&
+      (value > Number.MAX_SAFE_INTEGER || value < Number.MIN_SAFE_INTEGER);
+    const isInt = intRegex.test(context.source);
+    const isBigInt = isBigNumber && isInt;
+
+    if (isBigInt) return BigInt(context.source);
+
+    if (typeof reviver !== "function") return value;
+
+    return reviver(key, value, context);
+  });
+};
+
 /*
   Function to parse JSON.
   If JSON has number values greater than Number.MAX_SAFE_INTEGER, we convert those values to a custom format, then parse them to BigInt values.
@@ -59,6 +98,8 @@ export const JSONStringify = (value, replacer, space) => {
 export const JSONParse = (text, reviver) => {
   if (!text) return originalParse(text, reviver);
 
+  if (isContextSourceSupported()) return JSONParseV2(text, reviver); // Shortcut to a faster (2x) and simpler version
+
   const MAX_INT = Number.MAX_SAFE_INTEGER.toString();
   const MAX_DIGITS = MAX_INT.length;
   const stringsOrLargeNumbers =

package/json-with-bigint.min.js

@@ -1 +1 @@
-const noiseValue=/^-?\d+n+$/,originalStringify=JSON.stringify,originalParse=JSON.parse;export const JSONStringify=(n,r,t)=>{if("rawJSON"in JSON)return originalStringify(n,((n,t)=>"bigint"==typeof t?JSON.rawJSON(t.toString()):"function"==typeof r?r(n,t):(Array.isArray(r)&&r.includes(n),t)),t);if(!n)return originalStringify(n,r,t);const i=originalStringify(n,((n,t)=>"string"==typeof t&&Boolean(t.match(noiseValue))||"bigint"==typeof t?t.toString()+"n":"function"==typeof r?r(n,t):(Array.isArray(r)&&r.includes(n),t)),t);return i.replace(/([\[:])?"(-?\d+)n"($|([\\n]|\s)*(\s|[\\n])*[,\}\]])/g,"$1$2$3").replace(/([\[:])?("-?\d+n+)n("$|"([\\n]|\s)*(\s|[\\n])*[,\}\]])/g,"$1$2$3")};export const JSONParse=(n,r)=>{if(!n)return originalParse(n,r);const t=Number.MAX_SAFE_INTEGER.toString(),i=t.length,e=/^"-?\d+n+"$/,o=/^-?\d+n$/,g=n.replace(/"(?:\\.|[^"])*"|-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?/g,((n,r,o,g)=>{const s='"'===n[0];if(s&&Boolean(n.match(e)))return n.substring(0,n.length-1)+'n"';const a=o||g,l=r&&(r.length<i||r.length===i&&r<=t);return s||a||l?n:'"'+n+'n"'}));return originalParse(g,((n,t,i)=>{if("string"==typeof t&&Boolean(t.match(o)))return BigInt(t.substring(0,t.length-1));return"string"==typeof t&&Boolean(t.match(noiseValue))?t.substring(0,t.length-1):"function"!=typeof r?t:r(n,t,i)}))};
+const noiseValue=/^-?\d+n+$/,originalStringify=JSON.stringify,originalParse=JSON.parse;export const JSONStringify=(n,t,r)=>{if("rawJSON"in JSON)return originalStringify(n,((n,r)=>"bigint"==typeof r?JSON.rawJSON(r.toString()):"function"==typeof t?t(n,r):(Array.isArray(t)&&t.includes(n),r)),r);if(!n)return originalStringify(n,t,r);const e=originalStringify(n,((n,r)=>"string"==typeof r&&Boolean(r.match(noiseValue))||"bigint"==typeof r?r.toString()+"n":"function"==typeof t?t(n,r):(Array.isArray(t)&&t.includes(n),r)),r);return e.replace(/([\[:])?"(-?\d+)n"($|([\\n]|\s)*(\s|[\\n])*[,\}\]])/g,"$1$2$3").replace(/([\[:])?("-?\d+n+)n("$|"([\\n]|\s)*(\s|[\\n])*[,\}\]])/g,"$1$2$3")};const isContextSourceSupported=()=>{let n=!1;return JSON.parse('{"test": 1}',((t,r,e)=>("test"===t&&e&&"1"===e.source&&(n=!0),r))),n},JSONParseV2=(n,t)=>{const r=/^-?\d+$/;return JSON.parse(n,((n,e,i)=>{const o="number"==typeof e&&(e>Number.MAX_SAFE_INTEGER||e<Number.MIN_SAFE_INTEGER),s=r.test(i.source);return o&&s?BigInt(i.source):"function"!=typeof t?e:t(n,e,i)}))};export const JSONParse=(n,t)=>{if(!n)return originalParse(n,t);if(isContextSourceSupported())return JSONParseV2(n,t);const r=Number.MAX_SAFE_INTEGER.toString(),e=r.length,i=/^"-?\d+n+"$/,o=/^-?\d+n$/,s=n.replace(/"(?:\\.|[^"])*"|-?(0|[1-9][0-9]*)(\.[0-9]+)?([eE][+-]?[0-9]+)?/g,((n,t,o,s)=>{const a='"'===n[0];if(a&&Boolean(n.match(i)))return n.substring(0,n.length-1)+'n"';const u=o||s,g=t&&(t.length<e||t.length===e&&t<=r);return a||u||g?n:'"'+n+'n"'}));return originalParse(s,((n,r,e)=>{if("string"==typeof r&&Boolean(r.match(o)))return BigInt(r.substring(0,r.length-1));return"string"==typeof r&&Boolean(r.match(noiseValue))?r.substring(0,r.length-1):"function"!=typeof t?r:t(n,r,e)}))};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-with-bigint",
-  "version": "3.3.4",
+  "version": "3.5.0",
   "description": "JS library that allows you to easily serialize and deserialize data with BigInt values",
   "type": "module",
   "exports": {