@metamask-previews/composable-controller 12.0.0-preview-ee982ebe → 12.0.0-preview-91b0ac79

package/dist/ComposableController.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ComposableController.cjs","sourceRoot":"","sources":["../src/ComposableController.ts"],"names":[],"mappings":";;;;;;;;;AAQA,+DAA2D;AAG9C,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAExC,QAAA,wBAAwB,GACnC,oEAAoE,CAAC;AAuFvE;;;;;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,kBAAkB,EAAE,KAAK;oBACzB,OAAO,EAAE,IAAI;oBACb,sBAAsB,EAAE,IAAI;oBAC5B,QAAQ,EAAE,KAAK;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;CAoCF;AA/FD,oDA+FC;oJA7BwB,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,MAAM,GAAE;QACV,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,MAAM,gCAAwB,EAAE,CAAC,CAAC;KAC1D;IACD,IAAI;QACF,IAAI,CAAC,SAAS,CAAC,SAAS,CAKtB,GAAG,IAAI,cAAc,EAAE,CAAC,UAA2B,EAAE,EAAE;YACvD,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,CAAC,CAAC;KACJ;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  StateConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  ControllerStateChangeEvent,\n  ControllerGetStateAction,\n  BaseControllerInstance as ControllerInstance,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must 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 `getState` action type for the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerGetStateAction<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ControllerGetStateAction<typeof controllerName, ComposableControllerState>;\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 union type of action types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerActions<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerGetStateAction<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 ChildControllerName extends string,\n    infer ChildControllerState extends StateConstraint\n  >\n    ? ControllerStateChangeEvent<ChildControllerName, ChildControllerState>\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> = Messenger<\n  typeof controllerName,\n  ComposableControllerActions<ComposableControllerState>,\n  | ComposableControllerEvents<ComposableControllerState>\n  | AllowedEvents<ComposableControllerState>\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 controller 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          includeInStateLogs: false,\n          persist: true,\n          includeInDebugSnapshot: true,\n          usedInUi: false,\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      throw new Error(`${name} - ${INVALID_CONTROLLER_ERROR}`);\n    }\n    try {\n      this.messenger.subscribe<\n        // The type intersection with \"ComposableController:stateChange\" is added by one of the `Messenger.subscribe` overloads, but that constraint is unnecessary here,\n        // since this method only subscribes the messenger to child controller `stateChange` events.\n        // @ts-expect-error \"Type '`${string}:stateChange`' is not assignable to parameter of type '\"ComposableController:stateChange\" & ChildControllerStateChangeEvents<ComposableControllerState>[\"type\"]'.\"\n        ChildControllerStateChangeEvents<ComposableControllerState>['type']\n      >(`${name}:stateChange`, (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    } 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,+DAA2D;AAG9C,QAAA,cAAc,GAAG,sBAAsB,CAAC;AAExC,QAAA,wBAAwB,GACnC,oEAAoE,CAAC;AAuFvE;;;;;GAKG;AACH,MAAa,oBAMX,SAAQ,gCAIT;IACC;;;;;;OAMG;IACH,YAAY,EACV,WAAW,EACX,SAAS,GAIV;QACC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;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,kBAAkB,EAAE,KAAK;oBACzB,OAAO,EAAE,IAAI;oBACb,sBAAsB,EAAE,IAAI;oBAC5B,QAAQ,EAAE,KAAK;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;CAoCF;AA/FD,oDA+FC;oJA7BwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxB,oCAAoC;QACtC,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,MAAM,gCAAwB,EAAE,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,SAAS,CAKtB,GAAG,IAAI,cAAc,EAAE,CAAC,UAA2B,EAAE,EAAE;YACvD,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,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,2CAA2C;QAC3C,4EAA4E;QAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC;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  StateConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  ControllerStateChangeEvent,\n  ControllerGetStateAction,\n  BaseControllerInstance as ControllerInstance,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must 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 `getState` action type for the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerGetStateAction<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ControllerGetStateAction<typeof controllerName, ComposableControllerState>;\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 union type of action types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerActions<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerGetStateAction<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 ChildControllerName extends string,\n    infer ChildControllerState extends StateConstraint\n  >\n    ? ControllerStateChangeEvent<ChildControllerName, ChildControllerState>\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> = Messenger<\n  typeof controllerName,\n  ComposableControllerActions<ComposableControllerState>,\n  | ComposableControllerEvents<ComposableControllerState>\n  | AllowedEvents<ComposableControllerState>\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 controller 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          includeInStateLogs: false,\n          persist: true,\n          includeInDebugSnapshot: true,\n          usedInUi: false,\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      throw new Error(`${name} - ${INVALID_CONTROLLER_ERROR}`);\n    }\n    try {\n      this.messenger.subscribe<\n        // The type intersection with \"ComposableController:stateChange\" is added by one of the `Messenger.subscribe` overloads, but that constraint is unnecessary here,\n        // since this method only subscribes the messenger to child controller `stateChange` events.\n        // @ts-expect-error \"Type '`${string}:stateChange`' is not assignable to parameter of type '\"ComposableController:stateChange\" & ChildControllerStateChangeEvents<ComposableControllerState>[\"type\"]'.\"\n        ChildControllerStateChangeEvents<ComposableControllerState>['type']\n      >(`${name}:stateChange`, (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    } 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"]}

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;AAG3D,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAErD,MAAM,CAAC,MAAM,wBAAwB,GACnC,oEAAoE,CAAC;AAuFvE;;;;;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,kBAAkB,EAAE,KAAK;oBACzB,OAAO,EAAE,IAAI;oBACb,sBAAsB,EAAE,IAAI;oBAC5B,QAAQ,EAAE,KAAK;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;CAoCF;oJA7BwB,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,MAAM,GAAE;QACV,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,MAAM,wBAAwB,EAAE,CAAC,CAAC;KAC1D;IACD,IAAI;QACF,IAAI,CAAC,SAAS,CAAC,SAAS,CAKtB,GAAG,IAAI,cAAc,EAAE,CAAC,UAA2B,EAAE,EAAE;YACvD,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,CAAC,CAAC;KACJ;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  StateConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  ControllerStateChangeEvent,\n  ControllerGetStateAction,\n  BaseControllerInstance as ControllerInstance,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must 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 `getState` action type for the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerGetStateAction<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ControllerGetStateAction<typeof controllerName, ComposableControllerState>;\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 union type of action types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerActions<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerGetStateAction<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 ChildControllerName extends string,\n    infer ChildControllerState extends StateConstraint\n  >\n    ? ControllerStateChangeEvent<ChildControllerName, ChildControllerState>\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> = Messenger<\n  typeof controllerName,\n  ComposableControllerActions<ComposableControllerState>,\n  | ComposableControllerEvents<ComposableControllerState>\n  | AllowedEvents<ComposableControllerState>\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 controller 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          includeInStateLogs: false,\n          persist: true,\n          includeInDebugSnapshot: true,\n          usedInUi: false,\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      throw new Error(`${name} - ${INVALID_CONTROLLER_ERROR}`);\n    }\n    try {\n      this.messenger.subscribe<\n        // The type intersection with \"ComposableController:stateChange\" is added by one of the `Messenger.subscribe` overloads, but that constraint is unnecessary here,\n        // since this method only subscribes the messenger to child controller `stateChange` events.\n        // @ts-expect-error \"Type '`${string}:stateChange`' is not assignable to parameter of type '\"ComposableController:stateChange\" & ChildControllerStateChangeEvents<ComposableControllerState>[\"type\"]'.\"\n        ChildControllerStateChangeEvents<ComposableControllerState>['type']\n      >(`${name}:stateChange`, (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    } 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,kCAAkC;AAG3D,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAErD,MAAM,CAAC,MAAM,wBAAwB,GACnC,oEAAoE,CAAC;AAuFvE;;;;;GAKG;AACH,MAAM,OAAO,oBAMX,SAAQ,cAIT;IACC;;;;;;OAMG;IACH,YAAY,EACV,WAAW,EACX,SAAS,GAIV;QACC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;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,kBAAkB,EAAE,KAAK;oBACzB,OAAO,EAAE,IAAI;oBACb,sBAAsB,EAAE,IAAI;oBAC5B,QAAQ,EAAE,KAAK;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;CAoCF;oJA7BwB,UAA8B;IACnD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QAClC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxB,oCAAoC;QACtC,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,MAAM,wBAAwB,EAAE,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,SAAS,CAKtB,GAAG,IAAI,cAAc,EAAE,CAAC,UAA2B,EAAE,EAAE;YACvD,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,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,2CAA2C;QAC3C,4EAA4E;QAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC;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  StateConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  ControllerStateChangeEvent,\n  ControllerGetStateAction,\n  BaseControllerInstance as ControllerInstance,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nexport const controllerName = 'ComposableController';\n\nexport const INVALID_CONTROLLER_ERROR =\n  'Invalid controller: controller must 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 `getState` action type for the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerGetStateAction<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ControllerGetStateAction<typeof controllerName, ComposableControllerState>;\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 union type of action types available to the {@link ComposableControllerMessenger}.\n *\n * @template ComposableControllerState - A type object that maps controller names to their state types.\n */\nexport type ComposableControllerActions<\n  ComposableControllerState extends ComposableControllerStateConstraint,\n> = ComposableControllerGetStateAction<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 ChildControllerName extends string,\n    infer ChildControllerState extends StateConstraint\n  >\n    ? ControllerStateChangeEvent<ChildControllerName, ChildControllerState>\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> = Messenger<\n  typeof controllerName,\n  ComposableControllerActions<ComposableControllerState>,\n  | ComposableControllerEvents<ComposableControllerState>\n  | AllowedEvents<ComposableControllerState>\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 controller 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          includeInStateLogs: false,\n          persist: true,\n          includeInDebugSnapshot: true,\n          usedInUi: false,\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      throw new Error(`${name} - ${INVALID_CONTROLLER_ERROR}`);\n    }\n    try {\n      this.messenger.subscribe<\n        // The type intersection with \"ComposableController:stateChange\" is added by one of the `Messenger.subscribe` overloads, but that constraint is unnecessary here,\n        // since this method only subscribes the messenger to child controller `stateChange` events.\n        // @ts-expect-error \"Type '`${string}:stateChange`' is not assignable to parameter of type '\"ComposableController:stateChange\" & ChildControllerStateChangeEvents<ComposableControllerState>[\"type\"]'.\"\n        ChildControllerStateChangeEvents<ComposableControllerState>['type']\n      >(`${name}:stateChange`, (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    } 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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/composable-controller",
-  "version": "12.0.0-preview-ee982ebe",
+  "version": "12.0.0-preview-91b0ac79",
   "description": "Consolidates the state from multiple controllers into one",
   "keywords": [
     "MetaMask",
@@ -63,7 +63,7 @@
     "ts-jest": "^27.1.4",
     "typedoc": "^0.24.8",
     "typedoc-plugin-missing-exports": "^2.0.0",
-    "typescript": "~5.2.2"
+    "typescript": "~5.3.3"
   },
   "engines": {
     "node": "^18.18 || >=20"