c9359b8486
Signal's groupPolicy: allowlist was checking senders against groupAllowFrom, but users expected to put group IDs there. This adds proper group-level allowlisting via channels.signal.groups.<groupId>, matching the pattern used by Telegram and iMessage. When a group is explicitly listed in the groups config, it bypasses the sender-level groupAllowFrom check, allowing all members of that group to interact with the bot. - Add SignalGroupConfig type and groups property to SignalAccountConfig - Add resolveChannelGroupPolicy check before sender-level gating - Add tests for group-level allowlist functionality - Update docs to clarify groupAllowFrom vs groups config
111 lines
4.4 KiB
TypeScript
111 lines
4.4 KiB
TypeScript
import type {
|
|
BlockStreamingCoalesceConfig,
|
|
DmPolicy,
|
|
GroupPolicy,
|
|
MarkdownConfig,
|
|
} from "./types.base.js";
|
|
import type { ChannelHeartbeatVisibilityConfig } from "./types.channels.js";
|
|
import type { DmConfig } from "./types.messages.js";
|
|
import type { GroupToolPolicyBySenderConfig, GroupToolPolicyConfig } from "./types.tools.js";
|
|
|
|
export type SignalReactionNotificationMode = "off" | "own" | "all" | "allowlist";
|
|
export type SignalReactionLevel = "off" | "ack" | "minimal" | "extensive";
|
|
|
|
export type SignalGroupConfig = {
|
|
/** If true, require @mention to respond in this group. */
|
|
requireMention?: boolean;
|
|
/** Optional tool policy overrides for this group. */
|
|
tools?: GroupToolPolicyConfig;
|
|
/** Per-sender tool policy overrides. */
|
|
toolsBySender?: GroupToolPolicyBySenderConfig;
|
|
/** If false, disable the bot for this group. */
|
|
enabled?: boolean;
|
|
/** Optional allowlist for group senders (E.164 or uuid:<id>). */
|
|
allowFrom?: Array<string | number>;
|
|
/** Optional system prompt snippet for this group. */
|
|
systemPrompt?: string;
|
|
};
|
|
|
|
export type SignalAccountConfig = {
|
|
/** 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;
|
|
/** Allow channel-initiated config writes (default: true). */
|
|
configWrites?: boolean;
|
|
/** If false, do not start this Signal account. Default: true. */
|
|
enabled?: boolean;
|
|
/** Optional explicit E.164 account for signal-cli. */
|
|
account?: string;
|
|
/** Optional full base URL for signal-cli HTTP daemon. */
|
|
httpUrl?: string;
|
|
/** HTTP host for signal-cli daemon (default 127.0.0.1). */
|
|
httpHost?: string;
|
|
/** HTTP port for signal-cli daemon (default 8080). */
|
|
httpPort?: number;
|
|
/** signal-cli binary path (default: signal-cli). */
|
|
cliPath?: string;
|
|
/** Auto-start signal-cli daemon (default: true if httpUrl not set). */
|
|
autoStart?: boolean;
|
|
/** Max time to wait for signal-cli daemon startup (ms, cap 120000). */
|
|
startupTimeoutMs?: number;
|
|
receiveMode?: "on-start" | "manual";
|
|
ignoreAttachments?: boolean;
|
|
ignoreStories?: boolean;
|
|
sendReadReceipts?: boolean;
|
|
/** Direct message access policy (default: pairing). */
|
|
dmPolicy?: DmPolicy;
|
|
allowFrom?: Array<string | number>;
|
|
/** Optional allowlist for Signal group senders (E.164). */
|
|
groupAllowFrom?: Array<string | number>;
|
|
/**
|
|
* Controls how group messages are handled:
|
|
* - "open": groups bypass allowFrom, no extra gating
|
|
* - "disabled": block all group messages
|
|
* - "allowlist": only allow group messages from senders in groupAllowFrom/allowFrom
|
|
*/
|
|
groupPolicy?: GroupPolicy;
|
|
/** Per-group configuration keyed by Signal group ID. */
|
|
groups?: Record<string, SignalGroupConfig>;
|
|
/** Max group 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>;
|
|
/** Outbound text chunk size (chars). Default: 4000. */
|
|
textChunkLimit?: number;
|
|
/** Chunking mode: "length" (default) splits by size; "newline" splits on every newline. */
|
|
chunkMode?: "length" | "newline";
|
|
blockStreaming?: boolean;
|
|
/** Merge streamed block replies before sending. */
|
|
blockStreamingCoalesce?: BlockStreamingCoalesceConfig;
|
|
mediaMaxMb?: number;
|
|
/** Reaction notification mode (off|own|all|allowlist). Default: own. */
|
|
reactionNotifications?: SignalReactionNotificationMode;
|
|
/** Allowlist for reaction notifications when mode is allowlist. */
|
|
reactionAllowlist?: Array<string | number>;
|
|
/** Action toggles for message tool capabilities. */
|
|
actions?: {
|
|
/** Enable/disable sending reactions via message tool (default: true). */
|
|
reactions?: boolean;
|
|
};
|
|
/**
|
|
* Controls agent reaction behavior:
|
|
* - "off": No reactions
|
|
* - "ack": Only automatic ack reactions (👀 when processing)
|
|
* - "minimal": Agent can react sparingly (default)
|
|
* - "extensive": Agent can react liberally
|
|
*/
|
|
reactionLevel?: SignalReactionLevel;
|
|
/** Heartbeat visibility settings for this channel. */
|
|
heartbeat?: ChannelHeartbeatVisibilityConfig;
|
|
};
|
|
|
|
export type SignalConfig = {
|
|
/** Optional per-account Signal configuration (multi-account). */
|
|
accounts?: Record<string, SignalAccountConfig>;
|
|
} & SignalAccountConfig;
|