@agentforge-ai/channels-discord 0.6.0

package/LICENSE

@@ -0,0 +1,197 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)
+
+      Copyright [yyyy] [name of copyright owner]
+
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.

package/dist/index.d.ts

@@ -0,0 +1,236 @@
+import { ChannelAdapter, ChannelConfig, OutboundMessage, SendResult, ChannelCapabilities, HealthStatus } from '@agentforge-ai/core';
+
+/**
+ * Discord Channel Adapter for AgentForge.
+ *
+ * Implements the ChannelAdapter interface for the Discord Bot API using discord.js v14.
+ *
+ * Features:
+ * - Text messages in guild channels and DMs
+ * - Thread support (forum and text threads)
+ * - Reactions, message editing and deletion
+ * - Typing indicators
+ * - Slash command registration and handling
+ * - Embeds via platformOptions.embeds
+ * - Guild @mention detection
+ * - Rate limiting
+ * - Max 25MB file uploads, 2000 char text limit
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * Discord Bot channel adapter.
+ *
+ * @example
+ * ```typescript
+ * import { ChannelRegistry } from '@agentforge-ai/core';
+ * import { DiscordAdapter } from '@agentforge-ai/channels-discord';
+ *
+ * const registry = new ChannelRegistry();
+ * registry.registerFactory('discord', () => new DiscordAdapter());
+ *
+ * const adapter = await registry.createAdapter({
+ *   id: 'my-discord-bot',
+ *   platform: 'discord',
+ *   orgId: 'org-1',
+ *   agentId: 'agent-1',
+ *   enabled: true,
+ *   credentials: { botToken: 'BOT_TOKEN', clientId: 'CLIENT_ID' },
+ *   settings: {
+ *     mentionOnly: false,
+ *     respondToDMs: true,
+ *   },
+ * });
+ * ```
+ */
+declare class DiscordAdapter extends ChannelAdapter {
+    readonly platform = "discord";
+    private client;
+    private adapterConfig;
+    private botUserId;
+    private messageTimestamps;
+    private rateLimitPerSecond;
+    connect(config: ChannelConfig): Promise<void>;
+    disconnect(): Promise<void>;
+    sendMessage(message: OutboundMessage): Promise<SendResult>;
+    getCapabilities(): ChannelCapabilities;
+    healthCheck(): Promise<{
+        status: HealthStatus;
+        details?: string;
+    }>;
+    editMessage(platformMessageId: string, message: Partial<OutboundMessage>): Promise<SendResult>;
+    deleteMessage(platformMessageId: string, chatId: string): Promise<boolean>;
+    sendTypingIndicator(chatId: string): Promise<void>;
+    addReaction(platformMessageId: string, chatId: string, emoji: string): Promise<boolean>;
+    private registerClientEvents;
+    private handleDiscordMessage;
+    private handleSlashCommand;
+    private normalizeDiscordMessage;
+    private normalizeSlashCommand;
+    private extractMedia;
+    private mapMimeTypeToMediaType;
+    private mapChannelType;
+    private buildMessagePayload;
+    private isBotMentioned;
+    private resolveChannel;
+    private registerSlashCommands;
+    private waitForReady;
+    private enforceRateLimit;
+    private sleep;
+}
+
+/**
+ * Discord-specific types for the AgentForge Discord channel adapter.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Configuration for the DiscordAdapter.
+ * Passed via ChannelConfig.credentials and ChannelConfig.settings.
+ */
+interface DiscordAdapterConfig {
+    /** Discord bot token */
+    botToken: string;
+    /** Application/client ID (required for slash command registration) */
+    clientId?: string;
+    /** Guild (server) ID for guild-scoped slash command registration. If omitted, registers globally. */
+    guildId?: string;
+    /** Whether to register slash commands on connect. Default: true */
+    registerCommands?: boolean;
+    /** Whether to respond only to @mentions in guild channels. Default: false */
+    mentionOnly?: boolean;
+    /** Whether to respond to DMs. Default: true */
+    respondToDMs?: boolean;
+    /** Rate limit: max messages per second. Default: 5 */
+    rateLimitPerSecond?: number;
+}
+/**
+ * Configuration for the DiscordChannel runner (Convex integration).
+ */
+interface DiscordChannelConfig {
+    /** Discord bot token from Developer Portal */
+    botToken: string;
+    /** Application/client ID */
+    clientId?: string;
+    /** Guild ID for guild-scoped commands */
+    guildId?: string;
+    /** Agent ID to route messages to */
+    agentId: string;
+    /** Convex deployment URL */
+    convexUrl: string;
+    /** Whether to respond only to @mentions in guild channels. Default: false */
+    mentionOnly?: boolean;
+    /** Whether to respond to DMs. Default: true */
+    respondToDMs?: boolean;
+    /** User ID for Convex operations (default: 'discord') */
+    userId?: string;
+    /** Log level. Default: 'info' */
+    logLevel?: 'debug' | 'info' | 'warn' | 'error';
+}
+
+/**
+ * Discord Channel for AgentForge.
+ *
+ * Bridges the DiscordAdapter with the AgentForge Convex chat pipeline.
+ * This module:
+ * - Starts the Discord bot
+ * - Routes incoming messages through the agent execution pipeline
+ * - Creates/reuses Convex threads per Discord channel
+ * - Stores all messages in the Convex messages table
+ * - Sends agent responses back to the Discord user
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * Runs a Discord bot that routes messages through the AgentForge
+ * Convex chat pipeline.
+ *
+ * @example
+ * ```typescript
+ * import { DiscordChannel } from '@agentforge-ai/channels-discord';
+ *
+ * const channel = new DiscordChannel({
+ *   botToken: process.env.DISCORD_BOT_TOKEN!,
+ *   clientId: process.env.DISCORD_CLIENT_ID!,
+ *   agentId: 'my-agent',
+ *   convexUrl: process.env.CONVEX_URL!,
+ * });
+ *
+ * await channel.start();
+ * ```
+ */
+declare class DiscordChannel {
+    private adapter;
+    private convex;
+    private config;
+    private threadMap;
+    private logger;
+    private processingMessages;
+    private isRunning;
+    constructor(config: DiscordChannelConfig);
+    /**
+     * Start the Discord channel bot.
+     * Connects to Discord and begins listening for messages.
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the Discord channel bot.
+     */
+    stop(): Promise<void>;
+    /**
+     * Get the current thread map (for debugging).
+     */
+    getThreadMap(): ReadonlyMap<string, string>;
+    /**
+     * Get the underlying DiscordAdapter instance.
+     */
+    getAdapter(): DiscordAdapter;
+    /**
+     * Check if the channel is running.
+     */
+    get running(): boolean;
+    private handleEvent;
+    private handleInboundMessage;
+    /**
+     * Route a message through the AgentForge chat pipeline:
+     * 1. Get or create a Convex thread for this Discord channel
+     * 2. Call chat.sendMessage action
+     * 3. Send the agent response back to Discord
+     */
+    private routeToAgent;
+    /**
+     * Get or create a Convex thread for a Discord channel.
+     * Threads are cached in memory and created lazily.
+     */
+    private getOrCreateThread;
+    private handleStartCommand;
+    private handleHelpCommand;
+    /**
+     * Split a long message into chunks that fit Discord's 2000 char limit.
+     */
+    private splitMessage;
+}
+/**
+ * Create and start a Discord channel from environment variables.
+ *
+ * Required env vars:
+ * - DISCORD_BOT_TOKEN
+ * - CONVEX_URL
+ *
+ * Optional env vars:
+ * - DISCORD_CLIENT_ID
+ * - DISCORD_GUILD_ID
+ * - AGENTFORGE_AGENT_ID
+ *
+ * @example
+ * ```typescript
+ * import { startDiscordChannel } from '@agentforge-ai/channels-discord';
+ *
+ * await startDiscordChannel({ agentId: 'my-agent' });
+ * ```
+ */
+declare function startDiscordChannel(overrides?: Partial<DiscordChannelConfig>): Promise<DiscordChannel>;
+
+export { DiscordAdapter, type DiscordAdapterConfig, DiscordChannel, type DiscordChannelConfig, startDiscordChannel };