@metamask-previews/base-controller 3.2.0-preview.3dbf14f

package/CHANGELOG.md

@@ -0,0 +1,72 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [3.2.0]
+### Changed
+- When deriving state, skip properties with invalid metadata  ([#1529](https://github.com/MetaMask/core/pull/1529))
+  - The previous behavior was to throw an error
+  - An error is thrown in a timeout handler so that it can still be captured in the console, and by global unhandled error handlers.
+- Update `@metamask/utils` to `^6.2.0` ([#1514](https://github.com/MetaMask/core/pull/1514))
+
+## [3.1.0]
+### Changed
+- Prevent event publish from throwing error ([#1475](https://github.com/MetaMask/core/pull/1475))
+  - The controller messenger will no longer throw when an event subscriber throws an error. Calls to `publish` (either within controllers or on a messenger instance directly) will no longer throw errors.
+  - Errors are thrown in a timeout handler so that they can still be logged and captured.
+
+## [3.0.0]
+### Changed
+- **BREAKING:** Bump to Node 16 ([#1262](https://github.com/MetaMask/core/pull/1262))
+- Replace `@metamask/controller-utils` dependency with `@metamask/utils` ([#1370](https://github.com/MetaMask/core/pull/1370))
+
+## [2.0.0]
+### Removed
+- **BREAKING:** Remove `isomorphic-fetch` ([#1106](https://github.com/MetaMask/controllers/pull/1106))
+  - Consumers must now import `isomorphic-fetch` or another polyfill themselves if they are running in an environment without `fetch`
+
+## [1.1.2]
+### Changed
+- Rename this repository to `core` ([#1031](https://github.com/MetaMask/controllers/pull/1031))
+- Update `@metamask/controller-utils` package ([#1041](https://github.com/MetaMask/controllers/pull/1041)) 
+
+## [1.1.1]
+### Changed
+- Relax dependency on `@metamask/controller-utils` (use `^` instead of `~`) ([#998](https://github.com/MetaMask/core/pull/998))
+
+## [1.1.0]
+### Added
+- Add `applyPatches` function to BaseControllerV2 ([#980](https://github.com/MetaMask/core/pull/980))
+
+### Changed
+- Action and event handler types are now exported ([#987](https://github.com/MetaMask/core/pull/987))
+- Update `update` function to expose patches ([#980](https://github.com/MetaMask/core/pull/980))
+
+## [1.0.0]
+### Added
+- Initial release
+  - As a result of converting our shared controllers repo into a monorepo ([#831](https://github.com/MetaMask/core/pull/831)), we've created this package from select parts of [`@metamask/controllers` v33.0.0](https://github.com/MetaMask/core/tree/v33.0.0), namely:
+    - `src/BaseController.ts`
+    - `src/BaseController.test.ts`
+    - `src/BaseControllerV2.ts`
+    - `src/BaseControllerV2.test.ts`
+    - `src/ComposableController.ts`
+    - `src/ComposableController.test.ts`
+    - `src/ControllerMessenger.ts`
+    - `src/ControllerMessenger.test.ts`
+
+    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@3.2.0...HEAD
+[3.2.0]: https://github.com/MetaMask/core/compare/@metamask/base-controller@3.1.0...@metamask/base-controller@3.2.0
+[3.1.0]: https://github.com/MetaMask/core/compare/@metamask/base-controller@3.0.0...@metamask/base-controller@3.1.0
+[3.0.0]: https://github.com/MetaMask/core/compare/@metamask/base-controller@2.0.0...@metamask/base-controller@3.0.0
+[2.0.0]: https://github.com/MetaMask/core/compare/@metamask/base-controller@1.1.2...@metamask/base-controller@2.0.0
+[1.1.2]: https://github.com/MetaMask/core/compare/@metamask/base-controller@1.1.1...@metamask/base-controller@1.1.2
+[1.1.1]: https://github.com/MetaMask/core/compare/@metamask/base-controller@1.1.0...@metamask/base-controller@1.1.1
+[1.1.0]: https://github.com/MetaMask/core/compare/@metamask/base-controller@1.0.0...@metamask/base-controller@1.1.0
+[1.0.0]: https://github.com/MetaMask/core/releases/tag/@metamask/base-controller@1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2018 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/base-controller`
+
+Provides scaffolding for controllers as well a communication system for all controllers.
+
+## Installation
+
+`yarn add @metamask/base-controller`
+
+or
+
+`npm install @metamask/base-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/BaseController.d.ts

@@ -0,0 +1,114 @@
+/**
+ * State change callbacks
+ */
+export declare type Listener<T> = (state: T) => void;
+/**
+ * @type BaseConfig
+ *
+ * Base controller configuration
+ * @property disabled - Determines if this controller is enabled
+ */
+export interface BaseConfig {
+    disabled?: boolean;
+}
+/**
+ * @type BaseState
+ *
+ * Base state representation
+ * @property name - Unique name for this controller
+ */
+export interface BaseState {
+    name?: string;
+}
+/**
+ * Controller class that provides configuration, state management, and subscriptions.
+ *
+ * The core purpose of every controller is to maintain an internal data object
+ * called "state". Each controller is responsible for its own state, and all global wallet state
+ * is tracked in a controller as state.
+ */
+export declare class BaseController<C extends BaseConfig, S extends BaseState> {
+    /**
+     * Default options used to configure this controller
+     */
+    defaultConfig: C;
+    /**
+     * Default state set on this controller
+     */
+    defaultState: S;
+    /**
+     * Determines if listeners are notified of state changes
+     */
+    disabled: boolean;
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
+    private readonly initialConfig;
+    private readonly initialState;
+    private internalConfig;
+    private internalState;
+    private readonly internalListeners;
+    /**
+     * Creates a BaseController instance. Both initial state and initial
+     * configuration options are merged with defaults upon initialization.
+     *
+     * @param config - Initial options used to configure this controller.
+     * @param state - Initial state to set on this controller.
+     */
+    constructor(config?: Partial<C>, state?: Partial<S>);
+    /**
+     * Enables the controller. This sets each config option as a member
+     * variable on this instance and triggers any defined setters. This
+     * also sets initial state and triggers any listeners.
+     *
+     * @returns This controller instance.
+     */
+    protected initialize(): this;
+    /**
+     * Retrieves current controller configuration options.
+     *
+     * @returns The current configuration.
+     */
+    get config(): C;
+    /**
+     * Retrieves current controller state.
+     *
+     * @returns The current state.
+     */
+    get state(): S;
+    /**
+     * Updates controller configuration.
+     *
+     * @param config - New configuration options.
+     * @param overwrite - Overwrite config instead of merging.
+     * @param fullUpdate - Boolean that defines if the update is partial or not.
+     */
+    configure(config: Partial<C>, overwrite?: boolean, fullUpdate?: boolean): void;
+    /**
+     * Notifies all subscribed listeners of current state.
+     */
+    notify(): void;
+    /**
+     * Adds new listener to be notified of state changes.
+     *
+     * @param listener - The callback triggered when state changes.
+     */
+    subscribe(listener: Listener<S>): void;
+    /**
+     * Removes existing listener from receiving state changes.
+     *
+     * @param listener - The callback to remove.
+     * @returns `true` if a listener is found and unsubscribed.
+     */
+    unsubscribe(listener: Listener<S>): boolean;
+    /**
+     * Updates controller state.
+     *
+     * @param state - The new state.
+     * @param overwrite - Overwrite state instead of merging.
+     */
+    update(state: Partial<S>, overwrite?: boolean): void;
+}
+export default BaseController;
+//# 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;;GAEG;AACH,oBAAY,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,qBAAa,cAAc,CAAC,CAAC,SAAS,UAAU,EAAE,CAAC,SAAS,SAAS;IACnE;;OAEG;IACH,aAAa,EAAE,CAAC,CAAW;IAE3B;;OAEG;IACH,YAAY,EAAE,CAAC,CAAW;IAE1B;;OAEG;IACH,QAAQ,UAAS;IAEjB;;OAEG;IACH,IAAI,SAAoB;IAExB,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAI;IAElC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAI;IAEjC,OAAO,CAAC,cAAc,CAAyB;IAE/C,OAAO,CAAC,aAAa,CAAwB;IAE7C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAqB;IAEvD;;;;;;OAMG;gBACS,MAAM,GAAE,OAAO,CAAC,CAAC,CAAW,EAAE,KAAK,GAAE,OAAO,CAAC,CAAC,CAAW;IAMrE;;;;;;OAMG;IACH,SAAS,CAAC,UAAU;IAQpB;;;;OAIG;IACH,IAAI,MAAM,MAET;IAED;;;;OAIG;IACH,IAAI,KAAK,MAER;IAED;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,UAAQ,EAAE,UAAU,UAAO;IAsBlE;;OAEG;IACH,MAAM;IAUN;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;IAI/B;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;IAMjC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,UAAQ;CAM5C;AAED,eAAe,cAAc,CAAC"}

package/dist/BaseController.js

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseController = void 0;
+/**
+ * Controller class that provides configuration, state management, and subscriptions.
+ *
+ * The core purpose of every controller is to maintain an internal data object
+ * called "state". Each controller is responsible for its own state, and all global wallet state
+ * is tracked in a controller as state.
+ */
+class BaseController {
+    /**
+     * Creates a BaseController instance. Both initial state and initial
+     * configuration options are merged with defaults upon initialization.
+     *
+     * @param config - Initial options used to configure this controller.
+     * @param state - Initial state to set on this controller.
+     */
+    constructor(config = {}, state = {}) {
+        /**
+         * Default options used to configure this controller
+         */
+        this.defaultConfig = {};
+        /**
+         * Default state set on this controller
+         */
+        this.defaultState = {};
+        /**
+         * Determines if listeners are notified of state changes
+         */
+        this.disabled = false;
+        /**
+         * Name of this controller used during composition
+         */
+        this.name = 'BaseController';
+        this.internalConfig = this.defaultConfig;
+        this.internalState = this.defaultState;
+        this.internalListeners = [];
+        // Use assign since generics can't be spread: https://git.io/vpRhY
+        this.initialState = state;
+        this.initialConfig = config;
+    }
+    /**
+     * Enables the controller. This sets each config option as a member
+     * variable on this instance and triggers any defined setters. This
+     * also sets initial state and triggers any listeners.
+     *
+     * @returns This controller instance.
+     */
+    initialize() {
+        this.internalState = this.defaultState;
+        this.internalConfig = this.defaultConfig;
+        this.configure(this.initialConfig);
+        this.update(this.initialState);
+        return this;
+    }
+    /**
+     * Retrieves current controller configuration options.
+     *
+     * @returns The current configuration.
+     */
+    get config() {
+        return this.internalConfig;
+    }
+    /**
+     * Retrieves current controller state.
+     *
+     * @returns The current state.
+     */
+    get state() {
+        return this.internalState;
+    }
+    /**
+     * Updates controller configuration.
+     *
+     * @param config - New configuration options.
+     * @param overwrite - Overwrite config instead of merging.
+     * @param fullUpdate - Boolean that defines if the update is partial or not.
+     */
+    configure(config, overwrite = false, fullUpdate = true) {
+        if (fullUpdate) {
+            this.internalConfig = overwrite
+                ? config
+                : Object.assign(this.internalConfig, config);
+            for (const key in this.internalConfig) {
+                if (typeof this.internalConfig[key] !== 'undefined') {
+                    this[key] = this.internalConfig[key];
+                }
+            }
+        }
+        else {
+            for (const key in config) {
+                /* istanbul ignore else */
+                if (typeof this.internalConfig[key] !== 'undefined') {
+                    this.internalConfig[key] = config[key];
+                    this[key] = config[key];
+                }
+            }
+        }
+    }
+    /**
+     * Notifies all subscribed listeners of current state.
+     */
+    notify() {
+        if (this.disabled) {
+            return;
+        }
+        this.internalListeners.forEach((listener) => {
+            listener(this.internalState);
+        });
+    }
+    /**
+     * Adds new listener to be notified of state changes.
+     *
+     * @param listener - The callback triggered when state changes.
+     */
+    subscribe(listener) {
+        this.internalListeners.push(listener);
+    }
+    /**
+     * Removes existing listener from receiving state changes.
+     *
+     * @param listener - The callback to remove.
+     * @returns `true` if a listener is found and unsubscribed.
+     */
+    unsubscribe(listener) {
+        const index = this.internalListeners.findIndex((cb) => listener === cb);
+        index > -1 && this.internalListeners.splice(index, 1);
+        return index > -1;
+    }
+    /**
+     * Updates controller state.
+     *
+     * @param state - The new state.
+     * @param overwrite - Overwrite state instead of merging.
+     */
+    update(state, overwrite = false) {
+        this.internalState = overwrite
+            ? Object.assign({}, state)
+            : Object.assign({}, this.internalState, state);
+        this.notify();
+    }
+}
+exports.BaseController = BaseController;
+exports.default = BaseController;
+//# sourceMappingURL=BaseController.js.map

package/dist/BaseController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseController.js","sourceRoot":"","sources":["../src/BaseController.ts"],"names":[],"mappings":";;;AAyBA;;;;;;GAMG;AACH,MAAa,cAAc;IA+BzB;;;;;;OAMG;IACH,YAAY,SAAqB,EAAO,EAAE,QAAoB,EAAO;QArCrE;;WAEG;QACH,kBAAa,GAAM,EAAO,CAAC;QAE3B;;WAEG;QACH,iBAAY,GAAM,EAAO,CAAC;QAE1B;;WAEG;QACH,aAAQ,GAAG,KAAK,CAAC;QAEjB;;WAEG;QACH,SAAI,GAAG,gBAAgB,CAAC;QAMhB,mBAAc,GAAM,IAAI,CAAC,aAAa,CAAC;QAEvC,kBAAa,GAAM,IAAI,CAAC,YAAY,CAAC;QAE5B,sBAAiB,GAAkB,EAAE,CAAC;QAUrD,kEAAkE;QAClE,IAAI,CAAC,YAAY,GAAG,KAAU,CAAC;QAC/B,IAAI,CAAC,aAAa,GAAG,MAAW,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACO,UAAU;QAClB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,MAAkB,EAAE,SAAS,GAAG,KAAK,EAAE,UAAU,GAAG,IAAI;QAChE,IAAI,UAAU,EAAE;YACd,IAAI,CAAC,cAAc,GAAG,SAAS;gBAC7B,CAAC,CAAE,MAAY;gBACf,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;YAE/C,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,cAAc,EAAE;gBACrC,IAAI,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBAClD,IAAY,CAAC,GAAa,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;iBACzD;aACF;SACF;aAAM;YACL,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,0BAA0B;gBAC1B,IAAI,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBACnD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAQ,CAAC;oBAC7C,IAAY,CAAC,GAAa,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;iBAC5C;aACF;SACF;IACH,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,OAAO;SACR;QAED,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC1C,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAqB;QAC7B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,QAAqB;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAC;QACxE,KAAK,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACtD,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAiB,EAAE,SAAS,GAAG,KAAK;QACzC,IAAI,CAAC,aAAa,GAAG,SAAS;YAC5B,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,KAAU,CAAC;YAC/B,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;CACF;AAxJD,wCAwJC;AAED,kBAAe,cAAc,CAAC","sourcesContent":["/**\n * State change callbacks\n */\nexport type Listener<T> = (state: T) => void;\n\n/**\n * @type BaseConfig\n *\n * Base controller configuration\n * @property disabled - Determines if this controller is enabled\n */\nexport interface BaseConfig {\n  disabled?: boolean;\n}\n\n/**\n * @type BaseState\n *\n * Base state representation\n * @property name - Unique name for this controller\n */\nexport interface BaseState {\n  name?: string;\n}\n\n/**\n * Controller class that provides configuration, state management, and subscriptions.\n *\n * The core purpose of every controller is to maintain an internal data object\n * called \"state\". Each controller is responsible for its own state, and all global wallet state\n * is tracked in a controller as state.\n */\nexport class BaseController<C extends BaseConfig, S extends BaseState> {\n  /**\n   * Default options used to configure this controller\n   */\n  defaultConfig: C = {} as C;\n\n  /**\n   * Default state set on this controller\n   */\n  defaultState: S = {} as S;\n\n  /**\n   * Determines if listeners are notified of state changes\n   */\n  disabled = false;\n\n  /**\n   * Name of this controller used during composition\n   */\n  name = 'BaseController';\n\n  private readonly initialConfig: C;\n\n  private readonly initialState: S;\n\n  private internalConfig: C = this.defaultConfig;\n\n  private internalState: S = this.defaultState;\n\n  private readonly internalListeners: Listener<S>[] = [];\n\n  /**\n   * Creates a BaseController instance. Both initial state and initial\n   * configuration options are merged with defaults upon initialization.\n   *\n   * @param config - Initial options used to configure this controller.\n   * @param state - Initial state to set on this controller.\n   */\n  constructor(config: Partial<C> = {} as C, state: Partial<S> = {} as S) {\n    // Use assign since generics can't be spread: https://git.io/vpRhY\n    this.initialState = state as S;\n    this.initialConfig = config as C;\n  }\n\n  /**\n   * Enables the controller. This sets each config option as a member\n   * variable on this instance and triggers any defined setters. This\n   * also sets initial state and triggers any listeners.\n   *\n   * @returns This controller instance.\n   */\n  protected initialize() {\n    this.internalState = this.defaultState;\n    this.internalConfig = this.defaultConfig;\n    this.configure(this.initialConfig);\n    this.update(this.initialState);\n    return this;\n  }\n\n  /**\n   * Retrieves current controller configuration options.\n   *\n   * @returns The current configuration.\n   */\n  get config() {\n    return this.internalConfig;\n  }\n\n  /**\n   * Retrieves current controller state.\n   *\n   * @returns The current state.\n   */\n  get state() {\n    return this.internalState;\n  }\n\n  /**\n   * Updates controller configuration.\n   *\n   * @param config - New configuration options.\n   * @param overwrite - Overwrite config instead of merging.\n   * @param fullUpdate - Boolean that defines if the update is partial or not.\n   */\n  configure(config: Partial<C>, overwrite = false, fullUpdate = true) {\n    if (fullUpdate) {\n      this.internalConfig = overwrite\n        ? (config as C)\n        : Object.assign(this.internalConfig, config);\n\n      for (const key in this.internalConfig) {\n        if (typeof this.internalConfig[key] !== 'undefined') {\n          (this as any)[key as string] = this.internalConfig[key];\n        }\n      }\n    } else {\n      for (const key in config) {\n        /* istanbul ignore else */\n        if (typeof this.internalConfig[key] !== 'undefined') {\n          this.internalConfig[key] = config[key] as any;\n          (this as any)[key as string] = config[key];\n        }\n      }\n    }\n  }\n\n  /**\n   * Notifies all subscribed listeners of current state.\n   */\n  notify() {\n    if (this.disabled) {\n      return;\n    }\n\n    this.internalListeners.forEach((listener) => {\n      listener(this.internalState);\n    });\n  }\n\n  /**\n   * Adds new listener to be notified of state changes.\n   *\n   * @param listener - The callback triggered when state changes.\n   */\n  subscribe(listener: Listener<S>) {\n    this.internalListeners.push(listener);\n  }\n\n  /**\n   * Removes existing listener from receiving state changes.\n   *\n   * @param listener - The callback to remove.\n   * @returns `true` if a listener is found and unsubscribed.\n   */\n  unsubscribe(listener: Listener<S>) {\n    const index = this.internalListeners.findIndex((cb) => listener === cb);\n    index > -1 && this.internalListeners.splice(index, 1);\n    return index > -1;\n  }\n\n  /**\n   * Updates controller state.\n   *\n   * @param state - The new state.\n   * @param overwrite - Overwrite state instead of merging.\n   */\n  update(state: Partial<S>, overwrite = false) {\n    this.internalState = overwrite\n      ? Object.assign({}, state as S)\n      : Object.assign({}, this.internalState, state);\n    this.notify();\n  }\n}\n\nexport default BaseController;\n"]}

package/dist/BaseControllerV2.d.ts

@@ -0,0 +1,147 @@
+import type { Json } from '@metamask/utils';
+import type { Draft, Patch } from 'immer';
+import type { RestrictedControllerMessenger } from './ControllerMessenger';
+/**
+ * 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 declare type Listener<T> = (state: T, 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 declare type StateDeriver<T extends Json> = (value: T) => Json;
+/**
+ * State metadata.
+ *
+ * This metadata describes which parts of state should be persisted, and how to
+ * get an anonymized representation of the state.
+ */
+export declare type StateMetadata<T extends Record<string, Json>> = {
+    [P in keyof T]: StatePropertyMetadata<T[P]>;
+};
+/**
+ * Metadata for a single state property
+ *
+ * @property persist - Indicates whether this property should be persisted
+ * (`true` for persistent, `false` for transient), or is set to a function
+ * that derives the persistent state from the state.
+ * @property anonymous - Indicates whether this property is already anonymous,
+ * (`true` for anonymous, `false` if it has potential to be personally
+ * identifiable), or is set to a function that returns an anonymized
+ * representation of this state.
+ */
+export interface StatePropertyMetadata<T extends Json> {
+    persist: boolean | StateDeriver<T>;
+    anonymous: boolean | StateDeriver<T>;
+}
+/**
+ * Controller class that provides state management, subscriptions, and state metadata
+ */
+export declare class BaseController<N extends string, S extends Record<string, Json>, messenger extends RestrictedControllerMessenger<N, any, any, string, string>> {
+    private internalState;
+    protected messagingSystem: messenger;
+    /**
+     * The name of the controller.
+     *
+     * This is used by the ComposableController to construct a composed application state.
+     */
+    readonly name: N;
+    readonly metadata: StateMetadata<S>;
+    /**
+     * The existence of the `subscribe` property is how the ComposableController detects whether a
+     * controller extends the old BaseController or the new one. We set it to `undefined` here to
+     * ensure the ComposableController never mistakes them for an older style controller.
+     */
+    readonly subscribe: undefined;
+    /**
+     * Creates a BaseController instance.
+     *
+     * @param options - Controller options.
+     * @param options.messenger - Controller messaging system.
+     * @param options.metadata - State 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: messenger;
+        metadata: StateMetadata<S>;
+        name: N;
+        state: S;
+    });
+    /**
+     * Retrieves current controller state.
+     *
+     * @returns The current state.
+     */
+    get state(): S;
+    set state(_: S);
+    /**
+     * 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<S>) => void | S): {
+        nextState: S;
+        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;
+}
+/**
+ * Returns an anonymized representation of the controller state.
+ *
+ * By "anonymized" we mean that it should not contain any information that could be personally
+ * identifiable.
+ *
+ * @param state - The controller state.
+ * @param metadata - The controller state metadata, which describes how to derive the
+ * anonymized state.
+ * @returns The anonymized controller state.
+ */
+export declare function getAnonymizedState<S extends Record<string, Json>>(state: S, metadata: StateMetadata<S>): Record<string, Json>;
+/**
+ * Returns the subset of state that should be persisted.
+ *
+ * @param state - The controller state.
+ * @param metadata - The controller state metadata, which describes which pieces of state should be persisted.
+ * @returns The subset of controller state that should be persisted.
+ */
+export declare function getPersistentState<S extends Record<string, Json>>(state: S, metadata: StateMetadata<S>): Record<string, Json>;
+//# sourceMappingURL=BaseControllerV2.d.ts.map

package/dist/BaseControllerV2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseControllerV2.d.ts","sourceRoot":"","sources":["../src/BaseControllerV2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,KAAK,EACV,6BAA6B,EAE9B,MAAM,uBAAuB,CAAC;AAI/B;;;;;;;;;;GAUG;AACH,oBAAY,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,IAAI,CAAC;AAE/D;;;;;;;;GAQG;AACH,oBAAY,YAAY,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AAE9D;;;;;GAKG;AACH,oBAAY,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI;KACzD,CAAC,IAAI,MAAM,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,IAAI;IACnD,OAAO,EAAE,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;IACnC,SAAS,EAAE,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,qBAAa,cAAc,CACzB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,SAAS,SAAS,6BAA6B,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC;IAE5E,OAAO,CAAC,aAAa,CAAI;IAEzB,SAAS,CAAC,eAAe,EAAE,SAAS,CAAC;IAErC;;;;OAIG;IACH,SAAgB,IAAI,EAAE,CAAC,CAAC;IAExB,SAAgB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAE3C;;;;OAIG;IACH,SAAgB,SAAS,EAAE,SAAS,CAAC;IAErC;;;;;;;;;OASG;gBACS,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,KAAK,GACN,EAAE;QACD,SAAS,EAAE,SAAS,CAAC;QACrB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,EAAE,CAAC,CAAC;QACR,KAAK,EAAE,CAAC,CAAC;KACV;IAYD;;;;OAIG;IACH,IAAI,KAAK,MAER;IAED,IAAI,KAAK,CAAC,CAAC,GAAA,EAIV;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,GAAG;QACzD,SAAS,EAAE,CAAC,CAAC;QACb,OAAO,EAAE,KAAK,EAAE,CAAC;QACjB,cAAc,EAAE,KAAK,EAAE,CAAC;KACzB;IAoBD;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,EAAE;IAUvC;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO;CAKlB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAC/D,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GACzB,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAEtB;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,EAC/D,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GACzB,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAEtB"}