@copilotkit/channels-slack 0.1.0

package/dist/__tests__/views.test.js

@@ -0,0 +1,143 @@
+import { describe, it, expect, vi } from "vitest";
+import { decodeViewSubmission, decodeViewClosed } from "../interaction.js";
+import { SlackAdapter } from "../adapter.js";
+describe("decodeViewSubmission", () => {
+    it("parses field values from a view_submission payload", () => {
+        const evt = decodeViewSubmission({
+            callback_id: "triage",
+            private_metadata: "meta",
+            state: {
+                values: {
+                    summary: { summary: { type: "plain_text_input", value: "boom" } },
+                    prio: {
+                        prio: {
+                            type: "static_select",
+                            selected_option: { value: "high" },
+                        },
+                    },
+                    team: {
+                        team: {
+                            type: "radio_buttons",
+                            selected_option: { value: "core" },
+                        },
+                    },
+                },
+            },
+        }, { id: "U1" });
+        expect(evt).toMatchObject({
+            callbackId: "triage",
+            privateMetadata: "meta",
+            values: { summary: "boom", prio: "high", team: "core" },
+            user: { id: "U1" },
+            platform: "slack",
+        });
+    });
+    it("decodes a __cpk envelope into conversationKey + replyTarget and restores pm", () => {
+        const evt = decodeViewSubmission({
+            callback_id: "file_issue",
+            private_metadata: JSON.stringify({
+                __cpk: { channel: "C123", threadTs: "1700.5" },
+                pm: "authorMeta",
+            }),
+            state: { values: {} },
+        }, { id: "U1" });
+        expect(evt.conversationKey).toBe("C123::1700.5");
+        expect(evt.replyTarget).toEqual({ channel: "C123", threadTs: "1700.5" });
+        expect(evt.privateMetadata).toBe("authorMeta");
+    });
+    it("uses DM_SCOPE when the envelope has no threadTs", () => {
+        const evt = decodeViewSubmission({
+            callback_id: "file_issue",
+            private_metadata: JSON.stringify({
+                __cpk: { channel: "D999" },
+            }),
+            state: { values: {} },
+        }, { id: "U1" });
+        expect(evt.conversationKey).toBe("D999::dm");
+        expect(evt.replyTarget).toEqual({ channel: "D999" });
+        expect(evt.privateMetadata).toBeUndefined();
+    });
+    it("passes a plain (non-envelope) private_metadata through with no conversationKey/replyTarget", () => {
+        const evt = decodeViewSubmission({
+            callback_id: "triage",
+            private_metadata: "just-a-string",
+            state: { values: {} },
+        }, { id: "U1" });
+        expect(evt.privateMetadata).toBe("just-a-string");
+        expect(evt.conversationKey).toBeUndefined();
+        expect(evt.replyTarget).toBeUndefined();
+    });
+});
+describe("decodeViewClosed", () => {
+    it("decodes a __cpk envelope into conversationKey + replyTarget and restores pm", () => {
+        const evt = decodeViewClosed({
+            callback_id: "file_issue",
+            private_metadata: JSON.stringify({
+                __cpk: { channel: "C123", threadTs: "1700.5" },
+                pm: "authorMeta",
+            }),
+        }, { id: "U1" });
+        expect(evt.conversationKey).toBe("C123::1700.5");
+        expect(evt.replyTarget).toEqual({ channel: "C123", threadTs: "1700.5" });
+        expect(evt.privateMetadata).toBe("authorMeta");
+    });
+    it("passes a plain private_metadata through with no conversationKey/replyTarget", () => {
+        const evt = decodeViewClosed({
+            callback_id: "triage",
+            private_metadata: "plain",
+        }, { id: "U1" });
+        expect(evt.privateMetadata).toBe("plain");
+        expect(evt.conversationKey).toBeUndefined();
+        expect(evt.replyTarget).toBeUndefined();
+    });
+});
+describe("SlackAdapter.openModal", () => {
+    const modalIr = [
+        {
+            type: "modal",
+            props: {
+                callbackId: "file_issue",
+                title: "File issue",
+                children: [],
+            },
+        },
+    ];
+    function makeAdapter() {
+        const adapter = new SlackAdapter({
+            botToken: "xoxb-test",
+            appToken: "xapp-test",
+        });
+        const open = vi.fn().mockResolvedValue({ ok: true });
+        // Replace the WebClient with a stub exposing only views.open.
+        adapter.client = { views: { open } };
+        return { adapter, open };
+    }
+    it("stamps a __cpk envelope carrying the target channel/threadTs into private_metadata", async () => {
+        const { adapter, open } = makeAdapter();
+        const res = await adapter.openModal({ channel: "C123", threadTs: "1700.5" }, "trigger-1", modalIr);
+        expect(res.ok).toBe(true);
+        expect(open).toHaveBeenCalledTimes(1);
+        const arg = open.mock.calls[0][0];
+        const envelope = JSON.parse(arg.view.private_metadata);
+        expect(envelope.__cpk).toEqual({ channel: "C123", threadTs: "1700.5" });
+    });
+    it("preserves an author-set private_metadata under pm", async () => {
+        const { adapter, open } = makeAdapter();
+        const irWithMeta = [
+            {
+                type: "modal",
+                props: {
+                    callbackId: "file_issue",
+                    title: "File issue",
+                    privateMetadata: "authorMeta",
+                    children: [],
+                },
+            },
+        ];
+        await adapter.openModal({ channel: "C123" }, "trigger-1", irWithMeta);
+        const arg = open.mock.calls[0][0];
+        const envelope = JSON.parse(arg.view.private_metadata);
+        expect(envelope.__cpk).toEqual({ channel: "C123" });
+        expect(envelope.pm).toBe("authorMeta");
+    });
+});

package/dist/adapter.d.ts

@@ -0,0 +1,188 @@
+import { App, LogLevel } from "@slack/bolt";
+import type { WebClient } from "@slack/web-api";
+import type { KnownBlock } from "@slack/types";
+import type { PlatformAdapter, SurfaceCapabilities, IngressSink, InteractionEvent, RunRenderer, ReplyTarget as BotReplyTarget, ConversationStore, MessageRef, PlatformUser, UserQuery, EphemeralResult, NativePayload } from "@copilotkit/channels";
+import type { BotNode, ThreadMessage, EmojiValue } from "@copilotkit/channels-ui";
+import type { SlackAssistantOptions, SlackFeedbackOptions, SlackRespondToOptions } from "./types.js";
+export interface SlackAdapterOptions {
+    /** Slack bot token (xoxb-…). */
+    botToken: string;
+    /** Slack app-level token (xapp-…) used for Socket Mode. */
+    appToken: string;
+    /** Signing secret; required when not using Socket Mode. */
+    signingSecret?: string;
+    /** Use Socket Mode (default true). HTTP mode requires `signingSecret`. */
+    socketMode?: boolean;
+    /** HTTP port for non-socket mode (ignored under Socket Mode). */
+    port?: number;
+    /** Bolt log level. */
+    logLevel?: LogLevel;
+    /** Custom-event names treated as interrupts by the run renderer. */
+    interruptEventNames?: ReadonlySet<string>;
+    /** Surface `:wrench:`/`:white_check_mark:` tool-status rows. Default true. */
+    showToolStatus?: boolean;
+    /**
+     * Assistant-pane behavior ("Agents & AI Apps"). ON by default — the pane
+     * activates whenever the app's Slack config has the toggle (see the README),
+     * and lies dormant without it. Pass an object to customize, or `false` to
+     * disable pane handling entirely.
+     */
+    assistant?: SlackAssistantOptions | false;
+    /**
+     * Controls which Slack message surfaces become bot turns. Defaults: DMs
+     * respond, app mentions respond in-thread, and plain channel thread replies
+     * require another app mention.
+     */
+    respondTo?: SlackRespondToOptions;
+    /**
+     * Reply-stream transport. "native" (default): `chat.startStream` wherever the
+     * reply target is a thread; flat DMs and workspaces where the streaming API
+     * is unavailable fall back to legacy automatically. "legacy": the shipped
+     * `chat.update` transport.
+     */
+    streaming?: "native" | "legacy";
+    /**
+     * Opt-in native AI feedback buttons (👍/👎). When set, streamed replies on
+     * the native path finalize with a `feedback_buttons` row and clicks are
+     * routed to `onFeedback` (they never reach the engine). Omit for no feedback.
+     */
+    feedback?: SlackFeedbackOptions;
+}
+/** Slack `PlatformAdapter`: ingress via Bolt, egress via Block Kit + streaming. */
+export declare class SlackAdapter implements PlatformAdapter {
+    private readonly opts;
+    readonly platform = "slack";
+    readonly capabilities: SurfaceCapabilities;
+    readonly ackDeadlineMs = 3000;
+    readonly app: App;
+    client: WebClient;
+    botUserId: string;
+    private readonly store;
+    private sink;
+    /** Per-id cache for sender-profile resolution (repeat turns are cheap). */
+    private readonly userCache;
+    /** Set once the Assistant middleware is attached (when assistant !== false). */
+    private assistantHandle;
+    /** Our team id (from auth.test); native channel streams need it. */
+    private teamId;
+    /**
+     * In-memory native-streaming health for this workspace. Flipped to false the
+     * first time `chat.startStream` fails, so subsequent streams skip the native
+     * path and go straight to the legacy transport.
+     */
+    private nativeStreamingOk;
+    /**
+     * In-memory health of native structured `task_update` chunks for this
+     * workspace. Flipped to false the first time a chunk append fails (old
+     * workspace / missing `assistant:write`), so later turns surface tool
+     * progress as `:wrench:` rows instead of retrying chunks.
+     */
+    private nativeTaskChunksOk;
+    constructor(opts: SlackAdapterOptions);
+    start(sink: IngressSink): Promise<void>;
+    stop(): Promise<void>;
+    render(ir: BotNode[]): KnownBlock[];
+    post(target: BotReplyTarget, ir: BotNode[]): Promise<MessageRef>;
+    update(ref: MessageRef, ir: BotNode[]): Promise<void>;
+    stream(target: BotReplyTarget, chunks: AsyncIterable<string>): Promise<MessageRef>;
+    /**
+     * Build the {@link NativeStreamTransport} (chat.startStream/appendStream/
+     * stopStream) for a thread target. `onFirstTs` records the first streamed
+     * message's ts/channel for the returned MessageRef. Native channel streams
+     * pass `recipient_user_id` (the turn sender) + `recipient_team_id`.
+     */
+    private nativeTransport;
+    /**
+     * The credentialed {@link SlackRenderTransport} the run renderer calls
+     * (setStatus / postMessage / update), wrapping this adapter's `WebClient`.
+     * Extracted so `createRunRenderer` stays Bolt-free and the managed Connector
+     * Outbox can drive the identical renderer with its own sender.
+     */
+    private renderTransport;
+    /**
+     * Route a `feedback_buttons` click to the configured feedback callback.
+     * Returns `true` if this was a feedback click (so the caller skips the
+     * engine's interaction dispatch). Best-effort: payload-shape or handler
+     * errors are logged, never thrown.
+     */
+    private handleFeedbackClick;
+    delete(ref: MessageRef): Promise<void>;
+    /**
+     * True if `target` is a known assistant-pane thread (recorded by the
+     * Assistant middleware). Pane targets drive native status and back the
+     * pane-only `setSuggestedPrompts` / `setThreadTitle` methods.
+     */
+    private isPaneTarget;
+    createRunRenderer(target: BotReplyTarget): RunRenderer;
+    /** Backs the capability-gated `Thread.setSuggestedPrompts` for pane threads. */
+    setSuggestedPrompts(target: BotReplyTarget, prompts: ReadonlyArray<{
+        title: string;
+        message: string;
+    }>, opts?: {
+        title?: string;
+    }): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+    /** Backs the capability-gated `Thread.setTitle` for pane threads. */
+    setThreadTitle(target: BotReplyTarget, title: string): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+    decodeInteraction(raw: unknown): InteractionEvent | undefined;
+    lookupUser(q: UserQuery): Promise<PlatformUser | undefined>;
+    /**
+     * Resolve a Slack user id to a richer `PlatformUser` (name + email) for each
+     * turn, cached by id so repeat turns in the same conversation are cheap.
+     * Tolerates lookup failure by falling back to a bare `{ id }`.
+     */
+    resolveUser(userId: string): Promise<PlatformUser>;
+    get conversationStore(): ConversationStore;
+    /**
+     * Read the conversation's recent messages. Backs the capability-gated
+     * `Thread.getMessages()`. For a thread target we read its replies; a flat
+     * target (DM, no `threadTs`) has no thread to fetch, so we return `[]`.
+     * Capped defensively to the last 100 messages.
+     */
+    getMessages(target: BotReplyTarget): Promise<ThreadMessage[]>;
+    postFile(target: BotReplyTarget, { bytes, filename, title, altText, }: {
+        bytes: Uint8Array;
+        filename: string;
+        title?: string;
+        altText?: string;
+    }): Promise<{
+        ok: boolean;
+        fileId?: string;
+        error?: string;
+    }>;
+    addReaction(target: BotReplyTarget, messageRef: MessageRef, emoji: EmojiValue): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+    removeReaction(target: BotReplyTarget, messageRef: MessageRef, emoji: EmojiValue): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+    /**
+     * Post an ephemeral message visible only to `user`. Slack always supports
+     * native ephemeral, so `fallbackToDM` is ignored and `usedFallback` is
+     * always `false` on success. On API error returns `{ ok: false, error }`.
+     */
+    postEphemeral(target: BotReplyTarget, user: PlatformUser | string, ir: BotNode[], _opts: {
+        fallbackToDM: boolean;
+    }): Promise<EphemeralResult | null>;
+    /** Render a modal IR tree to a Slack `views.open` `View` (pure; backs `openModal`). */
+    renderModal(ir: BotNode[]): NativePayload;
+    /**
+     * Open a modal against a Slack `trigger_id` via `views.open`. Degrades rather
+     * than throwing: a render error (unsupported element) or API failure (expired
+     * trigger, etc.) resolves to `{ ok: false, error }`.
+     */
+    openModal(target: BotReplyTarget, triggerId: string, ir: BotNode[]): Promise<{
+        ok: boolean;
+        error?: string;
+    }>;
+}
+/** Construct a Slack `PlatformAdapter`. */
+export declare function slack(opts: SlackAdapterOptions): SlackAdapter;
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EACV,SAAS,EAMV,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAY,UAAU,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,KAAK,EACV,eAAe,EACf,mBAAmB,EACnB,WAAW,EACX,gBAAgB,EAChB,WAAW,EACX,WAAW,IAAI,cAAc,EAC7B,iBAAiB,EAEjB,UAAU,EACV,YAAY,EACZ,SAAS,EACT,eAAe,EACf,aAAa,EACd,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EACV,OAAO,EACP,aAAa,EACb,UAAU,EACX,MAAM,yBAAyB,CAAC;AA4BjC,OAAO,KAAK,EAGV,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,mBAAmB;IAClC,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iEAAiE;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,oEAAoE;IACpE,mBAAmB,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC1C,8EAA8E;IAC9E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,KAAK,CAAC;IAC1C;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAChC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;CACjC;AAED,mFAAmF;AACnF,qBAAa,YAAa,YAAW,eAAe;IA8BtC,OAAO,CAAC,QAAQ,CAAC,IAAI;IA7BjC,QAAQ,CAAC,QAAQ,WAAW;IAC5B,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAC3C,QAAQ,CAAC,aAAa,QAAQ;IAE9B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB,MAAM,EAAE,SAAS,CAAC;IAClB,SAAS,SAAM;IACf,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;IAC/C,OAAO,CAAC,IAAI,CAA0B;IACtC,2EAA2E;IAC3E,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmC;IAC7D,gFAAgF;IAChF,OAAO,CAAC,eAAe,CAA8B;IACrD,oEAAoE;IACpE,OAAO,CAAC,MAAM,CAAqB;IACnC;;;;OAIG;IACH,OAAO,CAAC,iBAAiB,CAAQ;IACjC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB,CAAQ;gBAEL,IAAI,EAAE,mBAAmB;IAgChD,KAAK,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAuIvC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE;IAId,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IA2BhE,MAAM,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBrD,MAAM,CACV,MAAM,EAAE,cAAc,EACtB,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,GAC5B,OAAO,CAAC,UAAU,CAAC;IAgEtB;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IA6DvB;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAiBvB;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAuCrB,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5C;;;;OAIG;IACH,OAAO,CAAC,YAAY;IASpB,iBAAiB,CAAC,MAAM,EAAE,cAAc,GAAG,WAAW;IAsDtD,gFAAgF;IAC1E,mBAAmB,CACvB,MAAM,EAAE,cAAc,EACtB,OAAO,EAAE,aAAa,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,EAC1D,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GACxB,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IA2B3C,qEAAqE;IAC/D,cAAc,CAClB,MAAM,EAAE,cAAc,EACtB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAoB3C,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,gBAAgB,GAAG,SAAS;IAIvD,UAAU,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IA4CjE;;;;OAIG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAoCxD,IAAI,iBAAiB,IAAI,iBAAiB,CAuBzC;IAED;;;;;OAKG;IACG,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IA4C7D,QAAQ,CACZ,MAAM,EAAE,cAAc,EACtB,EACE,KAAK,EACL,QAAQ,EACR,KAAK,EACL,OAAO,GACR,EAAE;QACD,KAAK,EAAE,UAAU,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GACA,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAuBtD,WAAW,CACf,MAAM,EAAE,cAAc,EACtB,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAiBrC,cAAc,CAClB,MAAM,EAAE,cAAc,EACtB,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAiB3C;;;;OAIG;IACG,aAAa,CACjB,MAAM,EAAE,cAAc,EACtB,IAAI,EAAE,YAAY,GAAG,MAAM,EAC3B,EAAE,EAAE,OAAO,EAAE,EACb,KAAK,EAAE;QAAE,YAAY,EAAE,OAAO,CAAA;KAAE,GAC/B,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IA0BlC,uFAAuF;IACvF,WAAW,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,aAAa;IAIzC;;;;OAIG;IACG,SAAS,CACb,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,EACjB,EAAE,EAAE,OAAO,EAAE,GACZ,OAAO,CAAC;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CA0B5C;AAED,2CAA2C;AAC3C,wBAAgB,KAAK,CAAC,IAAI,EAAE,mBAAmB,GAAG,YAAY,CAE7D"}