@yaebal/callback-data

pnpm add @yaebal/callback-data

import { Bot } from "@yaebal/core";
import { InlineKeyboard } from "@yaebal/keyboard";
import { callbackData, field } from "@yaebal/callback-data";

// a namespace: a prefix + a field schema
const user = callbackData("user", {
  id: Number,                                  // required scalar (shorthand)
  action: field.enum(["ban", "kick", "mute"]), // union type, one char on the wire
  note: field.string().optional(),             // may be absent
  page: field.number().default(1),             // absent → filled with 1
});

const bot = new Bot(process.env.BOT_TOKEN!);

bot.command("manage", (ctx) =>
  ctx.reply("choose:", {
    reply_markup: new InlineKeyboard()
      .text("ban", user.pack({ id: 42, action: "ban" }))
      .text("kick", user.pack({ id: 42, action: "kick", note: "spam" }))
      .build(),
  }),
);

// pass the namespace itself: the payload is validated + decoded to ctx.queryData,
// and this handler runs only on a clean unpack
bot.callbackQuery(user, (ctx) => {
  const { id, action, page } = ctx.queryData; // fully typed
  return ctx.reply(`${action} ${id} (page ${page})`);
});

// prefer passing the namespace (typed ctx.queryData). when you need the raw regex —
// e.g. to route several namespaces through one handler — use .pattern + .unpack:
bot.callbackQuery(user.pattern, (ctx) => {
  const payload = user.unpack(ctx.callbackQuery.data ?? "");
  if (!payload) return; // foreign or outdated data
  // payload is fully typed
});

// appending an optional field (or an enum member) keeps old buttons working
const v1 = callbackData("p", { id: Number });
const v2 = callbackData("p", { id: Number, note: field.string().optional() });

v2.unpack(v1.pack({ id: 7 })); // => { id: 7 } — a button packed by v1 still decodes

// a namespace with no fields — useful for simple action buttons
const ping = callbackData("ping", {});
ping.pack();         // => "ping"
ping.unpack("ping"); // => {}
ping.filter("ping"); // => true