@awsless/json 0.0.5 → 0.0.7

package/README.MD

@@ -3,24 +3,37 @@
 
 The `@awsless/json` package adds support for more JavaScript native types to JSON.
 
+Features:
+ - Lightweight / Using the JS native JSON parser.
+ - JSON backwards compatible.
+ - No precision loss.
+ - Includes support for basic JS types.
+ - Extendable.
+
 ## The Problem
 
 JSON doesn't have support for types like:
 - `undefined`
+- `NaN`
+- `Infinity`
+- `Uint8Array`
+- `RegExp`
 - `Set`
 - `Map`
+- `URL`
 - `Date`
 - `BigInt`
 - `BigFloat` - npm package @awsless/bit-float
 
-Having to decode & encode these type of values can get quite annoying. We try to solve this problem by encoding these types using valid JSON syntax.
+Having to encode & decode these type of values can get quite annoying. We try to solve this problem by encoding these types using valid JSON syntax.
+
+Additionally, the native `JSON.parse/stringify` functions do not address the potential loss of precision problem.
 
 ## Basic Usage
 
 ```ts
 import { parse, stringify } from '@awsless/json';
 
-// Stringify a bigint.
 // The output will be {"$bigint":"1"}
 const json = stringify(1n)
 
@@ -30,7 +43,7 @@ const value = parse(json)
 
 ## Patching incorrectly parsed JSON that was parsed with a different JSON parser
 
-In some cases you might not have control over the JSON parser that is being used. In these cases your JSON will still be able to parse, but the output will be incorrect. We can patch the incorrect output by using the `patch` function.
+In some situations, you may not have control over the JSON parser being used. In these instances, your JSON can still be parsed, but the output may be incorrect. We can correct the inaccurate output by using the `patch` function.
 
 ```ts
 import { stringify, patch } from '@awsless/json';
@@ -72,9 +85,36 @@ const json = stringify(new Custom('example'), { $custom })
 const value = parse(json, { $custom })
 ```
 
+## Precision Loss
+
+When using the native `JSON.parse/stringify` functions you could lose precision when parsing native numbers. And you don't always have the ability to extend JSON with your own custom types. For example when you’re communicating with a third-party API. For this reason, we have 2 utility functions that will parse the native JSON number type to your own precision-safe alternative.
+
+> [!NOTE]
+> These utility functions will only work in environments that support `JSON.rawJSON`
+> https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/rawJSON#browser_compatibility
+
+```ts
+import { safeNumberParse, safeNumberStringify } from '@awsless/json';
+import { BigFloat, eq } from '@awsless/big-float';
+
+const value = new BigFloat(1)
+const json = safeNumberStringify(ONE, {
+	is: v => v instanceof BigFloat,
+	stringify: v => v.toString(),
+})
+
+console.log(json) // '1'
+
+const result = safeNumberParse('1', {
+	parse: v => new BigFloat(v),
+})
+
+console.log(eq(value, result)) // true
+```
+
 ## Known Issue's
 
-### Don't use the $ character inside your JSON.
+### Don't use the `$` character inside your JSON.
 
 We use the `$` character to encode our special types inside JSON. In order to prevent parsing errors we recommend to avoid using the `$` character inside your object property names.
 

package/dist/index.cjs

@@ -22,8 +22,12 @@ var src_exports = {};
 __export(src_exports, {
   createReplacer: () => createReplacer,
   createReviver: () => createReviver,
+  createSafeNumberReplacer: () => createSafeNumberReplacer,
+  createSafeNumberReviver: () => createSafeNumberReviver,
   parse: () => parse,
   patch: () => patch,
+  safeNumberParse: () => safeNumberParse,
+  safeNumberStringify: () => safeNumberStringify,
   stringify: () => stringify,
   unpatch: () => unpatch
 });
@@ -51,6 +55,15 @@ var $date = {
   stringify: (v) => v.toISOString()
 };
 
+// src/type/infinity.ts
+var P = Infinity;
+var N = -Infinity;
+var $infinity = {
+  is: (v) => v === P || v === N,
+  parse: (v) => v === 1 ? P : N,
+  stringify: (v) => v > 0 ? 1 : 0
+};
+
 // src/type/map.ts
 var $map = {
   is: (v) => v instanceof Map,
@@ -58,6 +71,20 @@ var $map = {
   stringify: (v) => Array.from(v)
 };
 
+// src/type/nan.ts
+var $nan = {
+  is: (v) => typeof v === "number" && isNaN(v),
+  parse: (_) => NaN,
+  stringify: (_) => 0
+};
+
+// src/type/regexp.ts
+var $regexp = {
+  is: (v) => v instanceof RegExp,
+  parse: (v) => new RegExp(v[0], v[1]),
+  stringify: (v) => [v.source, v.flags]
+};
+
 // src/type/set.ts
 var $set = {
   is: (v) => v instanceof Set,
@@ -65,6 +92,13 @@ var $set = {
   stringify: (v) => Array.from(v)
 };
 
+// src/type/binary.ts
+var $binary = {
+  is: (v) => v instanceof Uint8Array,
+  parse: (v) => Uint8Array.from(atob(v), (c) => c.charCodeAt(0)),
+  stringify: (v) => btoa(String.fromCharCode(...v))
+};
+
 // src/type/undefined.ts
 var $undefined = {
   is: (v) => typeof v === "undefined",
@@ -72,14 +106,26 @@ var $undefined = {
   stringify: (_) => 0
 };
 
+// src/type/url.ts
+var $url = {
+  is: (v) => v instanceof URL,
+  parse: (v) => new URL(v),
+  stringify: (v) => v.toString()
+};
+
 // src/type/index.ts
 var baseTypes = {
   $undefined,
+  $infinity,
   $bigfloat,
   $bigint,
+  $regexp,
+  $binary,
   $date,
   $set,
-  $map
+  $map,
+  $nan,
+  $url
 };
 
 // src/parse.ts
@@ -136,12 +182,47 @@ var patch = (value, types = {}) => {
 var unpatch = (value, types = {}) => {
   return JSON.parse(stringify(value, types));
 };
+
+// src/safe-number/parse.ts
+var safeNumberParse = (json, props) => {
+  return JSON.parse(
+    json,
+    // @ts-ignore
+    createSafeNumberReviver(props)
+  );
+};
+var createSafeNumberReviver = (props) => {
+  return (_, value, context) => {
+    if (typeof value === "number") {
+      return props.parse(context.source);
+    }
+    return value;
+  };
+};
+
+// src/safe-number/stringify.ts
+var safeNumberStringify = (value, props) => {
+  return JSON.stringify(value, createSafeNumberReplacer(props));
+};
+var createSafeNumberReplacer = (props) => {
+  return function(key, value) {
+    const original = this[key];
+    if (props.is(original)) {
+      return JSON.rawJSON(props.stringify(original));
+    }
+    return value;
+  };
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createReplacer,
   createReviver,
+  createSafeNumberReplacer,
+  createSafeNumberReviver,
   parse,
   patch,
+  safeNumberParse,
+  safeNumberStringify,
   stringify,
   unpatch
 });

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 type Serializable<I, O> = {
-    is: (value: unknown) => value is I;
+    is: (value: unknown) => boolean;
     parse: (value: O) => I;
     stringify: (value: I) => O;
 };
@@ -9,11 +9,28 @@ declare const patch: (value: unknown, types?: SerializableTypes) => any;
 declare const unpatch: (value: unknown, types?: SerializableTypes) => any;
 
 declare const parse: (json: string, types?: SerializableTypes) => any;
-type Reviver = (this: any, key: string, value: any) => any;
-declare const createReviver: (types?: SerializableTypes) => Reviver;
+type Reviver$1 = (this: any, key: string, value: any) => any;
+declare const createReviver: (types?: SerializableTypes) => Reviver$1;
 
 declare const stringify: (value: unknown, types?: SerializableTypes) => string;
+type Replacer$1 = (this: any, key: string, value: any) => any;
+declare const createReplacer: (types?: SerializableTypes) => Replacer$1;
+
+type Props$1 = {
+    parse: (value: string) => unknown;
+};
+declare const safeNumberParse: (json: string, props: Props$1) => any;
+type Reviver = (this: any, key: string, value: any, context: {
+    source: string;
+}) => any;
+declare const createSafeNumberReviver: (props: Props$1) => Reviver;
+
+type Props<T> = {
+    is: (value: unknown) => value is T;
+    stringify: (value: T) => string;
+};
+declare const safeNumberStringify: <T>(value: unknown, props: Props<T>) => string;
 type Replacer = (this: any, key: string, value: any) => any;
-declare const createReplacer: (types?: SerializableTypes) => Replacer;
+declare const createSafeNumberReplacer: <T>(props: Props<T>) => Replacer;
 
-export { type Serializable, createReplacer, createReviver, parse, patch, stringify, unpatch };
+export { type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, stringify, unpatch };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 type Serializable<I, O> = {
-    is: (value: unknown) => value is I;
+    is: (value: unknown) => boolean;
     parse: (value: O) => I;
     stringify: (value: I) => O;
 };
@@ -9,11 +9,28 @@ declare const patch: (value: unknown, types?: SerializableTypes) => any;
 declare const unpatch: (value: unknown, types?: SerializableTypes) => any;
 
 declare const parse: (json: string, types?: SerializableTypes) => any;
-type Reviver = (this: any, key: string, value: any) => any;
-declare const createReviver: (types?: SerializableTypes) => Reviver;
+type Reviver$1 = (this: any, key: string, value: any) => any;
+declare const createReviver: (types?: SerializableTypes) => Reviver$1;
 
 declare const stringify: (value: unknown, types?: SerializableTypes) => string;
+type Replacer$1 = (this: any, key: string, value: any) => any;
+declare const createReplacer: (types?: SerializableTypes) => Replacer$1;
+
+type Props$1 = {
+    parse: (value: string) => unknown;
+};
+declare const safeNumberParse: (json: string, props: Props$1) => any;
+type Reviver = (this: any, key: string, value: any, context: {
+    source: string;
+}) => any;
+declare const createSafeNumberReviver: (props: Props$1) => Reviver;
+
+type Props<T> = {
+    is: (value: unknown) => value is T;
+    stringify: (value: T) => string;
+};
+declare const safeNumberStringify: <T>(value: unknown, props: Props<T>) => string;
 type Replacer = (this: any, key: string, value: any) => any;
-declare const createReplacer: (types?: SerializableTypes) => Replacer;
+declare const createSafeNumberReplacer: <T>(props: Props<T>) => Replacer;
 
-export { type Serializable, createReplacer, createReviver, parse, patch, stringify, unpatch };
+export { type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, stringify, unpatch };

package/dist/index.js

@@ -20,6 +20,15 @@ var $date = {
   stringify: (v) => v.toISOString()
 };
 
+// src/type/infinity.ts
+var P = Infinity;
+var N = -Infinity;
+var $infinity = {
+  is: (v) => v === P || v === N,
+  parse: (v) => v === 1 ? P : N,
+  stringify: (v) => v > 0 ? 1 : 0
+};
+
 // src/type/map.ts
 var $map = {
   is: (v) => v instanceof Map,
@@ -27,6 +36,20 @@ var $map = {
   stringify: (v) => Array.from(v)
 };
 
+// src/type/nan.ts
+var $nan = {
+  is: (v) => typeof v === "number" && isNaN(v),
+  parse: (_) => NaN,
+  stringify: (_) => 0
+};
+
+// src/type/regexp.ts
+var $regexp = {
+  is: (v) => v instanceof RegExp,
+  parse: (v) => new RegExp(v[0], v[1]),
+  stringify: (v) => [v.source, v.flags]
+};
+
 // src/type/set.ts
 var $set = {
   is: (v) => v instanceof Set,
@@ -34,6 +57,13 @@ var $set = {
   stringify: (v) => Array.from(v)
 };
 
+// src/type/binary.ts
+var $binary = {
+  is: (v) => v instanceof Uint8Array,
+  parse: (v) => Uint8Array.from(atob(v), (c) => c.charCodeAt(0)),
+  stringify: (v) => btoa(String.fromCharCode(...v))
+};
+
 // src/type/undefined.ts
 var $undefined = {
   is: (v) => typeof v === "undefined",
@@ -41,14 +71,26 @@ var $undefined = {
   stringify: (_) => 0
 };
 
+// src/type/url.ts
+var $url = {
+  is: (v) => v instanceof URL,
+  parse: (v) => new URL(v),
+  stringify: (v) => v.toString()
+};
+
 // src/type/index.ts
 var baseTypes = {
   $undefined,
+  $infinity,
   $bigfloat,
   $bigint,
+  $regexp,
+  $binary,
   $date,
   $set,
-  $map
+  $map,
+  $nan,
+  $url
 };
 
 // src/parse.ts
@@ -105,11 +147,46 @@ var patch = (value, types = {}) => {
 var unpatch = (value, types = {}) => {
   return JSON.parse(stringify(value, types));
 };
+
+// src/safe-number/parse.ts
+var safeNumberParse = (json, props) => {
+  return JSON.parse(
+    json,
+    // @ts-ignore
+    createSafeNumberReviver(props)
+  );
+};
+var createSafeNumberReviver = (props) => {
+  return (_, value, context) => {
+    if (typeof value === "number") {
+      return props.parse(context.source);
+    }
+    return value;
+  };
+};
+
+// src/safe-number/stringify.ts
+var safeNumberStringify = (value, props) => {
+  return JSON.stringify(value, createSafeNumberReplacer(props));
+};
+var createSafeNumberReplacer = (props) => {
+  return function(key, value) {
+    const original = this[key];
+    if (props.is(original)) {
+      return JSON.rawJSON(props.stringify(original));
+    }
+    return value;
+  };
+};
 export {
   createReplacer,
   createReviver,
+  createSafeNumberReplacer,
+  createSafeNumberReviver,
   parse,
   patch,
+  safeNumberParse,
+  safeNumberStringify,
   stringify,
   unpatch
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awsless/json",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "license": "MIT",
   "type": "module",
   "keywords": [
@@ -12,6 +12,11 @@
     "Map",
     "Set",
     "Date",
+    "NaN",
+    "Infinity",
+    "RegExp",
+    "Uint8Array",
+    "Binary",
     "undefined"
   ],
   "repository": {