@awsless/json 0.0.4 → 0.0.6

package/README.MD

@@ -3,6 +3,13 @@
 
 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 basic JS types.
+ - Extendable.
+
 ## The Problem
 
 JSON doesn't have support for types like:
@@ -15,6 +22,8 @@ JSON doesn't have support for types like:
 
 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.
 
+Also `JSON.parse/stringify` don't solve the potential loss of precision problem.
+
 ## Basic Usage
 
 ```ts
@@ -65,24 +74,51 @@ const $custom: Serializable<Custom, string> = {
 	stringify: v => v.value,
 }
 
-// Stringify your custom type
+// Stringify your custom type.
 const json = stringify(new Custom('example'), { $custom })
 
-// Parse the json with your custom type
+// Parse the json with your custom type.
 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.
+
+```ts
+import { safeNumberParse, safeNumberStringify } from '@awsless/json';
+import { BigFloat } 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
 
-Object properties with `undefined` as value type will be stripped away.
+### 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.
+
+### Object properties with `undefined` as value type will be stripped away.
 
 ```ts
-// Will result in an empty object
+// Will result in an empty object.
 const result = parse(stringify({ key: undefined }))
 
-// Will log false
+// Will log false.
 console.log('key' in result)
 
-// Will log true
+// Will log true.
 console.log(result.key === undefined)
 ```

package/dist/index.cjs

@@ -22,9 +22,14 @@ var src_exports = {};
 __export(src_exports, {
   createReplacer: () => createReplacer,
   createReviver: () => createReviver,
+  createSafeNumberReplacer: () => createSafeNumberReplacer,
+  createSafeNumberReviver: () => createSafeNumberReviver,
   parse: () => parse,
   patch: () => patch,
-  stringify: () => stringify
+  safeNumberParse: () => safeNumberParse,
+  safeNumberStringify: () => safeNumberStringify,
+  stringify: () => stringify,
+  unpatch: () => unpatch
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -130,13 +135,52 @@ var createReplacer = (types = {}) => {
 
 // src/patch.ts
 var patch = (value, types = {}) => {
-  return parse(stringify(value, types), types);
+  return parse(JSON.stringify(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 function(_, 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,
-  stringify
+  safeNumberParse,
+  safeNumberStringify,
+  stringify,
+  unpatch
 });

package/dist/index.d.cts

@@ -5,14 +5,32 @@ type Serializable<I, O> = {
 };
 type SerializableTypes = Record<string, Serializable<any, any>>;
 
-declare const patch: <T>(value: T, types?: SerializableTypes) => T;
+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 };
+export { type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, stringify, unpatch };

package/dist/index.d.ts

@@ -5,14 +5,32 @@ type Serializable<I, O> = {
 };
 type SerializableTypes = Record<string, Serializable<any, any>>;
 
-declare const patch: <T>(value: T, types?: SerializableTypes) => T;
+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 };
+export { type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, stringify, unpatch };

package/dist/index.js

@@ -100,12 +100,51 @@ var createReplacer = (types = {}) => {
 
 // src/patch.ts
 var patch = (value, types = {}) => {
-  return parse(stringify(value, types), types);
+  return parse(JSON.stringify(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 function(_, 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,
-  stringify
+  safeNumberParse,
+  safeNumberStringify,
+  stringify,
+  unpatch
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awsless/json",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "license": "MIT",
   "type": "module",
   "keywords": [