@metamask-previews/base-controller 9.1.0-preview-8bfa290fb → 10.0.0-preview-97d6b86c0

package/CHANGELOG.md

@@ -7,10 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [10.0.0]
+
 ### Changed
 
+- **BREAKING:** Drop CommonJS support ([#9536](https://github.com/MetaMask/core/pull/9536))
+  - This package is now ESM-only, but can still be used in CommonJS projects via `require(esm)` in modern Node.js versions (22+), or dynamic imports in older Node.js versions.
+- **BREAKING:** Bump minimum Node.js version to 22 ([#9976](https://github.com/MetaMask/core/pull/9976))
+- **BREAKING:** Bump TypeScript target to ES2022 ([#10019](https://github.com/MetaMask/core/pull/10019))
+  - This package now ships ES2022 code, requiring a compatible modern environment or bundler configuration to consume.
 - Bump `@metamask/utils` from `^11.9.0` to `^11.12.0` ([#9074](https://github.com/MetaMask/core/pull/9074), [#10076](https://github.com/MetaMask/core/pull/10076))
-- Bump `@metamask/messenger` from `^1.1.1` to `^2.0.0` ([#8632](https://github.com/MetaMask/core/pull/8632), [#9392](https://github.com/MetaMask/core/pull/9392))
+- Bump `@metamask/messenger` from `^1.1.1` to `^3.0.0` ([#8632](https://github.com/MetaMask/core/pull/8632), [#9392](https://github.com/MetaMask/core/pull/9392), [#10160](https://github.com/MetaMask/core/pull/10160))
 
 ## [9.1.0]
 
@@ -151,14 +158,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Remove `RestrictedControllerMessenger` export which was an alias for `RestrictedMessenger`. Consumers should import `RestrictedMessenger` directly
   - Remove `RestrictedControllerMessengerConstraint` type export which was an alias for `RestrictedMessengerConstraint`. Consumers should use `RestrictedMessengerConstraint` type directly
   - Simplify `RestrictedMessenger` constructor by removing deprecated `controllerMessenger` parameter. The messenger instance should now be passed using only the `messenger` parameter instead of supporting both options
-- Widen input parameter for type guard `isBaseController` from `ControllerInstance` to `unknown` ([#5018](https://github.com/MetaMask/core/pull/5018/))
+- Widen input parameter for type guard `isBaseController` from `ControllerInstance` to `unknown` ([#5018](https://github.com/MetaMask/core/pull/5018))
 - Bump `@metamask/json-rpc-engine` from `^10.0.2` to `^10.0.3` ([#5272](https://github.com/MetaMask/core/pull/5272))
 - Bump `@metamask/utils` from `^11.0.1` to `^11.1.0` ([#5223](https://github.com/MetaMask/core/pull/5223))
 
 ### Removed
 
-- **BREAKING:** Remove class `BaseControllerV1` and type guard `isBaseControllerV1` ([#5018](https://github.com/MetaMask/core/pull/5018/))
-- **BREAKING:** Remove types `BaseConfig`, `BaseControllerV1Instance`, `BaseState`, `ConfigConstraintV1`, `Listener`, `StateConstraintV1`, `LegacyControllerStateConstraint`, `ControllerInstance` ([#5018](https://github.com/MetaMask/core/pull/5018/))
+- **BREAKING:** Remove class `BaseControllerV1` and type guard `isBaseControllerV1` ([#5018](https://github.com/MetaMask/core/pull/5018))
+- **BREAKING:** Remove types `BaseConfig`, `BaseControllerV1Instance`, `BaseState`, `ConfigConstraintV1`, `Listener`, `StateConstraintV1`, `LegacyControllerStateConstraint`, `ControllerInstance` ([#5018](https://github.com/MetaMask/core/pull/5018))
 
 ## [7.1.1]
 
@@ -195,7 +202,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     ["Are the Types Wrong?"](https://arethetypeswrong.github.io/) tool as
     ["masquerading as CJS"](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md).
     All of the ATTW checks now pass.
-- Remove chunk files ([#4648](https://github.com/MetaMask/core/pull/4648)).
+- Remove chunk files. ([#4648](https://github.com/MetaMask/core/pull/4648))
   - Previously, the build tool we used to generate JavaScript files extracted
     common code to "chunk" files. While this was intended to make this package
     more tree-shakeable, it also made debugging more difficult for our
@@ -437,7 +444,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/base-controller@9.1.0...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/base-controller@10.0.0...HEAD
+[10.0.0]: https://github.com/MetaMask/core/compare/@metamask/base-controller@9.1.0...@metamask/base-controller@10.0.0
 [9.1.0]: https://github.com/MetaMask/core/compare/@metamask/base-controller@9.0.1...@metamask/base-controller@9.1.0
 [9.0.1]: https://github.com/MetaMask/core/compare/@metamask/base-controller@9.0.0...@metamask/base-controller@9.0.1
 [9.0.0]: https://github.com/MetaMask/core/compare/@metamask/base-controller@8.4.2...@metamask/base-controller@9.0.0

package/dist/{BaseController.d.mts → BaseController.d.ts}

@@ -1,6 +1,6 @@
-import type { ActionConstraint, EventConstraint, Messenger, MessengerActions, MessengerEvents } from "@metamask/messenger";
-import type { Json, PublicInterface } from "@metamask/utils";
-import type { Draft, Patch } from "immer";
+import type { ActionConstraint, EventConstraint, Messenger, MessengerActions, MessengerEvents } from '@metamask/messenger';
+import type { Json, PublicInterface } from '@metamask/utils';
+import type { Draft, Patch } from 'immer';
 /**
  * A type that constrains the state of all controllers.
  *
@@ -211,4 +211,4 @@ export declare class BaseController<ControllerName extends string, ControllerSta
  * @returns The metadata-derived controller state.
  */
 export declare function deriveStateFromMetadata<ControllerState extends StateConstraint>(state: ControllerState, metadata: StateMetadata<ControllerState>, metadataProperty: keyof StatePropertyMetadata<Json>, captureException?: (error: Error) => void): Record<keyof ControllerState, Json>;
-//# sourceMappingURL=BaseController.d.mts.map
+//# sourceMappingURL=BaseController.d.ts.map

package/dist/BaseController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseController.d.ts","sourceRoot":"","sources":["../src/BaseController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,SAAS,EACT,gBAAgB,EAChB,eAAe,EAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAE7D,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAI1C;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEnD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC;AAEhF;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,IAAI,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,IAAI,SAAS,eAAe,IAAI;KACvD,GAAG,IAAI,MAAM,IAAI,CAAC,CAAC,GAAG,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,eAAe,SAAS,IAAI,IAAI;IAChE;;;;;;OAMG;IACH,sBAAsB,EAAE,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IAChE;;;;;;;;;OASG;IACH,kBAAkB,EAAE,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IAC5D;;;;;OAKG;IACH,OAAO,EAAE,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IACjD;;;;;;;;;;;OAWG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,sBAAsB,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACzD,kBAAkB,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACrD,OAAO,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAC1C,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAC1C,MAAM,EACN,+BAA+B,CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,IAAI,CACvC,eAAe,CACb,cAAc,CACZ,MAAM,EACN,eAAe,EAGf,SAAS,CAAC,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAE,GAAG,CAAC,CAC1D,CACF,EACD,UAAU,CACX,GAAG;IACF,QAAQ,EAAE,uBAAuB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,wBAAwB,CAClC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC;IACF,IAAI,EAAE,GAAG,cAAc,WAAW,CAAC;IACnC,OAAO,EAAE,MAAM,eAAe,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,CACpC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC;IACF,IAAI,EAAE,GAAG,cAAc,cAAc,CAAC;IACtC,OAAO,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,2BAA2B,CACrC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC;IACF,IAAI,EAAE,GAAG,cAAc,eAAe,CAAC;IACvC,OAAO,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAC3B,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC,wBAAwB,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;AAE9D,MAAM,MAAM,gBAAgB,CAC1B,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IAErC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAC3D,2BAA2B,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;AAEjE;;GAEG;AACH,qBAAa,cAAc,CACzB,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,EACvC,mBAAmB,SAAS,SAAS,CACnC,cAAc,EACd,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ;;IAOD;;OAEG;IACH,SAAS,CAAC,SAAS,EAAE,mBAAmB,CAAC;IAczC;;;;OAIG;IACH,SAAgB,IAAI,EAAE,cAAc,CAAC;IAErC,SAAgB,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAEzD;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,KAAK,GACN,EAAE;QACD,SAAS,EAAE,iBAAiB,CAC1B,cAAc,EACd,eAAe,CAChB,CAAC,MAAM,CAAC,SAAS,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAC3D,0BAA0B,CACxB,cAAc,EACd,eAAe,CAChB,CAAC,MAAM,CAAC,SAAS,eAAe,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAC5D,mBAAmB,GACnB,2BAA2B,CACvB,cAAc,EACd,eAAe,CAChB,CAAC,MAAM,CAAC,SAAS,eAAe,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAC9D,mBAAmB,GACnB,KAAK,GACT,KAAK,CAAC;QACV,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;QACzC,IAAI,EAAE,cAAc,CAAC;QACrB,KAAK,EAAE,eAAe,CAAC;KACxB,EA4BA;IAED;;;;OAIG;IACH,IAAI,KAAK,IAAI,eAAe,CAE3B;IAED,IAAI,KAAK,CAAC,CAAC,EAJE,eAIF,EAIV;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,CACd,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,KAAK,IAAI,GAAG,eAAe,GAClE;QACD,SAAS,EAAE,eAAe,CAAC;QAC3B,OAAO,EAAE,KAAK,EAAE,CAAC;QACjB,cAAc,EAAE,KAAK,EAAE,CAAC;KACzB,CA0BA;IAED;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAa7C;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,IAAI,IAAI,CAGxB;CACF;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACrC,eAAe,SAAS,eAAe,EAEvC,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,EACxC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC,IAAI,CAAC,EACnD,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GACxC,MAAM,CAAC,MAAM,eAAe,EAAE,IAAI,CAAC,CAsCrC"}

package/dist/{BaseController.mjs → BaseController.js}

@@ -1,21 +1,31 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _BaseController_internalState, _BaseController_messenger;
-import { enablePatches, produceWithPatches, applyPatches, freeze } from "immer";
+import { enablePatches, produceWithPatches, applyPatches, freeze } from 'immer';
 enablePatches();
 /**
  * Controller class that provides state management, subscriptions, and state metadata
  */
 export class BaseController {
+    /**
+     * The controller state.
+     */
+    #internalState;
+    /**
+     * The controller messenger. This is used to interact with other parts of the application.
+     */
+    messenger;
+    /**
+     * The controller messenger.
+     *
+     * This is the same as the `messenger` property, but has a type that only lets us use
+     * actions and events that are part of the `BaseController` class.
+     */
+    #messenger;
+    /**
+     * The name of the controller.
+     *
+     * This is used by the ComposableController to construct a composed application state.
+     */
+    name;
+    metadata;
     /**
      * Creates a BaseController instance.
      *
@@ -27,20 +37,9 @@ export class BaseController {
      * @param options.state - Initial controller state.
      */
     constructor({ messenger, metadata, name, state, }) {
-        /**
-         * The controller state.
-         */
-        _BaseController_internalState.set(this, void 0);
-        /**
-         * The controller messenger.
-         *
-         * This is the same as the `messenger` property, but has a type that only lets us use
-         * actions and events that are part of the `BaseController` class.
-         */
-        _BaseController_messenger.set(this, void 0);
         // The parameter type validates that the expected actions/events are present
         // We don't have a way to validate the type property because the type is invariant
-        __classPrivateFieldSet(this, _BaseController_messenger, messenger, "f");
+        this.#messenger = messenger;
         this.messenger = messenger;
         this.name = name;
         // Here we use `freeze` from Immer to enforce that the state is deeply
@@ -48,14 +47,14 @@ export class BaseController {
         // That is, unlike `Object.freeze`, this does not narrow the type
         // recursively to `Readonly`. The equivalent in Immer is `Immutable`, but
         // `Immutable` does not handle recursive types such as our `Json` type.
-        __classPrivateFieldSet(this, _BaseController_internalState, freeze(state, true), "f");
+        this.#internalState = freeze(state, true);
         this.metadata = metadata;
-        __classPrivateFieldGet(this, _BaseController_messenger, "f").registerActionHandler(`${name}:getState`, () => this.state);
-        __classPrivateFieldGet(this, _BaseController_messenger, "f").registerInitialEventPayload({
+        this.#messenger.registerActionHandler(`${name}:getState`, () => this.state);
+        this.#messenger.registerInitialEventPayload({
             eventType: `${name}:stateChange`,
             getPayload: () => [this.state, []],
         });
-        __classPrivateFieldGet(this, _BaseController_messenger, "f").registerInitialEventPayload({
+        this.#messenger.registerInitialEventPayload({
             eventType: `${name}:stateChanged`,
             getPayload: () => [this.state, []],
         });
@@ -66,7 +65,7 @@ export class BaseController {
      * @returns The current state.
      */
     get state() {
-        return __classPrivateFieldGet(this, _BaseController_internalState, "f");
+        return this.#internalState;
     }
     set state(_) {
         throw new Error(`Controller state cannot be directly mutated; use 'update' method instead.`);
@@ -85,12 +84,12 @@ export class BaseController {
     update(callback) {
         // We run into ts2589, "infinite type depth", if we don't cast
         // produceWithPatches here.
-        const [nextState, patches, inversePatches] = produceWithPatches(__classPrivateFieldGet(this, _BaseController_internalState, "f"), callback);
+        const [nextState, patches, inversePatches] = produceWithPatches(this.#internalState, callback);
         // Protect against unnecessary state updates when there is no state diff.
         if (patches.length > 0) {
-            __classPrivateFieldSet(this, _BaseController_internalState, nextState, "f");
-            __classPrivateFieldGet(this, _BaseController_messenger, "f").publish(`${this.name}:stateChange`, nextState, patches);
-            __classPrivateFieldGet(this, _BaseController_messenger, "f").publish(`${this.name}:stateChanged`, nextState, patches);
+            this.#internalState = nextState;
+            this.#messenger.publish(`${this.name}:stateChange`, nextState, patches);
+            this.#messenger.publish(`${this.name}:stateChanged`, nextState, patches);
         }
         return { nextState, patches, inversePatches };
     }
@@ -102,10 +101,10 @@ export class BaseController {
      * or undo changes.
      */
     applyPatches(patches) {
-        const nextState = applyPatches(__classPrivateFieldGet(this, _BaseController_internalState, "f"), patches);
-        __classPrivateFieldSet(this, _BaseController_internalState, nextState, "f");
-        __classPrivateFieldGet(this, _BaseController_messenger, "f").publish(`${this.name}:stateChange`, nextState, patches);
-        __classPrivateFieldGet(this, _BaseController_messenger, "f").publish(`${this.name}:stateChanged`, nextState, patches);
+        const nextState = applyPatches(this.#internalState, patches);
+        this.#internalState = nextState;
+        this.#messenger.publish(`${this.name}:stateChange`, nextState, patches);
+        this.#messenger.publish(`${this.name}:stateChanged`, nextState, patches);
     }
     /**
      * Prepares the controller for garbage collection. This should be extended
@@ -121,7 +120,6 @@ export class BaseController {
         this.messenger.clearEventSubscriptions(`${this.name}:stateChanged`);
     }
 }
-_BaseController_internalState = new WeakMap(), _BaseController_messenger = new WeakMap();
 /**
  * Use the metadata to derive state according to the given metadata property.
  *
@@ -167,4 +165,4 @@ export function deriveStateFromMetadata(state, metadata, metadataProperty, captu
         }
     }, {});
 }
-//# sourceMappingURL=BaseController.mjs.map
+//# sourceMappingURL=BaseController.js.map

package/dist/BaseController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseController.js","sourceRoot":"","sources":["../src/BaseController.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAGhF,aAAa,EAAE,CAAC;AA6KhB;;GAEG;AACH,MAAM,OAAO,cAAc;IAazB;;OAEG;IACH,cAAc,CAAkB;IAEhC;;OAEG;IACO,SAAS,CAAsB;IAEzC;;;;;OAKG;IACM,UAAU,CAIjB;IAEF;;;;OAIG;IACa,IAAI,CAAiB;IAErB,QAAQ,CAAiC;IAEzD;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,KAAK,GAqBN;QACC,4EAA4E;QAC5E,kFAAkF;QAClF,IAAI,CAAC,UAAU,GAAG,SAIjB,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,sEAAsE;QACtE,0EAA0E;QAC1E,iEAAiE;QACjE,yEAAyE;QACzE,uEAAuE;QACvE,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,GAAG,IAAI,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE5E,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;YAC1C,SAAS,EAAE,GAAG,IAAI,cAAc;YAChC,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;SACnC,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;YAC1C,SAAS,EAAE,GAAG,IAAI,eAAe;YACjC,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;SACnC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAI,KAAK,CAAC,CAAC;QACT,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACO,MAAM,CACd,QAAmE;QAMnE,8DAA8D;QAC9D,2BAA2B;QAC3B,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,cAAc,CAAC,GACxC,kBAID,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;QAEjC,yEAAyE;QACzE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;YAChC,IAAI,CAAC,UAAU,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,cAAuB,EACnC,SAAS,EACT,OAAO,CACR,CAAC;YACF,IAAI,CAAC,UAAU,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC,SAAS,EACT,OAAO,CACR,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACO,YAAY,CAAC,OAAgB;QACrC,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAC7D,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,UAAU,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,cAAuB,EACnC,SAAS,EACT,OAAO,CACR,CAAC;QACF,IAAI,CAAC,UAAU,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC,SAAS,EACT,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,OAAO;QACf,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,IAAI,cAAc,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,IAAI,eAAe,CAAC,CAAC;IACtE,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,uBAAuB,CAGrC,KAAsB,EACtB,QAAwC,EACxC,gBAAmD,EACnD,gBAAyC;IAEzC,OAAQ,MAAM,CAAC,IAAI,CAAC,KAAK,CAA+B,CAAC,MAAM,CAE7D,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE;QACtB,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5D,CAAC;YACD,MAAM,gBAAgB,GAAG,aAAa,CAAC,gBAAgB,CAAC,CAAC;YACzD,MAAM,aAAa,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,YAAY,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;YACtD,CAAC;iBAAM,IAAI,gBAAgB,EAAE,CAAC;gBAC5B,YAAY,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;YACpC,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,8DAA8D;YAC9D,2HAA2H;YAC3H,IAAI,gBAAgB,EAAE,CAAC;gBACrB,IAAI,CAAC;oBACH,gBAAgB,CACd,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAC1D,CAAC;gBACJ,CAAC;gBAAC,OAAO,qBAAqB,EAAE,CAAC;oBAC/B,OAAO,CAAC,KAAK,CACX,IAAI,KAAK,CAAC,8CAA8C,CAAC,EACzD,qBAAqB,CACtB,CAAC;oBACF,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;IACH,CAAC,EAAE,EAAW,CAAC,CAAC;AAClB,CAAC","sourcesContent":["import type {\n  ActionConstraint,\n  EventConstraint,\n  Messenger,\n  MessengerActions,\n  MessengerEvents,\n} from '@metamask/messenger';\nimport type { Json, PublicInterface } from '@metamask/utils';\nimport { enablePatches, produceWithPatches, applyPatches, freeze } from 'immer';\nimport type { Draft, Patch } from 'immer';\n\nenablePatches();\n\n/**\n * A type that constrains the state of all controllers.\n *\n * In other words, the narrowest supertype encompassing all controller state.\n */\nexport type StateConstraint = Record<string, Json>;\n\n/**\n * A state change listener.\n *\n * This function will get called for each state change, and is given a copy of\n * the new state along with a set of patches describing the changes since the\n * last update.\n *\n * @param state - The new controller state.\n * @param patches - A list of patches describing any changes (see here for more\n * information: https://immerjs.github.io/immer/docs/patches)\n */\nexport type StateChangeListener<Type> = (state: Type, patches: Patch[]) => void;\n\n/**\n * An function to derive state.\n *\n * This function will accept one piece of the controller state (one property),\n * and will return some derivation of that state.\n *\n * @param value - A piece of controller state.\n * @returns Something derived from controller state.\n */\nexport type StateDeriver<Type extends Json> = (value: Type) => Json;\n\n/**\n * State metadata.\n *\n * This metadata describes which parts of state should be persisted, and how to\n * get an anonymized representation of the state.\n */\nexport type StateMetadata<Type extends StateConstraint> = {\n  [Key in keyof Type]-?: StatePropertyMetadata<Type[Key]>;\n};\n\n/**\n * Metadata for a single state property\n */\nexport type StatePropertyMetadata<ControllerState extends Json> = {\n  /**\n   * Indicates whether this property should be included in debug snapshots attached to Sentry\n   * errors.\n   *\n   * Set this to false if the state may contain personally identifiable information, or if it's\n   * too large to include in a debug snapshot.\n   */\n  includeInDebugSnapshot: boolean | StateDeriver<ControllerState>;\n  /**\n   * Indicates whether this property should be included in state logs.\n   *\n   * Set this to false if the data should be kept hidden from support agents (e.g. if it contains\n   * secret keys, or personally-identifiable information that is not useful for debugging).\n   *\n   * We do allow state logs to contain some personally identifiable information to assist with\n   * diagnosing errors (e.g. transaction hashes, addresses), but we still attempt to limit the\n   * data we expose to what is most useful for helping users.\n   */\n  includeInStateLogs: boolean | StateDeriver<ControllerState>;\n  /**\n   * Indicates whether this property should be persisted.\n   *\n   * If true, the property will be persisted and saved between sessions.\n   * If false, the property will not be saved between sessions, and it will always be missing from the `state` constructor parameter.\n   */\n  persist: boolean | StateDeriver<ControllerState>;\n  /**\n   * Indicates whether this property is used by the UI.\n   *\n   * If true, the property will be accessible from the UI.\n   * If false, it will be inaccessible from the UI.\n   *\n   * Making a property accessible to the UI has a performance overhead, so it's better to set this\n   * to `false` if it's not used in the UI, especially for properties that can be large in size.\n   *\n   * Note that we disallow the use of a state derivation function here to preserve type information\n   * for the UI (the state deriver type always returns `Json`).\n   */\n  usedInUi: boolean;\n};\n\n/**\n * A universal supertype of `StateDeriver` types.\n * This type can be assigned to any `StateDeriver` type.\n */\nexport type StateDeriverConstraint = (value: never) => Json;\n\n/**\n * A universal supertype of `StatePropertyMetadata` types.\n * This type can be assigned to any `StatePropertyMetadata` type.\n */\nexport type StatePropertyMetadataConstraint = {\n  includeInDebugSnapshot: boolean | StateDeriverConstraint;\n  includeInStateLogs: boolean | StateDeriverConstraint;\n  persist: boolean | StateDeriverConstraint;\n  usedInUi: boolean;\n};\n\n/**\n * A universal supertype of `StateMetadata` types.\n * This type can be assigned to any `StateMetadata` type.\n */\nexport type StateMetadataConstraint = Record<\n  string,\n  StatePropertyMetadataConstraint\n>;\n\n/**\n * The widest subtype of all controller instances that inherit from `BaseController` (formerly `BaseControllerV2`).\n * Any `BaseController` subclass instance can be assigned to this type.\n */\nexport type BaseControllerInstance = Omit<\n  PublicInterface<\n    BaseController<\n      string,\n      StateConstraint,\n      // Use `any` to allow any parent to be set.\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      Messenger<string, ActionConstraint, EventConstraint, any>\n    >\n  >,\n  'metadata'\n> & {\n  metadata: StateMetadataConstraint;\n};\n\nexport type ControllerGetStateAction<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:getState`;\n  handler: () => ControllerState;\n};\n\n/**\n * @deprecated This event type is deprecated. Please use\n * `ControllerStateChangedEvent` instead.\n */\nexport type ControllerStateChangeEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:stateChange`;\n  payload: [ControllerState, Patch[]];\n};\n\nexport type ControllerStateChangedEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:stateChanged`;\n  payload: [ControllerState, Patch[]];\n};\n\nexport type ControllerActions<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = ControllerGetStateAction<ControllerName, ControllerState>;\n\nexport type ControllerEvents<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> =\n  | ControllerStateChangeEvent<ControllerName, ControllerState>\n  | ControllerStateChangedEvent<ControllerName, ControllerState>;\n\n/**\n * Controller class that provides state management, subscriptions, and state metadata\n */\nexport class BaseController<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n  ControllerMessenger extends Messenger<\n    ControllerName,\n    ActionConstraint,\n    EventConstraint,\n    // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n    // it's the one totally safe place to use it.\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    any\n  >,\n> {\n  /**\n   * The controller state.\n   */\n  #internalState: ControllerState;\n\n  /**\n   * The controller messenger. This is used to interact with other parts of the application.\n   */\n  protected messenger: ControllerMessenger;\n\n  /**\n   * The controller messenger.\n   *\n   * This is the same as the `messenger` property, but has a type that only lets us use\n   * actions and events that are part of the `BaseController` class.\n   */\n  readonly #messenger: Messenger<\n    ControllerName,\n    ControllerActions<ControllerName, ControllerState>,\n    ControllerEvents<ControllerName, ControllerState>\n  >;\n\n  /**\n   * The name of the controller.\n   *\n   * This is used by the ComposableController to construct a composed application state.\n   */\n  public readonly name: ControllerName;\n\n  public readonly metadata: StateMetadata<ControllerState>;\n\n  /**\n   * Creates a BaseController instance.\n   *\n   * @param options - Controller options.\n   * @param options.messenger - The controller messenger.\n   * @param options.metadata - ControllerState metadata, describing how to \"anonymize\" the state, and which\n   * parts should be persisted.\n   * @param options.name - The name of the controller, used as a namespace for events and actions.\n   * @param options.state - Initial controller state.\n   */\n  constructor({\n    messenger,\n    metadata,\n    name,\n    state,\n  }: {\n    messenger: ControllerActions<\n      ControllerName,\n      ControllerState\n    >['type'] extends MessengerActions<ControllerMessenger>['type']\n      ? ControllerStateChangeEvent<\n          ControllerName,\n          ControllerState\n        >['type'] extends MessengerEvents<ControllerMessenger>['type']\n        ? ControllerMessenger\n        : ControllerStateChangedEvent<\n              ControllerName,\n              ControllerState\n            >['type'] extends MessengerEvents<ControllerMessenger>['type']\n          ? ControllerMessenger\n          : never\n      : never;\n    metadata: StateMetadata<ControllerState>;\n    name: ControllerName;\n    state: ControllerState;\n  }) {\n    // The parameter type validates that the expected actions/events are present\n    // We don't have a way to validate the type property because the type is invariant\n    this.#messenger = messenger as unknown as Messenger<\n      ControllerName,\n      ControllerActions<ControllerName, ControllerState>,\n      ControllerEvents<ControllerName, ControllerState>\n    >;\n    this.messenger = messenger;\n    this.name = name;\n    // Here we use `freeze` from Immer to enforce that the state is deeply\n    // immutable. Note that this is a runtime check, not a compile-time check.\n    // That is, unlike `Object.freeze`, this does not narrow the type\n    // recursively to `Readonly`. The equivalent in Immer is `Immutable`, but\n    // `Immutable` does not handle recursive types such as our `Json` type.\n    this.#internalState = freeze(state, true);\n    this.metadata = metadata;\n\n    this.#messenger.registerActionHandler(`${name}:getState`, () => this.state);\n\n    this.#messenger.registerInitialEventPayload({\n      eventType: `${name}:stateChange`,\n      getPayload: () => [this.state, []],\n    });\n    this.#messenger.registerInitialEventPayload({\n      eventType: `${name}:stateChanged`,\n      getPayload: () => [this.state, []],\n    });\n  }\n\n  /**\n   * Retrieves current controller state.\n   *\n   * @returns The current state.\n   */\n  get state(): ControllerState {\n    return this.#internalState;\n  }\n\n  set state(_) {\n    throw new Error(\n      `Controller state cannot be directly mutated; use 'update' method instead.`,\n    );\n  }\n\n  /**\n   * Updates controller state. Accepts a callback that is passed a draft copy\n   * of the controller state. If a value is returned, it is set as the new\n   * state. Otherwise, any changes made within that callback to the draft are\n   * applied to the controller state.\n   *\n   * @param callback - Callback for updating state, passed a draft state\n   * object. Return a new state object or mutate the draft to update state.\n   * @returns An object that has the next state, patches applied in the update and inverse patches to\n   * rollback the update.\n   */\n  protected update(\n    callback: (state: Draft<ControllerState>) => void | ControllerState,\n  ): {\n    nextState: ControllerState;\n    patches: Patch[];\n    inversePatches: Patch[];\n  } {\n    // We run into ts2589, \"infinite type depth\", if we don't cast\n    // produceWithPatches here.\n    const [nextState, patches, inversePatches] = (\n      produceWithPatches as unknown as (\n        state: ControllerState,\n        callbackFn: typeof callback,\n      ) => [ControllerState, Patch[], Patch[]]\n    )(this.#internalState, callback);\n\n    // Protect against unnecessary state updates when there is no state diff.\n    if (patches.length > 0) {\n      this.#internalState = nextState;\n      this.#messenger.publish(\n        `${this.name}:stateChange` as const,\n        nextState,\n        patches,\n      );\n      this.#messenger.publish(\n        `${this.name}:stateChanged` as const,\n        nextState,\n        patches,\n      );\n    }\n\n    return { nextState, patches, inversePatches };\n  }\n\n  /**\n   * Applies immer patches to the current state. The patches come from the\n   * update function itself and can either be normal or inverse patches.\n   *\n   * @param patches - An array of immer patches that are to be applied to make\n   * or undo changes.\n   */\n  protected applyPatches(patches: Patch[]): void {\n    const nextState = applyPatches(this.#internalState, patches);\n    this.#internalState = nextState;\n    this.#messenger.publish(\n      `${this.name}:stateChange` as const,\n      nextState,\n      patches,\n    );\n    this.#messenger.publish(\n      `${this.name}:stateChanged` as const,\n      nextState,\n      patches,\n    );\n  }\n\n  /**\n   * Prepares the controller for garbage collection. This should be extended\n   * by any subclasses to clean up any additional connections or events.\n   *\n   * The only cleanup performed here is to remove listeners. While technically\n   * this is not required to ensure this instance is garbage collected, it at\n   * least ensures this instance won't be responsible for preventing the\n   * listeners from being garbage collected.\n   */\n  protected destroy(): void {\n    this.messenger.clearEventSubscriptions(`${this.name}:stateChange`);\n    this.messenger.clearEventSubscriptions(`${this.name}:stateChanged`);\n  }\n}\n\n/**\n * Use the metadata to derive state according to the given metadata property.\n *\n * @param state - The full controller state.\n * @param metadata - The controller metadata.\n * @param metadataProperty - The metadata property to use to derive state.\n * @param captureException - Reports an error to an error monitoring service.\n * @returns The metadata-derived controller state.\n */\nexport function deriveStateFromMetadata<\n  ControllerState extends StateConstraint,\n>(\n  state: ControllerState,\n  metadata: StateMetadata<ControllerState>,\n  metadataProperty: keyof StatePropertyMetadata<Json>,\n  captureException?: (error: Error) => void,\n): Record<keyof ControllerState, Json> {\n  return (Object.keys(state) as (keyof ControllerState)[]).reduce<\n    Record<keyof ControllerState, Json>\n  >((derivedState, key) => {\n    try {\n      const stateMetadata = metadata[key];\n      if (!stateMetadata) {\n        throw new Error(`No metadata found for '${String(key)}'`);\n      }\n      const propertyMetadata = stateMetadata[metadataProperty];\n      const stateProperty = state[key];\n      if (typeof propertyMetadata === 'function') {\n        derivedState[key] = propertyMetadata(stateProperty);\n      } else if (propertyMetadata) {\n        derivedState[key] = stateProperty;\n      }\n      return derivedState;\n    } catch (error) {\n      // Capture error without interrupting state-related operations\n      // See [ADR core#0016](https://github.com/MetaMask/decisions/blob/main/decisions/core/0016-core-classes-error-reporting.md)\n      if (captureException) {\n        try {\n          captureException(\n            error instanceof Error ? error : new Error(String(error)),\n          );\n        } catch (captureExceptionError) {\n          console.error(\n            new Error(`Error thrown when calling 'captureException'`),\n            captureExceptionError,\n          );\n          console.error(error);\n        }\n      } else {\n        console.error(error);\n      }\n      return derivedState;\n    }\n  }, {} as never);\n}\n"]}

package/dist/{index.d.cts → index.d.ts}

@@ -1,3 +1,3 @@
-export type { BaseControllerInstance, StateChangeListener, StateConstraint, StateDeriver, StateDeriverConstraint, StateMetadata, StateMetadataConstraint, StatePropertyMetadata, StatePropertyMetadataConstraint, ControllerGetStateAction, ControllerStateChangeEvent, ControllerStateChangedEvent, } from "./BaseController.cjs";
-export { BaseController, deriveStateFromMetadata } from "./BaseController.cjs";
-//# sourceMappingURL=index.d.cts.map
+export type { BaseControllerInstance, StateChangeListener, StateConstraint, StateDeriver, StateDeriverConstraint, StateMetadata, StateMetadataConstraint, StatePropertyMetadata, StatePropertyMetadataConstraint, ControllerGetStateAction, ControllerStateChangeEvent, ControllerStateChangedEvent, } from './BaseController.js';
+export { BaseController, deriveStateFromMetadata } from './BaseController.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,sBAAsB,EACtB,mBAAmB,EACnB,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { BaseController, deriveStateFromMetadata } from './BaseController.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["export type {\n  BaseControllerInstance,\n  StateChangeListener,\n  StateConstraint,\n  StateDeriver,\n  StateDeriverConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  StatePropertyMetadata,\n  StatePropertyMetadataConstraint,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  ControllerStateChangedEvent,\n} from './BaseController.js';\nexport { BaseController, deriveStateFromMetadata } from './BaseController.js';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/base-controller",
-  "version": "9.1.0-preview-8bfa290fb",
+  "version": "10.0.0-preview-97d6b86c0",
   "description": "Provides scaffolding for controllers as well a communication system for all controllers",
   "keywords": [
     "Ethereum",
@@ -18,18 +18,11 @@
   "files": [
     "dist/"
   ],
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.cts",
+  "type": "module",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -38,9 +31,11 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
-    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build": "tsc --project tsconfig.build.json",
+    "build:all": "tsc --build tsconfig.build.json --verbose",
+    "build:clean": "yarn build:only-clean && yarn build",
     "build:docs": "typedoc",
+    "build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/base-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/base-controller",
     "lint:tsconfigs": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts",
@@ -52,23 +47,24 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/messenger": "^2.0.0",
+    "@metamask/messenger": "^3.0.0",
     "@metamask/utils": "^11.12.0",
     "immer": "^9.0.6"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",
-    "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^30.0.0",
+    "@typescript/native": "npm:typescript@^7.0.2",
     "deepmerge": "^4.2.2",
     "jest": "^30.4.2",
+    "rimraf": "^5.0.5",
     "ts-jest": "^29.4.11",
     "tsx": "^4.20.5",
     "typedoc": "^0.25.13",
     "typedoc-plugin-missing-exports": "^2.0.0",
-    "typescript": "~5.3.3"
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
   },
   "engines": {
-    "node": "^18.18 || >=20"
+    "node": "^22.14.0 || ^24"
   }
 }

package/dist/BaseController.cjs

@@ -1,175 +0,0 @@
-"use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _BaseController_internalState, _BaseController_messenger;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deriveStateFromMetadata = exports.BaseController = void 0;
-const immer_1 = require("immer");
-(0, immer_1.enablePatches)();
-/**
- * Controller class that provides state management, subscriptions, and state metadata
- */
-class BaseController {
-    /**
-     * Creates a BaseController instance.
-     *
-     * @param options - Controller options.
-     * @param options.messenger - The controller messenger.
-     * @param options.metadata - ControllerState metadata, describing how to "anonymize" the state, and which
-     * parts should be persisted.
-     * @param options.name - The name of the controller, used as a namespace for events and actions.
-     * @param options.state - Initial controller state.
-     */
-    constructor({ messenger, metadata, name, state, }) {
-        /**
-         * The controller state.
-         */
-        _BaseController_internalState.set(this, void 0);
-        /**
-         * The controller messenger.
-         *
-         * This is the same as the `messenger` property, but has a type that only lets us use
-         * actions and events that are part of the `BaseController` class.
-         */
-        _BaseController_messenger.set(this, void 0);
-        // The parameter type validates that the expected actions/events are present
-        // We don't have a way to validate the type property because the type is invariant
-        __classPrivateFieldSet(this, _BaseController_messenger, messenger, "f");
-        this.messenger = messenger;
-        this.name = name;
-        // Here we use `freeze` from Immer to enforce that the state is deeply
-        // immutable. Note that this is a runtime check, not a compile-time check.
-        // That is, unlike `Object.freeze`, this does not narrow the type
-        // recursively to `Readonly`. The equivalent in Immer is `Immutable`, but
-        // `Immutable` does not handle recursive types such as our `Json` type.
-        __classPrivateFieldSet(this, _BaseController_internalState, (0, immer_1.freeze)(state, true), "f");
-        this.metadata = metadata;
-        __classPrivateFieldGet(this, _BaseController_messenger, "f").registerActionHandler(`${name}:getState`, () => this.state);
-        __classPrivateFieldGet(this, _BaseController_messenger, "f").registerInitialEventPayload({
-            eventType: `${name}:stateChange`,
-            getPayload: () => [this.state, []],
-        });
-        __classPrivateFieldGet(this, _BaseController_messenger, "f").registerInitialEventPayload({
-            eventType: `${name}:stateChanged`,
-            getPayload: () => [this.state, []],
-        });
-    }
-    /**
-     * Retrieves current controller state.
-     *
-     * @returns The current state.
-     */
-    get state() {
-        return __classPrivateFieldGet(this, _BaseController_internalState, "f");
-    }
-    set state(_) {
-        throw new Error(`Controller state cannot be directly mutated; use 'update' method instead.`);
-    }
-    /**
-     * Updates controller state. Accepts a callback that is passed a draft copy
-     * of the controller state. If a value is returned, it is set as the new
-     * state. Otherwise, any changes made within that callback to the draft are
-     * applied to the controller state.
-     *
-     * @param callback - Callback for updating state, passed a draft state
-     * object. Return a new state object or mutate the draft to update state.
-     * @returns An object that has the next state, patches applied in the update and inverse patches to
-     * rollback the update.
-     */
-    update(callback) {
-        // We run into ts2589, "infinite type depth", if we don't cast
-        // produceWithPatches here.
-        const [nextState, patches, inversePatches] = immer_1.produceWithPatches(__classPrivateFieldGet(this, _BaseController_internalState, "f"), callback);
-        // Protect against unnecessary state updates when there is no state diff.
-        if (patches.length > 0) {
-            __classPrivateFieldSet(this, _BaseController_internalState, nextState, "f");
-            __classPrivateFieldGet(this, _BaseController_messenger, "f").publish(`${this.name}:stateChange`, nextState, patches);
-            __classPrivateFieldGet(this, _BaseController_messenger, "f").publish(`${this.name}:stateChanged`, nextState, patches);
-        }
-        return { nextState, patches, inversePatches };
-    }
-    /**
-     * Applies immer patches to the current state. The patches come from the
-     * update function itself and can either be normal or inverse patches.
-     *
-     * @param patches - An array of immer patches that are to be applied to make
-     * or undo changes.
-     */
-    applyPatches(patches) {
-        const nextState = (0, immer_1.applyPatches)(__classPrivateFieldGet(this, _BaseController_internalState, "f"), patches);
-        __classPrivateFieldSet(this, _BaseController_internalState, nextState, "f");
-        __classPrivateFieldGet(this, _BaseController_messenger, "f").publish(`${this.name}:stateChange`, nextState, patches);
-        __classPrivateFieldGet(this, _BaseController_messenger, "f").publish(`${this.name}:stateChanged`, nextState, patches);
-    }
-    /**
-     * Prepares the controller for garbage collection. This should be extended
-     * by any subclasses to clean up any additional connections or events.
-     *
-     * The only cleanup performed here is to remove listeners. While technically
-     * this is not required to ensure this instance is garbage collected, it at
-     * least ensures this instance won't be responsible for preventing the
-     * listeners from being garbage collected.
-     */
-    destroy() {
-        this.messenger.clearEventSubscriptions(`${this.name}:stateChange`);
-        this.messenger.clearEventSubscriptions(`${this.name}:stateChanged`);
-    }
-}
-exports.BaseController = BaseController;
-_BaseController_internalState = new WeakMap(), _BaseController_messenger = new WeakMap();
-/**
- * Use the metadata to derive state according to the given metadata property.
- *
- * @param state - The full controller state.
- * @param metadata - The controller metadata.
- * @param metadataProperty - The metadata property to use to derive state.
- * @param captureException - Reports an error to an error monitoring service.
- * @returns The metadata-derived controller state.
- */
-function deriveStateFromMetadata(state, metadata, metadataProperty, captureException) {
-    return Object.keys(state).reduce((derivedState, key) => {
-        try {
-            const stateMetadata = metadata[key];
-            if (!stateMetadata) {
-                throw new Error(`No metadata found for '${String(key)}'`);
-            }
-            const propertyMetadata = stateMetadata[metadataProperty];
-            const stateProperty = state[key];
-            if (typeof propertyMetadata === 'function') {
-                derivedState[key] = propertyMetadata(stateProperty);
-            }
-            else if (propertyMetadata) {
-                derivedState[key] = stateProperty;
-            }
-            return derivedState;
-        }
-        catch (error) {
-            // Capture error without interrupting state-related operations
-            // See [ADR core#0016](https://github.com/MetaMask/decisions/blob/main/decisions/core/0016-core-classes-error-reporting.md)
-            if (captureException) {
-                try {
-                    captureException(error instanceof Error ? error : new Error(String(error)));
-                }
-                catch (captureExceptionError) {
-                    console.error(new Error(`Error thrown when calling 'captureException'`), captureExceptionError);
-                    console.error(error);
-                }
-            }
-            else {
-                console.error(error);
-            }
-            return derivedState;
-        }
-    }, {});
-}
-exports.deriveStateFromMetadata = deriveStateFromMetadata;
-//# sourceMappingURL=BaseController.cjs.map

package/dist/BaseController.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"BaseController.cjs","sourceRoot":"","sources":["../src/BaseController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAQA,iCAAgF;AAGhF,IAAA,qBAAa,GAAE,CAAC;AA6KhB;;GAEG;AACH,MAAa,cAAc;IA4CzB;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,KAAK,GAqBN;QAlED;;WAEG;QACH,gDAAgC;QAOhC;;;;;WAKG;QACM,4CAIP;QA+CA,4EAA4E;QAC5E,kFAAkF;QAClF,uBAAA,IAAI,6BAAc,SAIjB,MAAA,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,sEAAsE;QACtE,0EAA0E;QAC1E,iEAAiE;QACjE,yEAAyE;QACzE,uEAAuE;QACvE,uBAAA,IAAI,iCAAkB,IAAA,cAAM,EAAC,KAAK,EAAE,IAAI,CAAC,MAAA,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,uBAAA,IAAI,iCAAW,CAAC,qBAAqB,CAAC,GAAG,IAAI,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE5E,uBAAA,IAAI,iCAAW,CAAC,2BAA2B,CAAC;YAC1C,SAAS,EAAE,GAAG,IAAI,cAAc;YAChC,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;SACnC,CAAC,CAAC;QACH,uBAAA,IAAI,iCAAW,CAAC,2BAA2B,CAAC;YAC1C,SAAS,EAAE,GAAG,IAAI,eAAe;YACjC,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;SACnC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,qCAAe,CAAC;IAC7B,CAAC;IAED,IAAI,KAAK,CAAC,CAAC;QACT,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACO,MAAM,CACd,QAAmE;QAMnE,8DAA8D;QAC9D,2BAA2B;QAC3B,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,cAAc,CAAC,GACxC,0BAID,CAAC,uBAAA,IAAI,qCAAe,EAAE,QAAQ,CAAC,CAAC;QAEjC,yEAAyE;QACzE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,uBAAA,IAAI,iCAAkB,SAAS,MAAA,CAAC;YAChC,uBAAA,IAAI,iCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,cAAuB,EACnC,SAAS,EACT,OAAO,CACR,CAAC;YACF,uBAAA,IAAI,iCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC,SAAS,EACT,OAAO,CACR,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACO,YAAY,CAAC,OAAgB;QACrC,MAAM,SAAS,GAAG,IAAA,oBAAY,EAAC,uBAAA,IAAI,qCAAe,EAAE,OAAO,CAAC,CAAC;QAC7D,uBAAA,IAAI,iCAAkB,SAAS,MAAA,CAAC;QAChC,uBAAA,IAAI,iCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,cAAuB,EACnC,SAAS,EACT,OAAO,CACR,CAAC;QACF,uBAAA,IAAI,iCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC,SAAS,EACT,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,OAAO;QACf,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,IAAI,cAAc,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,IAAI,eAAe,CAAC,CAAC;IACtE,CAAC;CACF;AA5MD,wCA4MC;;AAED;;;;;;;;GAQG;AACH,SAAgB,uBAAuB,CAGrC,KAAsB,EACtB,QAAwC,EACxC,gBAAmD,EACnD,gBAAyC;IAEzC,OAAQ,MAAM,CAAC,IAAI,CAAC,KAAK,CAA+B,CAAC,MAAM,CAE7D,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE;QACtB,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5D,CAAC;YACD,MAAM,gBAAgB,GAAG,aAAa,CAAC,gBAAgB,CAAC,CAAC;YACzD,MAAM,aAAa,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,YAAY,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;YACtD,CAAC;iBAAM,IAAI,gBAAgB,EAAE,CAAC;gBAC5B,YAAY,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;YACpC,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,8DAA8D;YAC9D,2HAA2H;YAC3H,IAAI,gBAAgB,EAAE,CAAC;gBACrB,IAAI,CAAC;oBACH,gBAAgB,CACd,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAC1D,CAAC;gBACJ,CAAC;gBAAC,OAAO,qBAAqB,EAAE,CAAC;oBAC/B,OAAO,CAAC,KAAK,CACX,IAAI,KAAK,CAAC,8CAA8C,CAAC,EACzD,qBAAqB,CACtB,CAAC;oBACF,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;IACH,CAAC,EAAE,EAAW,CAAC,CAAC;AAClB,CAAC;AA7CD,0DA6CC","sourcesContent":["import type {\n  ActionConstraint,\n  EventConstraint,\n  Messenger,\n  MessengerActions,\n  MessengerEvents,\n} from '@metamask/messenger';\nimport type { Json, PublicInterface } from '@metamask/utils';\nimport { enablePatches, produceWithPatches, applyPatches, freeze } from 'immer';\nimport type { Draft, Patch } from 'immer';\n\nenablePatches();\n\n/**\n * A type that constrains the state of all controllers.\n *\n * In other words, the narrowest supertype encompassing all controller state.\n */\nexport type StateConstraint = Record<string, Json>;\n\n/**\n * A state change listener.\n *\n * This function will get called for each state change, and is given a copy of\n * the new state along with a set of patches describing the changes since the\n * last update.\n *\n * @param state - The new controller state.\n * @param patches - A list of patches describing any changes (see here for more\n * information: https://immerjs.github.io/immer/docs/patches)\n */\nexport type StateChangeListener<Type> = (state: Type, patches: Patch[]) => void;\n\n/**\n * An function to derive state.\n *\n * This function will accept one piece of the controller state (one property),\n * and will return some derivation of that state.\n *\n * @param value - A piece of controller state.\n * @returns Something derived from controller state.\n */\nexport type StateDeriver<Type extends Json> = (value: Type) => Json;\n\n/**\n * State metadata.\n *\n * This metadata describes which parts of state should be persisted, and how to\n * get an anonymized representation of the state.\n */\nexport type StateMetadata<Type extends StateConstraint> = {\n  [Key in keyof Type]-?: StatePropertyMetadata<Type[Key]>;\n};\n\n/**\n * Metadata for a single state property\n */\nexport type StatePropertyMetadata<ControllerState extends Json> = {\n  /**\n   * Indicates whether this property should be included in debug snapshots attached to Sentry\n   * errors.\n   *\n   * Set this to false if the state may contain personally identifiable information, or if it's\n   * too large to include in a debug snapshot.\n   */\n  includeInDebugSnapshot: boolean | StateDeriver<ControllerState>;\n  /**\n   * Indicates whether this property should be included in state logs.\n   *\n   * Set this to false if the data should be kept hidden from support agents (e.g. if it contains\n   * secret keys, or personally-identifiable information that is not useful for debugging).\n   *\n   * We do allow state logs to contain some personally identifiable information to assist with\n   * diagnosing errors (e.g. transaction hashes, addresses), but we still attempt to limit the\n   * data we expose to what is most useful for helping users.\n   */\n  includeInStateLogs: boolean | StateDeriver<ControllerState>;\n  /**\n   * Indicates whether this property should be persisted.\n   *\n   * If true, the property will be persisted and saved between sessions.\n   * If false, the property will not be saved between sessions, and it will always be missing from the `state` constructor parameter.\n   */\n  persist: boolean | StateDeriver<ControllerState>;\n  /**\n   * Indicates whether this property is used by the UI.\n   *\n   * If true, the property will be accessible from the UI.\n   * If false, it will be inaccessible from the UI.\n   *\n   * Making a property accessible to the UI has a performance overhead, so it's better to set this\n   * to `false` if it's not used in the UI, especially for properties that can be large in size.\n   *\n   * Note that we disallow the use of a state derivation function here to preserve type information\n   * for the UI (the state deriver type always returns `Json`).\n   */\n  usedInUi: boolean;\n};\n\n/**\n * A universal supertype of `StateDeriver` types.\n * This type can be assigned to any `StateDeriver` type.\n */\nexport type StateDeriverConstraint = (value: never) => Json;\n\n/**\n * A universal supertype of `StatePropertyMetadata` types.\n * This type can be assigned to any `StatePropertyMetadata` type.\n */\nexport type StatePropertyMetadataConstraint = {\n  includeInDebugSnapshot: boolean | StateDeriverConstraint;\n  includeInStateLogs: boolean | StateDeriverConstraint;\n  persist: boolean | StateDeriverConstraint;\n  usedInUi: boolean;\n};\n\n/**\n * A universal supertype of `StateMetadata` types.\n * This type can be assigned to any `StateMetadata` type.\n */\nexport type StateMetadataConstraint = Record<\n  string,\n  StatePropertyMetadataConstraint\n>;\n\n/**\n * The widest subtype of all controller instances that inherit from `BaseController` (formerly `BaseControllerV2`).\n * Any `BaseController` subclass instance can be assigned to this type.\n */\nexport type BaseControllerInstance = Omit<\n  PublicInterface<\n    BaseController<\n      string,\n      StateConstraint,\n      // Use `any` to allow any parent to be set.\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      Messenger<string, ActionConstraint, EventConstraint, any>\n    >\n  >,\n  'metadata'\n> & {\n  metadata: StateMetadataConstraint;\n};\n\nexport type ControllerGetStateAction<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:getState`;\n  handler: () => ControllerState;\n};\n\n/**\n * @deprecated This event type is deprecated. Please use\n * `ControllerStateChangedEvent` instead.\n */\nexport type ControllerStateChangeEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:stateChange`;\n  payload: [ControllerState, Patch[]];\n};\n\nexport type ControllerStateChangedEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:stateChanged`;\n  payload: [ControllerState, Patch[]];\n};\n\nexport type ControllerActions<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = ControllerGetStateAction<ControllerName, ControllerState>;\n\nexport type ControllerEvents<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> =\n  | ControllerStateChangeEvent<ControllerName, ControllerState>\n  | ControllerStateChangedEvent<ControllerName, ControllerState>;\n\n/**\n * Controller class that provides state management, subscriptions, and state metadata\n */\nexport class BaseController<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n  ControllerMessenger extends Messenger<\n    ControllerName,\n    ActionConstraint,\n    EventConstraint,\n    // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n    // it's the one totally safe place to use it.\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    any\n  >,\n> {\n  /**\n   * The controller state.\n   */\n  #internalState: ControllerState;\n\n  /**\n   * The controller messenger. This is used to interact with other parts of the application.\n   */\n  protected messenger: ControllerMessenger;\n\n  /**\n   * The controller messenger.\n   *\n   * This is the same as the `messenger` property, but has a type that only lets us use\n   * actions and events that are part of the `BaseController` class.\n   */\n  readonly #messenger: Messenger<\n    ControllerName,\n    ControllerActions<ControllerName, ControllerState>,\n    ControllerEvents<ControllerName, ControllerState>\n  >;\n\n  /**\n   * The name of the controller.\n   *\n   * This is used by the ComposableController to construct a composed application state.\n   */\n  public readonly name: ControllerName;\n\n  public readonly metadata: StateMetadata<ControllerState>;\n\n  /**\n   * Creates a BaseController instance.\n   *\n   * @param options - Controller options.\n   * @param options.messenger - The controller messenger.\n   * @param options.metadata - ControllerState metadata, describing how to \"anonymize\" the state, and which\n   * parts should be persisted.\n   * @param options.name - The name of the controller, used as a namespace for events and actions.\n   * @param options.state - Initial controller state.\n   */\n  constructor({\n    messenger,\n    metadata,\n    name,\n    state,\n  }: {\n    messenger: ControllerActions<\n      ControllerName,\n      ControllerState\n    >['type'] extends MessengerActions<ControllerMessenger>['type']\n      ? ControllerStateChangeEvent<\n          ControllerName,\n          ControllerState\n        >['type'] extends MessengerEvents<ControllerMessenger>['type']\n        ? ControllerMessenger\n        : ControllerStateChangedEvent<\n              ControllerName,\n              ControllerState\n            >['type'] extends MessengerEvents<ControllerMessenger>['type']\n          ? ControllerMessenger\n          : never\n      : never;\n    metadata: StateMetadata<ControllerState>;\n    name: ControllerName;\n    state: ControllerState;\n  }) {\n    // The parameter type validates that the expected actions/events are present\n    // We don't have a way to validate the type property because the type is invariant\n    this.#messenger = messenger as unknown as Messenger<\n      ControllerName,\n      ControllerActions<ControllerName, ControllerState>,\n      ControllerEvents<ControllerName, ControllerState>\n    >;\n    this.messenger = messenger;\n    this.name = name;\n    // Here we use `freeze` from Immer to enforce that the state is deeply\n    // immutable. Note that this is a runtime check, not a compile-time check.\n    // That is, unlike `Object.freeze`, this does not narrow the type\n    // recursively to `Readonly`. The equivalent in Immer is `Immutable`, but\n    // `Immutable` does not handle recursive types such as our `Json` type.\n    this.#internalState = freeze(state, true);\n    this.metadata = metadata;\n\n    this.#messenger.registerActionHandler(`${name}:getState`, () => this.state);\n\n    this.#messenger.registerInitialEventPayload({\n      eventType: `${name}:stateChange`,\n      getPayload: () => [this.state, []],\n    });\n    this.#messenger.registerInitialEventPayload({\n      eventType: `${name}:stateChanged`,\n      getPayload: () => [this.state, []],\n    });\n  }\n\n  /**\n   * Retrieves current controller state.\n   *\n   * @returns The current state.\n   */\n  get state(): ControllerState {\n    return this.#internalState;\n  }\n\n  set state(_) {\n    throw new Error(\n      `Controller state cannot be directly mutated; use 'update' method instead.`,\n    );\n  }\n\n  /**\n   * Updates controller state. Accepts a callback that is passed a draft copy\n   * of the controller state. If a value is returned, it is set as the new\n   * state. Otherwise, any changes made within that callback to the draft are\n   * applied to the controller state.\n   *\n   * @param callback - Callback for updating state, passed a draft state\n   * object. Return a new state object or mutate the draft to update state.\n   * @returns An object that has the next state, patches applied in the update and inverse patches to\n   * rollback the update.\n   */\n  protected update(\n    callback: (state: Draft<ControllerState>) => void | ControllerState,\n  ): {\n    nextState: ControllerState;\n    patches: Patch[];\n    inversePatches: Patch[];\n  } {\n    // We run into ts2589, \"infinite type depth\", if we don't cast\n    // produceWithPatches here.\n    const [nextState, patches, inversePatches] = (\n      produceWithPatches as unknown as (\n        state: ControllerState,\n        callbackFn: typeof callback,\n      ) => [ControllerState, Patch[], Patch[]]\n    )(this.#internalState, callback);\n\n    // Protect against unnecessary state updates when there is no state diff.\n    if (patches.length > 0) {\n      this.#internalState = nextState;\n      this.#messenger.publish(\n        `${this.name}:stateChange` as const,\n        nextState,\n        patches,\n      );\n      this.#messenger.publish(\n        `${this.name}:stateChanged` as const,\n        nextState,\n        patches,\n      );\n    }\n\n    return { nextState, patches, inversePatches };\n  }\n\n  /**\n   * Applies immer patches to the current state. The patches come from the\n   * update function itself and can either be normal or inverse patches.\n   *\n   * @param patches - An array of immer patches that are to be applied to make\n   * or undo changes.\n   */\n  protected applyPatches(patches: Patch[]): void {\n    const nextState = applyPatches(this.#internalState, patches);\n    this.#internalState = nextState;\n    this.#messenger.publish(\n      `${this.name}:stateChange` as const,\n      nextState,\n      patches,\n    );\n    this.#messenger.publish(\n      `${this.name}:stateChanged` as const,\n      nextState,\n      patches,\n    );\n  }\n\n  /**\n   * Prepares the controller for garbage collection. This should be extended\n   * by any subclasses to clean up any additional connections or events.\n   *\n   * The only cleanup performed here is to remove listeners. While technically\n   * this is not required to ensure this instance is garbage collected, it at\n   * least ensures this instance won't be responsible for preventing the\n   * listeners from being garbage collected.\n   */\n  protected destroy(): void {\n    this.messenger.clearEventSubscriptions(`${this.name}:stateChange`);\n    this.messenger.clearEventSubscriptions(`${this.name}:stateChanged`);\n  }\n}\n\n/**\n * Use the metadata to derive state according to the given metadata property.\n *\n * @param state - The full controller state.\n * @param metadata - The controller metadata.\n * @param metadataProperty - The metadata property to use to derive state.\n * @param captureException - Reports an error to an error monitoring service.\n * @returns The metadata-derived controller state.\n */\nexport function deriveStateFromMetadata<\n  ControllerState extends StateConstraint,\n>(\n  state: ControllerState,\n  metadata: StateMetadata<ControllerState>,\n  metadataProperty: keyof StatePropertyMetadata<Json>,\n  captureException?: (error: Error) => void,\n): Record<keyof ControllerState, Json> {\n  return (Object.keys(state) as (keyof ControllerState)[]).reduce<\n    Record<keyof ControllerState, Json>\n  >((derivedState, key) => {\n    try {\n      const stateMetadata = metadata[key];\n      if (!stateMetadata) {\n        throw new Error(`No metadata found for '${String(key)}'`);\n      }\n      const propertyMetadata = stateMetadata[metadataProperty];\n      const stateProperty = state[key];\n      if (typeof propertyMetadata === 'function') {\n        derivedState[key] = propertyMetadata(stateProperty);\n      } else if (propertyMetadata) {\n        derivedState[key] = stateProperty;\n      }\n      return derivedState;\n    } catch (error) {\n      // Capture error without interrupting state-related operations\n      // See [ADR core#0016](https://github.com/MetaMask/decisions/blob/main/decisions/core/0016-core-classes-error-reporting.md)\n      if (captureException) {\n        try {\n          captureException(\n            error instanceof Error ? error : new Error(String(error)),\n          );\n        } catch (captureExceptionError) {\n          console.error(\n            new Error(`Error thrown when calling 'captureException'`),\n            captureExceptionError,\n          );\n          console.error(error);\n        }\n      } else {\n        console.error(error);\n      }\n      return derivedState;\n    }\n  }, {} as never);\n}\n"]}

package/dist/BaseController.d.cts

@@ -1,214 +0,0 @@
-import type { ActionConstraint, EventConstraint, Messenger, MessengerActions, MessengerEvents } from "@metamask/messenger";
-import type { Json, PublicInterface } from "@metamask/utils";
-import type { Draft, Patch } from "immer";
-/**
- * A type that constrains the state of all controllers.
- *
- * In other words, the narrowest supertype encompassing all controller state.
- */
-export type StateConstraint = Record<string, Json>;
-/**
- * A state change listener.
- *
- * This function will get called for each state change, and is given a copy of
- * the new state along with a set of patches describing the changes since the
- * last update.
- *
- * @param state - The new controller state.
- * @param patches - A list of patches describing any changes (see here for more
- * information: https://immerjs.github.io/immer/docs/patches)
- */
-export type StateChangeListener<Type> = (state: Type, patches: Patch[]) => void;
-/**
- * An function to derive state.
- *
- * This function will accept one piece of the controller state (one property),
- * and will return some derivation of that state.
- *
- * @param value - A piece of controller state.
- * @returns Something derived from controller state.
- */
-export type StateDeriver<Type extends Json> = (value: Type) => Json;
-/**
- * State metadata.
- *
- * This metadata describes which parts of state should be persisted, and how to
- * get an anonymized representation of the state.
- */
-export type StateMetadata<Type extends StateConstraint> = {
-    [Key in keyof Type]-?: StatePropertyMetadata<Type[Key]>;
-};
-/**
- * Metadata for a single state property
- */
-export type StatePropertyMetadata<ControllerState extends Json> = {
-    /**
-     * Indicates whether this property should be included in debug snapshots attached to Sentry
-     * errors.
-     *
-     * Set this to false if the state may contain personally identifiable information, or if it's
-     * too large to include in a debug snapshot.
-     */
-    includeInDebugSnapshot: boolean | StateDeriver<ControllerState>;
-    /**
-     * Indicates whether this property should be included in state logs.
-     *
-     * Set this to false if the data should be kept hidden from support agents (e.g. if it contains
-     * secret keys, or personally-identifiable information that is not useful for debugging).
-     *
-     * We do allow state logs to contain some personally identifiable information to assist with
-     * diagnosing errors (e.g. transaction hashes, addresses), but we still attempt to limit the
-     * data we expose to what is most useful for helping users.
-     */
-    includeInStateLogs: boolean | StateDeriver<ControllerState>;
-    /**
-     * Indicates whether this property should be persisted.
-     *
-     * If true, the property will be persisted and saved between sessions.
-     * If false, the property will not be saved between sessions, and it will always be missing from the `state` constructor parameter.
-     */
-    persist: boolean | StateDeriver<ControllerState>;
-    /**
-     * Indicates whether this property is used by the UI.
-     *
-     * If true, the property will be accessible from the UI.
-     * If false, it will be inaccessible from the UI.
-     *
-     * Making a property accessible to the UI has a performance overhead, so it's better to set this
-     * to `false` if it's not used in the UI, especially for properties that can be large in size.
-     *
-     * Note that we disallow the use of a state derivation function here to preserve type information
-     * for the UI (the state deriver type always returns `Json`).
-     */
-    usedInUi: boolean;
-};
-/**
- * A universal supertype of `StateDeriver` types.
- * This type can be assigned to any `StateDeriver` type.
- */
-export type StateDeriverConstraint = (value: never) => Json;
-/**
- * A universal supertype of `StatePropertyMetadata` types.
- * This type can be assigned to any `StatePropertyMetadata` type.
- */
-export type StatePropertyMetadataConstraint = {
-    includeInDebugSnapshot: boolean | StateDeriverConstraint;
-    includeInStateLogs: boolean | StateDeriverConstraint;
-    persist: boolean | StateDeriverConstraint;
-    usedInUi: boolean;
-};
-/**
- * A universal supertype of `StateMetadata` types.
- * This type can be assigned to any `StateMetadata` type.
- */
-export type StateMetadataConstraint = Record<string, StatePropertyMetadataConstraint>;
-/**
- * The widest subtype of all controller instances that inherit from `BaseController` (formerly `BaseControllerV2`).
- * Any `BaseController` subclass instance can be assigned to this type.
- */
-export type BaseControllerInstance = Omit<PublicInterface<BaseController<string, StateConstraint, Messenger<string, ActionConstraint, EventConstraint, any>>>, 'metadata'> & {
-    metadata: StateMetadataConstraint;
-};
-export type ControllerGetStateAction<ControllerName extends string, ControllerState extends StateConstraint> = {
-    type: `${ControllerName}:getState`;
-    handler: () => ControllerState;
-};
-/**
- * @deprecated This event type is deprecated. Please use
- * `ControllerStateChangedEvent` instead.
- */
-export type ControllerStateChangeEvent<ControllerName extends string, ControllerState extends StateConstraint> = {
-    type: `${ControllerName}:stateChange`;
-    payload: [ControllerState, Patch[]];
-};
-export type ControllerStateChangedEvent<ControllerName extends string, ControllerState extends StateConstraint> = {
-    type: `${ControllerName}:stateChanged`;
-    payload: [ControllerState, Patch[]];
-};
-export type ControllerActions<ControllerName extends string, ControllerState extends StateConstraint> = ControllerGetStateAction<ControllerName, ControllerState>;
-export type ControllerEvents<ControllerName extends string, ControllerState extends StateConstraint> = ControllerStateChangeEvent<ControllerName, ControllerState> | ControllerStateChangedEvent<ControllerName, ControllerState>;
-/**
- * Controller class that provides state management, subscriptions, and state metadata
- */
-export declare class BaseController<ControllerName extends string, ControllerState extends StateConstraint, ControllerMessenger extends Messenger<ControllerName, ActionConstraint, EventConstraint, any>> {
-    #private;
-    /**
-     * The controller messenger. This is used to interact with other parts of the application.
-     */
-    protected messenger: ControllerMessenger;
-    /**
-     * The name of the controller.
-     *
-     * This is used by the ComposableController to construct a composed application state.
-     */
-    readonly name: ControllerName;
-    readonly metadata: StateMetadata<ControllerState>;
-    /**
-     * Creates a BaseController instance.
-     *
-     * @param options - Controller options.
-     * @param options.messenger - The controller messenger.
-     * @param options.metadata - ControllerState metadata, describing how to "anonymize" the state, and which
-     * parts should be persisted.
-     * @param options.name - The name of the controller, used as a namespace for events and actions.
-     * @param options.state - Initial controller state.
-     */
-    constructor({ messenger, metadata, name, state, }: {
-        messenger: ControllerActions<ControllerName, ControllerState>['type'] extends MessengerActions<ControllerMessenger>['type'] ? ControllerStateChangeEvent<ControllerName, ControllerState>['type'] extends MessengerEvents<ControllerMessenger>['type'] ? ControllerMessenger : ControllerStateChangedEvent<ControllerName, ControllerState>['type'] extends MessengerEvents<ControllerMessenger>['type'] ? ControllerMessenger : never : never;
-        metadata: StateMetadata<ControllerState>;
-        name: ControllerName;
-        state: ControllerState;
-    });
-    /**
-     * Retrieves current controller state.
-     *
-     * @returns The current state.
-     */
-    get state(): ControllerState;
-    set state(_: ControllerState);
-    /**
-     * Updates controller state. Accepts a callback that is passed a draft copy
-     * of the controller state. If a value is returned, it is set as the new
-     * state. Otherwise, any changes made within that callback to the draft are
-     * applied to the controller state.
-     *
-     * @param callback - Callback for updating state, passed a draft state
-     * object. Return a new state object or mutate the draft to update state.
-     * @returns An object that has the next state, patches applied in the update and inverse patches to
-     * rollback the update.
-     */
-    protected update(callback: (state: Draft<ControllerState>) => void | ControllerState): {
-        nextState: ControllerState;
-        patches: Patch[];
-        inversePatches: Patch[];
-    };
-    /**
-     * Applies immer patches to the current state. The patches come from the
-     * update function itself and can either be normal or inverse patches.
-     *
-     * @param patches - An array of immer patches that are to be applied to make
-     * or undo changes.
-     */
-    protected applyPatches(patches: Patch[]): void;
-    /**
-     * Prepares the controller for garbage collection. This should be extended
-     * by any subclasses to clean up any additional connections or events.
-     *
-     * The only cleanup performed here is to remove listeners. While technically
-     * this is not required to ensure this instance is garbage collected, it at
-     * least ensures this instance won't be responsible for preventing the
-     * listeners from being garbage collected.
-     */
-    protected destroy(): void;
-}
-/**
- * Use the metadata to derive state according to the given metadata property.
- *
- * @param state - The full controller state.
- * @param metadata - The controller metadata.
- * @param metadataProperty - The metadata property to use to derive state.
- * @param captureException - Reports an error to an error monitoring service.
- * @returns The metadata-derived controller state.
- */
-export declare function deriveStateFromMetadata<ControllerState extends StateConstraint>(state: ControllerState, metadata: StateMetadata<ControllerState>, metadataProperty: keyof StatePropertyMetadata<Json>, captureException?: (error: Error) => void): Record<keyof ControllerState, Json>;
-//# sourceMappingURL=BaseController.d.cts.map

package/dist/BaseController.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BaseController.d.cts","sourceRoot":"","sources":["../src/BaseController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,SAAS,EACT,gBAAgB,EAChB,eAAe,EAChB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,wBAAwB;AAE7D,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,cAAc;AAI1C;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEnD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC;AAEhF;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,IAAI,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,IAAI,SAAS,eAAe,IAAI;KACvD,GAAG,IAAI,MAAM,IAAI,CAAC,CAAC,GAAG,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,eAAe,SAAS,IAAI,IAAI;IAChE;;;;;;OAMG;IACH,sBAAsB,EAAE,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IAChE;;;;;;;;;OASG;IACH,kBAAkB,EAAE,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IAC5D;;;;;OAKG;IACH,OAAO,EAAE,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IACjD;;;;;;;;;;;OAWG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,sBAAsB,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACzD,kBAAkB,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACrD,OAAO,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAC1C,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAC1C,MAAM,EACN,+BAA+B,CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,IAAI,CACvC,eAAe,CACb,cAAc,CACZ,MAAM,EACN,eAAe,EAGf,SAAS,CAAC,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAE,GAAG,CAAC,CAC1D,CACF,EACD,UAAU,CACX,GAAG;IACF,QAAQ,EAAE,uBAAuB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,wBAAwB,CAClC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC;IACF,IAAI,EAAE,GAAG,cAAc,WAAW,CAAC;IACnC,OAAO,EAAE,MAAM,eAAe,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,CACpC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC;IACF,IAAI,EAAE,GAAG,cAAc,cAAc,CAAC;IACtC,OAAO,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,2BAA2B,CACrC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC;IACF,IAAI,EAAE,GAAG,cAAc,eAAe,CAAC;IACvC,OAAO,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAC3B,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC,wBAAwB,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;AAE9D,MAAM,MAAM,gBAAgB,CAC1B,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IAErC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAC3D,2BAA2B,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;AAEjE;;GAEG;AACH,qBAAa,cAAc,CACzB,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,EACvC,mBAAmB,SAAS,SAAS,CACnC,cAAc,EACd,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ;;IAOD;;OAEG;IACH,SAAS,CAAC,SAAS,EAAE,mBAAmB,CAAC;IAczC;;;;OAIG;IACH,SAAgB,IAAI,EAAE,cAAc,CAAC;IAErC,SAAgB,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAEzD;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,KAAK,GACN,EAAE;QACD,SAAS,EAAE,iBAAiB,CAC1B,cAAc,EACd,eAAe,CAChB,CAAC,MAAM,CAAC,SAAS,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAC3D,0BAA0B,CACxB,cAAc,EACd,eAAe,CAChB,CAAC,MAAM,CAAC,SAAS,eAAe,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAC5D,mBAAmB,GACnB,2BAA2B,CACvB,cAAc,EACd,eAAe,CAChB,CAAC,MAAM,CAAC,SAAS,eAAe,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAC9D,mBAAmB,GACnB,KAAK,GACT,KAAK,CAAC;QACV,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;QACzC,IAAI,EAAE,cAAc,CAAC;QACrB,KAAK,EAAE,eAAe,CAAC;KACxB;IA8BD;;;;OAIG;IACH,IAAI,KAAK,IAAI,eAAe,CAE3B;IAED,IAAI,KAAK,CAAC,CAAC,EAJE,eAIF,EAIV;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,CACd,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,KAAK,IAAI,GAAG,eAAe,GAClE;QACD,SAAS,EAAE,eAAe,CAAC;QAC3B,OAAO,EAAE,KAAK,EAAE,CAAC;QACjB,cAAc,EAAE,KAAK,EAAE,CAAC;KACzB;IA4BD;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI;IAe9C;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,IAAI,IAAI;CAI1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACrC,eAAe,SAAS,eAAe,EAEvC,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,EACxC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC,IAAI,CAAC,EACnD,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GACxC,MAAM,CAAC,MAAM,eAAe,EAAE,IAAI,CAAC,CAsCrC"}

package/dist/BaseController.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BaseController.d.mts","sourceRoot":"","sources":["../src/BaseController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,SAAS,EACT,gBAAgB,EAChB,eAAe,EAChB,4BAA4B;AAC7B,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,wBAAwB;AAE7D,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,cAAc;AAI1C;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEnD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC;AAEhF;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,IAAI,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CAAC,IAAI,SAAS,eAAe,IAAI;KACvD,GAAG,IAAI,MAAM,IAAI,CAAC,CAAC,GAAG,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,eAAe,SAAS,IAAI,IAAI;IAChE;;;;;;OAMG;IACH,sBAAsB,EAAE,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IAChE;;;;;;;;;OASG;IACH,kBAAkB,EAAE,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IAC5D;;;;;OAKG;IACH,OAAO,EAAE,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;IACjD;;;;;;;;;;;OAWG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,sBAAsB,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACzD,kBAAkB,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACrD,OAAO,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAC1C,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAC1C,MAAM,EACN,+BAA+B,CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,IAAI,CACvC,eAAe,CACb,cAAc,CACZ,MAAM,EACN,eAAe,EAGf,SAAS,CAAC,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAE,GAAG,CAAC,CAC1D,CACF,EACD,UAAU,CACX,GAAG;IACF,QAAQ,EAAE,uBAAuB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,wBAAwB,CAClC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC;IACF,IAAI,EAAE,GAAG,cAAc,WAAW,CAAC;IACnC,OAAO,EAAE,MAAM,eAAe,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,0BAA0B,CACpC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC;IACF,IAAI,EAAE,GAAG,cAAc,cAAc,CAAC;IACtC,OAAO,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,2BAA2B,CACrC,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC;IACF,IAAI,EAAE,GAAG,cAAc,eAAe,CAAC;IACvC,OAAO,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAC3B,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IACrC,wBAAwB,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;AAE9D,MAAM,MAAM,gBAAgB,CAC1B,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,IAErC,0BAA0B,CAAC,cAAc,EAAE,eAAe,CAAC,GAC3D,2BAA2B,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;AAEjE;;GAEG;AACH,qBAAa,cAAc,CACzB,cAAc,SAAS,MAAM,EAC7B,eAAe,SAAS,eAAe,EACvC,mBAAmB,SAAS,SAAS,CACnC,cAAc,EACd,gBAAgB,EAChB,eAAe,EAIf,GAAG,CACJ;;IAOD;;OAEG;IACH,SAAS,CAAC,SAAS,EAAE,mBAAmB,CAAC;IAczC;;;;OAIG;IACH,SAAgB,IAAI,EAAE,cAAc,CAAC;IAErC,SAAgB,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;IAEzD;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,KAAK,GACN,EAAE;QACD,SAAS,EAAE,iBAAiB,CAC1B,cAAc,EACd,eAAe,CAChB,CAAC,MAAM,CAAC,SAAS,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAC3D,0BAA0B,CACxB,cAAc,EACd,eAAe,CAChB,CAAC,MAAM,CAAC,SAAS,eAAe,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAC5D,mBAAmB,GACnB,2BAA2B,CACvB,cAAc,EACd,eAAe,CAChB,CAAC,MAAM,CAAC,SAAS,eAAe,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAC9D,mBAAmB,GACnB,KAAK,GACT,KAAK,CAAC;QACV,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;QACzC,IAAI,EAAE,cAAc,CAAC;QACrB,KAAK,EAAE,eAAe,CAAC;KACxB;IA8BD;;;;OAIG;IACH,IAAI,KAAK,IAAI,eAAe,CAE3B;IAED,IAAI,KAAK,CAAC,CAAC,EAJE,eAIF,EAIV;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,CACd,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,KAAK,IAAI,GAAG,eAAe,GAClE;QACD,SAAS,EAAE,eAAe,CAAC;QAC3B,OAAO,EAAE,KAAK,EAAE,CAAC;QACjB,cAAc,EAAE,KAAK,EAAE,CAAC;KACzB;IA4BD;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI;IAe9C;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,IAAI,IAAI;CAI1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACrC,eAAe,SAAS,eAAe,EAEvC,KAAK,EAAE,eAAe,EACtB,QAAQ,EAAE,aAAa,CAAC,eAAe,CAAC,EACxC,gBAAgB,EAAE,MAAM,qBAAqB,CAAC,IAAI,CAAC,EACnD,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GACxC,MAAM,CAAC,MAAM,eAAe,EAAE,IAAI,CAAC,CAsCrC"}

package/dist/BaseController.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"BaseController.mjs","sourceRoot":"","sources":["../src/BaseController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAQA,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc;AAGhF,aAAa,EAAE,CAAC;AA6KhB;;GAEG;AACH,MAAM,OAAO,cAAc;IA4CzB;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,KAAK,GAqBN;QAlED;;WAEG;QACH,gDAAgC;QAOhC;;;;;WAKG;QACM,4CAIP;QA+CA,4EAA4E;QAC5E,kFAAkF;QAClF,uBAAA,IAAI,6BAAc,SAIjB,MAAA,CAAC;QACF,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,sEAAsE;QACtE,0EAA0E;QAC1E,iEAAiE;QACjE,yEAAyE;QACzE,uEAAuE;QACvE,uBAAA,IAAI,iCAAkB,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,MAAA,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,uBAAA,IAAI,iCAAW,CAAC,qBAAqB,CAAC,GAAG,IAAI,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE5E,uBAAA,IAAI,iCAAW,CAAC,2BAA2B,CAAC;YAC1C,SAAS,EAAE,GAAG,IAAI,cAAc;YAChC,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;SACnC,CAAC,CAAC;QACH,uBAAA,IAAI,iCAAW,CAAC,2BAA2B,CAAC;YAC1C,SAAS,EAAE,GAAG,IAAI,eAAe;YACjC,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;SACnC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,qCAAe,CAAC;IAC7B,CAAC;IAED,IAAI,KAAK,CAAC,CAAC;QACT,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACO,MAAM,CACd,QAAmE;QAMnE,8DAA8D;QAC9D,2BAA2B;QAC3B,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,cAAc,CAAC,GACxC,kBAID,CAAC,uBAAA,IAAI,qCAAe,EAAE,QAAQ,CAAC,CAAC;QAEjC,yEAAyE;QACzE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,uBAAA,IAAI,iCAAkB,SAAS,MAAA,CAAC;YAChC,uBAAA,IAAI,iCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,cAAuB,EACnC,SAAS,EACT,OAAO,CACR,CAAC;YACF,uBAAA,IAAI,iCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC,SAAS,EACT,OAAO,CACR,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACO,YAAY,CAAC,OAAgB;QACrC,MAAM,SAAS,GAAG,YAAY,CAAC,uBAAA,IAAI,qCAAe,EAAE,OAAO,CAAC,CAAC;QAC7D,uBAAA,IAAI,iCAAkB,SAAS,MAAA,CAAC;QAChC,uBAAA,IAAI,iCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,cAAuB,EACnC,SAAS,EACT,OAAO,CACR,CAAC;QACF,uBAAA,IAAI,iCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,eAAwB,EACpC,SAAS,EACT,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,OAAO;QACf,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,IAAI,cAAc,CAAC,CAAC;QACnE,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,IAAI,eAAe,CAAC,CAAC;IACtE,CAAC;CACF;;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,uBAAuB,CAGrC,KAAsB,EACtB,QAAwC,EACxC,gBAAmD,EACnD,gBAAyC;IAEzC,OAAQ,MAAM,CAAC,IAAI,CAAC,KAAK,CAA+B,CAAC,MAAM,CAE7D,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE;QACtB,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5D,CAAC;YACD,MAAM,gBAAgB,GAAG,aAAa,CAAC,gBAAgB,CAAC,CAAC;YACzD,MAAM,aAAa,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;gBAC3C,YAAY,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;YACtD,CAAC;iBAAM,IAAI,gBAAgB,EAAE,CAAC;gBAC5B,YAAY,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;YACpC,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,8DAA8D;YAC9D,2HAA2H;YAC3H,IAAI,gBAAgB,EAAE,CAAC;gBACrB,IAAI,CAAC;oBACH,gBAAgB,CACd,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAC1D,CAAC;gBACJ,CAAC;gBAAC,OAAO,qBAAqB,EAAE,CAAC;oBAC/B,OAAO,CAAC,KAAK,CACX,IAAI,KAAK,CAAC,8CAA8C,CAAC,EACzD,qBAAqB,CACtB,CAAC;oBACF,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,YAAY,CAAC;QACtB,CAAC;IACH,CAAC,EAAE,EAAW,CAAC,CAAC;AAClB,CAAC","sourcesContent":["import type {\n  ActionConstraint,\n  EventConstraint,\n  Messenger,\n  MessengerActions,\n  MessengerEvents,\n} from '@metamask/messenger';\nimport type { Json, PublicInterface } from '@metamask/utils';\nimport { enablePatches, produceWithPatches, applyPatches, freeze } from 'immer';\nimport type { Draft, Patch } from 'immer';\n\nenablePatches();\n\n/**\n * A type that constrains the state of all controllers.\n *\n * In other words, the narrowest supertype encompassing all controller state.\n */\nexport type StateConstraint = Record<string, Json>;\n\n/**\n * A state change listener.\n *\n * This function will get called for each state change, and is given a copy of\n * the new state along with a set of patches describing the changes since the\n * last update.\n *\n * @param state - The new controller state.\n * @param patches - A list of patches describing any changes (see here for more\n * information: https://immerjs.github.io/immer/docs/patches)\n */\nexport type StateChangeListener<Type> = (state: Type, patches: Patch[]) => void;\n\n/**\n * An function to derive state.\n *\n * This function will accept one piece of the controller state (one property),\n * and will return some derivation of that state.\n *\n * @param value - A piece of controller state.\n * @returns Something derived from controller state.\n */\nexport type StateDeriver<Type extends Json> = (value: Type) => Json;\n\n/**\n * State metadata.\n *\n * This metadata describes which parts of state should be persisted, and how to\n * get an anonymized representation of the state.\n */\nexport type StateMetadata<Type extends StateConstraint> = {\n  [Key in keyof Type]-?: StatePropertyMetadata<Type[Key]>;\n};\n\n/**\n * Metadata for a single state property\n */\nexport type StatePropertyMetadata<ControllerState extends Json> = {\n  /**\n   * Indicates whether this property should be included in debug snapshots attached to Sentry\n   * errors.\n   *\n   * Set this to false if the state may contain personally identifiable information, or if it's\n   * too large to include in a debug snapshot.\n   */\n  includeInDebugSnapshot: boolean | StateDeriver<ControllerState>;\n  /**\n   * Indicates whether this property should be included in state logs.\n   *\n   * Set this to false if the data should be kept hidden from support agents (e.g. if it contains\n   * secret keys, or personally-identifiable information that is not useful for debugging).\n   *\n   * We do allow state logs to contain some personally identifiable information to assist with\n   * diagnosing errors (e.g. transaction hashes, addresses), but we still attempt to limit the\n   * data we expose to what is most useful for helping users.\n   */\n  includeInStateLogs: boolean | StateDeriver<ControllerState>;\n  /**\n   * Indicates whether this property should be persisted.\n   *\n   * If true, the property will be persisted and saved between sessions.\n   * If false, the property will not be saved between sessions, and it will always be missing from the `state` constructor parameter.\n   */\n  persist: boolean | StateDeriver<ControllerState>;\n  /**\n   * Indicates whether this property is used by the UI.\n   *\n   * If true, the property will be accessible from the UI.\n   * If false, it will be inaccessible from the UI.\n   *\n   * Making a property accessible to the UI has a performance overhead, so it's better to set this\n   * to `false` if it's not used in the UI, especially for properties that can be large in size.\n   *\n   * Note that we disallow the use of a state derivation function here to preserve type information\n   * for the UI (the state deriver type always returns `Json`).\n   */\n  usedInUi: boolean;\n};\n\n/**\n * A universal supertype of `StateDeriver` types.\n * This type can be assigned to any `StateDeriver` type.\n */\nexport type StateDeriverConstraint = (value: never) => Json;\n\n/**\n * A universal supertype of `StatePropertyMetadata` types.\n * This type can be assigned to any `StatePropertyMetadata` type.\n */\nexport type StatePropertyMetadataConstraint = {\n  includeInDebugSnapshot: boolean | StateDeriverConstraint;\n  includeInStateLogs: boolean | StateDeriverConstraint;\n  persist: boolean | StateDeriverConstraint;\n  usedInUi: boolean;\n};\n\n/**\n * A universal supertype of `StateMetadata` types.\n * This type can be assigned to any `StateMetadata` type.\n */\nexport type StateMetadataConstraint = Record<\n  string,\n  StatePropertyMetadataConstraint\n>;\n\n/**\n * The widest subtype of all controller instances that inherit from `BaseController` (formerly `BaseControllerV2`).\n * Any `BaseController` subclass instance can be assigned to this type.\n */\nexport type BaseControllerInstance = Omit<\n  PublicInterface<\n    BaseController<\n      string,\n      StateConstraint,\n      // Use `any` to allow any parent to be set.\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      Messenger<string, ActionConstraint, EventConstraint, any>\n    >\n  >,\n  'metadata'\n> & {\n  metadata: StateMetadataConstraint;\n};\n\nexport type ControllerGetStateAction<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:getState`;\n  handler: () => ControllerState;\n};\n\n/**\n * @deprecated This event type is deprecated. Please use\n * `ControllerStateChangedEvent` instead.\n */\nexport type ControllerStateChangeEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:stateChange`;\n  payload: [ControllerState, Patch[]];\n};\n\nexport type ControllerStateChangedEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:stateChanged`;\n  payload: [ControllerState, Patch[]];\n};\n\nexport type ControllerActions<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = ControllerGetStateAction<ControllerName, ControllerState>;\n\nexport type ControllerEvents<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> =\n  | ControllerStateChangeEvent<ControllerName, ControllerState>\n  | ControllerStateChangedEvent<ControllerName, ControllerState>;\n\n/**\n * Controller class that provides state management, subscriptions, and state metadata\n */\nexport class BaseController<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n  ControllerMessenger extends Messenger<\n    ControllerName,\n    ActionConstraint,\n    EventConstraint,\n    // Use `any` to allow any parent to be set. `any` is harmless in a type constraint anyway,\n    // it's the one totally safe place to use it.\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    any\n  >,\n> {\n  /**\n   * The controller state.\n   */\n  #internalState: ControllerState;\n\n  /**\n   * The controller messenger. This is used to interact with other parts of the application.\n   */\n  protected messenger: ControllerMessenger;\n\n  /**\n   * The controller messenger.\n   *\n   * This is the same as the `messenger` property, but has a type that only lets us use\n   * actions and events that are part of the `BaseController` class.\n   */\n  readonly #messenger: Messenger<\n    ControllerName,\n    ControllerActions<ControllerName, ControllerState>,\n    ControllerEvents<ControllerName, ControllerState>\n  >;\n\n  /**\n   * The name of the controller.\n   *\n   * This is used by the ComposableController to construct a composed application state.\n   */\n  public readonly name: ControllerName;\n\n  public readonly metadata: StateMetadata<ControllerState>;\n\n  /**\n   * Creates a BaseController instance.\n   *\n   * @param options - Controller options.\n   * @param options.messenger - The controller messenger.\n   * @param options.metadata - ControllerState metadata, describing how to \"anonymize\" the state, and which\n   * parts should be persisted.\n   * @param options.name - The name of the controller, used as a namespace for events and actions.\n   * @param options.state - Initial controller state.\n   */\n  constructor({\n    messenger,\n    metadata,\n    name,\n    state,\n  }: {\n    messenger: ControllerActions<\n      ControllerName,\n      ControllerState\n    >['type'] extends MessengerActions<ControllerMessenger>['type']\n      ? ControllerStateChangeEvent<\n          ControllerName,\n          ControllerState\n        >['type'] extends MessengerEvents<ControllerMessenger>['type']\n        ? ControllerMessenger\n        : ControllerStateChangedEvent<\n              ControllerName,\n              ControllerState\n            >['type'] extends MessengerEvents<ControllerMessenger>['type']\n          ? ControllerMessenger\n          : never\n      : never;\n    metadata: StateMetadata<ControllerState>;\n    name: ControllerName;\n    state: ControllerState;\n  }) {\n    // The parameter type validates that the expected actions/events are present\n    // We don't have a way to validate the type property because the type is invariant\n    this.#messenger = messenger as unknown as Messenger<\n      ControllerName,\n      ControllerActions<ControllerName, ControllerState>,\n      ControllerEvents<ControllerName, ControllerState>\n    >;\n    this.messenger = messenger;\n    this.name = name;\n    // Here we use `freeze` from Immer to enforce that the state is deeply\n    // immutable. Note that this is a runtime check, not a compile-time check.\n    // That is, unlike `Object.freeze`, this does not narrow the type\n    // recursively to `Readonly`. The equivalent in Immer is `Immutable`, but\n    // `Immutable` does not handle recursive types such as our `Json` type.\n    this.#internalState = freeze(state, true);\n    this.metadata = metadata;\n\n    this.#messenger.registerActionHandler(`${name}:getState`, () => this.state);\n\n    this.#messenger.registerInitialEventPayload({\n      eventType: `${name}:stateChange`,\n      getPayload: () => [this.state, []],\n    });\n    this.#messenger.registerInitialEventPayload({\n      eventType: `${name}:stateChanged`,\n      getPayload: () => [this.state, []],\n    });\n  }\n\n  /**\n   * Retrieves current controller state.\n   *\n   * @returns The current state.\n   */\n  get state(): ControllerState {\n    return this.#internalState;\n  }\n\n  set state(_) {\n    throw new Error(\n      `Controller state cannot be directly mutated; use 'update' method instead.`,\n    );\n  }\n\n  /**\n   * Updates controller state. Accepts a callback that is passed a draft copy\n   * of the controller state. If a value is returned, it is set as the new\n   * state. Otherwise, any changes made within that callback to the draft are\n   * applied to the controller state.\n   *\n   * @param callback - Callback for updating state, passed a draft state\n   * object. Return a new state object or mutate the draft to update state.\n   * @returns An object that has the next state, patches applied in the update and inverse patches to\n   * rollback the update.\n   */\n  protected update(\n    callback: (state: Draft<ControllerState>) => void | ControllerState,\n  ): {\n    nextState: ControllerState;\n    patches: Patch[];\n    inversePatches: Patch[];\n  } {\n    // We run into ts2589, \"infinite type depth\", if we don't cast\n    // produceWithPatches here.\n    const [nextState, patches, inversePatches] = (\n      produceWithPatches as unknown as (\n        state: ControllerState,\n        callbackFn: typeof callback,\n      ) => [ControllerState, Patch[], Patch[]]\n    )(this.#internalState, callback);\n\n    // Protect against unnecessary state updates when there is no state diff.\n    if (patches.length > 0) {\n      this.#internalState = nextState;\n      this.#messenger.publish(\n        `${this.name}:stateChange` as const,\n        nextState,\n        patches,\n      );\n      this.#messenger.publish(\n        `${this.name}:stateChanged` as const,\n        nextState,\n        patches,\n      );\n    }\n\n    return { nextState, patches, inversePatches };\n  }\n\n  /**\n   * Applies immer patches to the current state. The patches come from the\n   * update function itself and can either be normal or inverse patches.\n   *\n   * @param patches - An array of immer patches that are to be applied to make\n   * or undo changes.\n   */\n  protected applyPatches(patches: Patch[]): void {\n    const nextState = applyPatches(this.#internalState, patches);\n    this.#internalState = nextState;\n    this.#messenger.publish(\n      `${this.name}:stateChange` as const,\n      nextState,\n      patches,\n    );\n    this.#messenger.publish(\n      `${this.name}:stateChanged` as const,\n      nextState,\n      patches,\n    );\n  }\n\n  /**\n   * Prepares the controller for garbage collection. This should be extended\n   * by any subclasses to clean up any additional connections or events.\n   *\n   * The only cleanup performed here is to remove listeners. While technically\n   * this is not required to ensure this instance is garbage collected, it at\n   * least ensures this instance won't be responsible for preventing the\n   * listeners from being garbage collected.\n   */\n  protected destroy(): void {\n    this.messenger.clearEventSubscriptions(`${this.name}:stateChange`);\n    this.messenger.clearEventSubscriptions(`${this.name}:stateChanged`);\n  }\n}\n\n/**\n * Use the metadata to derive state according to the given metadata property.\n *\n * @param state - The full controller state.\n * @param metadata - The controller metadata.\n * @param metadataProperty - The metadata property to use to derive state.\n * @param captureException - Reports an error to an error monitoring service.\n * @returns The metadata-derived controller state.\n */\nexport function deriveStateFromMetadata<\n  ControllerState extends StateConstraint,\n>(\n  state: ControllerState,\n  metadata: StateMetadata<ControllerState>,\n  metadataProperty: keyof StatePropertyMetadata<Json>,\n  captureException?: (error: Error) => void,\n): Record<keyof ControllerState, Json> {\n  return (Object.keys(state) as (keyof ControllerState)[]).reduce<\n    Record<keyof ControllerState, Json>\n  >((derivedState, key) => {\n    try {\n      const stateMetadata = metadata[key];\n      if (!stateMetadata) {\n        throw new Error(`No metadata found for '${String(key)}'`);\n      }\n      const propertyMetadata = stateMetadata[metadataProperty];\n      const stateProperty = state[key];\n      if (typeof propertyMetadata === 'function') {\n        derivedState[key] = propertyMetadata(stateProperty);\n      } else if (propertyMetadata) {\n        derivedState[key] = stateProperty;\n      }\n      return derivedState;\n    } catch (error) {\n      // Capture error without interrupting state-related operations\n      // See [ADR core#0016](https://github.com/MetaMask/decisions/blob/main/decisions/core/0016-core-classes-error-reporting.md)\n      if (captureException) {\n        try {\n          captureException(\n            error instanceof Error ? error : new Error(String(error)),\n          );\n        } catch (captureExceptionError) {\n          console.error(\n            new Error(`Error thrown when calling 'captureException'`),\n            captureExceptionError,\n          );\n          console.error(error);\n        }\n      } else {\n        console.error(error);\n      }\n      return derivedState;\n    }\n  }, {} as never);\n}\n"]}

package/dist/index.cjs

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deriveStateFromMetadata = exports.BaseController = void 0;
-var BaseController_js_1 = require("./BaseController.cjs");
-Object.defineProperty(exports, "BaseController", { enumerable: true, get: function () { return BaseController_js_1.BaseController; } });
-Object.defineProperty(exports, "deriveStateFromMetadata", { enumerable: true, get: function () { return BaseController_js_1.deriveStateFromMetadata; } });
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAcA,0DAA8E;AAArE,mHAAA,cAAc,OAAA;AAAE,4HAAA,uBAAuB,OAAA","sourcesContent":["export type {\n  BaseControllerInstance,\n  StateChangeListener,\n  StateConstraint,\n  StateDeriver,\n  StateDeriverConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  StatePropertyMetadata,\n  StatePropertyMetadataConstraint,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  ControllerStateChangedEvent,\n} from './BaseController.js';\nexport { BaseController, deriveStateFromMetadata } from './BaseController.js';\n"]}

package/dist/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,sBAAsB,EACtB,mBAAmB,EACnB,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,GAC5B,6BAA4B;AAC7B,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,6BAA4B"}

package/dist/index.d.mts

@@ -1,3 +0,0 @@
-export type { BaseControllerInstance, StateChangeListener, StateConstraint, StateDeriver, StateDeriverConstraint, StateMetadata, StateMetadataConstraint, StatePropertyMetadata, StatePropertyMetadataConstraint, ControllerGetStateAction, ControllerStateChangeEvent, ControllerStateChangedEvent, } from "./BaseController.mjs";
-export { BaseController, deriveStateFromMetadata } from "./BaseController.mjs";
-//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,sBAAsB,EACtB,mBAAmB,EACnB,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,GAC5B,6BAA4B;AAC7B,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,6BAA4B"}

package/dist/index.mjs

@@ -1,2 +0,0 @@
-export { BaseController, deriveStateFromMetadata } from "./BaseController.mjs";
-//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,6BAA4B","sourcesContent":["export type {\n  BaseControllerInstance,\n  StateChangeListener,\n  StateConstraint,\n  StateDeriver,\n  StateDeriverConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  StatePropertyMetadata,\n  StatePropertyMetadataConstraint,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  ControllerStateChangedEvent,\n} from './BaseController.js';\nexport { BaseController, deriveStateFromMetadata } from './BaseController.js';\n"]}