@metamask/utils 3.1.0 → 3.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +102 -0
- package/dist/assert.d.ts +26 -2
- package/dist/assert.js +86 -4
- package/dist/assert.js.map +1 -1
- package/dist/bytes.d.ts +31 -1
- package/dist/bytes.js +46 -2
- package/dist/bytes.js.map +1 -1
- package/dist/coercers.d.ts +96 -0
- package/dist/coercers.js +162 -0
- package/dist/coercers.js.map +1 -0
- package/dist/hex.d.ts +21 -1
- package/dist/hex.js +30 -4
- package/dist/hex.js.map +1 -1
- package/dist/hex.test-d.d.ts +1 -0
- package/dist/hex.test-d.js +16 -0
- package/dist/hex.test-d.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/json.d.ts +122 -42
- package/dist/json.js +122 -121
- package/dist/json.js.map +1 -1
- package/dist/json.test-d.d.ts +1 -0
- package/dist/json.test-d.js +62 -0
- package/dist/json.test-d.js.map +1 -0
- package/dist/number.d.ts +72 -0
- package/dist/number.js +102 -0
- package/dist/number.js.map +1 -0
- package/package.json +9 -4
package/dist/json.js
CHANGED
|
@@ -1,44 +1,22 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
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;
|
|
7
|
-
const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
|
|
3
|
+
exports.validateJsonAndGetSize = exports.getJsonRpcIdValidator = exports.assertIsJsonRpcError = exports.isJsonRpcError = exports.assertIsJsonRpcFailure = exports.isJsonRpcFailure = exports.assertIsJsonRpcSuccess = exports.isJsonRpcSuccess = exports.assertIsJsonRpcResponse = exports.isJsonRpcResponse = exports.assertIsPendingJsonRpcResponse = exports.isPendingJsonRpcResponse = exports.JsonRpcResponseStruct = exports.JsonRpcFailureStruct = exports.JsonRpcSuccessStruct = exports.PendingJsonRpcResponseStruct = 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;
|
|
8
4
|
const superstruct_1 = require("superstruct");
|
|
9
5
|
const misc_1 = require("./misc");
|
|
6
|
+
const assert_1 = require("./assert");
|
|
7
|
+
exports.JsonStruct = (0, superstruct_1.define)('Json', (value) => {
|
|
8
|
+
const [isValid] = validateJsonAndGetSize(value, true);
|
|
9
|
+
return isValid;
|
|
10
|
+
});
|
|
10
11
|
/**
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* @param error - The object to check.
|
|
15
|
-
* @returns True or false, depending on the result.
|
|
16
|
-
*/
|
|
17
|
-
function isErrorWithMessage(error) {
|
|
18
|
-
return typeof error === 'object' && error !== null && 'message' in error;
|
|
19
|
-
}
|
|
20
|
-
// Note: This struct references itself, so TypeScript cannot infer the type.
|
|
21
|
-
exports.JsonStruct = (0, superstruct_1.union)([
|
|
22
|
-
(0, superstruct_1.literal)(null),
|
|
23
|
-
(0, superstruct_1.boolean)(),
|
|
24
|
-
(0, superstruct_1.number)(),
|
|
25
|
-
(0, superstruct_1.string)(),
|
|
26
|
-
(0, superstruct_1.lazy)(() => (0, superstruct_1.array)(exports.JsonStruct)),
|
|
27
|
-
(0, superstruct_1.lazy)(() => (0, superstruct_1.record)((0, superstruct_1.string)(), exports.JsonStruct)),
|
|
28
|
-
]);
|
|
29
|
-
/**
|
|
30
|
-
* Type guard for {@link Json}.
|
|
12
|
+
* Check if the given value is a valid {@link Json} value, i.e., a value that is
|
|
13
|
+
* serializable to JSON.
|
|
31
14
|
*
|
|
32
15
|
* @param value - The value to check.
|
|
33
|
-
* @returns Whether the value is valid
|
|
16
|
+
* @returns Whether the value is a valid {@link Json} value.
|
|
34
17
|
*/
|
|
35
18
|
function isValidJson(value) {
|
|
36
|
-
|
|
37
|
-
return (0, fast_deep_equal_1.default)(value, JSON.parse(JSON.stringify(value)));
|
|
38
|
-
}
|
|
39
|
-
catch (_) {
|
|
40
|
-
return false;
|
|
41
|
-
}
|
|
19
|
+
return (0, superstruct_1.is)(value, exports.JsonStruct);
|
|
42
20
|
}
|
|
43
21
|
exports.isValidJson = isValidJson;
|
|
44
22
|
/**
|
|
@@ -48,9 +26,9 @@ exports.jsonrpc2 = '2.0';
|
|
|
48
26
|
exports.JsonRpcVersionStruct = (0, superstruct_1.literal)(exports.jsonrpc2);
|
|
49
27
|
exports.JsonRpcIdStruct = (0, superstruct_1.nullable)((0, superstruct_1.union)([(0, superstruct_1.number)(), (0, superstruct_1.string)()]));
|
|
50
28
|
exports.JsonRpcErrorStruct = (0, superstruct_1.object)({
|
|
51
|
-
code: (0, superstruct_1.
|
|
29
|
+
code: (0, superstruct_1.integer)(),
|
|
52
30
|
message: (0, superstruct_1.string)(),
|
|
53
|
-
data: (0, superstruct_1.optional)(
|
|
31
|
+
data: (0, superstruct_1.optional)(exports.JsonStruct),
|
|
54
32
|
stack: (0, superstruct_1.optional)((0, superstruct_1.string)()),
|
|
55
33
|
});
|
|
56
34
|
exports.JsonRpcParamsStruct = (0, superstruct_1.optional)((0, superstruct_1.union)([(0, superstruct_1.object)(), (0, superstruct_1.array)()]));
|
|
@@ -62,58 +40,56 @@ exports.JsonRpcRequestStruct = (0, superstruct_1.object)({
|
|
|
62
40
|
});
|
|
63
41
|
exports.JsonRpcNotificationStruct = (0, superstruct_1.omit)(exports.JsonRpcRequestStruct, ['id']);
|
|
64
42
|
/**
|
|
65
|
-
*
|
|
66
|
-
* notification.
|
|
43
|
+
* Check if the given value is a valid {@link JsonRpcNotification} object.
|
|
67
44
|
*
|
|
68
|
-
* @param
|
|
69
|
-
* @returns Whether the
|
|
45
|
+
* @param value - The value to check.
|
|
46
|
+
* @returns Whether the given value is a valid {@link JsonRpcNotification}
|
|
47
|
+
* object.
|
|
70
48
|
*/
|
|
71
|
-
function isJsonRpcNotification(
|
|
72
|
-
return (0, superstruct_1.is)(
|
|
49
|
+
function isJsonRpcNotification(value) {
|
|
50
|
+
return (0, superstruct_1.is)(value, exports.JsonRpcNotificationStruct);
|
|
73
51
|
}
|
|
74
52
|
exports.isJsonRpcNotification = isJsonRpcNotification;
|
|
75
53
|
/**
|
|
76
|
-
*
|
|
77
|
-
* notification.
|
|
54
|
+
* Assert that the given value is a valid {@link JsonRpcNotification} object.
|
|
78
55
|
*
|
|
79
|
-
* @param
|
|
56
|
+
* @param value - The value to check.
|
|
57
|
+
* @param ErrorWrapper - The error class to throw if the assertion fails.
|
|
58
|
+
* Defaults to {@link AssertionError}.
|
|
59
|
+
* @throws If the given value is not a valid {@link JsonRpcNotification} object.
|
|
80
60
|
*/
|
|
81
|
-
function assertIsJsonRpcNotification(
|
|
82
|
-
|
|
83
|
-
(0, superstruct_1.assert)(requestOrNotification, exports.JsonRpcNotificationStruct);
|
|
84
|
-
}
|
|
85
|
-
catch (error) {
|
|
86
|
-
const message = isErrorWithMessage(error) ? error.message : error;
|
|
87
|
-
throw new Error(`Not a JSON-RPC notification: ${message}.`);
|
|
88
|
-
}
|
|
61
|
+
function assertIsJsonRpcNotification(value, ErrorWrapper) {
|
|
62
|
+
(0, assert_1.assertStruct)(value, exports.JsonRpcNotificationStruct, 'Invalid JSON-RPC notification', ErrorWrapper);
|
|
89
63
|
}
|
|
90
64
|
exports.assertIsJsonRpcNotification = assertIsJsonRpcNotification;
|
|
91
65
|
/**
|
|
92
|
-
*
|
|
66
|
+
* Check if the given value is a valid {@link JsonRpcRequest} object.
|
|
93
67
|
*
|
|
94
|
-
* @param
|
|
95
|
-
* @returns Whether the
|
|
68
|
+
* @param value - The value to check.
|
|
69
|
+
* @returns Whether the given value is a valid {@link JsonRpcRequest} object.
|
|
96
70
|
*/
|
|
97
|
-
function isJsonRpcRequest(
|
|
98
|
-
return (0, superstruct_1.is)(
|
|
71
|
+
function isJsonRpcRequest(value) {
|
|
72
|
+
return (0, superstruct_1.is)(value, exports.JsonRpcRequestStruct);
|
|
99
73
|
}
|
|
100
74
|
exports.isJsonRpcRequest = isJsonRpcRequest;
|
|
101
75
|
/**
|
|
102
|
-
*
|
|
103
|
-
* request.
|
|
76
|
+
* Assert that the given value is a valid {@link JsonRpcRequest} object.
|
|
104
77
|
*
|
|
105
|
-
* @param
|
|
78
|
+
* @param value - The JSON-RPC request or notification to check.
|
|
79
|
+
* @param ErrorWrapper - The error class to throw if the assertion fails.
|
|
80
|
+
* Defaults to {@link AssertionError}.
|
|
81
|
+
* @throws If the given value is not a valid {@link JsonRpcRequest} object.
|
|
106
82
|
*/
|
|
107
|
-
function assertIsJsonRpcRequest(
|
|
108
|
-
|
|
109
|
-
(0, superstruct_1.assert)(requestOrNotification, exports.JsonRpcRequestStruct);
|
|
110
|
-
}
|
|
111
|
-
catch (error) {
|
|
112
|
-
const message = isErrorWithMessage(error) ? error.message : error;
|
|
113
|
-
throw new Error(`Not a JSON-RPC request: ${message}.`);
|
|
114
|
-
}
|
|
83
|
+
function assertIsJsonRpcRequest(value, ErrorWrapper) {
|
|
84
|
+
(0, assert_1.assertStruct)(value, exports.JsonRpcRequestStruct, 'Invalid JSON-RPC request', ErrorWrapper);
|
|
115
85
|
}
|
|
116
86
|
exports.assertIsJsonRpcRequest = assertIsJsonRpcRequest;
|
|
87
|
+
exports.PendingJsonRpcResponseStruct = (0, superstruct_1.object)({
|
|
88
|
+
id: exports.JsonRpcIdStruct,
|
|
89
|
+
jsonrpc: exports.JsonRpcVersionStruct,
|
|
90
|
+
result: (0, superstruct_1.optional)((0, superstruct_1.unknown)()),
|
|
91
|
+
error: (0, superstruct_1.optional)(exports.JsonRpcErrorStruct),
|
|
92
|
+
});
|
|
117
93
|
exports.JsonRpcSuccessStruct = (0, superstruct_1.object)({
|
|
118
94
|
id: exports.JsonRpcIdStruct,
|
|
119
95
|
jsonrpc: exports.JsonRpcVersionStruct,
|
|
@@ -129,7 +105,31 @@ exports.JsonRpcResponseStruct = (0, superstruct_1.union)([
|
|
|
129
105
|
exports.JsonRpcFailureStruct,
|
|
130
106
|
]);
|
|
131
107
|
/**
|
|
132
|
-
* Type guard to check
|
|
108
|
+
* Type guard to check whether specified JSON-RPC response is a
|
|
109
|
+
* {@link PendingJsonRpcResponse}.
|
|
110
|
+
*
|
|
111
|
+
* @param response - The JSON-RPC response to check.
|
|
112
|
+
* @returns Whether the specified JSON-RPC response is pending.
|
|
113
|
+
*/
|
|
114
|
+
function isPendingJsonRpcResponse(response) {
|
|
115
|
+
return (0, superstruct_1.is)(response, exports.PendingJsonRpcResponseStruct);
|
|
116
|
+
}
|
|
117
|
+
exports.isPendingJsonRpcResponse = isPendingJsonRpcResponse;
|
|
118
|
+
/**
|
|
119
|
+
* Assert that the given value is a valid {@link PendingJsonRpcResponse} object.
|
|
120
|
+
*
|
|
121
|
+
* @param response - The JSON-RPC response to check.
|
|
122
|
+
* @param ErrorWrapper - The error class to throw if the assertion fails.
|
|
123
|
+
* Defaults to {@link AssertionError}.
|
|
124
|
+
* @throws If the given value is not a valid {@link PendingJsonRpcResponse}
|
|
125
|
+
* object.
|
|
126
|
+
*/
|
|
127
|
+
function assertIsPendingJsonRpcResponse(response, ErrorWrapper) {
|
|
128
|
+
(0, assert_1.assertStruct)(response, exports.PendingJsonRpcResponseStruct, 'Invalid pending JSON-RPC response', ErrorWrapper);
|
|
129
|
+
}
|
|
130
|
+
exports.assertIsPendingJsonRpcResponse = assertIsPendingJsonRpcResponse;
|
|
131
|
+
/**
|
|
132
|
+
* Type guard to check if a value is a {@link JsonRpcResponse}.
|
|
133
133
|
*
|
|
134
134
|
* @param response - The object to check.
|
|
135
135
|
* @returns Whether the object is a JsonRpcResponse.
|
|
@@ -139,71 +139,83 @@ function isJsonRpcResponse(response) {
|
|
|
139
139
|
}
|
|
140
140
|
exports.isJsonRpcResponse = isJsonRpcResponse;
|
|
141
141
|
/**
|
|
142
|
-
*
|
|
142
|
+
* Assert that the given value is a valid {@link JsonRpcResponse} object.
|
|
143
143
|
*
|
|
144
|
-
* @param
|
|
144
|
+
* @param value - The value to check.
|
|
145
|
+
* @param ErrorWrapper - The error class to throw if the assertion fails.
|
|
146
|
+
* Defaults to {@link AssertionError}.
|
|
147
|
+
* @throws If the given value is not a valid {@link JsonRpcResponse} object.
|
|
145
148
|
*/
|
|
146
|
-
function assertIsJsonRpcResponse(
|
|
147
|
-
|
|
148
|
-
(0, superstruct_1.assert)(response, exports.JsonRpcResponseStruct);
|
|
149
|
-
}
|
|
150
|
-
catch (error) {
|
|
151
|
-
const message = isErrorWithMessage(error) ? error.message : error;
|
|
152
|
-
throw new Error(`Not a JSON-RPC response: ${message}.`);
|
|
153
|
-
}
|
|
149
|
+
function assertIsJsonRpcResponse(value, ErrorWrapper) {
|
|
150
|
+
(0, assert_1.assertStruct)(value, exports.JsonRpcResponseStruct, 'Invalid JSON-RPC response', ErrorWrapper);
|
|
154
151
|
}
|
|
155
152
|
exports.assertIsJsonRpcResponse = assertIsJsonRpcResponse;
|
|
156
153
|
/**
|
|
157
|
-
*
|
|
154
|
+
* Check if the given value is a valid {@link JsonRpcSuccess} object.
|
|
158
155
|
*
|
|
159
|
-
* @param
|
|
160
|
-
* @returns Whether the
|
|
156
|
+
* @param value - The value to check.
|
|
157
|
+
* @returns Whether the given value is a valid {@link JsonRpcSuccess} object.
|
|
161
158
|
*/
|
|
162
|
-
function isJsonRpcSuccess(
|
|
163
|
-
return (0, superstruct_1.is)(
|
|
159
|
+
function isJsonRpcSuccess(value) {
|
|
160
|
+
return (0, superstruct_1.is)(value, exports.JsonRpcSuccessStruct);
|
|
164
161
|
}
|
|
165
162
|
exports.isJsonRpcSuccess = isJsonRpcSuccess;
|
|
166
163
|
/**
|
|
167
|
-
*
|
|
164
|
+
* Assert that the given value is a valid {@link JsonRpcSuccess} object.
|
|
168
165
|
*
|
|
169
|
-
* @param
|
|
166
|
+
* @param value - The value to check.
|
|
167
|
+
* @param ErrorWrapper - The error class to throw if the assertion fails.
|
|
168
|
+
* Defaults to {@link AssertionError}.
|
|
169
|
+
* @throws If the given value is not a valid {@link JsonRpcSuccess} object.
|
|
170
170
|
*/
|
|
171
|
-
function assertIsJsonRpcSuccess(
|
|
172
|
-
|
|
173
|
-
(0, superstruct_1.assert)(response, exports.JsonRpcSuccessStruct);
|
|
174
|
-
}
|
|
175
|
-
catch (error) {
|
|
176
|
-
const message = isErrorWithMessage(error) ? error.message : error;
|
|
177
|
-
throw new Error(`Not a successful JSON-RPC response: ${message}.`);
|
|
178
|
-
}
|
|
171
|
+
function assertIsJsonRpcSuccess(value, ErrorWrapper) {
|
|
172
|
+
(0, assert_1.assertStruct)(value, exports.JsonRpcSuccessStruct, 'Invalid JSON-RPC success response', ErrorWrapper);
|
|
179
173
|
}
|
|
180
174
|
exports.assertIsJsonRpcSuccess = assertIsJsonRpcSuccess;
|
|
181
175
|
/**
|
|
182
|
-
*
|
|
176
|
+
* Check if the given value is a valid {@link JsonRpcFailure} object.
|
|
183
177
|
*
|
|
184
|
-
* @param
|
|
185
|
-
* @returns Whether the
|
|
186
|
-
* property.
|
|
178
|
+
* @param value - The value to check.
|
|
179
|
+
* @returns Whether the given value is a valid {@link JsonRpcFailure} object.
|
|
187
180
|
*/
|
|
188
|
-
function isJsonRpcFailure(
|
|
189
|
-
return (0, superstruct_1.is)(
|
|
181
|
+
function isJsonRpcFailure(value) {
|
|
182
|
+
return (0, superstruct_1.is)(value, exports.JsonRpcFailureStruct);
|
|
190
183
|
}
|
|
191
184
|
exports.isJsonRpcFailure = isJsonRpcFailure;
|
|
192
185
|
/**
|
|
193
|
-
*
|
|
186
|
+
* Assert that the given value is a valid {@link JsonRpcFailure} object.
|
|
194
187
|
*
|
|
195
|
-
* @param
|
|
188
|
+
* @param value - The value to check.
|
|
189
|
+
* @param ErrorWrapper - The error class to throw if the assertion fails.
|
|
190
|
+
* Defaults to {@link AssertionError}.
|
|
191
|
+
* @throws If the given value is not a valid {@link JsonRpcFailure} object.
|
|
196
192
|
*/
|
|
197
|
-
function assertIsJsonRpcFailure(
|
|
198
|
-
|
|
199
|
-
(0, superstruct_1.assert)(response, exports.JsonRpcFailureStruct);
|
|
200
|
-
}
|
|
201
|
-
catch (error) {
|
|
202
|
-
const message = isErrorWithMessage(error) ? error.message : error;
|
|
203
|
-
throw new Error(`Not a failed JSON-RPC response: ${message}.`);
|
|
204
|
-
}
|
|
193
|
+
function assertIsJsonRpcFailure(value, ErrorWrapper) {
|
|
194
|
+
(0, assert_1.assertStruct)(value, exports.JsonRpcFailureStruct, 'Invalid JSON-RPC failure response', ErrorWrapper);
|
|
205
195
|
}
|
|
206
196
|
exports.assertIsJsonRpcFailure = assertIsJsonRpcFailure;
|
|
197
|
+
/**
|
|
198
|
+
* Check if the given value is a valid {@link JsonRpcError} object.
|
|
199
|
+
*
|
|
200
|
+
* @param value - The value to check.
|
|
201
|
+
* @returns Whether the given value is a valid {@link JsonRpcError} object.
|
|
202
|
+
*/
|
|
203
|
+
function isJsonRpcError(value) {
|
|
204
|
+
return (0, superstruct_1.is)(value, exports.JsonRpcErrorStruct);
|
|
205
|
+
}
|
|
206
|
+
exports.isJsonRpcError = isJsonRpcError;
|
|
207
|
+
/**
|
|
208
|
+
* Assert that the given value is a valid {@link JsonRpcError} object.
|
|
209
|
+
*
|
|
210
|
+
* @param value - The value to check.
|
|
211
|
+
* @param ErrorWrapper - The error class to throw if the assertion fails.
|
|
212
|
+
* Defaults to {@link AssertionError}.
|
|
213
|
+
* @throws If the given value is not a valid {@link JsonRpcError} object.
|
|
214
|
+
*/
|
|
215
|
+
function assertIsJsonRpcError(value, ErrorWrapper) {
|
|
216
|
+
(0, assert_1.assertStruct)(value, exports.JsonRpcErrorStruct, 'Invalid JSON-RPC error', ErrorWrapper);
|
|
217
|
+
}
|
|
218
|
+
exports.assertIsJsonRpcError = assertIsJsonRpcError;
|
|
207
219
|
/**
|
|
208
220
|
* Gets a function for validating JSON-RPC request / response `id` values.
|
|
209
221
|
*
|
|
@@ -268,8 +280,7 @@ function validateJsonAndGetSize(jsObject, skipSizingProcess = false) {
|
|
|
268
280
|
*/
|
|
269
281
|
function getJsonSerializableInfo(value, skipSizing) {
|
|
270
282
|
if (value === undefined) {
|
|
271
|
-
|
|
272
|
-
return [true, 0];
|
|
283
|
+
return [false, 0];
|
|
273
284
|
}
|
|
274
285
|
else if (value === null) {
|
|
275
286
|
// Return already specified constant size for null (special object)
|
|
@@ -349,16 +360,6 @@ function validateJsonAndGetSize(jsObject, skipSizingProcess = false) {
|
|
|
349
360
|
if (skipSizing) {
|
|
350
361
|
return 0;
|
|
351
362
|
}
|
|
352
|
-
// If the size is 0, the value is undefined and undefined in an array
|
|
353
|
-
// when serialized will be replaced with null
|
|
354
|
-
if (size === 0 && Array.isArray(value)) {
|
|
355
|
-
size = misc_1.JsonSize.Null;
|
|
356
|
-
}
|
|
357
|
-
// If the size is 0, that means the object is undefined and
|
|
358
|
-
// the rest of the object structure will be omitted
|
|
359
|
-
if (size === 0) {
|
|
360
|
-
return sum;
|
|
361
|
-
}
|
|
362
363
|
// Objects will have be serialized with "key": value,
|
|
363
364
|
// therefore we include the key in the calculation here
|
|
364
365
|
const keySize = Array.isArray(value)
|
package/dist/json.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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;AAsBU,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;AAsBU,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,0BAA0C;CAClD,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 * Mark a certain key of a type as optional.\n */\nexport type OptionalField<\n Type extends Record<string, unknown>,\n Key extends keyof Type,\n> = Omit<Type, Key> & Partial<Pick<Type, Key>>;\n\n/**\n * A JSON-RPC error object.\n *\n * Note that TypeScript infers `unknown | undefined` as `unknown`, meaning that\n * the `data` field is not optional. To make it optional, we use the\n * `OptionalField` helper, to explicitly make it optional.\n */\nexport type JsonRpcError = OptionalField<\n Infer<typeof JsonRpcErrorStruct>,\n 'data'\n>;\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 (keyof Params extends undefined\n ? {\n params?: Params;\n }\n : {\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 as Struct<JsonRpcError>,\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"]}
|
|
1
|
+
{"version":3,"file":"json.js","sourceRoot":"","sources":["../src/json.ts"],"names":[],"mappings":";;;AAAA,6CAgBqB;AACrB,iCAKgB;AAChB,qCAAmE;AAEtD,QAAA,UAAU,GAAG,IAAA,oBAAM,EAAO,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;IACvD,MAAM,CAAC,OAAO,CAAC,GAAG,sBAAsB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACtD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC,CAAC;AAaH;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,kBAAU,CAAC,CAAC;AAC/B,CAAC;AAFD,kCAEC;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,qBAAO,GAAE;IACf,OAAO,EAAE,IAAA,oBAAM,GAAE;IACjB,IAAI,EAAE,IAAA,sBAAQ,EAAC,kBAAU,CAAC;IAC1B,KAAK,EAAE,IAAA,sBAAQ,EAAC,IAAA,oBAAM,GAAE,CAAC;CAC1B,CAAC,CAAC;AAsBU,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;AAsBU,QAAA,yBAAyB,GAAG,IAAA,kBAAI,EAAC,4BAAoB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;AAU5E;;;;;;GAMG;AACH,SAAgB,qBAAqB,CACnC,KAAc;IAEd,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,iCAAyB,CAAC,CAAC;AAC9C,CAAC;AAJD,sDAIC;AAED;;;;;;;GAOG;AACH,SAAgB,2BAA2B,CACzC,KAAc,EACd,YAAwC;IAExC,IAAA,qBAAY,EACV,KAAK,EACL,iCAAyB,EACzB,+BAA+B,EAC/B,YAAY,CACb,CAAC;AACJ,CAAC;AAVD,kEAUC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAC9B,KAAc;IAEd,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,4BAAoB,CAAC,CAAC;AACzC,CAAC;AAJD,4CAIC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,KAAc,EACd,YAAwC;IAExC,IAAA,qBAAY,EACV,KAAK,EACL,4BAAoB,EACpB,0BAA0B,EAC1B,YAAY,CACb,CAAC;AACJ,CAAC;AAVD,wDAUC;AAEY,QAAA,4BAA4B,GAAG,IAAA,oBAAM,EAAC;IACjD,EAAE,EAAE,uBAAe;IACnB,OAAO,EAAE,4BAAoB;IAC7B,MAAM,EAAE,IAAA,sBAAQ,EAAC,IAAA,qBAAO,GAAE,CAAC;IAC3B,KAAK,EAAE,IAAA,sBAAQ,EAAC,0BAAkB,CAAC;CACpC,CAAC,CAAC;AAYU,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,0BAA0C;CAClD,CAAC,CAAC;AAOU,QAAA,qBAAqB,GAAG,IAAA,mBAAK,EAAC;IACzC,4BAAoB;IACpB,4BAAoB;CACrB,CAAC,CAAC;AAYH;;;;;;GAMG;AACH,SAAgB,wBAAwB,CACtC,QAAiB;IAEjB,OAAO,IAAA,gBAAE,EAAC,QAAQ,EAAE,oCAA4B,CAAC,CAAC;AACpD,CAAC;AAJD,4DAIC;AAED;;;;;;;;GAQG;AACH,SAAgB,8BAA8B,CAC5C,QAAiB,EACjB,YAAwC;IAExC,IAAA,qBAAY,EACV,QAAQ,EACR,oCAA4B,EAC5B,mCAAmC,EACnC,YAAY,CACb,CAAC;AACJ,CAAC;AAVD,wEAUC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,QAAiB;IAEjB,OAAO,IAAA,gBAAE,EAAC,QAAQ,EAAE,6BAAqB,CAAC,CAAC;AAC7C,CAAC;AAJD,8CAIC;AAED;;;;;;;GAOG;AACH,SAAgB,uBAAuB,CACrC,KAAc,EACd,YAAwC;IAExC,IAAA,qBAAY,EACV,KAAK,EACL,6BAAqB,EACrB,2BAA2B,EAC3B,YAAY,CACb,CAAC;AACJ,CAAC;AAVD,0DAUC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAC9B,KAAc;IAEd,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,4BAAoB,CAAC,CAAC;AACzC,CAAC;AAJD,4CAIC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,KAAc,EACd,YAAwC;IAExC,IAAA,qBAAY,EACV,KAAK,EACL,4BAAoB,EACpB,mCAAmC,EACnC,YAAY,CACb,CAAC;AACJ,CAAC;AAVD,wDAUC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,KAAc;IAC7C,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,4BAAoB,CAAC,CAAC;AACzC,CAAC;AAFD,4CAEC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CACpC,KAAc,EACd,YAAwC;IAExC,IAAA,qBAAY,EACV,KAAK,EACL,4BAAoB,EACpB,mCAAmC,EACnC,YAAY,CACb,CAAC;AACJ,CAAC;AAVD,wDAUC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,KAAc;IAC3C,OAAO,IAAA,gBAAE,EAAC,KAAK,EAAE,0BAAkB,CAAC,CAAC;AACvC,CAAC;AAFD,wCAEC;AAED;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAClC,KAAc,EACd,YAAwC;IAExC,IAAA,qBAAY,EACV,KAAK,EACL,0BAAkB,EAClB,wBAAwB,EACxB,YAAY,CACb,CAAC;AACJ,CAAC;AAVD,oDAUC;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,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;SACnB;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,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;AAjID,wDAiIC","sourcesContent":["import {\n array,\n define,\n Infer,\n integer,\n is,\n literal,\n nullable,\n number,\n object,\n omit,\n optional,\n string,\n Struct,\n union,\n unknown,\n} from 'superstruct';\nimport {\n calculateNumberSize,\n calculateStringSize,\n isPlainObject,\n JsonSize,\n} from './misc';\nimport { AssertionErrorConstructor, assertStruct } from './assert';\n\nexport const JsonStruct = define<Json>('Json', (value) => {\n const [isValid] = validateJsonAndGetSize(value, true);\n return isValid;\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 * Check if the given value is a valid {@link Json} value, i.e., a value that is\n * serializable to JSON.\n *\n * @param value - The value to check.\n * @returns Whether the value is a valid {@link Json} value.\n */\nexport function isValidJson(value: unknown): value is Json {\n return is(value, JsonStruct);\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: integer(),\n message: string(),\n data: optional(JsonStruct),\n stack: optional(string()),\n});\n\n/**\n * Mark a certain key of a type as optional.\n */\nexport type OptionalField<\n Type extends Record<string, unknown>,\n Key extends keyof Type,\n> = Omit<Type, Key> & Partial<Pick<Type, Key>>;\n\n/**\n * A JSON-RPC error object.\n *\n * Note that TypeScript infers `unknown | undefined` as `unknown`, meaning that\n * the `data` field is not optional. To make it optional, we use the\n * `OptionalField` helper, to explicitly make it optional.\n */\nexport type JsonRpcError = OptionalField<\n Infer<typeof JsonRpcErrorStruct>,\n 'data'\n>;\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 (keyof Params extends undefined\n ? {\n params?: Params;\n }\n : {\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 * Check if the given value is a valid {@link JsonRpcNotification} object.\n *\n * @param value - The value to check.\n * @returns Whether the given value is a valid {@link JsonRpcNotification}\n * object.\n */\nexport function isJsonRpcNotification(\n value: unknown,\n): value is JsonRpcNotification<JsonRpcParams> {\n return is(value, JsonRpcNotificationStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link JsonRpcNotification} object.\n *\n * @param value - The value to check.\n * @param ErrorWrapper - The error class to throw if the assertion fails.\n * Defaults to {@link AssertionError}.\n * @throws If the given value is not a valid {@link JsonRpcNotification} object.\n */\nexport function assertIsJsonRpcNotification(\n value: unknown,\n ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is JsonRpcNotification<JsonRpcParams> {\n assertStruct(\n value,\n JsonRpcNotificationStruct,\n 'Invalid JSON-RPC notification',\n ErrorWrapper,\n );\n}\n\n/**\n * Check if the given value is a valid {@link JsonRpcRequest} object.\n *\n * @param value - The value to check.\n * @returns Whether the given value is a valid {@link JsonRpcRequest} object.\n */\nexport function isJsonRpcRequest(\n value: unknown,\n): value is JsonRpcRequest<JsonRpcParams> {\n return is(value, JsonRpcRequestStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link JsonRpcRequest} object.\n *\n * @param value - The JSON-RPC request or notification to check.\n * @param ErrorWrapper - The error class to throw if the assertion fails.\n * Defaults to {@link AssertionError}.\n * @throws If the given value is not a valid {@link JsonRpcRequest} object.\n */\nexport function assertIsJsonRpcRequest(\n value: unknown,\n ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is JsonRpcRequest<JsonRpcParams> {\n assertStruct(\n value,\n JsonRpcRequestStruct,\n 'Invalid JSON-RPC request',\n ErrorWrapper,\n );\n}\n\nexport const PendingJsonRpcResponseStruct = object({\n id: JsonRpcIdStruct,\n jsonrpc: JsonRpcVersionStruct,\n result: optional(unknown()),\n error: optional(JsonRpcErrorStruct),\n});\n\n/**\n * A JSON-RPC response object that has not yet been resolved.\n */\nexport type PendingJsonRpcResponse<Result extends Json> = Omit<\n Infer<typeof PendingJsonRpcResponseStruct>,\n 'result'\n> & {\n result?: Result;\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 as Struct<JsonRpcError>,\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 whether specified JSON-RPC response is a\n * {@link PendingJsonRpcResponse}.\n *\n * @param response - The JSON-RPC response to check.\n * @returns Whether the specified JSON-RPC response is pending.\n */\nexport function isPendingJsonRpcResponse(\n response: unknown,\n): response is PendingJsonRpcResponse<Json> {\n return is(response, PendingJsonRpcResponseStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link PendingJsonRpcResponse} object.\n *\n * @param response - The JSON-RPC response to check.\n * @param ErrorWrapper - The error class to throw if the assertion fails.\n * Defaults to {@link AssertionError}.\n * @throws If the given value is not a valid {@link PendingJsonRpcResponse}\n * object.\n */\nexport function assertIsPendingJsonRpcResponse(\n response: unknown,\n ErrorWrapper?: AssertionErrorConstructor,\n): asserts response is PendingJsonRpcResponse<Json> {\n assertStruct(\n response,\n PendingJsonRpcResponseStruct,\n 'Invalid pending JSON-RPC response',\n ErrorWrapper,\n );\n}\n\n/**\n * Type guard to check if a value is a {@link 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 * Assert that the given value is a valid {@link JsonRpcResponse} object.\n *\n * @param value - The value to check.\n * @param ErrorWrapper - The error class to throw if the assertion fails.\n * Defaults to {@link AssertionError}.\n * @throws If the given value is not a valid {@link JsonRpcResponse} object.\n */\nexport function assertIsJsonRpcResponse(\n value: unknown,\n ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is JsonRpcResponse<Json> {\n assertStruct(\n value,\n JsonRpcResponseStruct,\n 'Invalid JSON-RPC response',\n ErrorWrapper,\n );\n}\n\n/**\n * Check if the given value is a valid {@link JsonRpcSuccess} object.\n *\n * @param value - The value to check.\n * @returns Whether the given value is a valid {@link JsonRpcSuccess} object.\n */\nexport function isJsonRpcSuccess(\n value: unknown,\n): value is JsonRpcSuccess<Json> {\n return is(value, JsonRpcSuccessStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link JsonRpcSuccess} object.\n *\n * @param value - The value to check.\n * @param ErrorWrapper - The error class to throw if the assertion fails.\n * Defaults to {@link AssertionError}.\n * @throws If the given value is not a valid {@link JsonRpcSuccess} object.\n */\nexport function assertIsJsonRpcSuccess(\n value: unknown,\n ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is JsonRpcSuccess<Json> {\n assertStruct(\n value,\n JsonRpcSuccessStruct,\n 'Invalid JSON-RPC success response',\n ErrorWrapper,\n );\n}\n\n/**\n * Check if the given value is a valid {@link JsonRpcFailure} object.\n *\n * @param value - The value to check.\n * @returns Whether the given value is a valid {@link JsonRpcFailure} object.\n */\nexport function isJsonRpcFailure(value: unknown): value is JsonRpcFailure {\n return is(value, JsonRpcFailureStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link JsonRpcFailure} object.\n *\n * @param value - The value to check.\n * @param ErrorWrapper - The error class to throw if the assertion fails.\n * Defaults to {@link AssertionError}.\n * @throws If the given value is not a valid {@link JsonRpcFailure} object.\n */\nexport function assertIsJsonRpcFailure(\n value: unknown,\n ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is JsonRpcFailure {\n assertStruct(\n value,\n JsonRpcFailureStruct,\n 'Invalid JSON-RPC failure response',\n ErrorWrapper,\n );\n}\n\n/**\n * Check if the given value is a valid {@link JsonRpcError} object.\n *\n * @param value - The value to check.\n * @returns Whether the given value is a valid {@link JsonRpcError} object.\n */\nexport function isJsonRpcError(value: unknown): value is JsonRpcError {\n return is(value, JsonRpcErrorStruct);\n}\n\n/**\n * Assert that the given value is a valid {@link JsonRpcError} object.\n *\n * @param value - The value to check.\n * @param ErrorWrapper - The error class to throw if the assertion fails.\n * Defaults to {@link AssertionError}.\n * @throws If the given value is not a valid {@link JsonRpcError} object.\n */\nexport function assertIsJsonRpcError(\n value: unknown,\n ErrorWrapper?: AssertionErrorConstructor,\n): asserts value is JsonRpcError {\n assertStruct(\n value,\n JsonRpcErrorStruct,\n 'Invalid JSON-RPC error',\n ErrorWrapper,\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 [false, 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 // 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"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* eslint-disable @typescript-eslint/consistent-type-definitions */
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
const tsd_1 = require("tsd");
|
|
5
|
+
// Valid Json:
|
|
6
|
+
(0, tsd_1.expectAssignable)(null);
|
|
7
|
+
(0, tsd_1.expectAssignable)(false);
|
|
8
|
+
(0, tsd_1.expectAssignable)('');
|
|
9
|
+
(0, tsd_1.expectAssignable)(0);
|
|
10
|
+
(0, tsd_1.expectAssignable)([]);
|
|
11
|
+
(0, tsd_1.expectAssignable)({});
|
|
12
|
+
(0, tsd_1.expectAssignable)([0]);
|
|
13
|
+
(0, tsd_1.expectAssignable)({ a: 0 });
|
|
14
|
+
(0, tsd_1.expectAssignable)({ deeply: [{ nested: 1 }, 'mixed', 'types', 0] });
|
|
15
|
+
(0, tsd_1.expectAssignable)(['array', { nested: { mixed: true, types: null } }, 0]);
|
|
16
|
+
const jsonCompatibleType = { c: 0 };
|
|
17
|
+
(0, tsd_1.expectAssignable)(jsonCompatibleType);
|
|
18
|
+
// Invalid Json:
|
|
19
|
+
(0, tsd_1.expectNotAssignable)(undefined);
|
|
20
|
+
(0, tsd_1.expectNotAssignable)(new Date());
|
|
21
|
+
(0, tsd_1.expectNotAssignable)(() => 0);
|
|
22
|
+
(0, tsd_1.expectNotAssignable)(new Set());
|
|
23
|
+
(0, tsd_1.expectNotAssignable)(new Map());
|
|
24
|
+
(0, tsd_1.expectNotAssignable)(Symbol('test'));
|
|
25
|
+
(0, tsd_1.expectNotAssignable)({ a: new Date() });
|
|
26
|
+
(0, tsd_1.expectNotAssignable)(5);
|
|
27
|
+
const interfaceWithOptionalProperty = { a: 0 };
|
|
28
|
+
(0, tsd_1.expectNotAssignable)(interfaceWithOptionalProperty);
|
|
29
|
+
const interfaceWithDate = { a: new Date() };
|
|
30
|
+
(0, tsd_1.expectNotAssignable)(interfaceWithDate);
|
|
31
|
+
const interfaceWithOptionalDate = { a: new Date() };
|
|
32
|
+
(0, tsd_1.expectNotAssignable)(interfaceWithOptionalDate);
|
|
33
|
+
const interfaceWithUndefinedTypeUnion = {
|
|
34
|
+
a: 0,
|
|
35
|
+
};
|
|
36
|
+
(0, tsd_1.expectNotAssignable)(interfaceWithUndefinedTypeUnion);
|
|
37
|
+
const interfaceWithFunction = { a: () => 0 };
|
|
38
|
+
(0, tsd_1.expectNotAssignable)(interfaceWithFunction);
|
|
39
|
+
const typeWithDate = { a: new Date() };
|
|
40
|
+
(0, tsd_1.expectNotAssignable)(typeWithDate);
|
|
41
|
+
const typeWithOptionalDate = { a: new Date() };
|
|
42
|
+
(0, tsd_1.expectNotAssignable)(typeWithOptionalDate);
|
|
43
|
+
const typeWithUndefinedTypeUnion = {
|
|
44
|
+
a: 0,
|
|
45
|
+
};
|
|
46
|
+
(0, tsd_1.expectNotAssignable)(typeWithUndefinedTypeUnion);
|
|
47
|
+
const typeWithFunction = { a: () => 0 };
|
|
48
|
+
(0, tsd_1.expectNotAssignable)(typeWithFunction);
|
|
49
|
+
const typeWithOptionalProperty = { a: undefined };
|
|
50
|
+
(0, tsd_1.expectNotAssignable)(typeWithOptionalProperty);
|
|
51
|
+
// Edge cases:
|
|
52
|
+
// The Json type doesn't protect against the `any` type.
|
|
53
|
+
(0, tsd_1.expectAssignable)(null);
|
|
54
|
+
const a = { a: 0 };
|
|
55
|
+
(0, tsd_1.expectNotAssignable)(a);
|
|
56
|
+
// The Json type gets confused by classes. This class instance is valid Json,
|
|
57
|
+
// but it's incompatible with the Json type.
|
|
58
|
+
class B {
|
|
59
|
+
}
|
|
60
|
+
const b = new B();
|
|
61
|
+
(0, tsd_1.expectNotAssignable)(b);
|
|
62
|
+
//# sourceMappingURL=json.test-d.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"json.test-d.js","sourceRoot":"","sources":["../src/json.test-d.ts"],"names":[],"mappings":";AAAA,mEAAmE;;AAEnE,6BAA4D;AAG5D,cAAc;AAEd,IAAA,sBAAgB,EAAO,IAAI,CAAC,CAAC;AAE7B,IAAA,sBAAgB,EAAO,KAAK,CAAC,CAAC;AAE9B,IAAA,sBAAgB,EAAO,EAAE,CAAC,CAAC;AAE3B,IAAA,sBAAgB,EAAO,CAAC,CAAC,CAAC;AAE1B,IAAA,sBAAgB,EAAO,EAAE,CAAC,CAAC;AAE3B,IAAA,sBAAgB,EAAO,EAAE,CAAC,CAAC;AAE3B,IAAA,sBAAgB,EAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5B,IAAA,sBAAgB,EAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;AAEjC,IAAA,sBAAgB,EAAO,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAEzE,IAAA,sBAAgB,EAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AAK/E,MAAM,kBAAkB,GAAuB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AACxD,IAAA,sBAAgB,EAAO,kBAAkB,CAAC,CAAC;AAE3C,gBAAgB;AAEhB,IAAA,yBAAmB,EAAO,SAAS,CAAC,CAAC;AAErC,IAAA,yBAAmB,EAAO,IAAI,IAAI,EAAE,CAAC,CAAC;AAEtC,IAAA,yBAAmB,EAAO,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;AAEnC,IAAA,yBAAmB,EAAO,IAAI,GAAG,EAAE,CAAC,CAAC;AAErC,IAAA,yBAAmB,EAAO,IAAI,GAAG,EAAE,CAAC,CAAC;AAErC,IAAA,yBAAmB,EAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAE1C,IAAA,yBAAmB,EAAO,EAAE,CAAC,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;AAE7C,IAAA,yBAAmB,EAAO,CAAuB,CAAC,CAAC;AAKnD,MAAM,6BAA6B,GAAkC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAC9E,IAAA,yBAAmB,EAAO,6BAA6B,CAAC,CAAC;AAKzD,MAAM,iBAAiB,GAAsB,EAAE,CAAC,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC;AAC/D,IAAA,yBAAmB,EAAO,iBAAiB,CAAC,CAAC;AAK7C,MAAM,yBAAyB,GAA8B,EAAE,CAAC,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC;AAC/E,IAAA,yBAAmB,EAAO,yBAAyB,CAAC,CAAC;AAKrD,MAAM,+BAA+B,GAAoC;IACvE,CAAC,EAAE,CAAC;CACL,CAAC;AACF,IAAA,yBAAmB,EAAO,+BAA+B,CAAC,CAAC;AAK3D,MAAM,qBAAqB,GAA0B,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;AACpE,IAAA,yBAAmB,EAAO,qBAAqB,CAAC,CAAC;AAKjD,MAAM,YAAY,GAAiB,EAAE,CAAC,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC;AACrD,IAAA,yBAAmB,EAAO,YAAY,CAAC,CAAC;AAKxC,MAAM,oBAAoB,GAAyB,EAAE,CAAC,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC;AACrE,IAAA,yBAAmB,EAAO,oBAAoB,CAAC,CAAC;AAKhD,MAAM,0BAA0B,GAA+B;IAC7D,CAAC,EAAE,CAAC;CACL,CAAC;AACF,IAAA,yBAAmB,EAAO,0BAA0B,CAAC,CAAC;AAKtD,MAAM,gBAAgB,GAAqB,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;AAC1D,IAAA,yBAAmB,EAAO,gBAAgB,CAAC,CAAC;AAK5C,MAAM,wBAAwB,GAA6B,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC;AAC5E,IAAA,yBAAmB,EAAO,wBAAwB,CAAC,CAAC;AAEpD,cAAc;AAEd,wDAAwD;AACxD,IAAA,sBAAgB,EAAO,IAAW,CAAC,CAAC;AAOpC,MAAM,CAAC,GAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AACtB,IAAA,yBAAmB,EAAO,CAAC,CAAC,CAAC;AAE7B,6EAA6E;AAC7E,4CAA4C;AAC5C,MAAM,CAAC;CAEN;AACD,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;AAClB,IAAA,yBAAmB,EAAO,CAAC,CAAC,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/consistent-type-definitions */\n\nimport { expectAssignable, expectNotAssignable } from 'tsd';\nimport type { Json } from '.';\n\n// Valid Json:\n\nexpectAssignable<Json>(null);\n\nexpectAssignable<Json>(false);\n\nexpectAssignable<Json>('');\n\nexpectAssignable<Json>(0);\n\nexpectAssignable<Json>([]);\n\nexpectAssignable<Json>({});\n\nexpectAssignable<Json>([0]);\n\nexpectAssignable<Json>({ a: 0 });\n\nexpectAssignable<Json>({ deeply: [{ nested: 1 }, 'mixed', 'types', 0] });\n\nexpectAssignable<Json>(['array', { nested: { mixed: true, types: null } }, 0]);\n\ntype JsonCompatibleType = {\n c: number;\n};\nconst jsonCompatibleType: JsonCompatibleType = { c: 0 };\nexpectAssignable<Json>(jsonCompatibleType);\n\n// Invalid Json:\n\nexpectNotAssignable<Json>(undefined);\n\nexpectNotAssignable<Json>(new Date());\n\nexpectNotAssignable<Json>(() => 0);\n\nexpectNotAssignable<Json>(new Set());\n\nexpectNotAssignable<Json>(new Map());\n\nexpectNotAssignable<Json>(Symbol('test'));\n\nexpectNotAssignable<Json>({ a: new Date() });\n\nexpectNotAssignable<Json>(5 as number | undefined);\n\ninterface InterfaceWithOptionalProperty {\n a?: number;\n}\nconst interfaceWithOptionalProperty: InterfaceWithOptionalProperty = { a: 0 };\nexpectNotAssignable<Json>(interfaceWithOptionalProperty);\n\ninterface InterfaceWithDate {\n a: Date;\n}\nconst interfaceWithDate: InterfaceWithDate = { a: new Date() };\nexpectNotAssignable<Json>(interfaceWithDate);\n\ninterface InterfaceWithOptionalDate {\n a?: Date;\n}\nconst interfaceWithOptionalDate: InterfaceWithOptionalDate = { a: new Date() };\nexpectNotAssignable<Json>(interfaceWithOptionalDate);\n\ninterface InterfaceWithUndefinedTypeUnion {\n a: number | undefined;\n}\nconst interfaceWithUndefinedTypeUnion: InterfaceWithUndefinedTypeUnion = {\n a: 0,\n};\nexpectNotAssignable<Json>(interfaceWithUndefinedTypeUnion);\n\ninterface InterfaceWithFunction {\n a: () => number;\n}\nconst interfaceWithFunction: InterfaceWithFunction = { a: () => 0 };\nexpectNotAssignable<Json>(interfaceWithFunction);\n\ntype TypeWithDate = {\n a: Date;\n};\nconst typeWithDate: TypeWithDate = { a: new Date() };\nexpectNotAssignable<Json>(typeWithDate);\n\ntype TypeWithOptionalDate = {\n a?: Date;\n};\nconst typeWithOptionalDate: TypeWithOptionalDate = { a: new Date() };\nexpectNotAssignable<Json>(typeWithOptionalDate);\n\ntype TypeWithUndefinedTypeUnion = {\n a: number | undefined;\n};\nconst typeWithUndefinedTypeUnion: TypeWithUndefinedTypeUnion = {\n a: 0,\n};\nexpectNotAssignable<Json>(typeWithUndefinedTypeUnion);\n\ntype TypeWithFunction = {\n a: () => number;\n};\nconst typeWithFunction: TypeWithFunction = { a: () => 0 };\nexpectNotAssignable<Json>(typeWithFunction);\n\ntype TypeWithOptionalProperty = {\n a?: number | undefined;\n};\nconst typeWithOptionalProperty: TypeWithOptionalProperty = { a: undefined };\nexpectNotAssignable<Json>(typeWithOptionalProperty);\n\n// Edge cases:\n\n// The Json type doesn't protect against the `any` type.\nexpectAssignable<Json>(null as any);\n\n// The Json type gets confused by interfaces. This interface is valid Json,\n// but it's incompatible with the Json type.\ninterface A {\n a: number;\n}\nconst a: A = { a: 0 };\nexpectNotAssignable<Json>(a);\n\n// The Json type gets confused by classes. This class instance is valid Json,\n// but it's incompatible with the Json type.\nclass B {\n a!: number;\n}\nconst b = new B();\nexpectNotAssignable<Json>(b);\n"]}
|
package/dist/number.d.ts
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Convert a number to a hexadecimal string. This verifies that the number is a
|
|
3
|
+
* non-negative safe integer.
|
|
4
|
+
*
|
|
5
|
+
* To convert a `bigint` to a hexadecimal string instead, use
|
|
6
|
+
* {@link bigIntToHex}.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```typescript
|
|
10
|
+
* numberToHex(0); // '0x0'
|
|
11
|
+
* numberToHex(1); // '0x1'
|
|
12
|
+
* numberToHex(16); // '0x10'
|
|
13
|
+
* ```
|
|
14
|
+
* @param value - The number to convert to a hexadecimal string.
|
|
15
|
+
* @returns The hexadecimal string, with the "0x"-prefix.
|
|
16
|
+
* @throws If the number is not a non-negative safe integer.
|
|
17
|
+
*/
|
|
18
|
+
export declare const numberToHex: (value: number) => string;
|
|
19
|
+
/**
|
|
20
|
+
* Convert a `bigint` to a hexadecimal string. This verifies that the `bigint`
|
|
21
|
+
* is a non-negative integer.
|
|
22
|
+
*
|
|
23
|
+
* To convert a number to a hexadecimal string instead, use {@link numberToHex}.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```typescript
|
|
27
|
+
* bigIntToHex(0n); // '0x0'
|
|
28
|
+
* bigIntToHex(1n); // '0x1'
|
|
29
|
+
* bigIntToHex(16n); // '0x10'
|
|
30
|
+
* ```
|
|
31
|
+
* @param value - The `bigint` to convert to a hexadecimal string.
|
|
32
|
+
* @returns The hexadecimal string, with the "0x"-prefix.
|
|
33
|
+
* @throws If the `bigint` is not a non-negative integer.
|
|
34
|
+
*/
|
|
35
|
+
export declare const bigIntToHex: (value: bigint) => string;
|
|
36
|
+
/**
|
|
37
|
+
* Convert a hexadecimal string to a number. This verifies that the string is a
|
|
38
|
+
* valid hex string, and that the resulting number is a safe integer. Both
|
|
39
|
+
* "0x"-prefixed and unprefixed strings are supported.
|
|
40
|
+
*
|
|
41
|
+
* To convert a hexadecimal string to a `bigint` instead, use
|
|
42
|
+
* {@link hexToBigInt}.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```typescript
|
|
46
|
+
* hexToNumber('0x0'); // 0
|
|
47
|
+
* hexToNumber('0x1'); // 1
|
|
48
|
+
* hexToNumber('0x10'); // 16
|
|
49
|
+
* ```
|
|
50
|
+
* @param value - The hexadecimal string to convert to a number.
|
|
51
|
+
* @returns The number.
|
|
52
|
+
* @throws If the value is not a valid hexadecimal string, or if the resulting
|
|
53
|
+
* number is not a safe integer.
|
|
54
|
+
*/
|
|
55
|
+
export declare const hexToNumber: (value: string) => number;
|
|
56
|
+
/**
|
|
57
|
+
* Convert a hexadecimal string to a `bigint`. This verifies that the string is
|
|
58
|
+
* a valid hex string. Both "0x"-prefixed and unprefixed strings are supported.
|
|
59
|
+
*
|
|
60
|
+
* To convert a hexadecimal string to a number instead, use {@link hexToNumber}.
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```typescript
|
|
64
|
+
* hexToBigInt('0x0'); // 0n
|
|
65
|
+
* hexToBigInt('0x1'); // 1n
|
|
66
|
+
* hexToBigInt('0x10'); // 16n
|
|
67
|
+
* ```
|
|
68
|
+
* @param value - The hexadecimal string to convert to a `bigint`.
|
|
69
|
+
* @returns The `bigint`.
|
|
70
|
+
* @throws If the value is not a valid hexadecimal string.
|
|
71
|
+
*/
|
|
72
|
+
export declare const hexToBigInt: (value: string) => bigint;
|