@metamask/utils 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.0]
+### Added
+- Add JSON storage validation and limit utilities ([#14](https://github.com/MetaMask/utils/pull/14))
+  - Adds a new function `validateJsonAndGetSize`.
+
 ## [2.0.0]
 ### Added
 - Add more JSON utils ([#8](https://github.com/MetaMask/utils/pull/8))
@@ -18,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/utils/compare/v2.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/utils/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/MetaMask/utils/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/MetaMask/utils/compare/v1.0.0...v2.0.0
 [1.0.0]: https://github.com/MetaMask/utils/releases/tag/v1.0.0

package/dist/json.d.ts

@@ -168,4 +168,14 @@ declare type JsonRpcValidatorOptions = {
  * @returns The JSON-RPC ID validator function.
  */
 export declare function getJsonRpcIdValidator(options?: JsonRpcValidatorOptions): (id: unknown) => id is JsonRpcId;
+/**
+ * Checks whether a value is JSON serializable and counts the total number
+ * of bytes needed to store the serialized version of the value.
+ *
+ * @param jsObject - Potential JSON serializable object.
+ * @param skipSizingProcess - Skip JSON size calculation (default: false).
+ * @returns Tuple [isValid, plainTextSizeInBytes] containing a boolean that signals whether
+ * the value was serializable and a number of bytes that it will use when serialized to JSON.
+ */
+export declare function validateJsonAndGetSize(jsObject: unknown, skipSizingProcess?: boolean): [isValid: boolean, plainTextSizeInBytes: number];
 export {};

package/dist/json.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJsonRpcIdValidator = exports.assertIsJsonRpcFailure = exports.isJsonRpcFailure = exports.assertIsJsonRpcSuccess = exports.isJsonRpcSuccess = exports.assertIsJsonRpcRequest = exports.isJsonRpcRequest = exports.assertIsJsonRpcNotification = exports.isJsonRpcNotification = exports.jsonrpc2 = exports.isValidJson = void 0;
+exports.validateJsonAndGetSize = exports.getJsonRpcIdValidator = exports.assertIsJsonRpcFailure = exports.isJsonRpcFailure = exports.assertIsJsonRpcSuccess = exports.isJsonRpcSuccess = exports.assertIsJsonRpcRequest = exports.isJsonRpcRequest = exports.assertIsJsonRpcNotification = exports.isJsonRpcNotification = exports.jsonrpc2 = exports.isValidJson = void 0;
 const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
 const misc_1 = require("./misc");
 /**
@@ -154,4 +154,139 @@ function getJsonRpcIdValidator(options) {
     return isValidJsonRpcId;
 }
 exports.getJsonRpcIdValidator = getJsonRpcIdValidator;
+/**
+ * Checks whether a value is JSON serializable and counts the total number
+ * of bytes needed to store the serialized version of the value.
+ *
+ * @param jsObject - Potential JSON serializable object.
+ * @param skipSizingProcess - Skip JSON size calculation (default: false).
+ * @returns Tuple [isValid, plainTextSizeInBytes] containing a boolean that signals whether
+ * the value was serializable and a number of bytes that it will use when serialized to JSON.
+ */
+function validateJsonAndGetSize(jsObject, skipSizingProcess = false) {
+    const seenObjects = new Set();
+    /**
+     * Checks whether a value is JSON serializable and counts the total number
+     * of bytes needed to store the serialized version of the value.
+     *
+     * This function assumes the encoding of the JSON is done in UTF-8.
+     *
+     * @param value - Potential JSON serializable value.
+     * @param skipSizing - Skip JSON size calculation (default: false).
+     * @returns Tuple [isValid, plainTextSizeInBytes] containing a boolean that signals whether
+     * the value was serializable and a number of bytes that it will use when serialized to JSON.
+     */
+    function getJsonSerializableInfo(value, skipSizing) {
+        if (value === undefined) {
+            // Return zero for undefined, since these are omitted from JSON serialization
+            return [true, 0];
+        }
+        else if (value === null) {
+            // Return already specified constant size for null (special object)
+            return [true, skipSizing ? 0 : misc_1.JsonSize.Null];
+        }
+        // Check and calculate sizes for basic (and some special) types
+        const typeOfValue = typeof value;
+        try {
+            if (typeOfValue === 'function') {
+                return [false, 0];
+            }
+            else if (typeOfValue === 'string' || value instanceof String) {
+                return [
+                    true,
+                    skipSizing
+                        ? 0
+                        : misc_1.calculateStringSize(value) + misc_1.JsonSize.Quote * 2,
+                ];
+            }
+            else if (typeOfValue === 'boolean' || value instanceof Boolean) {
+                if (skipSizing) {
+                    return [true, 0];
+                }
+                // eslint-disable-next-line eqeqeq
+                return [true, value == true ? misc_1.JsonSize.True : misc_1.JsonSize.False];
+            }
+            else if (typeOfValue === 'number' || value instanceof Number) {
+                if (skipSizing) {
+                    return [true, 0];
+                }
+                return [true, misc_1.calculateNumberSize(value)];
+            }
+            else if (value instanceof Date) {
+                if (skipSizing) {
+                    return [true, 0];
+                }
+                return [
+                    true,
+                    // Note: Invalid dates will serialize to null
+                    isNaN(value.getDate())
+                        ? misc_1.JsonSize.Null
+                        : misc_1.JsonSize.Date + misc_1.JsonSize.Quote * 2,
+                ];
+            }
+        }
+        catch (_) {
+            return [false, 0];
+        }
+        // If object is not plain and cannot be serialized properly,
+        // stop here and return false for serialization
+        if (!misc_1.isPlainObject(value) && !Array.isArray(value)) {
+            return [false, 0];
+        }
+        // Circular object detection (handling)
+        // Check if the same object already exists
+        if (seenObjects.has(value)) {
+            return [false, 0];
+        }
+        // Add new object to the seen objects set
+        // Only the plain objects should be added (Primitive types are skipped)
+        seenObjects.add(value);
+        // Continue object decomposition
+        try {
+            return [
+                true,
+                Object.entries(value).reduce((sum, [key, nestedValue], idx, arr) => {
+                    // Recursively process next nested object or primitive type
+                    // eslint-disable-next-line prefer-const
+                    let [valid, size] = getJsonSerializableInfo(nestedValue, skipSizing);
+                    if (!valid) {
+                        throw new Error('JSON validation did not pass. Validation process stopped.');
+                    }
+                    // Circular object detection
+                    // Once a child node is visited and processed remove it from the set.
+                    // This will prevent false positives with the same adjacent objects.
+                    seenObjects.delete(value);
+                    if (skipSizing) {
+                        return 0;
+                    }
+                    // If the size is 0, the value is undefined and undefined in an array
+                    // when serialized will be replaced with null
+                    if (size === 0 && Array.isArray(value)) {
+                        size = misc_1.JsonSize.Null;
+                    }
+                    // If the size is 0, that means the object is undefined and
+                    // the rest of the object structure will be omitted
+                    if (size === 0) {
+                        return sum;
+                    }
+                    // Objects will have be serialized with "key": value,
+                    // therefore we include the key in the calculation here
+                    const keySize = Array.isArray(value)
+                        ? 0
+                        : key.length + misc_1.JsonSize.Comma + misc_1.JsonSize.Colon * 2;
+                    const separator = idx < arr.length - 1 ? misc_1.JsonSize.Comma : 0;
+                    return sum + keySize + size + separator;
+                }, 
+                // Starts at 2 because the serialized JSON string data (plain text)
+                // will minimally contain {}/[]
+                skipSizing ? 0 : misc_1.JsonSize.Wrapper * 2),
+            ];
+        }
+        catch (_) {
+            return [false, 0];
+        }
+    }
+    return getJsonSerializableInfo(jsObject, skipSizingProcess);
+}
+exports.validateJsonAndGetSize = validateJsonAndGetSize;
 //# sourceMappingURL=json.js.map

package/dist/json.js.map

@@ -1 +1 @@
-{"version":3,"file":"json.js","sourceRoot":"","sources":["../src/json.ts"],"names":[],"mappings":";;;;;;AAAA,sEAAwC;AACxC,iCAAqC;AAarC;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,IAAI;QACF,OAAO,yBAAS,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC5D;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAND,kCAMC;AAED;;GAEG;AACU,QAAA,QAAQ,GAAG,KAAc,CAAC;AAiDvC;;;;;;GAMG;AACH,SAAgB,qBAAqB,CACnC,qBAAiE;IAEjE,OAAO,CAAC,kBAAW,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;AACnD,CAAC;AAJD,sDAIC;AAED;;;;;GAKG;AACH,SAAgB,2BAA2B,CACzC,qBAAiE;IAEjE,IAAI,CAAC,qBAAqB,CAAC,qBAAqB,CAAC,EAAE;QACjD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KACjD;AACH,CAAC;AAND,kEAMC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAC9B,qBAAiE;IAEjE,OAAO,kBAAW,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;AAClD,CAAC;AAJD,4CAIC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CACpC,qBAAiE;IAEjE,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,EAAE;QAC5C,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;AACH,CAAC;AAND,wDAMC;AAgCD;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,QAAiC;IAEjC,OAAO,kBAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACzC,CAAC;AAJD,4CAIC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,QAA4B;IAE5B,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KACxD;AACH,CAAC;AAND,wDAMC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,QAAkC;IAElC,OAAO,kBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC;AAJD,4CAIC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,QAAkC;IAElC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACpD;AACH,CAAC;AAND,wDAMC;AAQD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,qBAAqB,CAAC,OAAiC;IACrE,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,UAAU,EAAE,mBACtD,iBAAiB,EAAE,IAAI,EACvB,eAAe,EAAE,KAAK,EACtB,UAAU,EAAE,IAAI,IACb,OAAO,CACX,CAAC;IAEF;;;;;;OAMG;IACH,MAAM,gBAAgB,GAAG,CAAC,EAAW,EAAmB,EAAE;QACxD,OAAO,OAAO,CACZ,CAAC,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,eAAe,IAAI,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;YACnE,CAAC,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,iBAAiB,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAChE,CAAC,UAAU,IAAI,EAAE,KAAK,IAAI,CAAC,CAC9B,CAAC;IACJ,CAAC,CAAC;IACF,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAvBD,sDAuBC","sourcesContent":["import deepEqual from 'fast-deep-equal';\nimport { hasProperty } from './misc';\n\n/**\n * Any JSON-compatible value.\n */\nexport type Json =\n  | null\n  | boolean\n  | number\n  | string\n  | Json[]\n  | { [prop: string]: Json };\n\n/**\n * Type guard for {@link Json}.\n *\n * @param value - The value to check.\n * @returns Whether the value is valid JSON.\n */\nexport function isValidJson(value: unknown): value is Json {\n  try {\n    return deepEqual(value, JSON.parse(JSON.stringify(value)));\n  } catch (_) {\n    return false;\n  }\n}\n\n/**\n * The string '2.0'.\n */\nexport const jsonrpc2 = '2.0' as const;\n\n/**\n * A String specifying the version of the JSON-RPC protocol.\n * MUST be exactly \"2.0\".\n */\nexport type JsonRpcVersion2 = typeof jsonrpc2;\n\n/**\n * An identifier established by the Client that MUST contain a String, Number,\n * or NULL value if included. If it is not included it is assumed to be a\n * notification. The value SHOULD normally not be Null and Numbers SHOULD\n * NOT contain fractional parts.\n */\nexport type JsonRpcId = number | string | null;\n\n/**\n * A JSON-RPC error object.\n */\nexport type JsonRpcError = {\n  code: number;\n  message: string;\n  data?: unknown;\n  stack?: string;\n};\n\n/**\n * A JSON-RPC request object.\n *\n * @template Params - The type of the params.\n */\nexport type JsonRpcRequest<Params> = {\n  id: JsonRpcId;\n  jsonrpc: JsonRpcVersion2;\n  method: string;\n  params?: Params;\n};\n\n/**\n * A JSON-RPC notification object.\n *\n * @template Params - The type of the params.\n */\nexport type JsonRpcNotification<Params> = {\n  jsonrpc: JsonRpcVersion2;\n  method: string;\n  params?: Params;\n};\n\n/**\n * Type guard to narrow a JSON-RPC request or notification object to a\n * notification.\n *\n * @param requestOrNotification - The JSON-RPC request or notification to check.\n * @returns Whether the specified JSON-RPC message is a notification.\n */\nexport function isJsonRpcNotification<T>(\n  requestOrNotification: JsonRpcNotification<T> | JsonRpcRequest<T>,\n): requestOrNotification is JsonRpcNotification<T> {\n  return !hasProperty(requestOrNotification, 'id');\n}\n\n/**\n * Assertion type guard to narrow a JSON-RPC request or notification object to a\n * notification.\n *\n * @param requestOrNotification - The JSON-RPC request or notification to check.\n */\nexport function assertIsJsonRpcNotification<T>(\n  requestOrNotification: JsonRpcNotification<T> | JsonRpcRequest<T>,\n): asserts requestOrNotification is JsonRpcNotification<T> {\n  if (!isJsonRpcNotification(requestOrNotification)) {\n    throw new Error('Not a JSON-RPC notification.');\n  }\n}\n\n/**\n * Type guard to narrow a JSON-RPC request or notification object to a request.\n *\n * @param requestOrNotification - The JSON-RPC request or notification to check.\n * @returns Whether the specified JSON-RPC message is a request.\n */\nexport function isJsonRpcRequest<T>(\n  requestOrNotification: JsonRpcNotification<T> | JsonRpcRequest<T>,\n): requestOrNotification is JsonRpcRequest<T> {\n  return hasProperty(requestOrNotification, 'id');\n}\n\n/**\n * Assertion type guard to narrow a JSON-RPC request or notification object to a\n * request.\n *\n * @param requestOrNotification - The JSON-RPC request or notification to check.\n */\nexport function assertIsJsonRpcRequest<T>(\n  requestOrNotification: JsonRpcNotification<T> | JsonRpcRequest<T>,\n): asserts requestOrNotification is JsonRpcRequest<T> {\n  if (!isJsonRpcRequest(requestOrNotification)) {\n    throw new Error('Not a JSON-RPC request.');\n  }\n}\n\n/**\n * A successful JSON-RPC response object.\n *\n * @template Result - The type of the result.\n */\nexport type JsonRpcSuccess<Result = unknown> = {\n  id: JsonRpcId;\n  jsonrpc: JsonRpcVersion2;\n  result: Result;\n};\n\n/**\n * A failed JSON-RPC response object.\n */\nexport type JsonRpcFailure = {\n  id: JsonRpcId;\n  jsonrpc: JsonRpcVersion2;\n  error: JsonRpcError;\n};\n\n/**\n * A JSON-RPC response object. Must be checked to determine whether it's a\n * success or failure.\n *\n * @template Result - The type of the result.\n */\nexport type JsonRpcResponse<Result = unknown> =\n  | JsonRpcSuccess<Result>\n  | JsonRpcFailure;\n\n/**\n * Type guard to narrow a JsonRpcResponse object to a success (or failure).\n *\n * @param response - The response object to check.\n * @returns Whether the response object is a success, i.e. has a `result`\n * property.\n */\nexport function isJsonRpcSuccess<Result>(\n  response: JsonRpcResponse<Result>,\n): response is JsonRpcSuccess<Result> {\n  return hasProperty(response, 'result');\n}\n\n/**\n * Type assertion to narrow a JsonRpcResponse object to a success (or failure).\n *\n * @param response - The response object to check.\n */\nexport function assertIsJsonRpcSuccess<T>(\n  response: JsonRpcResponse<T>,\n): asserts response is JsonRpcSuccess<T> {\n  if (!isJsonRpcSuccess(response)) {\n    throw new Error('Not a successful JSON-RPC response.');\n  }\n}\n\n/**\n * Type guard to narrow a JsonRpcResponse object to a failure (or success).\n *\n * @param response - The response object to check.\n * @returns Whether the response object is a failure, i.e. has an `error`\n * property.\n */\nexport function isJsonRpcFailure(\n  response: JsonRpcResponse<unknown>,\n): response is JsonRpcFailure {\n  return hasProperty(response, 'error');\n}\n\n/**\n * Type assertion to narrow a JsonRpcResponse object to a failure (or success).\n *\n * @param response - The response object to check.\n */\nexport function assertIsJsonRpcFailure(\n  response: JsonRpcResponse<unknown>,\n): asserts response is JsonRpcFailure {\n  if (!isJsonRpcFailure(response)) {\n    throw new Error('Not a failed JSON-RPC response.');\n  }\n}\n\ntype JsonRpcValidatorOptions = {\n  permitEmptyString?: boolean;\n  permitFractions?: boolean;\n  permitNull?: boolean;\n};\n\n/**\n * Gets a function for validating JSON-RPC request / response `id` values.\n *\n * By manipulating the options of this factory, you can control the behavior\n * of the resulting validator for some edge cases. This is useful because e.g.\n * `null` should sometimes but not always be permitted.\n *\n * Note that the empty string (`''`) is always permitted by the JSON-RPC\n * specification, but that kind of sucks and you may want to forbid it in some\n * instances anyway.\n *\n * For more details, see the\n * [JSON-RPC Specification](https://www.jsonrpc.org/specification).\n *\n * @param options - An options object.\n * @param options.permitEmptyString - Whether the empty string (i.e. `''`)\n * should be treated as a valid ID. Default: `true`\n * @param options.permitFractions - Whether fractional numbers (e.g. `1.2`)\n * should be treated as valid IDs. Default: `false`\n * @param options.permitNull - Whether `null` should be treated as a valid ID.\n * Default: `true`\n * @returns The JSON-RPC ID validator function.\n */\nexport function getJsonRpcIdValidator(options?: JsonRpcValidatorOptions) {\n  const { permitEmptyString, permitFractions, permitNull } = {\n    permitEmptyString: true,\n    permitFractions: false,\n    permitNull: true,\n    ...options,\n  };\n\n  /**\n   * Type guard for {@link JsonRpcId}.\n   *\n   * @param id - The JSON-RPC ID value to check.\n   * @returns Whether the given ID is valid per the options given to the\n   * factory.\n   */\n  const isValidJsonRpcId = (id: unknown): id is JsonRpcId => {\n    return Boolean(\n      (typeof id === 'number' && (permitFractions || Number.isInteger(id))) ||\n        (typeof id === 'string' && (permitEmptyString || id.length > 0)) ||\n        (permitNull && id === null),\n    );\n  };\n  return isValidJsonRpcId;\n}\n"]}
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../src/json.ts"],"names":[],"mappings":";;;;;;AAAA,sEAAwC;AACxC,iCAMgB;AAahB;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,IAAI;QACF,OAAO,yBAAS,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC5D;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAND,kCAMC;AAED;;GAEG;AACU,QAAA,QAAQ,GAAG,KAAc,CAAC;AAiDvC;;;;;;GAMG;AACH,SAAgB,qBAAqB,CACnC,qBAAiE;IAEjE,OAAO,CAAC,kBAAW,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;AACnD,CAAC;AAJD,sDAIC;AAED;;;;;GAKG;AACH,SAAgB,2BAA2B,CACzC,qBAAiE;IAEjE,IAAI,CAAC,qBAAqB,CAAC,qBAAqB,CAAC,EAAE;QACjD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;KACjD;AACH,CAAC;AAND,kEAMC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAC9B,qBAAiE;IAEjE,OAAO,kBAAW,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;AAClD,CAAC;AAJD,4CAIC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CACpC,qBAAiE;IAEjE,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,EAAE;QAC5C,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;AACH,CAAC;AAND,wDAMC;AAgCD;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,QAAiC;IAEjC,OAAO,kBAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACzC,CAAC;AAJD,4CAIC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,QAA4B;IAE5B,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;KACxD;AACH,CAAC;AAND,wDAMC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,QAAkC;IAElC,OAAO,kBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC;AAJD,4CAIC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,QAAkC;IAElC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACpD;AACH,CAAC;AAND,wDAMC;AAQD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,qBAAqB,CAAC,OAAiC;IACrE,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,UAAU,EAAE,mBACtD,iBAAiB,EAAE,IAAI,EACvB,eAAe,EAAE,KAAK,EACtB,UAAU,EAAE,IAAI,IACb,OAAO,CACX,CAAC;IAEF;;;;;;OAMG;IACH,MAAM,gBAAgB,GAAG,CAAC,EAAW,EAAmB,EAAE;QACxD,OAAO,OAAO,CACZ,CAAC,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,eAAe,IAAI,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;YACnE,CAAC,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,iBAAiB,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAChE,CAAC,UAAU,IAAI,EAAE,KAAK,IAAI,CAAC,CAC9B,CAAC;IACJ,CAAC,CAAC;IACF,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAvBD,sDAuBC;AAED;;;;;;;;GAQG;AACH,SAAgB,sBAAsB,CACpC,QAAiB,EACjB,iBAAiB,GAAG,KAAK;IAEzB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;IAC9B;;;;;;;;;;OAUG;IACH,SAAS,uBAAuB,CAC9B,KAAc,EACd,UAAmB;QAEnB,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,6EAA6E;YAC7E,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;SAClB;aAAM,IAAI,KAAK,KAAK,IAAI,EAAE;YACzB,mEAAmE;YACnE,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAQ,CAAC,IAAI,CAAC,CAAC;SAC/C;QAED,+DAA+D;QAC/D,MAAM,WAAW,GAAG,OAAO,KAAK,CAAC;QACjC,IAAI;YACF,IAAI,WAAW,KAAK,UAAU,EAAE;gBAC9B,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;aACnB;iBAAM,IAAI,WAAW,KAAK,QAAQ,IAAI,KAAK,YAAY,MAAM,EAAE;gBAC9D,OAAO;oBACL,IAAI;oBACJ,UAAU;wBACR,CAAC,CAAC,CAAC;wBACH,CAAC,CAAC,0BAAmB,CAAC,KAAe,CAAC,GAAG,eAAQ,CAAC,KAAK,GAAG,CAAC;iBAC9D,CAAC;aACH;iBAAM,IAAI,WAAW,KAAK,SAAS,IAAI,KAAK,YAAY,OAAO,EAAE;gBAChE,IAAI,UAAU,EAAE;oBACd,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;iBAClB;gBACD,kCAAkC;gBAClC,OAAO,CAAC,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,eAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,eAAQ,CAAC,KAAK,CAAC,CAAC;aAC/D;iBAAM,IAAI,WAAW,KAAK,QAAQ,IAAI,KAAK,YAAY,MAAM,EAAE;gBAC9D,IAAI,UAAU,EAAE;oBACd,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;iBAClB;gBACD,OAAO,CAAC,IAAI,EAAE,0BAAmB,CAAC,KAAe,CAAC,CAAC,CAAC;aACrD;iBAAM,IAAI,KAAK,YAAY,IAAI,EAAE;gBAChC,IAAI,UAAU,EAAE;oBACd,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;iBAClB;gBACD,OAAO;oBACL,IAAI;oBACJ,6CAA6C;oBAC7C,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;wBACpB,CAAC,CAAC,eAAQ,CAAC,IAAI;wBACf,CAAC,CAAC,eAAQ,CAAC,IAAI,GAAG,eAAQ,CAAC,KAAK,GAAG,CAAC;iBACvC,CAAC;aACH;SACF;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACnB;QAED,4DAA4D;QAC5D,+CAA+C;QAC/C,IAAI,CAAC,oBAAa,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAClD,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACnB;QAED,uCAAuC;QACvC,0CAA0C;QAC1C,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YAC1B,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACnB;QACD,yCAAyC;QACzC,uEAAuE;QACvE,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAEvB,gCAAgC;QAChC,IAAI;YACF,OAAO;gBACL,IAAI;gBACJ,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAC1B,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;oBACpC,2DAA2D;oBAC3D,wCAAwC;oBACxC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,uBAAuB,CACzC,WAAW,EACX,UAAU,CACX,CAAC;oBACF,IAAI,CAAC,KAAK,EAAE;wBACV,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAC;qBACH;oBAED,4BAA4B;oBAC5B,qEAAqE;oBACrE,oEAAoE;oBACpE,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBAE1B,IAAI,UAAU,EAAE;wBACd,OAAO,CAAC,CAAC;qBACV;oBAED,qEAAqE;oBACrE,6CAA6C;oBAC7C,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;wBACtC,IAAI,GAAG,eAAQ,CAAC,IAAI,CAAC;qBACtB;oBAED,2DAA2D;oBAC3D,mDAAmD;oBACnD,IAAI,IAAI,KAAK,CAAC,EAAE;wBACd,OAAO,GAAG,CAAC;qBACZ;oBAED,qDAAqD;oBACrD,uDAAuD;oBACvD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;wBAClC,CAAC,CAAC,CAAC;wBACH,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,eAAQ,CAAC,KAAK,GAAG,eAAQ,CAAC,KAAK,GAAG,CAAC,CAAC;oBAErD,MAAM,SAAS,GAAG,GAAG,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAE5D,OAAO,GAAG,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;gBAC1C,CAAC;gBACD,mEAAmE;gBACnE,+BAA+B;gBAC/B,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAQ,CAAC,OAAO,GAAG,CAAC,CACtC;aACF,CAAC;SACH;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACnB;IACH,CAAC;IAED,OAAO,uBAAuB,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;AAC9D,CAAC;AA9ID,wDA8IC","sourcesContent":["import deepEqual from 'fast-deep-equal';\nimport {\n  calculateNumberSize,\n  calculateStringSize,\n  hasProperty,\n  isPlainObject,\n  JsonSize,\n} from './misc';\n\n/**\n * Any JSON-compatible value.\n */\nexport type Json =\n  | null\n  | boolean\n  | number\n  | string\n  | Json[]\n  | { [prop: string]: Json };\n\n/**\n * Type guard for {@link Json}.\n *\n * @param value - The value to check.\n * @returns Whether the value is valid JSON.\n */\nexport function isValidJson(value: unknown): value is Json {\n  try {\n    return deepEqual(value, JSON.parse(JSON.stringify(value)));\n  } catch (_) {\n    return false;\n  }\n}\n\n/**\n * The string '2.0'.\n */\nexport const jsonrpc2 = '2.0' as const;\n\n/**\n * A String specifying the version of the JSON-RPC protocol.\n * MUST be exactly \"2.0\".\n */\nexport type JsonRpcVersion2 = typeof jsonrpc2;\n\n/**\n * An identifier established by the Client that MUST contain a String, Number,\n * or NULL value if included. If it is not included it is assumed to be a\n * notification. The value SHOULD normally not be Null and Numbers SHOULD\n * NOT contain fractional parts.\n */\nexport type JsonRpcId = number | string | null;\n\n/**\n * A JSON-RPC error object.\n */\nexport type JsonRpcError = {\n  code: number;\n  message: string;\n  data?: unknown;\n  stack?: string;\n};\n\n/**\n * A JSON-RPC request object.\n *\n * @template Params - The type of the params.\n */\nexport type JsonRpcRequest<Params> = {\n  id: JsonRpcId;\n  jsonrpc: JsonRpcVersion2;\n  method: string;\n  params?: Params;\n};\n\n/**\n * A JSON-RPC notification object.\n *\n * @template Params - The type of the params.\n */\nexport type JsonRpcNotification<Params> = {\n  jsonrpc: JsonRpcVersion2;\n  method: string;\n  params?: Params;\n};\n\n/**\n * Type guard to narrow a JSON-RPC request or notification object to a\n * notification.\n *\n * @param requestOrNotification - The JSON-RPC request or notification to check.\n * @returns Whether the specified JSON-RPC message is a notification.\n */\nexport function isJsonRpcNotification<T>(\n  requestOrNotification: JsonRpcNotification<T> | JsonRpcRequest<T>,\n): requestOrNotification is JsonRpcNotification<T> {\n  return !hasProperty(requestOrNotification, 'id');\n}\n\n/**\n * Assertion type guard to narrow a JSON-RPC request or notification object to a\n * notification.\n *\n * @param requestOrNotification - The JSON-RPC request or notification to check.\n */\nexport function assertIsJsonRpcNotification<T>(\n  requestOrNotification: JsonRpcNotification<T> | JsonRpcRequest<T>,\n): asserts requestOrNotification is JsonRpcNotification<T> {\n  if (!isJsonRpcNotification(requestOrNotification)) {\n    throw new Error('Not a JSON-RPC notification.');\n  }\n}\n\n/**\n * Type guard to narrow a JSON-RPC request or notification object to a request.\n *\n * @param requestOrNotification - The JSON-RPC request or notification to check.\n * @returns Whether the specified JSON-RPC message is a request.\n */\nexport function isJsonRpcRequest<T>(\n  requestOrNotification: JsonRpcNotification<T> | JsonRpcRequest<T>,\n): requestOrNotification is JsonRpcRequest<T> {\n  return hasProperty(requestOrNotification, 'id');\n}\n\n/**\n * Assertion type guard to narrow a JSON-RPC request or notification object to a\n * request.\n *\n * @param requestOrNotification - The JSON-RPC request or notification to check.\n */\nexport function assertIsJsonRpcRequest<T>(\n  requestOrNotification: JsonRpcNotification<T> | JsonRpcRequest<T>,\n): asserts requestOrNotification is JsonRpcRequest<T> {\n  if (!isJsonRpcRequest(requestOrNotification)) {\n    throw new Error('Not a JSON-RPC request.');\n  }\n}\n\n/**\n * A successful JSON-RPC response object.\n *\n * @template Result - The type of the result.\n */\nexport type JsonRpcSuccess<Result = unknown> = {\n  id: JsonRpcId;\n  jsonrpc: JsonRpcVersion2;\n  result: Result;\n};\n\n/**\n * A failed JSON-RPC response object.\n */\nexport type JsonRpcFailure = {\n  id: JsonRpcId;\n  jsonrpc: JsonRpcVersion2;\n  error: JsonRpcError;\n};\n\n/**\n * A JSON-RPC response object. Must be checked to determine whether it's a\n * success or failure.\n *\n * @template Result - The type of the result.\n */\nexport type JsonRpcResponse<Result = unknown> =\n  | JsonRpcSuccess<Result>\n  | JsonRpcFailure;\n\n/**\n * Type guard to narrow a JsonRpcResponse object to a success (or failure).\n *\n * @param response - The response object to check.\n * @returns Whether the response object is a success, i.e. has a `result`\n * property.\n */\nexport function isJsonRpcSuccess<Result>(\n  response: JsonRpcResponse<Result>,\n): response is JsonRpcSuccess<Result> {\n  return hasProperty(response, 'result');\n}\n\n/**\n * Type assertion to narrow a JsonRpcResponse object to a success (or failure).\n *\n * @param response - The response object to check.\n */\nexport function assertIsJsonRpcSuccess<T>(\n  response: JsonRpcResponse<T>,\n): asserts response is JsonRpcSuccess<T> {\n  if (!isJsonRpcSuccess(response)) {\n    throw new Error('Not a successful JSON-RPC response.');\n  }\n}\n\n/**\n * Type guard to narrow a JsonRpcResponse object to a failure (or success).\n *\n * @param response - The response object to check.\n * @returns Whether the response object is a failure, i.e. has an `error`\n * property.\n */\nexport function isJsonRpcFailure(\n  response: JsonRpcResponse<unknown>,\n): response is JsonRpcFailure {\n  return hasProperty(response, 'error');\n}\n\n/**\n * Type assertion to narrow a JsonRpcResponse object to a failure (or success).\n *\n * @param response - The response object to check.\n */\nexport function assertIsJsonRpcFailure(\n  response: JsonRpcResponse<unknown>,\n): asserts response is JsonRpcFailure {\n  if (!isJsonRpcFailure(response)) {\n    throw new Error('Not a failed JSON-RPC response.');\n  }\n}\n\ntype JsonRpcValidatorOptions = {\n  permitEmptyString?: boolean;\n  permitFractions?: boolean;\n  permitNull?: boolean;\n};\n\n/**\n * Gets a function for validating JSON-RPC request / response `id` values.\n *\n * By manipulating the options of this factory, you can control the behavior\n * of the resulting validator for some edge cases. This is useful because e.g.\n * `null` should sometimes but not always be permitted.\n *\n * Note that the empty string (`''`) is always permitted by the JSON-RPC\n * specification, but that kind of sucks and you may want to forbid it in some\n * instances anyway.\n *\n * For more details, see the\n * [JSON-RPC Specification](https://www.jsonrpc.org/specification).\n *\n * @param options - An options object.\n * @param options.permitEmptyString - Whether the empty string (i.e. `''`)\n * should be treated as a valid ID. Default: `true`\n * @param options.permitFractions - Whether fractional numbers (e.g. `1.2`)\n * should be treated as valid IDs. Default: `false`\n * @param options.permitNull - Whether `null` should be treated as a valid ID.\n * Default: `true`\n * @returns The JSON-RPC ID validator function.\n */\nexport function getJsonRpcIdValidator(options?: JsonRpcValidatorOptions) {\n  const { permitEmptyString, permitFractions, permitNull } = {\n    permitEmptyString: true,\n    permitFractions: false,\n    permitNull: true,\n    ...options,\n  };\n\n  /**\n   * Type guard for {@link JsonRpcId}.\n   *\n   * @param id - The JSON-RPC ID value to check.\n   * @returns Whether the given ID is valid per the options given to the\n   * factory.\n   */\n  const isValidJsonRpcId = (id: unknown): id is JsonRpcId => {\n    return Boolean(\n      (typeof id === 'number' && (permitFractions || Number.isInteger(id))) ||\n        (typeof id === 'string' && (permitEmptyString || id.length > 0)) ||\n        (permitNull && id === null),\n    );\n  };\n  return isValidJsonRpcId;\n}\n\n/**\n * Checks whether a value is JSON serializable and counts the total number\n * of bytes needed to store the serialized version of the value.\n *\n * @param jsObject - Potential JSON serializable object.\n * @param skipSizingProcess - Skip JSON size calculation (default: false).\n * @returns Tuple [isValid, plainTextSizeInBytes] containing a boolean that signals whether\n * the value was serializable and a number of bytes that it will use when serialized to JSON.\n */\nexport function validateJsonAndGetSize(\n  jsObject: unknown,\n  skipSizingProcess = false,\n): [isValid: boolean, plainTextSizeInBytes: number] {\n  const seenObjects = new Set();\n  /**\n   * Checks whether a value is JSON serializable and counts the total number\n   * of bytes needed to store the serialized version of the value.\n   *\n   * This function assumes the encoding of the JSON is done in UTF-8.\n   *\n   * @param value - Potential JSON serializable value.\n   * @param skipSizing - Skip JSON size calculation (default: false).\n   * @returns Tuple [isValid, plainTextSizeInBytes] containing a boolean that signals whether\n   * the value was serializable and a number of bytes that it will use when serialized to JSON.\n   */\n  function getJsonSerializableInfo(\n    value: unknown,\n    skipSizing: boolean,\n  ): [isValid: boolean, plainTextSizeInBytes: number] {\n    if (value === undefined) {\n      // Return zero for undefined, since these are omitted from JSON serialization\n      return [true, 0];\n    } else if (value === null) {\n      // Return already specified constant size for null (special object)\n      return [true, skipSizing ? 0 : JsonSize.Null];\n    }\n\n    // Check and calculate sizes for basic (and some special) types\n    const typeOfValue = typeof value;\n    try {\n      if (typeOfValue === 'function') {\n        return [false, 0];\n      } else if (typeOfValue === 'string' || value instanceof String) {\n        return [\n          true,\n          skipSizing\n            ? 0\n            : calculateStringSize(value as string) + JsonSize.Quote * 2,\n        ];\n      } else if (typeOfValue === 'boolean' || value instanceof Boolean) {\n        if (skipSizing) {\n          return [true, 0];\n        }\n        // eslint-disable-next-line eqeqeq\n        return [true, value == true ? JsonSize.True : JsonSize.False];\n      } else if (typeOfValue === 'number' || value instanceof Number) {\n        if (skipSizing) {\n          return [true, 0];\n        }\n        return [true, calculateNumberSize(value as number)];\n      } else if (value instanceof Date) {\n        if (skipSizing) {\n          return [true, 0];\n        }\n        return [\n          true,\n          // Note: Invalid dates will serialize to null\n          isNaN(value.getDate())\n            ? JsonSize.Null\n            : JsonSize.Date + JsonSize.Quote * 2,\n        ];\n      }\n    } catch (_) {\n      return [false, 0];\n    }\n\n    // If object is not plain and cannot be serialized properly,\n    // stop here and return false for serialization\n    if (!isPlainObject(value) && !Array.isArray(value)) {\n      return [false, 0];\n    }\n\n    // Circular object detection (handling)\n    // Check if the same object already exists\n    if (seenObjects.has(value)) {\n      return [false, 0];\n    }\n    // Add new object to the seen objects set\n    // Only the plain objects should be added (Primitive types are skipped)\n    seenObjects.add(value);\n\n    // Continue object decomposition\n    try {\n      return [\n        true,\n        Object.entries(value).reduce(\n          (sum, [key, nestedValue], idx, arr) => {\n            // Recursively process next nested object or primitive type\n            // eslint-disable-next-line prefer-const\n            let [valid, size] = getJsonSerializableInfo(\n              nestedValue,\n              skipSizing,\n            );\n            if (!valid) {\n              throw new Error(\n                'JSON validation did not pass. Validation process stopped.',\n              );\n            }\n\n            // Circular object detection\n            // Once a child node is visited and processed remove it from the set.\n            // This will prevent false positives with the same adjacent objects.\n            seenObjects.delete(value);\n\n            if (skipSizing) {\n              return 0;\n            }\n\n            // If the size is 0, the value is undefined and undefined in an array\n            // when serialized will be replaced with null\n            if (size === 0 && Array.isArray(value)) {\n              size = JsonSize.Null;\n            }\n\n            // If the size is 0, that means the object is undefined and\n            // the rest of the object structure will be omitted\n            if (size === 0) {\n              return sum;\n            }\n\n            // Objects will have be serialized with \"key\": value,\n            // therefore we include the key in the calculation here\n            const keySize = Array.isArray(value)\n              ? 0\n              : key.length + JsonSize.Comma + JsonSize.Colon * 2;\n\n            const separator = idx < arr.length - 1 ? JsonSize.Comma : 0;\n\n            return sum + keySize + size + separator;\n          },\n          // Starts at 2 because the serialized JSON string data (plain text)\n          // will minimally contain {}/[]\n          skipSizing ? 0 : JsonSize.Wrapper * 2,\n        ),\n      ];\n    } catch (_) {\n      return [false, 0];\n    }\n  }\n\n  return getJsonSerializableInfo(jsObject, skipSizingProcess);\n}\n"]}

package/dist/misc.d.ts

@@ -58,3 +58,50 @@ export declare function isObject(value: unknown): value is RuntimeObject;
  * name, regardless of whether it is enumerable or not.
  */
 export declare const hasProperty: (object: RuntimeObject, name: string | number | symbol) => boolean;
+export declare type PlainObject = Record<number | string | symbol, unknown>;
+/**
+ * Predefined sizes (in Bytes) of specific parts of JSON structure.
+ */
+export declare enum JsonSize {
+    Null = 4,
+    Comma = 1,
+    Wrapper = 1,
+    True = 4,
+    False = 5,
+    Quote = 1,
+    Colon = 1,
+    Date = 24
+}
+/**
+ * Regular expression with pattern matching for (special) escaped characters.
+ */
+export declare const ESCAPE_CHARACTERS_REGEXP: RegExp;
+/**
+ * Check if the value is plain object.
+ *
+ * @param value - Value to be checked.
+ * @returns True if an object is the plain JavaScript object,
+ * false if the object is not plain (e.g. function).
+ */
+export declare function isPlainObject(value: unknown): value is PlainObject;
+/**
+ * Check if character is ASCII.
+ *
+ * @param character - Character.
+ * @returns True if a character code is ASCII, false if not.
+ */
+export declare function isASCII(character: string): boolean;
+/**
+ * Calculate string size.
+ *
+ * @param value - String value to calculate size.
+ * @returns Number of bytes used to store whole string value.
+ */
+export declare function calculateStringSize(value: string): number;
+/**
+ * Calculate size of a number ofter JSON serialization.
+ *
+ * @param value - Number value to calculate size.
+ * @returns Number of bytes used to store whole number in JSON.
+ */
+export declare function calculateNumberSize(value: number): number;

package/dist/misc.js

@@ -3,7 +3,7 @@
 // Types
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasProperty = exports.isObject = exports.isNullOrUndefined = exports.isNonEmptyArray = void 0;
+exports.calculateNumberSize = exports.calculateStringSize = exports.isASCII = exports.isPlainObject = exports.ESCAPE_CHARACTERS_REGEXP = exports.JsonSize = exports.hasProperty = exports.isObject = exports.isNullOrUndefined = exports.isNonEmptyArray = void 0;
 //
 // Type Guards
 //
@@ -52,4 +52,83 @@ exports.isObject = isObject;
  */
 const hasProperty = (object, name) => Object.hasOwnProperty.call(object, name);
 exports.hasProperty = hasProperty;
+/**
+ * Predefined sizes (in Bytes) of specific parts of JSON structure.
+ */
+var JsonSize;
+(function (JsonSize) {
+    JsonSize[JsonSize["Null"] = 4] = "Null";
+    JsonSize[JsonSize["Comma"] = 1] = "Comma";
+    JsonSize[JsonSize["Wrapper"] = 1] = "Wrapper";
+    JsonSize[JsonSize["True"] = 4] = "True";
+    JsonSize[JsonSize["False"] = 5] = "False";
+    JsonSize[JsonSize["Quote"] = 1] = "Quote";
+    JsonSize[JsonSize["Colon"] = 1] = "Colon";
+    JsonSize[JsonSize["Date"] = 24] = "Date";
+})(JsonSize = exports.JsonSize || (exports.JsonSize = {}));
+/**
+ * Regular expression with pattern matching for (special) escaped characters.
+ */
+exports.ESCAPE_CHARACTERS_REGEXP = /"|\\|\n|\r|\t/gu;
+/**
+ * Check if the value is plain object.
+ *
+ * @param value - Value to be checked.
+ * @returns True if an object is the plain JavaScript object,
+ * false if the object is not plain (e.g. function).
+ */
+function isPlainObject(value) {
+    if (typeof value !== 'object' || value === null) {
+        return false;
+    }
+    try {
+        let proto = value;
+        while (Object.getPrototypeOf(proto) !== null) {
+            proto = Object.getPrototypeOf(proto);
+        }
+        return Object.getPrototypeOf(value) === proto;
+    }
+    catch (_) {
+        return false;
+    }
+}
+exports.isPlainObject = isPlainObject;
+/**
+ * Check if character is ASCII.
+ *
+ * @param character - Character.
+ * @returns True if a character code is ASCII, false if not.
+ */
+function isASCII(character) {
+    return character.charCodeAt(0) <= 127;
+}
+exports.isASCII = isASCII;
+/**
+ * Calculate string size.
+ *
+ * @param value - String value to calculate size.
+ * @returns Number of bytes used to store whole string value.
+ */
+function calculateStringSize(value) {
+    var _a;
+    const size = value.split('').reduce((total, character) => {
+        if (isASCII(character)) {
+            return total + 1;
+        }
+        return total + 2;
+    }, 0);
+    // Also detect characters that need backslash escape
+    return size + ((_a = value.match(exports.ESCAPE_CHARACTERS_REGEXP)) !== null && _a !== void 0 ? _a : []).length;
+}
+exports.calculateStringSize = calculateStringSize;
+/**
+ * Calculate size of a number ofter JSON serialization.
+ *
+ * @param value - Number value to calculate size.
+ * @returns Number of bytes used to store whole number in JSON.
+ */
+function calculateNumberSize(value) {
+    return value.toString().length;
+}
+exports.calculateNumberSize = calculateNumberSize;
 //# sourceMappingURL=misc.js.map

package/dist/misc.js.map

@@ -1 +1 @@
-{"version":3,"file":"misc.js","sourceRoot":"","sources":["../src/misc.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,QAAQ;AACR,EAAE;;;AAsCF,EAAE;AACF,cAAc;AACd,EAAE;AAEF;;;;;;GAMG;AACH,SAAgB,eAAe,CAC7B,KAAgB;IAEhB,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAClD,CAAC;AAJD,0CAIC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,KAAc;IAC9C,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAC/C,CAAC;AAFD,8CAEC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAFD,4BAEC;AAED,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;;;;;;GAOG;AACI,MAAM,WAAW,GAAG,CACzB,MAAqB,EACrB,IAA8B,EACrB,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAH1C,QAAA,WAAW,eAG+B","sourcesContent":["//\n// Types\n//\n\n/**\n * Makes every specified property of the specified object type mutable.\n *\n * @template ObjectValue - The object whose readonly properties to make mutable.\n * @template TargetKey - The property key(s) to make mutable.\n */\nexport type Mutable<\n  ObjectValue extends Record<string, unknown>,\n  TargetKey extends keyof ObjectValue\n> = {\n  -readonly [Key in keyof Pick<ObjectValue, TargetKey>]: ObjectValue[Key];\n} &\n  {\n    [Key in keyof Omit<ObjectValue, TargetKey>]: ObjectValue[Key];\n  };\n\n/**\n * Useful for representing some value that _might_ be present and / or complete.\n *\n * @template Value - The value that might be present or complete.\n */\nexport type PartialOrAbsent<Value> = Partial<Value> | null | undefined;\n\n/**\n * Like {@link Array}, but always non-empty.\n *\n * @template Element - The non-empty array member type.\n */\nexport type NonEmptyArray<Element> = [Element, ...Element[]];\n\n/**\n * A JavaScript object that is not `null`, a function, or an array. The object\n * can still be an instance of a class.\n */\nexport type RuntimeObject = Record<number | string | symbol, unknown>;\n\n//\n// Type Guards\n//\n\n/**\n * A {@link NonEmptyArray} type guard.\n *\n * @template Element - The non-empty array member type.\n * @param value - The value to check.\n * @returns Whether the value is a non-empty array.\n */\nexport function isNonEmptyArray<Element>(\n  value: Element[],\n): value is NonEmptyArray<Element> {\n  return Array.isArray(value) && value.length > 0;\n}\n\n/**\n * Type guard for \"nullishness\".\n *\n * @param value - Any value.\n * @returns `true` if the value is null or undefined, `false` otherwise.\n */\nexport function isNullOrUndefined(value: unknown): value is null | undefined {\n  return value === null || value === undefined;\n}\n\n/**\n * A type guard for {@link RuntimeObject}.\n *\n * @param value - The value to check.\n * @returns Whether the specified value has a runtime type of `object` and is\n * neither `null` nor an `Array`.\n */\nexport function isObject(value: unknown): value is RuntimeObject {\n  return Boolean(value) && typeof value === 'object' && !Array.isArray(value);\n}\n\n//\n// Other utility functions\n//\n\n/**\n * An alias for {@link Object.hasOwnProperty}.\n *\n * @param object - The object to check.\n * @param name - The property name to check for.\n * @returns Whether the specified object has an own property with the specified\n * name, regardless of whether it is enumerable or not.\n */\nexport const hasProperty = (\n  object: RuntimeObject,\n  name: string | number | symbol,\n): boolean => Object.hasOwnProperty.call(object, name);\n"]}
+{"version":3,"file":"misc.js","sourceRoot":"","sources":["../src/misc.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,QAAQ;AACR,EAAE;;;AAsCF,EAAE;AACF,cAAc;AACd,EAAE;AAEF;;;;;;GAMG;AACH,SAAgB,eAAe,CAC7B,KAAgB;IAEhB,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAClD,CAAC;AAJD,0CAIC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,KAAc;IAC9C,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAC/C,CAAC;AAFD,8CAEC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAFD,4BAEC;AAED,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;;;;;;GAOG;AACI,MAAM,WAAW,GAAG,CACzB,MAAqB,EACrB,IAA8B,EACrB,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAH1C,QAAA,WAAW,eAG+B;AAIvD;;GAEG;AACH,IAAY,QASX;AATD,WAAY,QAAQ;IAClB,uCAAQ,CAAA;IACR,yCAAS,CAAA;IACT,6CAAW,CAAA;IACX,uCAAQ,CAAA;IACR,yCAAS,CAAA;IACT,yCAAS,CAAA;IACT,yCAAS,CAAA;IACT,wCAAS,CAAA;AACX,CAAC,EATW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QASnB;AAED;;GAEG;AACU,QAAA,wBAAwB,GAAG,iBAAiB,CAAC;AAE1D;;;;;;GAMG;AACH,SAAgB,aAAa,CAAC,KAAc;IAC1C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;QAC/C,OAAO,KAAK,CAAC;KACd;IAED,IAAI;QACF,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,OAAO,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;YAC5C,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SACtC;QAED,OAAO,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC;KAC/C;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAfD,sCAeC;AAED;;;;;GAKG;AACH,SAAgB,OAAO,CAAC,SAAiB;IACvC,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC;AACxC,CAAC;AAFD,0BAEC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,KAAa;;IAC/C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACvD,IAAI,OAAO,CAAC,SAAS,CAAC,EAAE;YACtB,OAAO,KAAK,GAAG,CAAC,CAAC;SAClB;QACD,OAAO,KAAK,GAAG,CAAC,CAAC;IACnB,CAAC,EAAE,CAAC,CAAC,CAAC;IAEN,oDAAoD;IACpD,OAAO,IAAI,GAAG,CAAC,MAAA,KAAK,CAAC,KAAK,CAAC,gCAAwB,CAAC,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAC;AACrE,CAAC;AAVD,kDAUC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,KAAa;IAC/C,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC;AACjC,CAAC;AAFD,kDAEC","sourcesContent":["//\n// Types\n//\n\n/**\n * Makes every specified property of the specified object type mutable.\n *\n * @template ObjectValue - The object whose readonly properties to make mutable.\n * @template TargetKey - The property key(s) to make mutable.\n */\nexport type Mutable<\n  ObjectValue extends Record<string, unknown>,\n  TargetKey extends keyof ObjectValue\n> = {\n  -readonly [Key in keyof Pick<ObjectValue, TargetKey>]: ObjectValue[Key];\n} &\n  {\n    [Key in keyof Omit<ObjectValue, TargetKey>]: ObjectValue[Key];\n  };\n\n/**\n * Useful for representing some value that _might_ be present and / or complete.\n *\n * @template Value - The value that might be present or complete.\n */\nexport type PartialOrAbsent<Value> = Partial<Value> | null | undefined;\n\n/**\n * Like {@link Array}, but always non-empty.\n *\n * @template Element - The non-empty array member type.\n */\nexport type NonEmptyArray<Element> = [Element, ...Element[]];\n\n/**\n * A JavaScript object that is not `null`, a function, or an array. The object\n * can still be an instance of a class.\n */\nexport type RuntimeObject = Record<number | string | symbol, unknown>;\n\n//\n// Type Guards\n//\n\n/**\n * A {@link NonEmptyArray} type guard.\n *\n * @template Element - The non-empty array member type.\n * @param value - The value to check.\n * @returns Whether the value is a non-empty array.\n */\nexport function isNonEmptyArray<Element>(\n  value: Element[],\n): value is NonEmptyArray<Element> {\n  return Array.isArray(value) && value.length > 0;\n}\n\n/**\n * Type guard for \"nullishness\".\n *\n * @param value - Any value.\n * @returns `true` if the value is null or undefined, `false` otherwise.\n */\nexport function isNullOrUndefined(value: unknown): value is null | undefined {\n  return value === null || value === undefined;\n}\n\n/**\n * A type guard for {@link RuntimeObject}.\n *\n * @param value - The value to check.\n * @returns Whether the specified value has a runtime type of `object` and is\n * neither `null` nor an `Array`.\n */\nexport function isObject(value: unknown): value is RuntimeObject {\n  return Boolean(value) && typeof value === 'object' && !Array.isArray(value);\n}\n\n//\n// Other utility functions\n//\n\n/**\n * An alias for {@link Object.hasOwnProperty}.\n *\n * @param object - The object to check.\n * @param name - The property name to check for.\n * @returns Whether the specified object has an own property with the specified\n * name, regardless of whether it is enumerable or not.\n */\nexport const hasProperty = (\n  object: RuntimeObject,\n  name: string | number | symbol,\n): boolean => Object.hasOwnProperty.call(object, name);\n\nexport type PlainObject = Record<number | string | symbol, unknown>;\n\n/**\n * Predefined sizes (in Bytes) of specific parts of JSON structure.\n */\nexport enum JsonSize {\n  Null = 4,\n  Comma = 1,\n  Wrapper = 1,\n  True = 4,\n  False = 5,\n  Quote = 1,\n  Colon = 1,\n  Date = 24,\n}\n\n/**\n * Regular expression with pattern matching for (special) escaped characters.\n */\nexport const ESCAPE_CHARACTERS_REGEXP = /\"|\\\\|\\n|\\r|\\t/gu;\n\n/**\n * Check if the value is plain object.\n *\n * @param value - Value to be checked.\n * @returns True if an object is the plain JavaScript object,\n * false if the object is not plain (e.g. function).\n */\nexport function isPlainObject(value: unknown): value is PlainObject {\n  if (typeof value !== 'object' || value === null) {\n    return false;\n  }\n\n  try {\n    let proto = value;\n    while (Object.getPrototypeOf(proto) !== null) {\n      proto = Object.getPrototypeOf(proto);\n    }\n\n    return Object.getPrototypeOf(value) === proto;\n  } catch (_) {\n    return false;\n  }\n}\n\n/**\n * Check if character is ASCII.\n *\n * @param character - Character.\n * @returns True if a character code is ASCII, false if not.\n */\nexport function isASCII(character: string) {\n  return character.charCodeAt(0) <= 127;\n}\n\n/**\n * Calculate string size.\n *\n * @param value - String value to calculate size.\n * @returns Number of bytes used to store whole string value.\n */\nexport function calculateStringSize(value: string): number {\n  const size = value.split('').reduce((total, character) => {\n    if (isASCII(character)) {\n      return total + 1;\n    }\n    return total + 2;\n  }, 0);\n\n  // Also detect characters that need backslash escape\n  return size + (value.match(ESCAPE_CHARACTERS_REGEXP) ?? []).length;\n}\n\n/**\n * Calculate size of a number ofter JSON serialization.\n *\n * @param value - Number value to calculate size.\n * @returns Number of bytes used to store whole number in JSON.\n */\nexport function calculateNumberSize(value: number): number {\n  return value.toString().length;\n}\n"]}

package/dist/test.data.d.ts

@@ -0,0 +1,85 @@
+export declare const complexObject: {
+    data: {
+        account: {
+            __typename: string;
+            registrations: {
+                __typename: string;
+                domain: {
+                    __typename: string;
+                    isMigrated: boolean;
+                    labelName: string;
+                    labelhash: string;
+                    name: string;
+                    parent: {
+                        __typename: string;
+                        name: string;
+                    };
+                };
+                expiryDate: string;
+            }[];
+        };
+        moreComplexity: {
+            numbers: number[];
+            moreNestedObjects: {
+                nestedAgain: {
+                    nestedAgain: {
+                        andAgain: {
+                            andAgain: {
+                                value: boolean;
+                                again: {
+                                    value: boolean;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            differentEncodings: {
+                ascii: string;
+                utf8: string;
+                mixed: string;
+                specialCharacters: string;
+                stringWithSpecialEscapedCharacters: string;
+            };
+            specialObjectsTypesAndValues: {
+                t: boolean[];
+                f: boolean[];
+                nulls: null[];
+                undef: undefined;
+                mixed: (boolean | null | undefined)[];
+                inObject: {
+                    valueOne: null;
+                    valueTwo: undefined;
+                    t: boolean;
+                    f: boolean;
+                };
+                dates: {
+                    someDate: Date;
+                    someOther: Date;
+                    invalidDate: Date;
+                };
+            };
+        };
+    };
+};
+export declare const nonSerializableNestedObject: {
+    levelOne: {
+        levelTwo: {
+            levelThree: {
+                levelFour: {
+                    levelFive: () => string;
+                };
+            };
+        };
+    };
+};
+export declare const arrayOfDifferentKindsOfNumbers: number[];
+export declare const arrayOfMixedSpecialObjects: (null | undefined)[];
+export declare const objectMixedWithUndefinedValues: {
+    a: undefined;
+    b: string;
+    c: undefined;
+    d: string;
+    e: undefined;
+    f: string;
+};

package/dist/test.data.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectMixedWithUndefinedValues = exports.arrayOfMixedSpecialObjects = exports.arrayOfDifferentKindsOfNumbers = exports.nonSerializableNestedObject = exports.complexObject = void 0;
+exports.complexObject = {
+    data: {
+        account: {
+            __typename: 'Account',
+            registrations: [
+                {
+                    __typename: 'Registration',
+                    domain: {
+                        __typename: 'Domain',
+                        isMigrated: true,
+                        labelName: 'mycrypto',
+                        labelhash: '0x9a781ca0d227debc3ee76d547c960b0803a6c9f58c6d3b4722f12ede7e6ef7c9',
+                        name: 'mycrypto.eth',
+                        parent: { __typename: 'Domain', name: 'eth' },
+                    },
+                    expiryDate: '1754111315',
+                },
+            ],
+        },
+        moreComplexity: {
+            numbers: [
+                -5e-11,
+                5e-9,
+                0.000000000001,
+                -0.00000000009,
+                100000.00000008,
+                -100.88888,
+                0.333,
+                1000000000000,
+            ],
+            moreNestedObjects: {
+                nestedAgain: {
+                    nestedAgain: {
+                        andAgain: {
+                            andAgain: {
+                                value: true,
+                                again: {
+                                    value: false,
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+            differentEncodings: {
+                ascii: '!"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~',
+                utf8: 'šđćčžЀЂЇЄЖФћΣΩδλ',
+                mixed: 'ABCDEFGHIJ KLMNOPQRST UVWXYZšđćč žЀЂЇЄЖФћΣΩδλ',
+                specialCharacters: '"\\\n\r\t',
+                stringWithSpecialEscapedCharacters: "this\nis\nsome\"'string\r\nwith\tspecial\\escaped\tcharacters'",
+            },
+            specialObjectsTypesAndValues: {
+                t: [true, true, true],
+                f: [false, false, false],
+                nulls: [null, null, null],
+                undef: undefined,
+                mixed: [
+                    null,
+                    undefined,
+                    null,
+                    undefined,
+                    null,
+                    true,
+                    null,
+                    false,
+                    null,
+                    undefined,
+                ],
+                inObject: {
+                    valueOne: null,
+                    valueTwo: undefined,
+                    t: true,
+                    f: false,
+                },
+                dates: {
+                    someDate: new Date(),
+                    someOther: new Date(2022, 0, 2, 15, 4, 5),
+                    invalidDate: new Date('bad-date-format'),
+                },
+            },
+        },
+    },
+};
+exports.nonSerializableNestedObject = {
+    levelOne: {
+        levelTwo: {
+            levelThree: {
+                levelFour: {
+                    levelFive: () => {
+                        return 'anything';
+                    },
+                },
+            },
+        },
+    },
+};
+exports.arrayOfDifferentKindsOfNumbers = [
+    -5e-11,
+    5e-9,
+    0.000000000001,
+    -0.00000000009,
+    100000.00000008,
+    -100.88888,
+    0.333,
+    1000000000000,
+];
+exports.arrayOfMixedSpecialObjects = [
+    null,
+    undefined,
+    null,
+    undefined,
+    undefined,
+    undefined,
+    null,
+    null,
+    null,
+    undefined,
+];
+exports.objectMixedWithUndefinedValues = {
+    a: undefined,
+    b: 'b',
+    c: undefined,
+    d: 'd',
+    e: undefined,
+    f: 'f',
+};
+//# sourceMappingURL=test.data.js.map

package/dist/test.data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.data.js","sourceRoot":"","sources":["../src/test.data.ts"],"names":[],"mappings":";;;AAAa,QAAA,aAAa,GAAG;IAC3B,IAAI,EAAE;QACJ,OAAO,EAAE;YACP,UAAU,EAAE,SAAS;YACrB,aAAa,EAAE;gBACb;oBACE,UAAU,EAAE,cAAc;oBAC1B,MAAM,EAAE;wBACN,UAAU,EAAE,QAAQ;wBACpB,UAAU,EAAE,IAAI;wBAChB,SAAS,EAAE,UAAU;wBACrB,SAAS,EACP,oEAAoE;wBACtE,IAAI,EAAE,cAAc;wBACpB,MAAM,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE;qBAC9C;oBACD,UAAU,EAAE,YAAY;iBACzB;aACF;SACF;QACD,cAAc,EAAE;YACd,OAAO,EAAE;gBACP,CAAC,KAAK;gBACN,IAAI;gBACJ,cAAc;gBACd,CAAC,aAAa;gBACd,eAAe;gBACf,CAAC,SAAS;gBACV,KAAK;gBACL,aAAa;aACd;YACD,iBAAiB,EAAE;gBACjB,WAAW,EAAE;oBACX,WAAW,EAAE;wBACX,QAAQ,EAAE;4BACR,QAAQ,EAAE;gCACR,KAAK,EAAE,IAAI;gCACX,KAAK,EAAE;oCACL,KAAK,EAAE,KAAK;iCACb;6BACF;yBACF;qBACF;iBACF;aACF;YACD,kBAAkB,EAAE;gBAClB,KAAK,EACH,kGAAkG;gBACpG,IAAI,EAAE,kBAAkB;gBACxB,KAAK,EAAE,+CAA+C;gBACtD,iBAAiB,EAAE,WAAW;gBAC9B,kCAAkC,EAChC,gEAAgE;aACnE;YACD,4BAA4B,EAAE;gBAC5B,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;gBACrB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;gBACxB,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;gBACzB,KAAK,EAAE,SAAS;gBAChB,KAAK,EAAE;oBACL,IAAI;oBACJ,SAAS;oBACT,IAAI;oBACJ,SAAS;oBACT,IAAI;oBACJ,IAAI;oBACJ,IAAI;oBACJ,KAAK;oBACL,IAAI;oBACJ,SAAS;iBACV;gBACD,QAAQ,EAAE;oBACR,QAAQ,EAAE,IAAI;oBACd,QAAQ,EAAE,SAAS;oBACnB,CAAC,EAAE,IAAI;oBACP,CAAC,EAAE,KAAK;iBACT;gBACD,KAAK,EAAE;oBACL,QAAQ,EAAE,IAAI,IAAI,EAAE;oBACpB,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;oBACzC,WAAW,EAAE,IAAI,IAAI,CAAC,iBAAiB,CAAC;iBACzC;aACF;SACF;KACF;CACF,CAAC;AAEW,QAAA,2BAA2B,GAAG;IACzC,QAAQ,EAAE;QACR,QAAQ,EAAE;YACR,UAAU,EAAE;gBACV,SAAS,EAAE;oBACT,SAAS,EAAE,GAAG,EAAE;wBACd,OAAO,UAAU,CAAC;oBACpB,CAAC;iBACF;aACF;SACF;KACF;CACF,CAAC;AAEW,QAAA,8BAA8B,GAAG;IAC5C,CAAC,KAAK;IACN,IAAI;IACJ,cAAc;IACd,CAAC,aAAa;IACd,eAAe;IACf,CAAC,SAAS;IACV,KAAK;IACL,aAAa;CACd,CAAC;AAEW,QAAA,0BAA0B,GAAG;IACxC,IAAI;IACJ,SAAS;IACT,IAAI;IACJ,SAAS;IACT,SAAS;IACT,SAAS;IACT,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,SAAS;CACV,CAAC;AAEW,QAAA,8BAA8B,GAAG;IAC5C,CAAC,EAAE,SAAS;IACZ,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,SAAS;IACZ,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,SAAS;IACZ,CAAC,EAAE,GAAG;CACP,CAAC","sourcesContent":["export const complexObject = {\n  data: {\n    account: {\n      __typename: 'Account',\n      registrations: [\n        {\n          __typename: 'Registration',\n          domain: {\n            __typename: 'Domain',\n            isMigrated: true,\n            labelName: 'mycrypto',\n            labelhash:\n              '0x9a781ca0d227debc3ee76d547c960b0803a6c9f58c6d3b4722f12ede7e6ef7c9',\n            name: 'mycrypto.eth',\n            parent: { __typename: 'Domain', name: 'eth' },\n          },\n          expiryDate: '1754111315',\n        },\n      ],\n    },\n    moreComplexity: {\n      numbers: [\n        -5e-11,\n        5e-9,\n        0.000000000001,\n        -0.00000000009,\n        100000.00000008,\n        -100.88888,\n        0.333,\n        1000000000000,\n      ],\n      moreNestedObjects: {\n        nestedAgain: {\n          nestedAgain: {\n            andAgain: {\n              andAgain: {\n                value: true,\n                again: {\n                  value: false,\n                },\n              },\n            },\n          },\n        },\n      },\n      differentEncodings: {\n        ascii:\n          '!\"#$%&\\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\\\]^_`abcdefghijklmnopqrstuvwxyz{|}~',\n        utf8: 'šđćčžЀЂЇЄЖФћΣΩδλ',\n        mixed: 'ABCDEFGHIJ KLMNOPQRST UVWXYZšđćč žЀЂЇЄЖФћΣΩδλ',\n        specialCharacters: '\"\\\\\\n\\r\\t',\n        stringWithSpecialEscapedCharacters:\n          \"this\\nis\\nsome\\\"'string\\r\\nwith\\tspecial\\\\escaped\\tcharacters'\",\n      },\n      specialObjectsTypesAndValues: {\n        t: [true, true, true],\n        f: [false, false, false],\n        nulls: [null, null, null],\n        undef: undefined,\n        mixed: [\n          null,\n          undefined,\n          null,\n          undefined,\n          null,\n          true,\n          null,\n          false,\n          null,\n          undefined,\n        ],\n        inObject: {\n          valueOne: null,\n          valueTwo: undefined,\n          t: true,\n          f: false,\n        },\n        dates: {\n          someDate: new Date(),\n          someOther: new Date(2022, 0, 2, 15, 4, 5),\n          invalidDate: new Date('bad-date-format'),\n        },\n      },\n    },\n  },\n};\n\nexport const nonSerializableNestedObject = {\n  levelOne: {\n    levelTwo: {\n      levelThree: {\n        levelFour: {\n          levelFive: () => {\n            return 'anything';\n          },\n        },\n      },\n    },\n  },\n};\n\nexport const arrayOfDifferentKindsOfNumbers = [\n  -5e-11,\n  5e-9,\n  0.000000000001,\n  -0.00000000009,\n  100000.00000008,\n  -100.88888,\n  0.333,\n  1000000000000,\n];\n\nexport const arrayOfMixedSpecialObjects = [\n  null,\n  undefined,\n  null,\n  undefined,\n  undefined,\n  undefined,\n  null,\n  null,\n  null,\n  undefined,\n];\n\nexport const objectMixedWithUndefinedValues = {\n  a: undefined,\n  b: 'b',\n  c: undefined,\n  d: 'd',\n  e: undefined,\n  f: 'f',\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/utils",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Various JavaScript/TypeScript utilities of wide relevance to the MetaMask codebase.",
   "repository": {
     "type": "git",