reciple 5.1.1 → 5.1.2

package/README.md

@@ -17,7 +17,22 @@
 A simple Dicord.js handler that just works.
 </h3>
 
-****
+***
+
+<p align="center">
+    <a href="https://discord.gg/2CattJYNpw" title="">
+        <img src="https://i.imgur.com/GffJByO.png" alt="Join Discord">
+    </a>
+</p>
+
+# Features
+
+* [CLI based handler](#command-line)
+* [Message command builder](#messagecommandbuilder-example)
+* [Built-in message command validation](#built-in-message-command-validation)
+* Automatically register application commands
+* [Built-in command cooldowns](#command-cooldowns)
+* [Highly configurable](#config)
 
 ## Installation
 
@@ -74,13 +89,100 @@ To start the bot, run the following command:
 npx reciple
 ```
 
-> ## Fun Fact
-> The name reciple is from a minecraft bug. The bug was a misspelling of the word `recipe`. [View Mojang Bug Report](https://bugs.mojang.com/browse/MC-225837)
+## Command line
+
+**Usage:** `reciple [options] [current-working-directory]`
+
+**Arguments:**
+* `current-working-directory` Change the current working directory
+
+**Options:**
+* `-v, --version` output the version number
+* `-t, --token <token>` Replace used bot token
+* `-c, --config <config>` Change path to config file
+* `-D, --debugmode` Enable debug mode
+* `-y, --yes` Automatically agree to Reciple confirmation prompts
+* `-v, --version` Display version
+* `-h, --help` display help for command
+
+## MessageCommandBuilder Example
 
+* Read docs for [`MessageCommandBuilder`](https://reciple.js.org/classes/MessageCommandBuilder.html)
 
-# Join Discord
-[![Discord Invite](https://i.imgur.com/GffJByO.png)](https://discord.gg/2CattJYNpw)
+```js
+new MessageCommandBuilder()
+    .setName("command")
+    .setDescription("Your lil tiny description")
+    .addAliases('cmd', 'cmd1')
+    .setExecute(command => command.message.reply("Hello!"))
+```
+
+## Built-in message command validation
+
+* Read docs for [`MessageCommandBuilder#setValidateOptions()`](https://reciple.js.org/classes/MessageCommandBuilder.html#setValidateOptions)
+* Read docs for [`MessageCommandOptionBuilder`](https://reciple.js.org/classes/MessageCommandOptionBuilder.html)
+* Read docs for [`MessageCommandOptionManager`](https://reciple.js.org/classes/MessageCommandOptionManager.html)
+```js
+new MessageCommandBuilder()
+    .setName("command")
+    .setDescription("Your lil tiny description")
+    .addAliases('cmd', 'cmd1')
+    .setValidateOptions(true) // Validate options
+    .addOption(option => option
+        .setName("quantity")
+        .setDescription("Must be a number")
+        .setRequired(true) // A required option
+        .setValidator(val => !isNaN(Number(val))) // Validate value
+    )
+    .setExecute(async command => {
+        const quantity = Number(command.options.getValue('quantity', true));
+
+        await command.message.reply("Quantity: " + quantity);
+    })
+```
+
+## Command Cooldowns
+
+* Read docs for [`SlashCommandBuilder#setCooldown()`](https://reciple.js.org/classes/SlashCommandBuilder.html#setCooldown)
+* Read docs for [`MessageCommandBuilder#setCooldown()`](https://reciple.js.org/classes/MessageCommandBuilder.html#setCooldown)
+* Read docs for [`CommandHaltReason`](https://reciple.js.org/enums/CommandHaltReason.html)
+* Read docs for [`CommandCooldownData`](https://reciple.js.org/interfaces/CommandCooldownData.html)
+
+```js
+// Slash command
+new SlashCommandBuilder()
+    .setName("command")
+    .setDescription("Your lil tiny description")
+    .setCooldown(1000 * 60) // Cooldown in milliseconds
+    .setExecute(command => command.interaction.reply('hi'))
+    .setHalt(async halt => {
+        // Handle command on cooldown
+        if (halt.reason == CommandHaltReason.Cooldown) {
+            await halt.executeData.interaction.reply((halt.expireTime - Date.now()) / 1000 + " seconds cooldown");
+            return true;
+        }
+    })
+
+// Message command
+new MessageCommandBuilder()
+    .setName("command")
+    .setDescription("Your lil tiny description")
+    .setCooldown(1000 * 60) // Cooldown in milliseconds
+    .setExecute(command => command.message.reply('hi'))
+    .setHalt(async halt => {
+        // Handle command on cooldown
+        if (halt.reason == CommandHaltReason.Cooldown) {
+            await halt.executeData.message.reply((halt.expireTime - Date.now()) / 1000 + " seconds cooldown");
+            return true;
+        }
+    })
+```
+
+***
+
+> ## Fun Fact
+> The name reciple is from a minecraft bug. The bug was a misspelling of the word `recipe`. [View Mojang Bug Report](https://bugs.mojang.com/browse/MC-225837)
 
-****
+***
 
 [#letTheEarthBreathe](https://rebellion.global/)

package/bin/reciple/classes/RecipleClient.d.ts

@@ -1,9 +1,9 @@
 import { MessageCommandBuilder, MessageCommandExecuteData } from './builders/MessageCommandBuilder';
 import { SlashCommandBuilder, SlashCommandExecuteData } from './builders/SlashCommandBuilder';
 import { ApplicationCommandBuilder } from '../registerApplicationCommands';
+import { AnyCommandBuilder, AnySlashCommandBuilder, CommandBuilderType } from '../types/builders';
 import { AnyCommandExecuteData, AnyCommandHaltData } from '../types/commands';
 import { CommandCooldownManager } from './CommandCooldownManager';
-import { AnyCommandBuilder, CommandBuilderType } from '../types/builders';
 import { RecipleClientAddModuleOptions } from '../types/paramOptions';
 import { Logger as ILogger } from 'fallout-utility';
 import { Config } from './RecipleConfig';
@@ -20,7 +20,7 @@ export interface RecipleClientOptions extends ClientOptions {
  */
 export interface RecipleClientCommands {
     slashCommands: {
-        [commandName: string]: SlashCommandBuilder;
+        [commandName: string]: AnySlashCommandBuilder;
     };
     messageCommands: {
         [commandName: string]: MessageCommandBuilder;

package/bin/reciple/classes/RecipleClient.js

@@ -16,11 +16,11 @@ exports.RecipleClient = void 0;
 const MessageCommandBuilder_1 = require("./builders/MessageCommandBuilder");
 const SlashCommandBuilder_1 = require("./builders/SlashCommandBuilder");
 const registerApplicationCommands_1 = require("../registerApplicationCommands");
+const builders_1 = require("../types/builders");
 const commands_1 = require("../types/commands");
 const permissions_1 = require("../permissions");
 const CommandCooldownManager_1 = require("./CommandCooldownManager");
 const MessageCommandOptionManager_1 = require("./MessageCommandOptionManager");
-const builders_1 = require("../types/builders");
 const fallout_utility_1 = require("fallout-utility");
 const RecipleConfig_1 = require("./RecipleConfig");
 const modules_1 = require("../modules");

package/bin/reciple/classes/builders/MessageCommandBuilder.d.ts

@@ -1,5 +1,5 @@
 import { CommandBuilderType, CommandHaltFunction, CommandExecuteFunction, SharedCommandBuilderProperties } from '../../types/builders';
-import { AnyCommandExecuteData, BaseCommandExecuteData, CommandHaltData } from '../../types/commands';
+import { BaseCommandExecuteData, CommandHaltData } from '../../types/commands';
 import { Message, PermissionResolvable, RestOrArray } from 'discord.js';
 import { MessageCommandOptionManager } from '../MessageCommandOptionManager';
 import { MessageCommandOptionBuilder } from './MessageCommandOptionBuilder';
@@ -90,15 +90,15 @@ export declare class MessageCommandBuilder implements SharedCommandBuilderProper
     setCooldown(cooldown: number): this;
     setRequiredBotPermissions(...permissions: RestOrArray<PermissionResolvable>): this;
     setRequiredMemberPermissions(...permissions: RestOrArray<PermissionResolvable>): this;
-    setHalt(halt?: this["halt"]): this;
-    setExecute(execute: this["execute"]): this;
+    setHalt(halt?: MessageCommandHaltFunction | null): this;
+    setExecute(execute: MessageCommandExecuteFunction): this;
     /**
      * Is a message command builder
      */
-    static isMessageCommandBuilder(builder: any): builder is MessageCommandBuilder;
+    static isMessageCommandBuilder(builder: unknown): builder is MessageCommandBuilder;
     /**
      * Is a message command execute data
      */
-    static isMessageCommandExecuteData(executeData: AnyCommandExecuteData): executeData is MessageCommandExecuteData;
+    static isMessageCommandExecuteData(executeData: unknown): executeData is MessageCommandExecuteData;
 }
 export declare function validateMessageCommandOptions(builder: MessageCommandBuilder, options: CommandMessage): Promise<MessageCommandOptionManager>;

package/bin/reciple/classes/builders/MessageCommandBuilder.js

@@ -125,7 +125,7 @@ class MessageCommandBuilder {
         return this;
     }
     setHalt(halt) {
-        this.halt = halt ? halt : undefined;
+        this.halt = halt !== null && halt !== void 0 ? halt : undefined;
         return this;
     }
     setExecute(execute) {

package/bin/reciple/classes/builders/SlashCommandBuilder.d.ts

@@ -1,12 +1,12 @@
-import { CommandBuilderType, CommandHaltFunction, CommandExecuteFunction, SharedCommandBuilderProperties } from '../../types/builders';
-import { AnyCommandExecuteData, BaseCommandExecuteData, CommandHaltData } from '../../types/commands';
-import { ChatInputCommandInteraction, PermissionResolvable, RestOrArray, SlashCommandBuilder as DiscordJsSlashCommandBuilder, SlashCommandSubcommandBuilder, SlashCommandSubcommandGroupBuilder, SlashCommandSubcommandsOnlyBuilder as DiscordJsSlashCommandSubcommandsOnlyBuilder } from 'discord.js';
+import { CommandBuilderType, CommandHaltFunction, CommandExecuteFunction, SharedCommandBuilderProperties, AnySlashCommandBuilder } from '../../types/builders';
+import { BaseCommandExecuteData, CommandHaltData } from '../../types/commands';
+import { ChatInputCommandInteraction, PermissionResolvable, RestOrArray, SlashCommandBuilder as DiscordJsSlashCommandBuilder, SlashCommandSubcommandBuilder, SlashCommandSubcommandGroupBuilder, SlashCommandBooleanOption, SlashCommandUserOption, SlashCommandChannelOption, SlashCommandRoleOption, SlashCommandAttachmentOption, SlashCommandMentionableOption, SlashCommandStringOption, SlashCommandIntegerOption, SlashCommandNumberOption } from 'discord.js';
 /**
  * Execute data for slash command
  */
 export interface SlashCommandExecuteData extends BaseCommandExecuteData {
     interaction: ChatInputCommandInteraction;
-    builder: SlashCommandBuilder;
+    builder: AnySlashCommandBuilder;
 }
 /**
  * Slash command halt data
@@ -20,16 +20,25 @@ export declare type SlashCommandHaltFunction = CommandHaltFunction<CommandBuilde
  * Slash command execute function
  */
 export declare type SlashCommandExecuteFunction = CommandExecuteFunction<CommandBuilderType.SlashCommand>;
-export interface SlashCommandSubcommandsOnlyBuilder extends DiscordJsSlashCommandSubcommandsOnlyBuilder, Pick<SlashCommandBuilder, "setCooldown" | "setRequiredBotPermissions" | "setRequiredMemberPermissions" | "setHalt" | "setExecute"> {
-}
+export declare type SlashCommandSubcommandsOnlyBuilder = Omit<SlashCommandBuilder, "addBooleanOption" | "addUserOption" | "addChannelOption" | "addRoleOption" | "addAttachmentOption" | "addMentionableOption" | "addStringOption" | "addIntegerOption" | "addNumberOption">;
+export declare type SlashCommandOptionsOnlyBuilder = Omit<SlashCommandBuilder, "addSubcommand" | "addSubcommandGroup">;
 export interface SlashCommandBuilder extends DiscordJsSlashCommandBuilder {
     addSubcommandGroup(input: SlashCommandSubcommandGroupBuilder | ((subcommandGroup: SlashCommandSubcommandGroupBuilder) => SlashCommandSubcommandGroupBuilder)): SlashCommandSubcommandsOnlyBuilder;
     addSubcommand(input: SlashCommandSubcommandBuilder | ((subcommandGroup: SlashCommandSubcommandBuilder) => SlashCommandSubcommandBuilder)): SlashCommandSubcommandsOnlyBuilder;
+    addBooleanOption(input: SlashCommandBooleanOption | ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption)): Omit<this, "addSubcommand" | "addSubcommandGroup">;
+    addUserOption(input: SlashCommandUserOption | ((builder: SlashCommandUserOption) => SlashCommandUserOption)): Omit<this, "addSubcommand" | "addSubcommandGroup">;
+    addChannelOption(input: SlashCommandChannelOption | ((builder: SlashCommandChannelOption) => SlashCommandChannelOption)): Omit<this, "addSubcommand" | "addSubcommandGroup">;
+    addRoleOption(input: SlashCommandRoleOption | ((builder: SlashCommandRoleOption) => SlashCommandRoleOption)): Omit<this, "addSubcommand" | "addSubcommandGroup">;
+    addAttachmentOption(input: SlashCommandAttachmentOption | ((builder: SlashCommandAttachmentOption) => SlashCommandAttachmentOption)): Omit<this, "addSubcommand" | "addSubcommandGroup">;
+    addMentionableOption(input: SlashCommandMentionableOption | ((builder: SlashCommandMentionableOption) => SlashCommandMentionableOption)): Omit<this, "addSubcommand" | "addSubcommandGroup">;
+    addStringOption(input: SlashCommandStringOption | Omit<SlashCommandStringOption, 'setAutocomplete'> | Omit<SlashCommandStringOption, 'addChoices'> | ((builder: SlashCommandStringOption) => SlashCommandStringOption | Omit<SlashCommandStringOption, 'setAutocomplete'> | Omit<SlashCommandStringOption, 'addChoices'>)): Omit<this, "addSubcommand" | "addSubcommandGroup">;
+    addIntegerOption(input: SlashCommandIntegerOption | Omit<SlashCommandIntegerOption, 'setAutocomplete'> | Omit<SlashCommandIntegerOption, 'addChoices'> | ((builder: SlashCommandIntegerOption) => SlashCommandIntegerOption | Omit<SlashCommandIntegerOption, 'setAutocomplete'> | Omit<SlashCommandIntegerOption, 'addChoices'>)): Omit<this, "addSubcommand" | "addSubcommandGroup">;
+    addNumberOption(input: SlashCommandNumberOption | Omit<SlashCommandNumberOption, 'setAutocomplete'> | Omit<SlashCommandNumberOption, 'addChoices'> | ((builder: SlashCommandNumberOption) => SlashCommandNumberOption | Omit<SlashCommandNumberOption, 'setAutocomplete'> | Omit<SlashCommandNumberOption, 'addChoices'>)): Omit<this, "addSubcommand" | "addSubcommandGroup">;
 }
 /**
  * Reciple builder for slash command
  */
-export declare class SlashCommandBuilder extends DiscordJsSlashCommandBuilder implements SharedCommandBuilderProperties, SlashCommandBuilder {
+export declare class SlashCommandBuilder extends DiscordJsSlashCommandBuilder implements SharedCommandBuilderProperties {
     readonly type = CommandBuilderType.SlashCommand;
     cooldown: number;
     requiredBotPermissions: PermissionResolvable[];
@@ -40,14 +49,14 @@ export declare class SlashCommandBuilder extends DiscordJsSlashCommandBuilder im
     setCooldown(cooldown: number): this;
     setRequiredBotPermissions(...permissions: RestOrArray<PermissionResolvable>): this;
     setRequiredMemberPermissions(...permissions: RestOrArray<PermissionResolvable>): this;
-    setHalt(halt?: this["halt"]): this;
-    setExecute(execute: this["execute"]): this;
+    setHalt(halt?: SlashCommandHaltFunction | null): this;
+    setExecute(execute: SlashCommandExecuteFunction): this;
     /**
      * Is a slash command builder
      */
-    static isSlashCommandBuilder(builder: any): builder is SlashCommandBuilder;
+    static isSlashCommandBuilder(builder: unknown): builder is SlashCommandBuilder;
     /**
      * Is a slash command execute data
      */
-    static isSlashCommandExecuteData(executeData: AnyCommandExecuteData): executeData is SlashCommandExecuteData;
+    static isSlashCommandExecuteData(executeData: unknown): executeData is SlashCommandExecuteData;
 }

package/bin/reciple/classes/builders/SlashCommandBuilder.js

@@ -29,7 +29,7 @@ class SlashCommandBuilder extends discord_js_1.SlashCommandBuilder {
         return this;
     }
     setHalt(halt) {
-        this.halt = halt ? halt : undefined;
+        this.halt = halt !== null && halt !== void 0 ? halt : undefined;
         return this;
     }
     setExecute(execute) {

package/bin/reciple/modules.d.ts

@@ -10,8 +10,8 @@ export declare type LoadedModules = {
 export interface RecipleScript {
     versions: string | string[];
     commands?: AnyCommandBuilder[];
-    onLoad?(reciple: RecipleClient): void | Promise<void>;
-    onStart(reciple: RecipleClient): boolean | Promise<boolean>;
+    onLoad?(client: RecipleClient): void | Promise<void>;
+    onStart(client: RecipleClient): boolean | Promise<boolean>;
 }
 /**
  * Reciple module object

package/bin/reciple/registerApplicationCommands.d.ts

@@ -1,7 +1,7 @@
 import { ContextMenuCommandBuilder, SlashCommandBuilder as DiscordJsSlashCommandBuilder } from 'discord.js';
-import { SlashCommandBuilder } from './classes/builders/SlashCommandBuilder';
 import { RegisterApplicationCommandsOptions } from './types/paramOptions';
-export declare type ApplicationCommandBuilder = SlashCommandBuilder | ContextMenuCommandBuilder | DiscordJsSlashCommandBuilder;
+import { AnySlashCommandBuilder } from './types/builders';
+export declare type ApplicationCommandBuilder = AnySlashCommandBuilder | ContextMenuCommandBuilder | DiscordJsSlashCommandBuilder;
 /**
  * Register application commands
  * @param options Register application commands options

package/bin/reciple/types/builders.d.ts

@@ -1,10 +1,14 @@
 import { MessageCommandBuilder, MessageCommandExecuteData, MessageCommandExecuteFunction, MessageCommandHaltData, MessageCommandHaltFunction } from '../classes/builders/MessageCommandBuilder';
-import { SlashCommandBuilder, SlashCommandExecuteData, SlashCommandExecuteFunction, SlashCommandHaltData, SlashCommandHaltFunction } from '../classes/builders/SlashCommandBuilder';
+import { SlashCommandBuilder, SlashCommandExecuteData, SlashCommandExecuteFunction, SlashCommandHaltData, SlashCommandHaltFunction, SlashCommandOptionsOnlyBuilder, SlashCommandSubcommandsOnlyBuilder } from '../classes/builders/SlashCommandBuilder';
 import { Awaitable, PermissionResolvable, RestOrArray } from 'discord.js';
 /**
  * Any command builders
  */
-export declare type AnyCommandBuilder = SlashCommandBuilder | MessageCommandBuilder;
+export declare type AnyCommandBuilder = AnySlashCommandBuilder | MessageCommandBuilder;
+/**
+ * Any slash command builders
+ */
+export declare type AnySlashCommandBuilder = SlashCommandBuilder | SlashCommandOptionsOnlyBuilder | SlashCommandSubcommandsOnlyBuilder;
 /**
  * Any command halt functions
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reciple",
-  "version": "5.1.1",
+  "version": "5.1.2",
   "bin": "bin/bin.js",
   "license": "GPL-3.0",
   "main": "bin/index.js",
@@ -57,8 +57,8 @@
     "yaml": "^2.1.1"
   },
   "devDependencies": {
-    "@types/node": "^18.7.1",
-    "@types/semver": "^7.3.11",
+    "@types/node": "^18.7.6",
+    "@types/semver": "^7.3.12",
     "discord.js": "^14.2.0",
     "rimraf": "^3.0.2",
     "typedoc": "^0.23.10",