@grammyjs/commands 0.6.0 → 0.7.0

package/out/command.d.ts

@@ -17,7 +17,7 @@ export declare class Command<C extends Context = Context> implements MiddlewareO
      *
      * @param name Default command name
      * @param description Default command description
-     * @param options Options object that shuold apply to this command only
+     * @param options Options object that should apply to this command only
      * @access package
      */
     constructor(name: string | RegExp, description: string, options?: Partial<CommandOptions>);
@@ -76,7 +76,7 @@ export declare class Command<C extends Context = Context> implements MiddlewareO
      * ```ts
      * bot
      *  .filter(
-     *    Command.hasCommand(/\/delete_(.*)/),
+     *    Command.hasCommand(/delete_(.*)/),
      *    (ctx) => ctx.reply(`Deleting ${ctx.message?.text?.split("_")[1]}`)
      *  )
      * ```
@@ -96,7 +96,7 @@ export declare class Command<C extends Context = Context> implements MiddlewareO
      *  .localize("pt", "iniciar", "Inicia a configuração do bot")
      * ```
      *
-     * @param languageCode Language this translation applies to
+     * @param languageCode Language this translation applies to. @see https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
      * @param name Localized command name
      * @param description Localized command description
      */

package/out/command.js

@@ -19,7 +19,7 @@ class Command {
      *
      * @param name Default command name
      * @param description Default command description
-     * @param options Options object that shuold apply to this command only
+     * @param options Options object that should apply to this command only
      * @access package
      */
     constructor(name, description, options = {}) {
@@ -125,7 +125,7 @@ class Command {
      * ```ts
      * bot
      *  .filter(
-     *    Command.hasCommand(/\/delete_(.*)/),
+     *    Command.hasCommand(/delete_(.*)/),
      *    (ctx) => ctx.reply(`Deleting ${ctx.message?.text?.split("_")[1]}`)
      *  )
      * ```
@@ -171,13 +171,13 @@ class Command {
      *  .localize("pt", "iniciar", "Inicia a configuração do bot")
      * ```
      *
-     * @param languageCode Language this translation applies to
+     * @param languageCode Language this translation applies to. @see https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
      * @param name Localized command name
      * @param description Localized command description
      */
     localize(languageCode, name, description) {
         this._languages.set(languageCode, {
-            name: new RegExp(name),
+            name: name,
             description,
         });
         return this;
@@ -210,7 +210,9 @@ class Command {
     toObject(languageCode = "default") {
         const localizedName = this.getLocalizedName(languageCode);
         return {
-            command: localizedName instanceof RegExp ? "" : localizedName,
+            command: localizedName instanceof RegExp
+                ? localizedName.source
+                : localizedName,
             description: this.getLocalizedDescription(languageCode),
         };
     }

package/out/commands.d.ts

@@ -1,9 +1,10 @@
 import { Command, MaybeArray } from "./command.js";
-import { Api, BotCommand, BotCommandScope, Context, Middleware } from "./deps.node.js";
+import { Api, BotCommand, BotCommandScope, CommandContext, Context, Middleware } from "./deps.node.js";
 import { CommandOptions } from "./types.js";
-type SetMyCommandsParams = {
+export type SetMyCommandsParams = {
     /**
      * Scope
+     * @param language_code two letter abbreviation in ISO_639 standard: https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
      */
     scope?: BotCommandScope;
     language_code?: string;
@@ -40,7 +41,7 @@ export declare class Commands<C extends Context> {
      * @param options Extra options that should apply only to this command
      * @returns An instance of the `Command` class
      */
-    command(name: string | RegExp, description: string, handler: MaybeArray<Middleware<C>>, options?: Partial<CommandOptions>): Command<C>;
+    command(name: string | RegExp, description: string, handler: MaybeArray<Middleware<CommandContext<C>>>, options?: Partial<CommandOptions>): Command<C>;
     /**
      * Registers a new command with no handlers.
      * @param name Default command name
@@ -51,7 +52,6 @@ export declare class Commands<C extends Context> {
     command(name: string | RegExp, description: string, options?: Partial<CommandOptions>): Command<C>;
     /**
      * Serializes the commands into multiple objects that can each be passed to a `setMyCommands` call.
-     *
      * @returns One item for each combination of command + scope + language
      */
     toArgs(): SetMyCommandsParams[];
@@ -81,4 +81,3 @@ export declare class Commands<C extends Context> {
     toString(): string;
     middleware(): import("grammy").MiddlewareFn<C>;
 }
-export {};

package/out/commands.js

@@ -77,7 +77,6 @@ class Commands {
     }
     /**
      * Serializes the commands into multiple objects that can each be passed to a `setMyCommands` call.
-     *
      * @returns One item for each combination of command + scope + language
      */
     toArgs() {
@@ -112,6 +111,7 @@ class Commands {
                 language_code: language === "default" ? undefined : language,
                 commands: this._commands
                     .filter((command) => command.scopes.length)
+                    .filter((command) => typeof command.name === "string")
                     .map((command) => command.toObject(language)),
             });
         }

package/out/context.d.ts

@@ -1,6 +1,7 @@
 import { Commands } from "./commands.js";
 import { Context, NextFunction } from "./deps.node.js";
 import { JaroWinklerOptions } from "./jaro-winkler.js";
+import { SetMyCommandsParams } from "./mod.js";
 export interface CommandsFlavor<C extends Context = Context> extends Context {
     /**
      * Sets the provided commands for the current chat.
@@ -9,7 +10,7 @@ export interface CommandsFlavor<C extends Context = Context> extends Context {
      * @param commands List of available commands
      * @returns Promise with the result of the operations
      */
-    setMyCommands: (commands: Commands<C>) => Promise<void>;
+    setMyCommands: (commands: Commands<C>, ...moreCommands: Commands<C>[]) => Promise<void>;
     /**
      * Returns the nearest command to the user input.
      * If no command is found, returns `null`.
@@ -24,3 +25,11 @@ export interface CommandsFlavor<C extends Context = Context> extends Context {
  * Installs the commands flavor into the context.
  */
 export declare function commands<C extends Context>(): (ctx: CommandsFlavor<C>, next: NextFunction) => Promise<void>;
+/**
+ * Iterates over an array of commands params, merging commands when two commandsParams
+ * are from the same language.
+ *
+ * @param commandParams an array of commands params coming from multiple Commands instances
+ * @returns an array containing all commands to be set on ctx
+ */
+export declare function _mergeMyCommandsParams(commandParams: SetMyCommandsParams[][]): SetMyCommandsParams[];

package/out/context.js

@@ -1,18 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.commands = void 0;
+exports._mergeMyCommandsParams = exports.commands = void 0;
 const jaro_winkler_js_1 = require("./jaro-winkler.js");
 /**
  * Installs the commands flavor into the context.
  */
 function commands() {
     return (ctx, next) => {
-        ctx.setMyCommands = async (commands) => {
+        ctx.setMyCommands = async (commands, ...moreCommands) => {
             if (!ctx.chat) {
                 throw new Error("cannot call `ctx.setMyCommands` on an update with no `chat` property");
             }
-            await Promise.all(commands
-                .toSingleScopeArgs({ type: "chat", chat_id: ctx.chat.id })
+            const commandsParams = [commands].concat(moreCommands).map((commands) => commands.toSingleScopeArgs({
+                type: "chat",
+                chat_id: ctx.chat.id,
+            }));
+            const mergedCommands = _mergeMyCommandsParams(commandsParams);
+            await Promise.all(mergedCommands
                 .map((args) => ctx.api.raw.setMyCommands(args)));
         };
         ctx.getNearestCommand = (commands, options) => {
@@ -27,3 +31,36 @@ function commands() {
     };
 }
 exports.commands = commands;
+/**
+ * Iterates over an array of commands params, merging commands when two commandsParams
+ * are from the same language.
+ *
+ * @param commandParams an array of commands params coming from multiple Commands instances
+ * @returns an array containing all commands to be set on ctx
+ */
+function _mergeMyCommandsParams(commandParams) {
+    if (!commandParams.flat().length)
+        return [];
+    return commandParams
+        .flat()
+        .sort((a, b) => {
+        if (!a.language_code)
+            return -1;
+        if (!b.language_code)
+            return 1;
+        return a.language_code.localeCompare(b.language_code);
+    })
+        .reduce((result, current, i, arr) => {
+        if (i === 0 || current.language_code !== arr[i - 1].language_code) {
+            result.push(current);
+            return result;
+        }
+        else {
+            result[result.length - 1].commands = result[result.length - 1]
+                .commands
+                .concat(current.commands);
+            return result;
+        }
+    }, []);
+}
+exports._mergeMyCommandsParams = _mergeMyCommandsParams;

package/out/deps.node.d.ts

@@ -1,2 +1,2 @@
-export { Api, Bot, type ChatTypeContext, type ChatTypeMiddleware, type CommandMiddleware, Composer, Context, type Middleware, type MiddlewareObj, type NextFunction, } from "grammy";
+export { Api, Bot, type ChatTypeContext, type ChatTypeMiddleware, type CommandContext, type CommandMiddleware, Composer, Context, type Middleware, type MiddlewareObj, type NextFunction, } from "grammy";
 export type { BotCommand, BotCommandScope, BotCommandScopeAllChatAdministrators, BotCommandScopeAllGroupChats, BotCommandScopeAllPrivateChats, Chat, } from "grammy/types";

package/package.json

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