Command bot

import { Client } from '@cloak-software/bot-sdk';

const client = new Client({
  token: process.env.CLOAK_TOKEN!,
  // Keep this file. The bot's identity is published to the server once, so a
  // bot with no keystore works on its first run and fails on every one after.
  keystorePath: './command-bot.cloak-keystore.json',
  requiredPermissions: ['message_send'],
  debug: !!process.env.CLOAK_DEBUG,
});

// Everything registered here is published to the server at login(), so a human
// client's `/` picker can list it. That is why registration happens BEFORE
// login() and not inside a ready handler.

// A greedy trailing string option: the LAST option, when it is a string,
// consumes the rest of the line verbatim. `/play never gonna give you up`
// arrives as one argument, spaces and all, with no quoting needed.
client.commands.register(
  {
    name: 'play',
    description: 'play a song',
    options: [{ name: 'query', type: 'string', description: 'what to play', required: true }],
  },
  async (ctx) => {
    console.log(`[/play] from ${ctx.message.authorName} via the ${ctx.source} lane`);
    await ctx.reply(`playing: ${ctx.getString('query')}`);
  },
);

// A boolean plus a choices-constrained option. Choices are VALUES, as strings:
// the choice string is both the label and the value. Note the ordering rule:
// every required option precedes every optional one, or register() throws.
client.commands.register(
  {
    name: 'volume',
    description: 'set the playback volume',
    options: [
      {
        name: 'level',
        type: 'string',
        description: 'how loud',
        required: true,
        choices: ['quiet', 'normal', 'loud'],
      },
      { name: 'announce', type: 'boolean', description: 'say so in the channel' },
    ],
  },
  async (ctx) => {
    const level = ctx.getString('level');
    // `/volume loud announce:true`, `/volume quiet no`, `/volume normal` all work.
    if (ctx.getBoolean('announce')) await ctx.reply(`volume set to ${level}`);
    else console.log(`[/volume] ${level} (quietly)`);
  },
);

// A command that could not be run.
client.on('commandError', (e) => {
  console.warn(`/${e.name} failed (${e.reason}):`, e.error);
});

client.on('messageCreate', (msg) => {
  if (msg.authorId === client.user?.id) return; // never answer yourself
  // The filter a bot needs when it ALSO does its own text handling: a message
  // the command router already claimed has msg.command set, and its handler has
  // been dispatched. Without this you would answer twice.
  if (msg.command) return;

  if (msg.content.trim() === 'help') {
    const list = client.commands
      .list()
      .map((d) => `/${d.name}: ${d.description}`)
      .join('\n');
    void msg.channel.send(`commands:\n${list}`);
  }
});

client.on('error', (e) => console.warn('[cloak-sdk]', e));
client.on('ready', () =>
  console.log(`ready as ${client.user?.id}; ${client.commands.size} commands declared`),
);

client.login().catch((e) => {
  console.error('login failed', e);
  process.exit(1);
});