chapterjs 0.3.0 → 0.4.0

package/dist/events/registry.js

@@ -16,13 +16,15 @@ const channel = (on) => ({
     on,
     build: (ctx, data) => {
         const found = ctx.cache.channels.get(data.id);
-        return found ? { channel: found } : null;
+        return found ? { channel: found, guild: found.guild } : null;
     },
 });
 const deletedChannel = (on) => ({
     on,
     before: (ctx, data) => ctx.cache.channels.get(data.id) ?? null,
-    build: (_ctx, _data, { before }) => before ? { channel: before } : null,
+    build: (_ctx, _data, { before }) => before
+        ? { channel: before, guild: before.guild }
+        : null,
 });
 /**
  * Discord refused what an event needs before it can be given to its files:
@@ -95,14 +97,19 @@ const placeAndUser = (ctx, data, userId) => {
 };
 /** Who did it: what `prepare` got, or else what the bot knows. */
 const userFrom = (ctx, prepared, id) => prepared ?? ctx.cache.users.get(id) ?? null;
-/** Where something happened in a server or in private, as the bot knows it. */
+/**
+ * Where something happened in a server or in private, as the bot knows
+ * it: `at` goes in the object of the event, `guild` next to it.
+ */
 const placeOf = (ctx, data) => {
     const found = ctx.cache.channels.get(data.channel_id);
     const guildId = data.guild_id ?? found?.guildId ?? null;
     return {
-        channelId: data.channel_id,
-        channel: found?.isTextBased() ? found : null,
-        guildId,
+        at: {
+            channelId: data.channel_id,
+            channel: found?.isTextBased() ? found : null,
+            guildId,
+        },
         guild: guildId ? (ctx.cache.guilds.get(guildId) ?? null) : null,
     };
 };
@@ -114,15 +121,15 @@ const rememberedMember = (guild, userId) => guild?.members.get(userId) ?? null;
  * Whether a file wants something that happened in a server or in private:
  * it listens there, and in a server what it is promised is there.
  */
-const wantedPlace = (context, where, needsMember = false) => {
-    const inGuild = context.guildId !== null;
+const wantedPlace = (about, guild, where, needsMember = false) => {
+    const inGuild = about.guildId !== null;
     if (!listensThere(where, inGuild))
         return false;
     if (!inGuild)
         return true;
-    return (context.guild !== null &&
-        context.channel !== null &&
-        (!needsMember || context.member != null));
+    return (guild !== null &&
+        about.channel !== null &&
+        (!needsMember || about.member != null));
 };
 /**
  * Private messages, bots and webhooks only reach the files that asked for
@@ -152,9 +159,10 @@ const wantedMessage = ({ message }, options) => {
 const message = (on) => ({
     on,
     prepare: channelOf,
-    build: (ctx, data) => ({
-        message: ctx.entities.message(data, data.guild_id),
-    }),
+    build: (ctx, data) => {
+        const message = ctx.entities.message(data, data.guild_id);
+        return { message, guild: message.guild };
+    },
 });
 const member = (on) => ({
     on,
@@ -226,12 +234,15 @@ const cleared = (on) => ({
     on,
     prepare: channelOf,
     build: (ctx, data) => {
-        const place = placeOf(ctx, data);
+        const { at, guild } = placeOf(ctx, data);
         return {
-            emoji: 'emoji' in data ? toCamelCase(data.emoji) : null,
-            messageId: data.message_id,
-            message: rememberedMessage(place.channel, data.message_id),
-            ...place,
+            reactions: {
+                emoji: 'emoji' in data ? toCamelCase(data.emoji) : null,
+                messageId: data.message_id,
+                message: rememberedMessage(at.channel, data.message_id),
+                ...at,
+            },
+            guild,
         };
     },
 });
@@ -239,17 +250,20 @@ const vote = (on) => ({
     on,
     prepare: (ctx, data) => placeAndUser(ctx, data, data.user_id),
     build: (ctx, data, { prepared }) => {
-        const place = placeOf(ctx, data);
+        const { at, guild } = placeOf(ctx, data);
         const user = userFrom(ctx, prepared, data.user_id);
         if (!user)
             return null;
         return {
-            answerId: data.answer_id,
-            user,
-            member: rememberedMember(place.guild, data.user_id),
-            messageId: data.message_id,
-            message: rememberedMessage(place.channel, data.message_id),
-            ...place,
+            vote: {
+                answerId: data.answer_id,
+                user,
+                member: rememberedMember(guild, data.user_id),
+                messageId: data.message_id,
+                message: rememberedMessage(at.channel, data.message_id),
+                ...at,
+            },
+            guild,
         };
     },
 });
@@ -283,7 +297,7 @@ const voice = (pick) => ({
             : guild.members.get(data.user_id);
         if (!picked || !member)
             return null;
-        return { ...picked, member, guild };
+        return { voice: { ...picked, member }, guild };
     },
 });
 const scheduled = (on) => ({
@@ -308,9 +322,11 @@ const interested = (on) => ({
         if (!guild || !user)
             return null;
         return {
-            scheduledEventId: data.guild_scheduled_event_id,
-            user,
-            member: rememberedMember(guild, data.user_id),
+            interest: {
+                scheduledEventId: data.guild_scheduled_event_id,
+                user,
+                member: rememberedMember(guild, data.user_id),
+            },
             guild,
         };
     },
@@ -322,7 +338,7 @@ const interested = (on) => ({
 export const EVENTS = {
     ready: { intents: 0, sources: [] },
     messageCreate: {
-        guildOf: ({ message }) => message.guild,
+        guildOf: ofGuild,
         // Without Message Content, the messages of others come empty.
         intents: ({ where }) => messagesIn(where) | I.MessageContent,
         options: { bots: 'boolean', where: PLACES },
@@ -330,7 +346,7 @@ export const EVENTS = {
         sources: [message('MESSAGE_CREATE')],
     },
     messageUpdate: {
-        guildOf: ({ message }) => message.guild,
+        guildOf: ofGuild,
         intents: ({ where }) => messagesIn(where) | I.MessageContent,
         options: { bots: 'boolean', where: PLACES },
         accepts: wantedMessage,
@@ -340,9 +356,7 @@ export const EVENTS = {
         guildOf: ofGuild,
         intents: ({ where }) => messagesIn(where),
         options: { where: PLACES },
-        accepts: ({ guildId, guild, channel }, options) => listensThere(options.where, guildId !== null) &&
-            // In a server, the server and the channel are promised.
-            (guildId === null || (guild !== null && channel !== null)),
+        accepts: ({ message, guild }, options) => wantedPlace(message, guild, options.where),
         sources: [
             {
                 on: 'MESSAGE_DELETE',
@@ -353,11 +367,13 @@ export const EVENTS = {
                         ? (found.messages.get(data.id) ?? null)
                         : null;
                 },
-                build: (ctx, data, { before }) => ({
-                    messageId: data.id,
-                    ...placeOf(ctx, data),
-                    message: before,
-                }),
+                build: (ctx, data, { before }) => {
+                    const { at, guild } = placeOf(ctx, data);
+                    return {
+                        message: { id: data.id, ...at, before: before },
+                        guild,
+                    };
+                },
             },
             {
                 // Messages deleted together: one occurrence each.
@@ -368,12 +384,11 @@ export const EVENTS = {
                     return data.ids.map(id => found?.isTextBased() ? (found.messages.get(id) ?? null) : null);
                 },
                 build: (ctx, data, { before }) => {
-                    const place = placeOf(ctx, data);
+                    const { at, guild } = placeOf(ctx, data);
                     const messages = before;
-                    return data.ids.map((messageId, index) => ({
-                        messageId,
-                        ...place,
-                        message: messages[index] ?? null,
+                    return data.ids.map((id, index) => ({
+                        message: { id, ...at, before: messages[index] ?? null },
+                        guild,
                     }));
                 },
             },
@@ -392,21 +407,14 @@ export const EVENTS = {
     memberLeave: {
         guildOf: ofGuild,
         intents: I.GuildMembers,
-        // "The member as it was" is a member the bot remembered.
-        remembers: { members: 1000 },
         sources: [
             {
                 on: 'GUILD_MEMBER_REMOVE',
-                before: (ctx, data) => findGuild(ctx, data.guild_id)?.members.get(data.user.id) ?? null,
-                build: (ctx, data, { before }) => {
+                build: (ctx, data) => {
                     const guild = findGuild(ctx, data.guild_id);
                     if (!guild)
                         return null;
-                    return {
-                        user: ctx.entities.user(data.user),
-                        guild,
-                        member: before,
-                    };
+                    return { user: ctx.entities.user(data.user), guild };
                 },
             },
         ],
@@ -437,17 +445,17 @@ export const EVENTS = {
         ],
     },
     channelCreate: {
-        guildOf: ({ channel }) => channel.guild,
+        guildOf: ofGuild,
         intents: I.Guilds,
         sources: [channel('CHANNEL_CREATE'), channel('THREAD_CREATE')],
     },
     channelUpdate: {
-        guildOf: ({ channel }) => channel.guild,
+        guildOf: ofGuild,
         intents: I.Guilds,
         sources: [channel('CHANNEL_UPDATE'), channel('THREAD_UPDATE')],
     },
     channelDelete: {
-        guildOf: ({ channel }) => channel.guild,
+        guildOf: ofGuild,
         intents: I.Guilds,
         sources: [
             deletedChannel('CHANNEL_DELETE'),
@@ -476,7 +484,7 @@ export const EVENTS = {
                     // Every role of a server is known: one that is not never was.
                     if (!guild || !before)
                         return null;
-                    return { roleId: data.role_id, guild, role: before };
+                    return { role: before, guild };
                 },
             },
         ],
@@ -544,7 +552,7 @@ export const EVENTS = {
                         channel: { id: channelId },
                         ...(inviter ? { inviter } : {}),
                     });
-                    return { invite, ...place };
+                    return { invite, guild: place.guild };
                 },
             },
         ],
@@ -558,7 +566,12 @@ export const EVENTS = {
                 prepare: channelOf,
                 build: (ctx, data) => {
                     const place = inviteChannel(ctx, data);
-                    return place ? { code: data.code, ...place } : null;
+                    return place
+                        ? {
+                            invite: { code: data.code, channel: place.channel },
+                            guild: place.guild,
+                        }
+                        : null;
                 },
             },
         ],
@@ -583,15 +596,15 @@ export const EVENTS = {
         guildOf: ofGuild,
         intents: ({ where }) => reactionsIn(where),
         options: { bots: 'boolean', where: PLACES },
-        accepts: (context, options) => wantedPlace(context, options.where, true) &&
-            (options.bots === true || !context.user.bot),
+        accepts: ({ reaction, guild }, options) => wantedPlace(reaction, guild, options.where, true) &&
+            (options.bots === true || !reaction.user.bot),
         sources: [
             {
                 on: 'MESSAGE_REACTION_ADD',
                 // In a server, who reacted comes with the event.
                 prepare: (ctx, data) => placeAndUser(ctx, data, data.member?.user ? null : data.user_id),
                 build: (ctx, data, { prepared }) => {
-                    const place = placeOf(ctx, data);
+                    const { at, guild } = placeOf(ctx, data);
                     const member = data.member && data.guild_id
                         ? ctx.entities.member(data.guild_id, data.member)
                         : null;
@@ -599,14 +612,17 @@ export const EVENTS = {
                     if (!user)
                         return null;
                     return {
-                        emoji: toCamelCase(data.emoji),
-                        user,
-                        member,
-                        burst: data.burst,
-                        messageId: data.message_id,
-                        message: rememberedMessage(place.channel, data.message_id),
-                        messageAuthorId: data.message_author_id ?? null,
-                        ...place,
+                        reaction: {
+                            emoji: toCamelCase(data.emoji),
+                            user,
+                            member,
+                            burst: data.burst,
+                            messageId: data.message_id,
+                            message: rememberedMessage(at.channel, data.message_id),
+                            messageAuthorId: data.message_author_id ?? null,
+                            ...at,
+                        },
+                        guild,
                     };
                 },
             },
@@ -616,25 +632,28 @@ export const EVENTS = {
         guildOf: ofGuild,
         intents: ({ where }) => reactionsIn(where),
         options: { bots: 'boolean', where: PLACES },
-        accepts: (context, options) => wantedPlace(context, options.where) &&
-            (options.bots === true || !context.user.bot),
+        accepts: ({ reaction, guild }, options) => wantedPlace(reaction, guild, options.where) &&
+            (options.bots === true || !reaction.user.bot),
         sources: [
             {
                 on: 'MESSAGE_REACTION_REMOVE',
                 prepare: (ctx, data) => placeAndUser(ctx, data, data.user_id),
                 build: (ctx, data, { prepared }) => {
-                    const place = placeOf(ctx, data);
+                    const { at, guild } = placeOf(ctx, data);
                     const user = userFrom(ctx, prepared, data.user_id);
                     if (!user)
                         return null;
                     return {
-                        emoji: toCamelCase(data.emoji),
-                        user,
-                        member: rememberedMember(place.guild, data.user_id),
-                        burst: data.burst,
-                        messageId: data.message_id,
-                        message: rememberedMessage(place.channel, data.message_id),
-                        ...place,
+                        reaction: {
+                            emoji: toCamelCase(data.emoji),
+                            user,
+                            member: rememberedMember(guild, data.user_id),
+                            burst: data.burst,
+                            messageId: data.message_id,
+                            message: rememberedMessage(at.channel, data.message_id),
+                            ...at,
+                        },
+                        guild,
                     };
                 },
             },
@@ -644,7 +663,7 @@ export const EVENTS = {
         guildOf: ofGuild,
         intents: ({ where }) => reactionsIn(where),
         options: { where: PLACES },
-        accepts: (context, options) => wantedPlace(context, options.where),
+        accepts: ({ reactions, guild }, options) => wantedPlace(reactions, guild, options.where),
         sources: [
             cleared('MESSAGE_REACTION_REMOVE_ALL'),
             cleared('MESSAGE_REACTION_REMOVE_EMOJI'),
@@ -654,14 +673,14 @@ export const EVENTS = {
         guildOf: ofGuild,
         intents: ({ where }) => pollsIn(where),
         options: { where: PLACES },
-        accepts: (context, options) => wantedPlace(context, options.where),
+        accepts: ({ vote, guild }, options) => wantedPlace(vote, guild, options.where),
         sources: [vote('MESSAGE_POLL_VOTE_ADD')],
     },
     pollVoteRemove: {
         guildOf: ofGuild,
         intents: ({ where }) => pollsIn(where),
         options: { where: PLACES },
-        accepts: (context, options) => wantedPlace(context, options.where),
+        accepts: ({ vote, guild }, options) => wantedPlace(vote, guild, options.where),
         sources: [vote('MESSAGE_POLL_VOTE_REMOVE')],
     },
     typingStart: {
@@ -669,7 +688,7 @@ export const EVENTS = {
         intents: ({ where }) => (where === 'dm' ? 0 : I.GuildMessageTyping) |
             (where === 'dm' || where === 'both' ? I.DirectMessageTyping : 0),
         options: { where: PLACES },
-        accepts: (context, options) => wantedPlace(context, options.where, true),
+        accepts: ({ typing, guild }, options) => wantedPlace(typing, guild, options.where, true),
         sources: [
             {
                 on: 'TYPING_START',
@@ -681,11 +700,15 @@ export const EVENTS = {
                     const user = member?.user ?? userFrom(ctx, prepared, data.user_id);
                     if (!user)
                         return null;
+                    const { at, guild } = placeOf(ctx, data);
                     return {
-                        user,
-                        member,
-                        startedAt: new Date(data.timestamp * 1000),
-                        ...placeOf(ctx, data),
+                        typing: {
+                            user,
+                            member,
+                            startedAt: new Date(data.timestamp * 1000),
+                            ...at,
+                        },
+                        guild,
                     };
                 },
             },
@@ -711,7 +734,7 @@ export const EVENTS = {
                         if (!added.member?.user)
                             continue;
                         const member = ctx.entities.member(data.guild_id, added.member);
-                        joined.push({ member, user: member.user, ...place });
+                        joined.push({ thread: place.thread, member, guild: place.guild });
                     }
                     return joined;
                 },
@@ -732,10 +755,10 @@ export const EVENTS = {
                     if (!place)
                         return null;
                     return (data.removed_member_ids ?? []).map(userId => ({
+                        thread: place.thread,
                         userId,
-                        user: ctx.cache.users.get(userId) ?? null,
                         member: rememberedMember(place.guild, userId),
-                        ...place,
+                        guild: place.guild,
                     }));
                 },
             },
@@ -745,14 +768,14 @@ export const EVENTS = {
         guildOf: ofGuild,
         intents: I.GuildVoiceStates,
         sources: [
-            voice((was, now) => !was && now ? { channel: now.channel, voice: stateOf(now) } : null),
+            voice((was, now) => !was && now ? { channel: now.channel, state: stateOf(now) } : null),
         ],
     },
     voiceLeave: {
         guildOf: ofGuild,
         intents: I.GuildVoiceStates,
         sources: [
-            voice((was, now) => was && !now ? { channel: was.channel, voice: stateOf(was) } : null),
+            voice((was, now) => was && !now ? { channel: was.channel, state: stateOf(was) } : null),
         ],
     },
     voiceMove: {
@@ -760,7 +783,7 @@ export const EVENTS = {
         intents: I.GuildVoiceStates,
         sources: [
             voice((was, now) => was && now && was.channel.id !== now.channel.id
-                ? { from: was.channel, to: now.channel, voice: stateOf(now) }
+                ? { from: was.channel, to: now.channel, state: stateOf(now) }
                 : null),
         ],
     },
@@ -774,7 +797,7 @@ export const EVENTS = {
                 JSON.stringify(was.state) !== JSON.stringify(now.state)
                 ? {
                     channel: now.channel,
-                    voice: stateOf(now),
+                    state: stateOf(now),
                     before: stateOf(was),
                 }
                 : null),
@@ -797,10 +820,12 @@ export const EVENTS = {
                         ? ctx.entities.user(raw)
                         : (ctx.cache.users.get(raw.id) ?? null);
                     return {
-                        userId: raw.id,
-                        user,
-                        member: rememberedMember(guild, raw.id),
-                        presence: toCamelCase(presence),
+                        presence: {
+                            ...toCamelCase(presence),
+                            userId: raw.id,
+                            user,
+                            member: rememberedMember(guild, raw.id),
+                        },
                         guild,
                     };
                 },

package/dist/index.d.ts

@@ -18,7 +18,7 @@ export type { ContainerOptions, LinkButtonOptions, MediaOptions, SeparatorOption
 export type { ActionRowComponent, ButtonComponent, ContainerChild, ContainerComponent, FileComponent, GalleryComponent, MessageComponent, ModalComponent, Piece, SectionComponent, SelectComponent, SeparatorComponent, TextComponent, ThumbnailComponent, } from './components/instance.js';
 export { event } from './events/event.js';
 export type { EventConfig, EventDeclaration } from './events/event.js';
-export type { ContextOf, EventWhere, WhereEventOptions, EventContexts, EventName, EventOptions, MessageEventOptions, ReactionEventOptions, } from './events/registry.js';
+export type { ContextOf, EventWhere, WhereEventOptions, EventContexts, EventName, EventOptions, MessageEventOptions, ReactionEventOptions, AddedReaction, ClearedReactions, DeletedInvite, DeletedMessage, PollVote, PresenceChange, ScheduledEventInterest, Typing, UserReaction, VoiceActivity, VoiceChange, VoiceMove, } from './events/registry.js';
 export type { CategoryChannel, Channel, DMChannel, FetchMessagesOptions, ForumChannel, ForumPostOptions, ForumTag, GuildChannel, GuildChannelEditOptions, InviteCreateOptions, PermissionOverwrite, TextBasedChannel, GuildTextBasedChannel, TextChannel, ThreadChannel, ThreadCreateOptions, ThreadEditOptions, ThreadMember, VoiceChannel, } from './structures/channel.js';
 export type { GuildEmoji } from './structures/emoji.js';
 export type { AuditLog, AuditLogEntry, AutoModerationRule, Ban, ChannelCreateOptions, Guild, GuildEditOptions, RoleCreateOptions, ScheduledEvent, Sticker, VoiceState, } from './structures/guild.js';
@@ -30,7 +30,9 @@ export type { CommandsTranslations, FrameworkTexts, LanguageConfig, LanguageDecl
 export { presence } from './presence/presence.js';
 export type { Activity, ActivityKind, PlainActivity, PresenceConfig, PresenceDeclaration, PresenceStatusName, StreamingActivity, } from './presence/presence.js';
 export { store } from './store/store.js';
-export type { ScopedStore, Store, StoreConfig, StoreEntry, StoreKey, StoreScope, StoreSetOptions, } from './store/store.js';
+export type { ScopedStore, Store, StoreConfig, StoreEntry, StoreKey, StoreScope, StoreSetOptions, StoreStorage, } from './store/store.js';
+export { ranking } from './ranking/ranking.js';
+export type { Ranking, RankingConfig, RankingEntry, RankingOrder, ScopedRanking, } from './ranking/ranking.js';
 export { task } from './tasks/task.js';
 export type { CronTaskConfig, EveryTaskConfig, TaskConfig, TaskContext, TaskDeclaration, } from './tasks/task.js';
 export type { AssetFile, AssetOptions } from './assets/asset.js';

package/dist/index.js

@@ -22,6 +22,7 @@ export { event } from './events/event.js';
 export { language } from './messages/messages.js';
 export { presence } from './presence/presence.js';
 export { store } from './store/store.js';
+export { ranking } from './ranking/ranking.js';
 export { task } from './tasks/task.js';
 // Errors handlers can catch.
 export { DiscordApiError, DiscordUnavailableError, InvalidTokenError, } from './rest/errors.js';

package/dist/ranking/declaration.d.ts

@@ -0,0 +1,12 @@
+import type { Declaration } from '../loader/loader.js';
+import { type StoreStorage } from '../store/backend.js';
+import type { StoreScope } from '../store/store.js';
+import { type RankingOrder } from './ranking.js';
+/** A ranking, checked: what the project keeps of it. */
+export interface LoadedRanking {
+    readonly name: string;
+    readonly scope: StoreScope;
+    readonly storage: StoreStorage;
+    readonly order: RankingOrder;
+}
+export declare const rankingDeclaration: Declaration<LoadedRanking>;

package/dist/ranking/declaration.js

@@ -0,0 +1,48 @@
+// What a file declares with `ranking()`, checked when it loads, so a wrong
+// scope, storage or order is explained before any score is kept; the
+// ranking is then bound to the name of its export.
+import { STORAGES } from '../store/backend.js';
+import { bindRanking, isRankingDeclaration, rankingStateOf, } from './ranking.js';
+const fail = (message) => {
+    throw new TypeError(message);
+};
+const isRecord = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+const KEYS = ['scope', 'storage', 'order'];
+const SCOPES = ['guild', 'global'];
+const ORDERS = ['highest', 'lowest'];
+/** A name can name a file in `data/`, like a store's. */
+const NAME = /^[\w.-]+$/;
+export const rankingDeclaration = {
+    one: 'ranking',
+    many: 'rankings',
+    is: isRankingDeclaration,
+    list: false,
+    read(value, { name }) {
+        const config = rankingStateOf(value)?.config;
+        if (!isRecord(config)) {
+            return fail("ranking() takes an object, or nothing: ranking({ order: 'lowest' }).");
+        }
+        for (const key of Object.keys(config)) {
+            if (!KEYS.includes(key)) {
+                fail(`"${key}" is not something a ranking has. It can have: ${KEYS.join(', ')}.`);
+            }
+        }
+        if (!NAME.test(name)) {
+            fail(`"${name}" can't name a ranking: the name of the export is the name of the ranking and of its file in data/, made of letters, digits, _ . and -.`);
+        }
+        const scope = (config.scope ?? 'guild');
+        if (!SCOPES.includes(scope)) {
+            fail(`"scope" is 'guild' (a ranking per server, the default) or 'global' (one ranking for the whole bot), got ${JSON.stringify(config.scope)}.`);
+        }
+        const storage = (config.storage ?? 'file');
+        if (!STORAGES.includes(storage)) {
+            fail(`"storage" is 'file' (a file in data/, the default) or 'redis' (the Redis of REDIS_URL in .env), got ${JSON.stringify(config.storage)}.`);
+        }
+        const order = (config.order ?? 'highest');
+        if (!ORDERS.includes(order)) {
+            fail(`"order" is 'highest' (the highest score first, the default) or 'lowest' (the lowest first), got ${JSON.stringify(config.order)}.`);
+        }
+        bindRanking(value, { name, scope, storage, order });
+        return Object.freeze({ name, scope, storage, order });
+    },
+};