commandkit 0.1.11-dev.20250402134911 → 0.1.11-dev.20250403165006

package/LICENSE

@@ -0,0 +1,5 @@
+Copyright 2025 Avraj Sahota
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as discord_js from 'discord.js';
-import { RESTPostAPIApplicationCommandsJSONBody, Client, Interaction, CacheType, ClientEvents, Awaitable, ButtonBuilder, ButtonInteraction, Events, ModalBuilder, ModalSubmitInteraction, ActionRowBuilder, TextInputBuilder, ButtonStyle, ComponentEmojiResolvable, TextInputStyle, StringSelectMenuInteraction, StringSelectMenuBuilder, ChannelSelectMenuInteraction, ChannelSelectMenuBuilder, MentionableSelectMenuInteraction, MentionableSelectMenuBuilder, UserSelectMenuInteraction, UserSelectMenuBuilder, RoleSelectMenuInteraction, RoleSelectMenuBuilder, BaseSelectMenuComponentData, StringSelectMenuOptionBuilder, SelectMenuComponentOptionData, APISelectMenuOption, UserSelectMenuComponentData, RoleSelectMenuComponentData, MentionableSelectMenuComponentData, ChannelSelectMenuComponentData, LocalizationMap, Locale, Message as Message$1, ApplicationCommandOptionType, GuildMember, Attachment, User, Role, CommandInteractionOption, ChatInputCommandInteraction, MessageContextMenuCommandInteraction, UserContextMenuCommandInteraction, AutocompleteInteraction, Collection, SlashCommandBuilder, ContextMenuCommandBuilder, PartialMessage } from 'discord.js';
+import { RESTPostAPIApplicationCommandsJSONBody, Client, Interaction, CacheType, ClientEvents, Awaitable, ButtonBuilder, ButtonInteraction, Events, ModalBuilder, ModalSubmitInteraction, ActionRowBuilder, TextInputBuilder, ButtonStyle, ComponentEmojiResolvable, TextInputStyle, StringSelectMenuInteraction, StringSelectMenuBuilder, ChannelSelectMenuInteraction, ChannelSelectMenuBuilder, MentionableSelectMenuInteraction, MentionableSelectMenuBuilder, UserSelectMenuInteraction, UserSelectMenuBuilder, RoleSelectMenuInteraction, RoleSelectMenuBuilder, BaseSelectMenuComponentData, StringSelectMenuOptionBuilder, SelectMenuComponentOptionData, APISelectMenuOption, UserSelectMenuComponentData, RoleSelectMenuComponentData, MentionableSelectMenuComponentData, ChannelSelectMenuComponentData, Message as Message$1, ApplicationCommandOptionType, GuildMember, Attachment, User, Role, CommandInteractionOption, ChatInputCommandInteraction, MessageContextMenuCommandInteraction, UserContextMenuCommandInteraction, AutocompleteInteraction, Locale, Collection, SlashCommandBuilder, ContextMenuCommandBuilder, PartialMessage } from 'discord.js';
 import EventEmitter from 'node:events';
 import { Channel } from 'diagnostics_channel';
 import * as commander from 'commander';
@@ -629,88 +629,6 @@ interface ChannelSelectMenuProps extends Partial<Omit<ChannelSelectMenuComponent
 }
 declare function ChannelSelectMenu(props: ChannelSelectMenuProps): ChannelSelectMenuKit;
 
-interface TranslatableCommand {
-    name?: string;
-    description?: string;
-    options?: TranslatableCommandOptions[];
-}
-interface TranslatableCommandOptions {
-    ref: string;
-    name?: string;
-    description?: string;
-    options?: TranslatableCommandOptions[];
-}
-interface ApiTranslatableCommandOptions extends TranslatableCommandOptions {
-    name_localizations?: LocalizationMap;
-    description_localizations?: LocalizationMap;
-}
-interface CommandLocalizationTypeData {
-    [key: string]: Record<string, string | null>;
-}
-type TranslatableCommandName = string & {};
-interface Translation {
-    command: TranslatableCommand;
-    translations: Record<string, string>;
-}
-type TranslatableArguments<T extends TranslatableCommandName> = T extends TranslatableCommandName ? CommandLocalizationTypeData[T] extends Record<string, infer ArgType> ? ArgType extends null ? never : Record<string, string> : Record<string, string> : Record<string, string>;
-
-interface LocalizationTranslationRequest {
-    locale: Locale;
-    scope: string;
-    key: string;
-    args?: Record<string, any> | undefined;
-}
-type TranslationResult = string;
-interface LocalizationStrategy {
-    locateTranslation(scope: string, locale: Locale): Promise<Translation | null>;
-    getTranslation(scope: string, locale: Locale): Promise<Translation | null>;
-    getTranslationStrict(scope: string, locale: Locale): Promise<Translation>;
-    translate(request: LocalizationTranslationRequest): Promise<TranslationResult>;
-}
-
-interface LocalizationConfig {
-    /**
-     * The locale to use for localization.
-     */
-    locale: Locale;
-    /**
-     * The internalization data target.
-     */
-    target: string;
-}
-type Translator<T extends TranslatableCommandName> = <K extends keyof CommandLocalizationTypeData[T] & string>(key: K, args?: CommandLocalizationTypeData[T][K] extends null ? never : CommandLocalizationTypeData[T][K] extends string ? Record<CommandLocalizationTypeData[T][K], string> : Record<string, string>) => Promise<TranslationResult>;
-declare class Localization<T extends TranslatableCommandName = string> {
-    private readonly commandkit;
-    private readonly config;
-    /**
-     * Translates the given translatable object.
-     * @param translatable The translatable object to translate.
-     */
-    readonly t: Translator<T>;
-    /**
-     * Creates a new localization instance.
-     * @param commandkit The command kit instance.
-     * @param config The localization configuration.
-     */
-    constructor(commandkit: CommandKit, config: LocalizationConfig);
-    /**
-     * Get the localization strategy.
-     */
-    getStrategy(): LocalizationStrategy;
-    /**
-     * Get the default locale
-     */
-    getDefaultLocale(): Locale;
-    /**
-     * Get the current locale
-     */
-    getLocale(): Locale;
-    /**
-     * Get the localization target
-     */
-    getTarget(): string;
-}
-
 interface ParsedMessageCommand {
     command: string;
     options: {
@@ -796,18 +714,6 @@ declare function getContext(): CommandKitEnvironment | undefined;
  */
 declare function useEnvironment(): CommandKitEnvironment;
 
-declare class DefaultLocalizationStrategy implements LocalizationStrategy {
-    private readonly commandkit;
-    private translations;
-    constructor(commandkit: CommandKit);
-    locateTranslation(scope: string, locale: Locale): Promise<Translation | null>;
-    private generateLocaleTypes;
-    getTranslationStrict(scope: string, locale: Locale): Promise<Translation>;
-    getTranslation(scope: string, locale: Locale): Promise<Translation | null>;
-    translate(request: LocalizationTranslationRequest): Promise<TranslationResult>;
-    private applyTranslation;
-}
-
 /**
  * Cancel upcoming middleware execution.
  * If this is called inside pre-stage middleware, the next run will be the actual command, skipping all other pre-stage middlewares.
@@ -1077,12 +983,6 @@ declare class Context<ExecutionMode extends CommandExecutionMode = CommandExecut
      * @param locale The locale to set.
      */
     setLocale(locale: Locale | null): void;
-    /**
-     * Returns the i18n api for this command.
-     * @param locale The locale to use for the i18n api.
-     * @template T The command name for type-safe translations. Will provide autocomplete from available translations.
-     */
-    locale<T extends TranslatableCommandName | (string & {}) = string>(locale?: Locale): Localization<T extends TranslatableCommandName ? T : string>;
     /**
      * Creates a clone of this context
      */
@@ -1492,7 +1392,6 @@ declare class AppCommandHandler {
     loadCommands(): Promise<void>;
     private loadMiddleware;
     private loadCommand;
-    applyLocalizations(command: CommandBuilderLike): Promise<CommandBuilderLike>;
 }
 
 type ListenerFunction = GenericFunction | AsyncFunction;
@@ -1684,7 +1583,6 @@ declare const COMMANDKIT_IS_TEST: boolean;
 declare const HMREventType: {
     readonly ReloadCommands: "reload-commands";
     readonly ReloadEvents: "reload-events";
-    readonly ReloadLocales: "reload-locales";
     readonly Unknown: "unknown";
 };
 type HMREventType = (typeof HMREventType)[keyof typeof HMREventType];
@@ -1759,6 +1657,12 @@ declare abstract class RuntimePlugin<T extends PluginOptions = PluginOptions> ex
      * @param event The event
      */
     performHMR(ctx: CommandKitPluginRuntime, event: CommandKitHMREvent): Promise<void>;
+    /**
+     * Called before command is loaded for registration. This method can be used to modify the command data before it is loaded.
+     * @param ctx The context
+     * @param commands The command that is being loaded. This is a CommandBuilderLike object which represents Discord's command
+     */
+    prepareCommand(ctx: CommandKitPluginRuntime, commands: CommandBuilderLike): Promise<CommandBuilderLike | null>;
 }
 declare function isRuntimePlugin(plugin: unknown): plugin is RuntimePlugin;
 
@@ -1777,7 +1681,6 @@ declare class CommandKitPluginRuntime {
 
 interface CommandKitConfiguration {
     defaultLocale: Locale;
-    localizationStrategy: LocalizationStrategy;
     getMessageCommandPrefix: (message: Message$1) => Awaitable<string | string[]>;
 }
 declare let commandkit: CommandKit;
@@ -1830,11 +1733,6 @@ declare class CommandKit extends EventEmitter {
      * @param provider The cache provider.
      */
     setCacheProvider(provider: CacheProvider): this;
-    /**
-     * Sets the localization strategy for the command handler.
-     * @param strategy The localization strategy.
-     */
-    setLocalizationStrategy(strategy: LocalizationStrategy): this;
     /**
      * Resolves the current cache provider.
      */
@@ -1866,7 +1764,7 @@ declare class CommandKit extends EventEmitter {
      * - `./src/app`
      */
     getAppDirectory(): string | null;
-    getPath(to: 'locales' | 'commands' | 'events'): string | null;
+    getPath(to: 'commands' | 'events'): string | null;
 }
 
 interface CommandKitConfig {
@@ -1937,11 +1835,6 @@ interface CommandKitConfig {
          */
         production?: boolean;
     };
-    /**
-     * Whether or not to enable typed locales.
-     * @default true
-     */
-    typedLocales?: boolean;
     /**
      * Whether or not to enable the typed commands.
      * @default true
@@ -2024,4 +1917,4 @@ declare function getSourceDirectories(): string[];
  */
 declare function bootstrapCommandkitCLI(argv: string[], options?: commander.ParseOptions | undefined): Promise<void>;
 
-export { ActionRow, type ActionRowProps, type AnyCommandExecute, type AnyCommandKitElement, type ApiTranslatableCommandOptions, AppCommandHandler, type AsyncFunction, type AutocompleteCommand, type AutocompleteCommandContext, type AutocompleteCommandMiddlewareContext, Button, type ButtonChildrenLike, ButtonKit, type ButtonKitPredicate, type ButtonProps, COMMANDKIT_CACHE_TAG, COMMANDKIT_IS_DEV, COMMANDKIT_IS_TEST, type CacheContext, type CacheEntry, type CacheMetadata, CacheProvider, ChannelSelectMenu, ChannelSelectMenuKit, type ChannelSelectMenuKitPredicate, type ChannelSelectMenuProps, type Command, type CommandContext, type CommandContextOptions, type CommandData, CommandExecutionMode, CommandKit, type CommandKitButtonBuilderInteractionCollectorDispatch, type CommandKitButtonBuilderInteractionCollectorDispatchContextData, type CommandKitButtonBuilderOnEnd, type CommandKitConfiguration, type CommandKitElement, type CommandKitElementData, CommandKitEnvironment, type CommandKitEnvironmentInternalData, CommandKitEnvironmentType, type CommandKitHMREvent, type CommandKitLoggerOptions, type CommandKitModalBuilderInteractionCollectorDispatch, type CommandKitModalBuilderInteractionCollectorDispatchContextData, type CommandKitModalBuilderOnEnd, type CommandKitOptions, type CommandKitPlugin, CommandKitPluginRuntime, type CommandKitSelectMenuBuilderInteractionCollectorDispatch, type CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData, type CommandKitSelectMenuBuilderOnEnd, type CommandLocalizationTypeData, type CommandSource, type CommandTypeData, CommandsRouter, type CommandsRouterOptions, type CommonBuilderKit, type CommonPluginRuntime, type CommonSelectMenuProps, CompilerPlugin, CompilerPluginRuntime, Context, type ContextParameters, DefaultLocalizationStrategy, DefaultLogger, ElementType, EventInterceptor, type EventInterceptorContextData, type EventInterceptorErrorHandler, EventsRouter, type EventsRouterOptions, type EventsTree, Fragment, type FragmentElementProps, type GenericFunction, HMREventType, type ILogger, type InteractionCommandContext, type InteractionCommandMiddlewareContext, type LoadedCommand, type Loader, Localization, type LocalizationConfig, type LocalizationStrategy, type LocalizationTranslationRequest, type Location, Logger, type LoggerImpl, type MaybeArray, type MaybeFalsey, MemoryCache, MentionableSelectMenu, MentionableSelectMenuKit, type MentionableSelectMenuKitPredicate, type MentionableSelectMenuProps, type Message, type MessageCommand, type MessageCommandContext, type MessageCommandMiddlewareContext, MessageCommandOptions, type MessageCommandOptionsSchema, MessageCommandParser, type MessageContextMenuCommand, type MessageContextMenuCommandContext, type MessageContextMenuCommandMiddlewareContext, type Middleware, MiddlewareContext, type MiddlewareContextArgs, Modal, ModalKit, type ModalKitPredicate, type ModalProps, type OnButtonKitClick, type OnButtonKitEnd, type OnChannelSelectMenuKitSubmit, type OnLoadArgs, type OnLoadOptions, type OnLoadResult, type OnMentionableSelectMenuKitSubmit, type OnModalKitEnd, type OnModalKitSubmit, type OnResolveArgs, type OnResolveOptions, type OnResolveResult, type OnRoleSelectMenuKitSubmit, type OnSelectMenuKitEnd, type OnSelectMenuKitSubmit, type OnStringSelectMenuKitSubmit, type OnUserSelectMenuKitSubmit, ParagraphInput, type ParsedCommandData, type ParsedEvent, type ParsedMessageCommand, type PluginTransformParameters, type PreparedAppCommandExecution, type ResolvableCommand, type ResolveBuilderInteraction, type ResolveKind, type ResolveResult, RoleSelectMenu, RoleSelectMenuKit, type RoleSelectMenuKitPredicate, type RoleSelectMenuProps, type RunCommand, RuntimePlugin, type SelectMenuKitPredicate, type SelectMenuProps, type Setup, ShortInput, type SlashCommand, type SlashCommandContext, type SlashCommandMiddlewareContext, StringSelectMenu, StringSelectMenuKit, type StringSelectMenuKitPredicate, StringSelectMenuOption, type StringSelectMenuOptionProps, type StringSelectMenuProps, TextInput, type TextInputProps, type TransformedResult, type TranslatableArguments, type TranslatableCommand, type TranslatableCommandName, type TranslatableCommandOptions, type Translation, type TranslationResult, type Translator, type UserContextMenuCommand, type UserContextMenuCommandContext, type UserContextMenuCommandMiddlewareContext, UserSelectMenu, UserSelectMenuKit, type UserSelectMenuKitPredicate, type UserSelectMenuProps, afterCommand, bootstrapCommandkitCLI, cache, cacheLife, cacheTag, cancelAfterCommand, commandkit, createElement, createLogger, CommandKit as default, defineConfig, exitContext, exitMiddleware, fromEsbuildPlugin, getCommandKit, getConfig, getContext, getCurrentDirectory, getElement, getSourceDirectories, invalidate, isCachedFunction, isCommandKitElement, isCompilerPlugin, isInteractionSource, isMessageSource, isRuntimePlugin, makeContextAwareFunction, provideContext, redirect, rethrow, revalidate, useEnvironment, version, zzz_commandkit_secret_internal_use_cache_wrapper_do_not_use_or_you_will_be_fired };
+export { ActionRow, type ActionRowProps, type AnyCommandExecute, type AnyCommandKitElement, AppCommandHandler, type AsyncFunction, type AutocompleteCommand, type AutocompleteCommandContext, type AutocompleteCommandMiddlewareContext, Button, type ButtonChildrenLike, ButtonKit, type ButtonKitPredicate, type ButtonProps, COMMANDKIT_CACHE_TAG, COMMANDKIT_IS_DEV, COMMANDKIT_IS_TEST, type CacheContext, type CacheEntry, type CacheMetadata, CacheProvider, ChannelSelectMenu, ChannelSelectMenuKit, type ChannelSelectMenuKitPredicate, type ChannelSelectMenuProps, type Command, type CommandBuilderLike, type CommandContext, type CommandContextOptions, type CommandData, CommandExecutionMode, CommandKit, type CommandKitButtonBuilderInteractionCollectorDispatch, type CommandKitButtonBuilderInteractionCollectorDispatchContextData, type CommandKitButtonBuilderOnEnd, type CommandKitConfiguration, type CommandKitElement, type CommandKitElementData, CommandKitEnvironment, type CommandKitEnvironmentInternalData, CommandKitEnvironmentType, type CommandKitHMREvent, type CommandKitLoggerOptions, type CommandKitModalBuilderInteractionCollectorDispatch, type CommandKitModalBuilderInteractionCollectorDispatchContextData, type CommandKitModalBuilderOnEnd, type CommandKitOptions, type CommandKitPlugin, CommandKitPluginRuntime, type CommandKitSelectMenuBuilderInteractionCollectorDispatch, type CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData, type CommandKitSelectMenuBuilderOnEnd, type CommandSource, type CommandTypeData, CommandsRouter, type CommandsRouterOptions, type CommonBuilderKit, type CommonPluginRuntime, type CommonSelectMenuProps, CompilerPlugin, CompilerPluginRuntime, Context, type ContextParameters, DefaultLogger, ElementType, EventInterceptor, type EventInterceptorContextData, type EventInterceptorErrorHandler, EventsRouter, type EventsRouterOptions, type EventsTree, Fragment, type FragmentElementProps, type GenericFunction, HMREventType, type ILogger, type InteractionCommandContext, type InteractionCommandMiddlewareContext, type LoadedCommand, type Loader, type Location, Logger, type LoggerImpl, type MaybeArray, type MaybeFalsey, MemoryCache, MentionableSelectMenu, MentionableSelectMenuKit, type MentionableSelectMenuKitPredicate, type MentionableSelectMenuProps, type Message, type MessageCommand, type MessageCommandContext, type MessageCommandMiddlewareContext, MessageCommandOptions, type MessageCommandOptionsSchema, MessageCommandParser, type MessageContextMenuCommand, type MessageContextMenuCommandContext, type MessageContextMenuCommandMiddlewareContext, type Middleware, MiddlewareContext, type MiddlewareContextArgs, Modal, ModalKit, type ModalKitPredicate, type ModalProps, type OnButtonKitClick, type OnButtonKitEnd, type OnChannelSelectMenuKitSubmit, type OnLoadArgs, type OnLoadOptions, type OnLoadResult, type OnMentionableSelectMenuKitSubmit, type OnModalKitEnd, type OnModalKitSubmit, type OnResolveArgs, type OnResolveOptions, type OnResolveResult, type OnRoleSelectMenuKitSubmit, type OnSelectMenuKitEnd, type OnSelectMenuKitSubmit, type OnStringSelectMenuKitSubmit, type OnUserSelectMenuKitSubmit, ParagraphInput, type ParsedCommandData, type ParsedEvent, type ParsedMessageCommand, type PluginTransformParameters, type PreparedAppCommandExecution, type ResolvableCommand, type ResolveBuilderInteraction, type ResolveKind, type ResolveResult, RoleSelectMenu, RoleSelectMenuKit, type RoleSelectMenuKitPredicate, type RoleSelectMenuProps, type RunCommand, RuntimePlugin, type SelectMenuKitPredicate, type SelectMenuProps, type Setup, ShortInput, type SlashCommand, type SlashCommandContext, type SlashCommandMiddlewareContext, StringSelectMenu, StringSelectMenuKit, type StringSelectMenuKitPredicate, StringSelectMenuOption, type StringSelectMenuOptionProps, type StringSelectMenuProps, TextInput, type TextInputProps, type TransformedResult, type UserContextMenuCommand, type UserContextMenuCommandContext, type UserContextMenuCommandMiddlewareContext, UserSelectMenu, UserSelectMenuKit, type UserSelectMenuKitPredicate, type UserSelectMenuProps, afterCommand, bootstrapCommandkitCLI, cache, cacheLife, cacheTag, cancelAfterCommand, commandkit, createElement, createLogger, CommandKit as default, defineConfig, exitContext, exitMiddleware, fromEsbuildPlugin, getCommandKit, getConfig, getContext, getCurrentDirectory, getElement, getSourceDirectories, invalidate, isCachedFunction, isCommandKitElement, isCompilerPlugin, isInteractionSource, isMessageSource, isRuntimePlugin, makeContextAwareFunction, provideContext, redirect, rethrow, revalidate, useEnvironment, version, zzz_commandkit_secret_internal_use_cache_wrapper_do_not_use_or_you_will_be_fired };