discord-embed-router 0.0.3 → 0.2.0

package/README.md

@@ -1,3 +1,3 @@
 # discord-embed-router
 
-A url-based router for discord.js interaction messages
+A url path based router for discord.js interaction messages

package/dist/index.d.mts

@@ -1,3 +1,238 @@
-declare const _default: {};
+import { ParamData, Path, MatchFunction, MatchResult, TokenData } from 'path-to-regexp';
+import { Interaction, InteractionEditReplyOptions, ButtonInteraction, AnySelectMenuInteraction, InteractionReplyOptions, ButtonBuilder, APIButtonComponent, StringSelectMenuOptionBuilder, SelectMenuComponentOptionData, APISelectMenuOption, StringSelectMenuBuilder, StringSelectMenuComponentData, APIStringSelectComponent, RestOrArray, ChannelSelectMenuBuilder, ChannelSelectMenuComponentData, APIChannelSelectComponent, RoleSelectMenuBuilder, RoleSelectMenuComponentData, APIRoleSelectComponent, UserSelectMenuBuilder, UserSelectMenuComponentData, APIUserSelectComponent } from 'discord.js';
 
-export { _default as default };
+type State<L, P extends ParamData = ParamData> = MatchResult<P> & {
+    embedRouter: EmbedRouter<L>;
+    locals?: L | undefined;
+    query: URLSearchParams;
+};
+type RouteResponse = InteractionEditReplyOptions;
+type RouteHandler<L, P extends ParamData = ParamData> = (interaction: Interaction, state: State<L, P>) => Promise<RouteResponse> | RouteResponse;
+type CompiledRoute<L, P extends ParamData = ParamData> = {
+    path: Path[];
+    matchFunction: MatchFunction<P>;
+    handler: RouteHandler<L, P>;
+};
+type ResolvedRoute<L, P extends ParamData = ParamData> = {
+    state: State<L, P>;
+    handler: RouteHandler<L, P>;
+};
+
+type TakeIdentifier<T extends string, Name extends string = ""> = T extends `${infer Char}${infer Rest}` ? Char extends "/" | ":" | "*" | "{" | "}" ? [Name, T] : TakeIdentifier<Rest, `${Name}${Char}`> : [Name, T];
+type TakeQuoted<T extends string, Name extends string = ""> = T extends `"${infer Rest}` ? [Name, Rest] : T extends `${infer Char}${infer Rest}` ? TakeQuoted<Rest, `${Name}${Char}`> : [Name, T];
+type ParseName<T extends string> = T extends `"${infer Rest}` ? TakeQuoted<Rest> : TakeIdentifier<T>;
+type ExtractParams<T extends string | TokenData, Depth extends string = ""> = T extends TokenData ? ParamData : T extends string ? T extends `${infer Char}${infer Rest}` ? Char extends ":" | "*" ? ParseName<Rest> extends [
+    infer Name extends string,
+    infer After extends string
+] ? (Depth extends "" ? {
+    [K in Name]: string;
+} : {
+    [K in Name]?: string;
+}) & ExtractParams<After, Depth> : ExtractParams<Rest, Depth> : Char extends "{" ? ExtractParams<Rest, `${Depth}1`> : Char extends "}" ? ExtractParams<Rest, Depth extends `1${infer Rest2}` ? Rest2 : Depth> : ExtractParams<Rest, Depth> : object : never;
+
+declare class EmbedRouter<L> {
+    private static usedIdentifiers;
+    private name;
+    private idPrefix;
+    private identifier;
+    getIdPrefix(): string;
+    private routes;
+    /**
+     *
+     * @param name the name to give the router. ensures buttons stay connected across restarts
+     * @param idPrefix the prefix for RouteButtonBuilder customIds
+     */
+    constructor({ name, idPrefix, }?: {
+        name?: string;
+        idPrefix?: string;
+    });
+    private updateIdentifier;
+    /**
+     * Registers a path with the router
+     *
+     * @param routePath path to match with
+     * @param handler function that generates the message when a path is matched
+     */
+    get<P extends Path = Path>(routePath: P | P[], handler: RouteHandler<L, ExtractParams<P>>): void;
+    /**
+     * Adds a subrouter to the router
+     *
+     * @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;
+    /**
+     * Must be attached to "interactionCreate" event for RouteButtonBuilder to work
+     *
+     * @param interaction interactions from "interactionCreate" (filter for ButtonInteractions)
+     */
+    listener(interaction: ButtonInteraction | AnySelectMenuInteraction, locals?: L): Promise<void>;
+    /**
+     * Connect or update an interaction message to a path
+     *
+     * @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)
+     */
+    dispatch<P extends Path = Path>(interaction: Interaction, path: P, locals?: L, flags?: InteractionReplyOptions["flags"]): Promise<void>;
+    private resolve;
+}
+
+declare class RouteButtonBuilder<L> extends ButtonBuilder {
+    private embedRouter;
+    /**
+     *
+     * @param embedRouter the router you want to route with
+     * @param data the data to construct a component out of
+     */
+    constructor(embedRouter: EmbedRouter<L>, data?: Omit<Partial<APIButtonComponent>, "custom_id" | "url">);
+    /**
+     * Not supported for RouteButtonBuilder
+     *
+     * @remarks
+     * @param
+     */
+    setURL(): this;
+    /**
+     * Not supported for RouteButtonBuilder (use setTo)
+     *
+     * @remarks
+     * @param
+     */
+    setCustomId(): this;
+    /**
+     * 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<P extends Path>(path: P, query?: ConstructorParameters<typeof URLSearchParams>[0]): this;
+}
+
+declare class RouteStringSelectMenuOptionBuilder extends StringSelectMenuOptionBuilder {
+    /**
+     *
+     * @param data the data to construct a component out of
+     */
+    constructor(data?: Omit<SelectMenuComponentOptionData | APISelectMenuOption, "value"> & {
+        to: string;
+    });
+    /**
+     * Not supported for RouteStringSelectMenuOptionBuilder (use setTo)
+     *
+     * @remarks
+     * @param
+     */
+    setValue(): this;
+    /**
+     * 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<P extends Path>(path: P, query?: ConstructorParameters<typeof URLSearchParams>[0]): this;
+}
+
+declare class RouteStringSelectMenuBuilder<L, P extends Path> extends StringSelectMenuBuilder {
+    private embedRouter;
+    /**
+     *
+     * @param embedRouter the router you want to route with
+     * @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 data the data to construct a component out of
+     */
+    constructor(embedRouter: EmbedRouter<L>, path?: P | string, query?: ConstructorParameters<typeof URLSearchParams>[0], data?: Partial<StringSelectMenuComponentData | APIStringSelectComponent>);
+    /**
+     * Not supported for RouteStringSelectMenuBuilder (customId set from embedRouter)
+     *
+     * @remarks
+     * @param
+     */
+    setCustomId(): this;
+    /**
+     * Not supported for RouteStringSelectMenuBuilder (use addTos)
+     *
+     * @remarks
+     * @param
+     */
+    addOptions(): this;
+    /**
+     * Not supported for RouteStringSelectMenuBuilder (use setTos)
+     *
+     * @remarks
+     * @param
+     */
+    setOptions(): this;
+    /**
+     * Adds route select menu options to builder
+     *
+     * @param tos the list of route select menu options
+     */
+    addTos(...tos: RestOrArray<RouteStringSelectMenuOptionBuilder | ConstructorParameters<typeof RouteStringSelectMenuOptionBuilder>[0]>): this;
+    /**
+     * Sets route select menu options to builder
+     *
+     * @param tos the list of route select menu options
+     */
+    setTos(...tos: RestOrArray<RouteStringSelectMenuOptionBuilder | ConstructorParameters<typeof RouteStringSelectMenuOptionBuilder>[0]>): this;
+}
+
+declare class RouteChannelSelectMenuBuilder<L, P extends Path> extends ChannelSelectMenuBuilder {
+    private 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: EmbedRouter<L>, path: P, query?: ConstructorParameters<typeof URLSearchParams>[0], data?: Partial<ChannelSelectMenuComponentData | APIChannelSelectComponent>);
+    /**
+     * Not supported for RouteChannelSelectMenuBuilder (customId set from embedRouter)
+     *
+     * @remarks
+     * @param
+     */
+    setCustomId(): this;
+}
+
+declare class RouteRoleSelectMenuBuilder<L, P extends Path> extends RoleSelectMenuBuilder {
+    private 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: EmbedRouter<L>, path: P, query?: ConstructorParameters<typeof URLSearchParams>[0], data?: Partial<RoleSelectMenuComponentData | APIRoleSelectComponent>);
+    /**
+     * Not supported for RouteRoleSelectMenuBuilder (customId set from embedRouter)
+     *
+     * @remarks
+     * @param
+     */
+    setCustomId(): this;
+}
+
+declare class RouteUserSelectMenuBuilder<L, P extends Path> extends UserSelectMenuBuilder {
+    private 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: EmbedRouter<L>, path: P, query?: ConstructorParameters<typeof URLSearchParams>[0], data?: Partial<UserSelectMenuComponentData | APIUserSelectComponent>);
+    /**
+     * Not supported for RouteUserSelectMenuBuilder (customId set from embedRouter)
+     *
+     * @remarks
+     * @param
+     */
+    setCustomId(): this;
+}
+
+export { type CompiledRoute, EmbedRouter, type ResolvedRoute, RouteButtonBuilder, RouteChannelSelectMenuBuilder, type RouteHandler, type RouteResponse, RouteRoleSelectMenuBuilder, RouteStringSelectMenuBuilder, RouteStringSelectMenuOptionBuilder, RouteUserSelectMenuBuilder, type State };

package/dist/index.d.ts

@@ -1,3 +1,238 @@
-declare const _default: {};
+import { ParamData, Path, MatchFunction, MatchResult, TokenData } from 'path-to-regexp';
+import { Interaction, InteractionEditReplyOptions, ButtonInteraction, AnySelectMenuInteraction, InteractionReplyOptions, ButtonBuilder, APIButtonComponent, StringSelectMenuOptionBuilder, SelectMenuComponentOptionData, APISelectMenuOption, StringSelectMenuBuilder, StringSelectMenuComponentData, APIStringSelectComponent, RestOrArray, ChannelSelectMenuBuilder, ChannelSelectMenuComponentData, APIChannelSelectComponent, RoleSelectMenuBuilder, RoleSelectMenuComponentData, APIRoleSelectComponent, UserSelectMenuBuilder, UserSelectMenuComponentData, APIUserSelectComponent } from 'discord.js';
 
-export { _default as default };
+type State<L, P extends ParamData = ParamData> = MatchResult<P> & {
+    embedRouter: EmbedRouter<L>;
+    locals?: L | undefined;
+    query: URLSearchParams;
+};
+type RouteResponse = InteractionEditReplyOptions;
+type RouteHandler<L, P extends ParamData = ParamData> = (interaction: Interaction, state: State<L, P>) => Promise<RouteResponse> | RouteResponse;
+type CompiledRoute<L, P extends ParamData = ParamData> = {
+    path: Path[];
+    matchFunction: MatchFunction<P>;
+    handler: RouteHandler<L, P>;
+};
+type ResolvedRoute<L, P extends ParamData = ParamData> = {
+    state: State<L, P>;
+    handler: RouteHandler<L, P>;
+};
+
+type TakeIdentifier<T extends string, Name extends string = ""> = T extends `${infer Char}${infer Rest}` ? Char extends "/" | ":" | "*" | "{" | "}" ? [Name, T] : TakeIdentifier<Rest, `${Name}${Char}`> : [Name, T];
+type TakeQuoted<T extends string, Name extends string = ""> = T extends `"${infer Rest}` ? [Name, Rest] : T extends `${infer Char}${infer Rest}` ? TakeQuoted<Rest, `${Name}${Char}`> : [Name, T];
+type ParseName<T extends string> = T extends `"${infer Rest}` ? TakeQuoted<Rest> : TakeIdentifier<T>;
+type ExtractParams<T extends string | TokenData, Depth extends string = ""> = T extends TokenData ? ParamData : T extends string ? T extends `${infer Char}${infer Rest}` ? Char extends ":" | "*" ? ParseName<Rest> extends [
+    infer Name extends string,
+    infer After extends string
+] ? (Depth extends "" ? {
+    [K in Name]: string;
+} : {
+    [K in Name]?: string;
+}) & ExtractParams<After, Depth> : ExtractParams<Rest, Depth> : Char extends "{" ? ExtractParams<Rest, `${Depth}1`> : Char extends "}" ? ExtractParams<Rest, Depth extends `1${infer Rest2}` ? Rest2 : Depth> : ExtractParams<Rest, Depth> : object : never;
+
+declare class EmbedRouter<L> {
+    private static usedIdentifiers;
+    private name;
+    private idPrefix;
+    private identifier;
+    getIdPrefix(): string;
+    private routes;
+    /**
+     *
+     * @param name the name to give the router. ensures buttons stay connected across restarts
+     * @param idPrefix the prefix for RouteButtonBuilder customIds
+     */
+    constructor({ name, idPrefix, }?: {
+        name?: string;
+        idPrefix?: string;
+    });
+    private updateIdentifier;
+    /**
+     * Registers a path with the router
+     *
+     * @param routePath path to match with
+     * @param handler function that generates the message when a path is matched
+     */
+    get<P extends Path = Path>(routePath: P | P[], handler: RouteHandler<L, ExtractParams<P>>): void;
+    /**
+     * Adds a subrouter to the router
+     *
+     * @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;
+    /**
+     * Must be attached to "interactionCreate" event for RouteButtonBuilder to work
+     *
+     * @param interaction interactions from "interactionCreate" (filter for ButtonInteractions)
+     */
+    listener(interaction: ButtonInteraction | AnySelectMenuInteraction, locals?: L): Promise<void>;
+    /**
+     * Connect or update an interaction message to a path
+     *
+     * @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)
+     */
+    dispatch<P extends Path = Path>(interaction: Interaction, path: P, locals?: L, flags?: InteractionReplyOptions["flags"]): Promise<void>;
+    private resolve;
+}
+
+declare class RouteButtonBuilder<L> extends ButtonBuilder {
+    private embedRouter;
+    /**
+     *
+     * @param embedRouter the router you want to route with
+     * @param data the data to construct a component out of
+     */
+    constructor(embedRouter: EmbedRouter<L>, data?: Omit<Partial<APIButtonComponent>, "custom_id" | "url">);
+    /**
+     * Not supported for RouteButtonBuilder
+     *
+     * @remarks
+     * @param
+     */
+    setURL(): this;
+    /**
+     * Not supported for RouteButtonBuilder (use setTo)
+     *
+     * @remarks
+     * @param
+     */
+    setCustomId(): this;
+    /**
+     * 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<P extends Path>(path: P, query?: ConstructorParameters<typeof URLSearchParams>[0]): this;
+}
+
+declare class RouteStringSelectMenuOptionBuilder extends StringSelectMenuOptionBuilder {
+    /**
+     *
+     * @param data the data to construct a component out of
+     */
+    constructor(data?: Omit<SelectMenuComponentOptionData | APISelectMenuOption, "value"> & {
+        to: string;
+    });
+    /**
+     * Not supported for RouteStringSelectMenuOptionBuilder (use setTo)
+     *
+     * @remarks
+     * @param
+     */
+    setValue(): this;
+    /**
+     * 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<P extends Path>(path: P, query?: ConstructorParameters<typeof URLSearchParams>[0]): this;
+}
+
+declare class RouteStringSelectMenuBuilder<L, P extends Path> extends StringSelectMenuBuilder {
+    private embedRouter;
+    /**
+     *
+     * @param embedRouter the router you want to route with
+     * @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 data the data to construct a component out of
+     */
+    constructor(embedRouter: EmbedRouter<L>, path?: P | string, query?: ConstructorParameters<typeof URLSearchParams>[0], data?: Partial<StringSelectMenuComponentData | APIStringSelectComponent>);
+    /**
+     * Not supported for RouteStringSelectMenuBuilder (customId set from embedRouter)
+     *
+     * @remarks
+     * @param
+     */
+    setCustomId(): this;
+    /**
+     * Not supported for RouteStringSelectMenuBuilder (use addTos)
+     *
+     * @remarks
+     * @param
+     */
+    addOptions(): this;
+    /**
+     * Not supported for RouteStringSelectMenuBuilder (use setTos)
+     *
+     * @remarks
+     * @param
+     */
+    setOptions(): this;
+    /**
+     * Adds route select menu options to builder
+     *
+     * @param tos the list of route select menu options
+     */
+    addTos(...tos: RestOrArray<RouteStringSelectMenuOptionBuilder | ConstructorParameters<typeof RouteStringSelectMenuOptionBuilder>[0]>): this;
+    /**
+     * Sets route select menu options to builder
+     *
+     * @param tos the list of route select menu options
+     */
+    setTos(...tos: RestOrArray<RouteStringSelectMenuOptionBuilder | ConstructorParameters<typeof RouteStringSelectMenuOptionBuilder>[0]>): this;
+}
+
+declare class RouteChannelSelectMenuBuilder<L, P extends Path> extends ChannelSelectMenuBuilder {
+    private 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: EmbedRouter<L>, path: P, query?: ConstructorParameters<typeof URLSearchParams>[0], data?: Partial<ChannelSelectMenuComponentData | APIChannelSelectComponent>);
+    /**
+     * Not supported for RouteChannelSelectMenuBuilder (customId set from embedRouter)
+     *
+     * @remarks
+     * @param
+     */
+    setCustomId(): this;
+}
+
+declare class RouteRoleSelectMenuBuilder<L, P extends Path> extends RoleSelectMenuBuilder {
+    private 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: EmbedRouter<L>, path: P, query?: ConstructorParameters<typeof URLSearchParams>[0], data?: Partial<RoleSelectMenuComponentData | APIRoleSelectComponent>);
+    /**
+     * Not supported for RouteRoleSelectMenuBuilder (customId set from embedRouter)
+     *
+     * @remarks
+     * @param
+     */
+    setCustomId(): this;
+}
+
+declare class RouteUserSelectMenuBuilder<L, P extends Path> extends UserSelectMenuBuilder {
+    private 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: EmbedRouter<L>, path: P, query?: ConstructorParameters<typeof URLSearchParams>[0], data?: Partial<UserSelectMenuComponentData | APIUserSelectComponent>);
+    /**
+     * Not supported for RouteUserSelectMenuBuilder (customId set from embedRouter)
+     *
+     * @remarks
+     * @param
+     */
+    setCustomId(): this;
+}
+
+export { type CompiledRoute, EmbedRouter, type ResolvedRoute, RouteButtonBuilder, RouteChannelSelectMenuBuilder, type RouteHandler, type RouteResponse, RouteRoleSelectMenuBuilder, RouteStringSelectMenuBuilder, RouteStringSelectMenuOptionBuilder, RouteUserSelectMenuBuilder, type State };