@metamask-previews/composable-controller 9.0.1-preview-b5d0cd70 → 9.0.1-preview-9d476a5

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **BREAKING:** `ComposableController` constructor option `controllers` and generic type argument `ChildControllers` are re-defined from an array of controller instances to an object that maps controller names to controller instances.
+- **BREAKING:** `ComposableController` `state` field and `metadata` objects exclude child controllers that do not extend from `BaseController` or `BaseControllerV1`.
+
+## Fixed
+
+- **BREAKING:** `ComposableController` `metadata` field object now correctly populates `BaseControllerV1` controller properties with a metadata object that maps state property names to `StateMetadataProperty` type objects.
+  - Previously, during `metadata` object instantiation, `BaseControllerV1` controllers were assigned the object `{ persist: true, anonymous: true }`, and their state properties were overwritten.
+
 ## [9.0.1]
 
 ### Fixed

package/dist/ComposableController.cjs

@@ -21,7 +21,7 @@ class ComposableController extends base_controller_1.BaseController {
      * Creates a ComposableController instance.
      *
      * @param options - Initial options used to configure this controller
-     * @param options.controllers - List of child controller instances to compose.
+     * @param options.controllers - An object of child controller instances to compose that is keyed with the names of the controllers.
      * @param options.messenger - A restricted controller messenger.
      */
     constructor({ controllers, messenger, }) {
@@ -30,19 +30,33 @@ class ComposableController extends base_controller_1.BaseController {
         }
         super({
             name: exports.controllerName,
-            metadata: controllers.reduce((metadata, controller) => ({
-                ...metadata,
-                [controller.name]: (0, base_controller_1.isBaseController)(controller)
-                    ? controller.metadata
-                    : { persist: true, anonymous: true },
-            }), {}),
-            state: controllers.reduce((state, controller) => {
-                return { ...state, [controller.name]: controller.state };
+            metadata: Object.entries(controllers).reduce((metadata, [name, controller]) => {
+                if ((0, base_controller_1.isBaseController)(controller)) {
+                    // Type assertion is necessary for to assign new properties to a generic type - ts(2862)
+                    metadata[name] = controller.metadata;
+                }
+                else if ((0, base_controller_1.isBaseControllerV1)(controller)) {
+                    // Type assertion is necessary for to assign new properties to a generic type - ts(2862)
+                    metadata[name] = Object.keys(controller.state).reduce((acc, curr) => {
+                        acc[curr] = { persist: true, anonymous: true };
+                        return acc;
+                    }, {});
+                }
+                return metadata;
+            }, {}),
+            state: Object.entries(controllers).reduce((state, [name, controller]) => {
+                if ((0, base_controller_1.isBaseController)(controller) || (0, base_controller_1.isBaseControllerV1)(controller)) {
+                    // Type assertion is necessary for to assign new properties to a generic type - ts(2862)
+                    // TODO: Remove the 'object' member once `BaseControllerV2` migrations are completed for all controllers.
+                    state[name] =
+                        controller.state;
+                }
+                return state;
             }, {}),
             messenger,
         });
         _ComposableController_instances.add(this);
-        controllers.forEach((controller) => __classPrivateFieldGet(this, _ComposableController_instances, "m", _ComposableController_updateChildController).call(this, controller));
+        Object.keys(controllers).forEach((name) => __classPrivateFieldGet(this, _ComposableController_instances, "m", _ComposableController_updateChildController).call(this, controllers[name]));
     }
 }
 exports.ComposableController = ComposableController;

package/dist/ComposableController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ComposableController.cjs","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;;;;AASA,+DAImC;AAGtB,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAExC,QAAA,wBAAwB,GACnC,gHAAgH,CAAC;AAyGnH;;;;;GAKG;AACH,MAAa,oBAGX,SAAQ,gCAIT;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,CAAC;gBACzB,GAAG,QAAQ;gBACX,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAA,kCAAgB,EAAC,UAAU,CAAC;oBAC7C,CAAC,CAAC,UAAU,CAAC,QAAQ;oBACrB,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;aACvC,CAAC,EACF,EAAW,CACZ;YACD,KAAK,EAAE,WAAW,CAAC,MAAM,CACvB,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBACpB,OAAO,EAAE,GAAG,KAAK,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC;YAC3D,CAAC,EACD,EAAW,CACZ;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;CAsCF;AAxFD,oDAwFC;oJA/BwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,CAAC,IAAA,kCAAgB,EAAC,UAAU,CAAC,IAAI,CAAC,IAAA,oCAAkB,EAAC,UAAU,CAAC,EAAE;QACpE,2CAA2C;QAC3C,4EAA4E;QAC5E,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,MAAM,gCAAwB,EAAE,CAAC,CAAC;KAC1D;IACD,IAAI;QACF,IAAI,CAAC,eAAe,CAAC,SAAS;QAC5B,2CAA2C;QAC3C,4EAA4E;QAC5E,GAAG,IAAI,cAAc,EACrB,CAAC,UAA2C,EAAE,EAAE;YAC9C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC,CACF,CAAC;KACH;IAAC,OAAO,KAAc,EAAE;QACvB,2CAA2C;QAC3C,4EAA4E;QAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KAC7C;IACD,IAAI,IAAA,oCAAkB,EAAC,UAAU,CAAC,EAAE;QAClC,UAAU,CAAC,SAAS,CAAC,CAAC,UAA6B,EAAE,EAAE;YACrD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAGH,kBAAe,oBAAoB,CAAC","sourcesContent":["import type {\n  RestrictedControllerMessenger,\n  StateConstraint,\n  StateConstraintV1,\n  StateMetadata,\n  ControllerStateChangeEvent,\n  LegacyControllerStateConstraint,\n  ControllerInstance,\n} from '@metamask/base-controller';\nimport {\n  BaseController,\n  isBaseController,\n  isBaseControllerV1,\n} from '@metamask/base-controller';\nimport type { Patch } from 'immer';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must have a `messagingSystem` or be a class inheriting from `BaseControllerV1`.';\n\n/**\n * A universal supertype for the composable controller state object.\n *\n * This type is only intended to be used for disabling the generic constraint on the `ControllerState` type argument in the `BaseController` type as a temporary solution for ensuring compatibility with BaseControllerV1 child controllers.\n * Note that it is unsuitable for general use as a type constraint.\n */\n// TODO: Replace with `ComposableControllerStateConstraint` once BaseControllerV2 migrations are completed for all controllers.\ntype LegacyComposableControllerStateConstraint = {\n  // `any` is used here to disable the generic constraint on the `ControllerState` type argument in the `BaseController` type,\n  // enabling composable controller state types with BaseControllerV1 state objects to be.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [name: string]: Record<string, any>;\n};\n\n/**\n * The narrowest supertype for the composable controller state object.\n * This is also a widest subtype of the 'LegacyComposableControllerStateConstraint' type.\n */\n// TODO: Replace with `{ [name: string]: StateConstraint }` once BaseControllerV2 migrations are completed for all controllers.\nexport type ComposableControllerStateConstraint = {\n  [name: string]: LegacyControllerStateConstraint;\n};\n\n/**\n * A `stateChange` event for any controller instance that extends from either `BaseControllerV1` or `BaseControllerV2`.\n */\n// TODO: Replace all instances with `ControllerStateChangeEvent` once `BaseControllerV2` migrations are completed for all controllers.\ntype LegacyControllerStateChangeEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraintV1,\n> = {\n  type: `${ControllerName}:stateChange`;\n  payload: [ControllerState, Patch[]];\n};\n\n/**\n * The `stateChange` event type for the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerStateChangeEvent<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = LegacyControllerStateChangeEvent<\n  typeof controllerName,\n  ComposableControllerState\n>;\n\n/**\n * A union type of internal event types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerStateChangeEvent<ComposableControllerState>;\n\n/**\n * A utility type that extracts controllers from the {@link ComposableControllerState} type,\n * and derives a union type of all of their corresponding `stateChange` events.\n *\n * This type can handle both `BaseController` and `BaseControllerV1` controller instances.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ChildControllerStateChangeEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerState extends Record<\n  infer ControllerName extends string,\n  infer ControllerState\n>\n  ? ControllerState extends StateConstraint\n    ? ControllerStateChangeEvent<ControllerName, ControllerState>\n    : // TODO: Remove this conditional branch once `BaseControllerV2` migrations are completed for all controllers.\n    ControllerState extends StateConstraintV1\n    ? LegacyControllerStateChangeEvent<ControllerName, ControllerState>\n    : never\n  : never;\n\n/**\n * A union type of external event types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type AllowedEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ChildControllerStateChangeEvents<ComposableControllerState>;\n\n/**\n * The messenger of the {@link ComposableController}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerMessenger<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = RestrictedControllerMessenger<\n  typeof controllerName,\n  never,\n  | ComposableControllerEvents<ComposableControllerState>\n  | AllowedEvents<ComposableControllerState>,\n  never,\n  AllowedEvents<ComposableControllerState>['type']\n>;\n\n/**\n * Controller that composes multiple child controllers and maintains up-to-date composed state.\n *\n * @template ComposableControllerState - A type object containing the names and state types of the child controllers.\n * @template ChildControllers - A union type of the child controllers being used to instantiate the {@link ComposableController}.\n */\nexport class ComposableController<\n  ComposableControllerState extends LegacyComposableControllerStateConstraint,\n  ChildControllers extends ControllerInstance,\n> extends BaseController<\n  typeof controllerName,\n  ComposableControllerState,\n  ComposableControllerMessenger<ComposableControllerState>\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: ChildControllers[];\n    messenger: ComposableControllerMessenger<ComposableControllerState>;\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        {} as never,\n      ),\n      state: controllers.reduce<ComposableControllerState>(\n        (state, controller) => {\n          return { ...state, [controller.name]: controller.state };\n        },\n        {} as never,\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   *\n   * @param controller - Controller instance to update\n   */\n  #updateChildController(controller: ControllerInstance): void {\n    const { name } = controller;\n    if (!isBaseController(controller) && !isBaseControllerV1(controller)) {\n      // False negative. `name` is a string type.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n      throw new Error(`${name} - ${INVALID_CONTROLLER_ERROR}`);\n    }\n    try {\n      this.messagingSystem.subscribe(\n        // False negative. `name` is a string type.\n        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n        `${name}:stateChange`,\n        (childState: LegacyControllerStateConstraint) => {\n          this.update((state) => {\n            Object.assign(state, { [name]: childState });\n          });\n        },\n      );\n    } catch (error: unknown) {\n      // False negative. `name` is a string type.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n      console.error(`${name} - ${String(error)}`);\n    }\n    if (isBaseControllerV1(controller)) {\n      controller.subscribe((childState: StateConstraintV1) => {\n        this.update((state) => {\n          Object.assign(state, { [name]: childState });\n        });\n      });\n    }\n  }\n}\n\nexport default ComposableController;\n"]}
+{"version":3,"file":"ComposableController.cjs","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;;;;AAUA,+DAImC;AAGtB,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAExC,QAAA,wBAAwB,GACnC,gHAAgH,CAAC;AAyGnH;;;;;GAKG;AACH,MAAa,oBAGX,SAAQ,gCAIT;IACC;;;;;;OAMG;IACH,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,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CAE1C,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE;gBACjC,IAAI,IAAA,kCAAgB,EAAC,UAAU,CAAC,EAAE;oBAChC,wFAAwF;oBACvF,QAA+D,CAC9D,IAAI,CACL,GAAG,UAAU,CAAC,QAAQ,CAAC;iBACzB;qBAAM,IAAI,IAAA,oCAAkB,EAAC,UAAU,CAAC,EAAE;oBACzC,wFAAwF;oBACvF,QAA+D,CAC9D,IAAI,CACL,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CACtC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;wBACZ,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;wBAC/C,OAAO,GAAG,CAAC;oBACb,CAAC,EACD,EAAW,CACZ,CAAC;iBACH;gBACD,OAAO,QAAQ,CAAC;YAClB,CAAC,EAAE,EAAW,CAAC;YACf,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CACvC,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE;gBAC5B,IAAI,IAAA,kCAAgB,EAAC,UAAU,CAAC,IAAI,IAAA,oCAAkB,EAAC,UAAU,CAAC,EAAE;oBAClE,wFAAwF;oBACxF,yGAAyG;oBACxG,KAAkD,CAAC,IAAI,CAAC;wBACvD,UAAU,CAAC,KAAK,CAAC;iBACpB;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,EACD,EAAW,CACZ;YACD,SAAS;SACV,CAAC,CAAC;;QAEH,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CACxC,uBAAA,IAAI,oFAAuB,MAA3B,IAAI,EAAwB,WAAW,CAAC,IAAI,CAAC,CAAC,CAC/C,CAAC;IACJ,CAAC;CAsCF;AA1GD,oDA0GC;oJA/BwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,CAAC,IAAA,kCAAgB,EAAC,UAAU,CAAC,IAAI,CAAC,IAAA,oCAAkB,EAAC,UAAU,CAAC,EAAE;QACpE,2CAA2C;QAC3C,4EAA4E;QAC5E,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,MAAM,gCAAwB,EAAE,CAAC,CAAC;KAC1D;IACD,IAAI;QACF,IAAI,CAAC,eAAe,CAAC,SAAS;QAC5B,2CAA2C;QAC3C,4EAA4E;QAC5E,GAAG,IAAI,cAAc,EACrB,CAAC,UAA2C,EAAE,EAAE;YAC9C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC,CACF,CAAC;KACH;IAAC,OAAO,KAAc,EAAE;QACvB,2CAA2C;QAC3C,4EAA4E;QAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KAC7C;IACD,IAAI,IAAA,oCAAkB,EAAC,UAAU,CAAC,EAAE;QAClC,UAAU,CAAC,SAAS,CAAC,CAAC,UAA6B,EAAE,EAAE;YACrD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAGH,kBAAe,oBAAoB,CAAC","sourcesContent":["import type {\n  RestrictedControllerMessenger,\n  StateConstraint,\n  StateConstraintV1,\n  StateMetadata,\n  StateMetadataConstraint,\n  ControllerStateChangeEvent,\n  LegacyControllerStateConstraint,\n  ControllerInstance,\n} from '@metamask/base-controller';\nimport {\n  BaseController,\n  isBaseController,\n  isBaseControllerV1,\n} from '@metamask/base-controller';\nimport type { Patch } from 'immer';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must have a `messagingSystem` or be a class inheriting from `BaseControllerV1`.';\n\n/**\n * A universal supertype for the composable controller state object.\n *\n * This type is only intended to be used for disabling the generic constraint on the `ControllerState` type argument in the `BaseController` type as a temporary solution for ensuring compatibility with BaseControllerV1 child controllers.\n * Note that it is unsuitable for general use as a type constraint.\n */\n// TODO: Replace with `ComposableControllerStateConstraint` once BaseControllerV2 migrations are completed for all controllers.\ntype LegacyComposableControllerStateConstraint = {\n  // `any` is used here to disable the generic constraint on the `ControllerState` type argument in the `BaseController` type,\n  // enabling composable controller state types with BaseControllerV1 state objects to be.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [name: string]: Record<string, any>;\n};\n\n/**\n * The narrowest supertype for the composable controller state object.\n * This is also a widest subtype of the 'LegacyComposableControllerStateConstraint' type.\n */\n// TODO: Replace with `{ [name: string]: StateConstraint }` once BaseControllerV2 migrations are completed for all controllers.\nexport type ComposableControllerStateConstraint = {\n  [name: string]: LegacyControllerStateConstraint;\n};\n\n/**\n * A `stateChange` event for any controller instance that extends from either `BaseControllerV1` or `BaseControllerV2`.\n */\n// TODO: Replace all instances with `ControllerStateChangeEvent` once `BaseControllerV2` migrations are completed for all controllers.\ntype LegacyControllerStateChangeEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraintV1,\n> = {\n  type: `${ControllerName}:stateChange`;\n  payload: [ControllerState, Patch[]];\n};\n\n/**\n * The `stateChange` event type for the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerStateChangeEvent<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = LegacyControllerStateChangeEvent<\n  typeof controllerName,\n  ComposableControllerState\n>;\n\n/**\n * A union type of internal event types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerStateChangeEvent<ComposableControllerState>;\n\n/**\n * A utility type that extracts controllers from the {@link ComposableControllerState} type,\n * and derives a union type of all of their corresponding `stateChange` events.\n *\n * This type can handle both `BaseController` and `BaseControllerV1` controller instances.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ChildControllerStateChangeEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerState extends Record<\n  infer ControllerName extends string,\n  infer ControllerState\n>\n  ? ControllerState extends StateConstraint\n    ? ControllerStateChangeEvent<ControllerName, ControllerState>\n    : // TODO: Remove this conditional branch once `BaseControllerV2` migrations are completed for all controllers.\n    ControllerState extends StateConstraintV1\n    ? LegacyControllerStateChangeEvent<ControllerName, ControllerState>\n    : never\n  : never;\n\n/**\n * A union type of external event types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type AllowedEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ChildControllerStateChangeEvents<ComposableControllerState>;\n\n/**\n * The messenger of the {@link ComposableController}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerMessenger<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = RestrictedControllerMessenger<\n  typeof controllerName,\n  never,\n  | ComposableControllerEvents<ComposableControllerState>\n  | AllowedEvents<ComposableControllerState>,\n  never,\n  AllowedEvents<ComposableControllerState>['type']\n>;\n\n/**\n * Controller that composes multiple child controllers and maintains up-to-date composed state.\n *\n * @template ComposableControllerState - A type object containing the names and state types of the child controllers.\n * @template ChildControllers - A union type of the child controllers being used to instantiate the {@link ComposableController}.\n */\nexport class ComposableController<\n  ComposableControllerState extends LegacyComposableControllerStateConstraint,\n  ChildControllers extends Record<string, ControllerInstance>,\n> extends BaseController<\n  typeof controllerName,\n  ComposableControllerState,\n  ComposableControllerMessenger<ComposableControllerState>\n> {\n  /**\n   * Creates a ComposableController instance.\n   *\n   * @param options - Initial options used to configure this controller\n   * @param options.controllers - An object of child controller instances to compose that is keyed with the names of the controllers.\n   * @param options.messenger - A restricted controller messenger.\n   */\n  constructor({\n    controllers,\n    messenger,\n  }: {\n    controllers: ChildControllers;\n    messenger: ComposableControllerMessenger<ComposableControllerState>;\n  }) {\n    if (messenger === undefined) {\n      throw new Error(`Messaging system is required`);\n    }\n\n    super({\n      name: controllerName,\n      metadata: Object.entries(controllers).reduce<\n        StateMetadata<ComposableControllerState>\n      >((metadata, [name, controller]) => {\n        if (isBaseController(controller)) {\n          // Type assertion is necessary for to assign new properties to a generic type - ts(2862)\n          (metadata as unknown as Record<string, StateMetadataConstraint>)[\n            name\n          ] = controller.metadata;\n        } else if (isBaseControllerV1(controller)) {\n          // Type assertion is necessary for to assign new properties to a generic type - ts(2862)\n          (metadata as unknown as Record<string, StateMetadataConstraint>)[\n            name\n          ] = Object.keys(controller.state).reduce<StateMetadataConstraint>(\n            (acc, curr) => {\n              acc[curr] = { persist: true, anonymous: true };\n              return acc;\n            },\n            {} as never,\n          );\n        }\n        return metadata;\n      }, {} as never),\n      state: Object.entries(controllers).reduce<ComposableControllerState>(\n        (state, [name, controller]) => {\n          if (isBaseController(controller) || isBaseControllerV1(controller)) {\n            // Type assertion is necessary for to assign new properties to a generic type - ts(2862)\n            // TODO: Remove the 'object' member once `BaseControllerV2` migrations are completed for all controllers.\n            (state as Record<string, StateConstraint | object>)[name] =\n              controller.state;\n          }\n          return state;\n        },\n        {} as never,\n      ),\n      messenger,\n    });\n\n    Object.keys(controllers).forEach((name) =>\n      this.#updateChildController(controllers[name]),\n    );\n  }\n\n  /**\n   * Constructor helper that subscribes to child controller state changes.\n   *\n   * @param controller - Controller instance to update\n   */\n  #updateChildController(controller: ControllerInstance): void {\n    const { name } = controller;\n    if (!isBaseController(controller) && !isBaseControllerV1(controller)) {\n      // False negative. `name` is a string type.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n      throw new Error(`${name} - ${INVALID_CONTROLLER_ERROR}`);\n    }\n    try {\n      this.messagingSystem.subscribe(\n        // False negative. `name` is a string type.\n        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n        `${name}:stateChange`,\n        (childState: LegacyControllerStateConstraint) => {\n          this.update((state) => {\n            Object.assign(state, { [name]: childState });\n          });\n        },\n      );\n    } catch (error: unknown) {\n      // False negative. `name` is a string type.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n      console.error(`${name} - ${String(error)}`);\n    }\n    if (isBaseControllerV1(controller)) {\n      controller.subscribe((childState: StateConstraintV1) => {\n        this.update((state) => {\n          Object.assign(state, { [name]: childState });\n        });\n      });\n    }\n  }\n}\n\nexport default ComposableController;\n"]}

package/dist/ComposableController.d.cts

@@ -65,17 +65,17 @@ export type ComposableControllerMessenger<ComposableControllerState extends Comp
  * @template ComposableControllerState - A type object containing the names and state types of the child controllers.
  * @template ChildControllers - A union type of the child controllers being used to instantiate the {@link ComposableController}.
  */
-export declare class ComposableController<ComposableControllerState extends LegacyComposableControllerStateConstraint, ChildControllers extends ControllerInstance> extends BaseController<typeof controllerName, ComposableControllerState, ComposableControllerMessenger<ComposableControllerState>> {
+export declare class ComposableController<ComposableControllerState extends LegacyComposableControllerStateConstraint, ChildControllers extends Record<string, ControllerInstance>> extends BaseController<typeof controllerName, ComposableControllerState, ComposableControllerMessenger<ComposableControllerState>> {
     #private;
     /**
      * Creates a ComposableController instance.
      *
      * @param options - Initial options used to configure this controller
-     * @param options.controllers - List of child controller instances to compose.
+     * @param options.controllers - An object of child controller instances to compose that is keyed with the names of the controllers.
      * @param options.messenger - A restricted controller messenger.
      */
     constructor({ controllers, messenger, }: {
-        controllers: ChildControllers[];
+        controllers: ChildControllers;
         messenger: ComposableControllerMessenger<ComposableControllerState>;
     });
 }

package/dist/ComposableController.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"ComposableController.d.cts","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,6BAA6B,EAC7B,eAAe,EACf,iBAAiB,EAEjB,0BAA0B,EAC1B,+BAA+B,EAC/B,kBAAkB,EACnB,kCAAkC;AACnC,OAAO,EACL,cAAc,EAGf,kCAAkC;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,cAAc;AAEnC,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAErD,eAAO,MAAM,wBAAwB,mHAC6E,CAAC;AAEnH;;;;;GAKG;AAEH,KAAK,yCAAyC,GAAG;IAI/C,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACrC,CAAC;AAEF;;;GAGG;AAEH,MAAM,MAAM,mCAAmC,GAAG;IAChD,CAAC,IAAI,EAAE,MAAM,GAAG,+BAA+B,CAAC;CACjD,CAAC;AAEF;;GAEG;AAEH,KAAK,gCAAgC,CACnC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,iBAAiB,IACvC;IACF,IAAI,EAAE,GAAG,cAAc,cAAc,CAAC;IACtC,OAAO,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,CAC9C,yBAAyB,SAAS,mCAAmC,IACnE,gCAAgC,CAClC,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CACpC,yBAAyB,SAAS,mCAAmC,IACnE,oCAAoC,CAAC,yBAAyB,CAAC,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,MAAM,gCAAgC,CAC1C,yBAAyB,SAAS,mCAAmC,IACnE,yBAAyB,SAAS,MAAM,CAC1C,MAAM,cAAc,SAAS,MAAM,EACnC,MAAM,eAAe,CACtB,GACG,eAAe,SAAS,eAAe,GACrC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAE7D,eAAe,SAAS,iBAAiB,GACvC,gCAAgC,CAAC,cAAc,EAAE,eAAe,CAAC,GACjE,KAAK,GACP,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,aAAa,CACvB,yBAAyB,SAAS,mCAAmC,IACnE,gCAAgC,CAAC,yBAAyB,CAAC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,CACvC,yBAAyB,SAAS,mCAAmC,IACnE,6BAA6B,CAC/B,OAAO,cAAc,EACrB,KAAK,EACH,0BAA0B,CAAC,yBAAyB,CAAC,GACrD,aAAa,CAAC,yBAAyB,CAAC,EAC1C,KAAK,EACL,aAAa,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,CACjD,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,oBAAoB,CAC/B,yBAAyB,SAAS,yCAAyC,EAC3E,gBAAgB,SAAS,kBAAkB,CAC3C,SAAQ,cAAc,CACtB,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAAC,yBAAyB,CAAC,CACzD;;IACC;;;;;;OAMG;gBAES,EACV,WAAW,EACX,SAAS,GACV,EAAE;QACD,WAAW,EAAE,gBAAgB,EAAE,CAAC;QAChC,SAAS,EAAE,6BAA6B,CAAC,yBAAyB,CAAC,CAAC;KACrE;CAkEF;AAED,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"ComposableController.d.cts","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,6BAA6B,EAC7B,eAAe,EACf,iBAAiB,EAGjB,0BAA0B,EAC1B,+BAA+B,EAC/B,kBAAkB,EACnB,kCAAkC;AACnC,OAAO,EACL,cAAc,EAGf,kCAAkC;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,cAAc;AAEnC,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAErD,eAAO,MAAM,wBAAwB,mHAC6E,CAAC;AAEnH;;;;;GAKG;AAEH,KAAK,yCAAyC,GAAG;IAI/C,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACrC,CAAC;AAEF;;;GAGG;AAEH,MAAM,MAAM,mCAAmC,GAAG;IAChD,CAAC,IAAI,EAAE,MAAM,GAAG,+BAA+B,CAAC;CACjD,CAAC;AAEF;;GAEG;AAEH,KAAK,gCAAgC,CACnC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,iBAAiB,IACvC;IACF,IAAI,EAAE,GAAG,cAAc,cAAc,CAAC;IACtC,OAAO,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,CAC9C,yBAAyB,SAAS,mCAAmC,IACnE,gCAAgC,CAClC,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CACpC,yBAAyB,SAAS,mCAAmC,IACnE,oCAAoC,CAAC,yBAAyB,CAAC,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,MAAM,gCAAgC,CAC1C,yBAAyB,SAAS,mCAAmC,IACnE,yBAAyB,SAAS,MAAM,CAC1C,MAAM,cAAc,SAAS,MAAM,EACnC,MAAM,eAAe,CACtB,GACG,eAAe,SAAS,eAAe,GACrC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAE7D,eAAe,SAAS,iBAAiB,GACvC,gCAAgC,CAAC,cAAc,EAAE,eAAe,CAAC,GACjE,KAAK,GACP,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,aAAa,CACvB,yBAAyB,SAAS,mCAAmC,IACnE,gCAAgC,CAAC,yBAAyB,CAAC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,CACvC,yBAAyB,SAAS,mCAAmC,IACnE,6BAA6B,CAC/B,OAAO,cAAc,EACrB,KAAK,EACH,0BAA0B,CAAC,yBAAyB,CAAC,GACrD,aAAa,CAAC,yBAAyB,CAAC,EAC1C,KAAK,EACL,aAAa,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,CACjD,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,oBAAoB,CAC/B,yBAAyB,SAAS,yCAAyC,EAC3E,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAC3D,SAAQ,cAAc,CACtB,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAAC,yBAAyB,CAAC,CACzD;;IACC;;;;;;OAMG;gBACS,EACV,WAAW,EACX,SAAS,GACV,EAAE;QACD,WAAW,EAAE,gBAAgB,CAAC;QAC9B,SAAS,EAAE,6BAA6B,CAAC,yBAAyB,CAAC,CAAC;KACrE;CAqFF;AAED,eAAe,oBAAoB,CAAC"}

package/dist/ComposableController.d.mts

@@ -65,17 +65,17 @@ export type ComposableControllerMessenger<ComposableControllerState extends Comp
  * @template ComposableControllerState - A type object containing the names and state types of the child controllers.
  * @template ChildControllers - A union type of the child controllers being used to instantiate the {@link ComposableController}.
  */
-export declare class ComposableController<ComposableControllerState extends LegacyComposableControllerStateConstraint, ChildControllers extends ControllerInstance> extends BaseController<typeof controllerName, ComposableControllerState, ComposableControllerMessenger<ComposableControllerState>> {
+export declare class ComposableController<ComposableControllerState extends LegacyComposableControllerStateConstraint, ChildControllers extends Record<string, ControllerInstance>> extends BaseController<typeof controllerName, ComposableControllerState, ComposableControllerMessenger<ComposableControllerState>> {
     #private;
     /**
      * Creates a ComposableController instance.
      *
      * @param options - Initial options used to configure this controller
-     * @param options.controllers - List of child controller instances to compose.
+     * @param options.controllers - An object of child controller instances to compose that is keyed with the names of the controllers.
      * @param options.messenger - A restricted controller messenger.
      */
     constructor({ controllers, messenger, }: {
-        controllers: ChildControllers[];
+        controllers: ChildControllers;
         messenger: ComposableControllerMessenger<ComposableControllerState>;
     });
 }

package/dist/ComposableController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"ComposableController.d.mts","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,6BAA6B,EAC7B,eAAe,EACf,iBAAiB,EAEjB,0BAA0B,EAC1B,+BAA+B,EAC/B,kBAAkB,EACnB,kCAAkC;AACnC,OAAO,EACL,cAAc,EAGf,kCAAkC;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,cAAc;AAEnC,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAErD,eAAO,MAAM,wBAAwB,mHAC6E,CAAC;AAEnH;;;;;GAKG;AAEH,KAAK,yCAAyC,GAAG;IAI/C,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACrC,CAAC;AAEF;;;GAGG;AAEH,MAAM,MAAM,mCAAmC,GAAG;IAChD,CAAC,IAAI,EAAE,MAAM,GAAG,+BAA+B,CAAC;CACjD,CAAC;AAEF;;GAEG;AAEH,KAAK,gCAAgC,CACnC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,iBAAiB,IACvC;IACF,IAAI,EAAE,GAAG,cAAc,cAAc,CAAC;IACtC,OAAO,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,CAC9C,yBAAyB,SAAS,mCAAmC,IACnE,gCAAgC,CAClC,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CACpC,yBAAyB,SAAS,mCAAmC,IACnE,oCAAoC,CAAC,yBAAyB,CAAC,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,MAAM,gCAAgC,CAC1C,yBAAyB,SAAS,mCAAmC,IACnE,yBAAyB,SAAS,MAAM,CAC1C,MAAM,cAAc,SAAS,MAAM,EACnC,MAAM,eAAe,CACtB,GACG,eAAe,SAAS,eAAe,GACrC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAE7D,eAAe,SAAS,iBAAiB,GACvC,gCAAgC,CAAC,cAAc,EAAE,eAAe,CAAC,GACjE,KAAK,GACP,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,aAAa,CACvB,yBAAyB,SAAS,mCAAmC,IACnE,gCAAgC,CAAC,yBAAyB,CAAC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,CACvC,yBAAyB,SAAS,mCAAmC,IACnE,6BAA6B,CAC/B,OAAO,cAAc,EACrB,KAAK,EACH,0BAA0B,CAAC,yBAAyB,CAAC,GACrD,aAAa,CAAC,yBAAyB,CAAC,EAC1C,KAAK,EACL,aAAa,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,CACjD,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,oBAAoB,CAC/B,yBAAyB,SAAS,yCAAyC,EAC3E,gBAAgB,SAAS,kBAAkB,CAC3C,SAAQ,cAAc,CACtB,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAAC,yBAAyB,CAAC,CACzD;;IACC;;;;;;OAMG;gBAES,EACV,WAAW,EACX,SAAS,GACV,EAAE;QACD,WAAW,EAAE,gBAAgB,EAAE,CAAC;QAChC,SAAS,EAAE,6BAA6B,CAAC,yBAAyB,CAAC,CAAC;KACrE;CAkEF;AAED,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"ComposableController.d.mts","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,6BAA6B,EAC7B,eAAe,EACf,iBAAiB,EAGjB,0BAA0B,EAC1B,+BAA+B,EAC/B,kBAAkB,EACnB,kCAAkC;AACnC,OAAO,EACL,cAAc,EAGf,kCAAkC;AACnC,OAAO,KAAK,EAAE,KAAK,EAAE,cAAc;AAEnC,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAErD,eAAO,MAAM,wBAAwB,mHAC6E,CAAC;AAEnH;;;;;GAKG;AAEH,KAAK,yCAAyC,GAAG;IAI/C,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACrC,CAAC;AAEF;;;GAGG;AAEH,MAAM,MAAM,mCAAmC,GAAG;IAChD,CAAC,IAAI,EAAE,MAAM,GAAG,+BAA+B,CAAC;CACjD,CAAC;AAEF;;GAEG;AAEH,KAAK,gCAAgC,CACnC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,iBAAiB,IACvC;IACF,IAAI,EAAE,GAAG,cAAc,cAAc,CAAC;IACtC,OAAO,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,CAC9C,yBAAyB,SAAS,mCAAmC,IACnE,gCAAgC,CAClC,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CACpC,yBAAyB,SAAS,mCAAmC,IACnE,oCAAoC,CAAC,yBAAyB,CAAC,CAAC;AAEpE;;;;;;;GAOG;AACH,MAAM,MAAM,gCAAgC,CAC1C,yBAAyB,SAAS,mCAAmC,IACnE,yBAAyB,SAAS,MAAM,CAC1C,MAAM,cAAc,SAAS,MAAM,EACnC,MAAM,eAAe,CACtB,GACG,eAAe,SAAS,eAAe,GACrC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAE7D,eAAe,SAAS,iBAAiB,GACvC,gCAAgC,CAAC,cAAc,EAAE,eAAe,CAAC,GACjE,KAAK,GACP,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,aAAa,CACvB,yBAAyB,SAAS,mCAAmC,IACnE,gCAAgC,CAAC,yBAAyB,CAAC,CAAC;AAEhE;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,CACvC,yBAAyB,SAAS,mCAAmC,IACnE,6BAA6B,CAC/B,OAAO,cAAc,EACrB,KAAK,EACH,0BAA0B,CAAC,yBAAyB,CAAC,GACrD,aAAa,CAAC,yBAAyB,CAAC,EAC1C,KAAK,EACL,aAAa,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,CACjD,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,oBAAoB,CAC/B,yBAAyB,SAAS,yCAAyC,EAC3E,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAC3D,SAAQ,cAAc,CACtB,OAAO,cAAc,EACrB,yBAAyB,EACzB,6BAA6B,CAAC,yBAAyB,CAAC,CACzD;;IACC;;;;;;OAMG;gBACS,EACV,WAAW,EACX,SAAS,GACV,EAAE;QACD,WAAW,EAAE,gBAAgB,CAAC;QAC9B,SAAS,EAAE,6BAA6B,CAAC,yBAAyB,CAAC,CAAC;KACrE;CAqFF;AAED,eAAe,oBAAoB,CAAC"}

package/dist/ComposableController.mjs

@@ -18,7 +18,7 @@ export class ComposableController extends BaseController {
      * Creates a ComposableController instance.
      *
      * @param options - Initial options used to configure this controller
-     * @param options.controllers - List of child controller instances to compose.
+     * @param options.controllers - An object of child controller instances to compose that is keyed with the names of the controllers.
      * @param options.messenger - A restricted controller messenger.
      */
     constructor({ controllers, messenger, }) {
@@ -27,19 +27,33 @@ export class ComposableController extends BaseController {
         }
         super({
             name: controllerName,
-            metadata: controllers.reduce((metadata, controller) => ({
-                ...metadata,
-                [controller.name]: isBaseController(controller)
-                    ? controller.metadata
-                    : { persist: true, anonymous: true },
-            }), {}),
-            state: controllers.reduce((state, controller) => {
-                return { ...state, [controller.name]: controller.state };
+            metadata: Object.entries(controllers).reduce((metadata, [name, controller]) => {
+                if (isBaseController(controller)) {
+                    // Type assertion is necessary for to assign new properties to a generic type - ts(2862)
+                    metadata[name] = controller.metadata;
+                }
+                else if (isBaseControllerV1(controller)) {
+                    // Type assertion is necessary for to assign new properties to a generic type - ts(2862)
+                    metadata[name] = Object.keys(controller.state).reduce((acc, curr) => {
+                        acc[curr] = { persist: true, anonymous: true };
+                        return acc;
+                    }, {});
+                }
+                return metadata;
+            }, {}),
+            state: Object.entries(controllers).reduce((state, [name, controller]) => {
+                if (isBaseController(controller) || isBaseControllerV1(controller)) {
+                    // Type assertion is necessary for to assign new properties to a generic type - ts(2862)
+                    // TODO: Remove the 'object' member once `BaseControllerV2` migrations are completed for all controllers.
+                    state[name] =
+                        controller.state;
+                }
+                return state;
             }, {}),
             messenger,
         });
         _ComposableController_instances.add(this);
-        controllers.forEach((controller) => __classPrivateFieldGet(this, _ComposableController_instances, "m", _ComposableController_updateChildController).call(this, controller));
+        Object.keys(controllers).forEach((name) => __classPrivateFieldGet(this, _ComposableController_instances, "m", _ComposableController_updateChildController).call(this, controllers[name]));
     }
 }
 _ComposableController_instances = new WeakSet(), _ComposableController_updateChildController = function _ComposableController_updateChildController(controller) {

package/dist/ComposableController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ComposableController.mjs","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;AASA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EACnB,kCAAkC;AAGnC,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAErD,MAAM,CAAC,MAAM,wBAAwB,GACnC,gHAAgH,CAAC;AAyGnH;;;;;GAKG;AACH,MAAM,OAAO,oBAGX,SAAQ,cAIT;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,cAAc;YACpB,QAAQ,EAAE,WAAW,CAAC,MAAM,CAC1B,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;gBACzB,GAAG,QAAQ;gBACX,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;aACvC,CAAC,EACF,EAAW,CACZ;YACD,KAAK,EAAE,WAAW,CAAC,MAAM,CACvB,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBACpB,OAAO,EAAE,GAAG,KAAK,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC;YAC3D,CAAC,EACD,EAAW,CACZ;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;CAsCF;oJA/BwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QACpE,2CAA2C;QAC3C,4EAA4E;QAC5E,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,MAAM,wBAAwB,EAAE,CAAC,CAAC;KAC1D;IACD,IAAI;QACF,IAAI,CAAC,eAAe,CAAC,SAAS;QAC5B,2CAA2C;QAC3C,4EAA4E;QAC5E,GAAG,IAAI,cAAc,EACrB,CAAC,UAA2C,EAAE,EAAE;YAC9C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC,CACF,CAAC;KACH;IAAC,OAAO,KAAc,EAAE;QACvB,2CAA2C;QAC3C,4EAA4E;QAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KAC7C;IACD,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAClC,UAAU,CAAC,SAAS,CAAC,CAAC,UAA6B,EAAE,EAAE;YACrD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAGH,eAAe,oBAAoB,CAAC","sourcesContent":["import type {\n  RestrictedControllerMessenger,\n  StateConstraint,\n  StateConstraintV1,\n  StateMetadata,\n  ControllerStateChangeEvent,\n  LegacyControllerStateConstraint,\n  ControllerInstance,\n} from '@metamask/base-controller';\nimport {\n  BaseController,\n  isBaseController,\n  isBaseControllerV1,\n} from '@metamask/base-controller';\nimport type { Patch } from 'immer';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must have a `messagingSystem` or be a class inheriting from `BaseControllerV1`.';\n\n/**\n * A universal supertype for the composable controller state object.\n *\n * This type is only intended to be used for disabling the generic constraint on the `ControllerState` type argument in the `BaseController` type as a temporary solution for ensuring compatibility with BaseControllerV1 child controllers.\n * Note that it is unsuitable for general use as a type constraint.\n */\n// TODO: Replace with `ComposableControllerStateConstraint` once BaseControllerV2 migrations are completed for all controllers.\ntype LegacyComposableControllerStateConstraint = {\n  // `any` is used here to disable the generic constraint on the `ControllerState` type argument in the `BaseController` type,\n  // enabling composable controller state types with BaseControllerV1 state objects to be.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [name: string]: Record<string, any>;\n};\n\n/**\n * The narrowest supertype for the composable controller state object.\n * This is also a widest subtype of the 'LegacyComposableControllerStateConstraint' type.\n */\n// TODO: Replace with `{ [name: string]: StateConstraint }` once BaseControllerV2 migrations are completed for all controllers.\nexport type ComposableControllerStateConstraint = {\n  [name: string]: LegacyControllerStateConstraint;\n};\n\n/**\n * A `stateChange` event for any controller instance that extends from either `BaseControllerV1` or `BaseControllerV2`.\n */\n// TODO: Replace all instances with `ControllerStateChangeEvent` once `BaseControllerV2` migrations are completed for all controllers.\ntype LegacyControllerStateChangeEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraintV1,\n> = {\n  type: `${ControllerName}:stateChange`;\n  payload: [ControllerState, Patch[]];\n};\n\n/**\n * The `stateChange` event type for the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerStateChangeEvent<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = LegacyControllerStateChangeEvent<\n  typeof controllerName,\n  ComposableControllerState\n>;\n\n/**\n * A union type of internal event types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerStateChangeEvent<ComposableControllerState>;\n\n/**\n * A utility type that extracts controllers from the {@link ComposableControllerState} type,\n * and derives a union type of all of their corresponding `stateChange` events.\n *\n * This type can handle both `BaseController` and `BaseControllerV1` controller instances.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ChildControllerStateChangeEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerState extends Record<\n  infer ControllerName extends string,\n  infer ControllerState\n>\n  ? ControllerState extends StateConstraint\n    ? ControllerStateChangeEvent<ControllerName, ControllerState>\n    : // TODO: Remove this conditional branch once `BaseControllerV2` migrations are completed for all controllers.\n    ControllerState extends StateConstraintV1\n    ? LegacyControllerStateChangeEvent<ControllerName, ControllerState>\n    : never\n  : never;\n\n/**\n * A union type of external event types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type AllowedEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ChildControllerStateChangeEvents<ComposableControllerState>;\n\n/**\n * The messenger of the {@link ComposableController}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerMessenger<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = RestrictedControllerMessenger<\n  typeof controllerName,\n  never,\n  | ComposableControllerEvents<ComposableControllerState>\n  | AllowedEvents<ComposableControllerState>,\n  never,\n  AllowedEvents<ComposableControllerState>['type']\n>;\n\n/**\n * Controller that composes multiple child controllers and maintains up-to-date composed state.\n *\n * @template ComposableControllerState - A type object containing the names and state types of the child controllers.\n * @template ChildControllers - A union type of the child controllers being used to instantiate the {@link ComposableController}.\n */\nexport class ComposableController<\n  ComposableControllerState extends LegacyComposableControllerStateConstraint,\n  ChildControllers extends ControllerInstance,\n> extends BaseController<\n  typeof controllerName,\n  ComposableControllerState,\n  ComposableControllerMessenger<ComposableControllerState>\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: ChildControllers[];\n    messenger: ComposableControllerMessenger<ComposableControllerState>;\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        {} as never,\n      ),\n      state: controllers.reduce<ComposableControllerState>(\n        (state, controller) => {\n          return { ...state, [controller.name]: controller.state };\n        },\n        {} as never,\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   *\n   * @param controller - Controller instance to update\n   */\n  #updateChildController(controller: ControllerInstance): void {\n    const { name } = controller;\n    if (!isBaseController(controller) && !isBaseControllerV1(controller)) {\n      // False negative. `name` is a string type.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n      throw new Error(`${name} - ${INVALID_CONTROLLER_ERROR}`);\n    }\n    try {\n      this.messagingSystem.subscribe(\n        // False negative. `name` is a string type.\n        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n        `${name}:stateChange`,\n        (childState: LegacyControllerStateConstraint) => {\n          this.update((state) => {\n            Object.assign(state, { [name]: childState });\n          });\n        },\n      );\n    } catch (error: unknown) {\n      // False negative. `name` is a string type.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n      console.error(`${name} - ${String(error)}`);\n    }\n    if (isBaseControllerV1(controller)) {\n      controller.subscribe((childState: StateConstraintV1) => {\n        this.update((state) => {\n          Object.assign(state, { [name]: childState });\n        });\n      });\n    }\n  }\n}\n\nexport default ComposableController;\n"]}
+{"version":3,"file":"ComposableController.mjs","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;AAUA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EACnB,kCAAkC;AAGnC,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAErD,MAAM,CAAC,MAAM,wBAAwB,GACnC,gHAAgH,CAAC;AAyGnH;;;;;GAKG;AACH,MAAM,OAAO,oBAGX,SAAQ,cAIT;IACC;;;;;;OAMG;IACH,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,cAAc;YACpB,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CAE1C,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE;gBACjC,IAAI,gBAAgB,CAAC,UAAU,CAAC,EAAE;oBAChC,wFAAwF;oBACvF,QAA+D,CAC9D,IAAI,CACL,GAAG,UAAU,CAAC,QAAQ,CAAC;iBACzB;qBAAM,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE;oBACzC,wFAAwF;oBACvF,QAA+D,CAC9D,IAAI,CACL,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CACtC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;wBACZ,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;wBAC/C,OAAO,GAAG,CAAC;oBACb,CAAC,EACD,EAAW,CACZ,CAAC;iBACH;gBACD,OAAO,QAAQ,CAAC;YAClB,CAAC,EAAE,EAAW,CAAC;YACf,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CACvC,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE;gBAC5B,IAAI,gBAAgB,CAAC,UAAU,CAAC,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE;oBAClE,wFAAwF;oBACxF,yGAAyG;oBACxG,KAAkD,CAAC,IAAI,CAAC;wBACvD,UAAU,CAAC,KAAK,CAAC;iBACpB;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,EACD,EAAW,CACZ;YACD,SAAS;SACV,CAAC,CAAC;;QAEH,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CACxC,uBAAA,IAAI,oFAAuB,MAA3B,IAAI,EAAwB,WAAW,CAAC,IAAI,CAAC,CAAC,CAC/C,CAAC;IACJ,CAAC;CAsCF;oJA/BwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QACpE,2CAA2C;QAC3C,4EAA4E;QAC5E,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,MAAM,wBAAwB,EAAE,CAAC,CAAC;KAC1D;IACD,IAAI;QACF,IAAI,CAAC,eAAe,CAAC,SAAS;QAC5B,2CAA2C;QAC3C,4EAA4E;QAC5E,GAAG,IAAI,cAAc,EACrB,CAAC,UAA2C,EAAE,EAAE;YAC9C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC,CACF,CAAC;KACH;IAAC,OAAO,KAAc,EAAE;QACvB,2CAA2C;QAC3C,4EAA4E;QAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KAC7C;IACD,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAClC,UAAU,CAAC,SAAS,CAAC,CAAC,UAA6B,EAAE,EAAE;YACrD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAGH,eAAe,oBAAoB,CAAC","sourcesContent":["import type {\n  RestrictedControllerMessenger,\n  StateConstraint,\n  StateConstraintV1,\n  StateMetadata,\n  StateMetadataConstraint,\n  ControllerStateChangeEvent,\n  LegacyControllerStateConstraint,\n  ControllerInstance,\n} from '@metamask/base-controller';\nimport {\n  BaseController,\n  isBaseController,\n  isBaseControllerV1,\n} from '@metamask/base-controller';\nimport type { Patch } from 'immer';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must have a `messagingSystem` or be a class inheriting from `BaseControllerV1`.';\n\n/**\n * A universal supertype for the composable controller state object.\n *\n * This type is only intended to be used for disabling the generic constraint on the `ControllerState` type argument in the `BaseController` type as a temporary solution for ensuring compatibility with BaseControllerV1 child controllers.\n * Note that it is unsuitable for general use as a type constraint.\n */\n// TODO: Replace with `ComposableControllerStateConstraint` once BaseControllerV2 migrations are completed for all controllers.\ntype LegacyComposableControllerStateConstraint = {\n  // `any` is used here to disable the generic constraint on the `ControllerState` type argument in the `BaseController` type,\n  // enabling composable controller state types with BaseControllerV1 state objects to be.\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  [name: string]: Record<string, any>;\n};\n\n/**\n * The narrowest supertype for the composable controller state object.\n * This is also a widest subtype of the 'LegacyComposableControllerStateConstraint' type.\n */\n// TODO: Replace with `{ [name: string]: StateConstraint }` once BaseControllerV2 migrations are completed for all controllers.\nexport type ComposableControllerStateConstraint = {\n  [name: string]: LegacyControllerStateConstraint;\n};\n\n/**\n * A `stateChange` event for any controller instance that extends from either `BaseControllerV1` or `BaseControllerV2`.\n */\n// TODO: Replace all instances with `ControllerStateChangeEvent` once `BaseControllerV2` migrations are completed for all controllers.\ntype LegacyControllerStateChangeEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraintV1,\n> = {\n  type: `${ControllerName}:stateChange`;\n  payload: [ControllerState, Patch[]];\n};\n\n/**\n * The `stateChange` event type for the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerStateChangeEvent<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = LegacyControllerStateChangeEvent<\n  typeof controllerName,\n  ComposableControllerState\n>;\n\n/**\n * A union type of internal event types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerStateChangeEvent<ComposableControllerState>;\n\n/**\n * A utility type that extracts controllers from the {@link ComposableControllerState} type,\n * and derives a union type of all of their corresponding `stateChange` events.\n *\n * This type can handle both `BaseController` and `BaseControllerV1` controller instances.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ChildControllerStateChangeEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerState extends Record<\n  infer ControllerName extends string,\n  infer ControllerState\n>\n  ? ControllerState extends StateConstraint\n    ? ControllerStateChangeEvent<ControllerName, ControllerState>\n    : // TODO: Remove this conditional branch once `BaseControllerV2` migrations are completed for all controllers.\n    ControllerState extends StateConstraintV1\n    ? LegacyControllerStateChangeEvent<ControllerName, ControllerState>\n    : never\n  : never;\n\n/**\n * A union type of external event types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type AllowedEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ChildControllerStateChangeEvents<ComposableControllerState>;\n\n/**\n * The messenger of the {@link ComposableController}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerMessenger<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = RestrictedControllerMessenger<\n  typeof controllerName,\n  never,\n  | ComposableControllerEvents<ComposableControllerState>\n  | AllowedEvents<ComposableControllerState>,\n  never,\n  AllowedEvents<ComposableControllerState>['type']\n>;\n\n/**\n * Controller that composes multiple child controllers and maintains up-to-date composed state.\n *\n * @template ComposableControllerState - A type object containing the names and state types of the child controllers.\n * @template ChildControllers - A union type of the child controllers being used to instantiate the {@link ComposableController}.\n */\nexport class ComposableController<\n  ComposableControllerState extends LegacyComposableControllerStateConstraint,\n  ChildControllers extends Record<string, ControllerInstance>,\n> extends BaseController<\n  typeof controllerName,\n  ComposableControllerState,\n  ComposableControllerMessenger<ComposableControllerState>\n> {\n  /**\n   * Creates a ComposableController instance.\n   *\n   * @param options - Initial options used to configure this controller\n   * @param options.controllers - An object of child controller instances to compose that is keyed with the names of the controllers.\n   * @param options.messenger - A restricted controller messenger.\n   */\n  constructor({\n    controllers,\n    messenger,\n  }: {\n    controllers: ChildControllers;\n    messenger: ComposableControllerMessenger<ComposableControllerState>;\n  }) {\n    if (messenger === undefined) {\n      throw new Error(`Messaging system is required`);\n    }\n\n    super({\n      name: controllerName,\n      metadata: Object.entries(controllers).reduce<\n        StateMetadata<ComposableControllerState>\n      >((metadata, [name, controller]) => {\n        if (isBaseController(controller)) {\n          // Type assertion is necessary for to assign new properties to a generic type - ts(2862)\n          (metadata as unknown as Record<string, StateMetadataConstraint>)[\n            name\n          ] = controller.metadata;\n        } else if (isBaseControllerV1(controller)) {\n          // Type assertion is necessary for to assign new properties to a generic type - ts(2862)\n          (metadata as unknown as Record<string, StateMetadataConstraint>)[\n            name\n          ] = Object.keys(controller.state).reduce<StateMetadataConstraint>(\n            (acc, curr) => {\n              acc[curr] = { persist: true, anonymous: true };\n              return acc;\n            },\n            {} as never,\n          );\n        }\n        return metadata;\n      }, {} as never),\n      state: Object.entries(controllers).reduce<ComposableControllerState>(\n        (state, [name, controller]) => {\n          if (isBaseController(controller) || isBaseControllerV1(controller)) {\n            // Type assertion is necessary for to assign new properties to a generic type - ts(2862)\n            // TODO: Remove the 'object' member once `BaseControllerV2` migrations are completed for all controllers.\n            (state as Record<string, StateConstraint | object>)[name] =\n              controller.state;\n          }\n          return state;\n        },\n        {} as never,\n      ),\n      messenger,\n    });\n\n    Object.keys(controllers).forEach((name) =>\n      this.#updateChildController(controllers[name]),\n    );\n  }\n\n  /**\n   * Constructor helper that subscribes to child controller state changes.\n   *\n   * @param controller - Controller instance to update\n   */\n  #updateChildController(controller: ControllerInstance): void {\n    const { name } = controller;\n    if (!isBaseController(controller) && !isBaseControllerV1(controller)) {\n      // False negative. `name` is a string type.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n      throw new Error(`${name} - ${INVALID_CONTROLLER_ERROR}`);\n    }\n    try {\n      this.messagingSystem.subscribe(\n        // False negative. `name` is a string type.\n        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n        `${name}:stateChange`,\n        (childState: LegacyControllerStateConstraint) => {\n          this.update((state) => {\n            Object.assign(state, { [name]: childState });\n          });\n        },\n      );\n    } catch (error: unknown) {\n      // False negative. `name` is a string type.\n      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n      console.error(`${name} - ${String(error)}`);\n    }\n    if (isBaseControllerV1(controller)) {\n      controller.subscribe((childState: StateConstraintV1) => {\n        this.update((state) => {\n          Object.assign(state, { [name]: childState });\n        });\n      });\n    }\n  }\n}\n\nexport default ComposableController;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/composable-controller",
-  "version": "9.0.1-preview-b5d0cd70",
+  "version": "9.0.1-preview-9d476a5",
   "description": "Consolidates the state from multiple controllers into one",
   "keywords": [
     "MetaMask",