@awsless/json 0.0.10 → 0.0.11

package/README.MD

@@ -1,18 +1,19 @@
-
 # @awsless/json
 
 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.
+
+- 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`
@@ -33,7 +34,7 @@ Additionally, the native `JSON.parse/stringify` functions do not address the pot
 ## Basic Usage
 
 ```ts
-import { parse, stringify } from '@awsless/json';
+import { parse, stringify } from '@awsless/json'
 
 // The output will be {"$bigint":"1"}
 const json = stringify(1n)
@@ -47,7 +48,7 @@ const value = parse(json)
 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';
+import { stringify, patch } from '@awsless/json'
 
 const json = stringify(1n)
 
@@ -63,7 +64,7 @@ const fixed = patch(broken)
 We let you extend JSON to support your own custom types.
 
 ```ts
-import { parse, stringify, Serializable } from '@awsless/json';
+import { parse, stringify, Serializable, setGlobalTypes } from '@awsless/json'
 
 class Custom {
 	readonly value
@@ -80,10 +81,33 @@ const $custom: Serializable<Custom, string> = {
 }
 
 // Stringify your custom type.
-const json = stringify(new Custom('example'), { $custom })
+const json = stringify(new Custom('example'), {
+	types: { $custom },
+})
 
 // Parse the json with your custom type.
-const value = parse(json, { $custom })
+const value = parse(json, {
+	types: { $custom },
+})
+
+// Additionally, you can globally add your own extensions.
+setGlobalTypes({ $custom })
+```
+
+## Preserve undefined object properties
+
+The native `JSON.stringify` will strip undefined object properties to generate smaller JSON output. We do the same thing but we have a special option to opt out of this behavior if correctness is important to you.
+
+```ts
+const input = { key: undefined }
+
+const smallerJson = stringify(input, {
+	preserveUndefinedValues: true,
+}) // {}
+
+const moreCorrectJson = stringify(input, {
+	preserveUndefinedValues: true,
+}) // {"key":{"$undefined":0}}
 ```
 
 ## Precision Loss
@@ -91,15 +115,15 @@ const value = parse(json, { $custom })
 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
+> 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';
+import { safeNumberParse, safeNumberStringify } from '@awsless/json'
+import { BigFloat, eq } from '@awsless/big-float'
+
+const one = new BigFloat(1)
 
-const value = new BigFloat(1)
-const json = safeNumberStringify(ONE, {
+const json = safeNumberStringify(one, {
 	is: v => v instanceof BigFloat,
 	stringify: v => v.toString(),
 })
@@ -110,7 +134,7 @@ const result = safeNumberParse('1', {
 	parse: v => new BigFloat(v),
 })
 
-console.log(eq(value, result)) // true
+console.log(eq(one, result)) // true
 ```
 
 ## Known Issue's

package/dist/index.cjs

@@ -20,12 +20,24 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  $bigfloat: () => $bigfloat,
+  $bigint: () => $bigint,
+  $binary: () => $binary,
+  $date: () => $date,
+  $duration: () => $duration,
+  $infinity: () => $infinity,
+  $map: () => $map,
   $mockdate: () => $mockdate,
+  $nan: () => $nan,
+  $regexp: () => $regexp,
+  $set: () => $set,
+  $undefined: () => $undefined,
+  $url: () => $url,
   createReplacer: () => createReplacer,
   createReviver: () => createReviver,
   createSafeNumberReplacer: () => createSafeNumberReplacer,
   createSafeNumberReviver: () => createSafeNumberReviver,
-  parse: () => parse,
+  parse: () => parse2,
   patch: () => patch,
   safeNumberParse: () => safeNumberParse,
   safeNumberStringify: () => safeNumberStringify,
@@ -39,7 +51,7 @@ module.exports = __toCommonJS(index_exports);
 var import_big_float = require("@awsless/big-float");
 var $bigfloat = {
   is: (v) => v instanceof import_big_float.BigFloat,
-  parse: (v) => new import_big_float.BigFloat(v),
+  parse: (v) => (0, import_big_float.parse)(v),
   stringify: (v) => v.toString()
 };
 
@@ -147,11 +159,11 @@ var baseTypes = {
 };
 
 // src/parse.ts
-var parse = (json, types = {}) => {
+var parse2 = (json, options) => {
   const replacements = [];
   const result = JSON.parse(
     json,
-    createReviver(types, (target, key, value) => {
+    createReviver(options?.types, (target, key, value) => {
       replacements.push([target, key, value]);
     })
   );
@@ -176,12 +188,10 @@ var createReviver = (types = {}, registerReplacement) => {
           const stringified = original[typeName];
           if ("parse" in type) {
             return type.parse(stringified);
-          } else if (registerReplacement) {
+          } else {
             const result = type.replace(stringified);
-            registerReplacement(this, key, result);
+            registerReplacement?.(this, key, result);
             return result;
-          } else {
-            return type.replace(stringified);
           }
         }
       }
@@ -191,16 +201,19 @@ var createReviver = (types = {}, registerReplacement) => {
 };
 
 // src/stringify.ts
-var stringify = (value, types = {}) => {
-  return JSON.stringify(value, createReplacer(types));
+var stringify = (value, options) => {
+  return JSON.stringify(value, createReplacer(options));
 };
-var createReplacer = (types = {}) => {
-  types = {
+var createReplacer = (options) => {
+  const types = {
     ...baseTypes,
-    ...types
+    ...options?.types
   };
   return function(key, value) {
     const original = this[key];
+    if (!options?.preserveUndefinedValues && key && typeof original === "undefined" && typeof this === "object" && !Array.isArray(this)) {
+      return value;
+    }
     for (const [typeName, type] of Object.entries(types)) {
       if (type.is(original)) {
         return {
@@ -214,7 +227,7 @@ var createReplacer = (types = {}) => {
 
 // src/patch.ts
 var patch = (value, types = {}) => {
-  return parse(JSON.stringify(value), types);
+  return parse2(JSON.stringify(value), types);
 };
 var unpatch = (value, types = {}) => {
   return JSON.parse(stringify(value, types));
@@ -225,13 +238,6 @@ var setGlobalTypes = (types) => {
   Object.assign(baseTypes, types);
 };
 
-// src/type/mockdate.ts
-var $mockdate = {
-  is: (v) => typeof v === "object" && v !== null && "toISOString" in v && typeof v.toISOString === "function" && "getTime" in v && typeof v.getTime === "function" && "toUTCString" in v && typeof v.toUTCString === "function",
-  parse: (v) => new Date(v),
-  stringify: (v) => v.toISOString()
-};
-
 // src/safe-number/parse.ts
 var safeNumberParse = (json, props) => {
   return JSON.parse(
@@ -262,9 +268,28 @@ var createSafeNumberReplacer = (props) => {
     return value;
   };
 };
+
+// src/type/mockdate.ts
+var $mockdate = {
+  is: (v) => typeof v === "object" && v !== null && "toISOString" in v && typeof v.toISOString === "function" && "getTime" in v && typeof v.getTime === "function" && "toUTCString" in v && typeof v.toUTCString === "function",
+  parse: (v) => new Date(v),
+  stringify: (v) => v.toISOString()
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  $bigfloat,
+  $bigint,
+  $binary,
+  $date,
+  $duration,
+  $infinity,
+  $map,
   $mockdate,
+  $nan,
+  $regexp,
+  $set,
+  $undefined,
+  $url,
   createReplacer,
   createReviver,
   createSafeNumberReplacer,

package/dist/index.d.cts

@@ -1,3 +1,6 @@
+import { BigFloat } from '@awsless/big-float';
+import { Duration } from '@awsless/duration';
+
 type Serializable<I, O> = {
     is: (value: unknown) => boolean;
     stringify: (value: I) => O;
@@ -11,18 +14,23 @@ type SerializableTypes = Record<string, Serializable<any, any>>;
 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 Options$1 = {
+    types?: SerializableTypes;
+};
+declare const parse: (json: string, options?: Options$1) => any;
 type Reviver$1 = (this: any, key: string, value: any) => any;
 declare const createReviver: (types?: SerializableTypes, registerReplacement?: (target: any, key: string, value: unknown) => void) => Reviver$1;
 
-declare const stringify: (value: unknown, types?: SerializableTypes) => string;
+type Options = {
+    types?: SerializableTypes;
+    preserveUndefinedValues?: boolean;
+};
+declare const stringify: (value: unknown, options?: Options) => string;
 type Replacer$1 = (this: any, key: string, value: any) => any;
-declare const createReplacer: (types?: SerializableTypes) => Replacer$1;
+declare const createReplacer: (options?: Options) => Replacer$1;
 
 declare const setGlobalTypes: (types: SerializableTypes) => void;
 
-declare const $mockdate: Serializable<Date, string>;
-
 type Props$1 = {
     parse: (value: string) => unknown;
 };
@@ -40,4 +48,30 @@ declare const safeNumberStringify: <T>(value: unknown, props: Props<T>) => strin
 type Replacer = (this: any, key: string, value: any) => any;
 declare const createSafeNumberReplacer: <T>(props: Props<T>) => Replacer;
 
-export { $mockdate, type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, setGlobalTypes, stringify, unpatch };
+declare const $bigfloat: Serializable<BigFloat, string>;
+
+declare const $bigint: Serializable<bigint, string>;
+
+declare const $binary: Serializable<Uint8Array, string>;
+
+declare const $date: Serializable<Date, string>;
+
+declare const $duration: Serializable<Duration, string>;
+
+declare const $infinity: Serializable<typeof Infinity, 1 | 0>;
+
+declare const $map: Serializable<Map<unknown, unknown>, [unknown, unknown][]>;
+
+declare const $mockdate: Serializable<Date, string>;
+
+declare const $nan: Serializable<typeof NaN, 0>;
+
+declare const $regexp: Serializable<RegExp, [string, string]>;
+
+declare const $set: Serializable<Set<unknown>, unknown[]>;
+
+declare const $undefined: Serializable<undefined, 0>;
+
+declare const $url: Serializable<URL, string>;
+
+export { $bigfloat, $bigint, $binary, $date, $duration, $infinity, $map, $mockdate, $nan, $regexp, $set, $undefined, $url, type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, setGlobalTypes, stringify, unpatch };

package/dist/index.d.ts

@@ -1,3 +1,6 @@
+import { BigFloat } from '@awsless/big-float';
+import { Duration } from '@awsless/duration';
+
 type Serializable<I, O> = {
     is: (value: unknown) => boolean;
     stringify: (value: I) => O;
@@ -11,18 +14,23 @@ type SerializableTypes = Record<string, Serializable<any, any>>;
 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 Options$1 = {
+    types?: SerializableTypes;
+};
+declare const parse: (json: string, options?: Options$1) => any;
 type Reviver$1 = (this: any, key: string, value: any) => any;
 declare const createReviver: (types?: SerializableTypes, registerReplacement?: (target: any, key: string, value: unknown) => void) => Reviver$1;
 
-declare const stringify: (value: unknown, types?: SerializableTypes) => string;
+type Options = {
+    types?: SerializableTypes;
+    preserveUndefinedValues?: boolean;
+};
+declare const stringify: (value: unknown, options?: Options) => string;
 type Replacer$1 = (this: any, key: string, value: any) => any;
-declare const createReplacer: (types?: SerializableTypes) => Replacer$1;
+declare const createReplacer: (options?: Options) => Replacer$1;
 
 declare const setGlobalTypes: (types: SerializableTypes) => void;
 
-declare const $mockdate: Serializable<Date, string>;
-
 type Props$1 = {
     parse: (value: string) => unknown;
 };
@@ -40,4 +48,30 @@ declare const safeNumberStringify: <T>(value: unknown, props: Props<T>) => strin
 type Replacer = (this: any, key: string, value: any) => any;
 declare const createSafeNumberReplacer: <T>(props: Props<T>) => Replacer;
 
-export { $mockdate, type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, setGlobalTypes, stringify, unpatch };
+declare const $bigfloat: Serializable<BigFloat, string>;
+
+declare const $bigint: Serializable<bigint, string>;
+
+declare const $binary: Serializable<Uint8Array, string>;
+
+declare const $date: Serializable<Date, string>;
+
+declare const $duration: Serializable<Duration, string>;
+
+declare const $infinity: Serializable<typeof Infinity, 1 | 0>;
+
+declare const $map: Serializable<Map<unknown, unknown>, [unknown, unknown][]>;
+
+declare const $mockdate: Serializable<Date, string>;
+
+declare const $nan: Serializable<typeof NaN, 0>;
+
+declare const $regexp: Serializable<RegExp, [string, string]>;
+
+declare const $set: Serializable<Set<unknown>, unknown[]>;
+
+declare const $undefined: Serializable<undefined, 0>;
+
+declare const $url: Serializable<URL, string>;
+
+export { $bigfloat, $bigint, $binary, $date, $duration, $infinity, $map, $mockdate, $nan, $regexp, $set, $undefined, $url, type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, setGlobalTypes, stringify, unpatch };

package/dist/index.js

@@ -1,8 +1,8 @@
 // src/type/bigfloat.ts
-import { BigFloat } from "@awsless/big-float";
+import { BigFloat, parse } from "@awsless/big-float";
 var $bigfloat = {
   is: (v) => v instanceof BigFloat,
-  parse: (v) => new BigFloat(v),
+  parse: (v) => parse(v),
   stringify: (v) => v.toString()
 };
 
@@ -110,11 +110,11 @@ var baseTypes = {
 };
 
 // src/parse.ts
-var parse = (json, types = {}) => {
+var parse2 = (json, options) => {
   const replacements = [];
   const result = JSON.parse(
     json,
-    createReviver(types, (target, key, value) => {
+    createReviver(options?.types, (target, key, value) => {
       replacements.push([target, key, value]);
     })
   );
@@ -139,12 +139,10 @@ var createReviver = (types = {}, registerReplacement) => {
           const stringified = original[typeName];
           if ("parse" in type) {
             return type.parse(stringified);
-          } else if (registerReplacement) {
+          } else {
             const result = type.replace(stringified);
-            registerReplacement(this, key, result);
+            registerReplacement?.(this, key, result);
             return result;
-          } else {
-            return type.replace(stringified);
           }
         }
       }
@@ -154,16 +152,19 @@ var createReviver = (types = {}, registerReplacement) => {
 };
 
 // src/stringify.ts
-var stringify = (value, types = {}) => {
-  return JSON.stringify(value, createReplacer(types));
+var stringify = (value, options) => {
+  return JSON.stringify(value, createReplacer(options));
 };
-var createReplacer = (types = {}) => {
-  types = {
+var createReplacer = (options) => {
+  const types = {
     ...baseTypes,
-    ...types
+    ...options?.types
   };
   return function(key, value) {
     const original = this[key];
+    if (!options?.preserveUndefinedValues && key && typeof original === "undefined" && typeof this === "object" && !Array.isArray(this)) {
+      return value;
+    }
     for (const [typeName, type] of Object.entries(types)) {
       if (type.is(original)) {
         return {
@@ -177,7 +178,7 @@ var createReplacer = (types = {}) => {
 
 // src/patch.ts
 var patch = (value, types = {}) => {
-  return parse(JSON.stringify(value), types);
+  return parse2(JSON.stringify(value), types);
 };
 var unpatch = (value, types = {}) => {
   return JSON.parse(stringify(value, types));
@@ -188,13 +189,6 @@ var setGlobalTypes = (types) => {
   Object.assign(baseTypes, types);
 };
 
-// src/type/mockdate.ts
-var $mockdate = {
-  is: (v) => typeof v === "object" && v !== null && "toISOString" in v && typeof v.toISOString === "function" && "getTime" in v && typeof v.getTime === "function" && "toUTCString" in v && typeof v.toUTCString === "function",
-  parse: (v) => new Date(v),
-  stringify: (v) => v.toISOString()
-};
-
 // src/safe-number/parse.ts
 var safeNumberParse = (json, props) => {
   return JSON.parse(
@@ -225,13 +219,32 @@ var createSafeNumberReplacer = (props) => {
     return value;
   };
 };
+
+// src/type/mockdate.ts
+var $mockdate = {
+  is: (v) => typeof v === "object" && v !== null && "toISOString" in v && typeof v.toISOString === "function" && "getTime" in v && typeof v.getTime === "function" && "toUTCString" in v && typeof v.toUTCString === "function",
+  parse: (v) => new Date(v),
+  stringify: (v) => v.toISOString()
+};
 export {
+  $bigfloat,
+  $bigint,
+  $binary,
+  $date,
+  $duration,
+  $infinity,
+  $map,
   $mockdate,
+  $nan,
+  $regexp,
+  $set,
+  $undefined,
+  $url,
   createReplacer,
   createReviver,
   createSafeNumberReplacer,
   createSafeNumberReviver,
-  parse,
+  parse2 as parse,
   patch,
   safeNumberParse,
   safeNumberStringify,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awsless/json",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "license": "MIT",
   "type": "module",
   "keywords": [
@@ -41,12 +41,12 @@
     }
   },
   "peerDependencies": {
-    "@awsless/big-float": "^0.0.6",
-    "@awsless/duration": "^0.0.3"
+    "@awsless/big-float": "^0.1.5",
+    "@awsless/duration": "^0.0.4"
   },
   "devDependencies": {
-    "@awsless/duration": "^0.0.3",
-    "@awsless/big-float": "^0.0.6"
+    "@awsless/big-float": "^0.1.5",
+    "@awsless/duration": "^0.0.4"
   },
   "scripts": {
     "test": "pnpm code test",