132 lines
4.7 KiB
TypeScript
132 lines
4.7 KiB
TypeScript
import type {
|
|
BlockStreamingCoalesceConfig,
|
|
DmPolicy,
|
|
GroupPolicy,
|
|
ReplyToMode,
|
|
} from "./types.base.js";
|
|
import type { DmConfig, ProviderCommandsConfig } from "./types.messages.js";
|
|
|
|
export type SlackDmConfig = {
|
|
/** If false, ignore all incoming Slack DMs. Default: true. */
|
|
enabled?: boolean;
|
|
/** Direct message access policy (default: pairing). */
|
|
policy?: DmPolicy;
|
|
/** Allowlist for DM senders (ids). */
|
|
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>;
|
|
};
|
|
|
|
export type SlackChannelConfig = {
|
|
/** If false, disable the bot in this channel. (Alias for allow: false.) */
|
|
enabled?: boolean;
|
|
/** Legacy channel allow toggle; prefer enabled. */
|
|
allow?: boolean;
|
|
/** Require mentioning the bot to trigger replies. */
|
|
requireMention?: boolean;
|
|
/** Allow bot-authored messages to trigger replies (default: false). */
|
|
allowBots?: boolean;
|
|
/** Allowlist of users that can invoke the bot in this channel. */
|
|
users?: Array<string | number>;
|
|
/** Optional skill filter for this channel. */
|
|
skills?: string[];
|
|
/** Optional system prompt for this channel. */
|
|
systemPrompt?: string;
|
|
};
|
|
|
|
export type SlackReactionNotificationMode = "off" | "own" | "all" | "allowlist";
|
|
|
|
export type SlackActionConfig = {
|
|
reactions?: boolean;
|
|
messages?: boolean;
|
|
pins?: boolean;
|
|
search?: boolean;
|
|
permissions?: boolean;
|
|
memberInfo?: boolean;
|
|
channelInfo?: boolean;
|
|
emojiList?: boolean;
|
|
};
|
|
|
|
export type SlackSlashCommandConfig = {
|
|
/** Enable handling for the configured slash command (default: false). */
|
|
enabled?: boolean;
|
|
/** Slash command name (default: "clawd"). */
|
|
name?: string;
|
|
/** Session key prefix for slash commands (default: "slack:slash"). */
|
|
sessionPrefix?: string;
|
|
/** Reply ephemerally (default: true). */
|
|
ephemeral?: boolean;
|
|
};
|
|
|
|
export type SlackThreadConfig = {
|
|
/** Scope for thread history context (thread|channel). Default: thread. */
|
|
historyScope?: "thread" | "channel";
|
|
/** If true, thread sessions inherit the parent channel transcript. Default: false. */
|
|
inheritParent?: boolean;
|
|
};
|
|
|
|
export type SlackAccountConfig = {
|
|
/** Optional display name for this account (used in CLI/UI lists). */
|
|
name?: string;
|
|
/** Slack connection mode (socket|http). Default: socket. */
|
|
mode?: "socket" | "http";
|
|
/** Slack signing secret (required for HTTP mode). */
|
|
signingSecret?: string;
|
|
/** Slack Events API webhook path (default: /slack/events). */
|
|
webhookPath?: string;
|
|
/** Optional provider capability tags used for agent/runtime guidance. */
|
|
capabilities?: string[];
|
|
/** Override native command registration for Slack (bool or "auto"). */
|
|
commands?: ProviderCommandsConfig;
|
|
/** Allow channel-initiated config writes (default: true). */
|
|
configWrites?: boolean;
|
|
/** If false, do not start this Slack account. Default: true. */
|
|
enabled?: boolean;
|
|
botToken?: string;
|
|
appToken?: string;
|
|
userToken?: string;
|
|
/** If true, restrict user token to read operations only. Default: true. */
|
|
userTokenReadOnly?: boolean;
|
|
/** Allow bot-authored messages to trigger replies (default: false). */
|
|
allowBots?: boolean;
|
|
/** Default mention requirement for channel messages (default: true). */
|
|
requireMention?: boolean;
|
|
/**
|
|
* Controls how channel messages are handled:
|
|
* - "open": channels bypass allowlists; mention-gating applies
|
|
* - "disabled": block all channel messages
|
|
* - "allowlist": only allow channels present in channels.slack.channels
|
|
*/
|
|
groupPolicy?: GroupPolicy;
|
|
/** Max channel messages to keep as history context (0 disables). */
|
|
historyLimit?: number;
|
|
/** Max DM turns to keep as history context. */
|
|
dmHistoryLimit?: number;
|
|
/** Per-DM config overrides keyed by user ID. */
|
|
dms?: Record<string, DmConfig>;
|
|
textChunkLimit?: number;
|
|
blockStreaming?: boolean;
|
|
/** Merge streamed block replies before sending. */
|
|
blockStreamingCoalesce?: BlockStreamingCoalesceConfig;
|
|
mediaMaxMb?: number;
|
|
/** Reaction notification mode (off|own|all|allowlist). Default: own. */
|
|
reactionNotifications?: SlackReactionNotificationMode;
|
|
/** Allowlist for reaction notifications when mode is allowlist. */
|
|
reactionAllowlist?: Array<string | number>;
|
|
/** Control reply threading when reply tags are present (off|first|all). */
|
|
replyToMode?: ReplyToMode;
|
|
/** Thread session behavior. */
|
|
thread?: SlackThreadConfig;
|
|
actions?: SlackActionConfig;
|
|
slashCommand?: SlackSlashCommandConfig;
|
|
dm?: SlackDmConfig;
|
|
channels?: Record<string, SlackChannelConfig>;
|
|
};
|
|
|
|
export type SlackConfig = {
|
|
/** Optional per-account Slack configuration (multi-account). */
|
|
accounts?: Record<string, SlackAccountConfig>;
|
|
} & SlackAccountConfig;
|