archived-handler/src/handler/structures/module.ts

import type {
    ApplicationCommandOptionData,
    Awaitable,
    ButtonInteraction,
    MessageContextMenuCommandInteraction,
    SelectMenuInteraction,
    UserContextMenuCommandInteraction,
} from 'discord.js';
import type { Args, Override } from '../../types/handler';
import type { CommandPlugin, EventPlugin } from '../plugins/plugin';
import type Context from './context';
import { CommandType, PluginType } from './enums';

export interface BaseModule {
    type: CommandType | PluginType;
    name?: string;
    description: string;
    execute: (ctx: Context, args: Args) => Awaitable<void>;
}

//possible refactoring types into interfaces and not types
export type TextCommand = Override<BaseModule, {
    type: CommandType.Text;
    onEvent?: EventPlugin<CommandType.Text>[]
    plugins?: CommandPlugin[];
    alias?: string[];
}>;

export type SlashCommand = Override<BaseModule, {
    type: CommandType.Slash;
    onEvent?: EventPlugin<CommandType.Slash>[]
    plugins?: CommandPlugin[];
    options?: ApplicationCommandOptionData[];
}>;

export type BothCommand = Override<BaseModule, {
    type: CommandType.Both;
    onEvent?: EventPlugin<CommandType.Both>[]
    plugins?: CommandPlugin[]
    alias?: string[];
    options?: ApplicationCommandOptionData[];
}>;

export type ContextMenuUser = Override<BaseModule, {
    type: CommandType.MenuUser;
    onEvent?: EventPlugin<CommandType.MenuUser>[];
    plugins?: CommandPlugin[];
    execute: (ctx: UserContextMenuCommandInteraction) => Awaitable<void>
}>

export type ContextMenuMsg = Override<BaseModule, {
    type: CommandType.MenuMsg;
    onEvent?: EventPlugin<CommandType.MenuMsg>[];
    plugins?: CommandPlugin[];
    execute: (ctx: MessageContextMenuCommandInteraction) => Awaitable<void>
}>;

export type ButtonCommand = Override<BaseModule, {
    type: CommandType.Button;
    onEvent?: EventPlugin<CommandType.Button>[];
    plugins?: CommandPlugin[];
    execute: (ctx: ButtonInteraction) => Awaitable<void>
}>;

export type SelectMenuCommand = Override<BaseModule, {
    type: CommandType.MenuSelect;
    onEvent?: EventPlugin<CommandType.MenuSelect>[];
    plugins?: CommandPlugin[];
    execute: (ctx: SelectMenuInteraction) => Awaitable<void>
}>;

export type Module =
    | TextCommand
    | SlashCommand
    | BothCommand
    | ContextMenuUser
    | ContextMenuMsg
    | ButtonCommand
    | SelectMenuCommand;

//https://stackoverflow.com/questions/64092736/alternative-to-switch-statement-for-typescript-discriminated-union
// Explicit Module Definitions for mapping
export type ModuleDefs = {
    [CommandType.Text]: TextCommand;
    [CommandType.Slash]: SlashCommand;
    [CommandType.Both]: BothCommand;
    [CommandType.MenuMsg]: ContextMenuMsg;
    [CommandType.MenuUser]: ContextMenuUser;
    [CommandType.Button]: ButtonCommand;
    [CommandType.MenuSelect]: SelectMenuCommand;
};