feat: support for text content

[player21o]

This is a bare-bones implementation of content support for menus. Currently it supports only text.
One major change is the addition of replyWithMenu function which makes it possible to send a menu without specifying text of message (because the text is already specified inside the menu). Example usage:

bot.command("start", async (ctx) => {
  await ctx.replyWithMenu("main");
});

Example of specifying menu's text:

const menu = new Menu("main", {
  content: { text: "This is the main menu!" },
}).text("Hello world");

Dynamic labels:

const menu = new Menu("main", {
  content: { text: (ctx) => `Your ID is ${ctx.chatId}` },
}).text("Hello world");

[KnorpelSenf]

This is generally a good approach, but I still have some concerns regarding flexibility.

[KnorpelSenf]

How can a menu be sent to a different chat?

[player21o]

Like that:

bot.command("start", async (ctx) => {
  await ctx.api.sendMessage(
    ctx.chatId,
    "This text will be edited by menu plugin",
    { reply_markup: home_menu }
  );
});

This approach looks kinda janky, so I'd introduce a sendMenu method in ctx.api:

Object.assign(ctx.api, {sendMenu: (chat_id: string | number, menu_id: 'string') => ctx.sendMessage(chat_id, 'a', {reply_markup: this.at(menu_id)})})

[KnorpelSenf]

That's one option.

How about introducing ctx.menu.replyWith("main-menu") instead of polluting ctx directly? We could then also introduce ctx.menu.send or something which would have a chat_id param.

[player21o]

So I put these methods in MenuControlPanel, but I get an error, because this control panel is available only in menus, not outside of them. So this just produces an error:

bot.command("start", async (ctx) => {
  await ctx.menu.replyWith("main");
});

And this works, because of the reasons stated above:

const menu = new Menu("main", {
  content: { text: (ctx) => `Your ID is ${ctx.chatId}` },
}).text("Hello world", (ctx) => ctx.menu.replyWith("sub"));

We could move the control panel into the middleware, but I fear that this will break something. Is there another way?

[KnorpelSenf]

Ahhh that's a good point. I guess my suggestion doesn't work well.

We probably want to support sending a menu from arbitrary handlers, not just button handlers. This means we must introduce a new context flavour that people can install for their middleware.

We can then enable ctx.replyWithMenu anywhere in the middleware tree.

[KnorpelSenf]

#57 (comment) still needs to be done.

1. Create a new context flavour that can be used in middleware
2. Move replyWithMenu to it

[player21o]

Yeah i accidentally clicked on that one😅 Anyway, here is my commit. I created a new middleware that contains the functions discussed above and I also introduced some options for menu content.