chapterjs 0.2.3 → 0.4.0

package/dist/components/router.d.ts

@@ -14,6 +14,11 @@ export declare class ComponentRouter {
     constructor(options: ComponentRouterOptions);
     /** Replaces every component (after a load or a reload). */
     set(entries: Iterable<ComponentEntry>): void;
-    /** Handles an Interaction Create event, if it is a component or a form. */
-    dispatch(ctx: Context, raw: RawInteraction): void;
+    /**
+     * Handles an Interaction Create event, if it is a component or a form.
+     * Returns a promise of everything being done (the function run, the
+     * person answered), or `null` when the interaction is not for this
+     * router. Nothing of the bot waits for it: `chapterjs test` does.
+     */
+    dispatch(ctx: Context, raw: RawInteraction): Promise<void> | null;
 }

package/dist/components/router.js

@@ -33,18 +33,23 @@ export class ComponentRouter {
         }
         this.#components = components;
     }
-    /** Handles an Interaction Create event, if it is a component or a form. */
+    /**
+     * Handles an Interaction Create event, if it is a component or a form.
+     * Returns a promise of everything being done (the function run, the
+     * person answered), or `null` when the interaction is not for this
+     * router. Nothing of the bot waits for it: `chapterjs test` does.
+     */
     dispatch(ctx, raw) {
         const isComponent = raw.type === InteractionType.MessageComponent;
         const isModal = raw.type === InteractionType.ModalSubmit;
         if (!isComponent && !isModal)
-            return;
+            return null;
         const data = raw.data;
         if (!data || typeof data.custom_id !== 'string')
-            return;
+            return null;
         const author = authorOf(raw);
         if (!author)
-            return;
+            return null;
         const user = ctx.entities.user(author.user);
         const { user: _user, member: _member, message: rawMessage, ...rest } = raw;
         const message = rawMessage
@@ -79,7 +84,7 @@ export class ComponentRouter {
                 message: message,
             });
         if (isComponent && !message)
-            return;
+            return null;
         // Embeds are never in the map: what is left has a `run`.
         if (!entry ||
             entry.component.kind === 'embed' ||
@@ -87,27 +92,23 @@ export class ComponentRouter {
                 SELECT_TYPES[entry.component.type] !==
                     data.component_type)) {
             // Sent before the export was renamed, removed or changed of kind.
-            refuse(interaction, 'gone', { what });
-            return;
+            return refuse(interaction, 'gone', { what });
         }
         const { component, file } = entry;
         const values = readData(component.data, parts);
         if (!values) {
             // The data of the component changed since the message was sent.
-            refuse(interaction, 'outdated', { what });
-            return;
+            return refuse(interaction, 'outdated', { what });
         }
         const placed = resolvePlace(ctx, raw, user, author.member, component.where, warning => this.#options.onWarning(file, `${name} ${warning}`));
         if (!placed.place) {
-            refuse(interaction, placed.refusal, { what });
-            return;
+            return refuse(interaction, placed.refusal, { what });
         }
         const { place } = placed;
         if (component.kind !== 'modal' &&
             component.who === 'author' &&
             rawMessage?.interaction_metadata?.user.id !== user.id) {
-            refuse(interaction, 'authorOnly', { what });
-            return;
+            return refuse(interaction, 'authorOnly', { what });
         }
         remember(interaction, {
             guild: place.guild ?? undefined,
@@ -127,8 +128,7 @@ export class ComponentRouter {
         }
         catch (error) {
             this.#options.onError(file, error);
-            refuse(interaction, 'failed', { what });
-            return;
+            return refuse(interaction, 'failed', { what });
         }
         const context = Object.freeze({
             interaction,
@@ -144,7 +144,7 @@ export class ComponentRouter {
                 ephemeral: ephemeralOf(component),
             })),
         });
-        runInteraction({
+        return runInteraction({
             interaction,
             file,
             name,

package/dist/discord/types/channel.d.ts

@@ -251,6 +251,14 @@ export interface RawForumTag {
     /** the unicode character of the emoji * */
     emoji_name: string | null;
 }
+/**
+ * A forum tag as a request gives it: a new tag has no `id` yet, an existing
+ * one keeps its own.
+ * @see https://docs.discord.com/developers/resources/channel#forum-tag-object
+ */
+export type RawForumTagInput = Omit<RawForumTag, 'id'> & {
+    id?: Snowflake;
+};
 /**
  * JSON Params (Group DM)
  * @see https://docs.discord.com/developers/resources/channel#modify-channel-json-params-group-dm
@@ -293,7 +301,7 @@ export interface ModifyGuildChannelJSONParams {
     /** channel flags combined as a bitfield. */
     flags?: number;
     /** the set of tags that can be used in a `GUILD_FORUM` or a `GUILD_MEDIA` channel; limited to 20 */
-    available_tags?: RawForumTag[];
+    available_tags?: RawForumTagInput[];
     /** the emoji to show in the add reaction button on a thread in a `GUILD_FORUM` or a `GUILD_MEDIA` channel */
     default_reaction_emoji?: RawDefaultReaction | null;
     /** the initial `rate_limit_per_user` to set on newly created threads in a channel. this field is copied to the thread at creation time and does not live update. */

package/dist/discord/types/guild.d.ts

@@ -1,9 +1,9 @@
 import type { RawApplication } from './application.js';
-import type { ChannelType, ForumLayoutType, ForumSortOrderType, RawChannel, RawDefaultReaction, RawForumTag, RawPermissionOverwrite, RawThreadMember, VideoQualityMode } from './channel.js';
+import type { ChannelType, ForumLayoutType, ForumSortOrderType, RawChannel, RawDefaultReaction, RawForumTagInput, RawPermissionOverwrite, RawThreadMember, VideoQualityMode } from './channel.js';
 import type { ISO8601Timestamp, ImageData, Locale, Snowflake } from './common.js';
 import type { RawEmoji } from './emoji.js';
 import type { OAuth2Scope } from './oauth2.js';
-import type { RawRole, RawRoleColors } from './permissions.js';
+import type { RawRole, RawRoleColorsInput } from './permissions.js';
 import type { RawSticker } from './sticker.js';
 import type { RawAvatarDecorationData, RawCollectibles, RawUser } from './user.js';
 /**
@@ -605,7 +605,7 @@ export interface CreateGuildChannelJSONParams {
     /** emoji to show in the add reaction button on a thread in a `GUILD_FORUM` or a `GUILD_MEDIA` channel */
     default_reaction_emoji?: RawDefaultReaction | null;
     /** set of tags that can be used in a `GUILD_FORUM` or a `GUILD_MEDIA` channel */
-    available_tags?: RawForumTag[] | null;
+    available_tags?: RawForumTagInput[] | null;
     /** the default sort order type used to order posts in `GUILD_FORUM` and `GUILD_MEDIA` channels */
     default_sort_order?: ForumSortOrderType | null;
     /** the default forum layout view used to display posts in `GUILD_FORUM` channels */
@@ -773,7 +773,7 @@ export interface CreateGuildRoleJSONParams {
     /** **Deprecated** RGB color value */
     color?: number;
     /** the role's colors */
-    colors?: RawRoleColors;
+    colors?: RawRoleColorsInput;
     /** whether the role should be displayed separately in the sidebar */
     hoist?: boolean;
     /** the role's icon image (if the guild has the `ROLE_ICONS` feature) */
@@ -805,7 +805,7 @@ export interface ModifyGuildRoleJSONParams {
     /** **Deprecated** RGB color value */
     color?: number;
     /** the role's colors */
-    colors?: RawRoleColors;
+    colors?: RawRoleColorsInput;
     /** whether the role should be displayed separately in the sidebar */
     hoist?: boolean;
     /** the role's icon image (if the guild has the `ROLE_ICONS` feature) */

package/dist/discord/types/permissions.d.ts

@@ -172,6 +172,12 @@ export interface RawRoleColors {
     /** the tertiary color for the role, this will turn the gradient into a holographic style */
     tertiary_color: number | null;
 }
+/**
+ * The colors of a role as a request gives them: only the primary color is
+ * needed, the two others make a gradient when given.
+ * @see https://docs.discord.com/developers/topics/permissions#role-object-role-colors-object
+ */
+export type RawRoleColorsInput = Pick<RawRoleColors, 'primary_color'> & Partial<Omit<RawRoleColors, 'primary_color'>>;
 /**
  * Role Flags
  * @see https://docs.discord.com/developers/topics/permissions#role-object-role-flags

package/dist/discord/types/poll.d.ts

@@ -27,7 +27,7 @@ export interface RawPollCreateRequest {
     /** The question of the poll. Only `text` is supported. */
     question: RawPollMedia;
     /** Each of the answers available in the poll, up to 10 */
-    answers: RawPollAnswer[];
+    answers: RawPollAnswerInput[];
     /** Number of hours the poll should be open for, up to 32 days. Defaults to 24 */
     duration?: number;
     /** Whether a user can select multiple answers. Defaults to false */
@@ -54,6 +54,12 @@ export interface RawPollMedia {
     /** The emoji of the field */
     emoji?: Partial<RawEmoji>;
 }
+/**
+ * A poll answer as a request gives it: `answer_id` is only sent as part of
+ * responses from Discord's API/Gateway.
+ * @see https://docs.discord.com/developers/resources/poll#poll-answer-object-poll-answer-object-structure
+ */
+export type RawPollAnswerInput = Omit<RawPollAnswer, 'answer_id'>;
 /**
  * Poll Answer Object Structure
  * @see https://docs.discord.com/developers/resources/poll#poll-answer-object-poll-answer-object-structure