json-with-bigint 1.0.1 → 1.1.0

package/README.md

@@ -8,23 +8,28 @@ JS library that allows you to easily serialize and deserialize data with BigInt
 
 1. You need to convert some data to/from JSON and it includes BigInt values
 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 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)
+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 change your JSON or the way you want to work with your data
 
 ## Good things about JSON-with-BigInt
 
 ✔️ Supports consistent round-trip operations with JSON
 
 ```
-JSONParse(JSONStringify(9007199254740991n)) === 9007199254740991n // true
+const data = { bigNumber: 9007199254740992n };
+JSONParse(JSONStringify(data)).bigNumber === 9007199254740992n // true
 ```
 
+✔️ No need to change your JSON or the way you want to work with your data
+
+✔️ Parses and stringifies all other values other than big numbers same way as native JSON methods in JS do
+
 ✔️ Does not contaminate your global space (unlike monkey-patching solution)
 
-✔️ You don't have to memorize this library's API, you already know it, just skip the dot and that's it
+✔️ You don't have to memorize this library's API, you already know it, just skip the dot, use camelCase and that's it (JSONParse(), JSONStringify())
 
 ✔️ Can be used in a TypeScript project (.d.ts file included)
 
-✔️ Size: 164 bytes (minified and gzipped)
+✔️ Size: 301 bytes (minified and gzipped)
 
 ✔️ No dependencies
 
@@ -46,7 +51,7 @@ and use it
 import { JSONParse, JSONStringify } from 'json-with-bigint';
 
 const userData = {
-  someBigNumber: 9007199254740991n
+  someBigNumber: 9007199254740992n
 };
 
 localStorage.setItem('userData', JSONStringify(userData));
@@ -67,7 +72,7 @@ and use it
 ```
 <script>
   const userData = {
-    someBigNumber: 9007199254740991n
+    someBigNumber: 9007199254740992n
   };
 
   localStorage.setItem('userData', JSONStringify(userData));
@@ -84,7 +89,7 @@ Download json-with-bigint.min.js from this repository to your project's folder a
 <script src="./json-with-bigint.min.js"></script>
 <script>
   const userData = {
-    someBigNumber: 9007199254740991n
+    someBigNumber: 9007199254740992n
   };
 
   localStorage.setItem('userData', JSONStringify(userData));
@@ -101,7 +106,7 @@ Download json-with-bigint.min.js from this repository to your project's folder a
 
 Examples:
 
-- `JSONParse('{"someBigNumber":9007199254740991n}')`
+- `JSONParse('{"someBigNumber":9007199254740992n}')`
 - `JSONStringify({
-someBigNumber: 9007199254740991n
+someBigNumber: 9007199254740992n
 })`

package/json-with-bigint.js

@@ -1,11 +1,35 @@
+/* 
+  Function to serialize data to JSON string.
+  Converts all BigInt values to strings with "n" character at the end.
+*/
 export const JSONStringify = (data) =>
   JSON.stringify(data, (_, value) =>
     typeof value === "bigint" ? value.toString() + "n" : value
   );
 
-export const JSONParse = (serializedData) =>
-  JSON.parse(serializedData, (_, value) =>
-    typeof value === "string" && value.match(/^\d+n$/)
-      ? BigInt(value.substring(0, value.length - 1))
-      : value
-  );
+/* 
+  Function to parse JSON.
+  If JSON has values in our custom format BigInt (strings with "n" character at the end), we just parse them to BigInt values.
+  If JSON has big number values, but not in our custom format, we copy it, and in a copy we convert those values to our custom format, 
+  then parse them to BigInt values.
+  Other values (not big numbers and not our custom format BigInt values) are not affected and parsed as native JSON.parse() would parse them.
+*/
+export const JSONParse = (json) => {
+  /*
+    Big numbers are found and marked using Regex with this condition:
+    Number's length is bigger than 16 || Number's length is 16 and any numerical digit of the number is greater than that of the Number.MAX_SAFE_INTEGER
+  */
+  const numbersBiggerThanMaxInt =
+    /([\[:])?(\d{17,}|(?:[9](?:[1-9]07199254740991|0[1-9]7199254740991|00[8-9]199254740991|007[2-9]99254740991|007199[3-9]54740991|0071992[6-9]4740991|00719925[5-9]740991|007199254[8-9]40991|0071992547[5-9]0991|00719925474[1-9]991|00719925474099[2-9])))([,\}\]])/g;
+  const serializedData = json.replace(numbersBiggerThanMaxInt, '$1"$2n"$3');
+
+  return JSON.parse(serializedData, (_, value) => {
+    const isCustomFormatBigInt =
+      typeof value === "string" && value.match(/^\d+n$/);
+
+    if (isCustomFormatBigInt)
+      return BigInt(value.substring(0, value.length - 1));
+
+    return value;
+  });
+};

package/json-with-bigint.min.js

@@ -1 +1 @@
-export const JSONStringify=t=>JSON.stringify(t,(t,n)=>"bigint"==typeof n?n.toString()+"n":n);export const JSONParse=t=>JSON.parse(t,(t,n)=>"string"==typeof n&&n.match(/^\d+n$/)?BigInt(n.substring(0,n.length-1)):n);
+export const JSONStringify=t=>JSON.stringify(t,((t,n)=>"bigint"==typeof n?n.toString()+"n":n));export const JSONParse=t=>{const n=t.replace(/([\[:])?(\d{17,}|(?:[9](?:[1-9]07199254740991|0[1-9]7199254740991|00[8-9]199254740991|007[2-9]99254740991|007199[3-9]54740991|0071992[6-9]4740991|00719925[5-9]740991|007199254[8-9]40991|0071992547[5-9]0991|00719925474[1-9]991|00719925474099[2-9])))([,\}\]])/g,'$1"$2n"$3');return JSON.parse(n,((t,n)=>"string"==typeof n&&n.match(/^\d+n$/)?BigInt(n.substring(0,n.length-1)):n))};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-with-bigint",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "JS library that allows you to easily serialize and deserialize data with BigInt values",
   "main": "json-with-bigint.js",
   "repository": {
@@ -12,12 +12,7 @@
     "BigInt",
     "js",
     "ts",
-    "library",
-    "JSON.parse",
-    "JSON.stringify",
-    "serialization",
-    "deserialization",
-    "round-trip"
+    "library"
   ],
   "author": "Ivan Korolenko <iam@ivankorolenko.com>",
   "license": "MIT"