@metamask-previews/composable-controller 4.0.0-preview.3fbb6b41 → 5.0.0-preview.1ef189c

package/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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.
+  - Any getters for `ComposableController` state that access the internal class field directly should be refactored to instead use listeners that are subscribed to `ComposableControllerStateChangeEvent`.
+- 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))
@@ -50,7 +61,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@4.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@5.0.0...HEAD
+[5.0.0]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@4.0.0...@metamask/composable-controller@5.0.0
 [4.0.0]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@3.0.3...@metamask/composable-controller@4.0.0
 [3.0.3]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@3.0.2...@metamask/composable-controller@3.0.3
 [3.0.2]: https://github.com/MetaMask/core/compare/@metamask/composable-controller@3.0.1...@metamask/composable-controller@3.0.2

package/dist/ComposableController.d.ts

@@ -1,36 +1,36 @@
-import type { RestrictedControllerMessenger } from '@metamask/base-controller';
-import { BaseControllerV1 } from '@metamask/base-controller';
+import { BaseController, BaseControllerV1 } from '@metamask/base-controller';
+import type { ControllerStateChangeEvent, RestrictedControllerMessenger } from '@metamask/base-controller';
+export declare const controllerName = "ComposableController";
+declare type ControllerInstance = BaseControllerV1<any, any> | {
+    name: string;
+    state: Record<string, unknown>;
+};
 /**
  * List of child controller instances
- *
- * This type encompasses controllers based up either BaseControllerV1 or
- * BaseController. The BaseController type can't be included directly
- * because the generic parameters it expects require knowing the exact state
- * shape, so instead we look for an object with the BaseController properties
- * that we use in the ComposableController (name and state).
  */
-export declare type ControllerList = (BaseControllerV1<any, any> | {
-    name: string;
-    state: Record<string, unknown>;
-})[];
-export declare type ComposableControllerRestrictedMessenger = RestrictedControllerMessenger<'ComposableController', never, any, never, any>;
+export declare type ControllerList = ControllerInstance[];
+export declare type ComposableControllerState = {
+    [name: string]: ControllerInstance['state'];
+};
+export declare type ComposableControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, ComposableControllerState>;
+export declare type ComposableControllerEvents = ComposableControllerStateChangeEvent;
+export declare type ComposableControllerMessenger = RestrictedControllerMessenger<typeof controllerName, never, ControllerStateChangeEvent<string, Record<string, unknown>>, string, string>;
 /**
  * Controller that can be used to compose multiple controllers together.
  */
-export declare class ComposableController extends BaseControllerV1<never, any> {
-    private readonly controllers;
-    private readonly messagingSystem?;
-    /**
-     * Name of this controller used during composition
-     */
-    name: string;
+export declare class ComposableController extends BaseController<typeof controllerName, ComposableControllerState, ComposableControllerMessenger> {
+    #private;
     /**
      * Creates a ComposableController instance.
      *
-     * @param controllers - Map of names to controller instances.
-     * @param messenger - The controller messaging system, used for communicating with BaseController controllers.
+     * @param options - Initial options used to configure this controller
+     * @param options.controllers - List of child controller instances to compose.
+     * @param options.messenger - A restricted controller messenger.
      */
-    constructor(controllers: ControllerList, messenger?: ComposableControllerRestrictedMessenger);
+    constructor({ controllers, messenger, }: {
+        controllers: ControllerList;
+        messenger: ComposableControllerMessenger;
+    });
     /**
      * Flat state representation, one that isn't keyed
      * of controller name. Instead, all child controller state is merged

package/dist/ComposableController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ComposableController.d.ts","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE7D;;;;;;;;GAQG;AACH,oBAAY,cAAc,GAAG,CACzB,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,GAC1B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CACnD,EAAE,CAAC;AAEJ,oBAAY,uCAAuC,GACjD,6BAA6B,CAAC,sBAAsB,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;AAEhF;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC;IACpE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAElD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAA0C;IAE3E;;OAEG;IACM,IAAI,SAA0B;IAEvC;;;;;OAKG;gBAED,WAAW,EAAE,cAAc,EAC3B,SAAS,CAAC,EAAE,uCAAuC;IAiCrD;;;;;;OAMG;IACH,IAAI,SAAS,OAMZ;CACF;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,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"}

package/dist/ComposableController.js

@@ -1,46 +1,55 @@
 "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;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComposableController = void 0;
+exports.ComposableController = exports.controllerName = void 0;
 const base_controller_1 = require("@metamask/base-controller");
+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
+ */
+function isBaseControllerV1(controller) {
+    return controller instanceof base_controller_1.BaseControllerV1;
+}
 /**
  * Controller that can be used to compose multiple controllers together.
  */
-class ComposableController extends base_controller_1.BaseControllerV1 {
+class ComposableController extends base_controller_1.BaseController {
     /**
      * Creates a ComposableController instance.
      *
-     * @param controllers - Map of names to controller instances.
-     * @param messenger - The controller messaging system, used for communicating with BaseController controllers.
+     * @param options - Initial options used to configure this controller
+     * @param options.controllers - List of child controller instances to compose.
+     * @param options.messenger - A restricted controller messenger.
      */
-    constructor(controllers, messenger) {
-        super(undefined, controllers.reduce((state, controller) => {
-            state[controller.name] = controller.state;
-            return state;
-        }, {}));
-        this.controllers = [];
-        /**
-         * Name of this controller used during composition
-         */
-        this.name = 'ComposableController';
-        this.initialize();
-        this.controllers = controllers;
-        this.messagingSystem = messenger;
-        this.controllers.forEach((controller) => {
-            const { name } = controller;
-            if (controller.subscribe !== undefined) {
-                controller.subscribe((state) => {
-                    this.update({ [name]: state });
-                });
-            }
-            else if (this.messagingSystem) {
-                this.messagingSystem.subscribe(`${name}:stateChange`, (state) => {
-                    this.update({ [name]: state });
-                });
-            }
-            else {
-                throw new Error(`Messaging system required if any BaseController controllers are used`);
-            }
+    constructor({ controllers, messenger, }) {
+        if (messenger === undefined) {
+            throw new Error(`Messaging system is required`);
+        }
+        super({
+            name: exports.controllerName,
+            metadata: {},
+            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
@@ -51,12 +60,25 @@ class ComposableController extends base_controller_1.BaseControllerV1 {
      */
     get flatState() {
         let flatState = {};
-        for (const controller of this.controllers) {
+        for (const controller of __classPrivateFieldGet(this, _ComposableController_controllers, "f")) {
             flatState = Object.assign(Object.assign({}, flatState), controller.state);
         }
         return flatState;
     }
 }
 exports.ComposableController = ComposableController;
+_ComposableController_controllers = new WeakMap(), _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 })));
+        });
+    }
+};
 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":";;;AACA,+DAA6D;AAmB7D;;GAEG;AACH,MAAa,oBAAqB,SAAQ,kCAA4B;IAUpE;;;;;OAKG;IACH,YACE,WAA2B,EAC3B,SAAmD;QAEnD,KAAK,CACH,SAAS,EACT,WAAW,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;YACvC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC;YAC1C,OAAO,KAAK,CAAC;QACf,CAAC,EAAE,EAAS,CAAC,CACd,CAAC;QAzBa,gBAAW,GAAmB,EAAE,CAAC;QAIlD;;WAEG;QACM,SAAI,GAAG,sBAAsB,CAAC;QAmBrC,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACtC,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;YAC5B,IAAK,UAAyC,CAAC,SAAS,KAAK,SAAS,EAAE;gBACrE,UAAyC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC7D,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjC,CAAC,CAAC,CAAC;aACJ;iBAAM,IAAI,IAAI,CAAC,eAAe,EAAE;gBAC9B,IAAI,CAAC,eAAe,CAAC,SAAiB,CACrC,GAAG,IAAI,cAAc,EACrB,CAAC,KAAU,EAAE,EAAE;oBACb,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjC,CAAC,CACF,CAAC;aACH;iBAAM;gBACL,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,IAAI,SAAS;QACX,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACzC,SAAS,mCAAQ,SAAS,GAAK,UAAU,CAAC,KAAK,CAAE,CAAC;SACnD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAjED,oDAiEC;AAED,kBAAe,oBAAoB,CAAC","sourcesContent":["import type { RestrictedControllerMessenger } from '@metamask/base-controller';\nimport { BaseControllerV1 } from '@metamask/base-controller';\n\n/**\n * List of child controller instances\n *\n * This type encompasses controllers based up 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 */\nexport type ControllerList = (\n  | BaseControllerV1<any, any>\n  | { name: string; state: Record<string, unknown> }\n)[];\n\nexport type ComposableControllerRestrictedMessenger =\n  RestrictedControllerMessenger<'ComposableController', never, any, never, any>;\n\n/**\n * Controller that can be used to compose multiple controllers together.\n */\nexport class ComposableController extends BaseControllerV1<never, any> {\n  private readonly controllers: ControllerList = [];\n\n  private readonly messagingSystem?: ComposableControllerRestrictedMessenger;\n\n  /**\n   * Name of this controller used during composition\n   */\n  override name = 'ComposableController';\n\n  /**\n   * Creates a ComposableController instance.\n   *\n   * @param controllers - Map of names to controller instances.\n   * @param messenger - The controller messaging system, used for communicating with BaseController controllers.\n   */\n  constructor(\n    controllers: ControllerList,\n    messenger?: ComposableControllerRestrictedMessenger,\n  ) {\n    super(\n      undefined,\n      controllers.reduce((state, controller) => {\n        state[controller.name] = controller.state;\n        return state;\n      }, {} as any),\n    );\n    this.initialize();\n    this.controllers = controllers;\n    this.messagingSystem = messenger;\n    this.controllers.forEach((controller) => {\n      const { name } = controller;\n      if ((controller as BaseControllerV1<any, any>).subscribe !== undefined) {\n        (controller as BaseControllerV1<any, any>).subscribe((state) => {\n          this.update({ [name]: state });\n        });\n      } else if (this.messagingSystem) {\n        (this.messagingSystem.subscribe as any)(\n          `${name}:stateChange`,\n          (state: any) => {\n            this.update({ [name]: state });\n          },\n        );\n      } else {\n        throw new Error(\n          `Messaging system required if any BaseController controllers are used`,\n        );\n      }\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\nexport default ComposableController;\n"]}
+{"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"]}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
-export * from './ComposableController';
+export type { ControllerList, ComposableControllerState, ComposableControllerStateChangeEvent, ComposableControllerEvents, ComposableControllerMessenger, } from './ComposableController';
+export { ComposableController } 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,cAAc,wBAAwB,CAAC"}
+{"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"}

package/dist/index.js

@@ -1,18 +1,6 @@
 "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("./ComposableController"), exports);
+exports.ComposableController = void 0;
+var ComposableController_1 = require("./ComposableController");
+Object.defineProperty(exports, "ComposableController", { enumerable: true, get: function () { return ComposableController_1.ComposableController; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC","sourcesContent":["export * from './ComposableController';\n"]}
+{"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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/composable-controller",
-  "version": "4.0.0-preview.3fbb6b41",
+  "version": "5.0.0-preview.1ef189c",
   "description": "Consolidates the state from multiple controllers into one",
   "keywords": [
     "MetaMask",
@@ -22,6 +22,7 @@
   ],
   "scripts": {
     "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/composable-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/composable-controller",
     "publish:preview": "yarn npm publish --tag preview",
     "test": "jest --reporters=jest-silent-reporter",
@@ -30,10 +31,10 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^4.0.0"
+    "@metamask/base-controller": "^4.1.0"
   },
   "devDependencies": {
-    "@metamask/auto-changelog": "^3.4.3",
+    "@metamask/auto-changelog": "^3.4.4",
     "@types/jest": "^27.4.1",
     "deepmerge": "^4.2.2",
     "immer": "^9.0.6",