seyfert 5.2.2-dev-40488860512.0 → 5.2.2-dev-40764380528.0

package/README.md

@@ -1,63 +1,32 @@
-<div align='center'>
-  <img src="./assets/icon.png" alt="seyfert" width="200px" />
+<div align="center">
+  <img src="./assets/icon.png" alt="Seyfert" width="200" />
 
-**Seyfert is a brand-new Discord framework to take the bot development to a next level**
+# Seyfert
 
-[![License](https://img.shields.io/npm/l/seyfert?style=flat-square&logo=apache&color=white)](https://github.com/tiramisulabs/seyfert/blob/main/LICENSE)
+A TypeScript framework for building Discord bots.
+
+[![License](https://img.shields.io/npm/l/seyfert?style=flat-square&color=white)](./LICENSE)
 [![Version](https://img.shields.io/npm/v/seyfert?color=%23ff0000&logo=npm&style=flat-square)](https://www.npmjs.com/package/seyfert)
 [![Discord](https://img.shields.io/discord/1003825077969764412?color=%23406da2&label=support&logo=discord&style=flat-square)](https://discord.com/invite/XNw2RZFzaP)
 
 </div>
 
-## FAQ
-
-### So, what is `seyfert`?
-
-Seyfert is the ultimate Discord framework! We make it easy to interact with the Discord API, big cache control, scalable code and a pretty dev experience.
-
-### Why should I use it?
-
-There are many reasons to use Seyfert, but they dont all fit in this tiny readme, so here is a list of the most awesome reasons!
-- **Low RAM Usage**
-- **Latest features**
-- **Dev experience**
-- **24/6 support (Sunday is for church)**
-- **Written from Scratch**
-- **Type-safe**
-- **And many more!!**
-
-
-## Installation
-
-> [!NOTE]
-> Supported runtimes: Node.js and Bun.
-> Node v18>= (or v16 with `--experimental-fetch` flag) is required.
-> Bun/Node LTS recommended.
-
-```sh
-pnpm add seyfert
-```
-
-```sh
-bun add seyfert
-```
+Seyfert brings Discord's API and gateway together with typed commands, interaction handlers, and plugins. Written in TypeScript for Node.js and Bun, it provides the tools to organize a bot while keeping the underlying Discord types and REST routes accessible.
 
-```sh
-npm i seyfert
-```
-> Or other package manager.
+## What it offers
 
-## Contributing
+- **Typed commands:** Application and prefix commands with option inference, choices, subcommands, and autocomplete. Contexts give handlers access to resolved options and the appropriate response methods.
+- **Middleware and localization:** Share checks and preparation across commands, pass metadata to handlers, and translate command definitions and responses.
+- **Interactions and builders:** Handle components and modals through dedicated contexts. Build responses with embeds, buttons, select menus, and layout components.
+- **Discord resources:** Work with transformed structures and resource methods, or use the REST client directly when you need access to a route.
+- **Gateway and cache:** Handle gateway and custom events, distribute connections across shards and workers, and choose which resources to cache with configurable adapters.
+- **Plugins:** Package reusable commands, events, middleware, and client extensions with lifecycle hooks for setup and cleanup.
 
-We are open to contributions, fork the repo and make your changes!
+## Documentation and community
 
-## Useful links
+Explore the [documentation](https://seyfert.dev/guide) for guides and API usage, or join the [Discord server](https://discord.com/invite/XNw2RZFzaP) for questions and community support.
 
-- [GitHub Repository](https://github.com/tiramisulabs/seyfert)
-- [Discord server](https://discord.com/invite/XNw2RZFzaP)
-- [npm - core](https://www.npmjs.com/package/seyfert)
-- [Website](https://seyfert.dev)
-- [Documentation](https://seyfert.dev/guide)
+Contributions are welcome.
 
 <a href="https://www.star-history.com/?repos=tiramisulabs%2Fseyfert&type=date&legend=top-left">
  <picture>

package/lib/cache/index.d.ts

@@ -42,7 +42,7 @@ type BulkGetResult<K extends BulkGetKey[0] = BulkGetKey[0]> = Partial<{
     [P in K]: ReturnManagers[P][];
 }>;
 export * from './adapters/index';
-export type CachedEvents = 'READY' | 'GUILD_CREATE' | 'GUILD_UPDATE' | 'GUILD_DELETE' | 'CHANNEL_CREATE' | 'CHANNEL_UPDATE' | 'CHANNEL_DELETE' | 'GUILD_ROLE_CREATE' | 'GUILD_ROLE_UPDATE' | 'GUILD_ROLE_DELETE' | 'GUILD_BAN_ADD' | 'GUILD_BAN_REMOVE' | 'GUILD_EMOJIS_UPDATE' | 'GUILD_STICKERS_UPDATE' | 'GUILD_MEMBER_ADD' | 'GUILD_MEMBER_UPDATE' | 'GUILD_MEMBER_REMOVE' | 'MESSAGE_CREATE' | 'PRESENCE_UPDATE' | 'THREAD_DELETE' | 'THREAD_CREATE' | 'THREAD_UPDATE' | 'USER_UPDATE' | 'VOICE_CHANNEL_STATUS_UPDATE' | 'VOICE_STATE_UPDATE' | 'STAGE_INSTANCE_CREATE' | 'STAGE_INSTANCE_UPDATE' | 'STAGE_INSTANCE_DELETE' | 'GUILD_MEMBERS_CHUNK';
+export type CachedEvents = 'READY' | 'GUILD_CREATE' | 'GUILD_UPDATE' | 'GUILD_DELETE' | 'CHANNEL_CREATE' | 'CHANNEL_UPDATE' | 'CHANNEL_DELETE' | 'GUILD_ROLE_CREATE' | 'GUILD_ROLE_UPDATE' | 'GUILD_ROLE_DELETE' | 'GUILD_BAN_ADD' | 'GUILD_BAN_REMOVE' | 'GUILD_EMOJIS_UPDATE' | 'GUILD_STICKERS_UPDATE' | 'GUILD_MEMBER_ADD' | 'GUILD_MEMBER_UPDATE' | 'GUILD_MEMBER_REMOVE' | 'INTERACTION_CREATE' | 'MESSAGE_CREATE' | 'MESSAGE_UPDATE' | 'MESSAGE_REACTION_ADD' | 'TYPING_START' | 'PRESENCE_UPDATE' | 'THREAD_DELETE' | 'THREAD_CREATE' | 'THREAD_UPDATE' | 'USER_UPDATE' | 'VOICE_CHANNEL_STATUS_UPDATE' | 'VOICE_STATE_UPDATE' | 'STAGE_INSTANCE_CREATE' | 'STAGE_INSTANCE_UPDATE' | 'STAGE_INSTANCE_DELETE' | 'GUILD_MEMBERS_CHUNK';
 export type DisabledCache = {
     [P in NonGuildBased | GuildBased | GuildRelated | SeyfertBased]?: boolean;
 };
@@ -85,6 +85,8 @@ export declare class Cache {
     bulkSet(keys: BulkWriteKey[]): Promise<void>;
     onPacket(event: GatewayDispatchPayload): Promise<void>;
     private onPacketWithPluginResources;
+    private appendUserAndMember;
+    private appendMessageUsers;
     protected onPacketDefault(event: GatewayDispatchPayload): Promise<void>;
     /**
      * Destructively validates the adapter by flushing its complete storage before, during, and after the run.

package/lib/cache/index.js

@@ -264,6 +264,25 @@ class Cache {
             }
         }
     }
+    appendUserAndMember(data, user, member, guildId) {
+        if (!user?.id)
+            return;
+        if (this.users)
+            data.push([CacheFrom.Gateway, 'users', user, user.id]);
+        if (this.members && member && guildId) {
+            // Interaction permissions include channel overwrites and must stay local to the interaction.
+            const { permissions: _permissions, ...guildMember } = member;
+            guildMember.user = user;
+            data.push([CacheFrom.Gateway, 'members', guildMember, user.id, guildId]);
+        }
+    }
+    appendMessageUsers(data, message, guildId) {
+        for (const mention of message.mentions ?? []) {
+            const { member, ...user } = mention;
+            this.appendUserAndMember(data, user, member, guildId);
+        }
+        this.appendUserAndMember(data, message.author, message.member, guildId);
+    }
     async onPacketDefault(event) {
         switch (event.t) {
             case 'READY':
@@ -350,6 +369,34 @@ class Cache {
                 await this.members?.remove(event.d.user.id, event.d.guild_id);
                 await this.presences?.remove(event.d.user.id, event.d.guild_id);
                 break;
+            case 'INTERACTION_CREATE':
+                {
+                    const data = [];
+                    const resolved = event.d.data && 'resolved' in event.d.data ? event.d.data.resolved : undefined;
+                    if (resolved && 'messages' in resolved) {
+                        for (const message of Object.values(resolved.messages)) {
+                            this.appendMessageUsers(data, message, event.d.guild_id);
+                        }
+                    }
+                    if (resolved && 'users' in resolved) {
+                        for (const [id, user] of Object.entries(resolved.users ?? {})) {
+                            this.appendUserAndMember(data, user, resolved.members?.[id], event.d.guild_id);
+                        }
+                    }
+                    this.appendUserAndMember(data, event.d.member?.user ?? event.d.user, event.d.member, event.d.guild_id);
+                    if (data.length)
+                        await this.bulkPatch(data);
+                }
+                break;
+            case 'MESSAGE_REACTION_ADD':
+            case 'TYPING_START':
+                {
+                    const data = [];
+                    this.appendUserAndMember(data, event.d.member?.user, event.d.member, event.d.guild_id);
+                    if (data.length)
+                        await this.bulkPatch(data);
+                }
+                break;
             case 'PRESENCE_UPDATE':
                 // Should update member data?
                 await this.presences?.set(CacheFrom.Gateway, event.d.user.id, event.d.guild_id, event.d);
@@ -371,6 +418,10 @@ class Cache {
                 break;
             case 'VOICE_STATE_UPDATE':
                 {
+                    const data = [];
+                    this.appendUserAndMember(data, event.d.member?.user, event.d.member, event.d.guild_id);
+                    if (data.length)
+                        await this.bulkPatch(data);
                     if (!event.d.guild_id) {
                         return;
                     }
@@ -395,33 +446,15 @@ class Cache {
                 await this.stageInstances?.remove(event.d.channel_id, event.d.guild_id);
                 break;
             case 'MESSAGE_CREATE':
-                {
-                    if (this.messages !== undefined) {
-                        const data = [
-                            [CacheFrom.Gateway, 'messages', event.d, event.d.id, event.d.channel_id],
-                            [CacheFrom.Gateway, 'users', event.d.author, event.d.author.id],
-                        ];
-                        if (event.d.guild_id) {
-                            if (event.d.member)
-                                data.push([CacheFrom.Gateway, 'members', event.d.member, event.d.author.id, event.d.guild_id]);
-                        }
-                        await this.bulkPatch(data);
-                    }
-                }
-                break;
             case 'MESSAGE_UPDATE':
                 {
-                    if (this.messages !== undefined) {
-                        const data = [
-                            [CacheFrom.Gateway, 'messages', event.d, event.d.id, event.d.channel_id],
-                            [CacheFrom.Gateway, 'users', event.d.author, event.d.author.id],
-                        ];
-                        if (event.d.guild_id) {
-                            if (event.d.member)
-                                data.push([CacheFrom.Gateway, 'members', event.d.member, event.d.author.id, event.d.guild_id]);
-                        }
-                        await this.bulkPatch(data);
+                    const data = [];
+                    if (this.messages) {
+                        data.push([CacheFrom.Gateway, 'messages', event.d, event.d.id, event.d.channel_id]);
                     }
+                    this.appendMessageUsers(data, event.d, event.d.guild_id);
+                    if (data.length)
+                        await this.bulkPatch(data);
                 }
                 break;
             case 'MESSAGE_DELETE':

package/lib/common/it/formatter.d.ts

@@ -162,6 +162,12 @@ export declare const Formatter: {
      * @returns The formatted content.
      */
     quote(content: string): `> ${string}`;
+    /**
+     * Formats content into subtext.
+     * @param content The content to format.
+     * @returns The formatted content.
+     */
+    subtext(content: string): `-# ${string}`;
     /**
      * Formats a message link.
      * @param guildId The ID of the guild.
@@ -209,6 +215,13 @@ export declare const Formatter: {
      * @returns The formatted channel mention.
      */
     channelMention(channelId: string): `<#${string}>`;
+    /**
+     * Formats a slash command mention.
+     * @param name The name of the command, including subcommands (e.g. `config set`).
+     * @param commandId The ID of the command.
+     * @returns The formatted command mention.
+     */
+    commandMention(name: string, commandId: string): `</${string}:${string}>`;
     /**
      * Formats an emoji.
      * @param emojiId The ID of the emoji.
@@ -223,6 +236,12 @@ export declare const Formatter: {
      * @returns The formatted channel link.
      */
     channelLink(channelId: string, guildId?: string): ChannelLink;
+    /**
+     * Formats a guild navigation mention.
+     * @param type The guild page to link to.
+     * @returns The formatted guild navigation mention.
+     */
+    guildNavigation(type: 'customize' | 'browse' | 'guide' | 'linked-roles'): `<id:${string}>`;
     /**
      * Forms a oauth2 invite link for the bot.
      * @param applicationId The ID of the application.

package/lib/common/it/formatter.js

@@ -157,6 +157,14 @@ exports.Formatter = {
     quote(content) {
         return `> ${content}`;
     },
+    /**
+     * Formats content into subtext.
+     * @param content The content to format.
+     * @returns The formatted content.
+     */
+    subtext(content) {
+        return `-# ${content}`;
+    },
     /**
      * Formats a message link.
      * @param guildId The ID of the guild.
@@ -223,6 +231,15 @@ exports.Formatter = {
     channelMention(channelId) {
         return `<#${channelId}>`;
     },
+    /**
+     * Formats a slash command mention.
+     * @param name The name of the command, including subcommands (e.g. `config set`).
+     * @param commandId The ID of the command.
+     * @returns The formatted command mention.
+     */
+    commandMention(name, commandId) {
+        return `</${name}:${commandId}>`;
+    },
     /**
      * Formats an emoji.
      * @param emojiId The ID of the emoji.
@@ -241,6 +258,14 @@ exports.Formatter = {
     channelLink(channelId, guildId) {
         return `https://discord.com/channels/${guildId ?? '@me'}/${channelId}`;
     },
+    /**
+     * Formats a guild navigation mention.
+     * @param type The guild page to link to.
+     * @returns The formatted guild navigation mention.
+     */
+    guildNavigation(type) {
+        return `<id:${type}>`;
+    },
     /**
      * Forms a oauth2 invite link for the bot.
      * @param applicationId The ID of the application.

package/lib/common/it/utils.js

@@ -327,7 +327,7 @@ function resolvePartialEmoji(emoji) {
             };
         }
         if (emoji.includes('%')) {
-            emoji = encodeURIComponent(emoji);
+            emoji = decodeURIComponent(emoji);
         }
         if (!(emoji.includes(':') || emoji.match(/\d{17,20}/g))) {
             return { name: emoji, id: null };

package/lib/components/handler.js

@@ -26,6 +26,7 @@ class ComponentHandler extends common_1.BaseHandler {
         return str => (0, customId_1.matchesCustomId)(match, str);
     }
     createComponentCollector(messageId, channelId, guildId, options = {}, components = []) {
+        this.clearValue(messageId);
         this.values.set(messageId, {
             messageId,
             channelId,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "seyfert",
-	"version": "5.2.2-dev-40488860512.0",
+	"version": "5.2.2-dev-40764380528.0",
 	"description": "The most advanced framework for discord bots",
 	"packageManager": "pnpm@11.11.0",
 	"workspaces": [