seyfert 4.5.0 → 5.0.0

package/lib/client/base.d.ts

@@ -1,23 +1,36 @@
 import { ApiHandler } from '../api';
 import type { Adapter, DisabledCache } from '../cache';
 import { Cache } from '../cache';
-import type { Command, CommandContext, ContextMenuCommand, ExtendedRC, ExtendedRCLocations, ExtraProps, MenuCommandContext, RegisteredMiddlewares, SubCommand, UsingClient } from '../commands';
-import { type InferWithPrefix, type MiddlewareContext } from '../commands/applications/shared';
+import type { Command, CommandContext, ContextMenuCommand, ExtendContext, ExtendedRC, ExtendedRCLocations, ExtraProps, MenuCommandContext, ResolvedRegisteredMiddlewares, UsingClient } from '../commands';
+import { SubCommand } from '../commands';
+import { type AnyMiddlewareContext, type InferWithPrefix, type MiddlewareContext } from '../commands/applications/shared';
+import type { BaseContext } from '../commands/basecontext';
 import { HandleCommand } from '../commands/handle';
 import { CommandHandler } from '../commands/handler';
-import { ApplicationShorter, ChannelShorter, EmojiShorter, GuildShorter, InteractionShorter, InvitesShorter, Logger, type MakeRequired, MemberShorter, MessageShorter, ReactionShorter, RoleShorter, TemplateShorter, ThreadShorter, UsersShorter, WebhookShorter } from '../common';
+import { ApplicationShorter, ChannelShorter, EmojiShorter, GuildShorter, InteractionShorter, InvitesShorter, Logger, type LoggerOptions, type MakeRequired, MemberShorter, MessageShorter, ReactionShorter, RoleShorter, TemplateShorter, ThreadShorter, UsersShorter, WebhookShorter } from '../common';
 import { BanShorter } from '../common/shorters/bans';
 import { SoundboardShorter } from '../common/shorters/soundboard';
 import { VoiceStateShorter } from '../common/shorters/voiceStates';
-import type { Awaitable, DeepPartial, IntentStrings, OmitInsert, PermissionStrings, When } from '../common/types/util';
-import type { ComponentCommand, ModalCommand } from '../components';
+import type { Awaitable, DeepPartial, OmitInsert, PermissionStrings, When } from '../common/types/util';
+import { ComponentCommand, ModalCommand } from '../components';
 import { ComponentHandler } from '../components/handler';
+import { type CustomEventRunner } from '../events';
 import { LangsHandler } from '../langs/handler';
 import type { ChatInputCommandInteraction, ComponentInteraction, EntryPointInteraction, MessageCommandInteraction, ModalSubmitInteraction, UserCommandInteraction } from '../structures';
-import type { APIInteraction, APIInteractionResponse, LocaleString, RESTPostAPIChannelMessageJSONBody } from '../types';
+import { type APIInteraction, type APIInteractionResponse, type LocaleString, type RESTPostAPIChannelMessageJSONBody } from '../types';
+import { type GatewayIntentInput } from './intents';
+import { type AnySeyfertPlugin, type PluginMiddlewareDenialMetadata, type PluginSharedRegistry, type ResolvedPluginList } from './plugins';
 import type { MessageStructure } from './transformers';
+export type ContextScopeContext = BaseContext & ExtendContext;
+export type ContextScope = <T>(context: ContextScopeContext, run: () => Awaitable<T>) => Awaitable<T>;
+type ResolvedMiddlewareKey<T extends Record<string, AnyMiddlewareContext>> = Extract<keyof T, string>;
+export type ClientMiddlewares<T extends Record<string, AnyMiddlewareContext> = ResolvedRegisteredMiddlewares> = [
+    ResolvedMiddlewareKey<T>
+] extends [never] ? Record<string, MiddlewareContext> : {
+    [K in ResolvedMiddlewareKey<T>]?: T[K];
+};
 export declare class BaseClient {
-    rest: ApiHandler;
+    rest: ApiHandler<this>;
     cache: Cache;
     applications: ApplicationShorter;
     users: UsersShorter;
@@ -44,11 +57,21 @@ export declare class BaseClient {
     handleCommand: HandleCommand;
     private _applicationId?;
     private _botId?;
-    middlewares?: Record<string, MiddlewareContext>;
+    middlewares?: ClientMiddlewares;
     protected static getBotIdFromToken(token: string): string;
+    readonly plugins: ResolvedPluginList;
+    shared: PluginSharedRegistry;
+    events: CustomEventRunner;
+    private pluginsSetupPromise?;
+    private pluginsClosePromise?;
+    private langBaseValues;
+    private pluginCacheDisabledCache;
+    private pluginBaseGatewayIntents;
+    private pluginComponentsBeforeLoadDepth;
     options: BaseClientOptions;
     constructor(options?: BaseClientOptions);
-    get proxy(): import("../api").APIRoutes;
+    protected configureLogger(defaults: LoggerOptions, options?: LoggerOptions): void;
+    get proxy(): import("..").APIRoutes;
     set botId(id: string);
     get botId(): string;
     set applicationId(id: string);
@@ -56,6 +79,31 @@ export declare class BaseClient {
     setServices({ rest, cache, langs, middlewares, handleCommand }: ServicesOptions): void;
     protected execute(..._options: unknown[]): Promise<void>;
     start(options?: Pick<DeepPartial<StartOptions>, 'langsDir' | 'commandsDir' | 'connection' | 'token' | 'componentsDir'>): Promise<void>;
+    reloadPluginContributions(): Promise<void>;
+    private bindPluginRestObserverProvider;
+    private bindPluginLangReload;
+    private refreshPluginCacheResources;
+    protected resolvePluginGatewayIntents(base?: GatewayIntentInput): number;
+    private reloadPluginMiddlewares;
+    private reloadPluginCommands;
+    private reloadPluginComponents;
+    private setupPlugins;
+    /**
+     * Closes resources managed by the plugin lifecycle.
+     *
+     * This waits for in-flight plugin setup and runs `SeyfertPlugin.teardown`.
+     * It does not close the gateway, REST client, or cache adapter.
+     */
+    close(): Promise<void>;
+    private applyPluginCommands;
+    private get loadedCommands();
+    private applyPluginComponents;
+    private createPluginCommandInstance;
+    private createPluginComponentInstance;
+    private runPluginHandlerCreators;
+    private matchesPluginHandlerKind;
+    private createPluginLoadedMetadata;
+    private emitPluginCustomEvent;
     protected onPacket(..._packet: unknown[]): Promise<any>;
     /**
      *
@@ -70,25 +118,24 @@ export declare class BaseClient {
     }>;
     private shouldUploadCommands;
     private syncCachePath;
+    private cachedCommandGuilds;
     uploadCommands({ applicationId, cachePath }?: {
         applicationId?: string;
         cachePath?: string;
     }): Promise<void>;
+    private emitUploadCommandsMetadata;
     loadCommands(dir?: string): Promise<void>;
     loadComponents(dir?: string): Promise<void>;
     loadLangs(dir?: string): Promise<void>;
-    t(locale: string): import("..").__InternalParseLocale<import("../commands").DefaultLocale> & {
-        get(locale?: string): import("../commands").DefaultLocale;
-    };
-    getRC<T extends InternalRuntimeConfigHTTP | InternalRuntimeConfig = InternalRuntimeConfigHTTP | InternalRuntimeConfig>(): Promise<{
-        debug: boolean;
-    } & Omit<T, "debug" | "locations"> & {
-        locations: RCLocations;
-    }>;
+    private applyPluginLangs;
+    t(locale: string): import("..").SeyfertLocale;
+    getRC<T extends InternalRuntimeConfigHTTP | InternalRuntimeConfig = InternalRuntimeConfigHTTP | InternalRuntimeConfig>(): Promise<ResolvedRC>;
 }
 export interface BaseClientOptions {
+    plugins?: readonly AnySeyfertPlugin[];
+    contextScopes?: readonly ContextScope[];
     context?: (interaction: ChatInputCommandInteraction<boolean> | UserCommandInteraction<boolean> | MessageCommandInteraction<boolean> | ComponentInteraction | ModalSubmitInteraction | EntryPointInteraction<boolean> | When<InferWithPrefix, MessageStructure, never>) => Record<string, unknown>;
-    globalMiddlewares?: readonly (keyof RegisteredMiddlewares)[];
+    globalMiddlewares?: readonly (keyof ResolvedRegisteredMiddlewares)[];
     commands?: {
         defaults?: {
             onBeforeMiddlewares?: (context: CommandContext | MenuCommandContext<any, never>) => unknown;
@@ -97,7 +144,7 @@ export interface BaseClientOptions {
             onPermissionsFail?: Command['onPermissionsFail'];
             onBotPermissionsFail?: (context: MenuCommandContext<any, never> | CommandContext, permissions: PermissionStrings) => unknown;
             onInternalError?: (client: UsingClient, command: Command | SubCommand | ContextMenuCommand, error?: unknown) => unknown;
-            onMiddlewaresError?: (context: CommandContext | MenuCommandContext<any, never>, error: string) => unknown;
+            onMiddlewaresError?: (context: CommandContext | MenuCommandContext<any, never>, error: string, metadata: PluginMiddlewareDenialMetadata) => unknown;
             onOptionsError?: Command['onOptionsError'];
             onAfterRun?: (context: CommandContext | MenuCommandContext<any, never>, error: unknown) => unknown;
             props?: ExtraProps;
@@ -122,7 +169,8 @@ export interface BaseClientOptions {
         };
     };
     allowedMentions?: RESTPostAPIChannelMessageJSONBody['allowed_mentions'];
-    getRC?(): Awaitable<InternalRuntimeConfig | InternalRuntimeConfigHTTP>;
+    logger?: LoggerOptions;
+    getRC?(): Awaitable<InternalRuntimeConfig | InternalRuntimeConfigHTTP | RuntimeConfig | RuntimeConfigHTTP>;
 }
 export interface StartOptions {
     eventsDir: string;
@@ -130,7 +178,7 @@ export interface StartOptions {
     commandsDir: string;
     componentsDir: string;
     connection: {
-        intents: number;
+        intents: GatewayIntentInput;
     };
     httpConnection: {
         publicKey: string;
@@ -154,6 +202,11 @@ interface RC extends ExtendedRC {
     port?: number;
     publicKey?: string;
 }
+export type ResolvedRC = Readonly<Omit<RC, 'locations' | 'debug'> & {
+    locations: Readonly<MakeRequired<RC['locations'], 'base'>>;
+    debug: boolean;
+    intents: number;
+}>;
 export type InternalRuntimeConfigHTTP = Omit<MakeRequired<RC, 'publicKey' | 'port' | 'applicationId'>, 'intents' | 'locations'> & {
     locations: Omit<RC['locations'], 'events'>;
 };
@@ -162,8 +215,10 @@ export type RuntimeConfigHTTP = Omit<MakeRequired<RC, 'publicKey' | 'application
 };
 export type InternalRuntimeConfig = MakeRequired<RC, 'intents'>;
 export type RuntimeConfig = OmitInsert<InternalRuntimeConfig, 'intents', {
-    intents?: IntentStrings | number[] | number;
+    intents?: GatewayIntentInput;
 }>;
+export type BotConfig = InternalRuntimeConfig;
+export type HttpConfig = InternalRuntimeConfigHTTP;
 export interface ServicesOptions {
     rest?: ApiHandler;
     cache?: {
@@ -172,9 +227,13 @@ export interface ServicesOptions {
     };
     langs?: {
         default?: string;
+        preferGuildLocale?: boolean;
         aliases?: Record<string, LocaleString[]>;
     };
-    middlewares?: Record<string, MiddlewareContext>;
-    handleCommand?: typeof HandleCommand;
+    middlewares?: ClientMiddlewares;
+    /**
+     * Custom command handler subclass constructor. Pass the class itself, not an instance.
+     */
+    handleCommand?: new (client: UsingClient) => HandleCommand;
 }
 export {};