eve/dist/src/public/channels/slack/inbound.d.ts

Filesystem-first framework for durable backend AI agents that run anywhere.

/**
 * Inbound Slack event → harness shaping.
 *
 * The channel calls these helpers on every inbound `app_mention` event
 * before handing it to the runtime:
 *
 * 1. {@link parseAppMentionEvent} parses Slack's webhook envelope into
 *    a channel-owned {@link SlackMessage}, with the body's text already
 *    re-rendered as GFM markdown so the agent does not see raw
 *    `<@U…>` / `<https://…|…>` fragments.
 * 2. {@link formatSlackContextBlock} renders a `<slack_context>` block
 *    naming the actor, channel, and thread. The channel delivers it as
 *    a dedicated context entry so the agent always knows who and where
 *    it is talking.
 */
/**
 * Author metadata for an inbound Slack message. Channel-owned shape;
 * does not depend on the chat SDK's `Author` interface.
 */
export interface SlackAuthor {
    readonly userId: string;
    readonly userName: string | undefined;
    readonly fullName: string | undefined;
    readonly isBot: boolean;
    readonly isMe: boolean;
}
/**
 * Inbound Slack file attachment. The channel reads only `type`, `url`,
 * `name`, `mimeType`, and `size`. The full Slack file object stays
 * available on {@link SlackMessage.raw}.
 */
export interface SlackAttachment {
    readonly id: string;
    readonly type: "image" | "file" | "video" | "audio";
    readonly url: string | undefined;
    readonly name: string | undefined;
    readonly mimeType: string | undefined;
    readonly size: number | undefined;
}
/**
 * Channel-owned representation of one inbound Slack message.
 *
 * Returned by {@link parseAppMentionEvent} for the triggering mention.
 * Replaces the chat SDK `Message` type in the public callback surface
 * (e.g. `onAppMention(ctx, message)`).
 */
export interface SlackMessage {
    /** The original Slack text (mrkdwn). */
    readonly text: string;
    /** {@link text} re-rendered as GFM markdown for the agent. */
    readonly markdown: string;
    /** Slack message ts. */
    readonly ts: string;
    /** Thread parent ts (root). Equals {@link ts} for non-thread events. */
    readonly threadTs: string;
    /** Slack channel id. */
    readonly channelId: string;
    /** Slack team id, when the envelope carried one. */
    readonly teamId: string | undefined;
    /** Author of the message. May be `undefined` for system events. */
    readonly author: SlackAuthor | undefined;
    /** File / image attachments on the inbound message. */
    readonly attachments: readonly SlackAttachment[];
    /** Raw inbound event payload from Slack. */
    readonly raw: Record<string, unknown>;
}
/**
 * Slack webhook envelope for an `event_callback`. The channel cares
 * only about `team_id` (for ergonomic auth derivation) and the inner
 * `event` payload.
 */
export interface SlackEventCallback {
    readonly type: "event_callback";
    readonly team_id?: string;
    readonly event?: {
        readonly type?: string;
    } & Record<string, unknown>;
    readonly event_id?: string;
    readonly event_time?: number;
    readonly [key: string]: unknown;
}
/**
 * Parses a Slack `app_mention` event into a {@link SlackMessage}.
 *
 * Returns `null` when the envelope is not an `app_mention` event or
 * when required fields (channel id, ts) are missing.
 */
export declare function parseAppMentionEvent(envelope: SlackEventCallback): SlackMessage | null;
/**
 * Parses a Slack `message` event with `channel_type: "im"` into a
 * {@link SlackMessage}.
 *
 * Returns `null` when:
 * - the envelope is not an IM `message` event,
 * - required fields (channel id, ts) are missing,
 * - the message carries a system `subtype` (edits, deletes, joins, etc.)
 *   other than `file_share` — file uploads are real user messages and
 *   must reach the handler with their attachments intact, or
 * - the message was posted by a bot (`bot_id` set) — this prevents the
 *   bot's own DM replies from re-triggering the handler.
 */
export declare function parseDirectMessageEvent(envelope: SlackEventCallback): SlackMessage | null;
/**
 * Verified inbound identity used to render a `<slack_context>` block.
 *
 * Channel-owned shape so the helper does not depend on the inbound
 * `SlackMessage` and is therefore trivially testable in isolation.
 */
export interface SlackInboundContext {
    readonly userId: string;
    readonly userName?: string;
    readonly fullName?: string;
    readonly channelId: string;
    readonly threadTs: string;
    readonly teamId?: string;
}
/**
 * Renders one {@link SlackInboundContext} as a `<slack_context>` block.
 * Lines are deterministic and tag-delimited so the agent can match the
 * block in its prompt.
 */
export declare function formatSlackContextBlock(context: SlackInboundContext): string;