@awsless/json 0.0.8 → 0.0.10

package/README.MD

@@ -24,6 +24,7 @@ JSON doesn't have support for types like:
 - `Date`
 - `BigInt`
 - `BigFloat` - npm package @awsless/bit-float
+- `Duration` - npm package @awsless/duration
 
 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.
 
@@ -117,16 +118,3 @@ console.log(eq(value, result)) // true
 ### 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.
-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

@@ -18,8 +18,9 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
+  $mockdate: () => $mockdate,
   createReplacer: () => createReplacer,
   createReviver: () => createReviver,
   createSafeNumberReplacer: () => createSafeNumberReplacer,
@@ -28,10 +29,11 @@ __export(src_exports, {
   patch: () => patch,
   safeNumberParse: () => safeNumberParse,
   safeNumberStringify: () => safeNumberStringify,
+  setGlobalTypes: () => setGlobalTypes,
   stringify: () => stringify,
   unpatch: () => unpatch
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/type/bigfloat.ts
 var import_big_float = require("@awsless/big-float");
@@ -64,10 +66,24 @@ var $infinity = {
   stringify: (v) => v > 0 ? 1 : 0
 };
 
+// src/type/undefined.ts
+var $undefined = {
+  is: (v) => typeof v === "undefined",
+  replace: (_) => void 0,
+  stringify: (_) => 0
+};
+var isUndefined = (value) => {
+  return typeof value === "object" && value !== null && Object.keys(value).length === 1 && "$undefined" in value && value.$undefined === 0;
+};
+
 // src/type/map.ts
 var $map = {
   is: (v) => v instanceof Map,
-  parse: (v) => new Map(v),
+  parse: (v) => new Map(
+    v.map((pair) => {
+      return pair.map((i) => isUndefined(i) ? void 0 : i);
+    })
+  ),
   stringify: (v) => Array.from(v)
 };
 
@@ -88,7 +104,7 @@ var $regexp = {
 // src/type/set.ts
 var $set = {
   is: (v) => v instanceof Set,
-  parse: (v) => new Set(v),
+  parse: (v) => new Set(v.map((i) => isUndefined(i) ? void 0 : i)),
   stringify: (v) => Array.from(v)
 };
 
@@ -99,13 +115,6 @@ var $binary = {
   stringify: (v) => btoa(String.fromCharCode(...v))
 };
 
-// src/type/undefined.ts
-var $undefined = {
-  is: (v) => typeof v === "undefined",
-  parse: (_) => void 0,
-  stringify: (_) => 0
-};
-
 // src/type/url.ts
 var $url = {
   is: (v) => v instanceof URL,
@@ -139,9 +148,19 @@ var baseTypes = {
 
 // src/parse.ts
 var parse = (json, types = {}) => {
-  return JSON.parse(json, createReviver(types));
+  const replacements = [];
+  const result = JSON.parse(
+    json,
+    createReviver(types, (target, key, value) => {
+      replacements.push([target, key, value]);
+    })
+  );
+  for (const [target, key, value] of replacements) {
+    target[key] = value;
+  }
+  return result;
 };
-var createReviver = (types = {}) => {
+var createReviver = (types = {}, registerReplacement) => {
   types = {
     ...baseTypes,
     ...types
@@ -154,7 +173,16 @@ var createReviver = (types = {}) => {
         const typeName = keys[0];
         if (typeName in types && types[typeName]) {
           const type = types[typeName];
-          return type.parse(original[typeName]);
+          const stringified = original[typeName];
+          if ("parse" in type) {
+            return type.parse(stringified);
+          } else if (registerReplacement) {
+            const result = type.replace(stringified);
+            registerReplacement(this, key, result);
+            return result;
+          } else {
+            return type.replace(stringified);
+          }
         }
       }
     }
@@ -192,6 +220,18 @@ var unpatch = (value, types = {}) => {
   return JSON.parse(stringify(value, types));
 };
 
+// src/global.ts
+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(
@@ -224,6 +264,7 @@ var createSafeNumberReplacer = (props) => {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  $mockdate,
   createReplacer,
   createReviver,
   createSafeNumberReplacer,
@@ -232,6 +273,7 @@ var createSafeNumberReplacer = (props) => {
   patch,
   safeNumberParse,
   safeNumberStringify,
+  setGlobalTypes,
   stringify,
   unpatch
 });

package/dist/index.d.cts

@@ -1,8 +1,11 @@
 type Serializable<I, O> = {
     is: (value: unknown) => boolean;
-    parse: (value: O) => I;
     stringify: (value: I) => O;
-};
+} & ({
+    parse: (value: O) => I;
+} | {
+    replace: (value: O) => I;
+});
 type SerializableTypes = Record<string, Serializable<any, any>>;
 
 declare const patch: (value: unknown, types?: SerializableTypes) => any;
@@ -10,12 +13,16 @@ declare const unpatch: (value: unknown, types?: SerializableTypes) => any;
 
 declare const parse: (json: string, types?: SerializableTypes) => any;
 type Reviver$1 = (this: any, key: string, value: any) => any;
-declare const createReviver: (types?: SerializableTypes) => Reviver$1;
+declare const createReviver: (types?: SerializableTypes, registerReplacement?: (target: any, key: string, value: unknown) => void) => 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;
 
+declare const setGlobalTypes: (types: SerializableTypes) => void;
+
+declare const $mockdate: Serializable<Date, string>;
+
 type Props$1 = {
     parse: (value: string) => unknown;
 };
@@ -33,4 +40,4 @@ 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 { type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, stringify, unpatch };
+export { $mockdate, type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, setGlobalTypes, stringify, unpatch };

package/dist/index.d.ts

@@ -1,8 +1,11 @@
 type Serializable<I, O> = {
     is: (value: unknown) => boolean;
-    parse: (value: O) => I;
     stringify: (value: I) => O;
-};
+} & ({
+    parse: (value: O) => I;
+} | {
+    replace: (value: O) => I;
+});
 type SerializableTypes = Record<string, Serializable<any, any>>;
 
 declare const patch: (value: unknown, types?: SerializableTypes) => any;
@@ -10,12 +13,16 @@ declare const unpatch: (value: unknown, types?: SerializableTypes) => any;
 
 declare const parse: (json: string, types?: SerializableTypes) => any;
 type Reviver$1 = (this: any, key: string, value: any) => any;
-declare const createReviver: (types?: SerializableTypes) => Reviver$1;
+declare const createReviver: (types?: SerializableTypes, registerReplacement?: (target: any, key: string, value: unknown) => void) => 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;
 
+declare const setGlobalTypes: (types: SerializableTypes) => void;
+
+declare const $mockdate: Serializable<Date, string>;
+
 type Props$1 = {
     parse: (value: string) => unknown;
 };
@@ -33,4 +40,4 @@ 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 { type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, stringify, unpatch };
+export { $mockdate, type Serializable, createReplacer, createReviver, createSafeNumberReplacer, createSafeNumberReviver, parse, patch, safeNumberParse, safeNumberStringify, setGlobalTypes, stringify, unpatch };

package/dist/index.js

@@ -29,10 +29,24 @@ var $infinity = {
   stringify: (v) => v > 0 ? 1 : 0
 };
 
+// src/type/undefined.ts
+var $undefined = {
+  is: (v) => typeof v === "undefined",
+  replace: (_) => void 0,
+  stringify: (_) => 0
+};
+var isUndefined = (value) => {
+  return typeof value === "object" && value !== null && Object.keys(value).length === 1 && "$undefined" in value && value.$undefined === 0;
+};
+
 // src/type/map.ts
 var $map = {
   is: (v) => v instanceof Map,
-  parse: (v) => new Map(v),
+  parse: (v) => new Map(
+    v.map((pair) => {
+      return pair.map((i) => isUndefined(i) ? void 0 : i);
+    })
+  ),
   stringify: (v) => Array.from(v)
 };
 
@@ -53,7 +67,7 @@ var $regexp = {
 // src/type/set.ts
 var $set = {
   is: (v) => v instanceof Set,
-  parse: (v) => new Set(v),
+  parse: (v) => new Set(v.map((i) => isUndefined(i) ? void 0 : i)),
   stringify: (v) => Array.from(v)
 };
 
@@ -64,13 +78,6 @@ var $binary = {
   stringify: (v) => btoa(String.fromCharCode(...v))
 };
 
-// src/type/undefined.ts
-var $undefined = {
-  is: (v) => typeof v === "undefined",
-  parse: (_) => void 0,
-  stringify: (_) => 0
-};
-
 // src/type/url.ts
 var $url = {
   is: (v) => v instanceof URL,
@@ -104,9 +111,19 @@ var baseTypes = {
 
 // src/parse.ts
 var parse = (json, types = {}) => {
-  return JSON.parse(json, createReviver(types));
+  const replacements = [];
+  const result = JSON.parse(
+    json,
+    createReviver(types, (target, key, value) => {
+      replacements.push([target, key, value]);
+    })
+  );
+  for (const [target, key, value] of replacements) {
+    target[key] = value;
+  }
+  return result;
 };
-var createReviver = (types = {}) => {
+var createReviver = (types = {}, registerReplacement) => {
   types = {
     ...baseTypes,
     ...types
@@ -119,7 +136,16 @@ var createReviver = (types = {}) => {
         const typeName = keys[0];
         if (typeName in types && types[typeName]) {
           const type = types[typeName];
-          return type.parse(original[typeName]);
+          const stringified = original[typeName];
+          if ("parse" in type) {
+            return type.parse(stringified);
+          } else if (registerReplacement) {
+            const result = type.replace(stringified);
+            registerReplacement(this, key, result);
+            return result;
+          } else {
+            return type.replace(stringified);
+          }
         }
       }
     }
@@ -157,6 +183,18 @@ var unpatch = (value, types = {}) => {
   return JSON.parse(stringify(value, types));
 };
 
+// src/global.ts
+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(
@@ -188,6 +226,7 @@ var createSafeNumberReplacer = (props) => {
   };
 };
 export {
+  $mockdate,
   createReplacer,
   createReviver,
   createSafeNumberReplacer,
@@ -196,6 +235,7 @@ export {
   patch,
   safeNumberParse,
   safeNumberStringify,
+  setGlobalTypes,
   stringify,
   unpatch
 };

package/package.json

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