@skyra/http-framework v2.1.0

@skyra/http-framework

Some stuff to fill in later.

TODO

• Support for reloading and unloading commands
• Logging integration similar to @sapphire/plugin-logger.
  • Log levels
  • Colorette powered Colours
  • Timestamps
  • Logging similar to framework (registering commands, errors, successes, etc)

Usage

This library can do both handling HTTP interactions and registering commands both globally and per guild using an integrated design.

Command

The Command is a piece that runs for all chat input and context-menu interactions, including auto-complete (since this one is sort of part of context-menu). Registering the commands happens with decorators:

import { Command, RegisterCommand } from '@skyra/http-framework';

@RegisterCommand({ name: 'ping', description: 'Runs a network connection test with me.' })
export class UserCommand extends Command {
	public chatInputRun(interaction: APIApplicationCommandInteraction): APIInteractionResponse {
		return {
			type: InteractionResponseType.ChannelMessageWithSource,
			data: { content: 'Pong!' }
		};
	}
}

You can also register subcommands via decorators:

import { type ArgumentsOf, Command, RegisterCommand, RegisterSubCommandGroup, makeSubCommandBody } from '@skyra/http-framework';
import { type APIApplicationCommandInteraction, type APIInteractionResponse, ApplicationCommandOptionType } from 'discord-api-types/v9';

@RegisterCommand({ name: 'math', description: 'Does some maths.' })
export class UserCommand extends Command {
	@RegisterSubCommandGroup(addBody);
	public add(interaction: APIApplicationCommandInteraction, { first, second }: ArgumentsOf<typeof addBody>): APIInteractionResponse {
		return {
			type: InteractionResponseType.ChannelMessageWithSource,
			data: { content: `The result is: ${first + second}` }
		};
	}
}

const addBody = makeSubCommandBody({
	type: ApplicationCommandOptionType.Subcommand,
	name: 'add',
	description: 'Adds two numbers.',
	options: [
		{ type: ApplicationCommandOptionType.Number, name: 'first', description: 'The first number.' },
		{ type: ApplicationCommandOptionType.Number, name: 'second', description: 'The second number.' }
	]
});

Client

The Client class contains the HTTP server, powered by fastify, it also registers a handler which processes whether or not the HTTP request comes from Discord, then processes the information accordingly, handling the heavy weight in the background.

import { Client } from '@skyra/http-framework';

const client = new Client({
	discordPublicKey: process.env.DISCORD_PUBLIC_KEY
});

// Load all the commands and message component handlers:
await client.load();

// Start up the HTTP server;
await client.listen({ port: 3000 });

Registry

The Registry class is a wrapper around @skyra/http-framework's internal registries and uses @discordjs/rest to register them in Discord.

import { Registry } from '@skyra/http-framework';

const registry = new Registry({
	token: process.env.DISCORD_TOKEN
});

// Load all the commands and message component handlers:
await registry.load();

// Register all global commands:
await registry.registerGlobalCommands();

// Register all the guild-restricted commands:
await registry.registerGuildRestrictedCommands();