@ discord-interactions/ core (英语)

使用 Discord 相互作用的 Bots 核心框架 - 类型文件

开始

一个使用框架的机器人实例 这里。下面可找到额外的代码片段.

安装

npm install @discord-interactions/core

接收交互

我们的框架旨在与任何网络服务器合作,它只取取原始请求体和 X-Signature-Ed25519编号 :X-Signature-Timestamp 授权信头。 信头是可选的,如果您在较早的阶段处理授权,也可以被忽略.

举个例子,我们用快活:

const server = fastify();
server.register(rawBody);

server.post("/", async (request, reply) => {
  const signature = request.headers["x-signature-ed25519"];
  const timestamp = request.headers["x-signature-timestamp"];

  try {
    const [onResponse, finished] = await app.handleInteraction(
      request.rawBody,
      timestamp,
      signature
    );

    onResponse.then((response) => {
      reply.code(200).send(response);
    });

    await finished;
  } catch (err) {
    console.error(err);
  }
});

注册斜线命令

这将建立一个全球 /ping 命令。 如果一个数据已经登记,并且与所提供的数据不同,则该数据将被覆盖.

const app = new DiscordApplication({
  clientId: process.env.CLIENT_ID,
  token: process.env.TOKEN,
  publicKey: process.env.PUBLIC_KEY,
});

await app.commands.register(
  new SlashCommand(new SlashCommandBuilder("ping", "A simple ping command!"), async (context) => {
    context.reply("Pong!");
  })
);

指挥组

指挥组、副指挥组和副指挥更复杂一点:

await app.register([
  new CommandGroup(
    new CommandGroupBuilder("config", "A simple config command.")
      .addSubcommand(new SubcommandOption("get", "Get a config value."))
      .addSubcommand(new SubcommandOption("set", "Set a config value.")),
    {
      get: {
        handler: async (context) => {
          const value = "x";
          context.reply(new MessageBuilder().setContent(`Config value: ${value}!`));
        }
      },
      set: {
        handler: async (context) => {
          context.reply(new MessageBuilder().setContent("Config value set!"));
        }
      }
    }
  )
]);

关节命令

const guild = new CommandManager(app, guildId);

await guild.register(
  new SlashCommand(new SlashCommandBuilder("pingping", "A guild-specific ping command!"), async (context) => {
    context.reply("Pongpong");
  })
);

命令同步

默认情况下,框架的同步模式是 SyncMode.Enabled。这意味着,当您注册命令时,框架将在Discord的一侧对照您的命令检查这些命令,并在必要时创建/更新这些命令.

还有两种模式:

• SyncMode.Strict: 这将检查删除的命令, 从 Discord 中删除 .

• SyncMode.Disabled: 这禁用所有自动同步 .

构成部分

组件必须以类似的方式以独特的ID来注册,为您组件创建出某种"模板". 然后可以使用 context.createGlobalComponent() 它将返回一个深克隆版本的组件作为构建器,允许您在使用它作为响应之前进一步修改它.

再次注册一个 ping 命令, 这次用一个按钮显示一个存储在其状态中的单词 :

type ButtonState = {
  word: string;
};

export class Ping implements ISlashCommand {
  builder = new SlashCommandBuilder("ping", "Simple ping command.");

  handler = async (ctx: SlashCommandContext): Promise<void> => {
    return ctx.reply(
      new MessageBuilder("Press the button to see a surprise...").addComponents(
        new ActionRowBuilder([await ctx.createComponent("example", { word: "Surprise!" })])
      )
    );
  };

  components = [
    new Button(
      "example",
      new ButtonBuilder(ButtonStyle.Primary, "Example Button"),
      async (ctx: ButtonContext<ButtonState>) => {
        return ctx.reply(ctx.state.word);
      }
    )
  ];
}

名称间隔

命令接口包括可选 components 属性,允许您将组件与特定命令绑定。 此前缀包含命令名称的组件 ID (<command>.<component ID>),然后使用 context.createComponent()。 。 。 .

如果你不想使用命名间隔,你可以使用 context.createGlobalComponent() 并登记您的组件 app.components.register()。 。 。 .

状态

您可以在创建组件实例时通过任意对象, 允许您在组件中存储状态信息 custom_id 属性。 (以后可在 context.state) (中文(简体) ).

此状态保存于 custom_id 属性,将限制您的数据大小。 为避免这种情况,可以配置一个外部缓存,如Redis或Cloudflare的KV:

const redisClient = createClient();

await redisClient.connect();

const app = new DiscordApplication({
  clientId: process.env.CLIENT_ID,
  token: process.env.TOKEN,
  publicKey: process.env.PUBLIC_KEY,

  cache: {
    get: (key) => redisClient.get(key),
    set: (key, ttl, value) => redisClient.setEx(key, ttl, value)
  }
});

// CACHE being a Cloudflare KV namespace

const app = new DiscordApplication({
  clientId: process.env.CLIENT_ID,
  token: process.env.TOKEN,
  publicKey: process.env.PUBLIC_KEY,

  cache: {
    get: (key) => CACHE.get(key),
    set: (key, ttl, value) => CACHE.put(key, value, { expirationTtl: ttl })
  }
});