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

package/dist/RestrictedMessenger.d.cts

@@ -1,200 +0,0 @@
-import type { ActionConstraint, ActionHandler, Messenger, EventConstraint, ExtractActionParameters, ExtractActionResponse, ExtractEventHandler, ExtractEventPayload, NamespacedName, NotNamespacedBy, SelectorEventHandler, SelectorFunction } from "./Messenger.cjs";
-/**
- * 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.
-     * @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 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.
-     * @template EventType - A type union of Event type strings.
-     */
-    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.
-     * @template SelectorReturnValue - The selector return value.
-     */
-    unsubscribe<EventType extends AllowedEvent | (Event['type'] & NamespacedName<Namespace>), SelectorReturnValue = unknown>(event: EventType, handler: ExtractEventHandler<Event, EventType> | SelectorEventHandler<SelectorReturnValue>): 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.cts.map

package/dist/RestrictedMessenger.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RestrictedMessenger.d.cts","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;;;;;;;;OAQG;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;;;;;;;;;;;;;OAaG;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;IA2BP;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,SAAS,SACL,YAAY,GACZ,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAC/C,mBAAmB,GAAG,OAAO,EAE7B,KAAK,EAAE,SAAS,EAChB,OAAO,EACH,mBAAmB,CAAC,KAAK,EAAE,SAAS,CAAC,GACrC,oBAAoB,CAAC,mBAAmB,CAAC;IAQ/C;;;;;;;;;;OAUG;IACH,uBAAuB,CACrB,SAAS,SAAS,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EAC3D,KAAK,EAAE,SAAS;CA4DnB"}

package/dist/RestrictedMessenger.d.mts

@@ -1,200 +0,0 @@
-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.
-     * @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 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.
-     * @template EventType - A type union of Event type strings.
-     */
-    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.
-     * @template SelectorReturnValue - The selector return value.
-     */
-    unsubscribe<EventType extends AllowedEvent | (Event['type'] & NamespacedName<Namespace>), SelectorReturnValue = unknown>(event: EventType, handler: ExtractEventHandler<Event, EventType> | SelectorEventHandler<SelectorReturnValue>): 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

@@ -1 +0,0 @@
-{"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;;;;;;;;OAQG;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;;;;;;;;;;;;;OAaG;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;IA2BP;;;;;;;;;;;;OAYG;IACH,WAAW,CACT,SAAS,SACL,YAAY,GACZ,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAC/C,mBAAmB,GAAG,OAAO,EAE7B,KAAK,EAAE,SAAS,EAChB,OAAO,EACH,mBAAmB,CAAC,KAAK,EAAE,SAAS,CAAC,GACrC,oBAAoB,CAAC,mBAAmB,CAAC;IAQ/C;;;;;;;;;;OAUG;IACH,uBAAuB,CACrB,SAAS,SAAS,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EAC3D,KAAK,EAAE,SAAS;CA4DnB"}

package/dist/RestrictedMessenger.mjs

@@ -1,238 +0,0 @@
-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.
-     * @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) {
-        __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.
-     * @template EventType - A type union of Event type strings.
-     */
-    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.
-     * @template SelectorReturnValue - The selector return value.
-     */
-    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