ctx.setCommands not recognized

[dominicpaul1911]

I am a noob to telegram bot development and grammy. I installed all of the necessary packages including Grammy and @grammyjs/commands. But I am running into below error, setMyCommands not found on ctx. Could you please help me.

[KnorpelSenf]

What's the error that you're seeing?

[dominicpaul1911]

What's the error that you're seeing?

In loggedOutCommands.command method, the ctx object I receive from callback, does not recognize setMyCommands

[KnorpelSenf]

You need to include the actual error message in full.

Alternatively, consider posting your code. Right now, the only thing you gave away is an image of the code. This means that people would have to type out the entire source code you wrote if they wanted to reproduce the issue. That's tedious. Without reproducing the issue, it's very hard to help.

[KnightNiwrem]

I am a noob to telegram bot development and grammy. I installed all of the necessary packages including Grammy and @grammyjs/commands. But I am running into below error, setMyCommands not found on ctx. Could you please help me.

CommandsFlavor is a transformative type flavor, so you should be doing CommandsFlavor<Context> instead.

[KnorpelSenf]

Great catch, our documentation is wrong: https://grammy.dev/plugins/commands#context-shortcut

[dominicpaul1911]

I changed the code as suggested. Issue remains, setMyCommands method is not recognizable on ctx object

import { Bot, Context } from "grammy";
// import { Menu } from "@grammyjs/menu";
import { CommandGroup, CommandsFlavor, commands } from "@grammyjs/commands";

// TOKEN
const token = "";

// Use the flavor to create a custom context
type MyContext = CommandsFlavor<Context>;

// Use the new context to instantiate your bot
const bot = new Bot<MyContext>(token);

// Register the context shortcut
bot.use(commands());


const loggedOutCommands = new CommandGroup();
const loggedInCommands = new CommandGroup(); 

loggedOutCommands.command(
  "login",
  "Start your session with the bot",
  async (ctx) => {
    await ctx.setMyCommands(loggedInCommands);
    await ctx.reply("Welcome! Session started!");
  },
);

loggedInCommands.command(
  "logout",
  "End your session with the bot",
  async (ctx) => {
    await ctx.setMyCommands(loggedOutCommands);
    await ctx.reply("Goodbye :)");
  },
);

bot.use(loggedInCommands);
bot.use(loggedOutCommands);

// By default, users are not logged in,
// so you can set the logged out commands for everyone
await loggedOutCommands.setCommands(bot);

[KnightNiwrem]

I changed the code as suggested. Issue remains, setMyCommands method is not recognizable on ctx object

`import { Bot, Context } from "grammy"; // import { Menu } from "@grammyjs/menu"; import { CommandGroup, CommandsFlavor, commands } from "@grammyjs/commands";

// TOKEN const token = "";

// Use the flavor to create a custom context type MyContext = CommandsFlavor;

// Use the new context to instantiate your bot const bot = new Bot(token);

// Register the context shortcut bot.use(commands());

const loggedOutCommands = new CommandGroup(); const loggedInCommands = new CommandGroup();

loggedOutCommands.command( "login", "Start your session with the bot", async (ctx) => { await ctx.setMyCommands(loggedInCommands); await ctx.reply("Welcome! Session started!"); }, );

loggedInCommands.command( "logout", "End your session with the bot", async (ctx) => { await ctx.setMyCommands(loggedOutCommands); await ctx.reply("Goodbye :)"); }, );

bot.use(loggedInCommands); bot.use(loggedOutCommands);

// By default, users are not logged in, // so you can set the logged out commands for everyone await loggedOutCommands.setCommands(bot);`

I don't see the part where you "changed the code as suggested". For the current code shown, the error is completely expected.

I get the part of just doing type MyContext = CommandFlavor, taking advantage of the fact that CommandFlavor extends Context. But you have also changed new Bot<MyContext>() to new Bot(), so your MyContext type is right, but it's also just floating around doing nothing useful as it is not being used.

[carafelix]

Addressed in:
grammyjs/website#1186
grammyjs/website@ec14c95

[KnightNiwrem]

Thanks for the report @dominicpaul1911!

There are several issues going on here, but just to address your final issue, the documentations should have said new CommandGroup<MyContext>() instead. Check out the following screenshot that demonstrates the difference between the two:

Do note that this doesn't actually fully resolve your type issues in your use case, where the commandGroups circular set each other. Check out the following comment for more details.

[KnightNiwrem]

@carafelix Currently the type of CommandsFlavor is interface CommandsFlavor<C extends Context = Context> extends Context {}.

Let us begin with this example provided by the issue author:

Notice that ctx.setMyCommands exists as a property, but the type of CommandGroup expected is CommandGroup<Context>. This is because of the proposed documented type type MyContext = Context & CommandsFlavor<Context>, where the C in C extends Context is just the base Context. Hence, the method will expect CommandGroup<Context> rather than CommandGroup<MyContext>. Ironically, it is impossible to do new CommandGroup() instead of new CommandGroup<MyContext>(), because the type of Context needs to be extended so that ctx.setMyCommands exists.

[carafelix]

Thanks for pointing it out @KnightNiwrem
grammyjs/website@c07981c
grammyjs/website@65307d3