discord-embed-router 0.2.0 → 0.2.3

package/dist/index.mjs

@@ -5,6 +5,20 @@ import { match } from "path-to-regexp";
 
 // src/consts.ts
 var ID_PREFIX = "der";
+var METHOD_TO_ENCODING = {
+  GET: "G",
+  POST: "P",
+  PUT: "U",
+  PATCH: "A",
+  DELETE: "D"
+};
+var ENCODING_TO_METHOD = {
+  G: "GET",
+  P: "POST",
+  U: "PUT",
+  A: "PATCH",
+  D: "DELETE"
+};
 var BASE_URL = "discord://embed.router";
 var PUA_START = 57344;
 var PUA_END = 63743;
@@ -21,34 +35,38 @@ var pathToString = (path2, checkValidity = true) => {
 
 // src/helpers/decodePath.ts
 import { compile } from "path-to-regexp";
-var decodePath = (idPrefix, interaction) => {
+var decodePath = ({
+  idPrefix,
+  interaction
+}) => {
   const customId = interaction.customId;
   if (!customId.startsWith(idPrefix)) return false;
   if (interaction.isButton()) {
-    return customId.slice(idPrefix.length);
-  } else if (interaction.isStringSelectMenu()) {
-    if (interaction.values.length === 0) return false;
-    return fillParams(customId.slice(idPrefix.length), {
-      to: interaction.values[0].split("/").slice(1)
-    });
-  } else if (interaction.isChannelSelectMenu()) {
+    return parseMethodAndPath(customId.slice(idPrefix.length));
+  } else if (interaction.isAnySelectMenu()) {
     if (interaction.values.length === 0) return false;
-    return fillParams(customId.slice(idPrefix.length), {
-      channelId: interaction.values[0]
-    });
-  } else if (interaction.isRoleSelectMenu()) {
-    if (interaction.values.length === 0) return false;
-    return fillParams(customId.slice(idPrefix.length), {
-      roleId: interaction.values[0]
-    });
-  } else if (interaction.isUserSelectMenu()) {
-    if (interaction.values.length === 0) return false;
-    return fillParams(customId.slice(idPrefix.length), {
-      userId: interaction.values[0]
-    });
+    const res = parseMethodAndPath(customId.slice(idPrefix.length));
+    if (!res) return false;
+    const { method, path: path2 } = res;
+    return {
+      method,
+      path: fillParams(path2, {
+        [interaction.isStringSelectMenu() ? "to" : interaction.isChannelSelectMenu() ? "channelId" : interaction.isRoleSelectMenu() ? "roleId" : "userId"]: interaction.values[0].split("/").slice(1)
+      })
+    };
   }
   return false;
 };
+var parseMethodAndPath = (pathWithMethod) => {
+  const firstSlash = pathWithMethod.indexOf("/");
+  if (firstSlash <= 0) return false;
+  const method = ENCODING_TO_METHOD[pathWithMethod.slice(0, firstSlash)];
+  if (method === void 0) return false;
+  return {
+    method,
+    path: pathWithMethod.slice(firstSlash)
+  };
+};
 var fillParams = (path2, params = {}) => {
   const url = new URL(path2, BASE_URL);
   const toPath = compile(url.pathname);
@@ -72,17 +90,17 @@ var fillParams = (path2, params = {}) => {
 // src/EmbedRouter.ts
 var EmbedRouter = class _EmbedRouter {
   // identifier -> embedRouter
-  static usedIdentifiers = /* @__PURE__ */ new Map();
+  static #usedIdentifiers = /* @__PURE__ */ new Map();
   // Name used to generate prefixes
-  name = "";
+  #name = "";
   // Prefix for customIds of RouteButtonBuilders
-  idPrefix;
-  identifier = "";
+  #idPrefix;
+  #identifier = "";
   getIdPrefix() {
-    return `${this.idPrefix}${this.identifier}`;
+    return `${this.#idPrefix}${this.#identifier}`;
   }
   // All added routes
-  routes = [];
+  #routes = /* @__PURE__ */ new Map();
   /**
    *
    * @param name the name to give the router. ensures buttons stay connected across restarts
@@ -92,40 +110,50 @@ var EmbedRouter = class _EmbedRouter {
     name = "",
     idPrefix = ID_PREFIX
   } = {}) {
-    if (_EmbedRouter.usedIdentifiers.size >= PUA_RANGE) {
+    if (_EmbedRouter.#usedIdentifiers.size >= PUA_RANGE) {
       throw new Error(`You can not have more than ${PUA_RANGE} routers`);
     }
     if (idPrefix.includes("/")) {
       throw new Error(`Prefix can't contain "/": ${idPrefix}`);
     }
-    this.idPrefix = idPrefix;
-    this.name = name;
-    this.updateIdentifier();
+    this.#idPrefix = idPrefix;
+    this.#name = name;
+    this.#updateIdentifier();
   }
-  updateIdentifier() {
-    const hash = createHash("sha256").update(this.name).digest();
+  #updateIdentifier() {
+    const hash = createHash("sha256").update(this.#name).digest();
     let raw = hash.readUint32BE(0);
     let char;
     const nameCollisions = [];
     while (true) {
       const codepoint = PUA_START + raw++ % PUA_RANGE;
       char = String.fromCodePoint(codepoint);
-      const collisionRouter = _EmbedRouter.usedIdentifiers.get(char);
+      const collisionRouter = _EmbedRouter.#usedIdentifiers.get(char);
       if (collisionRouter === void 0) break;
-      if (this.name.length > 0 && collisionRouter.name.length === 0) {
-        collisionRouter.updateIdentifier();
+      if (this.#name.length > 0 && collisionRouter.#name.length === 0) {
+        collisionRouter.#updateIdentifier();
         break;
       }
       nameCollisions.push(collisionRouter);
     }
-    _EmbedRouter.usedIdentifiers.set(char, this);
-    if (nameCollisions.length > 0 && this.name.length > 0) {
+    _EmbedRouter.#usedIdentifiers.set(char, this);
+    if (nameCollisions.length > 0 && this.#name.length > 0) {
       process.emitWarning(
-        `EmbedRouter identifier collision for name "${this.name}" with ${nameCollisions.map((c) => `"${c.name}"`).join(", ")}`,
+        `EmbedRouter identifier collision for name "${this.#name}" with ${nameCollisions.map((c) => `"${c.#name}"`).join(", ")}`,
         "EmbedRouterWarning"
       );
     }
-    this.identifier = char;
+    this.#identifier = char;
+  }
+  #addRoute(method, routePath, handler) {
+    const methodRoutes = this.#routes.get(method) ?? [];
+    methodRoutes.push({
+      method,
+      path: Array.isArray(routePath) ? routePath : [routePath],
+      matchFunction: match(routePath),
+      handler
+    });
+    this.#routes.set(method, methodRoutes);
   }
   /**
    * Registers a path with the router
@@ -134,11 +162,43 @@ var EmbedRouter = class _EmbedRouter {
    * @param handler function that generates the message when a path is matched
    */
   get(routePath, handler) {
-    this.routes.push({
-      path: Array.isArray(routePath) ? routePath : [routePath],
-      matchFunction: match(routePath),
-      handler
-    });
+    this.#addRoute("GET", routePath, handler);
+  }
+  /**
+   * Registers a path with the router
+   *
+   * @param routePath path to match with
+   * @param handler function that generates the message when a path is matched
+   */
+  post(routePath, handler) {
+    this.#addRoute("POST", routePath, handler);
+  }
+  /**
+   * Registers a path with the router
+   *
+   * @param routePath path to match with
+   * @param handler function that generates the message when a path is matched
+   */
+  put(routePath, handler) {
+    this.#addRoute("PUT", routePath, handler);
+  }
+  /**
+   * Registers a path with the router
+   *
+   * @param routePath path to match with
+   * @param handler function that generates the message when a path is matched
+   */
+  patch(routePath, handler) {
+    this.#addRoute("PATCH", routePath, handler);
+  }
+  /**
+   * Registers a path with the router
+   *
+   * @param routePath path to match with
+   * @param handler function that generates the message when a path is matched
+   */
+  delete(routePath, handler) {
+    this.#addRoute("DELETE", routePath, handler);
   }
   /**
    * Adds a subrouter to the router
@@ -148,11 +208,14 @@ var EmbedRouter = class _EmbedRouter {
    */
   use(routePath, embedRouter) {
     const pathString = pathToString(routePath);
-    for (const route of embedRouter.routes) {
-      this.get(
-        route.path.map((p) => path.posix.join(pathString, pathToString(p))),
-        route.handler
-      );
+    for (const [method, routes] of embedRouter.#routes) {
+      for (const route of routes) {
+        this.#addRoute(
+          method,
+          route.path.map((p) => path.posix.join(pathString, pathToString(p))),
+          route.handler
+        );
+      }
     }
   }
   /**
@@ -161,34 +224,49 @@ var EmbedRouter = class _EmbedRouter {
    * @param interaction interactions from "interactionCreate" (filter for ButtonInteractions)
    */
   async listener(interaction, locals) {
-    const path2 = decodePath(this.getIdPrefix(), interaction);
-    if (!path2)
+    const res = decodePath({ idPrefix: this.getIdPrefix(), interaction });
+    if (!res)
       throw new Error(`Invalid component found: id ${interaction.customId}`);
-    this.dispatch(interaction, path2, locals);
+    this.dispatch({ interaction, method: res.method, path: res.path, locals });
   }
   /**
-   * Connect or update an interaction message to a path
+   * Replies to or editReplies to an interaction based on the route output
    *
    * @param interaction interaction to connect to
    * @param path path to route the interaction to
-   * @param flags optional discord flags to send with message (only allowed on first reply)
+   * @param method method to send to route
+   * @param flags discord flags to send with message (optional, only allowed on first reply)
+   * @param locals additional info to pass in to page through state.local (optional)
    */
-  async dispatch(interaction, path2, locals, flags) {
+  async dispatch({
+    interaction,
+    method = "GET",
+    path: path2,
+    flags,
+    locals
+  }) {
     if (interaction.isAutocomplete())
       throw new Error("Autocomplete Interactions aren't supported");
-    const resolvedRoute = this.resolve(pathToString(path2, false));
-    if (!resolvedRoute)
-      throw new Error(`No route found for ${pathToString(path2, false)}`);
-    const routeResponse = await resolvedRoute.handler(interaction, {
-      ...resolvedRoute.state,
+    const routeResponse = await this.#resolve({
+      interaction,
+      method,
+      path: path2,
       locals
     });
+    if (routeResponse === false)
+      throw new Error(`No route found for ${pathToString(path2, false)}`);
     if (interaction.replied || interaction.deferred) {
       if (flags)
         throw new Error(
           "You can only set flags for interactions that haven't been replied to"
         );
-      await interaction.editReply(routeResponse);
+      if (routeResponse) await interaction.editReply(routeResponse);
+    } else if (!routeResponse) {
+      if ("deferUpdate" in interaction) {
+        await interaction.deferUpdate();
+      } else {
+        await interaction.deferReply();
+      }
     } else if ("update" in interaction) {
       if (flags)
         throw new Error(
@@ -202,19 +280,31 @@ var EmbedRouter = class _EmbedRouter {
       });
     }
   }
-  resolve(routePath) {
-    const url = new URL(routePath, BASE_URL);
-    for (const route of this.routes) {
+  /**
+   * Resolves a route to the associated message (DOES NOT UPDATE MESSAGE)
+   *
+   * @param interaction interaction to connect to
+   * @param path path to route the interaction to
+   * @param method method to send to route
+   * @param locals additional info to pass in to page through state.local (optional)
+   * @returns discord message associated with route OR false
+   */
+  async #resolve({
+    interaction,
+    method = "GET",
+    path: path2,
+    locals
+  }) {
+    const url = new URL(pathToString(path2, false), BASE_URL);
+    for (const route of this.#routes.get(method) ?? []) {
       const result = route.matchFunction(url.pathname);
       if (result) {
-        return {
-          state: {
-            ...result,
-            query: url.searchParams,
-            embedRouter: this
-          },
-          handler: route.handler
-        };
+        return await route.handler(interaction, {
+          ...result,
+          query: url.searchParams,
+          embedRouter: this,
+          locals
+        });
       }
     }
     return false;
@@ -225,19 +315,29 @@ var EmbedRouter = class _EmbedRouter {
 import { ButtonBuilder } from "discord.js";
 
 // src/helpers/encodePath.ts
-var encodePath = (idPrefix, path2, query) => {
+var encodePath = ({
+  idPrefix,
+  method,
+  path: path2,
+  query
+}) => {
   const url = new URL(pathToString(path2), BASE_URL);
   if (query) {
     for (const [key, value] of new URLSearchParams(query)) {
       url.searchParams.set(key, value);
     }
   }
-  return `${idPrefix}${url.pathname}${url.search}`;
+  return `${idPrefix}${METHOD_TO_ENCODING[method]}${url.pathname}${url.search}`;
+};
+
+// src/types/componentBuilders.ts
+var isSetOptions = (u) => {
+  return typeof u === "object" && u !== null && (!("method" in u) || "method" in u && typeof u.method === "string" || u.method === void 0) && "path" in u && typeof u.path === "string" && (!("query" in u) || "query" in u && ["object", "string"].includes(typeof u.query) || u.query === void 0);
 };
 
 // src/componentBuilders/RouteButtonBuilder.ts
 var RouteButtonBuilder = class extends ButtonBuilder {
-  embedRouter;
+  #embedRouter;
   /**
    *
    * @param embedRouter the router you want to route with
@@ -245,7 +345,7 @@ var RouteButtonBuilder = class extends ButtonBuilder {
    */
   constructor(embedRouter, data) {
     super(data);
-    this.embedRouter = embedRouter;
+    this.#embedRouter = embedRouter;
   }
   /**
    * Not supported for RouteButtonBuilder
@@ -265,14 +365,20 @@ var RouteButtonBuilder = class extends ButtonBuilder {
   setCustomId() {
     throw new Error("setCustomId is not supported on RouteButtonBuilder");
   }
-  /**
-   * Sets the path to route to when clicked
-   *
-   * @param path the path to route to
-   * @param query any query parameters you want to add
-   */
-  setTo(path2, query) {
-    super.setCustomId(encodePath(this.embedRouter.getIdPrefix(), path2, query));
+  setTo(arg) {
+    const {
+      method = "GET",
+      path: path2,
+      query
+    } = isSetOptions(arg) ? arg : { path: arg };
+    super.setCustomId(
+      encodePath({
+        idPrefix: this.#embedRouter.getIdPrefix(),
+        method,
+        path: path2,
+        query
+      })
+    );
     return this;
   }
 };
@@ -284,21 +390,8 @@ import {
 } from "discord.js";
 
 // src/componentBuilders/RouteStringMenuOptionBuilder.ts
-import {
-  StringSelectMenuOptionBuilder
-} from "discord.js";
+import { StringSelectMenuOptionBuilder } from "discord.js";
 var RouteStringSelectMenuOptionBuilder = class extends StringSelectMenuOptionBuilder {
-  /**
-   *
-   * @param data the data to construct a component out of
-   */
-  constructor(data) {
-    const stringSelectData = data ? {
-      ...data,
-      value: encodePath("", data.to)
-    } : void 0;
-    super(stringSelectData);
-  }
   /**
    * Not supported for RouteStringSelectMenuOptionBuilder (use setTo)
    *
@@ -310,21 +403,27 @@ var RouteStringSelectMenuOptionBuilder = class extends StringSelectMenuOptionBui
       "setValue is not supported on RouteStringSelectMenuOptionBuilder"
     );
   }
-  /**
-   * Sets the path to route to when clicked
-   *
-   * @param path the path to route to
-   * @param query any query parameters you want to add
-   */
-  setTo(path2, query) {
-    super.setValue(encodePath("", path2, query));
+  setTo(arg) {
+    const {
+      method = "GET",
+      path: path2,
+      query
+    } = isSetOptions(arg) ? arg : { path: arg };
+    super.setValue(
+      encodePath({
+        idPrefix: "",
+        method,
+        path: path2,
+        query
+      })
+    );
     return this;
   }
 };
 
 // src/componentBuilders/RouteStringSelectMenuBuilder.ts
 var RouteStringSelectMenuBuilder = class extends StringSelectMenuBuilder {
-  embedRouter;
+  #embedRouter;
   /**
    *
    * @param embedRouter the router you want to route with
@@ -332,15 +431,15 @@ var RouteStringSelectMenuBuilder = class extends StringSelectMenuBuilder {
    * @param query any query parameters you want to add, :to will be replaced with the selected user's id
    * @param data the data to construct a component out of
    */
-  constructor(embedRouter, path2 = "/*to", query, data) {
+  constructor(embedRouter, data) {
     super(data);
-    this.embedRouter = embedRouter;
+    this.#embedRouter = embedRouter;
     super.setCustomId(
-      encodePath(
-        this.embedRouter.getIdPrefix(),
-        path2,
-        new URLSearchParams(query)
-      )
+      encodePath({
+        idPrefix: this.#embedRouter.getIdPrefix(),
+        method: "GET",
+        path: "/*to"
+      })
     );
   }
   /**
@@ -404,6 +503,22 @@ var RouteStringSelectMenuBuilder = class extends StringSelectMenuBuilder {
     );
     return this;
   }
+  setPattern(arg) {
+    const {
+      method = "GET",
+      path: path2,
+      query
+    } = isSetOptions(arg) ? arg : { path: arg };
+    super.setCustomId(
+      encodePath({
+        idPrefix: this.#embedRouter.getIdPrefix(),
+        method,
+        path: path2,
+        query
+      })
+    );
+    return this;
+  }
 };
 
 // src/componentBuilders/RouteChannelSelectMenuBuilder.ts
@@ -411,18 +526,15 @@ import {
   ChannelSelectMenuBuilder
 } from "discord.js";
 var RouteChannelSelectMenuBuilder = class extends ChannelSelectMenuBuilder {
-  embedRouter;
+  #embedRouter;
   /**
    *
    * @param embedRouter the router you want to route with
-   * @param path the path to redirect to, :channelId in path will be replaced with the selected user's id
-   * @param query any query parameters you want to add, :channelId will be replaced with the selected user's id
    * @param data the data to construct a component out of
    */
-  constructor(embedRouter, path2, query, data) {
+  constructor(embedRouter, data) {
     super(data);
-    this.embedRouter = embedRouter;
-    super.setCustomId(encodePath(this.embedRouter.getIdPrefix(), path2, query));
+    this.#embedRouter = embedRouter;
   }
   /**
    * Not supported for RouteChannelSelectMenuBuilder (customId set from embedRouter)
@@ -435,6 +547,22 @@ var RouteChannelSelectMenuBuilder = class extends ChannelSelectMenuBuilder {
       "setCustomId is not supported on RouteChannelSelectMenuBuilder"
     );
   }
+  setPattern(arg) {
+    const {
+      method = "GET",
+      path: path2,
+      query
+    } = isSetOptions(arg) ? arg : { path: arg };
+    super.setCustomId(
+      encodePath({
+        idPrefix: this.#embedRouter.getIdPrefix(),
+        method,
+        path: path2,
+        query
+      })
+    );
+    return this;
+  }
 };
 
 // src/componentBuilders/RouteRoleSelectMenuBuilder.ts
@@ -442,18 +570,15 @@ import {
   RoleSelectMenuBuilder
 } from "discord.js";
 var RouteRoleSelectMenuBuilder = class extends RoleSelectMenuBuilder {
-  embedRouter;
+  #embedRouter;
   /**
    *
    * @param embedRouter the router you want to route with
-   * @param path the path to redirect to, :roleId in path will be replaced with the selected user's id
-   * @param query any query parameters you want to add, :roleId will be replaced with the selected user's id
    * @param data the data to construct a component out of
    */
-  constructor(embedRouter, path2, query, data) {
+  constructor(embedRouter, data) {
     super(data);
-    this.embedRouter = embedRouter;
-    super.setCustomId(encodePath(this.embedRouter.getIdPrefix(), path2, query));
+    this.#embedRouter = embedRouter;
   }
   /**
    * Not supported for RouteRoleSelectMenuBuilder (customId set from embedRouter)
@@ -466,6 +591,22 @@ var RouteRoleSelectMenuBuilder = class extends RoleSelectMenuBuilder {
       "setCustomId is not supported on RouteRoleSelectMenuBuilder"
     );
   }
+  setPattern(arg) {
+    const {
+      method = "GET",
+      path: path2,
+      query
+    } = isSetOptions(arg) ? arg : { path: arg };
+    super.setCustomId(
+      encodePath({
+        idPrefix: this.#embedRouter.getIdPrefix(),
+        method,
+        path: path2,
+        query
+      })
+    );
+    return this;
+  }
 };
 
 // src/componentBuilders/RouteUserSelectMenuBuilder.ts
@@ -473,24 +614,15 @@ import {
   UserSelectMenuBuilder
 } from "discord.js";
 var RouteUserSelectMenuBuilder = class extends UserSelectMenuBuilder {
-  embedRouter;
+  #embedRouter;
   /**
    *
    * @param embedRouter the router you want to route with
-   * @param path the path to redirect to, :userId in path will be replaced with the selected user's id
-   * @param query any query parameters you want to add, :userId will be replaced with the selected user's id
    * @param data the data to construct a component out of
    */
-  constructor(embedRouter, path2, query, data) {
+  constructor(embedRouter, data) {
     super(data);
-    this.embedRouter = embedRouter;
-    super.setCustomId(
-      encodePath(
-        this.embedRouter.getIdPrefix(),
-        path2,
-        new URLSearchParams(query)
-      )
-    );
+    this.#embedRouter = embedRouter;
   }
   /**
    * Not supported for RouteUserSelectMenuBuilder (customId set from embedRouter)
@@ -503,6 +635,22 @@ var RouteUserSelectMenuBuilder = class extends UserSelectMenuBuilder {
       "setCustomId is not supported on RouteUserSelectMenuBuilder"
     );
   }
+  setPattern(arg) {
+    const {
+      method = "GET",
+      path: path2,
+      query
+    } = isSetOptions(arg) ? arg : { path: arg };
+    super.setCustomId(
+      encodePath({
+        idPrefix: this.#embedRouter.getIdPrefix(),
+        method,
+        path: path2,
+        query
+      })
+    );
+    return this;
+  }
 };
 export {
   EmbedRouter,