@seedcord/gateway 0.1.0-next.3 → 0.1.0-next.4

package/dist/index.d.mts

@@ -1,22 +1,31 @@
 import { AnyCustomId, AutocompletableNames, BaseReplySender, ChoiceValueOf, EntryFor, FocusedField, GateFitsWith, HasComponentDefs, MatchArms, ModalLike, PageCursor, SingleParams, SlashOptions as SlashOptions$1 } from "@seedcord/core/internal";
-import { AutocompleteOptions, BaseHandler, BuilderComponent, CoreBase, DispatchContext, Gate, GateContextBase, GateNoticeOptions, GuildPermissionsContext, Notice, PageView, PermissionScope, RepliableHandler as RepliableHandler$1, RequiredOf, SelectMenuKind, SlashOptionRegistry } from "@seedcord/core";
+import { AutocompleteOptions, BaseHandler, BuilderComponent, CoreBase, DispatchContext, Gate, GateContextBase, GateNoticeOptions, GuildPermissionsContext, Initializeable, Notice, PageView, PermissionScope, RepliableHandler as RepliableHandler$1, RequiredOf, SelectMenuKind, SlashOptionRegistry } from "@seedcord/core";
 import { Logger } from "@seedcord/logger";
 import { ActionRowBuilder, ButtonBuilder, ContextMenuCommandBuilder, SlashCommandBuilder } from "@discordjs/builders";
 import { APIInteractionGuildMember, APIMessageComponentEmoji, APIModalInteractionResponseCallbackData, AnySelectMenuInteraction, ApplicationCommand, ApplicationCommandOptionChoiceData, ApplicationCommandType, ApplicationEmoji, AutocompleteInteraction, BooleanCache, ButtonInteraction, ButtonStyle, CacheType, CacheTypeReducer, ChannelSelectMenuInteraction, ChatInputCommandInteraction, Client, ClientEvents, ClientOptions, Collection, CommandInteractionOption, ContextMenuCommandInteraction, Events, Guild, GuildEmoji, GuildMember, Interaction, MentionableSelectMenuInteraction, Message, MessageContextMenuCommandInteraction, ModalSubmitInteraction, Role, RoleSelectMenuInteraction, Snowflake, StringSelectMenuInteraction, TextChannel, TextChannelResolvable, User, UserContextMenuCommandInteraction, UserSelectMenuInteraction } from "discord.js";
 import { UUID } from "node:crypto";
-import { EventMap, NoEvents, TypedEventEmitter } from "@seedcord/event-emitter";
 import { APIMessageTopLevelComponent } from "discord-api-types/v10";
-import { CoordinatedShutdown, CoordinatedStartup, ShutdownPhase, StartupPhase, StartupPhase as StartupPhase$1 } from "@seedcord/core/node";
+import { REST } from "@discordjs/rest";
+import { CoordinatedShutdown, CoordinatedStartup, Pluggable, PluginCapabilities } from "@seedcord/core/node/internal";
 import { SeedcordBrand, SeedcordInstance } from "@seedcord/types/internal";
-import { BotConfig, Config, DeferOpts, EmojiMap, HmrAware, HmrUpdateEvent, IRateLimiter, ReplyResponse, SendOpts, Tail, V2Component } from "@seedcord/types";
+import { TypedEventEmitter } from "@seedcord/event-emitter";
+import { BotConfig, Config, DeferOpts, EmojiMap, HealthCheckOption, HmrAware, HmrUpdateEvent, IRateLimiter, ReplyResponse, SendOpts, V2Component } from "@seedcord/types";
 export * from "@seedcord/errors";
 export * from "@seedcord/core";
 export * from "@seedcord/logger";
-export * from "@seedcord/event-emitter";
 export * from "@seedcord/utils";
 export * from "@seedcord/rate-limiter";
+export * from "@seedcord/event-emitter";
 export type * from "@seedcord/types";
 
+//#region src/plugin-capabilities.d.ts
+declare module '@seedcord/core' {
+  interface PluginCapabilityTypes {
+    client: Client;
+    rest: REST;
+  }
+}
+//#endregion
 //#region src/bot/utilities/miscellaneous/contextMenuLeaves.d.ts
 /** The registered context-menu command names, split by kind, deduplicated. @internal */
 interface ContextMenuLeaves {
@@ -56,93 +65,13 @@ interface GatewayBotConfig extends BotConfig {
  */
 interface GatewayConfig extends Config {
   bot: GatewayBotConfig;
-}
-//#endregion
-//#region src/interfaces/Plugin.d.ts
-interface Initializeable {
-  init(): Promise<void>;
-}
-/**
- * Base class for Seedcord plugins
- *
- * Extend this class to create plugins that integrate with the Seedcord lifecycle.
- * Plugins have access to the core instance and must implement initialization logic.
- */
-declare abstract class Plugin<TPluginEvents extends EventMap<TPluginEvents> = NoEvents> extends TypedEventEmitter<TPluginEvents> implements Initializeable, HmrAware {
-  protected pluggable: Core;
-  abstract logger: Logger;
-  name: string;
-  constructor(pluggable: Core);
-  /** @virtual */
-  abstract init(): Promise<void>;
+  /** The gateway websocket requires a persistent process, so `'server'` is the only value. */
+  runtime?: 'server';
   /**
-   * Reloads plugin state on an HMR update. The base implementation is a no-op, override it in your plugin.
-   * @virtual
+   * The health-check server. `false` disables it, `true` or omit for the defaults, an object
+   * configures it.
    */
-  onHmr(_event: HmrUpdateEvent): Promise<void>;
-  /**
-   * Registers critical file patterns that should trigger a full restart when changed in Dev HMR.
-   * @param patterns - Glob patterns relative to the project root
-   */
-  protected registerCriticalFiles(patterns: string[]): void;
-  /** @internal */
-  removeListener<TEventKey extends Extract<keyof TPluginEvents, string | symbol>>(event: TEventKey, listener: (...args: TPluginEvents[TEventKey]) => void): this;
-  /** @internal */
-  removeAllListeners(event?: Extract<keyof TPluginEvents, string | symbol>): this;
-}
-/**
- * Constructor type for plugins that can accept extra arguments after Core.
- *
- * @internal
- */
-type PluginCtor<TPlugin extends Plugin = Plugin> = new (core: Core, ...args: any[]) => TPlugin;
-/**
- * Extracts the argument types for a plugin constructor, excluding the Core parameter.
- *
- * @internal
- */
-type PluginArgs<Ctor extends PluginCtor> = Tail<ConstructorParameters<Ctor>>;
-/**
- * Base class for objects that can have plugins attached.
- *
- * Provides plugin attachment capabilities and lifecycle management. Plugins are attached during
- * configuration and initialized during startup. Not constructed directly, the host is a {@link Seedcord}.
- */
-declare class Pluggable<TPluggableEvents extends EventMap<TPluggableEvents> = NoEvents> extends TypedEventEmitter<TPluggableEvents> {
-  protected isInitialized: boolean;
-  protected readonly shutdown: CoordinatedShutdown;
-  protected readonly startup: CoordinatedStartup;
-  protected readonly plugins: Plugin[];
-  private static readonly PLUGIN_INIT_TIMEOUT_MS;
-  constructor(shutdown: CoordinatedShutdown, startup: CoordinatedStartup);
-  /** @internal */
-  protected init(): Promise<this>;
-  /**
-   * Attaches a plugin to this instance
-   *
-   * Plugins provide external functionality and are initialized during the specified startup phase.
-   * The plugin instance becomes available as a property in `core` wherever it's available.
-   *
-   * Make sure to augment the {@link Core} interface with the plugin type to ensure TypeScript recognizes it and provides intellisense.
-   *
-   * @typeParam Key - The property name for accessing the plugin
-   * @typeParam Ctor - The plugin constructor type
-   * @param key - Property name to access the plugin instance
-   * @param Plugin - Plugin constructor class
-   * @param startupPhase - When during startup to initialize this plugin ({@link StartupPhase})
-   * @param args - Additional arguments to pass to the plugin constructor
-   * @returns This instance with the plugin attached as a typed property
-   * @throws A **SeedcordError** When called after initialization or if key already exists
-   * @example
-   * ```typescript
-   * seedcord.attach('db', Mongo, StartupPhase.Configuration, { uri: 'mongodb://...', name: 'seedcord', dir: ... })
-   * ```
-   */
-  attach<Key extends string, Ctor extends PluginCtor>(this: this, key: Key, Plugin: Ctor, startupPhase: StartupPhase$1, ...args: PluginArgs<Ctor>): this & Record<Key, InstanceType<Ctor>>;
-  /** @internal */
-  removeListener<TEventKey extends Extract<keyof TPluggableEvents, string | symbol>>(event: TEventKey, listener: (...args: TPluggableEvents[TEventKey]) => void): this;
-  /** @internal */
-  removeAllListeners(event?: Extract<keyof TPluggableEvents, string | symbol>): this;
+  healthCheck?: HealthCheckOption;
 }
 //#endregion
 //#region src/subscribers/types/Subscriptions.d.ts
@@ -237,11 +166,9 @@ type SubscriptionTuples = { [K in SubscriptionKey]: [AllSubscriptions[K]] };
  * Registers and dispatches subscribers. Subscribers load from the configured directories and run
  * on a programmatic or framework-event publish. Accessed via `core.bus`. Do not construct it directly.
  */
-declare class Bus extends Plugin<SubscriptionTuples> {
+declare class Bus extends TypedEventEmitter<SubscriptionTuples> implements Initializeable, HmrAware {
   protected core: Core;
   readonly logger: Logger;
-  /** @internal */
-  readonly name = "Subscribers";
   private isInitialized;
   private readonly subscribersMap;
   private readonly executedOnceHandlers;
@@ -317,7 +244,6 @@ interface DeployResult {
 declare class CommandRegistry implements Initializeable, HmrAware {
   private readonly core;
   private readonly onDeployed?;
-  readonly name = "Commands";
   private readonly logger;
   private isInitialised;
   readonly globalCommands: (SlashCommandBuilder | ContextMenuCommandBuilder)[];
@@ -389,11 +315,9 @@ interface BotEvents {
   ready: [];
 }
 /**
- * Discord bot implementation that manages client and controllers
- *
- * Don't instantiate this class directly. Use `core.bot` instead.
+ * The Discord client and its controllers. Access it through `core.bot`.
  */
-declare class Bot extends Plugin<BotEvents> {
+declare class Bot extends TypedEventEmitter<BotEvents> implements Initializeable, HmrAware {
   readonly botToken: string;
   /** @internal */
   readonly logger: Logger;
@@ -401,39 +325,25 @@ declare class Bot extends Plugin<BotEvents> {
   private readonly _client;
   private readonly interactions?;
   private readonly events?;
-  readonly commands?: CommandRegistry;
   private readonly emojiInjector;
+  readonly commands?: CommandRegistry;
   readonly emojis: InjectedEmojiMap;
   readonly mentions: InjectedMentionMap;
-  /** @internal For use in dev mode */
+  /** @internal */
   onHmr(event: HmrUpdateEvent): Promise<void>;
   /** @internal */
   constructor(core: Core);
-  /**
-   * Initializes Discord client and all controllers
-   * @internal
-   */
+  private registerShutdownTasks;
+  private stopAccepting;
+  private drain;
+  /** @internal */
   init(): Promise<void>;
-  /**
-   * Stops the bot and cleans up connections
-   * @internal
-   */
+  /** @internal */
   stop(): Promise<void>;
-  /**
-   * Logs the bot into Discord using the configured token
-   */
   private login;
-  /**
-   * Logs out and destroys the Discord client connection
-   */
   private logout;
   get client(): Client;
-  /**
-   * Emits a Discord event with its argument tuple. The overloads enforce the key/args correlation
-   * at compile time only; at runtime this forwards straight to the underlying EventEmitter.
-   *
-   * @internal
-   */
+  /** @internal */
   emit<TKey extends keyof ClientEvents>(event: 'any:event', name: TKey, ...args: ClientEvents[TKey]): boolean;
   /** @internal */
   emit<TEventKey extends keyof BotEvents>(event: TEventKey, ...args: BotEvents[TEventKey]): boolean;
@@ -2138,10 +2048,8 @@ declare function WebhookUrl(envKey: string): <HandlerCtor extends Constructor<We
 //#endregion
 //#region src/Seedcord.d.ts
 /**
- * Main Seedcord bot framework class
- *
- * Primary entry point for creating Discord bots with Seedcord.
- * Manages component lifecycle and provides plugin support.
+ * The gateway bot host. Opens a discord.js gateway session, discovers handlers, and runs
+ * coordinated startup and shutdown. Attach plugins with `attach()`.
  */
 declare class Seedcord extends Pluggable implements Core {
   readonly config: GatewayConfig;
@@ -2151,8 +2059,7 @@ declare class Seedcord extends Pluggable implements Core {
   readonly augmentTarget = "@seedcord/gateway";
   /** @internal */
   readonly version: string;
-  private static isInstantiated;
-  private readonly healthCheck;
+  private readonly healthCheck?;
   private readonly hmrManager;
   /** @see {@link CoordinatedShutdown} */
   readonly shutdown: CoordinatedShutdown;
@@ -2165,20 +2072,19 @@ declare class Seedcord extends Pluggable implements Core {
   /** @see {@link IRateLimiter} */
   readonly rateLimiter: IRateLimiter;
   /**
-   * Creates a new Seedcord instance
-   *
    * @param config - Bot configuration including paths and Discord client options
    * @throws A **SeedcordError** When attempting to create multiple instances (singleton)
    */
   constructor(config: GatewayConfig);
   /** The bot's discord username, populated after login. */
   get username(): string | undefined;
-  private static reset;
+  protected pluginCapabilities(): PluginCapabilities;
+  protected static reset(): void;
   private registerStartupTasks;
   /**
    * Starts the bot and runs all initialization tasks
    *
-   * @returns This Seedcord instance when fully initialized
+   * @returns This Seedcord instance when initialized
    */
   start(): Promise<this>;
   private registerHmrAwareModules;
@@ -2188,5 +2094,5 @@ declare class Seedcord extends Pluggable implements Core {
 /** Package version */
 declare const version: string;
 //#endregion
-export { ArraySource, AssignRoleNoticeOverrides, AutocompleteHandler, type BotEvents, ButtonHandler, type CheckPermissionOptions, CommandMentions, type ConfirmOptions, ContextMenuHandler, type Core, CursorSource, type DefaultConfirmOptions, Emojis, type EventGateContext, EventHandler, EventMiddleware, type EventSpec, type EventsConfig, type FaultSource, FetchUserOptions, type GateContext, Gated, type GatewayBotConfig, type GatewayConfig, HasPermsToAssignOptions, IgnoreBots, type Initializeable, type InjectedEmojiMap, type InjectedMentionMap, type InteractionGateContext, InteractionHandler, InteractionMiddleware, Middleware, type MiddlewareOptions, MiddlewareType, ModalHandler, Nsfw, Paginator, type PaginatorControls, type PermissionErrorNoticeOverrides, Pluggable, Plugin, type PluginArgs, type PluginCtor, RegisterEvent, type RegisterEventOptions, RepliableHandler, type Repliables, Seedcord, SelectMenuHandler, ShutdownPhase, SlashHandler, type SlashOptions, StartupPhase, Subscribe, type SubscribeOptions, Subscriber, type SubscriptionData, type SubscriptionKey, type Subscriptions, type ValidEventTypes, type ValidInteractionTypes, type ValidNonInteractionKeys, type WebhookFile, WebhookLog, type WebhookReport, WebhookUrl, checkBotPermissions, checkPermissions, fetchGuildMember, fetchManyGuildMembers, fetchManyUsers, fetchRole, fetchText, fetchUser, getBotRole, getConfirmation, hasPermsToAssign, updateMemberRoles, version };
+export { ArraySource, AssignRoleNoticeOverrides, AutocompleteHandler, type BotEvents, ButtonHandler, type CheckPermissionOptions, CommandMentions, type ConfirmOptions, ContextMenuHandler, type Core, CursorSource, type DefaultConfirmOptions, Emojis, type EventGateContext, EventHandler, EventMiddleware, type EventSpec, type EventsConfig, type FaultSource, FetchUserOptions, type GateContext, Gated, type GatewayBotConfig, type GatewayConfig, HasPermsToAssignOptions, IgnoreBots, type InjectedEmojiMap, type InjectedMentionMap, type InteractionGateContext, InteractionHandler, InteractionMiddleware, Middleware, type MiddlewareOptions, MiddlewareType, ModalHandler, Nsfw, Paginator, type PaginatorControls, type PermissionErrorNoticeOverrides, RegisterEvent, type RegisterEventOptions, RepliableHandler, type Repliables, Seedcord, SelectMenuHandler, SlashHandler, type SlashOptions, Subscribe, type SubscribeOptions, Subscriber, type SubscriptionData, type SubscriptionKey, type Subscriptions, type ValidEventTypes, type ValidInteractionTypes, type ValidNonInteractionKeys, type WebhookFile, WebhookLog, type WebhookReport, WebhookUrl, checkBotPermissions, checkPermissions, fetchGuildMember, fetchManyGuildMembers, fetchManyUsers, fetchRole, fetchText, fetchUser, getBotRole, getConfirmation, hasPermsToAssign, updateMemberRoles, version };
 //# sourceMappingURL=index.d.mts.map