@awsless/json 0.0.2 → 0.0.4

package/README.MD

@@ -6,13 +6,14 @@ The `@awsless/json` package adds support for more JavaScript native types to JSO
 ## The Problem
 
 JSON doesn't have support for types like:
-- Set
-- Map
-- Date
-- BigInt
-- BigFloat - npm @awsless/bit-float
+- `undefined`
+- `Set`
+- `Map`
+- `Date`
+- `BigInt`
+- `BigFloat` - npm package @awsless/bit-float
 
-Having to decode & encode these type of values can get quite annoying.
+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.
 
 ## Basic Usage
 
@@ -20,13 +21,29 @@ Having to decode & encode these type of values can get quite annoying.
 import { parse, stringify } from '@awsless/json';
 
 // Stringify a bigint.
-// The output will be {"$bigint": "1"}
+// The output will be {"$bigint":"1"}
 const json = stringify(1n)
 
 // Parse the json with a bigint inside.
 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.
+
+```ts
+import { stringify, patch } from '@awsless/json';
+
+const json = stringify(1n)
+
+// The native JSON.parse function will not parse our bigint correctly.
+const broken = JSON.parse(json)
+
+// Will fix the broken output.
+const fixed = patch(broken)
+```
+
 ## Extending Supported Types
 
 We let you extend JSON to support your own custom types.
@@ -54,3 +71,18 @@ const json = stringify(new Custom('example'), { $custom })
 // Parse the json with your custom type
 const value = parse(json, { $custom })
 ```
+
+## Known Issue's
+
+Object properties with `undefined` as value type will be stripped away.
+
+```ts
+// Will result in an empty object
+const result = parse(stringify({ key: undefined }))
+
+// Will log false
+console.log('key' in result)
+
+// Will log true
+console.log(result.key === undefined)
+```

package/dist/index.cjs

@@ -23,6 +23,7 @@ __export(src_exports, {
   createReplacer: () => createReplacer,
   createReviver: () => createReviver,
   parse: () => parse,
+  patch: () => patch,
   stringify: () => stringify
 });
 module.exports = __toCommonJS(src_exports);
@@ -63,14 +64,24 @@ var $set = {
   stringify: (v) => Array.from(v)
 };
 
-// src/index.ts
+// src/type/undefined.ts
+var $undefined = {
+  is: (v) => typeof v === "undefined",
+  parse: (_) => void 0,
+  stringify: (_) => 0
+};
+
+// src/type/index.ts
 var baseTypes = {
+  $undefined,
   $bigfloat,
   $bigint,
   $date,
   $set,
   $map
 };
+
+// src/parse.ts
 var parse = (json, types = {}) => {
   return JSON.parse(json, createReviver(types));
 };
@@ -94,6 +105,8 @@ var createReviver = (types = {}) => {
     return value;
   };
 };
+
+// src/stringify.ts
 var stringify = (value, types = {}) => {
   return JSON.stringify(value, createReplacer(types));
 };
@@ -114,10 +127,16 @@ var createReplacer = (types = {}) => {
     return value;
   };
 };
+
+// src/patch.ts
+var patch = (value, types = {}) => {
+  return parse(stringify(value, types), types);
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createReplacer,
   createReviver,
   parse,
+  patch,
   stringify
 });

package/dist/index.d.cts

@@ -4,11 +4,15 @@ type Serializable<I, O> = {
     stringify: (value: I) => O;
 };
 type SerializableTypes = Record<string, Serializable<any, any>>;
+
+declare const patch: <T>(value: T, types?: SerializableTypes) => T;
+
 declare const parse: (json: string, types?: SerializableTypes) => any;
 type Reviver = (this: any, key: string, value: any) => any;
-type Replacer = (this: any, key: string, value: any) => any;
 declare const createReviver: (types?: SerializableTypes) => Reviver;
+
 declare const stringify: (value: unknown, types?: SerializableTypes) => string;
+type Replacer = (this: any, key: string, value: any) => any;
 declare const createReplacer: (types?: SerializableTypes) => Replacer;
 
-export { type Serializable, createReplacer, createReviver, parse, stringify };
+export { type Serializable, createReplacer, createReviver, parse, patch, stringify };

package/dist/index.d.ts

@@ -4,11 +4,15 @@ type Serializable<I, O> = {
     stringify: (value: I) => O;
 };
 type SerializableTypes = Record<string, Serializable<any, any>>;
+
+declare const patch: <T>(value: T, types?: SerializableTypes) => T;
+
 declare const parse: (json: string, types?: SerializableTypes) => any;
 type Reviver = (this: any, key: string, value: any) => any;
-type Replacer = (this: any, key: string, value: any) => any;
 declare const createReviver: (types?: SerializableTypes) => Reviver;
+
 declare const stringify: (value: unknown, types?: SerializableTypes) => string;
+type Replacer = (this: any, key: string, value: any) => any;
 declare const createReplacer: (types?: SerializableTypes) => Replacer;
 
-export { type Serializable, createReplacer, createReviver, parse, stringify };
+export { type Serializable, createReplacer, createReviver, parse, patch, stringify };

package/dist/index.js

@@ -34,14 +34,24 @@ var $set = {
   stringify: (v) => Array.from(v)
 };
 
-// src/index.ts
+// src/type/undefined.ts
+var $undefined = {
+  is: (v) => typeof v === "undefined",
+  parse: (_) => void 0,
+  stringify: (_) => 0
+};
+
+// src/type/index.ts
 var baseTypes = {
+  $undefined,
   $bigfloat,
   $bigint,
   $date,
   $set,
   $map
 };
+
+// src/parse.ts
 var parse = (json, types = {}) => {
   return JSON.parse(json, createReviver(types));
 };
@@ -65,6 +75,8 @@ var createReviver = (types = {}) => {
     return value;
   };
 };
+
+// src/stringify.ts
 var stringify = (value, types = {}) => {
   return JSON.stringify(value, createReplacer(types));
 };
@@ -85,9 +97,15 @@ var createReplacer = (types = {}) => {
     return value;
   };
 };
+
+// src/patch.ts
+var patch = (value, types = {}) => {
+  return parse(stringify(value, types), types);
+};
 export {
   createReplacer,
   createReviver,
   parse,
+  patch,
   stringify
 };

package/package.json

@@ -1,8 +1,19 @@
 {
   "name": "@awsless/json",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "license": "MIT",
   "type": "module",
+  "keywords": [
+    "JSON",
+    "stringify",
+    "parse",
+    "BigInt",
+    "BigFloat",
+    "Map",
+    "Set",
+    "Date",
+    "undefined"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/awsless/awsless.git"