@seedcord/gateway 0.8.0-next.0 → 0.9.0-next.0

package/dist/index.d.mts

@@ -1,21 +1,21 @@
 import "reflect-metadata";
+import { InFlight } from "@seedcord/core/node/internal";
 import { WinstonConsoleSink, WinstonFileSink } from "@seedcord/logger/node";
 import { AutocompletableNames, AutocompleteRouteBrand, CacheFor, ChoiceValueOf, CommandRegistry, ComponentDefsBrand, ComponentKindBrand, ContextMenuKindBrand, ContextMenuLeaves, ContextMenuNamesBrand, EntryFor, FixedScope, FocusedField, GateFitsWith, HasComponentDefs, Initializeable, MatchArms, MenuCacheFor, MiddlewareKindsBrand, NamesFor, PageCursor, SingleParams, SlashOptions as SlashOptions$1, SlashRouteBrand } from "@seedcord/core/internal";
 import { ArraySourceBase, AutocompleteOptions, BaseHandler as BaseHandler$1, BaseReplySender, Bus, CoreBase, CursorSourceBase, DispatchContext, DispatchOutcome, DispatchResult, EventDispatchResult, Gate, GateContextBase, GateNoticeOptions, GuildPermissionsContext, HandlerOutcome, InteractionKind, MiddlewareKind, ModalLike, Notice, PageSourceBase, PaginatorBase, PaginatorConfig, PermissionNoticeOverrides, PermissionScope, RepliableHandler as RepliableHandler$1, RequiredOf, ResolvedEmoji, SlashRegistry, Subscriber as Subscriber$1, SubscriptionKey, WebhookLog as WebhookLog$1 } from "@seedcord/core";
 import { Logger } from "@seedcord/logger";
 import { APIInteractionGuildMember, APIModalInteractionResponseCallbackData, AnySelectMenuInteraction, ApplicationCommandOptionChoiceData, ApplicationCommandType, ApplicationEmoji, AutocompleteInteraction, BaseMessageOptions, BooleanCache, ButtonInteraction, ButtonStyle, CacheType, CacheTypeReducer, ChannelSelectMenuInteraction, ChatInputCommandInteraction, Client, ClientEvents, ClientOptions, CommandInteractionOption, ContextMenuCommandInteraction, Events, Guild, GuildEmoji, GuildMember, Interaction, MentionableSelectMenuInteraction, Message, MessageContextMenuCommandInteraction, ModalSubmitFields, ModalSubmitInteraction, Role, RoleSelectMenuInteraction, StringSelectMenuInteraction, TextChannel, User, UserContextMenuCommandInteraction, UserSelectMenuInteraction } from "discord.js";
 import { Plugin as Plugin$1, PluginLifecycleSpec, PluginOptions, PluginOptions as PluginOptions$1 } from "@seedcord/core/plugin";
-import { CoordinatedShutdown, CoordinatedStartup, ServerHost } from "@seedcord/core/node";
+import { ServerHost, ShutdownTasks, StartupTasks } from "@seedcord/core/node";
 import { HostAugmentTarget, HostVersion, SeedcordBrand, SeedcordInstance } from "@seedcord/types/internal";
 import { HmrModuleHandler } from "@seedcord/core/hmr";
 import { AnyCustomId } from "@seedcord/custom-id";
-import { BotConfig, Config, DeferOpts, EmojiMap, EventFrequency, HealthCheckOption, HmrAware, HmrUpdateEvent, IRateLimiter, ReplyResponse, SendOpts, TypedOmit } from "@seedcord/types";
+import { BotConfig, Config, DeferOpts, EmojiMap, EventFrequency, HealthCheckOption, HmrAware, HmrUpdateEvent, ReplyResponse, SendOpts, TypedOmit } from "@seedcord/types";
 import { Constructor, IsUnion, NonEmptyTuple, Promisable } from "type-fest";
 import { REST } from "@discordjs/rest";
 export * from "@seedcord/errors";
 export * from "@seedcord/core";
 export * from "@seedcord/logger";
-export * from "@seedcord/rate-limiter";
 export * from "@seedcord/utils";
 export * from "@seedcord/event-emitter";
 export type * from "@seedcord/types";
@@ -33,11 +33,11 @@ declare module '@seedcord/core/internal' {
       args: ClientEvents[Name];
     }; }[keyof ClientEvents];
     /**
-     * Triggered once an event's handlers settle, pairing with `eventDispatching`. A fire that runs no
-     * handler triggers neither.
+     * Published once an event's handlers settle, pairing with `eventDispatching`. When no handlers
+     * are registered, neither key is published.
      */
     eventDispatched: {
-      /** The same id `eventDispatching` published for this fire. */
+      /** The same id `eventDispatching` published for this dispatch. */
       dispatchId: string;
       name: keyof ClientEvents;
       /** How the middleware chain ended. A chain that refused the event leaves `handlers` empty. */
@@ -102,18 +102,18 @@ interface GatewayConfig extends Config {
  */
 declare class EventDispatcher implements Initializeable, HmrAware {
   protected core: Core;
+  private readonly inFlight;
   private readonly logger;
   private isInitialized;
   private readonly eventMap;
   private readonly middlewares;
-  private readonly executedOnceHandlers;
+  private readonly onceRuns;
   private readonly attachedEvents;
-  private readonly inFlight;
   private loading;
   private readonly loadedHandlers;
   private readonly loadedMiddlewares;
   private readonly hmrHandler?;
-  constructor(core: Core);
+  constructor(core: Core, inFlight: InFlight);
   private getArtifacts;
   init(): Promise<void>;
   private reportLoad;
@@ -130,8 +130,7 @@ declare class EventDispatcher implements Initializeable, HmrAware {
   private registerHandler;
   private attachToClient;
   private attachListener;
-  stopAccepting(): void;
-  drain(timeoutMs: number): Promise<void>;
+  private reportUnhandled;
   private processEvent;
   private processHandler;
 }
@@ -139,18 +138,18 @@ declare class EventDispatcher implements Initializeable, HmrAware {
 //#region src/bot/controllers/InteractionDispatcher.d.ts
 declare class InteractionDispatcher implements Initializeable, HmrAware {
   protected core: Core;
+  private readonly inFlight;
   private readonly logger;
   private isInitialized;
   private readonly maps;
   private readonly handlerFiles;
   private readonly keysToIgnore;
   private readonly middlewares;
-  private readonly inFlight;
   private loading;
   private readonly loadedHandlers;
   private readonly loadedMiddlewares;
   private readonly hmrHandler?;
-  constructor(core: Core);
+  constructor(core: Core, inFlight: InFlight);
   warnUnhandledRoutes(commandLeaves: Iterable<string>): void;
   warnUnhandledContextMenuRoutes(leaves: ContextMenuLeaves): void;
   private getArtifacts;
@@ -166,8 +165,6 @@ declare class InteractionDispatcher implements Initializeable, HmrAware {
   private unregisterHandler;
   private unregisterMiddleware;
   private attachToClient;
-  stopAccepting(): void;
-  drain(timeoutMs: number): Promise<void>;
   private handleCustomIdInteraction;
   private processInteraction;
   private answer;
@@ -236,8 +233,8 @@ declare class Bot implements HmrAware {
  * ```
  * */
 interface Core extends CoreBase {
-  readonly shutdown: Pick<CoordinatedShutdown, 'addTask'>;
-  readonly startup: Pick<CoordinatedStartup, 'addTask'>;
+  readonly shutdown: ShutdownTasks;
+  readonly startup: StartupTasks;
   readonly bot: Bot;
   readonly config: GatewayConfig;
 }
@@ -313,7 +310,7 @@ export declare abstract class EventHandler<in out Names extends ValidNonInteract
   constructor(event: ClientEvents[Names], core: Core, dispatch: DispatchContext, eventName?: Names);
   protected readonly event: SingleEventPayload<Names>;
   /**
-   * Run the arm for whichever event fired. Use this only when the handler is registered for several
+   * Run the arm for the current event. Use this only when the handler is registered for several
    * events. A single-event handler reads `this.event` directly. On a multi-event handler `this.event` is
    * `never`, so match is the only way to read the payload.
    *
@@ -357,7 +354,7 @@ export declare abstract class EventMiddleware<in out EventName extends ValidNonI
   constructor(event: ClientEvents[EventName], core: Core, dispatch: DispatchContext, eventName?: EventName);
   protected readonly event: SingleEventPayload<EventName>;
   /**
-   * The event that fired this middleware. Read it on a catchall or multi-event middleware, where `this.event`
+   * The name of the event being processed. Read it on a catchall or multi-event middleware, where `this.event`
    * is `never`, to do work that does not depend on the payload shape. A single-event middleware reads
    * `this.event` directly and does not need this.
    */
@@ -536,7 +533,7 @@ interface InteractionGateContext<Repliable extends Repliables = Repliables> exte
  * annotation, so a gate that reads one event's `payload` is rejected on a handler for a different
  * event. The default supports every event.
  *
- * @typeParam Names - The event name or names the gate reads, typing `payload` to that event's args tuple.
+ * @typeParam Names - One event or a union of the events the gate reads. `payload` gets that event's args tuple.
  *
  * @example
  * ```ts
@@ -600,7 +597,7 @@ type FitAll<TCtor extends AnyHandlerCtor, Gates extends readonly Gate<GateContex
  * Attaches gates to a handler. The gates run before `execute`, and a gate refusing stops the handler with
  * the reply or drop the gate threw. Multiple gates are ANDed, so each must pass. A gate that requires a
  * context the handler does not provide (a button gate on a slash handler, an interaction gate on an event
- * handler) is a compile error at this line, and the error names the gate and the handler kind. Place it
+ * handler) is a compile error at this line, and the error message shows the gate and the handler kind. Place it
  * above the route decorator.
  *
  * Combine gates with {@link and} or {@link or} to build a single gate from multiple arms.
@@ -1094,6 +1091,8 @@ type SlashMatchArms<Route extends keyof SlashRegistry, Cache extends CacheType,
 export declare abstract class SlashHandler<Route extends keyof SlashRegistry, Cache extends CacheType = CacheFor<Route>> extends InteractionHandler<ChatInputCommandInteraction<Cache>> {
   /** @internal */
   readonly [SlashRouteBrand]?: Route;
+  /** The selected command's path, such as `search/docs`. */
+  protected get route(): Route;
   /**
    * The typed options for this command's route. Only the getters for kinds this command declares appear.
    * Each getter's name argument is restricted to that command's options of its kind.
@@ -1109,7 +1108,7 @@ export declare abstract class SlashHandler<Route extends keyof SlashRegistry, Ca
    */
   protected get options(): SlashOptions<Route, Cache>;
   /**
-   * Run the arm for whichever command fired. Use this only when the handler is registered for several
+   * Run the arm for the selected command. Use this only when the handler is registered for several
    * routes.
    *
    * Provide one arm per registered route, keyed by its route string, and each arm receives that route's
@@ -1165,10 +1164,10 @@ export declare abstract class UserContextMenuHandler<Names extends NamesFor<Appl
   protected get target(): User;
   /** The right-clicked user's guild member, null outside a guild. */
   protected get targetMember(): CacheTypeReducer<Cache, GuildMember, APIInteractionGuildMember> | null;
-  /** Which of the registered commands fired. */
-  protected get commandName(): Names;
+  /** The selected context-menu command's name, without the interaction-kind prefix. */
+  protected get route(): Names;
   /**
-   * Run the arm for whichever command fired. Use this only when the handler is registered for several
+   * Run the arm for the selected command. Use this only when the handler is registered for several
    * names.
    *
    * Provide one arm per registered name, keyed by the name Discord shows in the right-click menu. Each
@@ -1219,10 +1218,10 @@ export declare abstract class MessageContextMenuHandler<Names extends NamesFor<A
   /** @internal */
   readonly [ContextMenuNamesBrand]?: Names;
   protected get target(): Message<BooleanCache<Cache>>;
-  /** Which of the registered commands fired. */
-  protected get commandName(): Names;
+  /** The selected context-menu command's name, without the interaction-kind prefix. */
+  protected get route(): Names;
   /**
-   * Run the arm for whichever command fired. Use this only when the handler is registered for several
+   * Run the arm for the selected command. Use this only when the handler is registered for several
    * names.
    *
    * Provide one arm per registered name, keyed by the name Discord shows in the right-click menu. Each
@@ -1255,7 +1254,7 @@ type FocusedArms<Route extends keyof SlashRegistry, Ret> = { [Name in Autocomple
  *
  * Pass the command route(s) from the generated registry as the generic, the same string(s) as
  * `@AutocompleteRoute`. Branch on the focused field with `this.match`, read already-entered sibling options
- * with `this.options`, and find which command fired with `this.route`.
+ * with `this.options`, and read the selected command's path from `this.route`.
  *
  * @typeParam Route - One or more route keys from {@link SlashRegistry}, e.g. `'search'` or `'search' | 'find'`.
  * @typeParam Cache - The interaction cache state. The command's contexts set it.
@@ -1310,7 +1309,7 @@ export declare abstract class AutocompleteHandler<Route extends keyof SlashRegis
   protected match<Ret>(arms: FocusedArms<Route, Ret>): Promise<Ret>;
   /** Send autocomplete suggestions, callback type 8. Prefer {@link match}, which restricts each field's choices to its declared type. */
   protected respond(choices: readonly ApplicationCommandOptionChoiceData[]): Promise<void>;
-  /** The firing command route, for a field whose completion differs per registered command. */
+  /** The selected command's path, such as `search/docs`, without the interaction-kind prefix. */
   protected get route(): Route;
   /**
    * The already-entered options on this command, restricted to the kinds Discord resolves during autocomplete
@@ -1339,7 +1338,14 @@ export declare abstract class ComponentHandler<Event extends ComponentInteractio
   /** Acknowledge the component without changing the source message. */
   protected deferUpdate(): Promise<void>;
   private decoded?;
-  private get route();
+  private get decodedRoute();
+  /**
+   * The matched custom-ID prefix, such as `approve`, without encoded params.
+   *
+   * @throws A **StaleCustomId** when the wire was encoded under an older shape.
+   * @throws An **InvalidCustomId** when the wire is corrupt.
+   */
+  protected get route(): Defs[number]['prefix'];
   /**
    * The decoded params of the single route this handler is registered for.
    *
@@ -1738,16 +1744,12 @@ export declare class Seedcord extends ServerHost<'gateway'> implements SeedcordI
   readonly [HostAugmentTarget] = "@seedcord/gateway";
   /** @internal */
   readonly [HostVersion]: string;
-  /** @see {@link Bus} */
-  readonly bus: Bus;
   /** @see {@link Bot} */
   readonly bot: Bot;
   /** The discord.js client's REST client. Its token is set during the Login phase. */
   readonly rest: REST;
   /** The bot's Discord application id. Throws if you read it before login. */
   get applicationId(): string;
-  /** @see {@link IRateLimiter} */
-  readonly rateLimiter: IRateLimiter;
   /**
    * @param config - Bot configuration including paths and Discord client options
    * @throws A **SeedcordError** when another `Seedcord` exists in this process and has not shut down.