f9cf508cff
Add per-channel and per-account heartbeat visibility settings: - showOk: hide/show HEARTBEAT_OK messages (default: false) - showAlerts: hide/show alert messages (default: true) - useIndicator: emit typing indicator events (default: true) Config precedence: per-account > per-channel > channel-defaults > global This allows silencing routine heartbeat acks while still surfacing alerts when something needs attention.
75 lines
2.8 KiB
TypeScript
75 lines
2.8 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 { GroupToolPolicyConfig } from "./types.tools.js";
|
|
|
|
export type IMessageAccountConfig = {
|
|
/** 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 iMessage account. Default: true. */
|
|
enabled?: boolean;
|
|
/** imsg CLI binary path (default: imsg). */
|
|
cliPath?: string;
|
|
/** Optional Messages db path override. */
|
|
dbPath?: string;
|
|
/** Remote host for SCP when attachments live on a different machine (e.g., clawdbot@192.168.64.3). */
|
|
remoteHost?: string;
|
|
/** Optional default send service (imessage|sms|auto). */
|
|
service?: "imessage" | "sms" | "auto";
|
|
/** Optional default region (used when sending SMS). */
|
|
region?: string;
|
|
/** Direct message access policy (default: pairing). */
|
|
dmPolicy?: DmPolicy;
|
|
/** Optional allowlist for inbound handles or chat_id targets. */
|
|
allowFrom?: Array<string | number>;
|
|
/** Optional allowlist for group senders or chat_id targets. */
|
|
groupAllowFrom?: Array<string | number>;
|
|
/**
|
|
* Controls how group messages are handled:
|
|
* - "open": groups bypass allowFrom; mention-gating applies
|
|
* - "disabled": block all group messages entirely
|
|
* - "allowlist": only allow group messages from senders in groupAllowFrom/allowFrom
|
|
*/
|
|
groupPolicy?: GroupPolicy;
|
|
/** 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>;
|
|
/** Include attachments + reactions in watch payloads. */
|
|
includeAttachments?: boolean;
|
|
/** Max outbound media size in MB. */
|
|
mediaMaxMb?: number;
|
|
/** Outbound text chunk size (chars). Default: 4000. */
|
|
textChunkLimit?: number;
|
|
blockStreaming?: boolean;
|
|
/** Merge streamed block replies before sending. */
|
|
blockStreamingCoalesce?: BlockStreamingCoalesceConfig;
|
|
groups?: Record<
|
|
string,
|
|
{
|
|
requireMention?: boolean;
|
|
tools?: GroupToolPolicyConfig;
|
|
}
|
|
>;
|
|
/** Heartbeat visibility settings for this channel. */
|
|
heartbeat?: ChannelHeartbeatVisibilityConfig;
|
|
};
|
|
|
|
export type IMessageConfig = {
|
|
/** Optional per-account iMessage configuration (multi-account). */
|
|
accounts?: Record<string, IMessageAccountConfig>;
|
|
} & IMessageAccountConfig;
|