https://github.com/maks11060/discord-interactions
Discord interactions handler
https://github.com/maks11060/discord-interactions
deno discord discord-api discord-interactions discordapp typescript
Last synced: about 2 months ago
JSON representation
Discord interactions handler
- Host: GitHub
- URL: https://github.com/maks11060/discord-interactions
- Owner: MAKS11060
- License: mit
- Created: 2024-04-19T11:15:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-02T10:39:22.000Z (5 months ago)
- Last Synced: 2025-07-19T02:09:43.336Z (3 months ago)
- Topics: deno, discord, discord-api, discord-interactions, discordapp, typescript
- Language: TypeScript
- Homepage: https://jsr.io/@maks11060/discord-interactions
- Size: 168 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Discord Interactions
### Library for handling **Discord Interactions**.
Handle slash command, user and chat command. [Overview of Interactions](https://discord.com/developers/docs/interactions/overview)
## Quick Start
1. Create a new application on the [Discord Developer Portal](https://discord.com/developers/applications).
2. Add your application to your Discord server by visiting the following URL and replacing `your_client_id` with your actual client ID:
- `https://discord.com/oauth2/authorize?client_id=your_client_id`
3. Copy the `PUBLIC KEY` from your application's settings page and add it to your `.env` file.
4. Copy the `CLIENT_ID` and `CLIENT_SECRET` from the OAuth2 page of your application's settings and add them to your `.env` file.
### `.env` file:
```env
# Discord application settings
# CLIENT_ID= # Required for deploying commands
# CLIENT_SECRET= # Required for deploying commands
CLIENT_PUBLIC_KEY= # Required for verifying requests
```
## Install from [JSR](https://jsr.io/@maks11060/discord-interactions)
```powershell
deno add @maks11060/discord-interactions
deno add npm:discord-api-types
```
## Install CLI
```powershell
deno install -Arfgn deploy-discord --unstable-kv jsr:@maks11060/discord-interactions/cli
```
## Usage
Define commands:
```ts
// ./src/commands.ts
import {defineCommand, Format} from '@maks11060/discord-interactions'
const hello = defineCommand({
name: 'hello',
description: 'says hi',
}).createHandler({
hello: () => ({
command: (c) => {
return c.reply({
content: `Hello ${Format.user(c.user.id)}`,
});
},
}),
})
export const commands = [hello]
// or use
// export default [hello]
```
Run **[CLI](#install-cli)**:
```powershell
deploy-discord ./src/commands.ts
# or use help
deploy-discord -h
```
### Use [Hono](https://hono.dev)
```ts
// main.ts
import {Hono} from 'hono'
import {importKeyRaw, discordInteraction} from '@maks11060/discord-interactions/hono'
import {commands} from './src/commands.ts'
const app = new Hono()
const key = await importKeyRaw(Deno.env.get('CLIENT_PUBLIC_KEY')!)
app.post('/interaction', ...await discordInteraction(key, commands))
Deno.serve(app.fetch)
```
### Use web standards api
```ts
// main.ts
import {importKeyRaw, discordInteraction} from '@maks11060/discord-interactions'
import {commands} from './src/commands.ts'
const key = await importKeyRaw(Deno.env.get('CLIENT_PUBLIC_KEY')!)
const interaction = await discordInteraction(key, commands)
Deno.serve(req => {
const uri = new URL(req.url)
if (req.method === 'POST' && uri.pathname === '/interaction') {
return interaction(req)
}
return new Response('404 Not found', {status: 404})
})
```
## Features
- [x] ApplicationCommandContext
- [x] getter for options
- [x] reply/replyUpdate
- [x] deferredReply
- [x] ApplicationCommandAutocompleteContext
- [x] get[string/integer/number]
- [x] autocomplete()
- [x] pass() return empty autocomplete
- [x] MessageComponentContext
- [x] getter(type/customId)
- [x] deferredReplyUpdate (DeferredMessageUpdate)
- [x] optional response support
- [x] optional. Support for manual call handling
- [x] ModalContext
- [x] reply
- [x] deferredReply
- [x] MenuCommandContext
- [x] reply
- [x] UserMenuCommandContext
- [x] getUser
- [x] getMember(guild only)
- [x] MessageMenuCommandContext
- [x] getMessage
- [x] CLI
- [x] resolve imports in deno.json[c]
- [ ] * resolve deps in package.json
\* Maybe it works
### Problems
1. Run the application to cache types from `discord-api-types/v10`
```ts
// ./src/commands.ts
import {defineCommand} from '@maks11060/discord-interactions' // or 'jsr:@maks11060/discord-interactions'
import {ApplicationCommandType} from 'discord-api-types/v10' // or 'npm:discord-api-types/v10'
const test = defineCommand({
type: ApplicationCommandType.ChatInput,
name: 'test',
description: 'autocomplete',
}).createHandler({
test: () => ({
command(c) {
return c.reply({content: 'ok'})
},
}),
})
```
| Supported Runtime | Tested |
| :---------------------------------------------------------------: | :--------------------------------------------------: |
| Deno / Deno Deploy | ✓ |
| CloudFlare worker | ? |
| Bun | x / [bug](https://github.com/oven-sh/bun/pull/12473) |
| Node + [@hono/node-server](https://github.com/honojs/node-server) | ? |