@metamask/utils 2.1.0 → 3.0.0

package/CHANGELOG.md

@@ -6,6 +6,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.0]
+### Added
+- Add logging functions ([#20](https://github.com/MetaMask/utils/pull/20))
+- Add frozen collections (implemented in [#5](https://github.com/MetaMask/utils/pull/5) but exported in [#19](https://github.com/MetaMask/utils/pull/19))
+
+### Changed
+- **BREAKING:** Improve types and type validation ([#19](https://github.com/MetaMask/utils/pull/19))
+  - Various type changes have been made that might be breaking:
+    - The `JsonRpcRequest` and `JsonRpcNotification` types now include a generic constraint requiring that the `Params` type extends the `JsonRpcParams` type.
+    - The `JsonRpcSuccess` and `JsonRpcResponse` types now include a generic contraint for the `Result` type, requiring that it extends the `Json` type.
+    - Various validation functions now accept `unknown` parameters rather than specific types. This should not be breaking except that it may affect type inference for the parameters passed in.
+  - New JSON-related functions have been added:
+    - `assertIsJsonRpcResponse`
+    - `isJsonRpcResponse`
+    - `InferWithParams`
+    - `JsonRpcParams`
+  - New JSON Struct types have been added:
+    - `JsonRpcErrorStruct`
+    - `JsonRpcFailureStruct`
+    - `JsonRpcIdStruct`
+    - `JsonRpcParamsStruct`
+    - `JsonRpcRequestStruct`
+    - `JsonRpcResponseStruct`
+    - `JsonRpcSuccessStruct`
+    - `JsonRpcVersionStruct`
+    - `JsonStruct`
+
 ## [2.1.0]
 ### Added
 - Add JSON storage validation and limit utilities ([#14](https://github.com/MetaMask/utils/pull/14))
@@ -23,7 +50,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/MetaMask/utils/compare/v2.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/utils/compare/v3.0.0...HEAD
+[3.0.0]: https://github.com/MetaMask/utils/compare/v2.1.0...v3.0.0
 [2.1.0]: https://github.com/MetaMask/utils/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/MetaMask/utils/compare/v1.0.0...v2.0.0
 [1.0.0]: https://github.com/MetaMask/utils/releases/tag/v1.0.0

package/dist/__fixtures__/index.d.ts

@@ -0,0 +1 @@
+export * from './json';

package/dist/__fixtures__/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./json"), exports);
+//# sourceMappingURL=index.js.map

package/dist/__fixtures__/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/__fixtures__/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB","sourcesContent":["export * from './json';\n"]}