initialize

Author: fourcolverleaf

.gitignore

@@ -1,4 +1,5 @@
 package-lock.json
 node_modules
 dist
-tsconfig.tsbuildinfo
+tsconfig.tsbuildinfo
+docs/

README.md

@@ -1,18 +1,19 @@
 # Discord.https
 
+[![Discord](https://img.shields.io/badge/discord-blue?logo=discord&logoColor=white)](https://discord.gg/pSgfJ4K5ej)
 [![npm version](https://img.shields.io/npm/v/discord.https.svg)](https://www.npmjs.com/package/discord.https)
 [![License](https://img.shields.io/npm/l/discord.https.svg)](LICENSE)
-[![Downloads](https://img.shields.io/npm/dm/discord.https.svg)](https://www.npmjs.com/package/discord.https/index.default.html)
+[![Downloads](https://img.shields.io/npm/dm/discord.https.svg)](https://www.npmjs.com/package/discord.https)
 [![Docs](https://img.shields.io/badge/docs-latest-blue)](https://discordhttps.github.io/discord.https/)
 
 **Discord.https** is a robust, modular library for implementing Discord HTTP interactions.
 
 It handles various interactions and organizes them into modular routes, making your bot's code cleaner, easier to understand, and easier to maintain. It works seamlessly in both serverless and persistent server environments.
 
-The core is production-ready and can be used in your new HTTP interaction bots.
-
 📄 **Documentation:** [https://discordhttps.github.io/discord.https/](https://discordhttps.github.io/discord.https/)
 
+Need help? Join us on discord  [https://discord.gg/pSgfJ4K5ej](https://discord.gg/pSgfJ4K5ej)
+
 ```js
 import Client, { InteractionResponseType } from "discord.https";
 import NodeAdapter from "@discordhttps/nodejs-adapter";
@@ -25,22 +26,7 @@ const client = new Client({
 
 client.command(
   (builder) => builder.setName("hi").setDescription("reply hello!"),
-  async (interaction, client, _, res) => {
-    res.writeHead(200, {
-      "Content-Type": "application/json",
-    });
-    const username = interaction.user
-      ? interaction.user.global_name
-      : interaction.member.user.global_name;
-    res.end(
-      JSON.stringify({
-        type: InteractionResponseType.ChannelMessageWithSource,
-        data: {
-          content: `Hello! ${username}`,
-        },
-      })
-    );
-  }
+  async (interaction) => await interaction.reply("hello!")
 );
 
 await client.listen("interactions", 3000, () => {
@@ -56,10 +42,16 @@ await client.listen("interactions", 3000, () => {
 
 > **Note**: Utility methods such as <interaction>.editReply() and <interaction>.deferReply() are currently in development, so you won’t need to manually handle the raw response object in the future.
 
-> **Note(new)**: Utility methods were initially planned to closely follow Discord.js. However, since HTTP interactions are mostly used in a serverless environment, instead of having many layers of objects like Discord.js, an Eris-like approach will be adopted to keep the utilities minimal and lightweight.
+> **Note**: Utility methods were initially planned to closely follow Discord.js. However, since HTTP interactions are mostly used in a serverless environment, instead of having many layers of objects like Discord.js, an Eris-like approach will be adopted to keep the utilities minimal and lightweight.
+
+> **Breaking Update (latest note)**: The goal was to stay within the web-standard V8 engine, but `@discord/rest` heavily depends on the Node.js environment. There are two choices: either use `@discord/rest` or build a custom REST handler. For now, `@discord/rest` will be used. The focus is on the Edge network, primarily Cloudflare. However, Cloudflare recently added [native Node.js support](https://blog.cloudflare.com/nodejs-workers-2025/). Previously, Node.js support was polyfilled, which can be inefficient for servers due to extra overhead. Now, Node.js support is native. Hence, from now on, the focus will be on Node.js APIs instead of web-standard/browser-context APIs.
 
 ## Examples
 
+>Examples are outdated. You are no longer required to handle the raw response. The core is still there, and you can use these examples as a reference.
+
+Deprecate warning, this example can be serve as a basic idea, but it has been changed quite a lot since, with utility functions.
+
 **You can view example/reference implementations here:**
 
 - Nodejs Runtime: [https://github.com/discordhttps/nodejs-example](https://github.com/discordhttps/nodejs-example)
@@ -84,10 +76,11 @@ npm install discord.https @discordhttps/cloudflare-adapter
 - **Discord.https Docs:** [https://discordhttps.github.io/discord.https/](https://discordhttps.github.io/discord.https/)
 - **Discord Interaction Docs:** [Responding to an Interaction](https://discord.com/developers/docs/interactions/receiving-and-responding#responding-to-an-interaction)
 
-## Todo
+## Todo for v4
 
-- [ ] Build structures
 - [ ] Build a simplified `npx create-app` command
 - [ ] Implement tests
-- [x] HTTP adapters to support all hosting environments. Currently implemented: Node.js adapter for [Node.js runtime](https://github.com/discord-http/nodejs-adapter) and [Cloudflare adapter for V8 isolates runtime](https://github.com/discord-http/cloudflare-adapter)
-- [x] Examples
+- [ ] Build channel, guild, etc wrapper
+- [X] ~~Build interaction wrapper~~
+- [x] ~~HTTP adapters to support most hosting environments~~. Currently implemented: Node.js adapter for [Node.js runtime](https://github.com/discord-http/nodejs-adapter) and [Cloudflare adapter for V8 isolates runtime](https://github.com/discord-http/cloudflare-adapter)
+- [x] Examples(currently outdated, requires update)

package.json

@@ -34,18 +34,16 @@
     "url": "https://github.com/discord-http/discord.https/issues"
   },
   "homepage": "https://discordhttps.github.io/discord.https",
-  "engines": {
-    "node": ">=18"
-  },
   "license": "MIT",
   "dependencies": {
     "@discordjs/builders": "^1.11.3",
+    "@discordjs/collection": "^2.1.1",
     "@discordjs/rest": "^2.6.0",
     "@discordjs/util": "^1.1.1",
     "@noble/ed25519": "^3.0.0",
     "@sapphire/snowflake": "^3.5.5",
     "chalk": "^5.6.0",
-    "discord-api-types": "^0.38.22"
+    "discord-api-types": "^0.38.26"
   },
   "keywords": [
     "discord",

src/adapter/index.ts

@@ -30,7 +30,7 @@ export interface HttpAdapter {
 export interface HttpAdapterSererResponse {
   headersSent: boolean;
   writeHead(status: number, headers?: Record<string, string>): void;
-  end(chunk?: string): void;
+  end(chunk?: string | Uint8Array): void;
 }
 
 /**

src/index.ts

@@ -1,13 +1,17 @@
+import {
+  InteractionRouterManager,
+  userContextCommandBuilder,
+  messageContextCommandBuilder,
+  type userContextCommandBuilderType,
+  type messageContextCommandBuilderType,
+} from "./interactionRouter/internal.js";
+import { HttpInteractionServer } from "./interactionServer.js";
+import type { HttpAdapter, HttpAdapterSererResponse } from "./adapter/index.js";
+import { AutoCompleteKeyBuilder } from "./interactionRouter/autoCompleteKeyBuilder.js";
 import chalk from "chalk";
 import { REST } from "@discordjs/rest";
 import { SlashCommandBuilder } from "@discordjs/builders";
 
-import HttpInteractionServer from "./interactionServer.js";
-import InteractionRouterManger from "./interactionRouter/internal.js";
-import AutoCompleteKeyBuilder from "./interactionRouter/autoCompleteKeyBuilder.js";
-
-import type { HttpAdapter, HttpAdapterSererResponse } from "./adapter/index.js";
-
 import {
   InteractionType,
   InteractionResponseType,
@@ -32,10 +36,10 @@ import type {
   CommandMiddleware,
   CommandbuilderType,
   GenericMiddleware,
+  UserContextMenuMiddleware,
+  MessageContextMenuMiddleware,
 } from "./interactionRouter/internal.js";
 
-import type { MessageMentionOptions } from "discord.js";
-
 export interface ClientOptions {
   token: string;
   publicKey: string;
@@ -92,7 +96,7 @@ export interface ClientOptions {
 
 class Client extends HttpInteractionServer {
   /** Interaction router manager responsible for routing incoming interactions. */
-  private router = new InteractionRouterManger();
+  private router = new InteractionRouterManager();
 
   /**
    * REST API client instance used for interacting with Discord's HTTP API.
@@ -141,6 +145,7 @@ class Client extends HttpInteractionServer {
    */
 
   middleware(...fns: GeneralMiddleware[]) {
+    this.tryAsync(fns);
     this.router.middlewares.push(...fns);
   }
 
@@ -150,6 +155,7 @@ class Client extends HttpInteractionServer {
    * @param fns - Async Functions executed when no handler matches an interaction. See {@link UnknownMiddleware} for callback parameters.
    */
   unknown(...fns: UnknownMiddleware[]) {
+    this.tryAsync(fns);
     this.router._unknownInteraction.push(...fns);
   }
 
@@ -176,14 +182,14 @@ class Client extends HttpInteractionServer {
    *
    * @param commandbuilder - Function returning a {@link SlashCommandBuilder}.
    * @param fns {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function | Async} functions. See {@link GenericMiddleware} for callback parameters.
-   * @returns {@link AutoCompleteKeyBuilder} for autocomplete options.
+   * @returns an {@link AutoCompleteKeyBuilder} for autocomplete options.
    * @example
    *
    * ```ts
    * router.command(
    *   (builder) =>
    *     builder.setName("Ping!").setDescription("Returns Pong!"),
-   *     pongHandle
+   *     async (interaction) => await interaction.reply("Pong!")
    * );
    * ```
    *
@@ -206,7 +212,7 @@ class Client extends HttpInteractionServer {
    * @param fns - {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function | Async} functions. See {@link GenericMiddleware} for callback parameters.
    * @example
    * ```ts
-   * router.button("custom_button_id", buttonMiddleware);
+   * router.button("custom_button_id", async (interaction) => await interaction.reply("Button Pressed!"));
    * ```
    */
   button(customId: string, ...fns: ButtonMiddleware[]) {
@@ -303,20 +309,20 @@ class Client extends HttpInteractionServer {
    * @param fns {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function | Async} functions. See {@link GenericMiddleware} for callback parameters.
    * @example
    * ```ts
-   * const githubQuery = router.command(
-   *   (builder) =>
+   * const weather = router.command(
+   *  async(builder) =>
    *     builder
-   *       .setName("weather")  // The command name
-   *       .setDescription("Query weather information!")  // The command description
+   *       .setName("weather")
+   *       .setDescription("Query weather information!")
    *       .addStringOption(option =>
    *         option
-   *           .setName("city")  // Option name
-   *           .setDescription("City to get the weather for")  // Option description
+   *           .setName("city")  // Option Name
+   *           .setDescription("City to get the weather for")
    *           .setAutocomplete(true) // Enable autocomplete for this option
    *       ),
    *   handler
    * );
-   * router.autocomplete(githubQuery.getAutoCompleteKey("city"), autocompleteMiddleware);
+   * router.autocomplete(weather.getAutoCompleteKey("city"), autocompleteMiddleware);
    * ```
    */
 
@@ -341,12 +347,20 @@ class Client extends HttpInteractionServer {
    * @param fns {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function | Async} functions. See {@link GenericMiddleware} for callback parameters.
    * @example
    * ```ts
-   * router.userContextMenu("userContextMenuId", userContextMenuMiddleware);
+   * router.userContextMenu(builder => builder.setName("Hello"), userContextMenuMiddleware);
    * ```
    */
-  userContextMenu(customId: string, ...fns: ContextMenuMiddleware[]) {
+  userContextMenu(
+    commandbuilder: userContextCommandBuilderType,
+    ...fns: UserContextMenuMiddleware[]
+  ) {
     this.tryAsync(fns);
-    this.router._register("userContextMenu", customId, fns);
+    const builder = userContextCommandBuilder();
+    const build = commandbuilder(builder);
+    this.router._register("userContextMenu", build.name, fns);
+
+    const commandDefinition = build.toJSON();
+    this.router.CommandDefinitions.push(commandDefinition);
   }
 
   /**
@@ -355,12 +369,20 @@ class Client extends HttpInteractionServer {
    * @param fns {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function | Async} functions. See {@link GenericMiddleware} for callback parameters.
    * @example
    * ```ts
-   * router.messageContextMenu("messageContextMenu", messageContextMenuMiddleware);
+   * router.messageContextMenu(builder => builder.setName("Hello"), messageContextMenuMiddleware);
    * ```
    */
-  messageContextMenu(customId: string, ...fns: ContextMenuMiddleware[]) {
+  messageContextMenu(
+    commandbuilder: messageContextCommandBuilderType,
+    ...fns: MessageContextMenuMiddleware[]
+  ) {
     this.tryAsync(fns);
-    this.router._register("messageContextMenu", customId, fns);
+    const builder = messageContextCommandBuilder();
+    const build = commandbuilder(builder);
+    this.router._register("messageContextMenu", build.name, fns);
+
+    const commandDefinition = build.toJSON();
+    this.router.CommandDefinitions.push(commandDefinition);
   }
   /**
    * Handles incoming interaction payloads from Discord.
@@ -386,7 +408,7 @@ class Client extends HttpInteractionServer {
     }
     this.debug("Interaction Request Received");
     // this.router.__internal_dispatch(res, body, this.client);
-    await this.router.__internal_dispatch(res, body, this.rest);
+    await this.router.__internal_dispatch(res, body, this);
   }
 
   /**
@@ -507,5 +529,6 @@ class Client extends HttpInteractionServer {
 }
 
 export default Client;
+export { AttachmentBuilder } from "./structures/Attachment/AttachmentBuilder.js";
 export * from "@discordjs/builders";
 export * from "discord-api-types/v10";

src/interactionRouter/autoCompleteKeyBuilder.ts

@@ -13,14 +13,14 @@ import type { CommandDefinitionType } from "./internal.js";
  */
 
 export interface APIApplicationCommandAutocompleteInteractionModified {
-  /** Type of the option (string, number, boolean, etc.). */
+  /** Type of the option (string, number, etc.). */
   type: ApplicationCommandOptionType;
 
   /** Name of the option. */
   name: string;
 
   /** Current value of the option if provided. */
-  value?: string | number | boolean; // The value of the option (can be string, number, or boolean)
+  value?: string; // The value of the option (can be string, integer, double, or boolean)
 
   /** Whether this option is currently focused. */
   focused?: boolean;
@@ -57,7 +57,7 @@ export interface APIApplicationCommandAutocompleteInteractionModified {
  * router.autocomplete(weather.getAutoCompleteKey("city"), autocompleteMiddleware);
  */
 
-class AutoCompleteKeyBuilder {
+export class AutoCompleteKeyBuilder {
   /** @internal Internal list of the path segments collected so far. */
   private path: string[] = []; // Array to store path segment
 
@@ -310,5 +310,3 @@ class AutoCompleteKeyBuilder {
     throw Error("Autocomplete event was fired without any options.");
   }
 }
-
-export default AutoCompleteKeyBuilder;