@metamask-previews/composable-controller 11.0.0-preview-ddceb3a8 → 11.0.0-preview-d79fc0b7

package/CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Bump `@metamask/base-controller` from `^8.0.0` to `^8.2.0` ([#5722](https://github.com/MetaMask/core/pull/5722), [#6284](https://github.com/MetaMask/core/pull/6284), [#6355](https://github.com/MetaMask/core/pull/6355))
+- Bump `@metamask/base-controller` from `^8.0.0` to `^8.1.0` ([#5722](https://github.com/MetaMask/core/pull/5722), [#6284](https://github.com/MetaMask/core/pull/6284))
 
 ## [11.0.0]
 

package/dist/ComposableController.cjs

@@ -56,7 +56,7 @@ class ComposableController extends base_controller_1.BaseController {
 exports.ComposableController = ComposableController;
 _ComposableController_instances = new WeakSet(), _ComposableController_updateChildController = function _ComposableController_updateChildController(controller) {
     const { name } = controller;
-    if (!isBaseController(controller)) {
+    if (!(0, base_controller_1.isBaseController)(controller)) {
         try {
             delete this.metadata[name];
             delete this.state[name];
@@ -85,21 +85,5 @@ _ComposableController_instances = new WeakSet(), _ComposableController_updateChi
         console.error(`${name} - ${String(error)}`);
     }
 };
-/**
- * Determines if the given controller is an instance of `BaseController`
- *
- * @param controller - Controller instance to check
- * @returns True if the controller is an instance of `BaseController`
- */
-function isBaseController(controller) {
-    return (typeof controller === 'object' &&
-        controller !== null &&
-        'name' in controller &&
-        typeof controller.name === 'string' &&
-        'state' in controller &&
-        typeof controller.state === 'object' &&
-        'metadata' in controller &&
-        typeof controller.metadata === 'object');
-}
 exports.default = ComposableController;
 //# sourceMappingURL=ComposableController.cjs.map

package/dist/ComposableController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ComposableController.cjs","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;;;;AAQA,+DAA2D;AAE9C,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAExC,QAAA,wBAAwB,GACnC,iGAAiG,CAAC;AAyEpG;;;;;GAKG;AACH,MAAa,oBAMX,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,+JAA+J;YAC/J,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAEvC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;gBAClB,QAAoC,CAAC,IAAI,CAAC,GAAG;oBAC5C,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,IAAI;iBAChB,CAAC;gBACF,OAAO,QAAQ,CAAC;YAClB,CAAC,EAAE,EAAW,CAAC;YACf,+JAA+J;YAC/J,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CACtC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBACpB,2IAA2I;gBAC1I,KAA6C,CAAC,UAAU,CAAC,IAAI,CAAC;oBAC7D,UAAU,CAAC,KAAK,CAAC;gBACnB,OAAO,KAAK,CAAC;YACf,CAAC,EACD,EAAW,CACZ;YACD,SAAS;SACV,CAAC,CAAC;;QAEH,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAChD,uBAAA,IAAI,oFAAuB,MAA3B,IAAI,EAAwB,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;CAsCF;AA/FD,oDA+FC;oJA/BwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;QACjC,IAAI;YACF,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxB,oCAAoC;SACrC;QAAC,OAAO,CAAC,EAAE,GAAE;QACd,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,UAA2B,EAAE,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,2IAA2I;gBAC3I,4DAA4D;gBAC3D,KAA6C,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;YACpE,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;AACH,CAAC;AAGH;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,UAAmB;IAEnB,OAAO,CACL,OAAO,UAAU,KAAK,QAAQ;QAC9B,UAAU,KAAK,IAAI;QACnB,MAAM,IAAI,UAAU;QACpB,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ;QACnC,OAAO,IAAI,UAAU;QACrB,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ;QACpC,UAAU,IAAI,UAAU;QACxB,OAAO,UAAU,CAAC,QAAQ,KAAK,QAAQ,CACxC,CAAC;AACJ,CAAC;AAED,kBAAe,oBAAoB,CAAC","sourcesContent":["import type {\n  RestrictedMessenger,\n  StateConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  ControllerStateChangeEvent,\n  BaseControllerInstance as ControllerInstance,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must have a `messagingSystem` and inherit from `BaseController`.';\n\n/**\n * The narrowest supertype for the composable controller state object.\n */\nexport type ComposableControllerStateConstraint = {\n  [controllerName: string]: StateConstraint;\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> = ControllerStateChangeEvent<\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 * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ChildControllerStateChangeEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> =\n  ComposableControllerState extends Record<\n    infer ControllerName extends string,\n    infer ControllerState\n  >\n    ? ControllerState extends StateConstraint\n      ? ControllerStateChangeEvent<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> = RestrictedMessenger<\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 ChildControllersMap - A type object that specifies the child controllers which are used to instantiate the {@link ComposableController}.\n */\nexport class ComposableController<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n  ChildControllersMap extends Record<\n    keyof ComposableControllerState,\n    ControllerInstance\n  >,\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 that contains child controllers keyed by their names.\n   * @param options.messenger - A restricted messenger.\n   */\n  constructor({\n    controllers,\n    messenger,\n  }: {\n    controllers: ChildControllersMap;\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      // This reduce operation intentionally reuses its output object. This provides a significant performance benefit over returning a new object on each iteration.\n      metadata: Object.keys(controllers).reduce<\n        StateMetadata<ComposableControllerState>\n      >((metadata, name) => {\n        (metadata as StateMetadataConstraint)[name] = {\n          persist: true,\n          anonymous: true,\n        };\n        return metadata;\n      }, {} as never),\n      // This reduce operation intentionally reuses its output object. This provides a significant performance benefit over returning a new object on each iteration.\n      state: Object.values(controllers).reduce<ComposableControllerState>(\n        (state, controller) => {\n          // Type assertion is necessary for property assignment to a generic type. This does not pollute or widen the type of the asserted variable.\n          (state as ComposableControllerStateConstraint)[controller.name] =\n            controller.state;\n          return state;\n        },\n        {} as never,\n      ),\n      messenger,\n    });\n\n    Object.values(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)) {\n      try {\n        delete this.metadata[name];\n        delete this.state[name];\n        // eslint-disable-next-line no-empty\n      } catch (_) {}\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: StateConstraint) => {\n          this.update((state) => {\n            // Type assertion is necessary for property assignment to a generic type. This does not pollute or widen the type of the asserted variable.\n            // @ts-expect-error \"Type instantiation is excessively deep\"\n            (state as ComposableControllerStateConstraint)[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  }\n}\n\n/**\n * Determines if the given controller is an instance of `BaseController`\n *\n * @param controller - Controller instance to check\n * @returns True if the controller is an instance of `BaseController`\n */\nfunction isBaseController(\n  controller: unknown,\n): controller is ControllerInstance {\n  return (\n    typeof controller === 'object' &&\n    controller !== null &&\n    'name' in controller &&\n    typeof controller.name === 'string' &&\n    'state' in controller &&\n    typeof controller.state === 'object' &&\n    'metadata' in controller &&\n    typeof controller.metadata === 'object'\n  );\n}\n\nexport default ComposableController;\n"]}
+{"version":3,"file":"ComposableController.cjs","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;;;;AAQA,+DAA6E;AAEhE,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAExC,QAAA,wBAAwB,GACnC,iGAAiG,CAAC;AAyEpG;;;;;GAKG;AACH,MAAa,oBAMX,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,+JAA+J;YAC/J,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAEvC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;gBAClB,QAAoC,CAAC,IAAI,CAAC,GAAG;oBAC5C,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,IAAI;iBAChB,CAAC;gBACF,OAAO,QAAQ,CAAC;YAClB,CAAC,EAAE,EAAW,CAAC;YACf,+JAA+J;YAC/J,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CACtC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBACpB,2IAA2I;gBAC1I,KAA6C,CAAC,UAAU,CAAC,IAAI,CAAC;oBAC7D,UAAU,CAAC,KAAK,CAAC;gBACnB,OAAO,KAAK,CAAC;YACf,CAAC,EACD,EAAW,CACZ;YACD,SAAS;SACV,CAAC,CAAC;;QAEH,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAChD,uBAAA,IAAI,oFAAuB,MAA3B,IAAI,EAAwB,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;CAsCF;AA/FD,oDA+FC;oJA/BwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,CAAC,IAAA,kCAAgB,EAAC,UAAU,CAAC,EAAE;QACjC,IAAI;YACF,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxB,oCAAoC;SACrC;QAAC,OAAO,CAAC,EAAE,GAAE;QACd,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,UAA2B,EAAE,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,2IAA2I;gBAC3I,4DAA4D;gBAC3D,KAA6C,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;YACpE,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;AACH,CAAC;AAGH,kBAAe,oBAAoB,CAAC","sourcesContent":["import type {\n  RestrictedMessenger,\n  StateConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  ControllerStateChangeEvent,\n  BaseControllerInstance as ControllerInstance,\n} from '@metamask/base-controller';\nimport { BaseController, isBaseController } from '@metamask/base-controller';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must have a `messagingSystem` and inherit from `BaseController`.';\n\n/**\n * The narrowest supertype for the composable controller state object.\n */\nexport type ComposableControllerStateConstraint = {\n  [controllerName: string]: StateConstraint;\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> = ControllerStateChangeEvent<\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 * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ChildControllerStateChangeEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> =\n  ComposableControllerState extends Record<\n    infer ControllerName extends string,\n    infer ControllerState\n  >\n    ? ControllerState extends StateConstraint\n      ? ControllerStateChangeEvent<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> = RestrictedMessenger<\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 ChildControllersMap - A type object that specifies the child controllers which are used to instantiate the {@link ComposableController}.\n */\nexport class ComposableController<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n  ChildControllersMap extends Record<\n    keyof ComposableControllerState,\n    ControllerInstance\n  >,\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 that contains child controllers keyed by their names.\n   * @param options.messenger - A restricted messenger.\n   */\n  constructor({\n    controllers,\n    messenger,\n  }: {\n    controllers: ChildControllersMap;\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      // This reduce operation intentionally reuses its output object. This provides a significant performance benefit over returning a new object on each iteration.\n      metadata: Object.keys(controllers).reduce<\n        StateMetadata<ComposableControllerState>\n      >((metadata, name) => {\n        (metadata as StateMetadataConstraint)[name] = {\n          persist: true,\n          anonymous: true,\n        };\n        return metadata;\n      }, {} as never),\n      // This reduce operation intentionally reuses its output object. This provides a significant performance benefit over returning a new object on each iteration.\n      state: Object.values(controllers).reduce<ComposableControllerState>(\n        (state, controller) => {\n          // Type assertion is necessary for property assignment to a generic type. This does not pollute or widen the type of the asserted variable.\n          (state as ComposableControllerStateConstraint)[controller.name] =\n            controller.state;\n          return state;\n        },\n        {} as never,\n      ),\n      messenger,\n    });\n\n    Object.values(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)) {\n      try {\n        delete this.metadata[name];\n        delete this.state[name];\n        // eslint-disable-next-line no-empty\n      } catch (_) {}\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: StateConstraint) => {\n          this.update((state) => {\n            // Type assertion is necessary for property assignment to a generic type. This does not pollute or widen the type of the asserted variable.\n            // @ts-expect-error \"Type instantiation is excessively deep\"\n            (state as ComposableControllerStateConstraint)[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  }\n}\n\nexport default ComposableController;\n"]}

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,mBAAmB,EACnB,eAAe,EAGf,0BAA0B,EAC1B,sBAAsB,IAAI,kBAAkB,EAC7C,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAErD,eAAO,MAAM,wBAAwB,oGAC8D,CAAC;AAEpG;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,CAAC,cAAc,EAAE,MAAM,GAAG,eAAe,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,CAC9C,yBAAyB,SAAS,mCAAmC,IACnE,0BAA0B,CAC5B,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CACpC,yBAAyB,SAAS,mCAAmC,IACnE,oCAAoC,CAAC,yBAAyB,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,gCAAgC,CAC1C,yBAAyB,SAAS,mCAAmC,IAErE,yBAAyB,SAAS,MAAM,CACtC,MAAM,cAAc,SAAS,MAAM,EACnC,MAAM,eAAe,CACtB,GACG,eAAe,SAAS,eAAe,GACrC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAC3D,KAAK,GACP,KAAK,CAAC;AAEZ;;;;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,mBAAmB,CACrB,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,mCAAmC,EACrE,mBAAmB,SAAS,MAAM,CAChC,MAAM,yBAAyB,EAC/B,kBAAkB,CACnB,CACD,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,mBAAmB,CAAC;QACjC,SAAS,EAAE,6BAA6B,CAAC,yBAAyB,CAAC,CAAC;KACrE;CAuEF;AAuBD,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"ComposableController.d.cts","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,eAAe,EAGf,0BAA0B,EAC1B,sBAAsB,IAAI,kBAAkB,EAC7C,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAoB,kCAAkC;AAE7E,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAErD,eAAO,MAAM,wBAAwB,oGAC8D,CAAC;AAEpG;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,CAAC,cAAc,EAAE,MAAM,GAAG,eAAe,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,CAC9C,yBAAyB,SAAS,mCAAmC,IACnE,0BAA0B,CAC5B,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CACpC,yBAAyB,SAAS,mCAAmC,IACnE,oCAAoC,CAAC,yBAAyB,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,gCAAgC,CAC1C,yBAAyB,SAAS,mCAAmC,IAErE,yBAAyB,SAAS,MAAM,CACtC,MAAM,cAAc,SAAS,MAAM,EACnC,MAAM,eAAe,CACtB,GACG,eAAe,SAAS,eAAe,GACrC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAC3D,KAAK,GACP,KAAK,CAAC;AAEZ;;;;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,mBAAmB,CACrB,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,mCAAmC,EACrE,mBAAmB,SAAS,MAAM,CAChC,MAAM,yBAAyB,EAC/B,kBAAkB,CACnB,CACD,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,mBAAmB,CAAC;QACjC,SAAS,EAAE,6BAA6B,CAAC,yBAAyB,CAAC,CAAC;KACrE;CAuEF;AAED,eAAe,oBAAoB,CAAC"}

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,mBAAmB,EACnB,eAAe,EAGf,0BAA0B,EAC1B,sBAAsB,IAAI,kBAAkB,EAC7C,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAErD,eAAO,MAAM,wBAAwB,oGAC8D,CAAC;AAEpG;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,CAAC,cAAc,EAAE,MAAM,GAAG,eAAe,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,CAC9C,yBAAyB,SAAS,mCAAmC,IACnE,0BAA0B,CAC5B,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CACpC,yBAAyB,SAAS,mCAAmC,IACnE,oCAAoC,CAAC,yBAAyB,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,gCAAgC,CAC1C,yBAAyB,SAAS,mCAAmC,IAErE,yBAAyB,SAAS,MAAM,CACtC,MAAM,cAAc,SAAS,MAAM,EACnC,MAAM,eAAe,CACtB,GACG,eAAe,SAAS,eAAe,GACrC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAC3D,KAAK,GACP,KAAK,CAAC;AAEZ;;;;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,mBAAmB,CACrB,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,mCAAmC,EACrE,mBAAmB,SAAS,MAAM,CAChC,MAAM,yBAAyB,EAC/B,kBAAkB,CACnB,CACD,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,mBAAmB,CAAC;QACjC,SAAS,EAAE,6BAA6B,CAAC,yBAAyB,CAAC,CAAC;KACrE;CAuEF;AAuBD,eAAe,oBAAoB,CAAC"}
+{"version":3,"file":"ComposableController.d.mts","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,eAAe,EAGf,0BAA0B,EAC1B,sBAAsB,IAAI,kBAAkB,EAC7C,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAoB,kCAAkC;AAE7E,eAAO,MAAM,cAAc,yBAAyB,CAAC;AAErD,eAAO,MAAM,wBAAwB,oGAC8D,CAAC;AAEpG;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,CAAC,cAAc,EAAE,MAAM,GAAG,eAAe,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,CAC9C,yBAAyB,SAAS,mCAAmC,IACnE,0BAA0B,CAC5B,OAAO,cAAc,EACrB,yBAAyB,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CACpC,yBAAyB,SAAS,mCAAmC,IACnE,oCAAoC,CAAC,yBAAyB,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,gCAAgC,CAC1C,yBAAyB,SAAS,mCAAmC,IAErE,yBAAyB,SAAS,MAAM,CACtC,MAAM,cAAc,SAAS,MAAM,EACnC,MAAM,eAAe,CACtB,GACG,eAAe,SAAS,eAAe,GACrC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAC3D,KAAK,GACP,KAAK,CAAC;AAEZ;;;;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,mBAAmB,CACrB,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,mCAAmC,EACrE,mBAAmB,SAAS,MAAM,CAChC,MAAM,yBAAyB,EAC/B,kBAAkB,CACnB,CACD,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,mBAAmB,CAAC;QACjC,SAAS,EAAE,6BAA6B,CAAC,yBAAyB,CAAC,CAAC;KACrE;CAuEF;AAED,eAAe,oBAAoB,CAAC"}

package/dist/ComposableController.mjs

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ComposableController_instances, _ComposableController_updateChildController;
-import { BaseController } from "@metamask/base-controller";
+import { BaseController, isBaseController } from "@metamask/base-controller";
 export const controllerName = 'ComposableController';
 export const INVALID_CONTROLLER_ERROR = 'Invalid controller: controller must have a `messagingSystem` and inherit from `BaseController`.';
 /**
@@ -81,21 +81,5 @@ _ComposableController_instances = new WeakSet(), _ComposableController_updateChi
         console.error(`${name} - ${String(error)}`);
     }
 };
-/**
- * Determines if the given controller is an instance of `BaseController`
- *
- * @param controller - Controller instance to check
- * @returns True if the controller is an instance of `BaseController`
- */
-function isBaseController(controller) {
-    return (typeof controller === 'object' &&
-        controller !== null &&
-        'name' in controller &&
-        typeof controller.name === 'string' &&
-        'state' in controller &&
-        typeof controller.state === 'object' &&
-        'metadata' in controller &&
-        typeof controller.metadata === 'object');
-}
 export default ComposableController;
 //# sourceMappingURL=ComposableController.mjs.map

package/dist/ComposableController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ComposableController.mjs","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;AAQA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAErD,MAAM,CAAC,MAAM,wBAAwB,GACnC,iGAAiG,CAAC;AAyEpG;;;;;GAKG;AACH,MAAM,OAAO,oBAMX,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,+JAA+J;YAC/J,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAEvC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;gBAClB,QAAoC,CAAC,IAAI,CAAC,GAAG;oBAC5C,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,IAAI;iBAChB,CAAC;gBACF,OAAO,QAAQ,CAAC;YAClB,CAAC,EAAE,EAAW,CAAC;YACf,+JAA+J;YAC/J,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CACtC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBACpB,2IAA2I;gBAC1I,KAA6C,CAAC,UAAU,CAAC,IAAI,CAAC;oBAC7D,UAAU,CAAC,KAAK,CAAC;gBACnB,OAAO,KAAK,CAAC;YACf,CAAC,EACD,EAAW,CACZ;YACD,SAAS;SACV,CAAC,CAAC;;QAEH,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAChD,uBAAA,IAAI,oFAAuB,MAA3B,IAAI,EAAwB,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;CAsCF;oJA/BwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;QACjC,IAAI;YACF,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxB,oCAAoC;SACrC;QAAC,OAAO,CAAC,EAAE,GAAE;QACd,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,UAA2B,EAAE,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,2IAA2I;gBAC3I,4DAA4D;gBAC3D,KAA6C,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;YACpE,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;AACH,CAAC;AAGH;;;;;GAKG;AACH,SAAS,gBAAgB,CACvB,UAAmB;IAEnB,OAAO,CACL,OAAO,UAAU,KAAK,QAAQ;QAC9B,UAAU,KAAK,IAAI;QACnB,MAAM,IAAI,UAAU;QACpB,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ;QACnC,OAAO,IAAI,UAAU;QACrB,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ;QACpC,UAAU,IAAI,UAAU;QACxB,OAAO,UAAU,CAAC,QAAQ,KAAK,QAAQ,CACxC,CAAC;AACJ,CAAC;AAED,eAAe,oBAAoB,CAAC","sourcesContent":["import type {\n  RestrictedMessenger,\n  StateConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  ControllerStateChangeEvent,\n  BaseControllerInstance as ControllerInstance,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must have a `messagingSystem` and inherit from `BaseController`.';\n\n/**\n * The narrowest supertype for the composable controller state object.\n */\nexport type ComposableControllerStateConstraint = {\n  [controllerName: string]: StateConstraint;\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> = ControllerStateChangeEvent<\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 * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ChildControllerStateChangeEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> =\n  ComposableControllerState extends Record<\n    infer ControllerName extends string,\n    infer ControllerState\n  >\n    ? ControllerState extends StateConstraint\n      ? ControllerStateChangeEvent<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> = RestrictedMessenger<\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 ChildControllersMap - A type object that specifies the child controllers which are used to instantiate the {@link ComposableController}.\n */\nexport class ComposableController<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n  ChildControllersMap extends Record<\n    keyof ComposableControllerState,\n    ControllerInstance\n  >,\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 that contains child controllers keyed by their names.\n   * @param options.messenger - A restricted messenger.\n   */\n  constructor({\n    controllers,\n    messenger,\n  }: {\n    controllers: ChildControllersMap;\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      // This reduce operation intentionally reuses its output object. This provides a significant performance benefit over returning a new object on each iteration.\n      metadata: Object.keys(controllers).reduce<\n        StateMetadata<ComposableControllerState>\n      >((metadata, name) => {\n        (metadata as StateMetadataConstraint)[name] = {\n          persist: true,\n          anonymous: true,\n        };\n        return metadata;\n      }, {} as never),\n      // This reduce operation intentionally reuses its output object. This provides a significant performance benefit over returning a new object on each iteration.\n      state: Object.values(controllers).reduce<ComposableControllerState>(\n        (state, controller) => {\n          // Type assertion is necessary for property assignment to a generic type. This does not pollute or widen the type of the asserted variable.\n          (state as ComposableControllerStateConstraint)[controller.name] =\n            controller.state;\n          return state;\n        },\n        {} as never,\n      ),\n      messenger,\n    });\n\n    Object.values(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)) {\n      try {\n        delete this.metadata[name];\n        delete this.state[name];\n        // eslint-disable-next-line no-empty\n      } catch (_) {}\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: StateConstraint) => {\n          this.update((state) => {\n            // Type assertion is necessary for property assignment to a generic type. This does not pollute or widen the type of the asserted variable.\n            // @ts-expect-error \"Type instantiation is excessively deep\"\n            (state as ComposableControllerStateConstraint)[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  }\n}\n\n/**\n * Determines if the given controller is an instance of `BaseController`\n *\n * @param controller - Controller instance to check\n * @returns True if the controller is an instance of `BaseController`\n */\nfunction isBaseController(\n  controller: unknown,\n): controller is ControllerInstance {\n  return (\n    typeof controller === 'object' &&\n    controller !== null &&\n    'name' in controller &&\n    typeof controller.name === 'string' &&\n    'state' in controller &&\n    typeof controller.state === 'object' &&\n    'metadata' in controller &&\n    typeof controller.metadata === 'object'\n  );\n}\n\nexport default ComposableController;\n"]}
+{"version":3,"file":"ComposableController.mjs","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;AAQA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,kCAAkC;AAE7E,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAErD,MAAM,CAAC,MAAM,wBAAwB,GACnC,iGAAiG,CAAC;AAyEpG;;;;;GAKG;AACH,MAAM,OAAO,oBAMX,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,+JAA+J;YAC/J,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAEvC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE;gBAClB,QAAoC,CAAC,IAAI,CAAC,GAAG;oBAC5C,OAAO,EAAE,IAAI;oBACb,SAAS,EAAE,IAAI;iBAChB,CAAC;gBACF,OAAO,QAAQ,CAAC;YAClB,CAAC,EAAE,EAAW,CAAC;YACf,+JAA+J;YAC/J,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CACtC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;gBACpB,2IAA2I;gBAC1I,KAA6C,CAAC,UAAU,CAAC,IAAI,CAAC;oBAC7D,UAAU,CAAC,KAAK,CAAC;gBACnB,OAAO,KAAK,CAAC;YACf,CAAC,EACD,EAAW,CACZ;YACD,SAAS;SACV,CAAC,CAAC;;QAEH,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAChD,uBAAA,IAAI,oFAAuB,MAA3B,IAAI,EAAwB,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;CAsCF;oJA/BwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;QACjC,IAAI;YACF,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxB,oCAAoC;SACrC;QAAC,OAAO,CAAC,EAAE,GAAE;QACd,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,UAA2B,EAAE,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,2IAA2I;gBAC3I,4DAA4D;gBAC3D,KAA6C,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;YACpE,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;AACH,CAAC;AAGH,eAAe,oBAAoB,CAAC","sourcesContent":["import type {\n  RestrictedMessenger,\n  StateConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  ControllerStateChangeEvent,\n  BaseControllerInstance as ControllerInstance,\n} from '@metamask/base-controller';\nimport { BaseController, isBaseController } from '@metamask/base-controller';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must have a `messagingSystem` and inherit from `BaseController`.';\n\n/**\n * The narrowest supertype for the composable controller state object.\n */\nexport type ComposableControllerStateConstraint = {\n  [controllerName: string]: StateConstraint;\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> = ControllerStateChangeEvent<\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 * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ChildControllerStateChangeEvents<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> =\n  ComposableControllerState extends Record<\n    infer ControllerName extends string,\n    infer ControllerState\n  >\n    ? ControllerState extends StateConstraint\n      ? ControllerStateChangeEvent<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> = RestrictedMessenger<\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 ChildControllersMap - A type object that specifies the child controllers which are used to instantiate the {@link ComposableController}.\n */\nexport class ComposableController<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n  ChildControllersMap extends Record<\n    keyof ComposableControllerState,\n    ControllerInstance\n  >,\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 that contains child controllers keyed by their names.\n   * @param options.messenger - A restricted messenger.\n   */\n  constructor({\n    controllers,\n    messenger,\n  }: {\n    controllers: ChildControllersMap;\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      // This reduce operation intentionally reuses its output object. This provides a significant performance benefit over returning a new object on each iteration.\n      metadata: Object.keys(controllers).reduce<\n        StateMetadata<ComposableControllerState>\n      >((metadata, name) => {\n        (metadata as StateMetadataConstraint)[name] = {\n          persist: true,\n          anonymous: true,\n        };\n        return metadata;\n      }, {} as never),\n      // This reduce operation intentionally reuses its output object. This provides a significant performance benefit over returning a new object on each iteration.\n      state: Object.values(controllers).reduce<ComposableControllerState>(\n        (state, controller) => {\n          // Type assertion is necessary for property assignment to a generic type. This does not pollute or widen the type of the asserted variable.\n          (state as ComposableControllerStateConstraint)[controller.name] =\n            controller.state;\n          return state;\n        },\n        {} as never,\n      ),\n      messenger,\n    });\n\n    Object.values(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)) {\n      try {\n        delete this.metadata[name];\n        delete this.state[name];\n        // eslint-disable-next-line no-empty\n      } catch (_) {}\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: StateConstraint) => {\n          this.update((state) => {\n            // Type assertion is necessary for property assignment to a generic type. This does not pollute or widen the type of the asserted variable.\n            // @ts-expect-error \"Type instantiation is excessively deep\"\n            (state as ComposableControllerStateConstraint)[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  }\n}\n\nexport default ComposableController;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/composable-controller",
-  "version": "11.0.0-preview-ddceb3a8",
+  "version": "11.0.0-preview-d79fc0b7",
   "description": "Consolidates the state from multiple controllers into one",
   "keywords": [
     "MetaMask",
@@ -47,7 +47,7 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^8.2.0"
+    "@metamask/base-controller": "^8.1.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",