@metamask/utils 1.0.0 → 3.0.0

package/dist/json.js

@@ -3,9 +3,29 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isJsonRpcFailure = exports.isJsonRpcSuccess = exports.jsonrpc2 = exports.isValidJson = void 0;
+exports.validateJsonAndGetSize = exports.getJsonRpcIdValidator = exports.assertIsJsonRpcFailure = exports.isJsonRpcFailure = exports.assertIsJsonRpcSuccess = exports.isJsonRpcSuccess = exports.assertIsJsonRpcResponse = exports.isJsonRpcResponse = exports.JsonRpcResponseStruct = exports.JsonRpcFailureStruct = exports.JsonRpcSuccessStruct = exports.assertIsJsonRpcRequest = exports.isJsonRpcRequest = exports.assertIsJsonRpcNotification = exports.isJsonRpcNotification = exports.JsonRpcNotificationStruct = exports.JsonRpcRequestStruct = exports.JsonRpcParamsStruct = exports.JsonRpcErrorStruct = exports.JsonRpcIdStruct = exports.JsonRpcVersionStruct = exports.jsonrpc2 = exports.isValidJson = exports.JsonStruct = void 0;
 const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
+const superstruct_1 = require("superstruct");
 const misc_1 = require("./misc");
+/**
+ * Type guard for determining whether the given value is an error object with a
+ * `message` property, such as an instance of Error.
+ *
+ * @param error - The object to check.
+ * @returns True or false, depending on the result.
+ */
+function isErrorWithMessage(error) {
+    return typeof error === 'object' && error !== null && 'message' in error;
+}
+// Note: This struct references itself, so TypeScript cannot infer the type.
+exports.JsonStruct = (0, superstruct_1.union)([
+    (0, superstruct_1.literal)(null),
+    (0, superstruct_1.boolean)(),
+    (0, superstruct_1.number)(),
+    (0, superstruct_1.string)(),
+    (0, superstruct_1.lazy)(() => (0, superstruct_1.array)(exports.JsonStruct)),
+    (0, superstruct_1.lazy)(() => (0, superstruct_1.record)((0, superstruct_1.string)(), exports.JsonStruct)),
+]);
 /**
  * Type guard for {@link Json}.
  *
@@ -14,7 +34,7 @@ const misc_1 = require("./misc");
  */
 function isValidJson(value) {
     try {
-        return fast_deep_equal_1.default(value, JSON.parse(JSON.stringify(value)));
+        return (0, fast_deep_equal_1.default)(value, JSON.parse(JSON.stringify(value)));
     }
     catch (_) {
         return false;
@@ -25,26 +45,140 @@ exports.isValidJson = isValidJson;
  * The string '2.0'.
  */
 exports.jsonrpc2 = '2.0';
+exports.JsonRpcVersionStruct = (0, superstruct_1.literal)(exports.jsonrpc2);
+exports.JsonRpcIdStruct = (0, superstruct_1.nullable)((0, superstruct_1.union)([(0, superstruct_1.number)(), (0, superstruct_1.string)()]));
+exports.JsonRpcErrorStruct = (0, superstruct_1.object)({
+    code: (0, superstruct_1.number)(),
+    message: (0, superstruct_1.string)(),
+    data: (0, superstruct_1.optional)((0, superstruct_1.unknown)()),
+    stack: (0, superstruct_1.optional)((0, superstruct_1.string)()),
+});
+exports.JsonRpcParamsStruct = (0, superstruct_1.optional)((0, superstruct_1.union)([(0, superstruct_1.object)(), (0, superstruct_1.array)()]));
+exports.JsonRpcRequestStruct = (0, superstruct_1.object)({
+    id: exports.JsonRpcIdStruct,
+    jsonrpc: exports.JsonRpcVersionStruct,
+    method: (0, superstruct_1.string)(),
+    params: exports.JsonRpcParamsStruct,
+});
+exports.JsonRpcNotificationStruct = (0, superstruct_1.omit)(exports.JsonRpcRequestStruct, ['id']);
+/**
+ * Type guard to narrow a JSON-RPC request or notification object to a
+ * notification.
+ *
+ * @param requestOrNotification - The JSON-RPC request or notification to check.
+ * @returns Whether the specified JSON-RPC message is a notification.
+ */
+function isJsonRpcNotification(requestOrNotification) {
+    return (0, superstruct_1.is)(requestOrNotification, exports.JsonRpcNotificationStruct);
+}
+exports.isJsonRpcNotification = isJsonRpcNotification;
+/**
+ * Assertion type guard to narrow a JSON-RPC request or notification object to a
+ * notification.
+ *
+ * @param requestOrNotification - The JSON-RPC request or notification to check.
+ */
+function assertIsJsonRpcNotification(requestOrNotification) {
+    try {
+        (0, superstruct_1.assert)(requestOrNotification, exports.JsonRpcNotificationStruct);
+    }
+    catch (error) {
+        const message = isErrorWithMessage(error) ? error.message : error;
+        throw new Error(`Not a JSON-RPC notification: ${message}.`);
+    }
+}
+exports.assertIsJsonRpcNotification = assertIsJsonRpcNotification;
+/**
+ * Type guard to narrow a JSON-RPC request or notification object to a request.
+ *
+ * @param requestOrNotification - The JSON-RPC request or notification to check.
+ * @returns Whether the specified JSON-RPC message is a request.
+ */
+function isJsonRpcRequest(requestOrNotification) {
+    return (0, superstruct_1.is)(requestOrNotification, exports.JsonRpcRequestStruct);
+}
+exports.isJsonRpcRequest = isJsonRpcRequest;
+/**
+ * Assertion type guard to narrow a JSON-RPC request or notification object to a
+ * request.
+ *
+ * @param requestOrNotification - The JSON-RPC request or notification to check.
+ */
+function assertIsJsonRpcRequest(requestOrNotification) {
+    try {
+        (0, superstruct_1.assert)(requestOrNotification, exports.JsonRpcRequestStruct);
+    }
+    catch (error) {
+        const message = isErrorWithMessage(error) ? error.message : error;
+        throw new Error(`Not a JSON-RPC request: ${message}.`);
+    }
+}
+exports.assertIsJsonRpcRequest = assertIsJsonRpcRequest;
+exports.JsonRpcSuccessStruct = (0, superstruct_1.object)({
+    id: exports.JsonRpcIdStruct,
+    jsonrpc: exports.JsonRpcVersionStruct,
+    result: exports.JsonStruct,
+});
+exports.JsonRpcFailureStruct = (0, superstruct_1.object)({
+    id: exports.JsonRpcIdStruct,
+    jsonrpc: exports.JsonRpcVersionStruct,
+    error: exports.JsonRpcErrorStruct,
+});
+exports.JsonRpcResponseStruct = (0, superstruct_1.union)([
+    exports.JsonRpcSuccessStruct,
+    exports.JsonRpcFailureStruct,
+]);
+/**
+ * Type guard to check if a value is a JsonRpcResponse.
+ *
+ * @param response - The object to check.
+ * @returns Whether the object is a JsonRpcResponse.
+ */
+function isJsonRpcResponse(response) {
+    return (0, superstruct_1.is)(response, exports.JsonRpcResponseStruct);
+}
+exports.isJsonRpcResponse = isJsonRpcResponse;
 /**
- * ATTN: Assumes that only one of the `result` and `error` properties is
- * present on the `response`, as guaranteed by e.g.
- * [`JsonRpcEngine.handle`](https://github.com/MetaMask/json-rpc-engine/blob/main/src/JsonRpcEngine.ts).
+ * Type assertion to check if a value is a JsonRpcResponse.
  *
+ * @param response - The response to check.
+ */
+function assertIsJsonRpcResponse(response) {
+    try {
+        (0, superstruct_1.assert)(response, exports.JsonRpcResponseStruct);
+    }
+    catch (error) {
+        const message = isErrorWithMessage(error) ? error.message : error;
+        throw new Error(`Not a JSON-RPC response: ${message}.`);
+    }
+}
+exports.assertIsJsonRpcResponse = assertIsJsonRpcResponse;
+/**
  * Type guard to narrow a JsonRpcResponse object to a success (or failure).
  *
  * @param response - The response object to check.
- * @returns Whether the response object is a success, i.e. has a `result`
- * property.
+ * @returns Whether the response object is a success.
  */
 function isJsonRpcSuccess(response) {
-    return misc_1.hasProperty(response, 'result');
+    return (0, superstruct_1.is)(response, exports.JsonRpcSuccessStruct);
 }
 exports.isJsonRpcSuccess = isJsonRpcSuccess;
 /**
- * ATTN: Assumes that only one of the `result` and `error` properties is
- * present on the `response`, as guaranteed by e.g.
- * [`JsonRpcEngine.handle`](https://github.com/MetaMask/json-rpc-engine/blob/main/src/JsonRpcEngine.ts).
+ * Type assertion to narrow a JsonRpcResponse object to a success (or failure).
  *
+ * @param response - The response object to check.
+ */
+function assertIsJsonRpcSuccess(response) {
+    try {
+        (0, superstruct_1.assert)(response, exports.JsonRpcSuccessStruct);
+    }
+    catch (error) {
+        const message = isErrorWithMessage(error) ? error.message : error;
+        throw new Error(`Not a successful JSON-RPC response: ${message}.`);
+    }
+}
+exports.assertIsJsonRpcSuccess = assertIsJsonRpcSuccess;
+/**
  * Type guard to narrow a JsonRpcResponse object to a failure (or success).
  *
  * @param response - The response object to check.
@@ -52,7 +186,197 @@ exports.isJsonRpcSuccess = isJsonRpcSuccess;
  * property.
  */
 function isJsonRpcFailure(response) {
-    return misc_1.hasProperty(response, 'error');
+    return (0, superstruct_1.is)(response, exports.JsonRpcFailureStruct);
 }
 exports.isJsonRpcFailure = isJsonRpcFailure;
+/**
+ * Type assertion to narrow a JsonRpcResponse object to a failure (or success).
+ *
+ * @param response - The response object to check.
+ */
+function assertIsJsonRpcFailure(response) {
+    try {
+        (0, superstruct_1.assert)(response, exports.JsonRpcFailureStruct);
+    }
+    catch (error) {
+        const message = isErrorWithMessage(error) ? error.message : error;
+        throw new Error(`Not a failed JSON-RPC response: ${message}.`);
+    }
+}
+exports.assertIsJsonRpcFailure = assertIsJsonRpcFailure;
+/**
+ * Gets a function for validating JSON-RPC request / response `id` values.
+ *
+ * By manipulating the options of this factory, you can control the behavior
+ * of the resulting validator for some edge cases. This is useful because e.g.
+ * `null` should sometimes but not always be permitted.
+ *
+ * Note that the empty string (`''`) is always permitted by the JSON-RPC
+ * specification, but that kind of sucks and you may want to forbid it in some
+ * instances anyway.
+ *
+ * For more details, see the
+ * [JSON-RPC Specification](https://www.jsonrpc.org/specification).
+ *
+ * @param options - An options object.
+ * @param options.permitEmptyString - Whether the empty string (i.e. `''`)
+ * should be treated as a valid ID. Default: `true`
+ * @param options.permitFractions - Whether fractional numbers (e.g. `1.2`)
+ * should be treated as valid IDs. Default: `false`
+ * @param options.permitNull - Whether `null` should be treated as a valid ID.
+ * Default: `true`
+ * @returns The JSON-RPC ID validator function.
+ */
+function getJsonRpcIdValidator(options) {
+    const { permitEmptyString, permitFractions, permitNull } = Object.assign({ permitEmptyString: true, permitFractions: false, permitNull: true }, options);
+    /**
+     * Type guard for {@link JsonRpcId}.
+     *
+     * @param id - The JSON-RPC ID value to check.
+     * @returns Whether the given ID is valid per the options given to the
+     * factory.
+     */
+    const isValidJsonRpcId = (id) => {
+        return Boolean((typeof id === 'number' && (permitFractions || Number.isInteger(id))) ||
+            (typeof id === 'string' && (permitEmptyString || id.length > 0)) ||
+            (permitNull && id === null));
+    };
+    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
+                        : (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, (0, 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 (!(0, 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;AA+EvC;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAC9B,QAAiC;IAEjC,OAAO,kBAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AACzC,CAAC;AAJD,4CAIC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAC9B,QAAkC;IAElC,OAAO,kBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC;AAJD,4CAIC","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 * 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 * ATTN: Assumes that only one of the `result` and `error` properties is\n * present on the `response`, as guaranteed by e.g.\n * [`JsonRpcEngine.handle`](https://github.com/MetaMask/json-rpc-engine/blob/main/src/JsonRpcEngine.ts).\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 * ATTN: Assumes that only one of the `result` and `error` properties is\n * present on the `response`, as guaranteed by e.g.\n * [`JsonRpcEngine.handle`](https://github.com/MetaMask/json-rpc-engine/blob/main/src/JsonRpcEngine.ts).\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"]}
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../src/json.ts"],"names":[],"mappings":";;;;;;AAAA,sEAAwC;AACxC,6CAkBqB;AACrB,iCAKgB;AAEhB;;;;;;GAMG;AACH,SAAS,kBAAkB,CAAC,KAAc;IACxC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,SAAS,IAAI,KAAK,CAAC;AAC3E,CAAC;AAED,4EAA4E;AAC/D,QAAA,UAAU,GAAiB,IAAA,mBAAK,EAAC;IAC5C,IAAA,qBAAO,EAAC,IAAI,CAAC;IACb,IAAA,qBAAO,GAAE;IACT,IAAA,oBAAM,GAAE;IACR,IAAA,oBAAM,GAAE;IACR,IAAA,kBAAI,EAAC,GAAG,EAAE,CAAC,IAAA,mBAAK,EAAC,kBAAU,CAAC,CAAC;IAC7B,IAAA,kBAAI,EAAC,GAAG,EAAE,CAAC,IAAA,oBAAM,EAAC,IAAA,oBAAM,GAAE,EAAE,kBAAU,CAAC,CAAC;CACzC,CAAC,CAAC;AAaH;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,IAAI;QACF,OAAO,IAAA,yBAAS,EAAC,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;AAC1B,QAAA,oBAAoB,GAAG,IAAA,qBAAO,EAAC,gBAAQ,CAAC,CAAC;AAQzC,QAAA,eAAe,GAAG,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,oBAAM,GAAE,CAAC,CAAC,CAAC,CAAC;AAUxD,QAAA,kBAAkB,GAAG,IAAA,oBAAM,EAAC;IACvC,IAAI,EAAE,IAAA,oBAAM,GAAE;IACd,OAAO,EAAE,IAAA,oBAAM,GAAE;IACjB,IAAI,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;IACzB,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CAC1B,CAAC,CAAC;AAOU,QAAA,mBAAmB,GAAG,IAAA,sBAAQ,EAAC,IAAA,mBAAK,EAAC,CAAC,IAAA,oBAAM,GAAE,EAAE,IAAA,mBAAK,GAAE,CAAC,CAAC,CAAC,CAAC;AAI3D,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC,EAAE,EAAE,uBAAe;IACnB,OAAO,EAAE,4BAAoB;IAC7B,MAAM,EAAE,IAAA,oBAAM,GAAE;IAChB,MAAM,EAAE,2BAAmB;CAC5B,CAAC,CAAC;AAiBU,QAAA,yBAAyB,GAAG,IAAA,kBAAI,EAAC,4BAAoB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;AAU5E;;;;;;GAMG;AACH,SAAgB,qBAAqB,CACnC,qBAA8B;IAE9B,OAAO,IAAA,gBAAE,EAAC,qBAAqB,EAAE,iCAAyB,CAAC,CAAC;AAC9D,CAAC;AAJD,sDAIC;AAED;;;;;GAKG;AACH,SAAgB,2BAA2B,CACzC,qBAA8B;IAE9B,IAAI;QACF,IAAA,oBAAM,EAAC,qBAAqB,EAAE,iCAAyB,CAAC,CAAC;KAC1D;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;QAClE,MAAM,IAAI,KAAK,CAAC,gCAAgC,OAAO,GAAG,CAAC,CAAC;KAC7D;AACH,CAAC;AATD,kEASC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAC9B,qBAA8B;IAE9B,OAAO,IAAA,gBAAE,EAAC,qBAAqB,EAAE,4BAAoB,CAAC,CAAC;AACzD,CAAC;AAJD,4CAIC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CACpC,qBAA8B;IAE9B,IAAI;QACF,IAAA,oBAAM,EAAC,qBAAqB,EAAE,4BAAoB,CAAC,CAAC;KACrD;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;QAClE,MAAM,IAAI,KAAK,CAAC,2BAA2B,OAAO,GAAG,CAAC,CAAC;KACxD;AACH,CAAC;AATD,wDASC;AAEY,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC,EAAE,EAAE,uBAAe;IACnB,OAAO,EAAE,4BAAoB;IAC7B,MAAM,EAAE,kBAAU;CACnB,CAAC,CAAC;AAYU,QAAA,oBAAoB,GAAG,IAAA,oBAAM,EAAC;IACzC,EAAE,EAAE,uBAAe;IACnB,OAAO,EAAE,4BAAoB;IAC7B,KAAK,EAAE,0BAAkB;CAC1B,CAAC,CAAC;AAOU,QAAA,qBAAqB,GAAG,IAAA,mBAAK,EAAC;IACzC,4BAAoB;IACpB,4BAAoB;CACrB,CAAC,CAAC;AAYH;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,QAAiB;IAEjB,OAAO,IAAA,gBAAE,EAAC,QAAQ,EAAE,6BAAqB,CAAC,CAAC;AAC7C,CAAC;AAJD,8CAIC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB,CACrC,QAAiB;IAEjB,IAAI;QACF,IAAA,oBAAM,EAAC,QAAQ,EAAE,6BAAqB,CAAC,CAAC;KACzC;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;QAClE,MAAM,IAAI,KAAK,CAAC,4BAA4B,OAAO,GAAG,CAAC,CAAC;KACzD;AACH,CAAC;AATD,0DASC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAC9B,QAAiB;IAEjB,OAAO,IAAA,gBAAE,EAAC,QAAQ,EAAE,4BAAoB,CAAC,CAAC;AAC5C,CAAC;AAJD,4CAIC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,QAAiB;IAEjB,IAAI;QACF,IAAA,oBAAM,EAAC,QAAQ,EAAE,4BAAoB,CAAC,CAAC;KACxC;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;QAClE,MAAM,IAAI,KAAK,CAAC,uCAAuC,OAAO,GAAG,CAAC,CAAC;KACpE;AACH,CAAC;AATD,wDASC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,QAAiB;IAEjB,OAAO,IAAA,gBAAE,EAAC,QAAQ,EAAE,4BAAoB,CAAC,CAAC;AAC5C,CAAC;AAJD,4CAIC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,QAAiB;IAEjB,IAAI;QACF,IAAA,oBAAM,EAAC,QAAQ,EAAE,4BAAoB,CAAC,CAAC;KACxC;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;QAClE,MAAM,IAAI,KAAK,CAAC,mCAAmC,OAAO,GAAG,CAAC,CAAC;KAChE;AACH,CAAC;AATD,wDASC;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;IAEF,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAxBD,sDAwBC;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,IAAA,0BAAmB,EAAC,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,IAAA,0BAAmB,EAAC,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,IAAA,oBAAa,EAAC,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  array,\n  assert,\n  boolean,\n  Infer,\n  is,\n  lazy,\n  literal,\n  nullable,\n  number,\n  object,\n  omit,\n  optional,\n  record,\n  string,\n  Struct,\n  union,\n  unknown,\n} from 'superstruct';\nimport {\n  calculateNumberSize,\n  calculateStringSize,\n  isPlainObject,\n  JsonSize,\n} from './misc';\n\n/**\n * Type guard for determining whether the given value is an error object with a\n * `message` property, such as an instance of Error.\n *\n * @param error - The object to check.\n * @returns True or false, depending on the result.\n */\nfunction isErrorWithMessage(error: unknown): error is { message: string } {\n  return typeof error === 'object' && error !== null && 'message' in error;\n}\n\n// Note: This struct references itself, so TypeScript cannot infer the type.\nexport const JsonStruct: Struct<Json> = union([\n  literal(null),\n  boolean(),\n  number(),\n  string(),\n  lazy(() => array(JsonStruct)),\n  lazy(() => record(string(), JsonStruct)),\n]);\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;\nexport const JsonRpcVersionStruct = literal(jsonrpc2);\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\nexport const JsonRpcIdStruct = nullable(union([number(), string()]));\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 = Infer<typeof JsonRpcIdStruct>;\n\nexport const JsonRpcErrorStruct = object({\n  code: number(),\n  message: string(),\n  data: optional(unknown()),\n  stack: optional(string()),\n});\n\n/**\n * A JSON-RPC error object.\n */\nexport type JsonRpcError = Infer<typeof JsonRpcErrorStruct>;\n\nexport const JsonRpcParamsStruct = optional(union([object(), array()]));\n\nexport type JsonRpcParams = Infer<typeof JsonRpcParamsStruct>;\n\nexport const JsonRpcRequestStruct = object({\n  id: JsonRpcIdStruct,\n  jsonrpc: JsonRpcVersionStruct,\n  method: string(),\n  params: JsonRpcParamsStruct,\n});\n\nexport type InferWithParams<\n  Type extends Struct<any, unknown>,\n  Params extends JsonRpcParams\n> = Omit<Infer<Type>, 'params'> & {\n  params: Params;\n};\n\n/**\n * A JSON-RPC request object.\n */\nexport type JsonRpcRequest<Params extends JsonRpcParams> = InferWithParams<\n  typeof JsonRpcRequestStruct,\n  Params\n>;\n\nexport const JsonRpcNotificationStruct = omit(JsonRpcRequestStruct, ['id']);\n\n/**\n * A JSON-RPC notification object.\n */\nexport type JsonRpcNotification<Params extends JsonRpcParams> = InferWithParams<\n  typeof JsonRpcNotificationStruct,\n  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(\n  requestOrNotification: unknown,\n): requestOrNotification is JsonRpcNotification<JsonRpcParams> {\n  return is(requestOrNotification, JsonRpcNotificationStruct);\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(\n  requestOrNotification: unknown,\n): asserts requestOrNotification is JsonRpcNotification<JsonRpcParams> {\n  try {\n    assert(requestOrNotification, JsonRpcNotificationStruct);\n  } catch (error) {\n    const message = isErrorWithMessage(error) ? error.message : error;\n    throw new Error(`Not a JSON-RPC notification: ${message}.`);\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(\n  requestOrNotification: unknown,\n): requestOrNotification is JsonRpcRequest<JsonRpcParams> {\n  return is(requestOrNotification, JsonRpcRequestStruct);\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(\n  requestOrNotification: unknown,\n): asserts requestOrNotification is JsonRpcRequest<JsonRpcParams> {\n  try {\n    assert(requestOrNotification, JsonRpcRequestStruct);\n  } catch (error) {\n    const message = isErrorWithMessage(error) ? error.message : error;\n    throw new Error(`Not a JSON-RPC request: ${message}.`);\n  }\n}\n\nexport const JsonRpcSuccessStruct = object({\n  id: JsonRpcIdStruct,\n  jsonrpc: JsonRpcVersionStruct,\n  result: JsonStruct,\n});\n\n/**\n * A successful JSON-RPC response object.\n */\nexport type JsonRpcSuccess<Result extends Json> = Omit<\n  Infer<typeof JsonRpcSuccessStruct>,\n  'result'\n> & {\n  result: Result;\n};\n\nexport const JsonRpcFailureStruct = object({\n  id: JsonRpcIdStruct,\n  jsonrpc: JsonRpcVersionStruct,\n  error: JsonRpcErrorStruct,\n});\n\n/**\n * A failed JSON-RPC response object.\n */\nexport type JsonRpcFailure = Infer<typeof JsonRpcFailureStruct>;\n\nexport const JsonRpcResponseStruct = union([\n  JsonRpcSuccessStruct,\n  JsonRpcFailureStruct,\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 extends Json> =\n  | JsonRpcSuccess<Result>\n  | JsonRpcFailure;\n\n/**\n * Type guard to check if a value is a JsonRpcResponse.\n *\n * @param response - The object to check.\n * @returns Whether the object is a JsonRpcResponse.\n */\nexport function isJsonRpcResponse(\n  response: unknown,\n): response is JsonRpcResponse<Json> {\n  return is(response, JsonRpcResponseStruct);\n}\n\n/**\n * Type assertion to check if a value is a JsonRpcResponse.\n *\n * @param response - The response to check.\n */\nexport function assertIsJsonRpcResponse(\n  response: unknown,\n): asserts response is JsonRpcResponse<Json> {\n  try {\n    assert(response, JsonRpcResponseStruct);\n  } catch (error) {\n    const message = isErrorWithMessage(error) ? error.message : error;\n    throw new Error(`Not a JSON-RPC response: ${message}.`);\n  }\n}\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.\n */\nexport function isJsonRpcSuccess(\n  response: unknown,\n): response is JsonRpcSuccess<Json> {\n  return is(response, JsonRpcSuccessStruct);\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(\n  response: unknown,\n): asserts response is JsonRpcSuccess<Json> {\n  try {\n    assert(response, JsonRpcSuccessStruct);\n  } catch (error) {\n    const message = isErrorWithMessage(error) ? error.message : error;\n    throw new Error(`Not a successful JSON-RPC response: ${message}.`);\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: unknown,\n): response is JsonRpcFailure {\n  return is(response, JsonRpcFailureStruct);\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: unknown,\n): asserts response is JsonRpcFailure {\n  try {\n    assert(response, JsonRpcFailureStruct);\n  } catch (error) {\n    const message = isErrorWithMessage(error) ? error.message : error;\n    throw new Error(`Not a failed JSON-RPC response: ${message}.`);\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\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/logging.d.ts

@@ -0,0 +1,29 @@
+import { Debugger } from 'debug';
+/**
+ * Creates a logger via the `debug` library whose log messages will be tagged
+ * using the name of your project. By default, such messages will be
+ * suppressed, but you can reveal them by setting the `DEBUG` environment
+ * variable to `metamask:<projectName>`. You can also set this variable to
+ * `metamask:*` if you want to see log messages from all MetaMask projects that
+ * are also using this function to create their loggers.
+ *
+ * @param projectName - The name of your project. This should be the name of
+ * your NPM package if you're developing one.
+ * @returns An instance of `debug`.
+ */
+export declare function createProjectLogger(projectName: string): Debugger;
+/**
+ * Creates a logger via the `debug` library which is derived from the logger for
+ * the whole project whose log messages will be tagged using the name of your
+ * module. By default, such messages will be suppressed, but you can reveal them
+ * by setting the `DEBUG` environment variable to
+ * `metamask:<projectName>:<moduleName>`. You can also set this variable to
+ * `metamask:<projectName>:*` if you want to see log messages from the project,
+ * or `metamask:*` if you want to see log messages from all MetaMask projects.
+ *
+ * @param projectLogger - The logger created via {@link createProjectLogger}.
+ * @param moduleName - The name of your module. You could use the name of the
+ * file where you're using this logger or some other name.
+ * @returns An instance of `debug`.
+ */
+export declare function createModuleLogger(projectLogger: Debugger, moduleName: string): Debugger;

package/dist/logging.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createModuleLogger = exports.createProjectLogger = void 0;
+const debug_1 = __importDefault(require("debug"));
+const globalLogger = (0, debug_1.default)('metamask');
+/**
+ * Creates a logger via the `debug` library whose log messages will be tagged
+ * using the name of your project. By default, such messages will be
+ * suppressed, but you can reveal them by setting the `DEBUG` environment
+ * variable to `metamask:<projectName>`. You can also set this variable to
+ * `metamask:*` if you want to see log messages from all MetaMask projects that
+ * are also using this function to create their loggers.
+ *
+ * @param projectName - The name of your project. This should be the name of
+ * your NPM package if you're developing one.
+ * @returns An instance of `debug`.
+ */
+function createProjectLogger(projectName) {
+    return globalLogger.extend(projectName);
+}
+exports.createProjectLogger = createProjectLogger;
+/**
+ * Creates a logger via the `debug` library which is derived from the logger for
+ * the whole project whose log messages will be tagged using the name of your
+ * module. By default, such messages will be suppressed, but you can reveal them
+ * by setting the `DEBUG` environment variable to
+ * `metamask:<projectName>:<moduleName>`. You can also set this variable to
+ * `metamask:<projectName>:*` if you want to see log messages from the project,
+ * or `metamask:*` if you want to see log messages from all MetaMask projects.
+ *
+ * @param projectLogger - The logger created via {@link createProjectLogger}.
+ * @param moduleName - The name of your module. You could use the name of the
+ * file where you're using this logger or some other name.
+ * @returns An instance of `debug`.
+ */
+function createModuleLogger(projectLogger, moduleName) {
+    return projectLogger.extend(moduleName);
+}
+exports.createModuleLogger = createModuleLogger;
+//# sourceMappingURL=logging.js.map

package/dist/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAwC;AAExC,MAAM,YAAY,GAAG,IAAA,eAAK,EAAC,UAAU,CAAC,CAAC;AAEvC;;;;;;;;;;;GAWG;AACH,SAAgB,mBAAmB,CAAC,WAAmB;IACrD,OAAO,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;AAC1C,CAAC;AAFD,kDAEC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,kBAAkB,CAChC,aAAuB,EACvB,UAAkB;IAElB,OAAO,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAC1C,CAAC;AALD,gDAKC","sourcesContent":["import debug, { Debugger } from 'debug';\n\nconst globalLogger = debug('metamask');\n\n/**\n * Creates a logger via the `debug` library whose log messages will be tagged\n * using the name of your project. By default, such messages will be\n * suppressed, but you can reveal them by setting the `DEBUG` environment\n * variable to `metamask:<projectName>`. You can also set this variable to\n * `metamask:*` if you want to see log messages from all MetaMask projects that\n * are also using this function to create their loggers.\n *\n * @param projectName - The name of your project. This should be the name of\n * your NPM package if you're developing one.\n * @returns An instance of `debug`.\n */\nexport function createProjectLogger(projectName: string): Debugger {\n  return globalLogger.extend(projectName);\n}\n\n/**\n * Creates a logger via the `debug` library which is derived from the logger for\n * the whole project whose log messages will be tagged using the name of your\n * module. By default, such messages will be suppressed, but you can reveal them\n * by setting the `DEBUG` environment variable to\n * `metamask:<projectName>:<moduleName>`. You can also set this variable to\n * `metamask:<projectName>:*` if you want to see log messages from the project,\n * or `metamask:*` if you want to see log messages from all MetaMask projects.\n *\n * @param projectLogger - The logger created via {@link createProjectLogger}.\n * @param moduleName - The name of your module. You could use the name of the\n * file where you're using this logger or some other name.\n * @returns An instance of `debug`.\n */\nexport function createModuleLogger(\n  projectLogger: Debugger,\n  moduleName: string,\n): Debugger {\n  return projectLogger.extend(moduleName);\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;