@minesa-org/mini-interaction 0.4.0 → 0.4.1

package/README.md

@@ -1,34 +1,144 @@
-# Mini Interaction
+# 🌌 Mini Interaction
 
-Discord interactions framework for HTTP/webhook bots with direct Discord API v10 payload compatibility.
+> **Sleek, Modular, and Type-Safe Discord Interactions Framework.**
 
-## Quick start (slash command)
+Mini Interaction is a high-performance framework designed for building Discord HTTP/Webhook-based bots. It provides a modular architecture that separates concerns, making your bot easier to maintain, test, and scale.
+
+---
+
+## ✨ Features
+
+- **🚀 Modular Router**: Easily map commands, components, and modals to handlers.
+- **⚡ Core V10 Engine**: Native support for Discord API v10 payloads.
+- **🛡️ Type Safety**: Full TypeScript support with rich autocompletion.
+- **🧩 Fluent Builders**: Construct complex messages and components with a premium API.
+- **🔐 Integrated OAuth**: Simple handlers for Discord OAuth2 flows.
+- **🗃️ Mini Database**: Lightweight, document-based storage integration.
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @minesa-org/mini-interaction
+```
+
+---
+
+## 🛠️ Quick Start
+
+Mini Interaction uses a modular approach with a dedicated Router and Context.
+
+### 1. Define your Router
 ```ts
-import { LegacyMiniInteractionAdapter } from '@minesa-org/mini-interaction';
+import { InteractionRouter } from '@minesa-org/mini-interaction';
+
+const router = new InteractionRouter();
+
+// Register a slash command
+router.onCommand('ping', async (interaction, ctx) => {
+  return ctx.reply({ content: '🏓 Pong!' });
+});
 
-const adapter = new LegacyMiniInteractionAdapter({ publicKey, applicationId, token });
-adapter.router.onCommand('ping', async (_interaction, ctx) => ctx.reply({ content: 'pong' }));
+// Register a component handler
+router.onComponent('my_button', async (interaction, ctx) => {
+  return ctx.reply({ content: 'Button clicked!', ephemeral: true });
+});
 ```
 
-## Modal example (label + upload + select)
+### 2. Handle Interactions
 ```ts
-import {
-  ModalBuilder,
-  LabelBuilder,
-  TextInputBuilder,
-  FileUploadBuilder,
-  ModalRoleSelectMenuBuilder,
+import { 
+  verifyAndParseInteraction, 
+  InteractionContext, 
+  DiscordRestClient 
 } from '@minesa-org/mini-interaction';
+
+const rest = new DiscordRestClient({ 
+  applicationId: process.env.DISCORD_APP_ID, 
+  token: process.env.DISCORD_TOKEN 
+});
+
+// In your web server (e.g., Next.js, Vercel, Express)
+export async function POST(req) {
+  const body = await req.text();
+  const signature = req.headers.get('x-signature-ed25519');
+  const timestamp = req.headers.get('x-signature-timestamp');
+
+  // Verify and parse the interaction
+  const interaction = await verifyAndParseInteraction({
+    body,
+    signature,
+    timestamp,
+    publicKey: process.env.DISCORD_PUBLIC_KEY
+  });
+
+  if (interaction.type === 1) return Response.json({ type: 1 });
+
+  const ctx = new InteractionContext({ interaction, rest });
+  const response = await router.dispatch(interaction, ctx);
+
+  return Response.json(response ?? ctx.deferReply());
+}
 ```
 
-## Radio example
+---
+
+## 🎨 Message Builders
+
+Mini Interaction provides a rich set of builders to create beautiful Discord content.
+
+```ts
+import { ModalBuilder, TextInputBuilder, TextInputStyle } from '@minesa-org/mini-interaction';
+
+const modal = new ModalBuilder()
+  .setCustomId('feedback_form')
+  .setTitle('Send us Feedback')
+  .addComponents(
+    new TextInputBuilder()
+      .setCustomId('feedback_text')
+      .setLabel('Your Message')
+      .setStyle(TextInputStyle.Paragraph)
+      .setPlaceholder('Tell us what you think...')
+  );
+```
+
+---
+
+## 📡 Advanced Routing
+
+You can organize your handlers into separate modules for better scalability.
+
 ```ts
-import { RadioBuilder } from '@minesa-org/mini-interaction';
+// components/modals.ts
+router.onModal('feedback_submit', async (interaction, ctx) => {
+  const feedback = interaction.getTextFieldValue('feedback_text');
+  // Process feedback...
+  return ctx.reply({ content: 'Thank you for your feedback!' });
+});
+```
+
+---
+
+## 🛡️ Error Handling
+
+Mini Interaction includes built-in validation to ensure your payloads follow Discord's requirements.
 
-const radio = new RadioBuilder()
-  .setCustomId('flavor')
-  .addOptions({ label: 'Vanilla', value: 'v', default: true }, { label: 'Chocolate', value: 'c' });
+```ts
+import { ValidationError } from '@minesa-org/mini-interaction';
+
+try {
+  const builder = new TextInputBuilder().setCustomId(''); // Too short!
+  builder.toJSON();
+} catch (error) {
+  if (error instanceof ValidationError) {
+    console.error(`Validation failed for ${error.component}: ${error.message}`);
+  }
+}
 ```
 
-## Error handling
-Catch `ValidationError` from builders to surface actionable diagnostics.
+---
+
+## 📜 License
+
+MIT © [Minesa](https://github.com/minesa-org)

package/dist/index.d.ts

@@ -1,20 +1,15 @@
-/** Entry point re-exporting MiniInteraction helpers, builders, and shared types. */
-export { MiniInteraction } from "./clients/MiniInteraction.js";
-export type { RoleConnectionMetadataField } from "./clients/MiniInteraction.js";
 export { CommandBuilder, CommandContext, IntegrationType, } from "./commands/CommandBuilder.js";
 export { UserCommandBuilder, MessageCommandBuilder, AppCommandBuilder, } from "./commands/ContextMenuCommandBuilder.js";
 export type { AttachmentOptionBuilder, ChannelOptionBuilder, MentionableOptionBuilder, NumberOptionBuilder, RoleOptionBuilder, StringOptionBuilder, SubcommandBuilder, SubcommandGroupBuilder, UserOptionBuilder, } from "./commands/CommandBuilder.js";
 export { CommandInteractionOptionResolver, createCommandInteraction, } from "./utils/CommandInteractionOptions.js";
 export { CommandInteraction, MentionableOption, ResolvedUserOption, } from "./utils/CommandInteractionOptions.js";
 export { UserContextMenuInteraction, MessageContextMenuInteraction, AppCommandInteraction, } from "./utils/ContextMenuInteraction.js";
-export type { InteractionFetchHandler, InteractionNodeHandler, InteractionHandlerResult, InteractionRequest, InteractionClientOptions, DiscordOAuthAuthorizeContext, DiscordOAuthCallbackOptions, DiscordOAuthCallbackTemplates, DiscordOAuthErrorTemplateContext, DiscordOAuthServerErrorTemplateContext, DiscordOAuthStateTemplateContext, DiscordOAuthSuccessTemplateContext, DiscordOAuthVerificationPageOptions, } from "./clients/MiniInteraction.js";
 export type { InteractionCommand, SlashCommandHandler, UserCommandHandler, MessageCommandHandler, AppCommandHandler, CommandHandler, } from "./types/Commands.js";
-export type { ComponentCommand, ButtonComponentHandler, StringSelectComponentHandler, RoleSelectComponentHandler, UserSelectComponentHandler, ChannelSelectComponentHandler, MentionableSelectComponentHandler, ComponentHandler, ModalCommand, ModalHandler, InteractionHandler, } from "./clients/MiniInteraction.js";
 export { MessageComponentInteraction, ButtonInteraction, StringSelectInteraction, RoleSelectInteraction, UserSelectInteraction, ChannelSelectInteraction, MentionableSelectInteraction, ResolvedUserOption as ComponentResolvedUserOption, ResolvedMentionableOption as ComponentResolvedMentionableOption, } from "./utils/MessageComponentInteraction.js";
 export { ModalSubmitInteraction } from "./utils/ModalSubmitInteraction.js";
 export { RoleConnectionMetadataTypes } from "./types/RoleConnectionMetadataTypes.js";
 export { ChannelType } from "./types/ChannelType.js";
-export { InteractionFollowUpFlags, InteractionReplyFlags, InteractionFlags, } from "./types/InteractionFlags.js";
+export { InteractionFlags, } from "./types/InteractionFlags.js";
 export { ButtonStyle } from "./types/ButtonStyle.js";
 export { SeparatorSpacingSize } from "./types/SeparatorSpacingSize.js";
 export { TextInputStyle } from "discord-api-types/v10";
@@ -35,8 +30,6 @@ export { InteractionContext } from "./core/interactions/InteractionContext.js";
 export type { InteractionContextOptions } from "./core/interactions/InteractionContext.js";
 export { verifyAndParseInteraction } from "./core/interactions/InteractionVerifier.js";
 export { InteractionRouter } from "./router/InteractionRouter.js";
-export { LegacyMiniInteractionAdapter } from "./compat/LegacyMiniInteractionAdapter.js";
-export type { LegacyAdapterOptions } from "./compat/LegacyMiniInteractionAdapter.js";
 export type { APIRadioComponent, APIRadioOption } from "./types/radio.js";
 export { RADIO_COMPONENT_TYPE } from "./types/radio.js";
 export { ValidationError } from "./types/validation.js";

package/dist/index.js

@@ -1,5 +1,3 @@
-/** Entry point re-exporting MiniInteraction helpers, builders, and shared types. */
-export { MiniInteraction } from "./clients/MiniInteraction.js";
 export { CommandBuilder, CommandContext, IntegrationType, } from "./commands/CommandBuilder.js";
 export { UserCommandBuilder, MessageCommandBuilder, AppCommandBuilder, } from "./commands/ContextMenuCommandBuilder.js";
 export { CommandInteractionOptionResolver, createCommandInteraction, } from "./utils/CommandInteractionOptions.js";
@@ -9,7 +7,7 @@ export { MessageComponentInteraction, ButtonInteraction, StringSelectInteraction
 export { ModalSubmitInteraction } from "./utils/ModalSubmitInteraction.js";
 export { RoleConnectionMetadataTypes } from "./types/RoleConnectionMetadataTypes.js";
 export { ChannelType } from "./types/ChannelType.js";
-export { InteractionFollowUpFlags, InteractionReplyFlags, InteractionFlags, } from "./types/InteractionFlags.js";
+export { InteractionFlags, } from "./types/InteractionFlags.js";
 export { ButtonStyle } from "./types/ButtonStyle.js";
 export { SeparatorSpacingSize } from "./types/SeparatorSpacingSize.js";
 export { TextInputStyle } from "discord-api-types/v10";
@@ -25,6 +23,5 @@ export { DiscordRestClient } from "./core/http/DiscordRestClient.js";
 export { InteractionContext } from "./core/interactions/InteractionContext.js";
 export { verifyAndParseInteraction } from "./core/interactions/InteractionVerifier.js";
 export { InteractionRouter } from "./router/InteractionRouter.js";
-export { LegacyMiniInteractionAdapter } from "./compat/LegacyMiniInteractionAdapter.js";
 export { RADIO_COMPONENT_TYPE } from "./types/radio.js";
 export { ValidationError } from "./types/validation.js";

package/dist/types/InteractionFlags.d.ts

@@ -3,7 +3,3 @@ export declare enum InteractionFlags {
     IsComponentsV2 = 32768,
     SuppressEmbeds = 4
 }
-/** @deprecated Use InteractionFlags instead. */
-export { InteractionFlags as InteractionReplyFlags };
-/** @deprecated Use InteractionFlags instead. */
-export { InteractionFlags as InteractionFollowUpFlags };

package/dist/types/InteractionFlags.js

@@ -4,7 +4,3 @@ export var InteractionFlags;
     InteractionFlags[InteractionFlags["IsComponentsV2"] = 32768] = "IsComponentsV2";
     InteractionFlags[InteractionFlags["SuppressEmbeds"] = 4] = "SuppressEmbeds";
 })(InteractionFlags || (InteractionFlags = {}));
-/** @deprecated Use InteractionFlags instead. */
-export { InteractionFlags as InteractionReplyFlags };
-/** @deprecated Use InteractionFlags instead. */
-export { InteractionFlags as InteractionFollowUpFlags };

package/dist/utils/ModalSubmitInteraction.js

@@ -183,9 +183,12 @@ export function createModalSubmitInteraction(interaction, helpers) {
     const getChannel = (customId) => getChannels(customId)[0];
     const getAttachment = (customId) => {
         const value = getComponentValue(customId);
-        if (!value || Array.isArray(value))
+        if (!value)
             return undefined;
-        return interaction.data.resolved?.attachments?.[value];
+        const attachmentId = Array.isArray(value) ? value[0] : value;
+        if (!attachmentId)
+            return undefined;
+        return interaction.data.resolved?.attachments?.[attachmentId];
     };
     return Object.assign(interaction, {
         reply,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minesa-org/mini-interaction",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Mini interaction, connecting your app with Discord via HTTP-interaction (Vercel support).",
   "type": "module",
   "main": "dist/index.js",