@metamask-previews/composable-controller 5.0.1-preview.2431602 → 5.0.1-preview.303e509

package/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -6,15 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add and export functions `isBaseControllerV1` and `isBaseController`, which are type guards for validating controller instances ([#3904](https://github.com/MetaMask/core/pull/3904))
+- Add and export types `BaseControllerV1Instance`, `BaseControllerV2Instance`, `ControllerInstance` which are the narrowest supertypes for all controllers extending from, respectively, `BaseControllerV1`, `BaseController`, and both ([#3904](https://github.com/MetaMask/core/pull/3904))
+
+### Changed
+
+- **BREAKING:** Passing a non-controller into `controllers` constructor option now throws an error ([#3904](https://github.com/MetaMask/core/pull/3904))
+- **BREAKING:** The `AllowedActions` parameter of the `ComposableControllerMessenger` type is narrowed from `string` to `never`, as `ComposableController` does not use any external controller actions. ([#3904](https://github.com/MetaMask/core/pull/3904))
+- Add `@metamask/utils` ^8.3.0 as a dependency. ([#3904](https://github.com/MetaMask/core/pull/3904))
+
+### Removed
+
+- **BREAKING:** Remove `ControllerList` as an exported type. ([#3904](https://github.com/MetaMask/core/pull/3904))
+
 ## [5.0.1]
+
 ### Changed
+
 - Bump `@metamask/base-controller` to `^4.1.1` ([#3760](https://github.com/MetaMask/core/pull/3760), [#3821](https://github.com/MetaMask/core/pull/3821))
 
 ## [5.0.0]
+
 ### Added
+
 - Add types `ComposableControllerState`, `ComposableControllerStateChangeEvent`, `ComposableControllerEvents`, `ComposableControllerMessenger` ([#3590](https://github.com/MetaMask/core/pull/3590))
 
 ### Changed
+
 - **BREAKING:** `ComposableController` is upgraded to extend `BaseControllerV2` ([#3590](https://github.com/MetaMask/core/pull/3590))
   - The constructor now expects an options object with required properties `controllers` and `messenger` as its only argument.
   - `ComposableController` no longer has a `subscribe` method. Instead, listeners for `ComposableController` events must be registered to the controller messenger that generated the restricted messenger assigned to the instance's `messagingSystem` class field.
@@ -22,44 +43,64 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Bump `@metamask/base-controller` to `^4.0.1` ([#3695](https://github.com/MetaMask/core/pull/3695))
 
 ## [4.0.0]
+
 ### Changed
+
 - **BREAKING:** Bump `@metamask/base-controller` to ^4.0.0 ([#2063](https://github.com/MetaMask/core/pull/2063))
   - This is breaking because the type of the `messenger` has backward-incompatible changes. See the changelog for this package for more.
 
 ## [3.0.3]
+
 ### Changed
+
 - Bump dependency on `@metamask/base-controller` to ^3.2.3 ([#1747](https://github.com/MetaMask/core/pull/1747))
 
 ## [3.0.2]
+
 ### Changed
+
 - Update TypeScript to v4.8.x ([#1718](https://github.com/MetaMask/core/pull/1718))
 
 ## [3.0.1]
+
 ### Changed
+
 - Bump dependency on `@metamask/base-controller` to ^3.2.1
 
 ## [3.0.0]
+
 ### Changed
+
 - **BREAKING:** Bump to Node 16 ([#1262](https://github.com/MetaMask/core/pull/1262))
 
 ## [2.0.0]
+
 ### Removed
+
 - **BREAKING:** Remove `isomorphic-fetch` ([#1106](https://github.com/MetaMask/controllers/pull/1106))
   - Consumers must now import `isomorphic-fetch` or another polyfill themselves if they are running in an environment without `fetch`
 
 ## [1.0.2]
+
 ### Changed
+
 - Rename this repository to `core` ([#1031](https://github.com/MetaMask/controllers/pull/1031))
-- Update `@metamask/controller-utils` package ([#1041](https://github.com/MetaMask/controllers/pull/1041)) 
+- Update `@metamask/controller-utils` package ([#1041](https://github.com/MetaMask/controllers/pull/1041))
 
 ## [1.0.1]
+
 ### Changed
+
 - Relax dependency on `@metamask/controller-utils` (use `^` instead of `~`) ([#998](https://github.com/MetaMask/core/pull/998))
 
 ## [1.0.0]
+
 ### Added
+
 - Initial release
+
   - As a result of converting our shared controllers repo into a monorepo ([#831](https://github.com/MetaMask/core/pull/831)), we've created this package from select parts of [`@metamask/controllers` v33.0.0](https://github.com/MetaMask/core/tree/v33.0.0), namely:
+
     - `src/ComposableController.ts`
     - `src/ComposableController.test.ts`
 

package/dist/ComposableController.d.ts

@@ -1,20 +1,48 @@
 import { BaseController, BaseControllerV1 } from '@metamask/base-controller';
-import type { ControllerStateChangeEvent, RestrictedControllerMessenger } from '@metamask/base-controller';
+import type { ControllerStateChangeEvent, RestrictedControllerMessenger, BaseState, BaseConfig } from '@metamask/base-controller';
+import { type Json } from '@metamask/utils';
 export declare const controllerName = "ComposableController";
-declare type ControllerInstance = BaseControllerV1<any, any> | {
+/**
+ * A type encompassing all controller instances that extend from `BaseControllerV1`.
+ */
+export declare type BaseControllerV1Instance = BaseControllerV1<any, any>;
+/**
+ * A type encompassing all controller instances that extend from `BaseController` (formerly `BaseControllerV2`).
+ *
+ * The `BaseController` class itself can't be used directly as a type representing all of its subclasses,
+ * because the generic parameters it expects require knowing the exact shape of the controller's state and messenger.
+ *
+ * Instead, we look for an object with the `BaseController` properties that we use in the ComposableController (name and state).
+ */
+export declare type BaseControllerV2Instance = {
     name: string;
-    state: Record<string, unknown>;
+    state: Record<string, Json>;
 };
 /**
- * List of child controller instances
+ * A type encompassing all controller instances that extend from `BaseControllerV1` or `BaseController`.
+ */
+export declare type ControllerInstance = BaseControllerV1Instance | BaseControllerV2Instance;
+/**
+ * Determines if the given controller is an instance of BaseControllerV1
+ * @param controller - Controller instance to check
+ * @returns True if the controller is an instance of BaseControllerV1
+ * TODO: Deprecate once `BaseControllerV2` migrations are completed for all controllers.
  */
-export declare type ControllerList = ControllerInstance[];
+export declare function isBaseControllerV1(controller: ControllerInstance): controller is BaseControllerV1<BaseConfig & Record<string, unknown>, BaseState & Record<string, unknown>>;
+/**
+ * Determines if the given controller is an instance of BaseController
+ * @param controller - Controller instance to check
+ * @returns True if the controller is an instance of BaseController
+ */
+export declare function isBaseController(controller: ControllerInstance): controller is BaseController<never, never, never>;
 export declare type ComposableControllerState = {
-    [name: string]: ControllerInstance['state'];
+    [name: string]: Record<string, any>;
 };
-export declare type ComposableControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, ComposableControllerState>;
+export declare type ComposableControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, Record<string, unknown>>;
 export declare type ComposableControllerEvents = ComposableControllerStateChangeEvent;
-export declare type ComposableControllerMessenger = RestrictedControllerMessenger<typeof controllerName, never, ControllerStateChangeEvent<string, Record<string, unknown>>, string, string>;
+declare type AnyControllerStateChangeEvent = ControllerStateChangeEvent<string, Record<string, unknown>>;
+declare type AllowedEvents = AnyControllerStateChangeEvent;
+export declare type ComposableControllerMessenger = RestrictedControllerMessenger<typeof controllerName, never, ComposableControllerEvents | AllowedEvents, never, AllowedEvents['type']>;
 /**
  * Controller that can be used to compose multiple controllers together.
  */
@@ -28,17 +56,9 @@ export declare class ComposableController extends BaseController<typeof controll
      * @param options.messenger - A restricted controller messenger.
      */
     constructor({ controllers, messenger, }: {
-        controllers: ControllerList;
+        controllers: ControllerInstance[];
         messenger: ComposableControllerMessenger;
     });
-    /**
-     * Flat state representation, one that isn't keyed
-     * of controller name. Instead, all child controller state is merged
-     * together into a single, flat object.
-     *
-     * @returns Merged state representation of all child controllers.
-     */
-    get flatState(): {};
 }
 export default ComposableController;
 //# sourceMappingURL=ComposableController.d.ts.map

package/dist/ComposableController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ComposableController.d.ts","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EACV,0BAA0B,EAC1B,6BAA6B,EAC9B,MAAM,2BAA2B,CAAC;AAEnC,eAAO,MAAM,cAAc,yBAAyB,CAAC;AASrD,aAAK,kBAAkB,GAGrB,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAAC;AAEhF;;GAEG;AACH,oBAAY,cAAc,GAAG,kBAAkB,EAAE,CAAC;AAelD,oBAAY,yBAAyB,GAAG;IACtC,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;CAC7C,CAAC;AAEF,oBAAY,oCAAoC,GAAG,0BAA0B,CAC3E,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF,oBAAY,0BAA0B,GAAG,oCAAoC,CAAC;AAE9E,oBAAY,6BAA6B,GAAG,6BAA6B,CACvE,OAAO,cAAc,EACrB,KAAK,EACL,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAC3D,MAAM,EACN,MAAM,CACP,CAAC;AAEF;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CACtD,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAC9B;;IAGC;;;;;;OAMG;gBAES,EACV,WAAW,EACX,SAAS,GACV,EAAE;QACD,WAAW,EAAE,cAAc,CAAC;QAC5B,SAAS,EAAE,6BAA6B,CAAC;KAC1C;IAoBD;;;;;;OAMG;IACH,IAAI,SAAS,OAMZ;CA4BF;AAED,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"ComposableController.d.ts","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,KAAK,EACV,0BAA0B,EAC1B,6BAA6B,EAC7B,SAAS,EACT,UAAU,EAEX,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAe,KAAK,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEzD,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAGrD;;GAEG;AACH,oBAAY,wBAAwB,GAGlC,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAE7B;;;;;;;GAOG;AACH,oBAAY,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC7B,CAAC;AAGF;;GAEG;AACH,oBAAY,kBAAkB,GAC1B,wBAAwB,GACxB,wBAAwB,CAAC;AAE7B;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,kBAAkB,GAC7B,UAAU,IAAI,gBAAgB,CAC/B,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACpC,CAYA;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,kBAAkB,GAC7B,UAAU,IAAI,cAAc,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAQnD;AAED,oBAAY,yBAAyB,GAAG;IAKtC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACrC,CAAC;AAEF,oBAAY,oCAAoC,GAAG,0BAA0B,CAC3E,OAAO,cAAc,EACrB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACxB,CAAC;AAEF,oBAAY,0BAA0B,GAAG,oCAAoC,CAAC;AAE9E,aAAK,6BAA6B,GAAG,0BAA0B,CAC7D,MAAM,EACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACxB,CAAC;AAEF,aAAK,aAAa,GAAG,6BAA6B,CAAC;AAEnD,oBAAY,6BAA6B,GAAG,6BAA6B,CACvE,OAAO,cAAc,EACrB,KAAK,EACL,0BAA0B,GAAG,aAAa,EAC1C,KAAK,EACL,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,cAAc,CACtD,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAC9B;;IACC;;;;;;OAMG;gBAES,EACV,WAAW,EACX,SAAS,GACV,EAAE;QACD,WAAW,EAAE,kBAAkB,EAAE,CAAC;QAClC,SAAS,EAAE,6BAA6B,CAAC;KAC1C;CA2DF;AAED,eAAe,oBAAoB,CAAC"}

package/dist/ComposableController.js

@@ -1,28 +1,46 @@
 "use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _ComposableController_instances, _ComposableController_controllers, _ComposableController_updateChildController;
+var _ComposableController_instances, _ComposableController_updateChildController;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComposableController = exports.controllerName = void 0;
+exports.ComposableController = exports.isBaseController = exports.isBaseControllerV1 = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
+const utils_1 = require("@metamask/utils");
 exports.controllerName = 'ComposableController';
 /**
  * Determines if the given controller is an instance of BaseControllerV1
  * @param controller - Controller instance to check
  * @returns True if the controller is an instance of BaseControllerV1
+ * TODO: Deprecate once `BaseControllerV2` migrations are completed for all controllers.
  */
 function isBaseControllerV1(controller) {
-    return controller instanceof base_controller_1.BaseControllerV1;
+    return ('name' in controller &&
+        typeof controller.name === 'string' &&
+        'defaultConfig' in controller &&
+        typeof controller.defaultConfig === 'object' &&
+        'defaultState' in controller &&
+        typeof controller.defaultState === 'object' &&
+        'disabled' in controller &&
+        typeof controller.disabled === 'boolean' &&
+        controller instanceof base_controller_1.BaseControllerV1);
 }
+exports.isBaseControllerV1 = isBaseControllerV1;
+/**
+ * Determines if the given controller is an instance of BaseController
+ * @param controller - Controller instance to check
+ * @returns True if the controller is an instance of BaseController
+ */
+function isBaseController(controller) {
+    return ('name' in controller &&
+        typeof controller.name === 'string' &&
+        'state' in controller &&
+        typeof controller.state === 'object' &&
+        controller instanceof base_controller_1.BaseController);
+}
+exports.isBaseController = isBaseController;
 /**
  * Controller that can be used to compose multiple controllers together.
  */
@@ -40,45 +58,36 @@ class ComposableController extends base_controller_1.BaseController {
         }
         super({
             name: exports.controllerName,
-            metadata: {},
+            metadata: controllers.reduce((metadata, controller) => (Object.assign(Object.assign({}, metadata), { [controller.name]: isBaseController(controller)
+                    ? controller.metadata
+                    : { persist: true, anonymous: true } })), {}),
             state: controllers.reduce((state, controller) => {
                 return Object.assign(Object.assign({}, state), { [controller.name]: controller.state });
             }, {}),
             messenger,
         });
         _ComposableController_instances.add(this);
-        _ComposableController_controllers.set(this, []);
-        __classPrivateFieldSet(this, _ComposableController_controllers, controllers, "f");
-        __classPrivateFieldGet(this, _ComposableController_controllers, "f").forEach((controller) => __classPrivateFieldGet(this, _ComposableController_instances, "m", _ComposableController_updateChildController).call(this, controller));
-    }
-    /**
-     * Flat state representation, one that isn't keyed
-     * of controller name. Instead, all child controller state is merged
-     * together into a single, flat object.
-     *
-     * @returns Merged state representation of all child controllers.
-     */
-    get flatState() {
-        let flatState = {};
-        for (const controller of __classPrivateFieldGet(this, _ComposableController_controllers, "f")) {
-            flatState = Object.assign(Object.assign({}, flatState), controller.state);
-        }
-        return flatState;
+        controllers.forEach((controller) => __classPrivateFieldGet(this, _ComposableController_instances, "m", _ComposableController_updateChildController).call(this, controller));
     }
 }
 exports.ComposableController = ComposableController;
-_ComposableController_controllers = new WeakMap(), _ComposableController_instances = new WeakSet(), _ComposableController_updateChildController = function _ComposableController_updateChildController(controller) {
+_ComposableController_instances = new WeakSet(), _ComposableController_updateChildController = function _ComposableController_updateChildController(controller) {
     const { name } = controller;
     if (isBaseControllerV1(controller)) {
         controller.subscribe((childState) => {
             this.update((state) => (Object.assign(Object.assign({}, state), { [name]: childState })));
         });
     }
-    else {
-        this.messagingSystem.subscribe(`${String(name)}:stateChange`, (childState) => {
-            this.update((state) => (Object.assign(Object.assign({}, state), { [name]: childState })));
+    else if (isBaseController(controller)) {
+        this.messagingSystem.subscribe(`${name}:stateChange`, (childState) => {
+            if ((0, utils_1.isValidJson)(childState)) {
+                this.update((state) => (Object.assign(Object.assign({}, state), { [name]: childState })));
+            }
         });
     }
+    else {
+        throw new Error('Invalid controller: controller must extend from BaseController or BaseControllerV1');
+    }
 };
 exports.default = ComposableController;
 //# sourceMappingURL=ComposableController.js.map

package/dist/ComposableController.js.map

@@ -1 +1 @@
-{"version":3,"file":"ComposableController.js","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+DAA6E;AAMhE,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAmBrD;;;;GAIG;AACH,SAAS,kBAAkB,CACzB,UAA8B;IAI9B,OAAO,UAAU,YAAY,kCAAgB,CAAC;AAChD,CAAC;AAqBD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,gCAIzC;IAGC;;;;;;OAMG;IAEH,YAAY,EACV,WAAW,EACX,SAAS,GAIV;QACC,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QAED,KAAK,CAAC;YACJ,IAAI,EAAE,sBAAc;YACpB,QAAQ,EAAE,EAAE;YACZ,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBAC9C,uCAAY,KAAK,KAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,KAAK,IAAG;YAC3D,CAAC,EAAE,EAA+B,CAAC;YACnC,SAAS;SACV,CAAC,CAAC;;QA5BL,4CAAwC,EAAE,EAAC;QA8BzC,uBAAA,IAAI,qCAAgB,WAAW,MAAA,CAAC;QAChC,uBAAA,IAAI,yCAAa,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CACvC,uBAAA,IAAI,oFAAuB,MAA3B,IAAI,EAAwB,UAAU,CAAC,CACxC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,IAAI,SAAS;QACX,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,UAAU,IAAI,uBAAA,IAAI,yCAAa,EAAE;YAC1C,SAAS,mCAAQ,SAAS,GAAK,UAAU,CAAC,KAAK,CAAE,CAAC;SACnD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CA4BF;AAlFD,oDAkFC;uMArBwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAClC,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE;YAClC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iCAClB,KAAK,KACR,CAAC,IAAI,CAAC,EAAE,UAAU,IAClB,CAAC,CAAC;QACN,CAAC,CAAC,CAAC;KACJ;SAAM;QACL,IAAI,CAAC,eAAe,CAAC,SAAS,CAC5B,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,EAC7B,CAAC,UAAmC,EAAE,EAAE;YACtC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iCAClB,KAAK,KACR,CAAC,IAAI,CAAC,EAAE,UAAU,IAClB,CAAC,CAAC;QACN,CAAC,CACF,CAAC;KACH;AACH,CAAC;AAGH,kBAAe,oBAAoB,CAAC","sourcesContent":["import { BaseController, BaseControllerV1 } from '@metamask/base-controller';\nimport type {\n  ControllerStateChangeEvent,\n  RestrictedControllerMessenger,\n} from '@metamask/base-controller';\n\nexport const controllerName = 'ComposableController';\n\n/*\n * This type encompasses controllers based on either BaseControllerV1 or\n * BaseController. The BaseController type can't be included directly\n * because the generic parameters it expects require knowing the exact state\n * shape, so instead we look for an object with the BaseController properties\n * that we use in the ComposableController (name and state).\n */\ntype ControllerInstance =\n  // TODO: Replace `any` with type\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  BaseControllerV1<any, any> | { name: string; state: Record<string, unknown> };\n\n/**\n * List of child controller instances\n */\nexport type ControllerList = ControllerInstance[];\n\n/**\n * Determines if the given controller is an instance of BaseControllerV1\n * @param controller - Controller instance to check\n * @returns True if the controller is an instance of BaseControllerV1\n */\nfunction isBaseControllerV1(\n  controller: ControllerInstance,\n  // TODO: Replace `any` with type\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n): controller is BaseControllerV1<any, any> {\n  return controller instanceof BaseControllerV1;\n}\n\nexport type ComposableControllerState = {\n  [name: string]: ControllerInstance['state'];\n};\n\nexport type ComposableControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ComposableControllerState\n>;\n\nexport type ComposableControllerEvents = ComposableControllerStateChangeEvent;\n\nexport type ComposableControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  never,\n  ControllerStateChangeEvent<string, Record<string, unknown>>,\n  string,\n  string\n>;\n\n/**\n * Controller that can be used to compose multiple controllers together.\n */\nexport class ComposableController extends BaseController<\n  typeof controllerName,\n  ComposableControllerState,\n  ComposableControllerMessenger\n> {\n  readonly #controllers: ControllerList = [];\n\n  /**\n   * Creates a ComposableController instance.\n   *\n   * @param options - Initial options used to configure this controller\n   * @param options.controllers - List of child controller instances to compose.\n   * @param options.messenger - A restricted controller messenger.\n   */\n\n  constructor({\n    controllers,\n    messenger,\n  }: {\n    controllers: ControllerList;\n    messenger: ComposableControllerMessenger;\n  }) {\n    if (messenger === undefined) {\n      throw new Error(`Messaging system is required`);\n    }\n\n    super({\n      name: controllerName,\n      metadata: {},\n      state: controllers.reduce((state, controller) => {\n        return { ...state, [controller.name]: controller.state };\n      }, {} as ComposableControllerState),\n      messenger,\n    });\n\n    this.#controllers = controllers;\n    this.#controllers.forEach((controller) =>\n      this.#updateChildController(controller),\n    );\n  }\n\n  /**\n   * Flat state representation, one that isn't keyed\n   * of controller name. Instead, all child controller state is merged\n   * together into a single, flat object.\n   *\n   * @returns Merged state representation of all child controllers.\n   */\n  get flatState() {\n    let flatState = {};\n    for (const controller of this.#controllers) {\n      flatState = { ...flatState, ...controller.state };\n    }\n    return flatState;\n  }\n\n  /**\n   * Adds a child controller instance to composable controller state,\n   * or updates the state of a child controller.\n   * @param controller - Controller instance to update\n   */\n  #updateChildController(controller: ControllerInstance): void {\n    const { name } = controller;\n    if (isBaseControllerV1(controller)) {\n      controller.subscribe((childState) => {\n        this.update((state) => ({\n          ...state,\n          [name]: childState,\n        }));\n      });\n    } else {\n      this.messagingSystem.subscribe(\n        `${String(name)}:stateChange`,\n        (childState: Record<string, unknown>) => {\n          this.update((state) => ({\n            ...state,\n            [name]: childState,\n          }));\n        },\n      );\n    }\n  }\n}\n\nexport default ComposableController;\n"]}
+{"version":3,"file":"ComposableController.js","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+DAA6E;AAQ7E,2CAAyD;AAE5C,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAgCrD;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,UAA8B;IAK9B,OAAO,CACL,MAAM,IAAI,UAAU;QACpB,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ;QACnC,eAAe,IAAI,UAAU;QAC7B,OAAO,UAAU,CAAC,aAAa,KAAK,QAAQ;QAC5C,cAAc,IAAI,UAAU;QAC5B,OAAO,UAAU,CAAC,YAAY,KAAK,QAAQ;QAC3C,UAAU,IAAI,UAAU;QACxB,OAAO,UAAU,CAAC,QAAQ,KAAK,SAAS;QACxC,UAAU,YAAY,kCAAgB,CACvC,CAAC;AACJ,CAAC;AAjBD,gDAiBC;AAED;;;;GAIG;AACH,SAAgB,gBAAgB,CAC9B,UAA8B;IAE9B,OAAO,CACL,MAAM,IAAI,UAAU;QACpB,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ;QACnC,OAAO,IAAI,UAAU;QACrB,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ;QACpC,UAAU,YAAY,gCAAc,CACrC,CAAC;AACJ,CAAC;AAVD,4CAUC;AAgCD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,gCAIzC;IACC;;;;;;OAMG;IAEH,YAAY,EACV,WAAW,EACX,SAAS,GAIV;QACC,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QAED,KAAK,CAAC;YACJ,IAAI,EAAE,sBAAc;YACpB,QAAQ,EAAE,WAAW,CAAC,MAAM,CAC1B,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,iCACrB,QAAQ,KACX,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC;oBAC7C,CAAC,CAAC,UAAU,CAAC,QAAQ;oBACrB,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,IACtC,EACF,EAAE,CACH;YACD,KAAK,EAAE,WAAW,CAAC,MAAM,CACvB,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBACpB,uCAAY,KAAK,KAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,KAAK,IAAG;YAC3D,CAAC,EACD,EAAE,CACH;YACD,SAAS;SACV,CAAC,CAAC;;QAEH,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CACjC,uBAAA,IAAI,oFAAuB,MAA3B,IAAI,EAAwB,UAAU,CAAC,CACxC,CAAC;IACJ,CAAC;CA+BF;AA9ED,oDA8EC;oJAxBwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAClC,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE;YAClC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iCAClB,KAAK,KACR,CAAC,IAAI,CAAC,EAAE,UAAU,IAClB,CAAC,CAAC;QACN,CAAC,CAAC,CAAC;KACJ;SAAM,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;QACvC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,IAAI,cAAc,EAAE,CAAC,UAAU,EAAE,EAAE;YACnE,IAAI,IAAA,mBAAW,EAAC,UAAU,CAAC,EAAE;gBAC3B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iCAClB,KAAK,KACR,CAAC,IAAI,CAAC,EAAE,UAAU,IAClB,CAAC,CAAC;aACL;QACH,CAAC,CAAC,CAAC;KACJ;SAAM;QACL,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAC;KACH;AACH,CAAC;AAGH,kBAAe,oBAAoB,CAAC","sourcesContent":["import { BaseController, BaseControllerV1 } from '@metamask/base-controller';\nimport type {\n  ControllerStateChangeEvent,\n  RestrictedControllerMessenger,\n  BaseState,\n  BaseConfig,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { isValidJson, type Json } from '@metamask/utils';\n\nexport const controllerName = 'ComposableController';\n\n// TODO: Remove this type once `BaseControllerV2` migrations are completed for all controllers.\n/**\n * A type encompassing all controller instances that extend from `BaseControllerV1`.\n */\nexport type BaseControllerV1Instance =\n  // `any` is used to include all `BaseControllerV1` instances.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  BaseControllerV1<any, any>;\n\n/**\n * A type encompassing all controller instances that extend from `BaseController` (formerly `BaseControllerV2`).\n *\n * The `BaseController` class itself can't be used directly as a type representing all of its subclasses,\n * because the generic parameters it expects require knowing the exact shape of the controller's state and messenger.\n *\n * Instead, we look for an object with the `BaseController` properties that we use in the ComposableController (name and state).\n */\nexport type BaseControllerV2Instance = {\n  name: string;\n  state: Record<string, Json>;\n};\n\n// TODO: Remove `BaseControllerV1Instance` member once `BaseControllerV2` migrations are completed for all controllers.\n/**\n * A type encompassing all controller instances that extend from `BaseControllerV1` or `BaseController`.\n */\nexport type ControllerInstance =\n  | BaseControllerV1Instance\n  | BaseControllerV2Instance;\n\n/**\n * Determines if the given controller is an instance of BaseControllerV1\n * @param controller - Controller instance to check\n * @returns True if the controller is an instance of BaseControllerV1\n * TODO: Deprecate once `BaseControllerV2` migrations are completed for all controllers.\n */\nexport function isBaseControllerV1(\n  controller: ControllerInstance,\n): controller is BaseControllerV1<\n  BaseConfig & Record<string, unknown>,\n  BaseState & Record<string, unknown>\n> {\n  return (\n    'name' in controller &&\n    typeof controller.name === 'string' &&\n    'defaultConfig' in controller &&\n    typeof controller.defaultConfig === 'object' &&\n    'defaultState' in controller &&\n    typeof controller.defaultState === 'object' &&\n    'disabled' in controller &&\n    typeof controller.disabled === 'boolean' &&\n    controller instanceof BaseControllerV1\n  );\n}\n\n/**\n * Determines if the given controller is an instance of BaseController\n * @param controller - Controller instance to check\n * @returns True if the controller is an instance of BaseController\n */\nexport function isBaseController(\n  controller: ControllerInstance,\n): controller is BaseController<never, never, never> {\n  return (\n    'name' in controller &&\n    typeof controller.name === 'string' &&\n    'state' in controller &&\n    typeof controller.state === 'object' &&\n    controller instanceof BaseController\n  );\n}\n\nexport type ComposableControllerState = {\n  // `any` is used here to disable the `BaseController` type constraint which expects state properties to extend `Record<string, Json>`.\n  // `ComposableController` state needs to accommodate `BaseControllerV1` state objects that may have properties wider than `Json`.\n  // TODO: Replace `any` with `Json` once `BaseControllerV2` migrations are completed for all controllers.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [name: string]: Record<string, any>;\n};\n\nexport type ComposableControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  Record<string, unknown>\n>;\n\nexport type ComposableControllerEvents = ComposableControllerStateChangeEvent;\n\ntype AnyControllerStateChangeEvent = ControllerStateChangeEvent<\n  string,\n  Record<string, unknown>\n>;\n\ntype AllowedEvents = AnyControllerStateChangeEvent;\n\nexport type ComposableControllerMessenger = RestrictedControllerMessenger<\n  typeof controllerName,\n  never,\n  ComposableControllerEvents | AllowedEvents,\n  never,\n  AllowedEvents['type']\n>;\n\n/**\n * Controller that can be used to compose multiple controllers together.\n */\nexport class ComposableController extends BaseController<\n  typeof controllerName,\n  ComposableControllerState,\n  ComposableControllerMessenger\n> {\n  /**\n   * Creates a ComposableController instance.\n   *\n   * @param options - Initial options used to configure this controller\n   * @param options.controllers - List of child controller instances to compose.\n   * @param options.messenger - A restricted controller messenger.\n   */\n\n  constructor({\n    controllers,\n    messenger,\n  }: {\n    controllers: ControllerInstance[];\n    messenger: ComposableControllerMessenger;\n  }) {\n    if (messenger === undefined) {\n      throw new Error(`Messaging system is required`);\n    }\n\n    super({\n      name: controllerName,\n      metadata: controllers.reduce<StateMetadata<ComposableControllerState>>(\n        (metadata, controller) => ({\n          ...metadata,\n          [controller.name]: isBaseController(controller)\n            ? controller.metadata\n            : { persist: true, anonymous: true },\n        }),\n        {},\n      ),\n      state: controllers.reduce<ComposableControllerState>(\n        (state, controller) => {\n          return { ...state, [controller.name]: controller.state };\n        },\n        {},\n      ),\n      messenger,\n    });\n\n    controllers.forEach((controller) =>\n      this.#updateChildController(controller),\n    );\n  }\n\n  /**\n   * Constructor helper that subscribes to child controller state changes.\n   * @param controller - Controller instance to update\n   * TODO: Remove `isBaseControllerV1` branch once `BaseControllerV2` migrations are completed for all controllers.\n   */\n  #updateChildController(controller: ControllerInstance): void {\n    const { name } = controller;\n    if (isBaseControllerV1(controller)) {\n      controller.subscribe((childState) => {\n        this.update((state) => ({\n          ...state,\n          [name]: childState,\n        }));\n      });\n    } else if (isBaseController(controller)) {\n      this.messagingSystem.subscribe(`${name}:stateChange`, (childState) => {\n        if (isValidJson(childState)) {\n          this.update((state) => ({\n            ...state,\n            [name]: childState,\n          }));\n        }\n      });\n    } else {\n      throw new Error(\n        'Invalid controller: controller must extend from BaseController or BaseControllerV1',\n      );\n    }\n  }\n}\n\nexport default ComposableController;\n"]}

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export type { ControllerList, ComposableControllerState, ComposableControllerStateChangeEvent, ComposableControllerEvents, ComposableControllerMessenger, } from './ComposableController';
-export { ComposableController } from './ComposableController';
+export type { BaseControllerV1Instance, BaseControllerV2Instance, ControllerInstance, ComposableControllerState, ComposableControllerStateChangeEvent, ComposableControllerEvents, ComposableControllerMessenger, } from './ComposableController';
+export { ComposableController, isBaseController, isBaseControllerV1, } from './ComposableController';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,cAAc,EACd,yBAAyB,EACzB,oCAAoC,EACpC,0BAA0B,EAC1B,6BAA6B,GAC9B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,wBAAwB,EACxB,wBAAwB,EACxB,kBAAkB,EAClB,yBAAyB,EACzB,oCAAoC,EACpC,0BAA0B,EAC1B,6BAA6B,GAC9B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,GACnB,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComposableController = void 0;
+exports.isBaseControllerV1 = exports.isBaseController = exports.ComposableController = void 0;
 var ComposableController_1 = require("./ComposableController");
 Object.defineProperty(exports, "ComposableController", { enumerable: true, get: function () { return ComposableController_1.ComposableController; } });
+Object.defineProperty(exports, "isBaseController", { enumerable: true, get: function () { return ComposableController_1.isBaseController; } });
+Object.defineProperty(exports, "isBaseControllerV1", { enumerable: true, get: function () { return ComposableController_1.isBaseControllerV1; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAOA,+DAA8D;AAArD,4HAAA,oBAAoB,OAAA","sourcesContent":["export type {\n  ControllerList,\n  ComposableControllerState,\n  ComposableControllerStateChangeEvent,\n  ComposableControllerEvents,\n  ComposableControllerMessenger,\n} from './ComposableController';\nexport { ComposableController } from './ComposableController';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AASA,+DAIgC;AAH9B,4HAAA,oBAAoB,OAAA;AACpB,wHAAA,gBAAgB,OAAA;AAChB,0HAAA,kBAAkB,OAAA","sourcesContent":["export type {\n  BaseControllerV1Instance,\n  BaseControllerV2Instance,\n  ControllerInstance,\n  ComposableControllerState,\n  ComposableControllerStateChangeEvent,\n  ComposableControllerEvents,\n  ComposableControllerMessenger,\n} from './ComposableController';\nexport {\n  ComposableController,\n  isBaseController,\n  isBaseControllerV1,\n} from './ComposableController';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/composable-controller",
-  "version": "5.0.1-preview.2431602",
+  "version": "5.0.1-preview.303e509",
   "description": "Consolidates the state from multiple controllers into one",
   "keywords": [
     "MetaMask",
@@ -31,10 +31,12 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^4.1.1"
+    "@metamask/base-controller": "^4.1.1",
+    "@metamask/utils": "^8.3.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/json-rpc-engine": "^7.3.2",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
     "immer": "^9.0.6",