@gguf/claw/dist/plugin-sdk/config/types.messages.d.ts

Multi-channel AI gateway with extensible messaging integrations

import type { QueueDropPolicy, QueueMode, QueueModeByProvider } from "./types.queue.js";
import type { TtsConfig } from "./types.tts.js";
export type GroupChatConfig = {
    mentionPatterns?: string[];
    historyLimit?: number;
};
export type DmConfig = {
    historyLimit?: number;
};
export type QueueConfig = {
    mode?: QueueMode;
    byChannel?: QueueModeByProvider;
    debounceMs?: number;
    /** Per-channel debounce overrides (ms). */
    debounceMsByChannel?: InboundDebounceByProvider;
    cap?: number;
    drop?: QueueDropPolicy;
};
export type InboundDebounceByProvider = Record<string, number>;
export type InboundDebounceConfig = {
    debounceMs?: number;
    byChannel?: InboundDebounceByProvider;
};
export type BroadcastStrategy = "parallel" | "sequential";
export type BroadcastConfig = {
    /** Default processing strategy for broadcast peers. */
    strategy?: BroadcastStrategy;
    /**
     * Map peer IDs to arrays of agent IDs that should ALL process messages.
     *
     * Note: the index signature includes `undefined` so `strategy?: ...` remains type-safe.
     */
    [peerId: string]: string[] | BroadcastStrategy | undefined;
};
export type AudioConfig = {
    /** @deprecated Use tools.media.audio.models instead. */
    transcription?: {
        command: string[];
        timeoutSeconds?: number;
    };
};
export type StatusReactionsEmojiConfig = {
    thinking?: string;
    tool?: string;
    coding?: string;
    web?: string;
    done?: string;
    error?: string;
    stallSoft?: string;
    stallHard?: string;
};
export type StatusReactionsTimingConfig = {
    /** Debounce interval for intermediate states (ms). Default: 700. */
    debounceMs?: number;
    /** Soft stall warning timeout (ms). Default: 25000. */
    stallSoftMs?: number;
    /** Hard stall warning timeout (ms). Default: 60000. */
    stallHardMs?: number;
    /** How long to hold done emoji before cleanup (ms). Default: 1500. */
    doneHoldMs?: number;
    /** How long to hold error emoji before cleanup (ms). Default: 2500. */
    errorHoldMs?: number;
};
export type StatusReactionsConfig = {
    /** Enable lifecycle status reactions (default: false). */
    enabled?: boolean;
    /** Override default emojis. */
    emojis?: StatusReactionsEmojiConfig;
    /** Override default timing. */
    timing?: StatusReactionsTimingConfig;
};
export type MessagesConfig = {
    /** @deprecated Use `whatsapp.messagePrefix` (WhatsApp-only inbound prefix). */
    messagePrefix?: string;
    /**
     * Prefix auto-added to all outbound replies.
     *
     * - string: explicit prefix (may include template variables)
     * - special value: `"auto"` derives `[{agents.list[].identity.name}]` for the routed agent (when set)
     *
     * Supported template variables (case-insensitive):
     * - `{model}` - short model name (e.g., `claude-opus-4-6`, `gpt-4o`)
     * - `{modelFull}` - full model identifier (e.g., `anthropic/claude-opus-4-6`)
     * - `{provider}` - provider name (e.g., `anthropic`, `openai`)
     * - `{thinkingLevel}` or `{think}` - current thinking level (`high`, `low`, `off`)
     * - `{identity.name}` or `{identityName}` - agent identity name
     *
     * Example: `"[{model} | think:{thinkingLevel}]"` → `"[claude-opus-4-6 | think:high]"`
     *
     * Unresolved variables remain as literal text (e.g., `{model}` if context unavailable).
     *
     * Default: none
     */
    responsePrefix?: string;
    groupChat?: GroupChatConfig;
    queue?: QueueConfig;
    /** Debounce rapid inbound messages per sender (global + per-channel overrides). */
    inbound?: InboundDebounceConfig;
    /** Emoji reaction used to acknowledge inbound messages (empty disables). */
    ackReaction?: string;
    /** When to send ack reactions. Default: "group-mentions". */
    ackReactionScope?: "group-mentions" | "group-all" | "direct" | "all";
    /** Remove ack reaction after reply is sent (default: false). */
    removeAckAfterReply?: boolean;
    /** Lifecycle status reactions configuration. */
    statusReactions?: StatusReactionsConfig;
    /** When true, suppress ⚠️ tool-error warnings from being shown to the user. Default: false. */
    suppressToolErrors?: boolean;
    /** Text-to-speech settings for outbound replies. */
    tts?: TtsConfig;
};
export type NativeCommandsSetting = boolean | "auto";
/**
 * Per-provider allowlist for command authorization.
 * Keys are channel IDs (e.g., "discord", "whatsapp") or "*" for global default.
 * Values are arrays of sender IDs allowed to use commands on that channel.
 */
export type CommandAllowFrom = Record<string, Array<string | number>>;
export type CommandsConfig = {
    /** Enable native command registration when supported (default: "auto"). */
    native?: NativeCommandsSetting;
    /** Enable native skill command registration when supported (default: "auto"). */
    nativeSkills?: NativeCommandsSetting;
    /** Enable text command parsing (default: true). */
    text?: boolean;
    /** Allow bash chat command (`!`; `/bash` alias) (default: false). */
    bash?: boolean;
    /** How long bash waits before backgrounding (default: 2000; 0 backgrounds immediately). */
    bashForegroundMs?: number;
    /** Allow /config command (default: false). */
    config?: boolean;
    /** Allow /debug command (default: false). */
    debug?: boolean;
    /** Allow restart commands/tools (default: true). */
    restart?: boolean;
    /** Enforce access-group allowlists/policies for commands (default: true). */
    useAccessGroups?: boolean;
    /** Explicit owner allowlist for owner-only tools/commands (channel-native IDs). */
    ownerAllowFrom?: Array<string | number>;
    /**
     * Per-provider allowlist restricting who can use slash commands.
     * If set, overrides the channel's allowFrom for command authorization.
     * Use "*" key for global default, provider-specific keys override the global.
     * Example: { "*": ["user1"], discord: ["user:123"] }
     */
    allowFrom?: CommandAllowFrom;
};
export type ProviderCommandsConfig = {
    /** Override native command registration for this provider (bool or "auto"). */
    native?: NativeCommandsSetting;
    /** Override native skill command registration for this provider (bool or "auto"). */
    nativeSkills?: NativeCommandsSetting;
};