@seedcord/gateway 0.1.0-next.1 → 0.1.0-next.2

package/dist/index.d.mts

@@ -1,18 +1,20 @@
 import { BuilderComponent, CoreBase, DispatchContext, Gate, GateContextBase, GateNoticeOptions, MessageContextMenuRegistry, Notice, OptionKind, PageView, RegisterCommand, RequiredOf, SlashOptionRegistry, UserContextMenuRegistry } from "@seedcord/core";
 import { AnyCustomId, DecodedParams, GateFitsWith, HasComponentDefs, PageCursor } from "@seedcord/core/internal";
 import { APIInteractionGuildMember, APIMessageComponentEmoji, AnySelectMenuInteraction, ApplicationCommand, ApplicationCommandOptionChoiceData, ApplicationCommandType, ApplicationEmoji, AutocompleteInteraction, BooleanCache, ButtonInteraction, ButtonStyle, CacheType, CacheTypeReducer, ChannelSelectMenuInteraction, ChannelType, 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, WebhookClient } from "discord.js";
-import { CoordinatedShutdown, CoordinatedStartup, Logger, StartupPhase } from "@seedcord/services";
+import { Logger } from "@seedcord/logger";
 import { ActionRowBuilder, ButtonBuilder, ContextMenuCommandBuilder, SlashCommandBuilder } from "@discordjs/builders";
 import { EventMap, NoEvents, TypedEventEmitter } from "@seedcord/event-emitter";
-import { HmrAware, HmrUpdateEvent, SeedcordBrand, SeedcordInstance } from "@seedcord/types/internal";
+import { CoordinatedShutdown, CoordinatedStartup, StartupPhase } from "@seedcord/services";
+import { SeedcordBrand, SeedcordInstance } from "@seedcord/types/internal";
 import { UUID } from "node:crypto";
-import { BotConfig, Config, EmojiMap, IRateLimiter, Nullable, ReplyResponse, Tail, V2Component } from "@seedcord/types";
+import { BotConfig, Config, EmojiMap, HmrAware, HmrUpdateEvent, IRateLimiter, Nullable, ReplyResponse, Tail, V2Component } from "@seedcord/types";
 export * from "@seedcord/core";
 export * from "@seedcord/errors";
 export * from "@seedcord/utils";
-export * from "@seedcord/services";
+export * from "@seedcord/logger";
 export * from "@seedcord/event-emitter";
 export * from "@seedcord/rate-limiter";
+export * from "@seedcord/services";
 export type * from "@seedcord/types";
 
 //#region src/bot/utilities/miscellaneous/contextMenuLeaves.d.ts
@@ -57,7 +59,6 @@ interface GatewayConfig extends Config {
 }
 //#endregion
 //#region src/interfaces/Plugin.d.ts
-/** Interface for objects that can be initialized asynchronously */
 interface Initializeable {
   init(): Promise<void>;
 }
@@ -69,14 +70,10 @@ interface Initializeable {
  */
 declare abstract class Plugin<TPluginEvents extends EventMap<TPluginEvents> = NoEvents> extends TypedEventEmitter<TPluginEvents> implements Initializeable, HmrAware {
   protected pluggable: Core;
-  /** Logger instance for this plugin. */
   abstract logger: Logger;
   name: string;
   constructor(pluggable: Core);
-  /**
-   * Initialize the plugin.
-   * @virtual
-   */
+  /** @virtual */
   abstract init(): Promise<void>;
   /**
    * Reloads plugin state on an HMR update. The base implementation is a no-op, override it in your plugin.
@@ -94,15 +91,13 @@ declare abstract class Plugin<TPluginEvents extends EventMap<TPluginEvents> = No
   removeAllListeners(event?: Extract<keyof TPluginEvents, string | symbol>): this;
 }
 /**
- * Constructor type for plugins that can accept additional arguments after Core
- * @typeParam TPlugin - The plugin type being constructed
+ * 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)
- * @typeParam Ctor - The plugin constructor to extract arguments from
+ * Extracts the argument types for a plugin constructor, excluding the Core parameter.
  *
  * @internal
  */
@@ -343,12 +338,15 @@ declare class CommandRegistry implements Initializeable, HmrAware {
   readonly globalCommands: (SlashCommandBuilder | ContextMenuCommandBuilder)[];
   readonly guildCommands: Collection<string, (SlashCommandBuilder | ContextMenuCommandBuilder)[]>;
   private readonly ctorToCommand;
+  private loading;
+  private readonly loadedCommands;
   private readonly hmrHandler?;
   private readonly pendingEvents;
   constructor(core: Core, onDeployed?: ((result: DeployResult) => void) | undefined);
   private getArtifacts;
   /** @internal */
   init(): Promise<void>;
+  private reportLoad;
   /** @internal */
   refresh(shouldRefresh?: boolean): Promise<void>;
   /** @internal */
@@ -2415,72 +2413,6 @@ declare abstract class WebhookLog<KeyOfSubscribers extends SubscriptionKey> exte
   constructor(data: AllSubscriptions[KeyOfSubscribers], core: Core);
 }
 //#endregion
-//#region src/hmr/HmrModuleHandler.d.ts
-/**
- * Options for configuring the HmrModuleHandler.
- *
- * This is only useful during development.
- */
-interface HmrModuleHandlerOptions<THandler, TMiddleware = void, TArtifacts = unknown> {
-  /** Directory containing handler modules. */
-  handlersDir: string;
-  /** Directory containing middleware modules. Optional because not all setups use middleware. */
-  middlewaresDir?: string;
-  /** Function to determine if a value is a handler module of type THandler. */
-  isHandler: (val: unknown) => val is THandler;
-  /** Function to determine if a value is a middleware module of type TMiddleware. Optional because not all setups use middleware. */
-  isMiddleware?: (val: unknown) => val is TMiddleware;
-  /** Function to register a handler module. */
-  registerHandler: (handler: THandler, file: string) => void;
-  /** Function to register a middleware module. Optional because not all setups use middleware. */
-  registerMiddleware?: (middleware: TMiddleware, file: string) => void;
-  /** Function to unregister a handler module. */
-  unregisterHandler: (handler: THandler, artifacts?: TArtifacts) => void;
-  /** Function to unregister a middleware module. Optional because not all setups use middleware. */
-  unregisterMiddleware?: (middleware: TMiddleware) => void;
-  /** Function to extract artifacts from a handler to be stored across hmr cache invalidations. */
-  getArtifacts?: (handler: THandler) => TArtifacts;
-  /** Logger instance for logging HMR activities.*/
-  logger: Logger;
-}
-/**
- * Reloads THandler and optional TMiddleware modules on HMR updates.
- *
- * You can either implement a custom `onHmr()` method in your class by extending `HmrAware`, or if it's a plugin, override the existing `onHmr()` with fully custom logic. Or, use this class's `handle()` method inside your `onHmr()` to get standard HMR handling for your modules based on the provided options you give to the constructor.
- *
- * This is only useful during development.
- */
-declare class HmrModuleHandler<THandler, TMiddleware = void, TArtifacts = unknown> {
-  private readonly store;
-  private readonly options;
-  constructor(options: HmrModuleHandlerOptions<THandler, TMiddleware, TArtifacts>);
-  /**
-   * Handles an HMR update event by reloading affected modules based on the event details and config. It receives an {@link HmrUpdateEvent}, then checks the type of update.
-   *
-   * - If it's a deletion, it unloads the module.
-   * - If it's an update/creation, it checks if the file is tracked, unloads it if so, then reloads the file if it is in the handlers or middlewares directory and is a valid handler/middleware.
-   */
-  handle(event: HmrUpdateEvent): Promise<void>;
-  private reloadWithRollback;
-  /**
-   * Tracks a handler module as being loaded from a specific file.
-   * @param file - The file path the handler was loaded from.
-   * @param handler - The handler module instance.
-   */
-  trackHandler(file: string, handler: THandler): void;
-  /**
-   * Tracks a middleware module as being loaded from a specific file.
-   * @param file - The file path the middleware was loaded from.
-   * @param middleware - The middleware module instance.
-   */
-  trackMiddleware(file: string, middleware: TMiddleware): void;
-  private isTracked;
-  private unload;
-  private reloadFile;
-  private snapshotUnits;
-  private restoreUnits;
-}
-//#endregion
 //#region src/Seedcord.d.ts
 /**
  * Main Seedcord bot framework class
@@ -2497,6 +2429,8 @@ declare class Seedcord extends Pluggable implements Core {
   /** @internal */
   readonly version: string;
   private static isInstantiated;
+  private readonly healthCheck;
+  private readonly hmrManager;
   /** @see {@link CoordinatedShutdown} */
   readonly shutdown: CoordinatedShutdown;
   /** @see {@link CoordinatedStartup} */
@@ -2507,10 +2441,6 @@ declare class Seedcord extends Pluggable implements Core {
   readonly bot: Bot;
   /** @see {@link IRateLimiter} */
   readonly rateLimiter: IRateLimiter;
-  /** @see {@link HealthCheck} */
-  private readonly healthCheck;
-  /** @see {@link HmrManager} */
-  private readonly hmrManager;
   /**
    * Creates a new Seedcord instance
    *
@@ -2518,12 +2448,9 @@ declare class Seedcord extends Pluggable implements Core {
    * @throws A **SeedcordError** When attempting to create multiple instances (singleton)
    */
   constructor(config: GatewayConfig);
-  /** @internal */
+  /** The bot's discord username, populated after login. */
+  get username(): string | undefined;
   private static reset;
-  /**
-   * Registers default startup tasks
-   * @internal
-   */
   private registerStartupTasks;
   /**
    * Starts the bot and runs all initialization tasks
@@ -2538,5 +2465,5 @@ declare class Seedcord extends Pluggable implements Core {
 /** Package version */
 declare const version: string;
 //#endregion
-export { type AllSubscriptions, ArraySource, AssignRoleErrorCtors, AutocompleteHandler, type AutocompleteOptions, AutocompleteRoute, type BotEvents, type BotPermissionScope, ButtonHandler, ButtonRoute, type CheckPermissionOptions, CommandMentions, type ConfirmOptions, ContextMenuHandler, ContextMenuRoute, 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, HmrModuleHandler, IgnoreBots, type Initializeable, type InjectedEmojiMap, type InjectedMentionMap, type InteractionGateContext, InteractionHandler, InteractionMiddleware, Middleware, type MiddlewareOptions, MiddlewareType, ModalHandler, ModalRoute, Nsfw, Paginator, type PaginatorControls, type PermissionErrorCtors, Pluggable, Plugin, type PluginArgs, type PluginCtor, RegisterCommand, RegisterEvent, type RegisterEventOptions, type Repliables, ReplySender, RequireBotPermissions, RequirePermissions, type RequirePermissionsOptions, RequireRole, type RequireRoleOptions, Seedcord, SelectMenuHandler, SelectMenuKind, SelectMenuRoute, SlashHandler, type SlashOptions, SlashRoute, Subscribe, type SubscribeOptions, Subscriber, type SubscriptionData, type SubscriptionKey, type Subscriptions, type ValidEventTypes, type ValidInteractionTypes, type ValidNonInteractionKeys, WebhookLog, checkBotPermissions, checkPermissions, fetchGuildMember, fetchManyGuildMembers, fetchManyUsers, fetchRole, fetchText, fetchUser, getBotRole, getConfirmation, hasPermsToAssign, updateMemberRoles, version };
+export { type AllSubscriptions, ArraySource, AssignRoleErrorCtors, AutocompleteHandler, type AutocompleteOptions, AutocompleteRoute, type BotEvents, type BotPermissionScope, ButtonHandler, ButtonRoute, type CheckPermissionOptions, CommandMentions, type ConfirmOptions, ContextMenuHandler, ContextMenuRoute, 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, ModalRoute, Nsfw, Paginator, type PaginatorControls, type PermissionErrorCtors, Pluggable, Plugin, type PluginArgs, type PluginCtor, RegisterCommand, RegisterEvent, type RegisterEventOptions, type Repliables, ReplySender, RequireBotPermissions, RequirePermissions, type RequirePermissionsOptions, RequireRole, type RequireRoleOptions, Seedcord, SelectMenuHandler, SelectMenuKind, SelectMenuRoute, SlashHandler, type SlashOptions, SlashRoute, Subscribe, type SubscribeOptions, Subscriber, type SubscriptionData, type SubscriptionKey, type Subscriptions, type ValidEventTypes, type ValidInteractionTypes, type ValidNonInteractionKeys, WebhookLog, checkBotPermissions, checkPermissions, fetchGuildMember, fetchManyGuildMembers, fetchManyUsers, fetchRole, fetchText, fetchUser, getBotRole, getConfirmation, hasPermsToAssign, updateMemberRoles, version };
 //# sourceMappingURL=index.d.mts.map