create-discord-https 1.0.6 → 2.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-discord-https",
   "description": "Create Discord.https-powered bots with one command.",
-  "version": "1.0.6",
+  "version": "2.0.0",
   "bin": {
     "create-discord-https": "index.js"
   },

package/templates/cloudflare/package.json

@@ -3,7 +3,7 @@
   "private": true,
   "version": "1.0.0",
   "description": "Discord HTTPS interaction callback bot powered by discord.https",
-  "main": "index.js",
+  "main": "src/index.js",
   "scripts": {
     "dev": "node src/spawner.js",
     "deploy": "npx wrangler deploy --env production",

package/templates/cloudflare/src/commands/index.js

@@ -0,0 +1,14 @@
+import { InteractionRouterCollector } from "discord.https/router";
+
+// Recommend using PascalCase and ending with the 'Route' suffix
+// for variable naming convention
+
+import JokeRoute from "./fun/joke.js";
+import PingRoute from "./reply/ping.js";
+import UtilityRoute from "./utility/index.js";
+
+export default new InteractionRouterCollector().register(
+  JokeRoute,
+  PingRoute,
+  UtilityRoute
+);

package/templates/cloudflare/src/commands/utility/index.js

@@ -0,0 +1,14 @@
+import { InteractionRouterCollector } from "discord.https/router";
+
+// Recommend using PascalCase and ending with the 'Route' suffix
+// for variable naming convention
+
+import HelpRoute from "./help.js";
+import InfoRoute from "./info.js";
+import ProfileRoute from "./profile.js";
+
+export default new InteractionRouterCollector().register(
+  HelpRoute,
+  InfoRoute,
+  ProfileRoute
+);

package/templates/cloudflare/src/index.js

@@ -0,0 +1,59 @@
+import Client from "discord.https";
+import CloudflareAdapter from "@discordhttps/cloudflare-adapter";
+
+import commands from "./commands/index.js";
+
+const adapter = new CloudflareAdapter();
+
+export default {
+  // Cloudflare Workers entry point
+  async fetch(request, env, ctx) {
+    const client = new Client({
+      token: "PUT_YOUR_TOKEN_HERE",
+      publicKey: "PUT_YOUR_PUBLIC_KEY_HERE",
+      httpAdapter: adapter,
+      debug: true,
+    });
+
+    // client.middleware() creates a global middleware, which is always executed before
+    // route middleware/handlers.
+
+    // https://discordhttps.js.org/classes/index.default.html#middleware
+    client.middleware(async (interaction) => {
+      const username = interaction.inGuild()
+        ? interaction.member.user.username
+        : interaction.user.username;
+      console.log(
+        "[Global Middleware]: A command has been invoked by: ",
+        username
+      );
+    });
+
+    // Everything here is middleware. A middleware can be defined as a function that takes a parameter
+    // and transforms the output in our case.
+
+    // client.register() mounts a middleware. This means that if the client receives a request from Discord
+    // and the corresponding middleware exists, the client will pass it to the appropriate middleware
+    // one by one in the order they were registered.
+
+    // simply, .register() lets the client know that these are the handlers.
+    client.register(commands);
+
+    if (env.NODE_ENV !== "production") {
+      const { commandRegistrarLayer, tunnelLayer } = await import(
+        "./DevLayer.js"
+      );
+      // Used to tunnel stuff
+
+      if (!globalThis.__TUNNEL_LAYER__)
+        globalThis.__TUNNEL_LAYER__ = await tunnelLayer();
+
+      // automatic command registration to discord.
+      // The first parameter is the guild ID. If a guild ID is provided, the command will be registered for that guild; otherwise, it will be registered globally.
+      // await commandRegistrarLayer(client, undefined);
+    }
+
+    // Handle Discord interactions on the "/interactions" endpoint
+    return await client.listen("interactions", request);
+  },
+};

package/templates/cloudflare-ts/package.json

@@ -3,7 +3,7 @@
   "private": true,
   "version": "1.0.0",
   "description": "Discord HTTPS interaction callback bot powered by discord.https",
-  "main": "index.js",
+  "main": "src/index.ts",
   "scripts": {
     "dev": "node src/spawner.js",
     "deploy": "npx wrangler deploy --env production",

package/templates/node/package.json

@@ -3,7 +3,7 @@
   "private": true,
   "version": "1.0.0",
   "description": "Discord HTTPS interaction callback bot powered by discord.https",
-  "main": "index.js",
+  "main": "src/index.js",
   "scripts": {
     "dev": "node src/index.js",
     "test": "echo \"Error: no test specified\" && exit 1"

package/templates/node/src/commands/index.js

@@ -0,0 +1,14 @@
+import { InteractionRouterCollector } from "discord.https/router";
+
+// Recommend using PascalCase and ending with the 'Route' suffix
+// for variable naming convention
+
+import JokeRoute from "./fun/joke.js";
+import PingRoute from "./reply/ping.js";
+import UtilityRoute from "./utility/index.js";
+
+export default new InteractionRouterCollector().register(
+  JokeRoute,
+  PingRoute,
+  UtilityRoute
+);

package/templates/node/src/commands/utility/index.js

@@ -0,0 +1,14 @@
+import { InteractionRouterCollector } from "discord.https/router";
+
+// Recommend using PascalCase and ending with the 'Route' suffix
+// for variable naming convention
+
+import HelpRoute from "./help.js";
+import InfoRoute from "./info.js";
+import ProfileRoute from "./profile.js";
+
+export default new InteractionRouterCollector().register(
+  HelpRoute,
+  InfoRoute,
+  ProfileRoute
+);

package/templates/node/src/index.js

@@ -0,0 +1,50 @@
+import Client from "discord.https";
+import NodeHttpAdapter from "@discordhttps/nodejs-adapter";
+
+import commands from "./commands/index.js";
+
+const adapter = new NodeHttpAdapter();
+
+const client = new Client({
+  token: "PUT_YOUR_TOKEN_HERE",
+  publicKey: "PUT_YOUR_PUBLIC_KEY_HERE",
+  httpAdapter: adapter,
+});
+
+// client.middleware() creates a global middleware, which is always executed before
+// route middleware/handlers.
+
+// https://discordhttps.js.org/classes/index.default.html#middleware
+client.middleware(async (interaction) => {
+  const username = interaction.inGuild()
+    ? interaction.member.user.username
+    : interaction.user.username;
+  console.log("[Global Middleware]: A command has been invoked by: ", username);
+});
+
+// Everything here is middleware. A middleware can be defined as a function that takes a parameter
+// and transforms the output in our case.
+
+// client.register() mounts a middleware. This means that if the client receives a request from Discord
+// and the corresponding middleware exists, the client will pass it to the appropriate middleware
+// one by one in the order they were registered.
+
+// simply, .register() lets the client know that these are the handlers.
+
+client.register(commands);
+
+if (process.env.NODE_ENV !== "production") {
+  const { commandRegistrarLayer, tunnelLayer } = await import("./DevLayer.js");
+  // Used to tunnel stuff
+  await tunnelLayer();
+
+  // automatic command registration to discord.
+  // The first parameter is the guild ID. If a guild ID is provided, the command will be registered for that guild; otherwise, it will be registered globally.
+  await commandRegistrarLayer(client, undefined);
+}
+
+client.listen("interactions", 8080, () => {
+  console.log(
+    "Listening for interactions at http://localhost:8080/interactions"
+  );
+});

package/templates/node-ts/package.json

@@ -3,7 +3,6 @@
   "private": true,
   "version": "1.0.0",
   "description": "Discord HTTPS interaction callback bot powered by discord.https",
-  "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },

package/templates/vercel/package.json

@@ -3,7 +3,11 @@
   "private": true,
   "version": "1.0.0",
   "description": "Discord HTTPS interaction callback bot powered by discord.https",
-  "main": "index.js",
+  "main": "api/interaction.js",
+  "files": [
+    "api",
+    "src"
+  ],
   "scripts": {
     "dev": "node src/spawner.js",
     "test": "echo \"Error: no test specified\" && exit 1"

package/templates/vercel/src/commands/index.js

@@ -0,0 +1,14 @@
+import { InteractionRouterCollector } from "discord.https/router";
+
+// Recommend using PascalCase and ending with the 'Route' suffix
+// for variable naming convention
+
+import JokeRoute from "./fun/joke.js";
+import PingRoute from "./reply/ping.js";
+import UtilityRoute from "./utility/index.js";
+
+export default new InteractionRouterCollector().register(
+  JokeRoute,
+  PingRoute,
+  UtilityRoute
+);

package/templates/vercel/src/commands/utility/index.js

@@ -0,0 +1,14 @@
+import { InteractionRouterCollector } from "discord.https/router";
+
+// Recommend using PascalCase and ending with the 'Route' suffix
+// for variable naming convention
+
+import HelpRoute from "./help.js";
+import InfoRoute from "./info.js";
+import ProfileRoute from "./profile.js";
+
+export default new InteractionRouterCollector().register(
+  HelpRoute,
+  InfoRoute,
+  ProfileRoute
+);

package/templates/vercel/src/index.js

@@ -0,0 +1,49 @@
+import Client from "discord.https";
+import VercelAdapter from "@discordhttps/vercel-adapter";
+
+import commands from "./commands/index.js";
+
+const adapter = new VercelAdapter();
+
+const client = new Client({
+  token: "PUT_YOUR_TOKEN_HERE",
+  publicKey: "PUT_YOUR_PUBLIC_KEY_HERE",
+  httpAdapter: adapter,
+});
+
+// client.middleware() creates a global middleware, which is always executed before
+// route middleware/handlers.
+
+// https://discordhttps.js.org/classes/index.default.html#middleware
+client.middleware(async (interaction) => {
+  const username = interaction.inGuild()
+    ? interaction.member.user.username
+    : interaction.user.username;
+  console.log("[Global Middleware]: A command has been invoked by: ", username);
+});
+
+// Everything here is middleware. A middleware can be defined as a function that takes a parameter
+// and transforms the output in our case.
+
+// client.register() mounts a middleware. This means that if the client receives a request from Discord
+// and the corresponding middleware exists, the client will pass it to the appropriate middleware
+// one by one in the order they were registered.
+
+// simply, .register() lets the client know that these are the handlers.
+
+client.register(commands);
+
+if (process.env.NODE_ENV !== "production") {
+  const { commandRegistrarLayer } = await import("./DevLayer.js");
+
+  // if (!globalThis.__TUNNEL_LAYER__)
+  //   globalThis.__TUNNEL_LAYER__ = await tunnelLayer();
+
+  // automatic command registration to discord.
+  // The first parameter is the guild ID. If a guild ID is provided, the command will be registered for that guild; otherwise, it will be registered globally.
+  await commandRegistrarLayer(client, undefined);
+}
+
+// Only api/<file.js/ts> can be serverless function, exporting it for api/interaction
+// so, it cloud be imported from api/interaction.js and use there due to vercel way of serverless
+export default client;

package/templates/vercel-ts/api/interactions.ts

@@ -0,0 +1,5 @@
+import client from "../src/index.js";
+import type { VercelRequest, VercelResponse } from "@vercel/functions";
+export default async function handler(req: VercelRequest, res: VercelResponse) {
+  return await client.listen("api/interactions", req, res);
+}

package/templates/vercel-ts/package.json

@@ -3,7 +3,7 @@
   "private": true,
   "version": "1.0.0",
   "description": "Discord HTTPS interaction callback bot powered by discord.https",
-  "main": "index.js",
+  "main": "api/interactions.ts",
   "scripts": {
     "dev": "node src/spawner.js",
     "test": "echo \"Error: no test specified\" && exit 1"

package/templates/vercel-ts/api/interactions.js

@@ -1,5 +0,0 @@
-import client from "../src/index.js";
-
-export default async function handler(req, res) {
-  return await client.listen("api/interactions", req, res);
-}