@metamask-previews/base-controller 4.1.1-preview.dad68d4 → 4.1.1-preview.eb2135e

package/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add and export type `StateConstraint`, which is an alias for `Record<string, Json>`, and represents the narrowest supertype encompassing the state of all controllers.
+
+### Changed
+
+- **BREAKING:** Narrow the generic constraint of the `ControllerState` parameter from `Record<string, unknown>` to `Record<string, Json>` for types `ControllerGetStateAction`, `ControllerStateChangeEvent`, `ControllerActions`, `ControllerEvents`.
+- **BREAKING:** Narrow the return type of the function `deriveStateFromMetadata<ControllerState>` from `Record<string, Json>` to `Record<keyof ControllerState, Json>`.
+- **BREAKING:** The `getRestricted` method of the `ControllerMessenger` class has major API changes that may require updates to its existing instances in downstream code. These changes align the type-level and runtime behavior of `getRestricted`, so that omitted or empty inputs consistently represent a set of empty allowlists. ([$4013](https://github.com/MetaMask/core/pull/4013))
+  - If the `AllowedActions`, `AllowedEvents` generic parameters are omitted, they are always assumed to be `never`.
+    - Previously, omission of these generic parameters resulted in the full allowlists for the controller being inferred as type constraints for the `allowedActions`, `allowedEvents` function parameters.
+  - If the function parameters `allowedActions`, `allowedEvents` are a non-empty array, their corresponding type names must be explicitly passed into generic parameters `AllowedActions`, `AllowedEvents` to avoid type errors.
+    - This may cause some duplication of allowlists between type-level and value-level code.
+    - This requirement is only relevant for TypeScript code. A JavaScript consumer only needs to pass in the correct value-level function parameters. Because of this, these changes should not affect downstream JavaScript code, but may be disruptive to TypeScript code.
+    - `getRestricted` is still able to flag `AllowedActions` and `AllowedEvents` members that should not be included in the allowlists, based on the `Action`, `Event` generic arguments passed into the `ControllerMessenger` instance.
+- **BREAKING:** The `RestrictedControllerMessenger` class constructor now expects `allowedActions` and `allowedEvents` as required options. ([$4013](https://github.com/MetaMask/core/pull/4013))
+- Convert interface `StatePropertyMetadata<T extends Json>` into a type.
+
+### Removed
+
+- **BREAKING:** Remove the deprecated `subscribe` class field from `BaseControllerV2`.
+
 ## [4.1.1]
 
 ### Changed

package/dist/BaseControllerV1.js

@@ -1,152 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseControllerV1 = void 0;
-/**
- * @deprecated This class has been renamed to BaseControllerV1 and is no longer recommended for use for controllers. Please use BaseController (formerly BaseControllerV2) instead.
- *
- * 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 BaseControllerV1 {
-    /**
-     * Creates a BaseControllerV1 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, value] of Object.entries(this.internalConfig)) {
-                if (value !== undefined) {
-                    // TODO: Replace `any` with type
-                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                    this[key] = value;
-                }
-            }
-        }
-        else {
-            for (const key of Object.keys(config)) {
-                /* istanbul ignore else */
-                if (typeof this.internalConfig[key] !== 'undefined') {
-                    this.internalConfig[key] = config[key];
-                    // TODO: Replace `any` with type
-                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                    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.BaseControllerV1 = BaseControllerV1;
-exports.default = BaseControllerV1;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkNINOM2XQjs = require('./chunk-NINOM2XQ.js');
+require('./chunk-Z4BLTVTB.js');
+
+
+
+exports.BaseControllerV1 = _chunkNINOM2XQjs.BaseControllerV1; exports.default = _chunkNINOM2XQjs.BaseControllerV1_default;
 //# sourceMappingURL=BaseControllerV1.js.map

package/dist/BaseControllerV1.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseControllerV1.js","sourceRoot":"","sources":["../src/BaseControllerV1.ts"],"names":[],"mappings":";;;AA+BA;;;;;;;;GAQG;AACH,MAAa,gBAAgB;IA+B3B;;;;;;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,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE;gBAC9D,IAAI,KAAK,KAAK,SAAS,EAAE;oBACvB,gCAAgC;oBAChC,8DAA8D;oBAC7D,IAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;iBAC5B;aACF;SACF;aAAM;YACL,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAgB,EAAE;gBACpD,0BAA0B;gBAC1B,IAAI,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBACnD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAI,MAAY,CAAC,GAAG,CAAC,CAAC;oBAC9C,gCAAgC;oBAChC,8DAA8D;oBAC7D,IAAY,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;iBAClC;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;AA5JD,4CA4JC;AAED,kBAAe,gBAAgB,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 */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\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 */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface BaseState {\n  name?: string;\n}\n\n/**\n * @deprecated This class has been renamed to BaseControllerV1 and is no longer recommended for use for controllers. Please use BaseController (formerly BaseControllerV2) instead.\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 BaseControllerV1<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 BaseControllerV1 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, value] of Object.entries(this.internalConfig)) {\n        if (value !== undefined) {\n          // TODO: Replace `any` with type\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          (this as any)[key] = value;\n        }\n      }\n    } else {\n      for (const key of Object.keys(config) as (keyof C)[]) {\n        /* istanbul ignore else */\n        if (typeof this.internalConfig[key] !== 'undefined') {\n          this.internalConfig[key] = (config as C)[key];\n          // TODO: Replace `any` with type\n          // eslint-disable-next-line @typescript-eslint/no-explicit-any\n          (this as any)[key] = 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 BaseControllerV1;\n"]}
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/BaseControllerV1.mjs

@@ -0,0 +1,10 @@
+import {
+  BaseControllerV1,
+  BaseControllerV1_default
+} from "./chunk-NZOIZH6C.mjs";
+import "./chunk-XUI43LEZ.mjs";
+export {
+  BaseControllerV1,
+  BaseControllerV1_default as default
+};
+//# sourceMappingURL=BaseControllerV1.mjs.map

package/dist/BaseControllerV1.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/BaseControllerV2.js

@@ -1,162 +1,12 @@
-"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;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPersistentState = exports.getAnonymizedState = 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 - Controller messaging system.
-     * @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, }) {
-        _BaseController_internalState.set(this, void 0);
-        this.messagingSystem = messenger;
-        this.name = name;
-        __classPrivateFieldSet(this, _BaseController_internalState, state, "f");
-        this.metadata = metadata;
-        this.messagingSystem.registerActionHandler(`${name}:getState`, () => this.state);
-        this.messagingSystem.registerInitialEventPayload({
-            eventType: `${name}:stateChange`,
-            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);
-        __classPrivateFieldSet(this, _BaseController_internalState, nextState, "f");
-        this.messagingSystem.publish(`${this.name}:stateChange`, 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");
-        this.messagingSystem.publish(`${this.name}:stateChange`, 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.messagingSystem.clearEventSubscriptions(`${this.name}:stateChange`);
-    }
-}
-exports.BaseController = BaseController;
-_BaseController_internalState = new WeakMap();
-/**
- * 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.
- */
-function getAnonymizedState(state, metadata) {
-    return deriveStateFromMetadata(state, metadata, 'anonymous');
-}
-exports.getAnonymizedState = getAnonymizedState;
-/**
- * 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.
- */
-function getPersistentState(state, metadata) {
-    return deriveStateFromMetadata(state, metadata, 'persist');
-}
-exports.getPersistentState = getPersistentState;
-/**
- * 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.
- * @returns The metadata-derived controller state.
- */
-function deriveStateFromMetadata(state, metadata, metadataProperty) {
-    return Object.keys(state).reduce((persistedState, 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') {
-                persistedState[key] = propertyMetadata(stateProperty);
-            }
-            else if (propertyMetadata) {
-                persistedState[key] = stateProperty;
-            }
-            return persistedState;
-        }
-        catch (error) {
-            // Throw error after timeout so that it is captured as a console error
-            // (and by Sentry) without interrupting state-related operations
-            setTimeout(() => {
-                throw error;
-            });
-            return persistedState;
-        }
-    }, {});
-}
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+var _chunkCRIROOT2js = require('./chunk-CRIROOT2.js');
+require('./chunk-Z4BLTVTB.js');
+
+
+
+
+exports.BaseController = _chunkCRIROOT2js.BaseController; exports.getAnonymizedState = _chunkCRIROOT2js.getAnonymizedState; exports.getPersistentState = _chunkCRIROOT2js.getPersistentState;
 //# sourceMappingURL=BaseControllerV2.js.map

package/dist/BaseControllerV2.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseControllerV2.js","sourceRoot":"","sources":["../src/BaseControllerV2.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,iCAAwE;AAMxE,IAAA,qBAAa,GAAE,CAAC;AAiFhB;;GAEG;AACH,MAAa,cAAc;IAmCzB;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,KAAK,GAMN;QA5CD,gDAAgC;QA6C9B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,uBAAA,IAAI,iCAAkB,KAAK,MAAA,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,CAAC,eAAe,CAAC,qBAAqB,CACxC,GAAG,IAAI,WAAW,EAClB,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CACjB,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,2BAA2B,CAAC;YAC/C,SAAS,EAAE,GAAG,IAAI,cAAc;YAChC,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,uBAAA,IAAI,iCAAkB,SAAS,MAAA,CAAC;QAChC,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,IAAI,CAAC,IAAI,cAAc,EAC1B,SAAS,EACT,OAAO,CACR,CAAC;QAEF,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,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,IAAI,CAAC,IAAI,cAAc,EAC1B,SAAS,EACT,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,OAAO;QACf,IAAI,CAAC,eAAe,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,IAAI,cAAc,CAAC,CAAC;IAC3E,CAAC;CACF;AAzJD,wCAyJC;;AAED;;;;;;;;;;GAUG;AACH,SAAgB,kBAAkB,CAGhC,KAAsB,EACtB,QAAwC;IAExC,OAAO,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;AAC/D,CAAC;AAPD,gDAOC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAGhC,KAAsB,EACtB,QAAwC;IAExC,OAAO,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;AAC7D,CAAC;AAPD,gDAOC;AAED;;;;;;;GAOG;AACH,SAAS,uBAAuB,CAC9B,KAAsB,EACtB,QAAwC,EACxC,gBAAyC;IAEzC,OAAQ,MAAM,CAAC,IAAI,CAAC,KAAK,CAA+B,CAAC,MAAM,CAE7D,CAAC,cAAc,EAAE,GAAG,EAAE,EAAE;QACxB,IAAI;YACF,MAAM,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,CAAC,aAAa,EAAE;gBAClB,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;aAC3D;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;gBAC1C,cAAc,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;aACvD;iBAAM,IAAI,gBAAgB,EAAE;gBAC3B,cAAc,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;aACrC;YACD,OAAO,cAAc,CAAC;SACvB;QAAC,OAAO,KAAK,EAAE;YACd,sEAAsE;YACtE,gEAAgE;YAChE,UAAU,CAAC,GAAG,EAAE;gBACd,MAAM,KAAK,CAAC;YACd,CAAC,CAAC,CAAC;YACH,OAAO,cAAc,CAAC;SACvB;IACH,CAAC,EAAE,EAAE,CAAwC,CAAC;AAChD,CAAC","sourcesContent":["import type { Json } from '@metamask/utils';\nimport { enablePatches, produceWithPatches, applyPatches } from 'immer';\nimport type { Draft, Patch } from 'immer';\n\nimport type { ActionConstraint, EventConstraint } from './ControllerMessenger';\nimport type { RestrictedControllerMessenger } from './RestrictedControllerMessenger';\n\nenablePatches();\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 Listener<T> = (state: T, 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<T extends Json> = (value: T) => 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<T extends Record<string, Json>> = {\n  [P in keyof T]: StatePropertyMetadata<T[P]>;\n};\n\n/**\n * Metadata for a single state property\n *\n * @property persist - Indicates whether this property should be persisted\n * (`true` for persistent, `false` for transient), or is set to a function\n * that derives the persistent state from the state.\n * @property anonymous - Indicates whether this property is already anonymous,\n * (`true` for anonymous, `false` if it has potential to be personally\n * identifiable), or is set to a function that returns an anonymized\n * representation of this state.\n */\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface StatePropertyMetadata<T extends Json> {\n  persist: boolean | StateDeriver<T>;\n  anonymous: boolean | StateDeriver<T>;\n}\n\nexport type ControllerGetStateAction<\n  ControllerName extends string,\n  ControllerState extends Record<string, unknown>,\n> = {\n  type: `${ControllerName}:getState`;\n  handler: () => ControllerState;\n};\n\nexport type ControllerStateChangeEvent<\n  ControllerName extends string,\n  ControllerState extends Record<string, unknown>,\n> = {\n  type: `${ControllerName}:stateChange`;\n  payload: [ControllerState, Patch[]];\n};\n\nexport type ControllerActions<\n  ControllerName extends string,\n  ControllerState extends Record<string, unknown>,\n> = ControllerGetStateAction<ControllerName, ControllerState>;\n\nexport type ControllerEvents<\n  ControllerName extends string,\n  ControllerState extends Record<string, unknown>,\n> = ControllerStateChangeEvent<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 Record<string, Json>,\n  messenger extends RestrictedControllerMessenger<\n    ControllerName,\n    ActionConstraint | ControllerActions<ControllerName, ControllerState>,\n    EventConstraint | ControllerEvents<ControllerName, ControllerState>,\n    string,\n    string\n  >,\n> {\n  #internalState: ControllerState;\n\n  protected messagingSystem: messenger;\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   * The existence of the `subscribe` property is how the ComposableController used to detect\n   * whether a controller extends the old BaseController or the new one. We set it to `undefined` here to\n   * ensure the ComposableController never mistakes them for an older style controller.\n   *\n   * This property is no longer used, and will be removed in a future release.\n   *\n   * @deprecated This will be removed in a future release\n   */\n  public readonly subscribe: undefined;\n\n  /**\n   * Creates a BaseController instance.\n   *\n   * @param options - Controller options.\n   * @param options.messenger - Controller messaging system.\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: messenger;\n    metadata: StateMetadata<ControllerState>;\n    name: ControllerName;\n    state: ControllerState;\n  }) {\n    this.messagingSystem = messenger;\n    this.name = name;\n    this.#internalState = state;\n    this.metadata = metadata;\n\n    this.messagingSystem.registerActionHandler(\n      `${name}:getState`,\n      () => this.state,\n    );\n\n    this.messagingSystem.registerInitialEventPayload({\n      eventType: `${name}:stateChange`,\n      getPayload: () => [this.state, []],\n    });\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  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        cb: typeof callback,\n      ) => [ControllerState, Patch[], Patch[]]\n    )(this.#internalState, callback);\n\n    this.#internalState = nextState;\n    this.messagingSystem.publish(\n      `${this.name}:stateChange`,\n      nextState,\n      patches,\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[]) {\n    const nextState = applyPatches(this.#internalState, patches);\n    this.#internalState = nextState;\n    this.messagingSystem.publish(\n      `${this.name}:stateChange`,\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() {\n    this.messagingSystem.clearEventSubscriptions(`${this.name}:stateChange`);\n  }\n}\n\n/**\n * Returns an anonymized representation of the controller state.\n *\n * By \"anonymized\" we mean that it should not contain any information that could be personally\n * identifiable.\n *\n * @param state - The controller state.\n * @param metadata - The controller state metadata, which describes how to derive the\n * anonymized state.\n * @returns The anonymized controller state.\n */\nexport function getAnonymizedState<\n  ControllerState extends Record<string, Json>,\n>(\n  state: ControllerState,\n  metadata: StateMetadata<ControllerState>,\n): Record<string, Json> {\n  return deriveStateFromMetadata(state, metadata, 'anonymous');\n}\n\n/**\n * Returns the subset of state that should be persisted.\n *\n * @param state - The controller state.\n * @param metadata - The controller state metadata, which describes which pieces of state should be persisted.\n * @returns The subset of controller state that should be persisted.\n */\nexport function getPersistentState<\n  ControllerState extends Record<string, Json>,\n>(\n  state: ControllerState,\n  metadata: StateMetadata<ControllerState>,\n): Record<string, Json> {\n  return deriveStateFromMetadata(state, metadata, 'persist');\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 * @returns The metadata-derived controller state.\n */\nfunction deriveStateFromMetadata<ControllerState extends Record<string, Json>>(\n  state: ControllerState,\n  metadata: StateMetadata<ControllerState>,\n  metadataProperty: 'anonymous' | 'persist',\n): Record<string, Json> {\n  return (Object.keys(state) as (keyof ControllerState)[]).reduce<\n    Partial<Record<keyof ControllerState, Json>>\n  >((persistedState, 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        persistedState[key] = propertyMetadata(stateProperty);\n      } else if (propertyMetadata) {\n        persistedState[key] = stateProperty;\n      }\n      return persistedState;\n    } catch (error) {\n      // Throw error after timeout so that it is captured as a console error\n      // (and by Sentry) without interrupting state-related operations\n      setTimeout(() => {\n        throw error;\n      });\n      return persistedState;\n    }\n  }, {}) as Record<keyof ControllerState, Json>;\n}\n"]}
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/BaseControllerV2.mjs

@@ -0,0 +1,12 @@
+import {
+  BaseController,
+  getAnonymizedState,
+  getPersistentState
+} from "./chunk-U2WUIHS7.mjs";
+import "./chunk-XUI43LEZ.mjs";
+export {
+  BaseController,
+  getAnonymizedState,
+  getPersistentState
+};
+//# sourceMappingURL=BaseControllerV2.mjs.map

package/dist/BaseControllerV2.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}