@grammyjs/commands 0.10.0 → 0.11.0

package/out/command-group.d.ts

@@ -70,6 +70,12 @@ export declare class CommandGroup<C extends Context> {
      * @returns An instance of the `Command` class
      */
     command(name: string | RegExp, description: string, options?: Partial<CommandOptions>): Command<C>;
+    /**
+     * Registers a Command that was created by it's own.
+     *
+     * @param command the command or list of commands being added to the group
+     */
+    add(command: Command<C> | Command<C>[]): this;
     /**
      * Serializes the commands into multiple objects that can each be passed to a `setMyCommands` call.
      *

package/out/command-group.js

@@ -5,20 +5,7 @@ const mod_js_1 = require("./mod.js");
 const deps_node_js_1 = require("./deps.node.js");
 const array_js_1 = require("./utils/array.js");
 const set_bot_commands_js_1 = require("./utils/set-bot-commands.js");
-const isMiddleware = (obj) => {
-    if (!obj)
-        return false;
-    if (Array.isArray(obj))
-        return obj.every(isMiddleware);
-    const objType = typeof obj;
-    switch (objType) {
-        case "function":
-            return true;
-        case "object":
-            return Object.keys(obj).includes("middleware");
-    }
-    return false;
-};
+const checks_js_1 = require("./utils/checks.js");
 /**
  * Central class that manages all registered commands.
  * This is the starting point for the plugin, and this is what you should pass to `bot.use` so your commands get properly registered.
@@ -34,6 +21,7 @@ const isMiddleware = (obj) => {
  */
 class CommandGroup {
     constructor(options = {}) {
+        var _a;
         this._languages = new Set();
         this._scopes = new Map();
         this._commands = [];
@@ -41,6 +29,9 @@ class CommandGroup {
         this._cachedComposerInvalidated = false;
         this._commandOptions = {};
         this._commandOptions = options;
+        if (((_a = this._commandOptions.prefix) === null || _a === void 0 ? void 0 : _a.trim()) === "") {
+            this._commandOptions.prefix = "/";
+        }
     }
     _addCommandToScope(scope, command) {
         var _a;
@@ -60,20 +51,27 @@ class CommandGroup {
         });
     }
     command(name, description, handlerOrOptions, _options) {
-        var _a;
-        const handler = isMiddleware(handlerOrOptions)
+        const handler = (0, checks_js_1.isMiddleware)(handlerOrOptions)
             ? handlerOrOptions
             : undefined;
-        const options = handler
-            ? _options !== null && _options !== void 0 ? _options : this._commandOptions
-            : (_a = handlerOrOptions) !== null && _a !== void 0 ? _a : this._commandOptions;
-        const command = new mod_js_1.Command(name, description, options);
-        if (handler)
-            command.addToScope({ type: "default" }, handler);
+        const options = !handler && (0, checks_js_1.isCommandOptions)(handlerOrOptions)
+            ? { ...this._commandOptions, ...handlerOrOptions }
+            : { ...this._commandOptions, ..._options };
+        const command = new mod_js_1.Command(name, description, handler, options);
         this._commands.push(command);
         this._cachedComposerInvalidated = true;
         return command;
     }
+    /**
+     * Registers a Command that was created by it's own.
+     *
+     * @param command the command or list of commands being added to the group
+     */
+    add(command) {
+        this._commands.push(...(0, array_js_1.ensureArray)(command));
+        this._cachedComposerInvalidated = true;
+        return this;
+    }
     /**
      * Serializes the commands into multiple objects that can each be passed to a `setMyCommands` call.
      *

package/out/command.d.ts

@@ -1,8 +1,7 @@
-import { type BotCommand, type BotCommandScope, type BotCommandScopeAllChatAdministrators, type BotCommandScopeAllGroupChats, type BotCommandScopeAllPrivateChats, type ChatTypeMiddleware, type Context, type LanguageCode, type Middleware, type MiddlewareObj } from "./deps.node.js";
+import { type BotCommand, type BotCommandScope, type BotCommandScopeAllChatAdministrators, type BotCommandScopeAllGroupChats, type BotCommandScopeAllPrivateChats, type ChatTypeMiddleware, CommandContext, type Context, type LanguageCode, type Middleware, type MiddlewareObj } from "./deps.node.js";
 import type { CommandOptions } from "./types.js";
 import { type MaybeArray } from "./utils/array.js";
 type BotCommandGroupsScope = BotCommandScopeAllGroupChats | BotCommandScopeAllChatAdministrators;
-export declare const matchesPattern: (value: string, pattern: string | RegExp, ignoreCase?: boolean) => boolean;
 /**
  * Class that represents a single command and allows you to configure it.
  */
@@ -10,17 +9,46 @@ export declare class Command<C extends Context = Context> implements MiddlewareO
     private _scopes;
     private _languages;
     private _composer;
+    private _defaultScopeComposer;
     private _options;
     /**
-     * Constructor for the `Command` class.
-     * Do not call this directly. Instead, use the `command` method from the `Commands` class
+     * Initialize a new command with a default handler.
+     *
+     * [!IMPORTANT] This class by its own does nothing. It needs to be imported into a `CommandGroup`
+     * via the `add` method.
+     *
+     * @example
+     * ```ts
+     *    const sayHi = new Command("hi","say hi", (ctx) => ctx.reply("hi"))
+     *    const myCmds = new CommandGroup().add(sayHi)
+     * ```
+     *
+     * @param name Default command name
+     * @param description Default command description
+     * @param handler Default command handler
+     * @param options Extra options that should apply only to this command
+     * @returns An instance of the `Command` class
+     */
+    constructor(name: string | RegExp, description: string, handler: MaybeArray<Middleware<CommandContext<C>>>, options?: Partial<CommandOptions>);
+    /**
+     * Initialize a new command with no handlers.
+     *
+     * [!IMPORTANT] This class by its own does nothing. It needs to be imported into a `CommandGroup`
+     * via the `add` method
+     *
+     * @example
+     * ```ts
+     *    const sayHi = new Command("hi","say hi", (ctx) => ctx.reply("hi") )
+     *    const myCmds = new CommandGroup().add(sayHi)
+     * ```
      *
      * @param name Default command name
      * @param description Default command description
-     * @param options Options object that should apply to this command only
-     * @access package
+     * @param options Extra options that should apply only to this command
+     * @returns An instance of the `Command` class
      */
     constructor(name: string | RegExp, description: string, options?: Partial<CommandOptions>);
+    constructor(name: string | RegExp, description: string, handlerOrOptions?: MaybeArray<Middleware<CommandContext<C>>> | Partial<CommandOptions>, options?: Partial<CommandOptions>);
     /**
      * Whether the command has a custom prefix
      */
@@ -86,9 +114,9 @@ export declare class Command<C extends Context = Context> implements MiddlewareO
      * @param middleware The handler for this command on the specified scope
      * @param options Additional options that should apply only to this scope
      */
-    addToScope(scope: BotCommandGroupsScope, middleware: MaybeArray<ChatTypeMiddleware<C, "group" | "supergroup">>, options?: Partial<CommandOptions>): this;
-    addToScope(scope: BotCommandScopeAllPrivateChats, middleware: MaybeArray<ChatTypeMiddleware<C, "private">>, options?: Partial<CommandOptions>): this;
-    addToScope(scope: BotCommandScope, middleware: MaybeArray<Middleware<C>>, options?: Partial<CommandOptions>): this;
+    addToScope(scope: BotCommandGroupsScope, middleware?: MaybeArray<ChatTypeMiddleware<C, "group" | "supergroup">>, options?: Partial<CommandOptions>): this;
+    addToScope(scope: BotCommandScopeAllPrivateChats, middleware?: MaybeArray<ChatTypeMiddleware<C, "private">>, options?: Partial<CommandOptions>): this;
+    addToScope(scope: BotCommandScope, middleware?: MaybeArray<Middleware<C>>, options?: Partial<CommandOptions>): this;
     /**
      * Creates a matcher for the given command that can be used in filtering operations
      *

package/out/command.js

@@ -1,50 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Command = exports.matchesPattern = void 0;
+exports.Command = void 0;
 const deps_node_js_1 = require("./deps.node.js");
 const errors_js_1 = require("./utils/errors.js");
 const array_js_1 = require("./utils/array.js");
-const isAdmin = (ctx) => ctx
-    .getAuthor()
-    .then((author) => ["administrator", "creator"].includes(author.status));
-const matchesPattern = (value, pattern, ignoreCase = false) => {
-    const transformedValue = ignoreCase ? value.toLowerCase() : value;
-    const transformedPattern = pattern instanceof RegExp && ignoreCase && !pattern.flags.includes("i")
-        ? new RegExp(pattern, pattern.flags + "i")
-        : pattern;
-    return typeof transformedPattern === "string"
-        ? transformedValue === transformedPattern
-        : transformedPattern.test(transformedValue);
-};
-exports.matchesPattern = matchesPattern;
+const checks_js_1 = require("./utils/checks.js");
 const NOCASE_COMMAND_NAME_REGEX = /^[0-9a-z_]+$/i;
 /**
  * Class that represents a single command and allows you to configure it.
  */
 class Command {
-    /**
-     * Constructor for the `Command` class.
-     * Do not call this directly. Instead, use the `command` method from the `Commands` class
-     *
-     * @param name Default command name
-     * @param description Default command description
-     * @param options Options object that should apply to this command only
-     * @access package
-     */
-    constructor(name, description, options = {}) {
+    constructor(name, description, handlerOrOptions, options) {
+        var _a;
         this._scopes = [];
         this._languages = new Map();
         this._composer = new deps_node_js_1.Composer();
+        this._defaultScopeComposer = new deps_node_js_1.Composer();
         this._options = {
             prefix: "/",
             matchOnlyAtStart: true,
             targetedCommands: "optional",
             ignoreCase: false,
         };
+        const handler = (0, checks_js_1.isMiddleware)(handlerOrOptions)
+            ? handlerOrOptions
+            : undefined;
+        options = !handler && (0, checks_js_1.isCommandOptions)(handlerOrOptions)
+            ? handlerOrOptions
+            : options;
         this._options = { ...this._options, ...options };
-        if (this._options.prefix === "")
+        if (((_a = this._options.prefix) === null || _a === void 0 ? void 0 : _a.trim()) === "")
             this._options.prefix = "/";
         this._languages.set("default", { name: name, description });
+        if (handler) {
+            this.addToScope({ type: "default" }, handler);
+        }
+        return this;
     }
     /**
      * Whether the command has a custom prefix
@@ -121,53 +112,55 @@ class Command {
         return this._options.prefix;
     }
     addToScope(scope, middleware, options = this._options) {
-        const middlewareArray = (0, array_js_1.ensureArray)(middleware);
+        const middlewareArray = middleware ? (0, array_js_1.ensureArray)(middleware) : undefined;
         const optionsObject = { ...this._options, ...options };
-        switch (scope.type) {
-            case "default":
-                this._composer
-                    .filter(Command.hasCommand(this.names, optionsObject))
-                    .use(...middlewareArray);
-                break;
-            case "all_chat_administrators":
-                this._composer
-                    .filter(Command.hasCommand(this.names, optionsObject))
-                    .filter(isAdmin)
-                    .use(...middlewareArray);
-                break;
-            case "all_private_chats":
-                this._composer
-                    .filter(Command.hasCommand(this.names, optionsObject))
-                    .chatType("private")
-                    .use(...middlewareArray);
-                break;
-            case "all_group_chats":
-                this._composer
-                    .filter(Command.hasCommand(this.names, optionsObject))
-                    .chatType(["group", "supergroup"])
-                    .use(...middlewareArray);
-                break;
-            case "chat":
-            case "chat_administrators":
-                if (scope.chat_id) {
+        if (middlewareArray) {
+            switch (scope.type) {
+                case "default":
+                    this._defaultScopeComposer
+                        .filter(Command.hasCommand(this.names, optionsObject))
+                        .use(...middlewareArray);
+                    break;
+                case "all_chat_administrators":
                     this._composer
                         .filter(Command.hasCommand(this.names, optionsObject))
-                        .filter((ctx) => { var _a; return ((_a = ctx.chat) === null || _a === void 0 ? void 0 : _a.id) === scope.chat_id; })
-                        .filter(isAdmin)
+                        .filter(checks_js_1.isAdmin)
                         .use(...middlewareArray);
-                }
-                break;
-            case "chat_member":
-                if (scope.chat_id && scope.user_id) {
+                    break;
+                case "all_private_chats":
                     this._composer
                         .filter(Command.hasCommand(this.names, optionsObject))
-                        .filter((ctx) => { var _a; return ((_a = ctx.chat) === null || _a === void 0 ? void 0 : _a.id) === scope.chat_id; })
-                        .filter((ctx) => { var _a; return ((_a = ctx.from) === null || _a === void 0 ? void 0 : _a.id) === scope.user_id; })
+                        .chatType("private")
                         .use(...middlewareArray);
-                }
-                break;
-            default:
-                throw new errors_js_1.InvalidScopeError(scope);
+                    break;
+                case "all_group_chats":
+                    this._composer
+                        .filter(Command.hasCommand(this.names, optionsObject))
+                        .chatType(["group", "supergroup"])
+                        .use(...middlewareArray);
+                    break;
+                case "chat":
+                case "chat_administrators":
+                    if (scope.chat_id) {
+                        this._composer
+                            .filter(Command.hasCommand(this.names, optionsObject))
+                            .filter((ctx) => { var _a; return ((_a = ctx.chat) === null || _a === void 0 ? void 0 : _a.id) === scope.chat_id; })
+                            .filter(checks_js_1.isAdmin)
+                            .use(...middlewareArray);
+                    }
+                    break;
+                case "chat_member":
+                    if (scope.chat_id && scope.user_id) {
+                        this._composer
+                            .filter(Command.hasCommand(this.names, optionsObject))
+                            .filter((ctx) => { var _a; return ((_a = ctx.chat) === null || _a === void 0 ? void 0 : _a.id) === scope.chat_id; })
+                            .filter((ctx) => { var _a; return ((_a = ctx.from) === null || _a === void 0 ? void 0 : _a.id) === scope.user_id; })
+                            .use(...middlewareArray);
+                    }
+                    break;
+                default:
+                    throw new errors_js_1.InvalidScopeError(scope);
+            }
         }
         this._scopes.push(scope);
         return this;
@@ -208,7 +201,7 @@ class Command {
                     continue;
                 if (username && username !== ctx.me.username)
                     continue;
-                if (commandNames.some((name) => (0, exports.matchesPattern)(command.replace(prefix, ""), name, options.ignoreCase))) {
+                if (commandNames.some((name) => (0, checks_js_1.matchesPattern)(command.replace(prefix, ""), name, options.ignoreCase))) {
                     return true;
                 }
             }
@@ -271,7 +264,8 @@ class Command {
         };
     }
     middleware() {
-        return this._composer.middleware();
+        return new deps_node_js_1.Composer(this._composer, this._defaultScopeComposer)
+            .middleware();
     }
 }
 exports.Command = Command;

package/out/utils/checks.d.ts

@@ -0,0 +1,7 @@
+import { Context, Middleware } from "../deps.node.js";
+import { CommandOptions } from "../types.js";
+import { MaybeArray } from "./array.js";
+export declare function isAdmin(ctx: Context): Promise<boolean>;
+export declare function isMiddleware<C extends Context = Context>(obj: unknown): obj is MaybeArray<Middleware<C>>;
+export declare function isCommandOptions(obj: unknown): obj is Partial<CommandOptions>;
+export declare function matchesPattern(value: string, pattern: string | RegExp, ignoreCase?: boolean): boolean;

package/out/utils/checks.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchesPattern = exports.isCommandOptions = exports.isMiddleware = exports.isAdmin = void 0;
+function isAdmin(ctx) {
+    return ctx
+        .getAuthor()
+        .then((author) => ["administrator", "creator"].includes(author.status));
+}
+exports.isAdmin = isAdmin;
+function isMiddleware(obj) {
+    if (!obj)
+        return false;
+    if (Array.isArray(obj))
+        return obj.every(isMiddleware);
+    const objType = typeof obj;
+    switch (objType) {
+        case "function":
+            return true;
+        case "object":
+            return Object.keys(obj).includes("middleware");
+    }
+    return false;
+}
+exports.isMiddleware = isMiddleware;
+function isCommandOptions(obj) {
+    if (typeof obj !== "object" || !obj)
+        return false;
+    const { prefix, matchOnlyAtStart, targetedCommands, ignoreCase } = obj;
+    if (typeof prefix === "string")
+        return true;
+    if (typeof matchOnlyAtStart === "boolean")
+        return true;
+    if (targetedCommands &&
+        ["ignored", "optional", "required"].includes(targetedCommands))
+        return true;
+    if (typeof ignoreCase === "boolean")
+        return true;
+    return false;
+}
+exports.isCommandOptions = isCommandOptions;
+function matchesPattern(value, pattern, ignoreCase = false) {
+    const transformedValue = ignoreCase ? value.toLowerCase() : value;
+    const transformedPattern = pattern instanceof RegExp && ignoreCase && !pattern.flags.includes("i")
+        ? new RegExp(pattern, pattern.flags + "i")
+        : pattern;
+    return typeof transformedPattern === "string"
+        ? transformedValue === transformedPattern
+        : transformedPattern.test(transformedValue);
+}
+exports.matchesPattern = matchesPattern;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grammyjs/commands",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "grammY Commands Plugin",
   "main": "out/mod.js",
   "scripts": {