@metamask-previews/base-controller 3.2.3-preview.e3b05ea → 3.2.3-preview.eb58a59

package/dist/RestrictedControllerMessenger.js

@@ -0,0 +1,195 @@
+"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 _RestrictedControllerMessenger_controllerMessenger, _RestrictedControllerMessenger_controllerName, _RestrictedControllerMessenger_allowedActions, _RestrictedControllerMessenger_allowedEvents;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestrictedControllerMessenger = void 0;
+/**
+ * A restricted controller messenger.
+ *
+ * This acts as a wrapper around the controller messenger instance that restricts access to actions
+ * and events.
+ *
+ * @template Namespace - The namespace for this messenger. Typically this is the name of the controller or
+ * 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 Action - A type union of all Action types.
+ * @template Event - A type union of all Event types.
+ * @template AllowedAction - A type union of the 'type' string for any allowed actions.
+ * @template AllowedEvent - A type union of the 'type' string for any allowed events.
+ */
+class RestrictedControllerMessenger {
+    /**
+     * Constructs a restricted controller messenger
+     *
+     * 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 - The controller options.
+     * @param options.controllerMessenger - The controller messenger instance that is being wrapped.
+     * @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 controller messenger returned.
+     * @param options.allowedActions - The list of actions that this restricted controller messenger
+     * should be alowed to call.
+     * @param options.allowedEvents - The list of events that this restricted controller messenger
+     * should be allowed to subscribe to.
+     */
+    constructor({ controllerMessenger, name, allowedActions, allowedEvents, }) {
+        _RestrictedControllerMessenger_controllerMessenger.set(this, void 0);
+        _RestrictedControllerMessenger_controllerName.set(this, void 0);
+        _RestrictedControllerMessenger_allowedActions.set(this, void 0);
+        _RestrictedControllerMessenger_allowedEvents.set(this, void 0);
+        __classPrivateFieldSet(this, _RestrictedControllerMessenger_controllerMessenger, controllerMessenger, "f");
+        __classPrivateFieldSet(this, _RestrictedControllerMessenger_controllerName, name, "f");
+        __classPrivateFieldSet(this, _RestrictedControllerMessenger_allowedActions, allowedActions || null, "f");
+        __classPrivateFieldSet(this, _RestrictedControllerMessenger_allowedEvents, allowedEvents || null, "f");
+    }
+    /**
+     * Register an action handler.
+     *
+     * This will make the registered function available to call via the `call` method.
+     *
+     * The action type this handler is registered under *must* be in the current namespace.
+     *
+     * @param action - The action type. This is a unqiue 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 if an action handler that is not in the current namespace is being registered.
+     * @template ActionType - A type union of Action type strings that are namespaced by Namespace.
+     */
+    registerActionHandler(action, handler) {
+        /* istanbul ignore if */ // Branch unreachable with valid types
+        if (!action.startsWith(`${__classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerName, "f")}:`)) {
+            throw new Error(`Only allowed registering action handlers prefixed by '${__classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerName, "f")}:'`);
+        }
+        __classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerMessenger, "f").registerActionHandler(action, handler);
+    }
+    /**
+     * Unregister an action handler.
+     *
+     * This will prevent this action from being called.
+     *
+     * The action type being unregistered *must* be in the current namespace.
+     *
+     * @param action - The action type. This is a unqiue identifier for this action.
+     * @template ActionType - A type union of Action type strings that are namespaced by Namespace.
+     */
+    unregisterActionHandler(action) {
+        /* istanbul ignore if */ // Branch unreachable with valid types
+        if (!action.startsWith(`${__classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerName, "f")}:`)) {
+            throw new Error(`Only allowed unregistering action handlers prefixed by '${__classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerName, "f")}:'`);
+        }
+        __classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerMessenger, "f").unregisterActionHandler(action);
+    }
+    /**
+     * Call an action.
+     *
+     * This function will call the action handler corresponding to the given action type, passing
+     * along any parameters given.
+     *
+     * The action type being called must be on the action allowlist.
+     *
+     * @param action - The action type. This is a unqiue 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 allowed Action type strings.
+     * @returns The action return value.
+     */
+    call(action, ...params) {
+        /* istanbul ignore next */ // Branches unreachable with valid types
+        if (__classPrivateFieldGet(this, _RestrictedControllerMessenger_allowedActions, "f") === null) {
+            throw new Error('No actions allowed');
+        }
+        else if (!__classPrivateFieldGet(this, _RestrictedControllerMessenger_allowedActions, "f").includes(action)) {
+            throw new Error(`Action missing from allow list: ${action}`);
+        }
+        return __classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerMessenger, "f").call(action, ...params);
+    }
+    /**
+     * Publish an event.
+     *
+     * Publishes the given payload to all subscribers of the given event type.
+     *
+     * The event type being published *must* be in the current namespace.
+     *
+     * @param event - 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 that are namespaced by Namespace.
+     */
+    publish(event, ...payload) {
+        /* istanbul ignore if */ // Branch unreachable with valid types
+        if (!event.startsWith(`${__classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerName, "f")}:`)) {
+            throw new Error(`Only allowed publishing events prefixed by '${__classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerName, "f")}:'`);
+        }
+        __classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerMessenger, "f").publish(event, ...payload);
+    }
+    subscribe(event, handler, selector) {
+        /* istanbul ignore next */ // Branches unreachable with valid types
+        if (__classPrivateFieldGet(this, _RestrictedControllerMessenger_allowedEvents, "f") === null) {
+            throw new Error('No events allowed');
+        }
+        else if (!__classPrivateFieldGet(this, _RestrictedControllerMessenger_allowedEvents, "f").includes(event)) {
+            throw new Error(`Event missing from allow list: ${event}`);
+        }
+        if (selector) {
+            return __classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerMessenger, "f").subscribe(event, handler, selector);
+        }
+        return __classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerMessenger, "f").subscribe(event, handler);
+    }
+    /**
+     * Unsubscribe from an event.
+     *
+     * Unregisters the given function as an event handler for the given event.
+     *
+     * The event type being unsubscribed to must be on the event allowlist.
+     *
+     * @param event - 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 allowed Event type strings.
+     */
+    unsubscribe(event, handler) {
+        /* istanbul ignore next */ // Branches unreachable with valid types
+        if (__classPrivateFieldGet(this, _RestrictedControllerMessenger_allowedEvents, "f") === null) {
+            throw new Error('No events allowed');
+        }
+        else if (!__classPrivateFieldGet(this, _RestrictedControllerMessenger_allowedEvents, "f").includes(event)) {
+            throw new Error(`Event missing from allow list: ${event}`);
+        }
+        __classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerMessenger, "f").unsubscribe(event, handler);
+    }
+    /**
+     * Clear subscriptions for a specific event.
+     *
+     * This will remove all subscribed handlers for this event.
+     *
+     * The event type being cleared *must* be in the current namespace.
+     *
+     * @param event - The event type. This is a unique identifier for this event.
+     * @template EventType - A type union of Event type strings that are namespaced by Namespace.
+     */
+    clearEventSubscriptions(event) {
+        /* istanbul ignore if */ // Branch unreachable with valid types
+        if (!event.startsWith(`${__classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerName, "f")}:`)) {
+            throw new Error(`Only allowed clearing events prefixed by '${__classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerName, "f")}:'`);
+        }
+        __classPrivateFieldGet(this, _RestrictedControllerMessenger_controllerMessenger, "f").clearEventSubscriptions(event);
+    }
+}
+exports.RestrictedControllerMessenger = RestrictedControllerMessenger;
+_RestrictedControllerMessenger_controllerMessenger = new WeakMap(), _RestrictedControllerMessenger_controllerName = new WeakMap(), _RestrictedControllerMessenger_allowedActions = new WeakMap(), _RestrictedControllerMessenger_allowedEvents = new WeakMap();
+//# sourceMappingURL=RestrictedControllerMessenger.js.map

package/dist/RestrictedControllerMessenger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestrictedControllerMessenger.js","sourceRoot":"","sources":["../src/RestrictedControllerMessenger.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAcA;;;;;;;;;;;;;GAaG;AACH,MAAa,6BAA6B;IAkBxC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,EACV,mBAAmB,EACnB,IAAI,EACJ,cAAc,EACd,aAAa,GAMd;QAvCD,qEAGE;QAEF,gEAAoC;QAEpC,gEAAiD;QAEjD,+DAA+C;QA+B7C,uBAAA,IAAI,sDAAwB,mBAAmB,MAAA,CAAC;QAChD,uBAAA,IAAI,iDAAmB,IAAI,MAAA,CAAC;QAC5B,uBAAA,IAAI,iDAAmB,cAAc,IAAI,IAAI,MAAA,CAAC;QAC9C,uBAAA,IAAI,gDAAkB,aAAa,IAAI,IAAI,MAAA,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,MAAkB,EAClB,OAA0C;QAE1C,wBAAwB,CAAC,sCAAsC;QAC/D,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,uBAAA,IAAI,qDAAgB,GAAG,CAAC,EAAE;YAClD,MAAM,IAAI,KAAK,CACb,yDACE,uBAAA,IAAI,qDACN,IAAI,CACL,CAAC;SACH;QACD,uBAAA,IAAI,0DAAqB,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,uBAAuB,CACrB,MAAkB;QAElB,wBAAwB,CAAC,sCAAsC;QAC/D,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,uBAAA,IAAI,qDAAgB,GAAG,CAAC,EAAE;YAClD,MAAM,IAAI,KAAK,CACb,2DACE,uBAAA,IAAI,qDACN,IAAI,CACL,CAAC;SACH;QACD,uBAAA,IAAI,0DAAqB,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,MAAkB,EAClB,GAAG,MAAmD;QAEtD,0BAA0B,CAAC,wCAAwC;QACnE,IAAI,uBAAA,IAAI,qDAAgB,KAAK,IAAI,EAAE;YACjC,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;SACvC;aAAM,IAAI,CAAC,uBAAA,IAAI,qDAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACjD,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,EAAE,CAAC,CAAC;SAC9D;QACD,OAAO,uBAAA,IAAI,0DAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CACL,KAAgB,EAChB,GAAG,OAA8C;QAEjD,wBAAwB,CAAC,sCAAsC;QAC/D,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,uBAAA,IAAI,qDAAgB,GAAG,CAAC,EAAE;YACjD,MAAM,IAAI,KAAK,CACb,+CAA+C,uBAAA,IAAI,qDAAgB,IAAI,CACxE,CAAC;SACH;QACD,uBAAA,IAAI,0DAAqB,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC;IACvD,CAAC;IAkDD,SAAS,CAIP,KAAgB,EAChB,OAA8C,EAC9C,QAGC;QAED,0BAA0B,CAAC,wCAAwC;QACnE,IAAI,uBAAA,IAAI,oDAAe,KAAK,IAAI,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;SACtC;aAAM,IAAI,CAAC,uBAAA,IAAI,oDAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC/C,MAAM,IAAI,KAAK,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;SAC5D;QAED,IAAI,QAAQ,EAAE;YACZ,OAAO,uBAAA,IAAI,0DAAqB,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;SACtE;QACD,OAAO,uBAAA,IAAI,0DAAqB,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CACT,KAAgB,EAChB,OAA8C;QAE9C,0BAA0B,CAAC,wCAAwC;QACnE,IAAI,uBAAA,IAAI,oDAAe,KAAK,IAAI,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;SACtC;aAAM,IAAI,CAAC,uBAAA,IAAI,oDAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC/C,MAAM,IAAI,KAAK,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;SAC5D;QACD,uBAAA,IAAI,0DAAqB,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;OASG;IACH,uBAAuB,CACrB,KAAgB;QAEhB,wBAAwB,CAAC,sCAAsC;QAC/D,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,uBAAA,IAAI,qDAAgB,GAAG,CAAC,EAAE;YACjD,MAAM,IAAI,KAAK,CACb,6CAA6C,uBAAA,IAAI,qDAAgB,IAAI,CACtE,CAAC;SACH;QACD,uBAAA,IAAI,0DAAqB,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAC3D,CAAC;CACF;AApRD,sEAoRC","sourcesContent":["import type {\n  ActionConstraint,\n  ActionHandler,\n  ControllerMessenger,\n  EventConstraint,\n  ExtractActionParameters,\n  ExtractActionResponse,\n  ExtractEventHandler,\n  ExtractEventPayload,\n  NamespacedName,\n  SelectorEventHandler,\n  SelectorFunction,\n} from './ControllerMessenger';\n\n/**\n * A restricted controller messenger.\n *\n * This acts as a wrapper around the controller messenger instance that restricts access to actions\n * and events.\n *\n * @template Namespace - The namespace for this messenger. Typically this is the name of the controller or\n * module that this messenger has been created for. The authority to publish events and register\n * actions under this namespace is granted to this restricted messenger instance.\n * @template Action - A type union of all Action types.\n * @template Event - A type union of all Event types.\n * @template AllowedAction - A type union of the 'type' string for any allowed actions.\n * @template AllowedEvent - A type union of the 'type' string for any allowed events.\n */\nexport class RestrictedControllerMessenger<\n  Namespace extends string,\n  Action extends ActionConstraint,\n  Event extends EventConstraint,\n  AllowedAction extends string,\n  AllowedEvent extends string,\n> {\n  readonly #controllerMessenger: ControllerMessenger<\n    ActionConstraint,\n    EventConstraint\n  >;\n\n  readonly #controllerName: Namespace;\n\n  readonly #allowedActions: AllowedAction[] | null;\n\n  readonly #allowedEvents: AllowedEvent[] | null;\n\n  /**\n   * Constructs a restricted controller messenger\n   *\n   * The provided allowlists grant the ability to call the listed actions and subscribe to the\n   * listed events. The \"name\" provided grants ownership of any actions and events under that\n   * namespace. Ownership allows registering actions and publishing events, as well as\n   * unregistering actions and clearing event subscriptions.\n   *\n   * @param options - The controller options.\n   * @param options.controllerMessenger - The controller messenger instance that is being wrapped.\n   * @param options.name - The name of the thing this messenger will be handed to (e.g. the\n   * controller name). This grants \"ownership\" of actions and events under this namespace to the\n   * restricted controller messenger returned.\n   * @param options.allowedActions - The list of actions that this restricted controller messenger\n   * should be alowed to call.\n   * @param options.allowedEvents - The list of events that this restricted controller messenger\n   * should be allowed to subscribe to.\n   */\n  constructor({\n    controllerMessenger,\n    name,\n    allowedActions,\n    allowedEvents,\n  }: {\n    controllerMessenger: ControllerMessenger<ActionConstraint, EventConstraint>;\n    name: Namespace;\n    allowedActions?: AllowedAction[];\n    allowedEvents?: AllowedEvent[];\n  }) {\n    this.#controllerMessenger = controllerMessenger;\n    this.#controllerName = name;\n    this.#allowedActions = allowedActions || null;\n    this.#allowedEvents = allowedEvents || null;\n  }\n\n  /**\n   * Register an action handler.\n   *\n   * This will make the registered function available to call via the `call` method.\n   *\n   * The action type this handler is registered under *must* be in the current namespace.\n   *\n   * @param action - The action type. This is a unqiue identifier for this action.\n   * @param handler - The action handler. This function gets called when the `call` method is\n   * invoked with the given action type.\n   * @throws Will throw if an action handler that is not in the current namespace is being registered.\n   * @template ActionType - A type union of Action type strings that are namespaced by Namespace.\n   */\n  registerActionHandler<ActionType extends Action['type']>(\n    action: ActionType,\n    handler: ActionHandler<Action, ActionType>,\n  ) {\n    /* istanbul ignore if */ // Branch unreachable with valid types\n    if (!action.startsWith(`${this.#controllerName}:`)) {\n      throw new Error(\n        `Only allowed registering action handlers prefixed by '${\n          this.#controllerName\n        }:'`,\n      );\n    }\n    this.#controllerMessenger.registerActionHandler(action, handler);\n  }\n\n  /**\n   * Unregister an action handler.\n   *\n   * This will prevent this action from being called.\n   *\n   * The action type being unregistered *must* be in the current namespace.\n   *\n   * @param action - The action type. This is a unqiue identifier for this action.\n   * @template ActionType - A type union of Action type strings that are namespaced by Namespace.\n   */\n  unregisterActionHandler<ActionType extends NamespacedName<Namespace>>(\n    action: ActionType,\n  ) {\n    /* istanbul ignore if */ // Branch unreachable with valid types\n    if (!action.startsWith(`${this.#controllerName}:`)) {\n      throw new Error(\n        `Only allowed unregistering action handlers prefixed by '${\n          this.#controllerName\n        }:'`,\n      );\n    }\n    this.#controllerMessenger.unregisterActionHandler(action);\n  }\n\n  /**\n   * Call an action.\n   *\n   * This function will call the action handler corresponding to the given action type, passing\n   * along any parameters given.\n   *\n   * The action type being called must be on the action allowlist.\n   *\n   * @param action - The action type. This is a unqiue identifier for this action.\n   * @param params - The action parameters. These must match the type of the parameters of the\n   * registered action handler.\n   * @throws Will throw when no handler has been registered for the given type.\n   * @template ActionType - A type union of allowed Action type strings.\n   * @returns The action return value.\n   */\n  call<ActionType extends AllowedAction & NamespacedName>(\n    action: ActionType,\n    ...params: ExtractActionParameters<Action, ActionType>\n  ): ExtractActionResponse<Action, ActionType> {\n    /* istanbul ignore next */ // Branches unreachable with valid types\n    if (this.#allowedActions === null) {\n      throw new Error('No actions allowed');\n    } else if (!this.#allowedActions.includes(action)) {\n      throw new Error(`Action missing from allow list: ${action}`);\n    }\n    return this.#controllerMessenger.call(action, ...params);\n  }\n\n  /**\n   * Publish an event.\n   *\n   * Publishes the given payload to all subscribers of the given event type.\n   *\n   * The event type being published *must* be in the current namespace.\n   *\n   * @param event - The event type. This is a unique identifier for this event.\n   * @param payload - The event payload. The type of the parameters for each event handler must\n   * match the type of this payload.\n   * @template EventType - A type union of Event type strings that are namespaced by Namespace.\n   */\n  publish<EventType extends NamespacedName<Namespace>>(\n    event: EventType,\n    ...payload: ExtractEventPayload<Event, EventType>\n  ) {\n    /* istanbul ignore if */ // Branch unreachable with valid types\n    if (!event.startsWith(`${this.#controllerName}:`)) {\n      throw new Error(\n        `Only allowed publishing events prefixed by '${this.#controllerName}:'`,\n      );\n    }\n    this.#controllerMessenger.publish(event, ...payload);\n  }\n\n  /**\n   * Subscribe to an event.\n   *\n   * Registers the given function as an event handler for the given event type.\n   *\n   * The event type being subscribed to must be on the event allowlist.\n   *\n   * @param eventType - The event type. This is a unique identifier for this event.\n   * @param handler - The event handler. The type of the parameters for this event handler must\n   * match the type of the payload for this event type.\n   * @template EventType - A type union of Event type strings.\n   */\n  subscribe<EventType extends AllowedEvent & NamespacedName>(\n    eventType: EventType,\n    handler: ExtractEventHandler<Event, EventType>,\n  ): void;\n\n  /**\n   * Subscribe to an event, with a selector.\n   *\n   * Registers the given handler function as an event handler for the given\n   * event type. When an event is published, its payload is first passed to the\n   * selector. The event handler is only called if the selector's return value\n   * differs from its last known return value.\n   *\n   * The event type being subscribed to must be on the event allowlist.\n   *\n   * @param eventType - The event type. This is a unique identifier for this event.\n   * @param handler - The event handler. The type of the parameters for this event\n   * handler must match the return type of the selector.\n   * @param selector - The selector function used to select relevant data from\n   * the event payload. The type of the parameters for this selector must match\n   * the type of the payload for this event type.\n   * @template EventType - A type union of Event type strings.\n   * @template SelectorReturnValue - The selector return value.\n   */\n  subscribe<\n    EventType extends AllowedEvent & NamespacedName,\n    SelectorReturnValue,\n  >(\n    eventType: EventType,\n    handler: SelectorEventHandler<SelectorReturnValue>,\n    selector: SelectorFunction<\n      ExtractEventPayload<Event, EventType>,\n      SelectorReturnValue\n    >,\n  ): void;\n\n  subscribe<\n    EventType extends AllowedEvent & NamespacedName,\n    SelectorReturnValue,\n  >(\n    event: EventType,\n    handler: ExtractEventHandler<Event, EventType>,\n    selector?: SelectorFunction<\n      ExtractEventPayload<Event, EventType>,\n      SelectorReturnValue\n    >,\n  ) {\n    /* istanbul ignore next */ // Branches unreachable with valid types\n    if (this.#allowedEvents === null) {\n      throw new Error('No events allowed');\n    } else if (!this.#allowedEvents.includes(event)) {\n      throw new Error(`Event missing from allow list: ${event}`);\n    }\n\n    if (selector) {\n      return this.#controllerMessenger.subscribe(event, handler, selector);\n    }\n    return this.#controllerMessenger.subscribe(event, handler);\n  }\n\n  /**\n   * Unsubscribe from an event.\n   *\n   * Unregisters the given function as an event handler for the given event.\n   *\n   * The event type being unsubscribed to must be on the event allowlist.\n   *\n   * @param event - The event type. This is a unique identifier for this event.\n   * @param handler - The event handler to unregister.\n   * @throws Will throw when the given event handler is not registered for this event.\n   * @template EventType - A type union of allowed Event type strings.\n   */\n  unsubscribe<EventType extends AllowedEvent & NamespacedName>(\n    event: EventType,\n    handler: ExtractEventHandler<Event, EventType>,\n  ) {\n    /* istanbul ignore next */ // Branches unreachable with valid types\n    if (this.#allowedEvents === null) {\n      throw new Error('No events allowed');\n    } else if (!this.#allowedEvents.includes(event)) {\n      throw new Error(`Event missing from allow list: ${event}`);\n    }\n    this.#controllerMessenger.unsubscribe(event, handler);\n  }\n\n  /**\n   * Clear subscriptions for a specific event.\n   *\n   * This will remove all subscribed handlers for this event.\n   *\n   * The event type being cleared *must* be in the current namespace.\n   *\n   * @param event - The event type. This is a unique identifier for this event.\n   * @template EventType - A type union of Event type strings that are namespaced by Namespace.\n   */\n  clearEventSubscriptions<EventType extends NamespacedName<Namespace>>(\n    event: EventType,\n  ) {\n    /* istanbul ignore if */ // Branch unreachable with valid types\n    if (!event.startsWith(`${this.#controllerName}:`)) {\n      throw new Error(\n        `Only allowed clearing events prefixed by '${this.#controllerName}:'`,\n      );\n    }\n    this.#controllerMessenger.clearEventSubscriptions(event);\n  }\n}\n"]}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export type { BaseConfig, BaseState, Listener } from './BaseController';
 export { BaseController } from './BaseController';
 export type { Listener as ListenerV2, StateDeriver, StateMetadata, StatePropertyMetadata, } from './BaseControllerV2';
-export { BaseController as BaseControllerV2, getAnonymizedState, getPersistentState, } from './BaseControllerV2';
+export { BaseController as BaseControllerV2, getAnonymizedState, getPersistentState, type ControllerGetStateAction, type ControllerStateChangeEvent, } from './BaseControllerV2';
 export * from './ControllerMessenger';
+export * from './RestrictedControllerMessenger';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,YAAY,EACV,QAAQ,IAAI,UAAU,EACtB,YAAY,EACZ,aAAa,EACb,qBAAqB,GACtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,cAAc,IAAI,gBAAgB,EAClC,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,cAAc,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,YAAY,EACV,QAAQ,IAAI,UAAU,EACtB,YAAY,EACZ,aAAa,EACb,qBAAqB,GACtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,cAAc,IAAI,gBAAgB,EAClC,kBAAkB,EAClB,kBAAkB,EAClB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,GAChC,MAAM,oBAAoB,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC"}

package/dist/index.js

@@ -22,4 +22,5 @@ Object.defineProperty(exports, "BaseControllerV2", { enumerable: true, get: func
 Object.defineProperty(exports, "getAnonymizedState", { enumerable: true, get: function () { return BaseControllerV2_1.getAnonymizedState; } });
 Object.defineProperty(exports, "getPersistentState", { enumerable: true, get: function () { return BaseControllerV2_1.getPersistentState; } });
 __exportStar(require("./ControllerMessenger"), exports);
+__exportStar(require("./RestrictedControllerMessenger"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,mDAAkD;AAAzC,gHAAA,cAAc,OAAA;AAOvB,uDAI4B;AAH1B,oHAAA,cAAc,OAAoB;AAClC,sHAAA,kBAAkB,OAAA;AAClB,sHAAA,kBAAkB,OAAA;AAEpB,wDAAsC","sourcesContent":["export type { BaseConfig, BaseState, Listener } from './BaseController';\nexport { BaseController } from './BaseController';\nexport type {\n  Listener as ListenerV2,\n  StateDeriver,\n  StateMetadata,\n  StatePropertyMetadata,\n} from './BaseControllerV2';\nexport {\n  BaseController as BaseControllerV2,\n  getAnonymizedState,\n  getPersistentState,\n} from './BaseControllerV2';\nexport * from './ControllerMessenger';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,mDAAkD;AAAzC,gHAAA,cAAc,OAAA;AAOvB,uDAM4B;AAL1B,oHAAA,cAAc,OAAoB;AAClC,sHAAA,kBAAkB,OAAA;AAClB,sHAAA,kBAAkB,OAAA;AAIpB,wDAAsC;AACtC,kEAAgD","sourcesContent":["export type { BaseConfig, BaseState, Listener } from './BaseController';\nexport { BaseController } from './BaseController';\nexport type {\n  Listener as ListenerV2,\n  StateDeriver,\n  StateMetadata,\n  StatePropertyMetadata,\n} from './BaseControllerV2';\nexport {\n  BaseController as BaseControllerV2,\n  getAnonymizedState,\n  getPersistentState,\n  type ControllerGetStateAction,\n  type ControllerStateChangeEvent,\n} from './BaseControllerV2';\nexport * from './ControllerMessenger';\nexport * from './RestrictedControllerMessenger';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/base-controller",
-  "version": "3.2.3-preview.e3b05ea",
+  "version": "3.2.3-preview.eb58a59",
   "description": "Provides scaffolding for controllers as well a communication system for all controllers",
   "keywords": [
     "MetaMask",
@@ -24,16 +24,17 @@
     "build:docs": "typedoc",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/base-controller",
     "publish:preview": "yarn npm publish --tag preview",
-    "test": "jest",
+    "test": "jest --reporters=jest-silent-reporter",
     "test:clean": "jest --clearCache",
+    "test:verbose": "jest --verbose",
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@metamask/utils": "^8.1.0",
+    "@metamask/utils": "^8.2.0",
     "immer": "^9.0.6"
   },
   "devDependencies": {
-    "@metamask/auto-changelog": "^3.4.0",
+    "@metamask/auto-changelog": "^3.4.3",
     "@types/jest": "^27.4.1",
     "@types/sinon": "^9.0.10",
     "deepmerge": "^4.2.2",