discord-embed-router 0.2.3 → 0.2.5

package/dist/index.d.mts

@@ -1,13 +1,21 @@
 import { ParamData, Path, MatchFunction, MatchResult, TokenData } from 'path-to-regexp';
-import { Interaction, InteractionEditReplyOptions, ButtonInteraction, AnySelectMenuInteraction, InteractionReplyOptions, ButtonBuilder, APIButtonComponent, StringSelectMenuOptionBuilder, StringSelectMenuBuilder, StringSelectMenuComponentData, APIStringSelectComponent, RestOrArray, ChannelSelectMenuBuilder, ChannelSelectMenuComponentData, APIChannelSelectComponent, RoleSelectMenuBuilder, RoleSelectMenuComponentData, APIRoleSelectComponent, UserSelectMenuBuilder, UserSelectMenuComponentData, APIUserSelectComponent } from 'discord.js';
+import { InteractionEditReplyOptions, Interaction, ButtonInteraction, AnySelectMenuInteraction, InteractionReplyOptions, ButtonBuilder, APIButtonComponent, StringSelectMenuOptionBuilder, StringSelectMenuBuilder, StringSelectMenuComponentData, APIStringSelectComponent, RestOrArray, ChannelSelectMenuBuilder, ChannelSelectMenuComponentData, APIChannelSelectComponent, RoleSelectMenuBuilder, RoleSelectMenuComponentData, APIRoleSelectComponent, UserSelectMenuBuilder, UserSelectMenuComponentData, APIUserSelectComponent } from 'discord.js';
 
 type State<L, P extends ParamData = ParamData> = MatchResult<P> & {
     embedRouter: EmbedRouter<L>;
     locals?: L | undefined;
     query: URLSearchParams;
 };
-type RouteResponse = InteractionEditReplyOptions | undefined;
+type RouteResponse = InteractionEditReplyOptions & ({
+    cleanup?: undefined;
+    timeout?: undefined;
+} | {
+    cleanup: CleanupHandler;
+    timeout: number;
+});
 type RouteHandler<M extends Method, L, P extends ParamData = ParamData> = (interaction: Interaction, state: State<L, P>) => M extends "GET" ? Promise<RouteResponse> | RouteResponse : Promise<RouteResponse | undefined> | RouteResponse | undefined;
+type CleanupHandler = () => Promise<InteractionEditReplyOptions | undefined> | InteractionEditReplyOptions | undefined;
+type ApplyHandler = (options: string | InteractionEditReplyOptions) => Promise<unknown>;
 type Method = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
 type CompiledRoute<M extends Method, L, P extends ParamData = ParamData> = {
     method: Method;
@@ -81,7 +89,7 @@ declare class EmbedRouter<L> {
      * @param routePath path of the router
      * @param embedRouter router to add at the path
      */
-    use<P extends Path = Path>(routePath: P, embedRouter: EmbedRouter<L>): void;
+    use<P extends Path = Path>(routePath: P, embedRouter: EmbedRouter<Partial<L>>): void;
     /**
      * Must be attached to "interactionCreate" event for RouteButtonBuilder to work
      *
@@ -97,18 +105,15 @@ declare class EmbedRouter<L> {
      * @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)
      */
-    dispatch<P extends Path = Path>({ interaction, method, path, flags, locals, }: {
-        interaction: Interaction;
+    dispatch<P extends Path = Path>(interaction: Interaction, path: P, { method, flags, locals, }?: {
         method?: Method;
-        path: P;
         flags?: InteractionReplyOptions["flags"] | undefined;
         locals?: L | undefined;
     }): Promise<void>;
 }
 
-type SetOptions<P extends Path> = {
-    method?: Method;
-    path: P;
+type RouteOptions<AllowEmptyMethod extends boolean = false> = {
+    method?: AllowEmptyMethod extends false ? Method : Method | "";
     query?: ConstructorParameters<typeof URLSearchParams>[0] | undefined;
 };
 
@@ -137,17 +142,11 @@ declare class RouteButtonBuilder<L> extends ButtonBuilder {
     /**
      * Sets the path to route to when clicked
      *
-     * @param path the path to route to
-     * @param query any query parameters you want to add
+     * @param path the path to route to, can include :ts
+     * @param query any query parameters you want to add, can include :ts
      * @param method method to send to route
      */
-    setTo<P extends Path>({ method, path, query }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setTo<P extends Path>(path: P): this;
+    setTo<P extends Path>(path: P, { method, query }?: RouteOptions): this;
 }
 
 declare class RouteStringSelectMenuOptionBuilder extends StringSelectMenuOptionBuilder {
@@ -159,19 +158,13 @@ declare class RouteStringSelectMenuOptionBuilder extends StringSelectMenuOptionB
      */
     setValue(): this;
     /**
-     * Sets the path to route to when clicked
+     * Sets the path to route to when selected
      *
-     * @param path the path to route to
-     * @param query any query parameters you want to add
+     * @param path the path to route to, can include :ts
+     * @param query any query parameters you want to add, can include :ts
      * @param method method to send to route
      */
-    setTo<P extends Path>({ method, path, query }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setTo<P extends Path>(path: P): this;
+    setTo<P extends Path>(path: P, { method, query }?: RouteOptions<true>): this;
 }
 
 declare class RouteStringSelectMenuBuilder<L> extends StringSelectMenuBuilder {
@@ -220,17 +213,11 @@ declare class RouteStringSelectMenuBuilder<L> extends StringSelectMenuBuilder {
     /**
      * Sets the pattern to redirect to (Required)
      *
-     * @param path the path to redirect to, :to or *to in path will be replaced with the selected user's id
-     * @param query any query parameters you want to add, :to will be replaced with the selected user's id
+     * @param path the path to redirect to, can include :ts :to *to
+     * @param query any query parameters you want to add, can include :ts :to *to
      * @param method method to send to route
      */
-    setPattern<P extends Path>({ method, path, query, }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setPattern<P extends Path>(path: P): this;
+    setPattern<P extends Path>(path: P, { method, query }?: RouteOptions): this;
 }
 
 declare class RouteChannelSelectMenuBuilder<L> extends ChannelSelectMenuBuilder {
@@ -251,17 +238,11 @@ declare class RouteChannelSelectMenuBuilder<L> extends ChannelSelectMenuBuilder
     /**
      * Sets the pattern to redirect to (Required)
      *
-     * @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 path the path to redirect to, can include :ts :channelId
+     * @param query any query parameters you want to add, can include :ts :channelId
      * @param method method to send to route
      */
-    setPattern<P extends Path>({ method, path, query, }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setPattern<P extends Path>(path: P): this;
+    setPattern<P extends Path>(path: P, { method, query }?: RouteOptions): this;
 }
 
 declare class RouteRoleSelectMenuBuilder<L> extends RoleSelectMenuBuilder {
@@ -282,17 +263,11 @@ declare class RouteRoleSelectMenuBuilder<L> extends RoleSelectMenuBuilder {
     /**
      * Sets the pattern to redirect to (Required)
      *
-     * @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 path the path to redirect to, can include :ts :roleId
+     * @param query any query parameters you want to add, can include :ts :roleId
      * @param method method to send to route
      */
-    setPattern<P extends Path>({ method, path, query, }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setPattern<P extends Path>(path: P): this;
+    setPattern<P extends Path>(path: P, { method, query }?: RouteOptions): this;
 }
 
 declare class RouteUserSelectMenuBuilder<L> extends UserSelectMenuBuilder {
@@ -313,17 +288,11 @@ declare class RouteUserSelectMenuBuilder<L> extends UserSelectMenuBuilder {
     /**
      * Sets the pattern to redirect to (Required)
      *
-     * @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 path the path to redirect to, can include :ts :userId
+     * @param query any query parameters you want to add, can include :ts :userId
      * @param method method to send to route
      */
-    setPattern<P extends Path>({ method, path, query, }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setPattern<P extends Path>(path: P): this;
+    setPattern<P extends Path>(path: P, { method, query }?: RouteOptions): this;
 }
 
-export { type CompiledRoute, EmbedRouter, type Method, RouteButtonBuilder, RouteChannelSelectMenuBuilder, type RouteHandler, type RouteResponse, RouteRoleSelectMenuBuilder, RouteStringSelectMenuBuilder, RouteStringSelectMenuOptionBuilder, RouteUserSelectMenuBuilder, type State };
+export { type ApplyHandler, type CleanupHandler, type CompiledRoute, EmbedRouter, type Method, RouteButtonBuilder, RouteChannelSelectMenuBuilder, type RouteHandler, type RouteResponse, RouteRoleSelectMenuBuilder, RouteStringSelectMenuBuilder, RouteStringSelectMenuOptionBuilder, RouteUserSelectMenuBuilder, type State };

package/dist/index.d.ts

@@ -1,13 +1,21 @@
 import { ParamData, Path, MatchFunction, MatchResult, TokenData } from 'path-to-regexp';
-import { Interaction, InteractionEditReplyOptions, ButtonInteraction, AnySelectMenuInteraction, InteractionReplyOptions, ButtonBuilder, APIButtonComponent, StringSelectMenuOptionBuilder, StringSelectMenuBuilder, StringSelectMenuComponentData, APIStringSelectComponent, RestOrArray, ChannelSelectMenuBuilder, ChannelSelectMenuComponentData, APIChannelSelectComponent, RoleSelectMenuBuilder, RoleSelectMenuComponentData, APIRoleSelectComponent, UserSelectMenuBuilder, UserSelectMenuComponentData, APIUserSelectComponent } from 'discord.js';
+import { InteractionEditReplyOptions, Interaction, ButtonInteraction, AnySelectMenuInteraction, InteractionReplyOptions, ButtonBuilder, APIButtonComponent, StringSelectMenuOptionBuilder, StringSelectMenuBuilder, StringSelectMenuComponentData, APIStringSelectComponent, RestOrArray, ChannelSelectMenuBuilder, ChannelSelectMenuComponentData, APIChannelSelectComponent, RoleSelectMenuBuilder, RoleSelectMenuComponentData, APIRoleSelectComponent, UserSelectMenuBuilder, UserSelectMenuComponentData, APIUserSelectComponent } from 'discord.js';
 
 type State<L, P extends ParamData = ParamData> = MatchResult<P> & {
     embedRouter: EmbedRouter<L>;
     locals?: L | undefined;
     query: URLSearchParams;
 };
-type RouteResponse = InteractionEditReplyOptions | undefined;
+type RouteResponse = InteractionEditReplyOptions & ({
+    cleanup?: undefined;
+    timeout?: undefined;
+} | {
+    cleanup: CleanupHandler;
+    timeout: number;
+});
 type RouteHandler<M extends Method, L, P extends ParamData = ParamData> = (interaction: Interaction, state: State<L, P>) => M extends "GET" ? Promise<RouteResponse> | RouteResponse : Promise<RouteResponse | undefined> | RouteResponse | undefined;
+type CleanupHandler = () => Promise<InteractionEditReplyOptions | undefined> | InteractionEditReplyOptions | undefined;
+type ApplyHandler = (options: string | InteractionEditReplyOptions) => Promise<unknown>;
 type Method = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
 type CompiledRoute<M extends Method, L, P extends ParamData = ParamData> = {
     method: Method;
@@ -81,7 +89,7 @@ declare class EmbedRouter<L> {
      * @param routePath path of the router
      * @param embedRouter router to add at the path
      */
-    use<P extends Path = Path>(routePath: P, embedRouter: EmbedRouter<L>): void;
+    use<P extends Path = Path>(routePath: P, embedRouter: EmbedRouter<Partial<L>>): void;
     /**
      * Must be attached to "interactionCreate" event for RouteButtonBuilder to work
      *
@@ -97,18 +105,15 @@ declare class EmbedRouter<L> {
      * @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)
      */
-    dispatch<P extends Path = Path>({ interaction, method, path, flags, locals, }: {
-        interaction: Interaction;
+    dispatch<P extends Path = Path>(interaction: Interaction, path: P, { method, flags, locals, }?: {
         method?: Method;
-        path: P;
         flags?: InteractionReplyOptions["flags"] | undefined;
         locals?: L | undefined;
     }): Promise<void>;
 }
 
-type SetOptions<P extends Path> = {
-    method?: Method;
-    path: P;
+type RouteOptions<AllowEmptyMethod extends boolean = false> = {
+    method?: AllowEmptyMethod extends false ? Method : Method | "";
     query?: ConstructorParameters<typeof URLSearchParams>[0] | undefined;
 };
 
@@ -137,17 +142,11 @@ declare class RouteButtonBuilder<L> extends ButtonBuilder {
     /**
      * Sets the path to route to when clicked
      *
-     * @param path the path to route to
-     * @param query any query parameters you want to add
+     * @param path the path to route to, can include :ts
+     * @param query any query parameters you want to add, can include :ts
      * @param method method to send to route
      */
-    setTo<P extends Path>({ method, path, query }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setTo<P extends Path>(path: P): this;
+    setTo<P extends Path>(path: P, { method, query }?: RouteOptions): this;
 }
 
 declare class RouteStringSelectMenuOptionBuilder extends StringSelectMenuOptionBuilder {
@@ -159,19 +158,13 @@ declare class RouteStringSelectMenuOptionBuilder extends StringSelectMenuOptionB
      */
     setValue(): this;
     /**
-     * Sets the path to route to when clicked
+     * Sets the path to route to when selected
      *
-     * @param path the path to route to
-     * @param query any query parameters you want to add
+     * @param path the path to route to, can include :ts
+     * @param query any query parameters you want to add, can include :ts
      * @param method method to send to route
      */
-    setTo<P extends Path>({ method, path, query }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setTo<P extends Path>(path: P): this;
+    setTo<P extends Path>(path: P, { method, query }?: RouteOptions<true>): this;
 }
 
 declare class RouteStringSelectMenuBuilder<L> extends StringSelectMenuBuilder {
@@ -220,17 +213,11 @@ declare class RouteStringSelectMenuBuilder<L> extends StringSelectMenuBuilder {
     /**
      * Sets the pattern to redirect to (Required)
      *
-     * @param path the path to redirect to, :to or *to in path will be replaced with the selected user's id
-     * @param query any query parameters you want to add, :to will be replaced with the selected user's id
+     * @param path the path to redirect to, can include :ts :to *to
+     * @param query any query parameters you want to add, can include :ts :to *to
      * @param method method to send to route
      */
-    setPattern<P extends Path>({ method, path, query, }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setPattern<P extends Path>(path: P): this;
+    setPattern<P extends Path>(path: P, { method, query }?: RouteOptions): this;
 }
 
 declare class RouteChannelSelectMenuBuilder<L> extends ChannelSelectMenuBuilder {
@@ -251,17 +238,11 @@ declare class RouteChannelSelectMenuBuilder<L> extends ChannelSelectMenuBuilder
     /**
      * Sets the pattern to redirect to (Required)
      *
-     * @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 path the path to redirect to, can include :ts :channelId
+     * @param query any query parameters you want to add, can include :ts :channelId
      * @param method method to send to route
      */
-    setPattern<P extends Path>({ method, path, query, }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setPattern<P extends Path>(path: P): this;
+    setPattern<P extends Path>(path: P, { method, query }?: RouteOptions): this;
 }
 
 declare class RouteRoleSelectMenuBuilder<L> extends RoleSelectMenuBuilder {
@@ -282,17 +263,11 @@ declare class RouteRoleSelectMenuBuilder<L> extends RoleSelectMenuBuilder {
     /**
      * Sets the pattern to redirect to (Required)
      *
-     * @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 path the path to redirect to, can include :ts :roleId
+     * @param query any query parameters you want to add, can include :ts :roleId
      * @param method method to send to route
      */
-    setPattern<P extends Path>({ method, path, query, }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setPattern<P extends Path>(path: P): this;
+    setPattern<P extends Path>(path: P, { method, query }?: RouteOptions): this;
 }
 
 declare class RouteUserSelectMenuBuilder<L> extends UserSelectMenuBuilder {
@@ -313,17 +288,11 @@ declare class RouteUserSelectMenuBuilder<L> extends UserSelectMenuBuilder {
     /**
      * Sets the pattern to redirect to (Required)
      *
-     * @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 path the path to redirect to, can include :ts :userId
+     * @param query any query parameters you want to add, can include :ts :userId
      * @param method method to send to route
      */
-    setPattern<P extends Path>({ method, path, query, }: SetOptions<P>): this;
-    /**
-     * Sets the path to route to when clicked
-     *
-     * @param path the path to route to
-     */
-    setPattern<P extends Path>(path: P): this;
+    setPattern<P extends Path>(path: P, { method, query }?: RouteOptions): this;
 }
 
-export { type CompiledRoute, EmbedRouter, type Method, RouteButtonBuilder, RouteChannelSelectMenuBuilder, type RouteHandler, type RouteResponse, RouteRoleSelectMenuBuilder, RouteStringSelectMenuBuilder, RouteStringSelectMenuOptionBuilder, RouteUserSelectMenuBuilder, type State };
+export { type ApplyHandler, type CleanupHandler, type CompiledRoute, EmbedRouter, type Method, RouteButtonBuilder, RouteChannelSelectMenuBuilder, type RouteHandler, type RouteResponse, RouteRoleSelectMenuBuilder, RouteStringSelectMenuBuilder, RouteStringSelectMenuOptionBuilder, RouteUserSelectMenuBuilder, type State };