@metamask-previews/messenger 0.0.0-preview-3713f9f

package/dist/RestrictedMessenger.d.mts

@@ -0,0 +1,196 @@
+import type { ActionConstraint, ActionHandler, Messenger, EventConstraint, ExtractActionParameters, ExtractActionResponse, ExtractEventHandler, ExtractEventPayload, NamespacedName, NotNamespacedBy, SelectorEventHandler, SelectorFunction } from "./Messenger.mjs";
+/**
+ * A universal supertype of all `RestrictedMessenger` instances. This type can be assigned to any
+ * `RestrictedMessenger` type.
+ *
+ * @template Namespace - Name of the module this messenger is for. Optionally can be used to
+ * narrow this type to a constraint for the messenger of a specific module.
+ */
+export type RestrictedMessengerConstraint<Namespace extends string = string> = RestrictedMessenger<Namespace, ActionConstraint, EventConstraint, string, string>;
+/**
+ * A restricted messenger.
+ *
+ * This acts as a wrapper around the 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.
+ * 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.
+ */
+export declare class RestrictedMessenger<Namespace extends string, Action extends ActionConstraint, Event extends EventConstraint, AllowedAction extends string, AllowedEvent extends string> {
+    #private;
+    /**
+     * Constructs a restricted 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 - Options.
+     * @param options.messenger - The 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 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.
+     */
+    constructor({ messenger, name, allowedActions, allowedEvents, }: {
+        messenger?: Messenger<ActionConstraint, EventConstraint>;
+        name: Namespace;
+        allowedActions: NotNamespacedBy<Namespace, AllowedAction>[];
+        allowedEvents: NotNamespacedBy<Namespace, AllowedEvent>[];
+    });
+    /**
+     * 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 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 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<ActionType extends Action['type'] & NamespacedName<Namespace>>(action: ActionType, handler: ActionHandler<Action, ActionType>): void;
+    /**
+     * 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
+     */
+    registerMethodActionHandlers<MessengerClient extends {
+        name: string;
+    }, MethodNames extends keyof MessengerClient & string>(messengerClient: MessengerClient, methodNames: readonly MethodNames[]): void;
+    /**
+     * 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 unique identifier for this action.
+     * @throws Will throw if an action handler that is not in the current namespace is being unregistered.
+     * @template ActionType - A type union of Action type strings that are namespaced by Namespace.
+     */
+    unregisterActionHandler<ActionType extends Action['type'] & NamespacedName<Namespace>>(action: ActionType): void;
+    /**
+     * 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 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 allowed Action type strings.
+     * @returns The action return value.
+     */
+    call<ActionType extends AllowedAction | (Action['type'] & NamespacedName<Namespace>)>(actionType: ActionType, ...params: ExtractActionParameters<Action, ActionType>): ExtractActionResponse<Action, ActionType>;
+    /**
+     * 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.
+     *
+     * The event type *must* be in the current namespace
+     *
+     * @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.
+     */
+    registerInitialEventPayload<EventType extends Event['type'] & NamespacedName<Namespace>>({ eventType, getPayload, }: {
+        eventType: EventType;
+        getPayload: () => ExtractEventPayload<Event, EventType>;
+    }): void;
+    /**
+     * 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.
+     * @throws Will throw if an event that is not in the current namespace is being published.
+     * @template EventType - A type union of Event type strings that are namespaced by Namespace.
+     */
+    publish<EventType extends Event['type'] & NamespacedName<Namespace>>(event: EventType, ...payload: ExtractEventPayload<Event, EventType>): void;
+    /**
+     * Subscribe to an event.
+     *
+     * Registers the given function as an event handler for the given event type.
+     *
+     * The event type being subscribed to must be on the event allowlist.
+     *
+     * @param eventType - The event type. This is a unique identifier for this event.
+     * @param handler - The event handler. The type of the parameters for this event handler must
+     * match the type of the payload for this event type.
+     * @throws Will throw if the given event is not an allowed event for this messenger.
+     * @template EventType - A type union of Event type strings.
+     */
+    subscribe<EventType extends AllowedEvent | (Event['type'] & NamespacedName<Namespace>)>(eventType: EventType, handler: ExtractEventHandler<Event, EventType>): void;
+    /**
+     * Subscribe to an event, with a selector.
+     *
+     * Registers the given handler function as an event handler for the given
+     * event type. When an event is published, its payload is first passed to the
+     * selector. The event handler is only called if the selector's return value
+     * differs from its last known return value.
+     *
+     * The event type being subscribed to must be on the event allowlist.
+     *
+     * @param eventType - The event type. This is a unique identifier for this event.
+     * @param handler - The event handler. The type of the parameters for this event
+     * handler must match the return type of the selector.
+     * @param selector - The selector function used to select relevant data from
+     * the event payload. The type of the parameters for this selector must match
+     * the type of the payload for this event type.
+     * @throws Will throw if the given event is not an allowed event for this messenger.
+     * @template EventType - A type union of Event type strings.
+     * @template SelectorReturnValue - The selector return value.
+     */
+    subscribe<EventType extends AllowedEvent | (Event['type'] & NamespacedName<Namespace>), SelectorReturnValue>(eventType: EventType, handler: SelectorEventHandler<SelectorReturnValue>, selector: SelectorFunction<Event, EventType, SelectorReturnValue>): void;
+    /**
+     * 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 if the given event is not an allowed event for this messenger.
+     * @template EventType - A type union of allowed Event type strings.
+     */
+    unsubscribe<EventType extends AllowedEvent | (Event['type'] & NamespacedName<Namespace>)>(event: EventType, handler: ExtractEventHandler<Event, EventType>): void;
+    /**
+     * 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.
+     * @throws Will throw if a subscription for an event that is not in the current namespace is being cleared.
+     * @template EventType - A type union of Event type strings that are namespaced by Namespace.
+     */
+    clearEventSubscriptions<EventType extends Event['type'] & NamespacedName<Namespace>>(event: EventType): void;
+}
+//# sourceMappingURL=RestrictedMessenger.d.mts.map

package/dist/RestrictedMessenger.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestrictedMessenger.d.mts","sourceRoot":"","sources":["../src/RestrictedMessenger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,eAAe,EACf,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,gBAAgB,EACjB,wBAAoB;AAErB;;;;;;GAMG;AACH,MAAM,MAAM,6BAA6B,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IACzE,mBAAmB,CACjB,SAAS,EACT,gBAAgB,EAChB,eAAe,EACf,MAAM,EACN,MAAM,CACP,CAAC;AAEJ;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,mBAAmB,CAC9B,SAAS,SAAS,MAAM,EACxB,MAAM,SAAS,gBAAgB,EAC/B,KAAK,SAAS,eAAe,EAC7B,aAAa,SAAS,MAAM,EAC5B,YAAY,SAAS,MAAM;;IAU3B;;;;;;;;;;;;;;;;;OAiBG;gBACS,EACV,SAAS,EACT,IAAI,EACJ,cAAc,EACd,aAAa,GACd,EAAE;QACD,SAAS,CAAC,EAAE,SAAS,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;QACzD,IAAI,EAAE,SAAS,CAAC;QAChB,cAAc,EAAE,eAAe,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,CAAC;QAC5D,aAAa,EAAE,eAAe,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE,CAAC;KAC3D;IAWD;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,UAAU,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EAC7D,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC;IAYhE;;;;;;OAMG;IACH,4BAA4B,CAC1B,eAAe,SAAS;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EACxC,WAAW,SAAS,MAAM,eAAe,GAAG,MAAM,EAClD,eAAe,EAAE,eAAe,EAAE,WAAW,EAAE,SAAS,WAAW,EAAE;IAIvE;;;;;;;;;;OAUG;IACH,uBAAuB,CACrB,UAAU,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EAC7D,MAAM,EAAE,UAAU;IAYpB;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,UAAU,SACN,aAAa,GACb,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAEhD,UAAU,EAAE,UAAU,EACtB,GAAG,MAAM,EAAE,uBAAuB,CAAC,MAAM,EAAE,UAAU,CAAC,GACrD,qBAAqB,CAAC,MAAM,EAAE,UAAU,CAAC;IAS5C;;;;;;;;;;;;OAYG;IACH,2BAA2B,CACzB,SAAS,SAAS,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EAC3D,EACA,SAAS,EACT,UAAU,GACX,EAAE;QACD,SAAS,EAAE,SAAS,CAAC;QACrB,UAAU,EAAE,MAAM,mBAAmB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;KACzD;IAaD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,SAAS,SAAS,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EACjE,KAAK,EAAE,SAAS,EAChB,GAAG,OAAO,EAAE,mBAAmB,CAAC,KAAK,EAAE,SAAS,CAAC;IAWnD;;;;;;;;;;;;OAYG;IACH,SAAS,CACP,SAAS,SACL,YAAY,GACZ,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAC/C,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,mBAAmB,CAAC,KAAK,EAAE,SAAS,CAAC,GAAG,IAAI;IAE7E;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CACP,SAAS,SACL,YAAY,GACZ,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAC/C,mBAAmB,EAEnB,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,EAClD,QAAQ,EAAE,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,mBAAmB,CAAC,GAChE,IAAI;IAsBP;;;;;;;;;;;OAWG;IACH,WAAW,CACT,SAAS,SACL,YAAY,GACZ,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAC/C,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,mBAAmB,CAAC,KAAK,EAAE,SAAS,CAAC;IAOlE;;;;;;;;;;OAUG;IACH,uBAAuB,CACrB,SAAS,SAAS,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EAC3D,KAAK,EAAE,SAAS;CA4DnB"}

package/dist/RestrictedMessenger.mjs

@@ -0,0 +1,234 @@
+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 _RestrictedMessenger_instances, _RestrictedMessenger_messenger, _RestrictedMessenger_namespace, _RestrictedMessenger_allowedActions, _RestrictedMessenger_allowedEvents, _RestrictedMessenger_isAllowedEvent, _RestrictedMessenger_isAllowedAction, _RestrictedMessenger_isInCurrentNamespace;
+/**
+ * A restricted messenger.
+ *
+ * This acts as a wrapper around the 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.
+ * 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.
+ */
+export class RestrictedMessenger {
+    /**
+     * Constructs a restricted 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 - Options.
+     * @param options.messenger - The 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 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.
+     */
+    constructor({ messenger, name, allowedActions, allowedEvents, }) {
+        _RestrictedMessenger_instances.add(this);
+        _RestrictedMessenger_messenger.set(this, void 0);
+        _RestrictedMessenger_namespace.set(this, void 0);
+        _RestrictedMessenger_allowedActions.set(this, void 0);
+        _RestrictedMessenger_allowedEvents.set(this, void 0);
+        if (!messenger) {
+            throw new Error('Messenger not provided');
+        }
+        // The above condition guarantees that one of these options is defined.
+        __classPrivateFieldSet(this, _RestrictedMessenger_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _RestrictedMessenger_namespace, name, "f");
+        __classPrivateFieldSet(this, _RestrictedMessenger_allowedActions, allowedActions, "f");
+        __classPrivateFieldSet(this, _RestrictedMessenger_allowedEvents, allowedEvents, "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 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 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 (!__classPrivateFieldGet(this, _RestrictedMessenger_instances, "m", _RestrictedMessenger_isInCurrentNamespace).call(this, action)) {
+            throw new Error(`Only allowed registering action handlers prefixed by '${__classPrivateFieldGet(this, _RestrictedMessenger_namespace, "f")}:'`);
+        }
+        __classPrivateFieldGet(this, _RestrictedMessenger_messenger, "f").registerActionHandler(action, 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
+     */
+    registerMethodActionHandlers(messengerClient, methodNames) {
+        __classPrivateFieldGet(this, _RestrictedMessenger_messenger, "f").registerMethodActionHandlers(messengerClient, methodNames);
+    }
+    /**
+     * 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 unique identifier for this action.
+     * @throws Will throw if an action handler that is not in the current namespace is being unregistered.
+     * @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 (!__classPrivateFieldGet(this, _RestrictedMessenger_instances, "m", _RestrictedMessenger_isInCurrentNamespace).call(this, action)) {
+            throw new Error(`Only allowed unregistering action handlers prefixed by '${__classPrivateFieldGet(this, _RestrictedMessenger_namespace, "f")}:'`);
+        }
+        __classPrivateFieldGet(this, _RestrictedMessenger_messenger, "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 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 allowed Action type strings.
+     * @returns The action return value.
+     */
+    call(actionType, ...params) {
+        if (!__classPrivateFieldGet(this, _RestrictedMessenger_instances, "m", _RestrictedMessenger_isAllowedAction).call(this, actionType)) {
+            throw new Error(`Action missing from allow list: ${actionType}`);
+        }
+        const response = __classPrivateFieldGet(this, _RestrictedMessenger_messenger, "f").call(actionType, ...params);
+        return response;
+    }
+    /**
+     * 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.
+     *
+     * The event type *must* be in the current namespace
+     *
+     * @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.
+     */
+    registerInitialEventPayload({ eventType, getPayload, }) {
+        /* istanbul ignore if */ // Branch unreachable with valid types
+        if (!__classPrivateFieldGet(this, _RestrictedMessenger_instances, "m", _RestrictedMessenger_isInCurrentNamespace).call(this, eventType)) {
+            throw new Error(`Only allowed publishing events prefixed by '${__classPrivateFieldGet(this, _RestrictedMessenger_namespace, "f")}:'`);
+        }
+        __classPrivateFieldGet(this, _RestrictedMessenger_messenger, "f").registerInitialEventPayload({
+            eventType,
+            getPayload,
+        });
+    }
+    /**
+     * 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.
+     * @throws Will throw if an event that is not in the current namespace is being published.
+     * @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 (!__classPrivateFieldGet(this, _RestrictedMessenger_instances, "m", _RestrictedMessenger_isInCurrentNamespace).call(this, event)) {
+            throw new Error(`Only allowed publishing events prefixed by '${__classPrivateFieldGet(this, _RestrictedMessenger_namespace, "f")}:'`);
+        }
+        __classPrivateFieldGet(this, _RestrictedMessenger_messenger, "f").publish(event, ...payload);
+    }
+    subscribe(event, handler, selector) {
+        if (!__classPrivateFieldGet(this, _RestrictedMessenger_instances, "m", _RestrictedMessenger_isAllowedEvent).call(this, event)) {
+            throw new Error(`Event missing from allow list: ${event}`);
+        }
+        if (selector) {
+            return __classPrivateFieldGet(this, _RestrictedMessenger_messenger, "f").subscribe(event, handler, selector);
+        }
+        return __classPrivateFieldGet(this, _RestrictedMessenger_messenger, "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 if the given event is not an allowed event for this messenger.
+     * @template EventType - A type union of allowed Event type strings.
+     */
+    unsubscribe(event, handler) {
+        if (!__classPrivateFieldGet(this, _RestrictedMessenger_instances, "m", _RestrictedMessenger_isAllowedEvent).call(this, event)) {
+            throw new Error(`Event missing from allow list: ${event}`);
+        }
+        __classPrivateFieldGet(this, _RestrictedMessenger_messenger, "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.
+     * @throws Will throw if a subscription for an event that is not in the current namespace is being cleared.
+     * @template EventType - A type union of Event type strings that are namespaced by Namespace.
+     */
+    clearEventSubscriptions(event) {
+        if (!__classPrivateFieldGet(this, _RestrictedMessenger_instances, "m", _RestrictedMessenger_isInCurrentNamespace).call(this, event)) {
+            throw new Error(`Only allowed clearing events prefixed by '${__classPrivateFieldGet(this, _RestrictedMessenger_namespace, "f")}:'`);
+        }
+        __classPrivateFieldGet(this, _RestrictedMessenger_messenger, "f").clearEventSubscriptions(event);
+    }
+}
+_RestrictedMessenger_messenger = new WeakMap(), _RestrictedMessenger_namespace = new WeakMap(), _RestrictedMessenger_allowedActions = new WeakMap(), _RestrictedMessenger_allowedEvents = new WeakMap(), _RestrictedMessenger_instances = new WeakSet(), _RestrictedMessenger_isAllowedEvent = function _RestrictedMessenger_isAllowedEvent(eventType) {
+    // Safely upcast to allow runtime check
+    const allowedEvents = __classPrivateFieldGet(this, _RestrictedMessenger_allowedEvents, "f");
+    return (__classPrivateFieldGet(this, _RestrictedMessenger_instances, "m", _RestrictedMessenger_isInCurrentNamespace).call(this, eventType) ||
+        (allowedEvents !== null && allowedEvents.includes(eventType)));
+}, _RestrictedMessenger_isAllowedAction = function _RestrictedMessenger_isAllowedAction(actionType) {
+    // Safely upcast to allow runtime check
+    const allowedActions = __classPrivateFieldGet(this, _RestrictedMessenger_allowedActions, "f");
+    return (__classPrivateFieldGet(this, _RestrictedMessenger_instances, "m", _RestrictedMessenger_isInCurrentNamespace).call(this, actionType) ||
+        (allowedActions !== null && allowedActions.includes(actionType)));
+}, _RestrictedMessenger_isInCurrentNamespace = function _RestrictedMessenger_isInCurrentNamespace(name) {
+    return name.startsWith(`${__classPrivateFieldGet(this, _RestrictedMessenger_namespace, "f")}:`);
+};
+//# sourceMappingURL=RestrictedMessenger.mjs.map

package/dist/RestrictedMessenger.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"RestrictedMessenger.mjs","sourceRoot":"","sources":["../src/RestrictedMessenger.ts"],"names":[],"mappings":";;;;;;;;;;;;AA+BA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,mBAAmB;IAe9B;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,EACV,SAAS,EACT,IAAI,EACJ,cAAc,EACd,aAAa,GAMd;;QApCQ,iDAAyD;QAEzD,iDAAsB;QAEtB,sDAA6D;QAE7D,qDAA2D;QA+BlE,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC3C;QACD,uEAAuE;QACvE,uBAAA,IAAI,kCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,kCAAc,IAAI,MAAA,CAAC;QACvB,uBAAA,IAAI,uCAAmB,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,sCAAkB,aAAa,MAAA,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAEnB,MAAkB,EAAE,OAA0C;QAC9D,wBAAwB,CAAC,sCAAsC;QAC/D,IAAI,CAAC,uBAAA,IAAI,iFAAsB,MAA1B,IAAI,EAAuB,MAAM,CAAC,EAAE;YACvC,MAAM,IAAI,KAAK,CACb,yDACE,uBAAA,IAAI,sCACN,IAAI,CACL,CAAC;SACH;QACD,uBAAA,IAAI,sCAAW,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACH,4BAA4B,CAG1B,eAAgC,EAAE,WAAmC;QACrE,uBAAA,IAAI,sCAAW,CAAC,4BAA4B,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,uBAAuB,CAErB,MAAkB;QAClB,wBAAwB,CAAC,sCAAsC;QAC/D,IAAI,CAAC,uBAAA,IAAI,iFAAsB,MAA1B,IAAI,EAAuB,MAAM,CAAC,EAAE;YACvC,MAAM,IAAI,KAAK,CACb,2DACE,uBAAA,IAAI,sCACN,IAAI,CACL,CAAC;SACH;QACD,uBAAA,IAAI,sCAAW,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAKF,UAAsB,EACtB,GAAG,MAAmD;QAEtD,IAAI,CAAC,uBAAA,IAAI,4EAAiB,MAArB,IAAI,EAAkB,UAAU,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,mCAAmC,UAAU,EAAE,CAAC,CAAC;SAClE;QACD,MAAM,QAAQ,GAAG,uBAAA,IAAI,sCAAW,CAAC,IAAI,CAAa,UAAU,EAAE,GAAG,MAAM,CAAC,CAAC;QAEzE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,2BAA2B,CAEzB,EACA,SAAS,EACT,UAAU,GAIX;QACC,wBAAwB,CAAC,sCAAsC;QAC/D,IAAI,CAAC,uBAAA,IAAI,iFAAsB,MAA1B,IAAI,EAAuB,SAAS,CAAC,EAAE;YAC1C,MAAM,IAAI,KAAK,CACb,+CAA+C,uBAAA,IAAI,sCAAW,IAAI,CACnE,CAAC;SACH;QACD,uBAAA,IAAI,sCAAW,CAAC,2BAA2B,CAAC;YAC1C,SAAS;YACT,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CACL,KAAgB,EAChB,GAAG,OAA8C;QAEjD,wBAAwB,CAAC,sCAAsC;QAC/D,IAAI,CAAC,uBAAA,IAAI,iFAAsB,MAA1B,IAAI,EAAuB,KAAK,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CACb,+CAA+C,uBAAA,IAAI,sCAAW,IAAI,CACnE,CAAC;SACH;QACD,uBAAA,IAAI,sCAAW,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC;IAC7C,CAAC;IAoDD,SAAS,CAMP,KAAgB,EAChB,OAA8C,EAC9C,QAAkE;QAElE,IAAI,CAAC,uBAAA,IAAI,2EAAgB,MAApB,IAAI,EAAiB,KAAK,CAAC,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;SAC5D;QAED,IAAI,QAAQ,EAAE;YACZ,OAAO,uBAAA,IAAI,sCAAW,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;SAC5D;QACD,OAAO,uBAAA,IAAI,sCAAW,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAIT,KAAgB,EAAE,OAA8C;QAChE,IAAI,CAAC,uBAAA,IAAI,2EAAgB,MAApB,IAAI,EAAiB,KAAK,CAAC,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;SAC5D;QACD,uBAAA,IAAI,sCAAW,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;OAUG;IACH,uBAAuB,CAErB,KAAgB;QAChB,IAAI,CAAC,uBAAA,IAAI,iFAAsB,MAA1B,IAAI,EAAuB,KAAK,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CACb,6CAA6C,uBAAA,IAAI,sCAAW,IAAI,CACjE,CAAC;SACH;QACD,uBAAA,IAAI,sCAAW,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC;CAqDF;4UA1CG,SAAwB;IAIxB,uCAAuC;IACvC,MAAM,aAAa,GAAoB,uBAAA,IAAI,0CAAe,CAAC;IAC3D,OAAO,CACL,uBAAA,IAAI,iFAAsB,MAA1B,IAAI,EAAuB,SAAS,CAAC;QACrC,CAAC,aAAa,KAAK,IAAI,IAAI,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAC9D,CAAC;AACJ,CAAC,uFAWC,UAA0B;IAI1B,uCAAuC;IACvC,MAAM,cAAc,GAAoB,uBAAA,IAAI,2CAAgB,CAAC;IAC7D,OAAO,CACL,uBAAA,IAAI,iFAAsB,MAA1B,IAAI,EAAuB,UAAU,CAAC;QACtC,CAAC,cAAc,KAAK,IAAI,IAAI,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CACjE,CAAC;AACJ,CAAC,iGAQqB,IAAY;IAChC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,uBAAA,IAAI,sCAAW,GAAG,CAAC,CAAC;AAChD,CAAC","sourcesContent":["import type {\n  ActionConstraint,\n  ActionHandler,\n  Messenger,\n  EventConstraint,\n  ExtractActionParameters,\n  ExtractActionResponse,\n  ExtractEventHandler,\n  ExtractEventPayload,\n  NamespacedName,\n  NotNamespacedBy,\n  SelectorEventHandler,\n  SelectorFunction,\n} from './Messenger';\n\n/**\n * A universal supertype of all `RestrictedMessenger` instances. This type can be assigned to any\n * `RestrictedMessenger` type.\n *\n * @template Namespace - Name of the module this messenger is for. Optionally can be used to\n * narrow this type to a constraint for the messenger of a specific module.\n */\nexport type RestrictedMessengerConstraint<Namespace extends string = string> =\n  RestrictedMessenger<\n    Namespace,\n    ActionConstraint,\n    EventConstraint,\n    string,\n    string\n  >;\n\n/**\n * A restricted messenger.\n *\n * This acts as a wrapper around the 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 * This must not include internal actions that are in the messenger's namespace.\n * @template AllowedEvent - A type union of the 'type' string for any allowed events.\n * This must not include internal events that are in the messenger's namespace.\n */\nexport class RestrictedMessenger<\n  Namespace extends string,\n  Action extends ActionConstraint,\n  Event extends EventConstraint,\n  AllowedAction extends string,\n  AllowedEvent extends string,\n> {\n  readonly #messenger: Messenger<ActionConstraint, EventConstraint>;\n\n  readonly #namespace: Namespace;\n\n  readonly #allowedActions: NotNamespacedBy<Namespace, AllowedAction>[];\n\n  readonly #allowedEvents: NotNamespacedBy<Namespace, AllowedEvent>[];\n\n  /**\n   * Constructs a restricted 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 - Options.\n   * @param options.messenger - The 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 messenger returned.\n   * @param options.allowedActions - The list of actions that this restricted messenger should be\n   * allowed to call.\n   * @param options.allowedEvents - The list of events that this restricted messenger should be\n   * allowed to subscribe to.\n   */\n  constructor({\n    messenger,\n    name,\n    allowedActions,\n    allowedEvents,\n  }: {\n    messenger?: Messenger<ActionConstraint, EventConstraint>;\n    name: Namespace;\n    allowedActions: NotNamespacedBy<Namespace, AllowedAction>[];\n    allowedEvents: NotNamespacedBy<Namespace, AllowedEvent>[];\n  }) {\n    if (!messenger) {\n      throw new Error('Messenger not provided');\n    }\n    // The above condition guarantees that one of these options is defined.\n    this.#messenger = messenger;\n    this.#namespace = name;\n    this.#allowedActions = allowedActions;\n    this.#allowedEvents = allowedEvents;\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 unique 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<\n    ActionType extends Action['type'] & NamespacedName<Namespace>,\n  >(action: ActionType, handler: ActionHandler<Action, ActionType>) {\n    /* istanbul ignore if */ // Branch unreachable with valid types\n    if (!this.#isInCurrentNamespace(action)) {\n      throw new Error(\n        `Only allowed registering action handlers prefixed by '${\n          this.#namespace\n        }:'`,\n      );\n    }\n    this.#messenger.registerActionHandler(action, handler);\n  }\n\n  /**\n   * Registers action handlers for a list of methods on a messenger client\n   *\n   * @param messengerClient - The object that is expected to make use of the messenger.\n   * @param methodNames - The names of the methods on the messenger client to register as action\n   * handlers\n   */\n  registerMethodActionHandlers<\n    MessengerClient extends { name: string },\n    MethodNames extends keyof MessengerClient & string,\n  >(messengerClient: MessengerClient, methodNames: readonly MethodNames[]) {\n    this.#messenger.registerMethodActionHandlers(messengerClient, methodNames);\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 unique identifier for this action.\n   * @throws Will throw if an action handler that is not in the current namespace is being unregistered.\n   * @template ActionType - A type union of Action type strings that are namespaced by Namespace.\n   */\n  unregisterActionHandler<\n    ActionType extends Action['type'] & NamespacedName<Namespace>,\n  >(action: ActionType) {\n    /* istanbul ignore if */ // Branch unreachable with valid types\n    if (!this.#isInCurrentNamespace(action)) {\n      throw new Error(\n        `Only allowed unregistering action handlers prefixed by '${\n          this.#namespace\n        }:'`,\n      );\n    }\n    this.#messenger.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 actionType - The action type. This is a unique 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<\n    ActionType extends\n      | AllowedAction\n      | (Action['type'] & NamespacedName<Namespace>),\n  >(\n    actionType: ActionType,\n    ...params: ExtractActionParameters<Action, ActionType>\n  ): ExtractActionResponse<Action, ActionType> {\n    if (!this.#isAllowedAction(actionType)) {\n      throw new Error(`Action missing from allow list: ${actionType}`);\n    }\n    const response = this.#messenger.call<ActionType>(actionType, ...params);\n\n    return response;\n  }\n\n  /**\n   * Register a function for getting the initial payload for an event.\n   *\n   * This is used for events that represent a state change, where the payload is the state.\n   * Registering a function for getting the payload allows event selectors to have a point of\n   * comparison the first time state changes.\n   *\n   * The event type *must* be in the current namespace\n   *\n   * @param args - The arguments to this function\n   * @param args.eventType - The event type to register a payload for.\n   * @param args.getPayload - A function for retrieving the event payload.\n   */\n  registerInitialEventPayload<\n    EventType extends Event['type'] & NamespacedName<Namespace>,\n  >({\n    eventType,\n    getPayload,\n  }: {\n    eventType: EventType;\n    getPayload: () => ExtractEventPayload<Event, EventType>;\n  }) {\n    /* istanbul ignore if */ // Branch unreachable with valid types\n    if (!this.#isInCurrentNamespace(eventType)) {\n      throw new Error(\n        `Only allowed publishing events prefixed by '${this.#namespace}:'`,\n      );\n    }\n    this.#messenger.registerInitialEventPayload({\n      eventType,\n      getPayload,\n    });\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   * @throws Will throw if an event that is not in the current namespace is being published.\n   * @template EventType - A type union of Event type strings that are namespaced by Namespace.\n   */\n  publish<EventType extends Event['type'] & NamespacedName<Namespace>>(\n    event: EventType,\n    ...payload: ExtractEventPayload<Event, EventType>\n  ) {\n    /* istanbul ignore if */ // Branch unreachable with valid types\n    if (!this.#isInCurrentNamespace(event)) {\n      throw new Error(\n        `Only allowed publishing events prefixed by '${this.#namespace}:'`,\n      );\n    }\n    this.#messenger.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   * @throws Will throw if the given event is not an allowed event for this messenger.\n   * @template EventType - A type union of Event type strings.\n   */\n  subscribe<\n    EventType extends\n      | AllowedEvent\n      | (Event['type'] & NamespacedName<Namespace>),\n  >(eventType: EventType, handler: ExtractEventHandler<Event, EventType>): 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   * @throws Will throw if the given event is not an allowed event for this messenger.\n   * @template EventType - A type union of Event type strings.\n   * @template SelectorReturnValue - The selector return value.\n   */\n  subscribe<\n    EventType extends\n      | AllowedEvent\n      | (Event['type'] & NamespacedName<Namespace>),\n    SelectorReturnValue,\n  >(\n    eventType: EventType,\n    handler: SelectorEventHandler<SelectorReturnValue>,\n    selector: SelectorFunction<Event, EventType, SelectorReturnValue>,\n  ): void;\n\n  subscribe<\n    EventType extends\n      | AllowedEvent\n      | (Event['type'] & NamespacedName<Namespace>),\n    SelectorReturnValue,\n  >(\n    event: EventType,\n    handler: ExtractEventHandler<Event, EventType>,\n    selector?: SelectorFunction<Event, EventType, SelectorReturnValue>,\n  ) {\n    if (!this.#isAllowedEvent(event)) {\n      throw new Error(`Event missing from allow list: ${event}`);\n    }\n\n    if (selector) {\n      return this.#messenger.subscribe(event, handler, selector);\n    }\n    return this.#messenger.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 if the given event is not an allowed event for this messenger.\n   * @template EventType - A type union of allowed Event type strings.\n   */\n  unsubscribe<\n    EventType extends\n      | AllowedEvent\n      | (Event['type'] & NamespacedName<Namespace>),\n  >(event: EventType, handler: ExtractEventHandler<Event, EventType>) {\n    if (!this.#isAllowedEvent(event)) {\n      throw new Error(`Event missing from allow list: ${event}`);\n    }\n    this.#messenger.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   * @throws Will throw if a subscription for an event that is not in the current namespace is being cleared.\n   * @template EventType - A type union of Event type strings that are namespaced by Namespace.\n   */\n  clearEventSubscriptions<\n    EventType extends Event['type'] & NamespacedName<Namespace>,\n  >(event: EventType) {\n    if (!this.#isInCurrentNamespace(event)) {\n      throw new Error(\n        `Only allowed clearing events prefixed by '${this.#namespace}:'`,\n      );\n    }\n    this.#messenger.clearEventSubscriptions(event);\n  }\n\n  /**\n   * Determine whether the given event type is allowed. Event types are\n   * allowed if they are in the current namespace or on the list of\n   * allowed events.\n   *\n   * @param eventType - The event type to check.\n   * @returns Whether the event type is allowed.\n   */\n  #isAllowedEvent(\n    eventType: Event['type'],\n  ): eventType is\n    | NamespacedName<Namespace>\n    | NotNamespacedBy<Namespace, AllowedEvent> {\n    // Safely upcast to allow runtime check\n    const allowedEvents: string[] | null = this.#allowedEvents;\n    return (\n      this.#isInCurrentNamespace(eventType) ||\n      (allowedEvents !== null && allowedEvents.includes(eventType))\n    );\n  }\n\n  /**\n   * Determine whether the given action type is allowed. Action types\n   * are allowed if they are in the current namespace or on the list of\n   * allowed actions.\n   *\n   * @param actionType - The action type to check.\n   * @returns Whether the action type is allowed.\n   */\n  #isAllowedAction(\n    actionType: Action['type'],\n  ): actionType is\n    | NamespacedName<Namespace>\n    | NotNamespacedBy<Namespace, AllowedAction> {\n    // Safely upcast to allow runtime check\n    const allowedActions: string[] | null = this.#allowedActions;\n    return (\n      this.#isInCurrentNamespace(actionType) ||\n      (allowedActions !== null && allowedActions.includes(actionType))\n    );\n  }\n\n  /**\n   * Determine whether the given name is within the current namespace.\n   *\n   * @param name - The name to check\n   * @returns Whether the name is within the current namespace\n   */\n  #isInCurrentNamespace(name: string): name is NamespacedName<Namespace> {\n    return name.startsWith(`${this.#namespace}:`);\n  }\n}\n"]}

package/dist/index.cjs

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestrictedMessenger = exports.Messenger = void 0;
+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

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAcA,6CAAwC;AAA/B,sGAAA,SAAS,OAAA;AAElB,iEAA4D;AAAnD,0HAAA,mBAAmB,OAAA","sourcesContent":["export 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"]}

package/dist/index.d.cts

@@ -0,0 +1,5 @@
+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";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,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"}

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+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";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,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"}

package/dist/index.mjs

@@ -0,0 +1,3 @@
+export { Messenger } from "./Messenger.mjs";
+export { RestrictedMessenger } from "./RestrictedMessenger.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,SAAS,EAAE,wBAAoB;AAExC,OAAO,EAAE,mBAAmB,EAAE,kCAA8B","sourcesContent":["export 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"]}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@metamask-previews/messenger",
+  "version": "0.0.0-preview-3713f9f",
+  "description": "A type-safe message bus library",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/messenger#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/messenger",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/messenger",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "immer": "^9.0.6",
+    "jest": "^27.5.1",
+    "sinon": "^9.2.4",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}