@metamask-previews/base-controller - npm Package Compare versions

Comparing version 4.0.0-preview.3fbb6b41 to 4.0.1-preview.c9a5f6a5

CHANGELOG.md

@@ -9,2 +9,7 @@ # Changelog
 
+## [4.0.1]
+### Changed
+- Deprecate `subscribe` property from `BaseControllerV2` ([#3590](https://github.com/MetaMask/core/pull/3590), [#3698](https://github.com/MetaMask/core/pull/3698))
+  - This property was used to differentiate between `BaseControllerV1` and `BaseControllerV2` controllers. It is no longer used, so it has been marked as deprecated.
+
 ## [4.0.0]
@@ -102,3 +107,4 @@ ### Added
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/base-controller@4.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/base-controller@4.0.1...HEAD
+[4.0.1]: https://github.com/MetaMask/core/compare/@metamask/base-controller@4.0.0...@metamask/base-controller@4.0.1
 [4.0.0]: https://github.com/MetaMask/core/compare/@metamask/base-controller@3.2.3...@metamask/base-controller@4.0.0
@@ -105,0 +111,0 @@ [3.2.3]: https://github.com/MetaMask/core/compare/@metamask/base-controller@3.2.2...@metamask/base-controller@3.2.3

dist/BaseControllerV1.js

@@ -89,2 +89,4 @@ "use strict";
                 if (value !== undefined) {
+                    // TODO: Replace `any` with type
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                     this[key] = value;
@@ -99,2 +101,4 @@ }
                     this.internalConfig[key] = config[key];
+                    // TODO: Replace `any` with type
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
                     this[key] = config[key];
@@ -101,0 +105,0 @@ }

dist/BaseControllerV2.d.ts

@@ -75,5 +75,9 @@ import type { Json } from '@metamask/utils';
     /**
-     * The existence of the `subscribe` property is how the ComposableController detects whether a
-     * controller extends the old BaseController or the new one. We set it to `undefined` here to
+     * The existence of the `subscribe` property is how the ComposableController used to detect
+     * whether a controller extends the old BaseController or the new one. We set it to `undefined` here to
      * ensure the ComposableController never mistakes them for an older style controller.
+     *
+     * This property is no longer used, and will be removed in a future release.
+     *
+     * @deprecated This will be removed in a future release
      */
@@ -80,0 +84,0 @@ readonly subscribe: undefined;

package.json

 {
   "name": "@metamask-previews/base-controller",
-  "version": "4.0.0-preview.3fbb6b41",
+  "version": "4.0.1-preview.c9a5f6a5",
   "description": "Provides scaffolding for controllers as well a communication system for all controllers",
@@ -25,2 +25,3 @@ "keywords": [
     "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/base-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/base-controller",
@@ -38,3 +39,3 @@ "publish:preview": "yarn npm publish --tag preview",
   "devDependencies": {
-    "@metamask/auto-changelog": "^3.4.3",
+    "@metamask/auto-changelog": "^3.4.4",
     "@types/jest": "^27.4.1",
@@ -41,0 +42,0 @@ "@types/sinon": "^9.0.10",

No alert changes

Improved metrics

Total package byte prevSize

151005

increased by0.97%

Lines of code

1391

increased by0.58%

No dependency changes