@grammyjs/commands 1.0.3 → 1.0.4

package/out/command-group.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.commandNotFound = exports.CommandGroup = void 0;
+exports.CommandGroup = void 0;
+exports.commandNotFound = commandNotFound;
 const mod_js_1 = require("./mod.js");
 const deps_node_js_1 = require("./deps.node.js");
 const array_js_1 = require("./utils/array.js");
@@ -249,7 +250,6 @@ function commandNotFound(commands, opts = {}) {
         return false;
     };
 }
-exports.commandNotFound = commandNotFound;
 function containsCommands(ctx, commands) {
     let allPrefixes = [
         ...new Set((0, array_js_1.ensureArray)(commands).flatMap((cmds) => cmds.prefixes)),

package/out/command.d.ts

@@ -2,6 +2,25 @@ import { type BotCommand, type BotCommandScope, type BotCommandScopeAllChatAdmin
 import type { CommandOptions } from "./types.js";
 import { type MaybeArray } from "./utils/array.js";
 type BotCommandGroupsScope = BotCommandScopeAllGroupChats | BotCommandScopeAllChatAdministrators;
+/**
+ * Represents a matched command, the result of the RegExp match, and the rest of the input.
+ */
+export interface CommandMatch {
+    /**
+     * The matched command.
+     */
+    command: string | RegExp;
+    /**
+     * The rest of the input after the command.
+     */
+    rest: string;
+    /**
+     * The result of the RegExp match.
+     *
+     * Only defined if the command is a RegExp.
+     */
+    match?: RegExpExecArray | null;
+}
 /**
  * Class that represents a single command and allows you to configure it.
  */
@@ -117,6 +136,17 @@ export declare class Command<C extends Context = Context> implements MiddlewareO
     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;
+    /**
+     * Finds the matching command in the given context
+     *
+     * @example
+     * ```ts
+     * // ctx.msg.text = "/delete_123 something"
+     * const match = Command.findMatchingCommand(/delete_(.*)/, { prefix: "/", ignoreCase: true }, ctx)
+     * // match is { command: /delete_(.*)/, rest: ["something"], match: ["delete_123"] }
+     * ```
+     */
+    static findMatchingCommand(command: MaybeArray<string | RegExp>, options: CommandOptions, ctx: Context): CommandMatch | null;
     /**
      * Creates a matcher for the given command that can be used in filtering operations
      *

package/out/command.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 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 checks_js_1 = require("./utils/checks.js");
+const errors_js_1 = require("./utils/errors.js");
 const NOCASE_COMMAND_NAME_REGEX = /^[0-9a-z_]+$/i;
 /**
  * Class that represents a single command and allows you to configure it.
@@ -165,6 +165,58 @@ class Command {
         this._scopes.push(scope);
         return this;
     }
+    /**
+     * Finds the matching command in the given context
+     *
+     * @example
+     * ```ts
+     * // ctx.msg.text = "/delete_123 something"
+     * const match = Command.findMatchingCommand(/delete_(.*)/, { prefix: "/", ignoreCase: true }, ctx)
+     * // match is { command: /delete_(.*)/, rest: ["something"], match: ["delete_123"] }
+     * ```
+     */
+    static findMatchingCommand(command, options, ctx) {
+        var _a;
+        const { matchOnlyAtStart, prefix, targetedCommands } = options;
+        if (!ctx.has(":text"))
+            return null;
+        if (matchOnlyAtStart && !ctx.msg.text.startsWith(prefix)) {
+            return null;
+        }
+        const commandNames = (0, array_js_1.ensureArray)(command);
+        const escapedPrefix = prefix.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+        const commandRegex = new RegExp(`${escapedPrefix}(?<command>[^@ ]+)(?:@(?<username>[^\\s]*))?(?<rest>.*)`, "g");
+        const firstCommand = (_a = commandRegex.exec(ctx.msg.text)) === null || _a === void 0 ? void 0 : _a.groups;
+        if (!firstCommand)
+            return null;
+        if (!firstCommand.username && targetedCommands === "required")
+            return null;
+        if (firstCommand.username && firstCommand.username !== ctx.me.username) {
+            return null;
+        }
+        if (firstCommand.username && targetedCommands === "ignored")
+            return null;
+        const matchingCommand = commandNames.find((name) => {
+            const matches = (0, checks_js_1.matchesPattern)(name instanceof RegExp
+                ? firstCommand.command + firstCommand.rest
+                : firstCommand.command, name, options.ignoreCase);
+            return matches;
+        });
+        if (matchingCommand instanceof RegExp) {
+            return {
+                command: matchingCommand,
+                rest: firstCommand.rest.trim(),
+                match: matchingCommand.exec(ctx.msg.text),
+            };
+        }
+        if (matchingCommand) {
+            return {
+                command: matchingCommand,
+                rest: firstCommand.rest.trim(),
+            };
+        }
+        return null;
+    }
     /**
      * Creates a matcher for the given command that can be used in filtering operations
      *
@@ -182,30 +234,14 @@ class Command {
      * @returns A predicate that matches the given command
      */
     static hasCommand(command, options) {
-        const { matchOnlyAtStart, prefix, targetedCommands } = options;
         return (ctx) => {
-            if (!ctx.has(":text"))
-                return false;
-            if (matchOnlyAtStart && !ctx.msg.text.startsWith(prefix)) {
+            const matchingCommand = Command.findMatchingCommand(command, options, ctx);
+            if (!matchingCommand)
                 return false;
-            }
-            const commandNames = (0, array_js_1.ensureArray)(command);
-            const commands = prefix === "/"
-                ? ctx.entities("bot_command")
-                : ctx.msg.text.split(prefix).map((text) => ({ text }));
-            for (const { text } of commands) {
-                const [command, username] = text.split("@");
-                if (targetedCommands === "ignored" && username)
-                    continue;
-                if (targetedCommands === "required" && !username)
-                    continue;
-                if (username && username !== ctx.me.username)
-                    continue;
-                if (commandNames.some((name) => (0, checks_js_1.matchesPattern)(command.replace(prefix, "").split(" ")[0], name, options.ignoreCase))) {
-                    return true;
-                }
-            }
-            return false;
+            ctx.match = matchingCommand.rest;
+            // TODO: Clean this up. But how to do it without requiring the user to install the commands flavor?
+            ctx.commandMatch = matchingCommand;
+            return true;
         };
     }
     /**

package/out/context.d.ts

@@ -1,4 +1,5 @@
 import { CommandGroup } from "./command-group.js";
+import { CommandMatch } from "./command.js";
 import { BotCommandScopeChat, Context, NextFunction } from "./deps.node.js";
 import { SetMyCommandsParams } from "./mod.js";
 import { BotCommandEntity } from "./types.js";
@@ -42,6 +43,12 @@ export interface CommandsFlavor<C extends Context = Context> extends Context {
      * @returns command entities hydrated with the custom prefixes
      */
     getCommandEntities: (commands: CommandGroup<C> | CommandGroup<C>[]) => BotCommandEntity[];
+    /**
+     * The matched command and the rest of the input.
+     *
+     * When matched command is a RegExp, a `match` property exposes the result of the RegExp match.
+     */
+    commandMatch: CommandMatch;
 }
 /**
  * Installs the commands flavor into the context.

package/out/context.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MyCommandParams = exports.commands = void 0;
+exports.MyCommandParams = void 0;
+exports.commands = commands;
 const array_js_1 = require("./utils/array.js");
 const jaro_winkler_js_1 = require("./utils/jaro-winkler.js");
 const set_bot_commands_js_1 = require("./utils/set-bot-commands.js");
@@ -70,7 +71,6 @@ function commands() {
         return next();
     };
 }
-exports.commands = commands;
 /**
  * Static class for getting and manipulating {@link SetMyCommandsParams}.
  * The main function is {@link from}

package/out/utils/array.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCommandsRegex = exports.escapeSpecial = exports.ensureArray = void 0;
+exports.ensureArray = void 0;
+exports.escapeSpecial = escapeSpecial;
+exports.getCommandsRegex = getCommandsRegex;
 const ensureArray = (value) => Array.isArray(value) ? value : [value];
 exports.ensureArray = ensureArray;
 const specialChars = "\\.^$|?*+()[]{}-".split("");
@@ -8,8 +10,6 @@ const replaceAll = (s, find, replace) => s.replace(new RegExp(`\\${find}`, "g"),
 function escapeSpecial(str) {
     return specialChars.reduce((acc, char) => replaceAll(acc, char, `\\${char}`), str);
 }
-exports.escapeSpecial = escapeSpecial;
 function getCommandsRegex(prefix) {
     return new RegExp(`(\?\<\!\\S)(\?<prefix>${escapeSpecial(prefix)})\\S+(\\s|$)`, "g");
 }
-exports.getCommandsRegex = getCommandsRegex;

package/out/utils/checks.js

@@ -1,15 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.matchesPattern = exports.isCommandOptions = exports.isMiddleware = exports.isAdmin = void 0;
+exports.isAdmin = isAdmin;
+exports.isMiddleware = isMiddleware;
+exports.isCommandOptions = isCommandOptions;
+exports.matchesPattern = matchesPattern;
+const deps_node_js_1 = require("../deps.node.js");
 function isAdmin(ctx) {
     return ctx
         .getAuthor()
         .then((author) => ["administrator", "creator"].includes(author.status));
 }
-exports.isAdmin = isAdmin;
 function isMiddleware(obj) {
     if (!obj)
         return false;
+    if (obj instanceof deps_node_js_1.Composer)
+        return true;
     if (Array.isArray(obj))
         return obj.every(isMiddleware);
     const objType = typeof obj;
@@ -21,7 +26,6 @@ function isMiddleware(obj) {
     }
     return false;
 }
-exports.isMiddleware = isMiddleware;
 function isCommandOptions(obj) {
     if (typeof obj !== "object" || !obj)
         return false;
@@ -37,7 +41,6 @@ function isCommandOptions(obj) {
         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")
@@ -47,4 +50,3 @@ function matchesPattern(value, pattern, ignoreCase = false) {
         ? transformedValue === transformedPattern
         : transformedPattern.test(transformedValue);
 }
-exports.matchesPattern = matchesPattern;

package/out/utils/jaro-winkler.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fuzzyMatch = exports.isLanguageCode = exports.JaroWinklerDistance = exports.distance = void 0;
+exports.distance = distance;
+exports.JaroWinklerDistance = JaroWinklerDistance;
+exports.isLanguageCode = isLanguageCode;
+exports.fuzzyMatch = fuzzyMatch;
 const language_codes_js_1 = require("../language-codes.js");
 function distance(s1, s2) {
     if (s1.length === 0 || s2.length === 0) {
@@ -61,7 +64,6 @@ function distance(s1, s2) {
     return (m / s1.length + m / s2.length + (m - t) / m) / 3.0; // HtD: therefore, m - t > 0, and m - t < m
     // HtD: => return value is between 0 and 1
 }
-exports.distance = distance;
 // Computes the Winkler distance between two string -- intrepreted from:
 // http://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance
 // s1 is the first string to compare
@@ -87,11 +89,9 @@ function JaroWinklerDistance(s1, s2, options) {
         return jaro + l * p * (1 - jaro);
     }
 }
-exports.JaroWinklerDistance = JaroWinklerDistance;
 function isLanguageCode(value) {
     return Object.values(language_codes_js_1.LanguageCodes).includes(value);
 }
-exports.isLanguageCode = isLanguageCode;
 function fuzzyMatch(userInput, commands, options) {
     var _a;
     const defaultSimilarityThreshold = 0.82;
@@ -114,4 +114,3 @@ function fuzzyMatch(userInput, commands, options) {
     }, { command: null, similarity: 0 });
     return bestMatch.similarity > similarityThreshold ? bestMatch : null;
 }
-exports.fuzzyMatch = fuzzyMatch;

package/out/utils/set-bot-commands.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setBotCommands = void 0;
+exports.setBotCommands = setBotCommands;
 const errors_js_1 = require("./errors.js");
 /**
  * Performs validation and sets the provided commands for the bot.
@@ -16,4 +16,3 @@ async function setBotCommands(api, commandParams, uncompliantCommands, options)
     }
     await Promise.all(commandParams.map((args) => api.raw.setMyCommands(args)));
 }
-exports.setBotCommands = setBotCommands;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@grammyjs/commands",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "grammY Commands Plugin",
   "main": "out/mod.js",
   "scripts": {
-    "backport": "deno task backport",
-    "prepare": "deno task backport"
+    "backport": "deno2node tsconfig.json",
+    "prepare": "npm run backport"
   },
   "keywords": [
     "grammY",
@@ -27,7 +27,7 @@
     "grammy": "^1.17.1"
   },
   "devDependencies": {
-    "deno-bin": "^2.0.6",
+    "deno2node": "^1.14.0",
     "typescript": "^5.6.3"
   },
   "files": [