@metamask-previews/base-controller 8.4.2-preview-9fa15fd0 → 9.0.0-preview-46d2c977

package/dist/BaseController.mjs

@@ -9,25 +9,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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;
+var _BaseController_internalState, _BaseController_messenger;
 import { enablePatches, produceWithPatches, applyPatches, freeze } from "immer";
 enablePatches();
-/**
- * Determines if the given controller is an instance of `BaseController`
- *
- * @param controller - Controller instance to check
- * @returns True if the controller is an instance of `BaseController`
- */
-export function isBaseController(controller) {
-    return (typeof controller === 'object' &&
-        controller !== null &&
-        'name' in controller &&
-        typeof controller.name === 'string' &&
-        'state' in controller &&
-        typeof controller.state === 'object' &&
-        'metadata' in controller &&
-        typeof controller.metadata === 'object');
-}
 /**
  * Controller class that provides state management, subscriptions, and state metadata
  */
@@ -36,15 +20,28 @@ export class BaseController {
      * Creates a BaseController instance.
      *
      * @param options - Controller options.
-     * @param options.messenger - Controller messaging system.
+     * @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);
-        this.messagingSystem = 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.
+         */
+        _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.
@@ -53,8 +50,8 @@ export class BaseController {
         // `Immutable` does not handle recursive types such as our `Json` type.
         __classPrivateFieldSet(this, _BaseController_internalState, freeze(state, true), "f");
         this.metadata = metadata;
-        this.messagingSystem.registerActionHandler(`${name}:getState`, () => this.state);
-        this.messagingSystem.registerInitialEventPayload({
+        __classPrivateFieldGet(this, _BaseController_messenger, "f").registerActionHandler(`${name}:getState`, () => this.state);
+        __classPrivateFieldGet(this, _BaseController_messenger, "f").registerInitialEventPayload({
             eventType: `${name}:stateChange`,
             getPayload: () => [this.state, []],
         });
@@ -88,7 +85,7 @@ export class BaseController {
         // Protect against unnecessary state updates when there is no state diff.
         if (patches.length > 0) {
             __classPrivateFieldSet(this, _BaseController_internalState, nextState, "f");
-            this.messagingSystem.publish(`${this.name}:stateChange`, nextState, patches);
+            __classPrivateFieldGet(this, _BaseController_messenger, "f").publish(`${this.name}:stateChange`, nextState, patches);
         }
         return { nextState, patches, inversePatches };
     }
@@ -102,7 +99,7 @@ export class BaseController {
     applyPatches(patches) {
         const nextState = applyPatches(__classPrivateFieldGet(this, _BaseController_internalState, "f"), patches);
         __classPrivateFieldSet(this, _BaseController_internalState, nextState, "f");
-        this.messagingSystem.publish(`${this.name}:stateChange`, nextState, patches);
+        __classPrivateFieldGet(this, _BaseController_messenger, "f").publish(`${this.name}:stateChange`, nextState, patches);
     }
     /**
      * Prepares the controller for garbage collection. This should be extended
@@ -114,38 +111,10 @@ export class BaseController {
      * listeners from being garbage collected.
      */
     destroy() {
-        this.messagingSystem.clearEventSubscriptions(`${this.name}:stateChange`);
+        this.messenger.clearEventSubscriptions(`${this.name}:stateChange`);
     }
 }
-_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.
- *
- * @deprecated Use `deriveStateFromMetadata` instead.
- * @param state - The controller state.
- * @param metadata - The controller state metadata, which describes how to derive the
- * anonymized state.
- * @param captureException - Reports an error to an error monitoring service.
- * @returns The anonymized controller state.
- */
-export function getAnonymizedState(state, metadata, captureException) {
-    return deriveStateFromMetadata(state, metadata, 'anonymous', captureException);
-}
-/**
- * Returns the subset of state that should be persisted.
- *
- * @deprecated Use `deriveStateFromMetadata` instead.
- * @param state - The controller state.
- * @param metadata - The controller state metadata, which describes which pieces of state should be persisted.
- * @param captureException - Reports an error to an error monitoring service.
- * @returns The subset of controller state that should be persisted.
- */
-export function getPersistentState(state, metadata, captureException) {
-    return deriveStateFromMetadata(state, metadata, 'persist', captureException);
-}
+_BaseController_internalState = new WeakMap(), _BaseController_messenger = new WeakMap();
 /**
  * Use the metadata to derive state according to the given metadata property.
  *

package/dist/BaseController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"BaseController.mjs","sourceRoot":"","sources":["../src/BaseController.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc;AAShF,aAAa,EAAE,CAAC;AAEhB;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,UAAmB;IAEnB,OAAO,CACL,OAAO,UAAU,KAAK,QAAQ;QAC9B,UAAU,KAAK,IAAI;QACnB,MAAM,IAAI,UAAU;QACpB,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ;QACnC,OAAO,IAAI,UAAU;QACrB,OAAO,UAAU,CAAC,KAAK,KAAK,QAAQ;QACpC,UAAU,IAAI,UAAU;QACxB,OAAO,UAAU,CAAC,QAAQ,KAAK,QAAQ,CACxC,CAAC;AACJ,CAAC;AA+JD;;GAEG;AACH,MAAM,OAAO,cAAc;IA0BzB;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,KAAK,GAMN;QAjCD,gDAAgC;QAkC9B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACjC,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,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,kBAID,CAAC,uBAAA,IAAI,qCAAe,EAAE,QAAQ,CAAC,CAAC;QAEjC,yEAAyE;QACzE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,uBAAA,IAAI,iCAAkB,SAAS,MAAA,CAAC;YAChC,IAAI,CAAC,eAAe,CAAC,OAAO,CAC1B,GAAG,IAAI,CAAC,IAAI,cAAc,EAC1B,SAAS,EACT,OAAO,CACR,CAAC;SACH;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,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;;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAChC,KAAsB,EACtB,QAAwC,EACxC,gBAAyC;IAEzC,OAAO,uBAAuB,CAC5B,KAAK,EACL,QAAQ,EACR,WAAW,EACX,gBAAgB,CACjB,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAChC,KAAsB,EACtB,QAAwC,EACxC,gBAAyC;IAEzC,OAAO,uBAAuB,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,gBAAgB,CAAC,CAAC;AAC/E,CAAC;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;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,YAAY,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;aACrD;iBAAM,IAAI,gBAAgB,EAAE;gBAC3B,YAAY,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;aACnC;YACD,OAAO,YAAY,CAAC;SACrB;QAAC,OAAO,KAAK,EAAE;YACd,8DAA8D;YAC9D,2HAA2H;YAC3H,IAAI,gBAAgB,EAAE;gBACpB,IAAI;oBACF,gBAAgB,CACd,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAC1D,CAAC;iBACH;gBAAC,OAAO,qBAAqB,EAAE;oBAC9B,OAAO,CAAC,KAAK,CACX,IAAI,KAAK,CAAC,8CAA8C,CAAC,EACzD,qBAAqB,CACtB,CAAC;oBACF,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBACtB;aACF;iBAAM;gBACL,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACtB;YACD,OAAO,YAAY,CAAC;SACrB;IACH,CAAC,EAAE,EAAW,CAAC,CAAC;AAClB,CAAC","sourcesContent":["import type { Json, PublicInterface } from '@metamask/utils';\nimport { enablePatches, produceWithPatches, applyPatches, freeze } from 'immer';\nimport type { Draft, Patch } from 'immer';\n\nimport type { ActionConstraint, EventConstraint } from './Messenger';\nimport type {\n  RestrictedMessenger,\n  RestrictedMessengerConstraint,\n} from './RestrictedMessenger';\n\nenablePatches();\n\n/**\n * Determines if the given controller is an instance of `BaseController`\n *\n * @param controller - Controller instance to check\n * @returns True if the controller is an instance of `BaseController`\n */\nexport function isBaseController(\n  controller: unknown,\n): controller is BaseControllerInstance {\n  return (\n    typeof controller === 'object' &&\n    controller !== null &&\n    'name' in controller &&\n    typeof controller.name === 'string' &&\n    'state' in controller &&\n    typeof controller.state === 'object' &&\n    'metadata' in controller &&\n    typeof controller.metadata === 'object'\n  );\n}\n\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 */\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\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 */\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\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 */\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport type StateMetadata<T extends StateConstraint> = {\n  [P in keyof T]-?: StatePropertyMetadata<T[P]>;\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  anonymous: 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  anonymous: 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<string, StateConstraint, RestrictedMessengerConstraint>\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\nexport type ControllerStateChangeEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:stateChange`;\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> = 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 StateConstraint,\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  messenger extends RestrictedMessenger<\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   * 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    // 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.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    // Protect against unnecessary state updates when there is no state diff.\n    if (patches.length > 0) {\n      this.#internalState = nextState;\n      this.messagingSystem.publish(\n        `${this.name}:stateChange`,\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[]) {\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 * @deprecated Use `deriveStateFromMetadata` instead.\n * @param state - The controller state.\n * @param metadata - The controller state metadata, which describes how to derive the\n * anonymized state.\n * @param captureException - Reports an error to an error monitoring service.\n * @returns The anonymized controller state.\n */\nexport function getAnonymizedState<ControllerState extends StateConstraint>(\n  state: ControllerState,\n  metadata: StateMetadata<ControllerState>,\n  captureException?: (error: Error) => void,\n): Record<keyof ControllerState, Json> {\n  return deriveStateFromMetadata(\n    state,\n    metadata,\n    'anonymous',\n    captureException,\n  );\n}\n\n/**\n * Returns the subset of state that should be persisted.\n *\n * @deprecated Use `deriveStateFromMetadata` instead.\n * @param state - The controller state.\n * @param metadata - The controller state metadata, which describes which pieces of state should be persisted.\n * @param captureException - Reports an error to an error monitoring service.\n * @returns The subset of controller state that should be persisted.\n */\nexport function getPersistentState<ControllerState extends StateConstraint>(\n  state: ControllerState,\n  metadata: StateMetadata<ControllerState>,\n  captureException?: (error: Error) => void,\n): Record<keyof ControllerState, Json> {\n  return deriveStateFromMetadata(state, metadata, 'persist', captureException);\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"]}
+{"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;AAmKhB;;GAEG;AACH,MAAM,OAAO,cAAc;IA4CzB;;;;;;;;;OASG;IACH,YAAY,EACV,SAAS,EACT,QAAQ,EACR,IAAI,EACJ,KAAK,GAgBN;QA7DD;;WAEG;QACH,gDAAgC;QAOhC;;;;;WAKG;QACM,4CAIP;QA0CA,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;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;YACtB,uBAAA,IAAI,iCAAkB,SAAS,MAAA,CAAC;YAChC,uBAAA,IAAI,iCAAW,CAAC,OAAO,CACrB,GAAG,IAAI,CAAC,IAAI,cAAuB,EACnC,SAAS,EACT,OAAO,CACR,CAAC;SACH;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;IACJ,CAAC;IAED;;;;;;;;OAQG;IACO,OAAO;QACf,IAAI,CAAC,SAAS,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,IAAI,cAAc,CAAC,CAAC;IACrE,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;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,YAAY,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;aACrD;iBAAM,IAAI,gBAAgB,EAAE;gBAC3B,YAAY,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;aACnC;YACD,OAAO,YAAY,CAAC;SACrB;QAAC,OAAO,KAAK,EAAE;YACd,8DAA8D;YAC9D,2HAA2H;YAC3H,IAAI,gBAAgB,EAAE;gBACpB,IAAI;oBACF,gBAAgB,CACd,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAC1D,CAAC;iBACH;gBAAC,OAAO,qBAAqB,EAAE;oBAC9B,OAAO,CAAC,KAAK,CACX,IAAI,KAAK,CAAC,8CAA8C,CAAC,EACzD,qBAAqB,CACtB,CAAC;oBACF,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBACtB;aACF;iBAAM;gBACL,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;aACtB;YACD,OAAO,YAAY,CAAC;SACrB;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<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 */\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\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 */\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport type StateMetadata<T extends StateConstraint> = {\n  [P in keyof T]-?: StatePropertyMetadata<T[P]>;\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\nexport type ControllerStateChangeEvent<\n  ControllerName extends string,\n  ControllerState extends StateConstraint,\n> = {\n  type: `${ControllerName}:stateChange`;\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> = 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 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      ? ControllerEvents<\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  }\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    // 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    }\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.#messenger.publish(\n      `${this.name}:stateChange` 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() {\n    this.messenger.clearEventSubscriptions(`${this.name}:stateChange`);\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,14 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RestrictedMessenger = exports.Messenger = exports.isBaseController = exports.getPersistentState = exports.getAnonymizedState = exports.deriveStateFromMetadata = exports.BaseController = void 0;
+exports.deriveStateFromMetadata = exports.BaseController = void 0;
 var BaseController_1 = require("./BaseController.cjs");
 Object.defineProperty(exports, "BaseController", { enumerable: true, get: function () { return BaseController_1.BaseController; } });
 Object.defineProperty(exports, "deriveStateFromMetadata", { enumerable: true, get: function () { return BaseController_1.deriveStateFromMetadata; } });
-Object.defineProperty(exports, "getAnonymizedState", { enumerable: true, get: function () { return BaseController_1.getAnonymizedState; } });
-Object.defineProperty(exports, "getPersistentState", { enumerable: true, get: function () { return BaseController_1.getPersistentState; } });
-Object.defineProperty(exports, "isBaseController", { enumerable: true, get: function () { return BaseController_1.isBaseController; } });
-var Messenger_1 = require("./Messenger.cjs");
-Object.defineProperty(exports, "Messenger", { enumerable: true, get: function () { return Messenger_1.Messenger; } });
-var RestrictedMessenger_1 = require("./RestrictedMessenger.cjs");
-Object.defineProperty(exports, "RestrictedMessenger", { enumerable: true, get: function () { return RestrictedMessenger_1.RestrictedMessenger; } });
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAaA,uDAM0B;AALxB,gHAAA,cAAc,OAAA;AACd,yHAAA,uBAAuB,OAAA;AACvB,oHAAA,kBAAkB,OAAA;AAClB,oHAAA,kBAAkB,OAAA;AAClB,kHAAA,gBAAgB,OAAA;AAgBlB,6CAAwC;AAA/B,sGAAA,SAAS,OAAA;AAElB,iEAA4D;AAAnD,0HAAA,mBAAmB,OAAA","sourcesContent":["export type {\n  BaseControllerInstance,\n  Listener as ListenerV2,\n  StateConstraint,\n  StateDeriver,\n  StateDeriverConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  StatePropertyMetadata,\n  StatePropertyMetadataConstraint,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from './BaseController';\nexport {\n  BaseController,\n  deriveStateFromMetadata,\n  getAnonymizedState,\n  getPersistentState,\n  isBaseController,\n} from './BaseController';\nexport type {\n  ActionHandler,\n  ExtractActionParameters,\n  ExtractActionResponse,\n  ExtractEventHandler,\n  ExtractEventPayload,\n  GenericEventHandler,\n  SelectorFunction,\n  ActionConstraint,\n  EventConstraint,\n  NamespacedBy,\n  NotNamespacedBy,\n  NamespacedName,\n} from './Messenger';\nexport { Messenger } from './Messenger';\nexport type { RestrictedMessengerConstraint } from './RestrictedMessenger';\nexport { RestrictedMessenger } from './RestrictedMessenger';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAaA,uDAA2E;AAAlE,gHAAA,cAAc,OAAA;AAAE,yHAAA,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} from './BaseController';\nexport { BaseController, deriveStateFromMetadata } from './BaseController';\n"]}

package/dist/index.d.cts

@@ -1,7 +1,3 @@
-export type { BaseControllerInstance, Listener as ListenerV2, StateConstraint, StateDeriver, StateDeriverConstraint, StateMetadata, StateMetadataConstraint, StatePropertyMetadata, StatePropertyMetadataConstraint, ControllerGetStateAction, ControllerStateChangeEvent, } from "./BaseController.cjs";
-export { BaseController, deriveStateFromMetadata, getAnonymizedState, getPersistentState, isBaseController, } from "./BaseController.cjs";
-export type { ActionHandler, ExtractActionParameters, ExtractActionResponse, ExtractEventHandler, ExtractEventPayload, GenericEventHandler, SelectorFunction, ActionConstraint, EventConstraint, NamespacedBy, NotNamespacedBy, NamespacedName, } from "./Messenger.cjs";
-export { Messenger } from "./Messenger.cjs";
-export type { RestrictedMessengerConstraint } from "./RestrictedMessenger.cjs";
-export { RestrictedMessenger } from "./RestrictedMessenger.cjs";
+export type { BaseControllerInstance, StateChangeListener, StateConstraint, StateDeriver, StateDeriverConstraint, StateMetadata, StateMetadataConstraint, StatePropertyMetadata, StatePropertyMetadataConstraint, ControllerGetStateAction, ControllerStateChangeEvent, } from "./BaseController.cjs";
+export { BaseController, deriveStateFromMetadata } from "./BaseController.cjs";
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,sBAAsB,EACtB,QAAQ,IAAI,UAAU,EACtB,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,GAC3B,6BAAyB;AAC1B,OAAO,EACL,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,GACjB,6BAAyB;AAC1B,YAAY,EACV,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,eAAe,EACf,cAAc,GACf,wBAAoB;AACrB,OAAO,EAAE,SAAS,EAAE,wBAAoB;AACxC,YAAY,EAAE,6BAA6B,EAAE,kCAA8B;AAC3E,OAAO,EAAE,mBAAmB,EAAE,kCAA8B"}
+{"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,GAC3B,6BAAyB;AAC1B,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,6BAAyB"}

package/dist/index.d.mts

@@ -1,7 +1,3 @@
-export type { BaseControllerInstance, Listener as ListenerV2, StateConstraint, StateDeriver, StateDeriverConstraint, StateMetadata, StateMetadataConstraint, StatePropertyMetadata, StatePropertyMetadataConstraint, ControllerGetStateAction, ControllerStateChangeEvent, } from "./BaseController.mjs";
-export { BaseController, deriveStateFromMetadata, getAnonymizedState, getPersistentState, isBaseController, } from "./BaseController.mjs";
-export type { ActionHandler, ExtractActionParameters, ExtractActionResponse, ExtractEventHandler, ExtractEventPayload, GenericEventHandler, SelectorFunction, ActionConstraint, EventConstraint, NamespacedBy, NotNamespacedBy, NamespacedName, } from "./Messenger.mjs";
-export { Messenger } from "./Messenger.mjs";
-export type { RestrictedMessengerConstraint } from "./RestrictedMessenger.mjs";
-export { RestrictedMessenger } from "./RestrictedMessenger.mjs";
+export type { BaseControllerInstance, StateChangeListener, StateConstraint, StateDeriver, StateDeriverConstraint, StateMetadata, StateMetadataConstraint, StatePropertyMetadata, StatePropertyMetadataConstraint, ControllerGetStateAction, ControllerStateChangeEvent, } from "./BaseController.mjs";
+export { BaseController, deriveStateFromMetadata } from "./BaseController.mjs";
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,sBAAsB,EACtB,QAAQ,IAAI,UAAU,EACtB,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,GAC3B,6BAAyB;AAC1B,OAAO,EACL,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,GACjB,6BAAyB;AAC1B,YAAY,EACV,aAAa,EACb,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,eAAe,EACf,cAAc,GACf,wBAAoB;AACrB,OAAO,EAAE,SAAS,EAAE,wBAAoB;AACxC,YAAY,EAAE,6BAA6B,EAAE,kCAA8B;AAC3E,OAAO,EAAE,mBAAmB,EAAE,kCAA8B"}
+{"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,GAC3B,6BAAyB;AAC1B,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,6BAAyB"}

package/dist/index.mjs

@@ -1,4 +1,2 @@
-export { BaseController, deriveStateFromMetadata, getAnonymizedState, getPersistentState, isBaseController } from "./BaseController.mjs";
-export { Messenger } from "./Messenger.mjs";
-export { RestrictedMessenger } from "./RestrictedMessenger.mjs";
+export { BaseController, deriveStateFromMetadata } from "./BaseController.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,OAAO,EACL,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EACjB,6BAAyB;AAe1B,OAAO,EAAE,SAAS,EAAE,wBAAoB;AAExC,OAAO,EAAE,mBAAmB,EAAE,kCAA8B","sourcesContent":["export type {\n  BaseControllerInstance,\n  Listener as ListenerV2,\n  StateConstraint,\n  StateDeriver,\n  StateDeriverConstraint,\n  StateMetadata,\n  StateMetadataConstraint,\n  StatePropertyMetadata,\n  StatePropertyMetadataConstraint,\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n} from './BaseController';\nexport {\n  BaseController,\n  deriveStateFromMetadata,\n  getAnonymizedState,\n  getPersistentState,\n  isBaseController,\n} from './BaseController';\nexport type {\n  ActionHandler,\n  ExtractActionParameters,\n  ExtractActionResponse,\n  ExtractEventHandler,\n  ExtractEventPayload,\n  GenericEventHandler,\n  SelectorFunction,\n  ActionConstraint,\n  EventConstraint,\n  NamespacedBy,\n  NotNamespacedBy,\n  NamespacedName,\n} from './Messenger';\nexport { Messenger } from './Messenger';\nexport type { RestrictedMessengerConstraint } from './RestrictedMessenger';\nexport { RestrictedMessenger } from './RestrictedMessenger';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,6BAAyB","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} from './BaseController';\nexport { BaseController, deriveStateFromMetadata } from './BaseController';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/base-controller",
-  "version": "8.4.2-preview-9fa15fd0",
+  "version": "9.0.0-preview-46d2c977",
   "description": "Provides scaffolding for controllers as well a communication system for all controllers",
   "keywords": [
     "MetaMask",
@@ -26,24 +26,12 @@
         "default": "./dist/index.cjs"
       }
     },
-    "./next": {
-      "import": {
-        "types": "./dist/next/index.d.mts",
-        "default": "./dist/next/index.mjs"
-      },
-      "require": {
-        "types": "./dist/next/index.d.cts",
-        "default": "./dist/next/index.cjs"
-      }
-    },
     "./package.json": "./package.json"
   },
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.cts",
   "files": [
-    "dist/",
-    "next.js",
-    "next.d.ts"
+    "dist/"
   ],
   "scripts": {
     "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",

package/dist/Messenger.cjs

@@ -1,279 +0,0 @@
-"use strict";
-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 _Messenger_actions, _Messenger_events, _Messenger_initialEventPayloadGetters, _Messenger_eventPayloadCache;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Messenger = void 0;
-const RestrictedMessenger_1 = require("./RestrictedMessenger.cjs");
-/**
- * A message broker for "actions" and "events".
- *
- * The messenger allows registering functions as 'actions' that can be called elsewhere,
- * and it allows publishing and subscribing to events. Both actions and events are identified by
- * unique strings.
- *
- * @template Action - A type union of all Action types.
- * @template Event - A type union of all Event types.
- */
-class Messenger {
-    constructor() {
-        _Messenger_actions.set(this, new Map());
-        _Messenger_events.set(this, new Map());
-        /**
-         * A map of functions for getting the initial event payload.
-         *
-         * Used only for events that represent state changes.
-         */
-        _Messenger_initialEventPayloadGetters.set(this, new Map());
-        /**
-         * A cache of selector return values for their respective handlers.
-         */
-        _Messenger_eventPayloadCache.set(this, new Map());
-    }
-    /**
-     * Register an action handler.
-     *
-     * This will make the registered function available to call via the `call` method.
-     *
-     * @param actionType - The action type. This is a unique identifier for this action.
-     * @param handler - The action handler. This function gets called when the `call` method is
-     * invoked with the given action type.
-     * @throws Will throw when a handler has been registered for this action type already.
-     * @template ActionType - A type union of Action type strings.
-     */
-    registerActionHandler(actionType, handler) {
-        if (__classPrivateFieldGet(this, _Messenger_actions, "f").has(actionType)) {
-            throw new Error(`A handler for ${actionType} has already been registered`);
-        }
-        __classPrivateFieldGet(this, _Messenger_actions, "f").set(actionType, handler);
-    }
-    /**
-     * Registers action handlers for a list of methods on a messenger client
-     *
-     * @param messengerClient - The object that is expected to make use of the messenger.
-     * @param methodNames - The names of the methods on the messenger client to register as action
-     * handlers.
-     * @template MessengerClient - The type expected to make use of the messenger.
-     * @template MethodNames - The type union of method names to register as action handlers.
-     */
-    registerMethodActionHandlers(messengerClient, methodNames) {
-        for (const methodName of methodNames) {
-            const method = messengerClient[methodName];
-            if (typeof method === 'function') {
-                const actionType = `${messengerClient.name}:${methodName}`;
-                this.registerActionHandler(actionType, method.bind(messengerClient));
-            }
-        }
-    }
-    /**
-     * Unregister an action handler.
-     *
-     * This will prevent this action from being called.
-     *
-     * @param actionType - The action type. This is a unique identifier for this action.
-     * @template ActionType - A type union of Action type strings.
-     */
-    unregisterActionHandler(actionType) {
-        __classPrivateFieldGet(this, _Messenger_actions, "f").delete(actionType);
-    }
-    /**
-     * Unregister all action handlers.
-     *
-     * This prevents all actions from being called.
-     */
-    clearActions() {
-        __classPrivateFieldGet(this, _Messenger_actions, "f").clear();
-    }
-    /**
-     * Call an action.
-     *
-     * This function will call the action handler corresponding to the given action type, passing
-     * along any parameters given.
-     *
-     * @param actionType - The action type. This is a unique identifier for this action.
-     * @param params - The action parameters. These must match the type of the parameters of the
-     * registered action handler.
-     * @throws Will throw when no handler has been registered for the given type.
-     * @template ActionType - A type union of Action type strings.
-     * @returns The action return value.
-     */
-    call(actionType, ...params) {
-        const handler = __classPrivateFieldGet(this, _Messenger_actions, "f").get(actionType);
-        if (!handler) {
-            throw new Error(`A handler for ${actionType} has not been registered`);
-        }
-        return handler(...params);
-    }
-    /**
-     * Register a function for getting the initial payload for an event.
-     *
-     * This is used for events that represent a state change, where the payload is the state.
-     * Registering a function for getting the payload allows event selectors to have a point of
-     * comparison the first time state changes.
-     *
-     * @param args - The arguments to this function
-     * @param args.eventType - The event type to register a payload for.
-     * @param args.getPayload - A function for retrieving the event payload.
-     * @template EventType - A type union of Event type strings.
-     */
-    registerInitialEventPayload({ eventType, getPayload, }) {
-        __classPrivateFieldGet(this, _Messenger_initialEventPayloadGetters, "f").set(eventType, getPayload);
-    }
-    /**
-     * Publish an event.
-     *
-     * Publishes the given payload to all subscribers of the given event type.
-     *
-     * Note that this method should never throw directly. Any errors from
-     * subscribers are captured and re-thrown in a timeout handler.
-     *
-     * @param eventType - The event type. This is a unique identifier for this event.
-     * @param payload - The event payload. The type of the parameters for each event handler must
-     * match the type of this payload.
-     * @template EventType - A type union of Event type strings.
-     */
-    publish(eventType, ...payload) {
-        const subscribers = __classPrivateFieldGet(this, _Messenger_events, "f").get(eventType);
-        if (subscribers) {
-            for (const [handler, selector] of subscribers.entries()) {
-                try {
-                    if (selector) {
-                        const previousValue = __classPrivateFieldGet(this, _Messenger_eventPayloadCache, "f").get(handler);
-                        const newValue = selector(...payload);
-                        if (newValue !== previousValue) {
-                            __classPrivateFieldGet(this, _Messenger_eventPayloadCache, "f").set(handler, newValue);
-                            handler(newValue, previousValue);
-                        }
-                    }
-                    else {
-                        handler(...payload);
-                    }
-                }
-                catch (error) {
-                    // Throw error after timeout so that it is capured as a console error
-                    // (and by Sentry) without interrupting the event publishing.
-                    setTimeout(() => {
-                        throw error;
-                    });
-                }
-            }
-        }
-    }
-    subscribe(eventType, handler, selector) {
-        let subscribers = __classPrivateFieldGet(this, _Messenger_events, "f").get(eventType);
-        if (!subscribers) {
-            subscribers = new Map();
-            __classPrivateFieldGet(this, _Messenger_events, "f").set(eventType, subscribers);
-        }
-        // Widen type of event handler by dropping ReturnType parameter.
-        //
-        // We need to drop it here because it's used as the parameter to the event handler, and
-        // functions in general are contravarient over the parameter type. This means the type is no
-        // longer valid once it's added to a broader type union with other handlers (because as far
-        // as TypeScript knows, we might call the handler with output from a different selector).
-        //
-        // This cast means the type system is not guaranteeing the handler is called with the matching
-        // input selector return value. The parameter types do ensure they match when `subscribe` is
-        // called, but past that point we need to make sure of that with manual review and tests
-        // instead.
-        const widenedHandler = handler;
-        subscribers.set(widenedHandler, selector);
-        if (selector) {
-            const getPayload = __classPrivateFieldGet(this, _Messenger_initialEventPayloadGetters, "f").get(eventType);
-            if (getPayload) {
-                const initialValue = selector(...getPayload());
-                __classPrivateFieldGet(this, _Messenger_eventPayloadCache, "f").set(widenedHandler, initialValue);
-            }
-        }
-    }
-    /**
-     * Unsubscribe from an event.
-     *
-     * Unregisters the given function as an event handler for the given event.
-     *
-     * @param eventType - The event type. This is a unique identifier for this event.
-     * @param handler - The event handler to unregister.
-     * @throws Will throw when the given event handler is not registered for this event.
-     * @template EventType - A type union of Event type strings.
-     * @template SelectorReturnValue - The selector return value.
-     */
-    unsubscribe(eventType, handler) {
-        const subscribers = __classPrivateFieldGet(this, _Messenger_events, "f").get(eventType);
-        // Widen type of event handler by dropping ReturnType parameter.
-        //
-        // We need to drop it here because it's used as the parameter to the event handler, and
-        // functions in general are contravarient over the parameter type. This means the type is no
-        // longer valid once it's added to a broader type union with other handlers (because as far
-        // as TypeScript knows, we might call the handler with output from a different selector).
-        //
-        // This poses no risk in this case, since we never call the handler past this point.
-        const widenedHandler = handler;
-        if (!subscribers || !subscribers.has(widenedHandler)) {
-            throw new Error(`Subscription not found for event: ${eventType}`);
-        }
-        const selector = subscribers.get(widenedHandler);
-        if (selector) {
-            __classPrivateFieldGet(this, _Messenger_eventPayloadCache, "f").delete(widenedHandler);
-        }
-        subscribers.delete(widenedHandler);
-    }
-    /**
-     * Clear subscriptions for a specific event.
-     *
-     * This will remove all subscribed handlers for this event.
-     *
-     * @param eventType - The event type. This is a unique identifier for this event.
-     * @template EventType - A type union of Event type strings.
-     */
-    clearEventSubscriptions(eventType) {
-        __classPrivateFieldGet(this, _Messenger_events, "f").delete(eventType);
-    }
-    /**
-     * Clear all subscriptions.
-     *
-     * This will remove all subscribed handlers for all events.
-     */
-    clearSubscriptions() {
-        __classPrivateFieldGet(this, _Messenger_events, "f").clear();
-    }
-    /**
-     * Get a restricted messenger
-     *
-     * Returns a wrapper around the messenger instance that restricts access to actions and events.
-     * The provided allowlists grant the ability to call the listed actions and subscribe to the
-     * listed events. The "name" provided grants ownership of any actions and events under that
-     * namespace. Ownership allows registering actions and publishing events, as well as
-     * unregistering actions and clearing event subscriptions.
-     *
-     * @param options - Messenger options.
-     * @param options.name - The name of the thing this messenger will be handed to (e.g. the
-     * controller name). This grants "ownership" of actions and events under this namespace to the
-     * restricted messenger returned.
-     * @param options.allowedActions - The list of actions that this restricted messenger should be
-     * allowed to call.
-     * @param options.allowedEvents - The list of events that this restricted messenger should be
-     * allowed to subscribe to.
-     * @template Namespace - The namespace for this messenger. Typically this is the name of the
-     * module that this messenger has been created for. The authority to publish events and register
-     * actions under this namespace is granted to this restricted messenger instance.
-     * @template AllowedAction - A type union of the 'type' string for any allowed actions.
-     * This must not include internal actions that are in the messenger's namespace.
-     * @template AllowedEvent - A type union of the 'type' string for any allowed events.
-     * This must not include internal events that are in the messenger's namespace.
-     * @returns The restricted messenger.
-     */
-    getRestricted({ name, allowedActions, allowedEvents, }) {
-        return new RestrictedMessenger_1.RestrictedMessenger({
-            messenger: this,
-            name,
-            allowedActions,
-            allowedEvents,
-        });
-    }
-}
-exports.Messenger = Messenger;
-_Messenger_actions = new WeakMap(), _Messenger_events = new WeakMap(), _Messenger_initialEventPayloadGetters = new WeakMap(), _Messenger_eventPayloadCache = new WeakMap();
-//# sourceMappingURL=Messenger.cjs.map