elizaos--eliza/plugins/plugin-discord/config.ts

/**
 * Discord plugin configuration types.
 *
 * These types define the configuration schema for the Discord plugin.
 * Shared base types are imported from @elizaos/core.
 */

import type {
	BlockStreamingCoalesceConfig,
	ChannelHeartbeatVisibilityConfig,
	DmConfig,
	DmPolicy,
	GroupPolicy,
	GroupToolPolicyBySenderConfig,
	GroupToolPolicyConfig,
	MarkdownConfig,
	OutboundRetryConfig,
	ProviderCommandsConfig,
	ReplyToMode,
} from "@elizaos/core";

// ============================================================
// PluralKit Configuration
// ============================================================

export type DiscordPluralKitConfig = {
	enabled?: boolean;
	detectProxied?: boolean;
	cacheUsers?: boolean;
};

// ============================================================
// DM Configuration
// ============================================================

export type DiscordDmConfig = {
	/** If false, ignore all incoming Discord DMs. Default: true. */
	enabled?: boolean;
	/** Direct message access policy (default: pairing). */
	policy?: DmPolicy;
	/** Allowlist for DM senders (ids or names). */
	allowFrom?: Array<string | number>;
	/** If true, allow group DMs (default: false). */
	groupEnabled?: boolean;
	/** Optional allowlist for group DM channels (ids or slugs). */
	groupChannels?: Array<string | number>;
};

// ============================================================
// Guild and Channel Configuration
// ============================================================

export type DiscordGuildChannelConfig = {
	allow?: boolean;
	requireMention?: boolean;
	/** Optional tool policy overrides for this channel. */
	tools?: GroupToolPolicyConfig;
	toolsBySender?: GroupToolPolicyBySenderConfig;
	/** If specified, only load these skills for this channel. Omit = all skills; empty = no skills. */
	skills?: string[];
	/** If false, disable the bot for this channel. */
	enabled?: boolean;
	/** Optional allowlist for channel senders (ids or names). */
	users?: Array<string | number>;
	/** Optional system prompt snippet for this channel. */
	systemPrompt?: string;
};

export type DiscordReactionNotificationMode =
	| "off"
	| "own"
	| "all"
	| "allowlist";

export type DiscordGuildEntry = {
	slug?: string;
	requireMention?: boolean;
	/** Optional tool policy overrides for this guild (used when channel override is missing). */
	tools?: GroupToolPolicyConfig;
	toolsBySender?: GroupToolPolicyBySenderConfig;
	/** Reaction notification mode (off|own|all|allowlist). Default: own. */
	reactionNotifications?: DiscordReactionNotificationMode;
	users?: Array<string | number>;
	channels?: Record<string, DiscordGuildChannelConfig>;
};

// ============================================================
// Action Configuration
// ============================================================

export type DiscordActionConfig = {
	reactions?: boolean;
	stickers?: boolean;
	polls?: boolean;
	permissions?: boolean;
	messages?: boolean;
	threads?: boolean;
	pins?: boolean;
	search?: boolean;
	memberInfo?: boolean;
	roleInfo?: boolean;
	roles?: boolean;
	channelInfo?: boolean;
	voiceStatus?: boolean;
	events?: boolean;
	moderation?: boolean;
	emojiUploads?: boolean;
	stickerUploads?: boolean;
	channels?: boolean;
	/** Enable bot presence/activity changes (default: false). */
	presence?: boolean;
};

// ============================================================
// Intents Configuration
// ============================================================

export type DiscordIntentsConfig = {
	/** Enable Guild Presences privileged intent (requires Portal opt-in). Default: false. */
	presence?: boolean;
	/** Enable Guild Members privileged intent (requires Portal opt-in). Default: false. */
	guildMembers?: boolean;
};

// ============================================================
// Exec Approval Configuration
// ============================================================

export type DiscordExecApprovalConfig = {
	/** Enable exec approval forwarding to Discord DMs. Default: false. */
	enabled?: boolean;
	/** Discord user IDs to receive approval prompts. Required if enabled. */
	approvers?: Array<string | number>;
	/** Only forward approvals for these agent IDs. Omit = all agents. */
	agentFilter?: string[];
	/** Only forward approvals matching these session key patterns (substring or regex). */
	sessionFilter?: string[];
};

// ============================================================
// Account Configuration
// ============================================================

export type DiscordAccountConfig = {
	/** Optional display name for this account (used in CLI/UI lists). */
	name?: string;
	/** Optional provider capability tags used for agent/runtime guidance. */
	capabilities?: string[];
	/** Markdown formatting overrides (tables). */
	markdown?: MarkdownConfig;
	/** Override native command registration for Discord (bool or "auto"). */
	commands?: ProviderCommandsConfig;
	/** Allow channel-initiated config writes (default: true). */
	configWrites?: boolean;
	/** If false, do not start this Discord account. Default: true. */
	enabled?: boolean;
	token?: string;
	/** Allow bot-authored messages to trigger replies (default: false). */
	allowBots?: boolean;
	/**
	 * Controls how guild channel messages are handled:
	 * - "open": guild channels bypass allowlists; mention-gating applies
	 * - "disabled": block all guild channel messages
	 * - "allowlist": only allow channels present in discord.guilds.*.channels
	 */
	groupPolicy?: GroupPolicy;
	/** Outbound text chunk size (chars). Default: 2000. */
	textChunkLimit?: number;
	/** Chunking mode: "length" (default) splits by size; "newline" splits on every newline. */
	chunkMode?: "length" | "newline";
	/** Disable block streaming for this account. */
	blockStreaming?: boolean;
	/** Merge streamed block replies before sending. */
	blockStreamingCoalesce?: BlockStreamingCoalesceConfig;
	/**
	 * Soft max line count per Discord message.
	 * Discord clients can clip/collapse very tall messages; splitting by lines
	 * keeps replies readable in-channel. Default: 17.
	 */
	maxLinesPerMessage?: number;
	mediaMaxMb?: number;
	historyLimit?: number;
	/** Max DM turns to keep as history context. */
	dmHistoryLimit?: number;
	/** Per-DM config overrides keyed by user ID. */
	dms?: Record<string, DmConfig>;
	/** Retry policy for outbound Discord API calls. */
	retry?: OutboundRetryConfig;
	/** Per-action tool gating (default: true for all). */
	actions?: DiscordActionConfig;
	/** Control reply threading when reply tags are present (off|first|all). */
	replyToMode?: ReplyToMode;
	dm?: DiscordDmConfig;
	/** New per-guild config keyed by guild id or slug. */
	guilds?: Record<string, DiscordGuildEntry>;
	/** Heartbeat visibility settings for this channel. */
	heartbeat?: ChannelHeartbeatVisibilityConfig;
	/** Exec approval forwarding configuration. */
	execApprovals?: DiscordExecApprovalConfig;
	/** Privileged Gateway Intents (must also be enabled in Discord Developer Portal). */
	intents?: DiscordIntentsConfig;
	/** PluralKit identity resolution for proxied messages. */
	pluralkit?: DiscordPluralKitConfig;
};

// ============================================================
// Main Discord Configuration
// ============================================================

export type DiscordChannelConfig = {
	/** Optional named Discord account configuration records. */
	accounts?: Record<string, DiscordAccountConfig>;
} & DiscordAccountConfig;

// Re-export for backward compatibility
export type { DiscordChannelConfig as DiscordConfig };