reciple 6.0.0-dev.19 → 6.0.0-dev.20

package/dist/types/reciple/classes/RecipleConfig.d.ts

@@ -1,100 +1,100 @@
-import { ClientOptions, PermissionResolvable } from 'discord.js';
-/**
- * Command permissions config object interface
- */
-export interface ConfigCommandPermissions {
-    /**
-     * Command name
-     */
-    command: string;
-    /**
-     * Override command builder permissions
-     */
-    permissions: PermissionResolvable[];
-}
-/**
- * Reciple config object interface
- */
-export interface Config {
-    token: string;
-    commands: {
-        slashCommand: {
-            enabled: boolean;
-            replyOnError: boolean;
-            registerCommands: boolean;
-            allowRegisterEmptyCommandList: boolean;
-            enableCooldown: boolean;
-            setRequiredPermissions: boolean;
-            acceptRepliedInteractions: boolean;
-            guilds?: string[] | string;
-            permissions: {
-                enabled: boolean;
-                commands: ConfigCommandPermissions[];
-            };
-        };
-        messageCommand: {
-            enabled: boolean;
-            prefix?: string;
-            replyOnError: boolean;
-            allowCommandAlias: boolean;
-            enableCooldown: boolean;
-            commandArgumentSeparator: string;
-            permissions: {
-                enabled: boolean;
-                commands: ConfigCommandPermissions[];
-            };
-        };
-    };
-    fileLogging: {
-        enabled: boolean;
-        debugmode: boolean;
-        clientLogs: boolean;
-        stringifyLoggedJSON: boolean;
-        logFilePath: string;
-    };
-    client: ClientOptions;
-    messages: {
-        [messageKey: string]: any;
-    };
-    ignoredFiles: string[];
-    modulesFolder: string | string[];
-    disableVersionCheck: boolean;
-    version: string;
-}
-/**
- * Create/parse reciple config
- */
-export declare class RecipleConfig {
-    config: Config;
-    configPath: string;
-    static defaultConfigPath: string;
-    /**
-     * @param configPath Path to config
-     */
-    constructor(configPath: string);
-    /**
-     * Parse the config file
-     */
-    parseConfig(): this;
-    /**
-     * Returns the parsed config file
-     */
-    getConfig(): Config;
-    /**
-     * Parse token from config
-     * @param askIfEmpty Ask for token if the token is undefined
-     */
-    parseToken(askIfEmpty?: boolean): string | null;
-    /**
-     * Check if the config version is supported
-     */
-    protected _isSupportedConfig(): boolean;
-    /**
-     * Ask for a token
-     */
-    protected _askToken(): string | null;
-    /**
-     * Get default config
-     */
-    static getDefaultConfig(): Config;
-}
+import { ClientOptions, PermissionResolvable } from 'discord.js';
+/**
+ * Command permissions config object interface
+ */
+export interface ConfigCommandPermissions {
+    /**
+     * Command name
+     */
+    command: string;
+    /**
+     * Override command builder permissions
+     */
+    permissions: PermissionResolvable[];
+}
+/**
+ * Reciple config object interface
+ */
+export interface Config {
+    token: string;
+    commands: {
+        slashCommand: {
+            enabled: boolean;
+            replyOnError: boolean;
+            registerCommands: boolean;
+            allowRegisterEmptyCommandList: boolean;
+            enableCooldown: boolean;
+            setRequiredPermissions: boolean;
+            acceptRepliedInteractions: boolean;
+            guilds?: string[] | string;
+            permissions: {
+                enabled: boolean;
+                commands: ConfigCommandPermissions[];
+            };
+        };
+        messageCommand: {
+            enabled: boolean;
+            prefix?: string;
+            replyOnError: boolean;
+            allowCommandAlias: boolean;
+            enableCooldown: boolean;
+            commandArgumentSeparator: string;
+            permissions: {
+                enabled: boolean;
+                commands: ConfigCommandPermissions[];
+            };
+        };
+    };
+    fileLogging: {
+        enabled: boolean;
+        debugmode: boolean;
+        clientLogs: boolean;
+        stringifyLoggedJSON: boolean;
+        logFilePath: string;
+    };
+    client: ClientOptions;
+    messages: {
+        [messageKey: string]: any;
+    };
+    ignoredFiles: string[];
+    modulesFolder: string | string[];
+    disableVersionCheck: boolean;
+    version: string;
+}
+/**
+ * Create/parse reciple config
+ */
+export declare class RecipleConfig {
+    config: Config;
+    configPath: string;
+    static defaultConfigPath: string;
+    /**
+     * @param configPath Path to config
+     */
+    constructor(configPath: string);
+    /**
+     * Parse the config file
+     */
+    parseConfig(): this;
+    /**
+     * Returns the parsed config file
+     */
+    getConfig(): Config;
+    /**
+     * Parse token from config
+     * @param askIfEmpty Ask for token if the token is undefined
+     */
+    parseToken(askIfEmpty?: boolean): string | null;
+    /**
+     * Check if the config version is supported
+     */
+    protected _isSupportedConfig(): boolean;
+    /**
+     * Ask for a token
+     */
+    protected _askToken(): string | null;
+    /**
+     * Get default config
+     */
+    static getDefaultConfig(): Config;
+}

package/dist/types/reciple/classes/RecipleModule.d.ts

@@ -1,56 +1,56 @@
-import { GuildResolvable, RestOrArray } from 'discord.js';
-import { AnyCommandBuilder, AnyCommandData } from '../types/builders';
-import { RecipleClient } from './RecipleClient';
-/**
- * Reciple script object
- */
-export interface RecipleScript {
-    /**
-     * Supported reciple versions
-     */
-    versions: string | string[];
-    /**
-     * Module commands
-     */
-    commands?: (AnyCommandBuilder | AnyCommandData)[];
-    /**
-     * Action on module start
-     * @param client Bot client
-     */
-    onStart(client: RecipleClient<false>): boolean | Promise<boolean>;
-    /**
-     * Action on bot ready
-     * @param client Bot client
-     */
-    onLoad?(client: RecipleClient<true>): void | Promise<void>;
-    /**
-     * Action when unloading this module
-     * @param reason Unload reason
-     * @param client Bot client
-     */
-    onUnload?(reason: unknown, client: RecipleClient<true>): void | Promise<void>;
-}
-export interface RecipleModuleOptions<M = unknown> {
-    client: RecipleClient;
-    script: RecipleScript;
-    filePath?: string;
-    metadata?: M;
-}
-export declare class RecipleModule<M = unknown> {
-    readonly id: string;
-    readonly client: RecipleClient;
-    readonly commands: AnyCommandBuilder[];
-    readonly script: RecipleScript;
-    readonly filePath?: string;
-    metadata?: M;
-    get displayName(): string;
-    constructor(options: RecipleModuleOptions<M>);
-    start(): Promise<boolean>;
-    load(resolveCommands?: boolean): Promise<void>;
-    unload(reason?: any): Promise<void>;
-    registerSlashCommands(...guilds: RestOrArray<GuildResolvable>): Promise<void>;
-    unregisterSlashCommands(...guilds: RestOrArray<GuildResolvable>): Promise<void>;
-    updateSlashCommands(...guilds: RestOrArray<GuildResolvable>): Promise<void>;
-    resolveCommands(): AnyCommandBuilder[];
-    toString(): string;
-}
+import { GuildResolvable, RestOrArray } from 'discord.js';
+import { AnyCommandBuilder, AnyCommandData } from '../types/builders';
+import { RecipleClient } from './RecipleClient';
+/**
+ * Reciple script object
+ */
+export interface RecipleScript {
+    /**
+     * Supported reciple versions
+     */
+    versions: string | string[];
+    /**
+     * Module commands
+     */
+    commands?: (AnyCommandBuilder | AnyCommandData)[];
+    /**
+     * Action on module start
+     * @param client Bot client
+     */
+    onStart(client: RecipleClient<false>): boolean | Promise<boolean>;
+    /**
+     * Action on bot ready
+     * @param client Bot client
+     */
+    onLoad?(client: RecipleClient<true>): void | Promise<void>;
+    /**
+     * Action when unloading this module
+     * @param reason Unload reason
+     * @param client Bot client
+     */
+    onUnload?(reason: unknown, client: RecipleClient<true>): void | Promise<void>;
+}
+export interface RecipleModuleOptions<M = unknown> {
+    client: RecipleClient;
+    script: RecipleScript;
+    filePath?: string;
+    metadata?: M;
+}
+export declare class RecipleModule<M = unknown> {
+    readonly id: string;
+    readonly client: RecipleClient;
+    readonly commands: AnyCommandBuilder[];
+    readonly script: RecipleScript;
+    readonly filePath?: string;
+    metadata?: M;
+    get displayName(): string;
+    constructor(options: RecipleModuleOptions<M>);
+    start(): Promise<boolean>;
+    load(resolveCommands?: boolean): Promise<void>;
+    unload(reason?: any): Promise<void>;
+    registerSlashCommands(...guilds: RestOrArray<GuildResolvable>): Promise<void>;
+    unregisterSlashCommands(...guilds: RestOrArray<GuildResolvable>): Promise<void>;
+    updateSlashCommands(...guilds: RestOrArray<GuildResolvable>): Promise<void>;
+    resolveCommands(): AnyCommandBuilder[];
+    toString(): string;
+}

package/dist/types/reciple/classes/builders/MessageCommandBuilder.d.ts

@@ -1,150 +1,150 @@
-import { CommandType, CommandHaltFunction, CommandExecuteFunction, SharedCommandBuilderProperties, MessageCommandData } from '../../types/builders';
-import { Message, PermissionResolvable, RestOrArray } from 'discord.js';
-import { BaseCommandExecuteData, CommandHaltData } from '../../types/commands';
-import { MessageCommandOptionManager } from '../managers/MessageCommandOptionManager';
-import { MessageCommandOptionBuilder } from './MessageCommandOptionBuilder';
-import { Command } from 'fallout-utility';
-/**
- * Execute data for message command
- */
-export interface MessageCommandExecuteData<T = unknown> extends BaseCommandExecuteData {
-    /**
-     * Command message
-     */
-    message: Message;
-    /**
-     * Command option args
-     */
-    options: MessageCommandOptionManager;
-    /**
-     * Command parsed args
-     */
-    command: Command;
-    /**
-     * Command builder
-     */
-    builder: MessageCommandBuilder<T>;
-}
-/**
- * Validated message command option
- */
-export interface MessageCommandValidatedOption {
-    /**
-     * Option name
-     */
-    name: string;
-    /**
-     * Option value
-     */
-    value?: string;
-    /**
-     * Is the option required
-     */
-    required: boolean;
-    /**
-     * Is the option invalid
-     */
-    invalid: boolean;
-    /**
-     * Is the option missing
-     */
-    missing: boolean;
-}
-/**
- * Halt data for message command
- */
-export declare type MessageCommandHaltData<T = unknown> = CommandHaltData<CommandType.MessageCommand, T>;
-/**
- * Message command halt function
- */
-export declare type MessageCommandHaltFunction<T = unknown> = CommandHaltFunction<CommandType.MessageCommand, T>;
-/**
- * Message command execute function
- */
-export declare type MessageCommandExecuteFunction<T = unknown> = CommandExecuteFunction<CommandType.MessageCommand, T>;
-/**
- * Reciple builder for message command
- */
-export declare class MessageCommandBuilder<T = unknown> implements SharedCommandBuilderProperties<T> {
-    readonly type = CommandType.MessageCommand;
-    name: string;
-    description: string;
-    cooldown: number;
-    aliases: string[];
-    validateOptions: boolean;
-    options: MessageCommandOptionBuilder[];
-    requiredBotPermissions: PermissionResolvable[];
-    requiredMemberPermissions: PermissionResolvable[];
-    allowExecuteInDM: boolean;
-    allowExecuteByBots: boolean;
-    halt?: MessageCommandHaltFunction<T>;
-    execute: MessageCommandExecuteFunction<T>;
-    metadata?: T;
-    constructor(data?: Partial<Omit<MessageCommandData<T>, 'type'>>);
-    /**
-     * Sets the command name
-     * @param name Command name
-     */
-    setName(name: string): this;
-    /**
-     * Sets the command description
-     * @param description Command description
-     */
-    setDescription(description: string): this;
-    /**
-     * Add aliases to the command
-     * @param aliases Command aliases
-     */
-    addAliases(...aliases: RestOrArray<string>): this;
-    /**
-     * Set if command can be executed in dms
-     * @param allowExecuteInDM `true` if the command can execute in DMs
-     */
-    setAllowExecuteInDM(allowExecuteInDM: boolean): this;
-    /**
-     * Allow command to be executed by bots
-     * @param allowExecuteByBots `true` if the command can be executed by bots
-     */
-    setAllowExecuteByBots(allowExecuteByBots: boolean): this;
-    /**
-     * Add option to the command
-     * @param option Message option builder
-     */
-    addOption(option: MessageCommandOptionBuilder | ((constructor: MessageCommandOptionBuilder) => MessageCommandOptionBuilder)): this;
-    /**
-     * Validate options before executing
-     * @param validateOptions `true` if the command options needs to be validated before executing
-     */
-    setValidateOptions(validateOptions: boolean): this;
-    setCooldown(cooldown: number): this;
-    setRequiredBotPermissions(...permissions: RestOrArray<PermissionResolvable>): this;
-    setRequiredMemberPermissions(...permissions: RestOrArray<PermissionResolvable>): this;
-    setHalt(halt?: MessageCommandHaltFunction<T> | null): this;
-    setExecute(execute: MessageCommandExecuteFunction<T>): this;
-    setMetadata(metadata?: T): this;
-    /**
-     * Returns JSON object of this builder
-     */
-    toJSON(): MessageCommandData<T>;
-    /**
-     * Resolve message command data/builder
-     * @param commandData Command data to resolve
-     */
-    static resolveMessageCommand<T = unknown>(commandData: MessageCommandData<T> | MessageCommandBuilder<T>): MessageCommandBuilder<T>;
-    /**
-     * Is a message command builder
-     * @param builder data to check
-     */
-    static isMessageCommandBuilder<T>(builder: unknown): builder is MessageCommandBuilder<T>;
-    /**
-     * Is a message command execute data
-     * @param executeData data to check
-     */
-    static isMessageCommandExecuteData(executeData: unknown): executeData is MessageCommandExecuteData;
-}
-/**
- * Validate message command options
- * @param builder Command builder
- * @param options Parsed command args
- */
-export declare function validateMessageCommandOptions(builder: MessageCommandBuilder, options: Command): Promise<MessageCommandOptionManager>;
+import { CommandType, CommandHaltFunction, CommandExecuteFunction, SharedCommandBuilderProperties, MessageCommandData } from '../../types/builders';
+import { Message, PermissionResolvable, RestOrArray } from 'discord.js';
+import { BaseCommandExecuteData, CommandHaltData } from '../../types/commands';
+import { MessageCommandOptionManager } from '../managers/MessageCommandOptionManager';
+import { MessageCommandOptionBuilder } from './MessageCommandOptionBuilder';
+import { Command } from 'fallout-utility';
+/**
+ * Execute data for message command
+ */
+export interface MessageCommandExecuteData<T = unknown> extends BaseCommandExecuteData {
+    /**
+     * Command message
+     */
+    message: Message;
+    /**
+     * Command option args
+     */
+    options: MessageCommandOptionManager;
+    /**
+     * Command parsed args
+     */
+    command: Command;
+    /**
+     * Command builder
+     */
+    builder: MessageCommandBuilder<T>;
+}
+/**
+ * Validated message command option
+ */
+export interface MessageCommandValidatedOption {
+    /**
+     * Option name
+     */
+    name: string;
+    /**
+     * Option value
+     */
+    value?: string;
+    /**
+     * Is the option required
+     */
+    required: boolean;
+    /**
+     * Is the option invalid
+     */
+    invalid: boolean;
+    /**
+     * Is the option missing
+     */
+    missing: boolean;
+}
+/**
+ * Halt data for message command
+ */
+export declare type MessageCommandHaltData<T = unknown> = CommandHaltData<CommandType.MessageCommand, T>;
+/**
+ * Message command halt function
+ */
+export declare type MessageCommandHaltFunction<T = unknown> = CommandHaltFunction<CommandType.MessageCommand, T>;
+/**
+ * Message command execute function
+ */
+export declare type MessageCommandExecuteFunction<T = unknown> = CommandExecuteFunction<CommandType.MessageCommand, T>;
+/**
+ * Reciple builder for message command
+ */
+export declare class MessageCommandBuilder<T = unknown> implements SharedCommandBuilderProperties<T> {
+    readonly type = CommandType.MessageCommand;
+    name: string;
+    description: string;
+    cooldown: number;
+    aliases: string[];
+    validateOptions: boolean;
+    options: MessageCommandOptionBuilder[];
+    requiredBotPermissions: PermissionResolvable[];
+    requiredMemberPermissions: PermissionResolvable[];
+    allowExecuteInDM: boolean;
+    allowExecuteByBots: boolean;
+    halt?: MessageCommandHaltFunction<T>;
+    execute: MessageCommandExecuteFunction<T>;
+    metadata?: T;
+    constructor(data?: Partial<Omit<MessageCommandData<T>, 'type'>>);
+    /**
+     * Sets the command name
+     * @param name Command name
+     */
+    setName(name: string): this;
+    /**
+     * Sets the command description
+     * @param description Command description
+     */
+    setDescription(description: string): this;
+    /**
+     * Add aliases to the command
+     * @param aliases Command aliases
+     */
+    addAliases(...aliases: RestOrArray<string>): this;
+    /**
+     * Set if command can be executed in dms
+     * @param allowExecuteInDM `true` if the command can execute in DMs
+     */
+    setAllowExecuteInDM(allowExecuteInDM: boolean): this;
+    /**
+     * Allow command to be executed by bots
+     * @param allowExecuteByBots `true` if the command can be executed by bots
+     */
+    setAllowExecuteByBots(allowExecuteByBots: boolean): this;
+    /**
+     * Add option to the command
+     * @param option Message option builder
+     */
+    addOption(option: MessageCommandOptionBuilder | ((constructor: MessageCommandOptionBuilder) => MessageCommandOptionBuilder)): this;
+    /**
+     * Validate options before executing
+     * @param validateOptions `true` if the command options needs to be validated before executing
+     */
+    setValidateOptions(validateOptions: boolean): this;
+    setCooldown(cooldown: number): this;
+    setRequiredBotPermissions(...permissions: RestOrArray<PermissionResolvable>): this;
+    setRequiredMemberPermissions(...permissions: RestOrArray<PermissionResolvable>): this;
+    setHalt(halt?: MessageCommandHaltFunction<T> | null): this;
+    setExecute(execute: MessageCommandExecuteFunction<T>): this;
+    setMetadata(metadata?: T): this;
+    /**
+     * Returns JSON object of this builder
+     */
+    toJSON(): MessageCommandData<T>;
+    /**
+     * Resolve message command data/builder
+     * @param commandData Command data to resolve
+     */
+    static resolveMessageCommand<T = unknown>(commandData: MessageCommandData<T> | MessageCommandBuilder<T>): MessageCommandBuilder<T>;
+    /**
+     * Is a message command builder
+     * @param builder data to check
+     */
+    static isMessageCommandBuilder<T>(builder: unknown): builder is MessageCommandBuilder<T>;
+    /**
+     * Is a message command execute data
+     * @param executeData data to check
+     */
+    static isMessageCommandExecuteData(executeData: unknown): executeData is MessageCommandExecuteData;
+}
+/**
+ * Validate message command options
+ * @param builder Command builder
+ * @param options Parsed command args
+ */
+export declare function validateMessageCommandOptions(builder: MessageCommandBuilder, options: Command): Promise<MessageCommandOptionManager>;