discordthing 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Leon Semmens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# discordthing
+
+## Description
+
+A lightweight framework and collection of plugins for building a discord bot with [`discord.js`](https://www.npmjs.com/package/discord.js)
+
+## Installation
+
+```bash
+npm install discordthing
+```
+
+```bash
+pnpm add discordthing
+```
+
+## Create a bot
+
+```ts
+import { createBot, createCommandExecutor, okMessage } from "discordthing";
+import { EmbedBuilder, Colors } from "discord.js";
+
+import { commands } from "./commands";
+import { eventListeners } from "./eventListeners";
+
+const commandExecutor = createCommandExecutor({
+	getErrorMessage(msg, _err, _interaction) {
+		const embed = new EmbedBuilder()
+			.setColor(Colors.Red)
+			.setTitle(":warning: Error")
+			.setDescription(msg);
+
+		return okMessage({
+			embeds: [embed]
+		});
+	}
+});
+
+const client = createBot({
+	clientOptions: {
+		intents: ["Guilds", "GuildMembers"]
+	},
+	commandExecutor,
+	commands,
+	eventListeners
+});
+
+client.login(process.env.DISCORD_TOKEN);
+```
+
+### Define a command
+
+```ts
+// hello-world.command.ts
+
+import { defineCommand } from "discordthing";
+import { Result } from "@l3dev/result";
+
+export default defineCommand({
+	name: "hello-world",
+	define(builder) {
+		return builder.setName(this.name).setDescription("Say hello!");
+	},
+	async execute(interaction) {
+		return await Result.fromPromise(
+			{ onError: { type: "HELLO_WORLD_REPLY" } },
+			interaction.reply("Hello world!")
+		);
+	}
+});
+```
+
+Export commands as a single object:
+
+```ts
+// commands.ts
+
+export const commands = {
+	helloWorld: await import("./hello-world.command")
+};
+
+// or if you are using a bundler like Vite:
+
+export const commands = import.meta.glob<true, string>("./*.command.ts", { eager: true });
+```
+
+### Define an event listener
+
+```ts
+// welcome.event.ts
+
+import { defineEventListener } from "@l3dev/discord.js-helpers";
+import { Result } from "@l3dev/result";
+import { Events } from "discord.js";
+
+export default defineEventListener({
+	event: Events.GuildMemberAdd,
+	async listener(member) {
+		const joinChannel = await getJoinChannel(member.guild);
+
+		return await Result.fromPromise(
+			{ onError: { type: "WELCOME_MESSAGE" } },
+			joinChannel.send(`Welcome <@${member.user.id}>!`)
+		);
+	}
+});
+```
+
+Export event listeners as a single object:
+
+```ts
+// eventListeners.ts
+
+export const eventListeners = {
+	welcome: await import("./welcome.event")
+};
+
+// or if you are using a bundler like Vite:
+
+export const eventListeners = import.meta.glob<true, string>("./*.event.ts", { eager: true });
+```

package/build/bot.d.ts

@@ -0,0 +1,37 @@
+import { type ReturnResult } from "@l3dev/result";
+import { Client, REST, SlashCommandBuilder, type ClientOptions, type Guild, type RestOrArray } from "discord.js";
+import type { Command, CommandFilter } from "./commands/command.js";
+import type { Listener } from "./events/listener.js";
+import type { ILogger } from "./logger.js";
+import type { Plugin } from "./plugin.js";
+export type BotOptions = {
+    name?: string;
+    plugins?: Plugin[];
+    commands?: Command<string, SlashCommandBuilder>[];
+    listeners?: Listener<any>[];
+    logger?: ILogger;
+};
+export declare class Bot {
+    readonly client: Client<boolean>;
+    private _rest;
+    get rest(): REST;
+    private readonly plugins;
+    private readonly commands;
+    private readonly commandFilters;
+    private readonly readyListeners;
+    private readonly logger;
+    constructor(clientOptions: ClientOptions, options?: BotOptions);
+    addCommands(...commands: RestOrArray<Command<string, SlashCommandBuilder>>): void;
+    addCommand(command: Command<string, SlashCommandBuilder>): void;
+    addCommandFilter(filter: CommandFilter): void;
+    addListeners(...listeners: RestOrArray<Listener<any>>): void;
+    addListener(listener: Listener<any>): void;
+    private createListenerFn;
+    start(token: string): Promise<void>;
+    getMe(guild: Guild): Promise<ReturnResult<import("discord.js").GuildMember, import("@l3dev/result").ResultErrorDefinition<"GET_ME", object & {
+        error: Error;
+    }>>>;
+    private registerCommands;
+    private onReady;
+    private onInteraction;
+}

package/build/bot.js

@@ -0,0 +1,166 @@
+import { err, ok, Result } from "@l3dev/result";
+import { Client, Events, InteractionContextType, REST, SlashCommandBuilder } from "discord.js";
+import { Logger } from "tslog";
+import { CommandRegistration } from "./commands/registration.js";
+import { createContext } from "./context.js";
+export class Bot {
+    client;
+    _rest;
+    get rest() {
+        return this._rest;
+    }
+    plugins;
+    commands;
+    commandFilters = [];
+    readyListeners = [];
+    logger;
+    constructor(clientOptions, options = {}) {
+        this._rest = new REST({ version: "10" });
+        this.client = new Client(clientOptions);
+        this.plugins = (options.plugins ?? []).map((plugin) => plugin(options));
+        this.logger =
+            options.logger ??
+                new Logger({
+                    name: options.name ?? "discordthing-bot"
+                });
+        for (const plugin of this.plugins) {
+            plugin.resolved(this);
+        }
+        this.commands = [
+            ...(options.commands ?? []),
+            ...this.plugins.flatMap((plugin) => plugin.commands)
+        ].reduce((acc, command) => ({
+            ...acc,
+            [command.name]: command
+        }), {});
+        this.client.on(Events.ClientReady, this.onReady.bind(this));
+        this.client.on(Events.InteractionCreate, this.onInteraction.bind(this));
+        const allListeners = [
+            ...(options.listeners ?? []),
+            ...this.plugins.flatMap((plugin) => plugin.listeners)
+        ];
+        for (const listener of allListeners) {
+            if (listener.event === Events.ClientReady) {
+                this.readyListeners.push(listener);
+                continue;
+            }
+            this.client.on(listener.event, this.createListenerFn(listener));
+        }
+    }
+    addCommands(...commands) {
+        for (const command of commands.flat()) {
+            this.addCommand(command);
+        }
+    }
+    addCommand(command) {
+        if (this.client.isReady()) {
+            throw new Error("Cannot add command after bot has started");
+        }
+        this.commands[command.name] = command;
+    }
+    addCommandFilter(filter) {
+        this.commandFilters.push(filter);
+    }
+    addListeners(...listeners) {
+        for (const listener of listeners.flat()) {
+            this.addListener(listener);
+        }
+    }
+    addListener(listener) {
+        if (this.client.isReady()) {
+            throw new Error("Cannot add listener after bot has started");
+        }
+        if (listener.event === Events.ClientReady) {
+            this.readyListeners.push(listener);
+            return;
+        }
+        (listener.once ? this.client.once : this.client.on)(listener.event, this.createListenerFn(listener));
+    }
+    createListenerFn(listener) {
+        return async (...args) => {
+            const ctx = createContext(this, this.logger);
+            listener.handler(ctx, ...args);
+        };
+    }
+    async start(token) {
+        this._rest = this._rest.setToken(token);
+        await this.client.login(token);
+    }
+    async getMe(guild) {
+        if (guild.members.me) {
+            return ok(guild.members.me);
+        }
+        return await Result.fromPromise(guild.members.fetchMe(), {
+            onError: { type: "GET_ME" }
+        });
+    }
+    async registerCommands(client) {
+        const commandRegistration = new CommandRegistration(this._rest, client);
+        const globalCommands = Object.values(this.commands).filter((command) => {
+            const contexts = command.getContexts();
+            return (contexts.includes(InteractionContextType.BotDM) ||
+                contexts.includes(InteractionContextType.PrivateChannel));
+        });
+        const guildCommands = Object.values(this.commands).filter((command) => {
+            const contexts = command.getContexts();
+            return contexts.includes(InteractionContextType.Guild);
+        });
+        this.logger.debug(`Registering global commands...`);
+        await commandRegistration.registerGlobalCommands(globalCommands);
+        const guilds = await client.guilds.fetch();
+        for (const guild of guilds.values()) {
+            this.logger.debug(`Registering guild commands for guild ${guild.id}...`);
+            await commandRegistration.registerGuildCommands(guild.id, guildCommands);
+        }
+    }
+    async onReady(client) {
+        const startMs = performance.now();
+        await this.registerCommands(client);
+        // Make a copy so we can remove _once_ listeners
+        const listeners = [...this.readyListeners];
+        for (const listener of listeners) {
+            const handler = this.createListenerFn(listener);
+            handler(client);
+            if (listener.once) {
+                const index = this.readyListeners.indexOf(listener);
+                if (index === -1) {
+                    return;
+                }
+                this.readyListeners.splice(index, 1);
+            }
+        }
+        const endMs = performance.now();
+        const elapsedMs = endMs - startMs;
+        this.logger.info(`Ready! (${elapsedMs > 1000 ? `${(elapsedMs / 1000).toFixed(2)}s` : `${elapsedMs}ms`})`);
+    }
+    async onInteraction(interaction) {
+        if (interaction.user.bot || !interaction.isChatInputCommand())
+            return;
+        const command = this.commands[interaction.commandName];
+        if (!command) {
+            this.logger.error(`Unknown command '${interaction.commandName}'`);
+            return;
+        }
+        if (!this.commandFilters.some((filter) => filter(interaction, command))) {
+            return;
+        }
+        const ctx = createContext(this, this.logger);
+        ctx.interaction = interaction;
+        let result;
+        try {
+            result = await command.execute(ctx);
+        }
+        catch (error) {
+            result = err("COMMAND_FAILED", {
+                command: interaction.commandName,
+                interactionId: interaction.id,
+                error
+            });
+        }
+        const unwrapped = Result.unwrap(result);
+        if (!unwrapped.ok) {
+            this.logger.error(`Error while executing command '${interaction.commandName}':`, result);
+        }
+    }
+}
+//# sourceMappingURL=bot.js.map

package/build/bot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot.js","sourceRoot":"","sources":["../src/bot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,EAAqB,MAAM,eAAe,CAAC;AACnE,OAAO,EACN,MAAM,EACN,MAAM,EACN,sBAAsB,EACtB,IAAI,EACJ,mBAAmB,EAKnB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAa7C,MAAM,OAAO,GAAG;IACN,MAAM,CAAkB;IACzB,KAAK,CAAO;IAEpB,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAEgB,OAAO,CAAmB;IAC1B,QAAQ,CAAuD;IAC/D,cAAc,GAAoB,EAAE,CAAC;IACrC,cAAc,GAA8B,EAAE,CAAC;IAC/C,MAAM,CAAU;IAEjC,YAAY,aAA4B,EAAE,UAAsB,EAAE;QACjE,IAAI,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC;QAExC,IAAI,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM;YACV,OAAO,CAAC,MAAM;gBACd,IAAI,MAAM,CAAC;oBACV,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,kBAAkB;iBACxC,CAAC,CAAC;QAEJ,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACnC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG;YACf,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;YAC3B,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC;SACpD,CAAC,MAAM,CACP,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;YAClB,GAAG,GAAG;YACN,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO;SACvB,CAAC,EACF,EAAE,CACF,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAExE,MAAM,YAAY,GAAG;YACpB,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;YAC5B,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC;SACrD,CAAC;QACF,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE,CAAC;YACrC,IAAI,QAAQ,CAAC,KAAK,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC3C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACnC,SAAS;YACV,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;QACjE,CAAC;IACF,CAAC;IAED,WAAW,CAAC,GAAG,QAA2D;QACzE,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;YACvC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;IACF,CAAC;IAED,UAAU,CAAC,OAA6C;QACvD,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;IACvC,CAAC;IAED,gBAAgB,CAAC,MAAqB;QACrC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAED,YAAY,CAAC,GAAG,SAAqC;QACpD,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC;YACzC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;IACF,CAAC;IAED,WAAW,CAAC,QAAuB;QAClC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC;YAC3C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,OAAO;QACR,CAAC;QAED,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAClD,QAAQ,CAAC,KAAK,EACd,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAC/B,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,QAAuB;QAC/C,OAAO,KAAK,EAAE,GAAG,IAAW,EAAE,EAAE;YAC/B,MAAM,GAAG,GAAG,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7C,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAChC,CAAC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,KAAa;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,KAAY;QACvB,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;YACtB,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,MAAM,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE;YACxD,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC3B,CAAC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,MAAoB;QAClD,MAAM,mBAAmB,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAExE,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;YACtE,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;YACvC,OAAO,CACN,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,KAAK,CAAC;gBAC/C,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,cAAc,CAAC,CACxD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;YACrE,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;YACvC,OAAO,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,MAAM,mBAAmB,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;QAEjE,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAC3C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,wCAAwC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;YACzE,MAAM,mBAAmB,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QAC1E,CAAC;IACF,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,MAAoB;QACzC,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAElC,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAEpC,gDAAgD;QAChD,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;QAE3C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAClC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAChD,OAAO,CAAC,MAAM,CAAC,CAAC;YAEhB,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACnB,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACpD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;oBAClB,OAAO;gBACR,CAAC;gBAED,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACtC,CAAC;QACF,CAAC;QAED,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,MAAM,SAAS,GAAG,KAAK,GAAG,OAAO,CAAC;QAElC,IAAI,CAAC,MAAM,CAAC,IAAI,CACf,WAAW,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,GAAG,CACvF,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,WAAwB;QACnD,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE;YAAE,OAAO;QAEtE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,WAAW,CAAC,WAAW,GAAG,CAAC,CAAC;YAClE,OAAO;QACR,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;YACzE,OAAO;QACR,CAAC;QAED,MAAM,GAAG,GAAG,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAe,CAAC;QAC3D,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;QAE9B,IAAI,MAAM,CAAC;QACX,IAAI,CAAC;YACJ,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,GAAG,GAAG,CAAC,gBAAgB,EAAE;gBAC9B,OAAO,EAAE,WAAW,CAAC,WAAW;gBAChC,aAAa,EAAE,WAAW,CAAC,EAAE;gBAC7B,KAAK;aACL,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAA2B,CAAC;QAClE,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC;YACnB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,WAAW,CAAC,WAAW,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1F,CAAC;IACF,CAAC;CACD","sourcesContent":["import { err, ok, Result, type ReturnResult } from \"@l3dev/result\";\nimport {\n\tClient,\n\tEvents,\n\tInteractionContextType,\n\tREST,\n\tSlashCommandBuilder,\n\ttype ClientOptions,\n\ttype Guild,\n\ttype Interaction,\n\ttype RestOrArray\n} from \"discord.js\";\nimport { Logger } from \"tslog\";\n\nimport type { Command, CommandCtx, CommandFilter } from \"./commands/command.js\";\nimport { CommandRegistration } from \"./commands/registration.js\";\nimport { createContext } from \"./context.js\";\nimport type { Listener } from \"./events/listener.js\";\nimport type { ILogger } from \"./logger.js\";\nimport type { Plugin, ResolvedPlugin } from \"./plugin.js\";\n\nexport type BotOptions = {\n\tname?: string;\n\tplugins?: Plugin[];\n\tcommands?: Command<string, SlashCommandBuilder>[];\n\tlisteners?: Listener<any>[];\n\tlogger?: ILogger;\n};\n\nexport class Bot {\n\treadonly client: Client<boolean>;\n\tprivate _rest: REST;\n\n\tget rest() {\n\t\treturn this._rest;\n\t}\n\n\tprivate readonly plugins: ResolvedPlugin[];\n\tprivate readonly commands: Record<string, Command<string, SlashCommandBuilder>>;\n\tprivate readonly commandFilters: CommandFilter[] = [];\n\tprivate readonly readyListeners: Listener<\"clientReady\">[] = [];\n\tprivate readonly logger: ILogger;\n\n\tconstructor(clientOptions: ClientOptions, options: BotOptions = {}) {\n\t\tthis._rest = new REST({ version: \"10\" });\n\t\tthis.client = new Client(clientOptions);\n\n\t\tthis.plugins = (options.plugins ?? []).map((plugin) => plugin(options));\n\t\tthis.logger =\n\t\t\toptions.logger ??\n\t\t\tnew Logger({\n\t\t\t\tname: options.name ?? \"discordthing-bot\"\n\t\t\t});\n\n\t\tfor (const plugin of this.plugins) {\n\t\t\tplugin.resolved(this);\n\t\t}\n\n\t\tthis.commands = [\n\t\t\t...(options.commands ?? []),\n\t\t\t...this.plugins.flatMap((plugin) => plugin.commands)\n\t\t].reduce(\n\t\t\t(acc, command) => ({\n\t\t\t\t...acc,\n\t\t\t\t[command.name]: command\n\t\t\t}),\n\t\t\t{}\n\t\t);\n\n\t\tthis.client.on(Events.ClientReady, this.onReady.bind(this));\n\t\tthis.client.on(Events.InteractionCreate, this.onInteraction.bind(this));\n\n\t\tconst allListeners = [\n\t\t\t...(options.listeners ?? []),\n\t\t\t...this.plugins.flatMap((plugin) => plugin.listeners)\n\t\t];\n\t\tfor (const listener of allListeners) {\n\t\t\tif (listener.event === Events.ClientReady) {\n\t\t\t\tthis.readyListeners.push(listener);\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tthis.client.on(listener.event, this.createListenerFn(listener));\n\t\t}\n\t}\n\n\taddCommands(...commands: RestOrArray<Command<string, SlashCommandBuilder>>) {\n\t\tfor (const command of commands.flat()) {\n\t\t\tthis.addCommand(command);\n\t\t}\n\t}\n\n\taddCommand(command: Command<string, SlashCommandBuilder>) {\n\t\tif (this.client.isReady()) {\n\t\t\tthrow new Error(\"Cannot add command after bot has started\");\n\t\t}\n\n\t\tthis.commands[command.name] = command;\n\t}\n\n\taddCommandFilter(filter: CommandFilter) {\n\t\tthis.commandFilters.push(filter);\n\t}\n\n\taddListeners(...listeners: RestOrArray<Listener<any>>) {\n\t\tfor (const listener of listeners.flat()) {\n\t\t\tthis.addListener(listener);\n\t\t}\n\t}\n\n\taddListener(listener: Listener<any>) {\n\t\tif (this.client.isReady()) {\n\t\t\tthrow new Error(\"Cannot add listener after bot has started\");\n\t\t}\n\n\t\tif (listener.event === Events.ClientReady) {\n\t\t\tthis.readyListeners.push(listener);\n\t\t\treturn;\n\t\t}\n\n\t\t(listener.once ? this.client.once : this.client.on)(\n\t\t\tlistener.event,\n\t\t\tthis.createListenerFn(listener)\n\t\t);\n\t}\n\n\tprivate createListenerFn(listener: Listener<any>) {\n\t\treturn async (...args: any[]) => {\n\t\t\tconst ctx = createContext(this, this.logger);\n\t\t\tlistener.handler(ctx, ...args);\n\t\t};\n\t}\n\n\tasync start(token: string) {\n\t\tthis._rest = this._rest.setToken(token);\n\t\tawait this.client.login(token);\n\t}\n\n\tasync getMe(guild: Guild) {\n\t\tif (guild.members.me) {\n\t\t\treturn ok(guild.members.me);\n\t\t}\n\n\t\treturn await Result.fromPromise(guild.members.fetchMe(), {\n\t\t\tonError: { type: \"GET_ME\" }\n\t\t});\n\t}\n\n\tprivate async registerCommands(client: Client<true>) {\n\t\tconst commandRegistration = new CommandRegistration(this._rest, client);\n\n\t\tconst globalCommands = Object.values(this.commands).filter((command) => {\n\t\t\tconst contexts = command.getContexts();\n\t\t\treturn (\n\t\t\t\tcontexts.includes(InteractionContextType.BotDM) ||\n\t\t\t\tcontexts.includes(InteractionContextType.PrivateChannel)\n\t\t\t);\n\t\t});\n\n\t\tconst guildCommands = Object.values(this.commands).filter((command) => {\n\t\t\tconst contexts = command.getContexts();\n\t\t\treturn contexts.includes(InteractionContextType.Guild);\n\t\t});\n\n\t\tthis.logger.debug(`Registering global commands...`);\n\t\tawait commandRegistration.registerGlobalCommands(globalCommands);\n\n\t\tconst guilds = await client.guilds.fetch();\n\t\tfor (const guild of guilds.values()) {\n\t\t\tthis.logger.debug(`Registering guild commands for guild ${guild.id}...`);\n\t\t\tawait commandRegistration.registerGuildCommands(guild.id, guildCommands);\n\t\t}\n\t}\n\n\tprivate async onReady(client: Client<true>) {\n\t\tconst startMs = performance.now();\n\n\t\tawait this.registerCommands(client);\n\n\t\t// Make a copy so we can remove _once_ listeners\n\t\tconst listeners = [...this.readyListeners];\n\n\t\tfor (const listener of listeners) {\n\t\t\tconst handler = this.createListenerFn(listener);\n\t\t\thandler(client);\n\n\t\t\tif (listener.once) {\n\t\t\t\tconst index = this.readyListeners.indexOf(listener);\n\t\t\t\tif (index === -1) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tthis.readyListeners.splice(index, 1);\n\t\t\t}\n\t\t}\n\n\t\tconst endMs = performance.now();\n\t\tconst elapsedMs = endMs - startMs;\n\n\t\tthis.logger.info(\n\t\t\t`Ready! (${elapsedMs > 1000 ? `${(elapsedMs / 1000).toFixed(2)}s` : `${elapsedMs}ms`})`\n\t\t);\n\t}\n\n\tprivate async onInteraction(interaction: Interaction) {\n\t\tif (interaction.user.bot || !interaction.isChatInputCommand()) return;\n\n\t\tconst command = this.commands[interaction.commandName];\n\t\tif (!command) {\n\t\t\tthis.logger.error(`Unknown command '${interaction.commandName}'`);\n\t\t\treturn;\n\t\t}\n\n\t\tif (!this.commandFilters.some((filter) => filter(interaction, command))) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst ctx = createContext(this, this.logger) as CommandCtx;\n\t\tctx.interaction = interaction;\n\n\t\tlet result;\n\t\ttry {\n\t\t\tresult = await command.execute(ctx);\n\t\t} catch (error) {\n\t\t\tresult = err(\"COMMAND_FAILED\", {\n\t\t\t\tcommand: interaction.commandName,\n\t\t\t\tinteractionId: interaction.id,\n\t\t\t\terror\n\t\t\t});\n\t\t}\n\n\t\tconst unwrapped = Result.unwrap(result) as ReturnResult<any, any>;\n\t\tif (!unwrapped.ok) {\n\t\t\tthis.logger.error(`Error while executing command '${interaction.commandName}':`, result);\n\t\t}\n\t}\n}\n"]}

package/build/commands/command.d.ts

@@ -0,0 +1,111 @@
+import { type ReturnResult } from "@l3dev/result";
+import { InteractionContextType, SlashCommandBuilder, SlashCommandSubcommandBuilder, type ChatInputCommandInteraction, type SharedNameAndDescription, type SharedSlashCommandOptions } from "discord.js";
+import type { GenericCtx } from "../context.js";
+import type { Args, OptionDefinitions } from "../options/index.js";
+import type { Expand, MaybePromise } from "../utility-types.js";
+export type CommandCtx = Expand<GenericCtx & {
+    interaction: ChatInputCommandInteraction;
+}>;
+export type ArgsArrayForOptions<Options extends OptionDefinitions> = [Options] extends [
+    OptionDefinitions
+] ? [args: Args<Options>] : [];
+export type CommandMeta<Name extends string> = {
+    /**
+     * The name of the command.
+     */
+    name: Name;
+    /**
+     * The description of the command.
+     */
+    description?: string;
+    /**
+     * Whether the command is NSFW.
+     */
+    nsfw?: boolean;
+    /**
+     * The contexts in which the command can be used.
+     *
+     * @default [InteractionContextType.Guild]
+     */
+    contexts?: InteractionContextType[];
+};
+export type SubcommandMeta<Name extends string> = {
+    /**
+     * The name of the command.
+     */
+    name: Name;
+    /**
+     * The description of the command.
+     */
+    description?: string;
+};
+export declare class Command<Name extends string, Builder extends SharedNameAndDescription & SharedSlashCommandOptions<any>> {
+    protected builder: Builder;
+    readonly name: Name;
+    private options;
+    private subcommands;
+    private handler;
+    constructor(builder: Builder, meta: CommandMeta<Name>);
+    execute(ctx: CommandCtx): Promise<ReturnResult<any, any>>;
+}
+export declare function command<Name extends string, Options extends OptionDefinitions>(command: {
+    /**
+     * Metadata for this command.
+     */
+    meta: CommandMeta<Name>;
+    /**
+     * Options for the command.
+     *
+     * Examples:
+     *
+     * ```
+     * options: {}
+     * options: { message: o.string() }
+     * options: { message: o.string().union(o.choice("hello"), o.choice("world")) }
+     * options: { message: o.string(), count: o.integer() }
+     * ```
+     */
+    options?: Options;
+    /**
+     * The implementation for this command.
+     */
+    handler: (ctx: CommandCtx, ...args: ArgsArrayForOptions<Options>) => MaybePromise<ReturnResult<any, any>>;
+}): Command<Name, SlashCommandBuilder>;
+export declare function command<Name extends string>(command: {
+    /**
+     * Metadata for this command.
+     */
+    meta: CommandMeta<Name>;
+    /**
+     * Subcommands for the command.
+     */
+    subcommands: Command<string, SlashCommandSubcommandBuilder>[];
+    /**
+     * The middleware for this command with subcommands.
+     */
+    middleware?: (ctx: CommandCtx) => MaybePromise<ReturnResult<boolean, any>>;
+}): Command<Name, SlashCommandBuilder>;
+export declare function subcommand<Name extends string, Options extends OptionDefinitions>(command: {
+    /**
+     * Metadata for this command.
+     */
+    meta: SubcommandMeta<Name>;
+    /**
+     * Options for the command.
+     *
+     * Examples:
+     *
+     * ```
+     * options: {}
+     * options: { message: o.string() }
+     * options: { message: o.string().union(o.choice("hello"), o.choice("world")) }
+     * options: { message: o.string(), count: o.integer() }
+     * ```
+     */
+    options?: Options;
+    /**
+     * The implementation for this command.
+     */
+    handler: (ctx: CommandCtx, ...args: ArgsArrayForOptions<Options>) => MaybePromise<ReturnResult<any, any>>;
+}): Command<Name, SlashCommandSubcommandBuilder>;
+export type CommandFilter = (interaction: ChatInputCommandInteraction, command: Command<string, SlashCommandBuilder>) => boolean;

package/build/commands/command.js

@@ -0,0 +1,176 @@
+import { err, NONE } from "@l3dev/result";
+import { ApplicationCommandOptionType, InteractionContextType, SlashCommandBuilder, SlashCommandSubcommandBuilder } from "discord.js";
+import { AttachmentOption, BooleanOption, BuilderOption, ChannelOption, IntegerOption, MentionableOption, NumberOption, RoleOption, StringOption, UserOption } from "../options/options.js";
+export class Command {
+    builder;
+    name;
+    options = null;
+    subcommands = null;
+    handler = null;
+    constructor(builder, meta) {
+        this.builder = builder;
+        this.name = meta.name;
+        builder = builder.setName(meta.name);
+        if (meta.description) {
+            builder = builder.setDescription(meta.description);
+        }
+        if (builder instanceof SlashCommandBuilder) {
+            let commandBuilder = builder;
+            if (meta.nsfw) {
+                commandBuilder = commandBuilder.setNSFW(meta.nsfw);
+            }
+            commandBuilder = commandBuilder.setContexts(meta.contexts ?? [InteractionContextType.Guild]);
+            builder = commandBuilder;
+        }
+        this.builder = builder;
+    }
+    async execute(ctx) {
+        if (this.subcommands) {
+            const continueResult = this.handler ? await this.handler(ctx) : NONE;
+            if (!continueResult.ok || !continueResult.value) {
+                return continueResult;
+            }
+            const subcommandName = ctx.interaction.options.getSubcommand(true);
+            const subcommand = this.subcommands[subcommandName];
+            if (!subcommand) {
+                return err("UNKNOWN_SUBCOMMAND", {
+                    name: subcommandName
+                });
+            }
+            return await subcommand.execute(ctx);
+        }
+        const args = this.parseOptions(ctx.interaction.options);
+        return await this.handler(ctx, args);
+    }
+    /** @internal */
+    parseOptions(options) {
+        const args = {};
+        for (const [name, option] of Object.entries(this.options ?? {})) {
+            const required = option.isOptional === "required";
+            let value = null;
+            if (options.getAttachment && option instanceof AttachmentOption) {
+                value = options.getAttachment(name, required);
+            }
+            else if (options.getBoolean && option instanceof BooleanOption) {
+                value = options.getBoolean(name, required);
+            }
+            else if (options.getChannel && option instanceof ChannelOption) {
+                value = options.getChannel(name, required, option.getBuilder().channel_types);
+            }
+            else if (options.getInteger && option instanceof IntegerOption) {
+                value = options.getInteger(name, required);
+            }
+            else if (options.getMentionable && option instanceof MentionableOption) {
+                value = options.getMentionable(name, required);
+            }
+            else if (options.getNumber && option instanceof NumberOption) {
+                value = options.getNumber(name, required);
+            }
+            else if (options.getRole && option instanceof RoleOption) {
+                value = options.getRole(name, required);
+            }
+            else if (options.getString && option instanceof StringOption) {
+                value = options.getString(name, required);
+            }
+            else if (options.getUser && option instanceof UserOption) {
+                value = options.getUser(name, required);
+            }
+            if (value === null || value === undefined) {
+                continue;
+            }
+            args[name] = value;
+        }
+        return args;
+    }
+    /** @internal */
+    getContexts() {
+        if (!(this.builder instanceof SlashCommandBuilder)) {
+            return [];
+        }
+        return this.builder.contexts ?? [InteractionContextType.Guild];
+    }
+    /** @internal */
+    getBuilder() {
+        return this.builder;
+    }
+    /** @internal */
+    setOptions(options) {
+        this.options = options;
+        for (const [name, option] of Object.entries(options)) {
+            if (option instanceof BuilderOption) {
+                this.addOption(name, option);
+            }
+        }
+    }
+    /** @internal */
+    addOption(name, option) {
+        let optionBuilder = option.getBuilder().setName(name);
+        if (!optionBuilder.description) {
+            optionBuilder = optionBuilder.setDescription(`${name} option.`);
+        }
+        if (optionBuilder.type === ApplicationCommandOptionType.Attachment) {
+            this.builder = this.builder.addAttachmentOption(optionBuilder);
+        }
+        else if (optionBuilder.type === ApplicationCommandOptionType.Boolean) {
+            this.builder = this.builder.addBooleanOption(optionBuilder);
+        }
+        else if (optionBuilder.type === ApplicationCommandOptionType.Channel) {
+            this.builder = this.builder.addChannelOption(optionBuilder);
+        }
+        else if (optionBuilder.type === ApplicationCommandOptionType.Integer) {
+            this.builder = this.builder.addIntegerOption(optionBuilder);
+        }
+        else if (optionBuilder.type === ApplicationCommandOptionType.Mentionable) {
+            this.builder = this.builder.addMentionableOption(optionBuilder);
+        }
+        else if (optionBuilder.type === ApplicationCommandOptionType.Number) {
+            this.builder = this.builder.addNumberOption(optionBuilder);
+        }
+        else if (optionBuilder.type === ApplicationCommandOptionType.Role) {
+            this.builder = this.builder.addRoleOption(optionBuilder);
+        }
+        else if (optionBuilder.type === ApplicationCommandOptionType.String) {
+            this.builder = this.builder.addStringOption(optionBuilder);
+        }
+        else if (optionBuilder.type === ApplicationCommandOptionType.User) {
+            this.builder = this.builder.addUserOption(optionBuilder);
+        }
+    }
+    /** @internal */
+    setSubcommands(subcommands) {
+        if (!(this.builder instanceof SlashCommandBuilder)) {
+            throw new Error("Subcommands can only be set on a SlashCommandBuilder");
+        }
+        this.subcommands = subcommands.reduce((acc, subcommand) => ({
+            ...acc,
+            [subcommand.name]: subcommand
+        }), {});
+    }
+    /** @internal */
+    setHandler(handler) {
+        this.handler = handler;
+    }
+}
+export function command(data) {
+    const command = new Command(new SlashCommandBuilder(), data.meta);
+    if ("options" in data && data.options) {
+        command.setOptions(data.options);
+        command.setHandler(data.handler);
+    }
+    else if ("subcommands" in data) {
+        command.setSubcommands(data.subcommands);
+        if (data.middleware) {
+            command.setHandler(data.middleware);
+        }
+    }
+    return command;
+}
+export function subcommand(command) {
+    const subcommand = new Command(new SlashCommandSubcommandBuilder(), command.meta);
+    if (command.options) {
+        subcommand.setOptions(command.options);
+    }
+    subcommand.setHandler(command.handler);
+    return subcommand;
+}
+//# sourceMappingURL=command.js.map