meocord/dist/interface/index.d.ts

MeoCord is a lightweight and modular framework for building scalable Discord bots using TypeScript and Discord.js. It simplifies bot development with an extensible architecture, TypeScript-first approach, and powerful CLI tools.

/**
 * MeoCord Framework
 * Copyright (C) 2025 Ukasyah Rahmatullah Zada
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
import { BaseInteraction, type PartialUser, User } from 'discord.js';
import { type Configuration } from 'webpack';
import { ReactionHandlerAction } from '../enum/controller.enum.js';
/**
 * Interface for Guard classes.
 * Guards are used to handle permission checks before executing a method.
 * Each guard must implement the `canActivate` method, which is responsible for determining
 * whether the method should be allowed to execute based on the provided interaction and arguments.
 */
export interface GuardInterface {
    /**
     * Determines if the method should be allowed to execute based on the interaction and additional arguments.
     * @param interaction - The interaction object, typically representing a user action in Discord.
     * @param args - Additional arguments that might be required for the guard's logic.
     * @returns A `Promise` resolving to `true` if the method can proceed, otherwise `false`,
     *          or a `boolean` value directly.
     */
    canActivate(interaction: BaseInteraction, ...args: any[]): Promise<boolean> | boolean;
}
/**
 * Interface for handling reactions in a Discord message.
 */
export interface ReactionHandlerOptions {
    /** The user object, which can be either a full or partial user. */
    user: User | PartialUser;
    /** The action performed on the reaction, such as adding or removing it. */
    action: ReactionHandlerAction;
}
/**
 * Interface representing the Webpack configuration for the MeoCord framework.
 * This interface extends the base Webpack Configuration and provides stricter type definitions
 * with additional required properties to ensure a complete and valid Webpack setup.
 */
export interface MeoCordWebpackConfig extends Omit<Configuration, 'externals'> {
    /** Defines the mode of the Webpack build process (e.g., 'development' or 'production'). */
    mode: NonNullable<Configuration['mode']>;
    /** The entry point file path(s) for the application. Represents the starting point(s) of the build. */
    entry: string;
    /** Configuration for build optimization settings, such as code splitting and minimization. */
    optimization: NonNullable<Configuration['optimization']>;
    /**
     * Specifies external dependencies to exclude from the output bundle.
     * Can be used to exclude libraries from being bundled, like `node_modules`.
     */
    externals: Extract<NonNullable<Configuration['externals']>, any[]>;
    /**
     * Rules and configurations for handling module files during the build process.
     * Includes loaders for processing various file types.
     */
    module: NonNullable<Configuration['module']>;
    /**
     * Configuration for module resolution, including resolving extensions and alias paths.
     * Determines how imported files are resolved.
     */
    resolve: NonNullable<Configuration['resolve']>;
    /**
     * Specifies output settings for the Webpack build, excluding path, publicPath, and filename.
     * Defines properties like asset management and global settings.
     */
    output: Omit<NonNullable<Configuration['output']>, 'path' | 'publicPath' | 'filename'>;
    /** Configures the stats object to control the output of build process logs. */
    stats: NonNullable<Configuration['stats']>;
}
/**
 * Configuration interface for the MeoCord application.
 * This interface defines optional configurations for the application, including
 * metadata, authentication tokens, and Webpack configuration overrides.
 */
export interface MeoCordConfig {
    /**
     * The name of the application.
     * If not specified, it defaults to 'MeoCord'.
     */
    appName?: string;
    /**
     * The Discord bot token used for authenticating with the Discord API.
     */
    discordToken: string;
    /**
     * Function to customize the Webpack configuration.
     * Allows overriding and extending the default Webpack setup for the application.
     * @param config - A callback function to modify the existing Webpack configuration.
     * @returns A modified Webpack configuration or `undefined` if no customization is needed.
     */
    webpack?: (config: MeoCordWebpackConfig) => MeoCordWebpackConfig | undefined;
}