@cursor/bdk 0.2.2 → 0.2.4

package/src/channels/slack/init.ts

@@ -1,169 +0,0 @@
-/**
- * Scaffold a Slack channel into an agent-serve project.
- *
- * `initSlackChannel` is the create-safe channel writer.
- * only. DIY manifests + Slack CLI `.slack/` live in
- * {@link initSlackManual} so `slack create` cannot reach them.
- */
-
-import { mkdir, writeFile } from "node:fs/promises";
-import { basename, join, resolve } from "node:path";
-import { CLI_COMMAND_NAME as CLI, PACKAGE_NAME } from "../../internal/distribution.js";
-import { projectPath, resolveProjectRoot } from "../../internal/project-layout.js";
-import { writeSlackCliProject } from "./cli-project.js";
-import { envPrefixFromName, slackEnvKeys } from "./credentials.js";
-import { buildSlackManifestPair, slackManifestFileEntries } from "./manifest.js";
-import { initialSlackSetupStatus } from "./setup.js";
-
-export interface InitSlackOptions {
-  dir: string;
-  /** Display name for the Slack app. Defaults to directory basename. */
-  name?: string;
-  /**
-   * Env prefix for tokens (`MY_AGENT` → `MY_AGENT_SLACK_BOT_TOKEN`). Defaults to
-   * the directory basename so multi-agent serve can mount several Slack bots.
-   * Pass `""` to use the shared `SLACK_BOT_TOKEN` / `SLACK_APP_TOKEN` globals.
-   */
-  envPrefix?: string;
-}
-
-export interface InitSlackManualOptions extends InitSlackOptions {
-  description?: string;
-  /**
-   * Subscribe the generated manifests to `message.channels` +
-   * `message.groups` for the opt-in channel watch
-   * (`engagement.channelPosts` on `slackChannel`).
-   */
-  channelPosts?: boolean;
-}
-
-export interface InitSlackResult {
-  rootDir: string;
-  files: string[];
-  envPrefix: string | undefined;
-  envKeys: { bot: string; app: string };
-}
-
-interface SlackInitTarget {
-  rootDir: string;
-  name: string;
-  envPrefix: string | undefined;
-  envKeys: { bot: string; app: string };
-}
-
-function resolveSlackInitTarget(options: InitSlackOptions): SlackInitTarget {
-  const rootDir = resolve(options.dir);
-  const envPrefix =
-    options.envPrefix === ""
-      ? undefined
-      : (options.envPrefix ?? envPrefixFromName(basename(rootDir)));
-  return {
-    rootDir,
-    name: options.name ?? basename(rootDir),
-    envPrefix,
-    envKeys: slackEnvKeys(envPrefix),
-  };
-}
-
-async function writeExclusive(rootDir: string, rel: string, contents: string): Promise<void> {
-  const abs = join(rootDir, rel);
-  await mkdir(join(abs, ".."), { recursive: true });
-  await writeFile(abs, contents, { flag: "wx" });
-}
-
-function slackChannelSource(target: SlackInitTarget, kind: "create" | "manual"): string {
-  const envPrefixLine =
-    target.envPrefix === undefined ? "" : `  envPrefix: ${JSON.stringify(target.envPrefix)},\n`;
-  const tokenLines =
-    kind === "manual"
-      ? ` * Tokens: ${target.envKeys.bot} + ${target.envKeys.app}\n * (see .agent-serve/slack/env.example).`
-      : ` * Tokens: ${target.envKeys.bot} + ${target.envKeys.app}`;
-  const setupLine =
-    kind === "manual"
-      ? ` * Full setup: ${CLI} slack setup`
-      : ` * Full setup: ${CLI} slack create --dir .`;
-  return `import { slackChannel } from "${PACKAGE_NAME}/channels/slack";
-
-/**
- * Slack channel (Socket Mode).
- *
-${tokenLines}
- *
-${setupLine}
- */
-export default slackChannel({
-${envPrefixLine}  // Streaming and thinking steps default to true.
-  suggestedPrompts: [
-    { title: "Help", message: "How can you help me?" },
-    { title: "Status", message: "What are you working on?" },
-  ],
-});
-`;
-}
-
-/** Create-safe: write only the authored Slack channel. */
-export async function initSlackChannel(options: InitSlackOptions): Promise<InitSlackResult> {
-  const target = resolveSlackInitTarget(options);
-  const channelPath = projectPath(resolveProjectRoot(target.rootDir), "channels/slack.ts");
-  await writeExclusive(target.rootDir, channelPath, slackChannelSource(target, "create"));
-  return {
-    rootDir: target.rootDir,
-    files: [channelPath],
-    envPrefix: target.envPrefix,
-    envKeys: target.envKeys,
-  };
-}
-
-/**
- * `slack init --manual`: channel file plus DIY manifests
- * (`managedByCursor: false`), Slack CLI `.slack/` project, env.example,
- * and setup-status.json.
- */
-export async function initSlackManual(options: InitSlackManualOptions): Promise<InitSlackResult> {
-  const target = resolveSlackInitTarget(options);
-  const channelPath = projectPath(resolveProjectRoot(target.rootDir), "channels/slack.ts");
-  const files: string[] = [];
-  const write = async (rel: string, contents: string): Promise<void> => {
-    await writeExclusive(target.rootDir, rel, contents);
-    files.push(rel);
-  };
-
-  await write(channelPath, slackChannelSource(target, "manual"));
-
-  const pair = buildSlackManifestPair({
-    name: target.name,
-    managedByCursor: false,
-    description: options.description,
-    channelPosts: options.channelPosts,
-  });
-  await write(
-    ".agent-serve/slack/env.example",
-    `# Copy to .env.local (or export in your shell). Use the *dev* Slack app
-# for local development; use the Prod app tokens in deployment secrets.
-#
-# Multi-agent serve needs a distinct Slack app (and token pair) per agent.
-
-${target.envKeys.bot}=xoxb-...
-${target.envKeys.app}=xapp-...
-`,
-  );
-  await write(
-    ".agent-serve/slack/setup-status.json",
-    `${JSON.stringify(
-      initialSlackSetupStatus({
-        envPrefix: target.envPrefix,
-        envKeys: target.envKeys,
-      }),
-      null,
-      2,
-    )}\n`,
-  );
-  files.push(...(await writeSlackCliProject(target.rootDir, slackManifestFileEntries(pair))));
-
-  return {
-    rootDir: target.rootDir,
-    files,
-    envPrefix: target.envPrefix,
-    envKeys: target.envKeys,
-  };
-}

package/src/channels/slack/interactive.ts

@@ -1,406 +0,0 @@
-/**
- * Socket Mode interactive payloads (Block Kit clicks).
- *
- * Built-in tool-approval Approve/Deny actions resolve parked calls
- * ({@link dispatchInteractiveFromPayload}); everything else can be routed
- * to an author handler ({@link dispatchBlockAction} via
- * `slackChannel({ onBlockAction })`).
- */
-
-import type { ContinuationIdentity } from "../../internal/continuation-identity.js";
-import { isSlackImChannel } from "../../internal/slack-thread-key.js";
-import type {
-  ApprovalDecision,
-  ArtifactsApi,
-  AuthContext,
-  ChannelSession,
-  HostContext,
-  PendingApproval,
-  PendingAuth,
-  SendMessageFn,
-} from "../../types.js";
-import { updateMessage } from "./api.js";
-import {
-  decisionFromActionId,
-  decisionFromAuthActionId,
-  parseApprovalActionValue,
-} from "./approvals.js";
-import { buildSlackInteractiveApprovalAuth } from "./auth.js";
-import { dispatchInboundMessage } from "./dispatch.js";
-import { isExternalSlackSender } from "./external-policy.js";
-import { defaultSlackLog, type SlackLog } from "./log.js";
-import type {
-  SlackBlockAction,
-  SlackBlockActionHandler,
-  SlackBotToken,
-  SlackContinuationProbes,
-  SlackCredentials,
-  SlackMessage,
-} from "./types.js";
-
-export interface SlackInteractiveDispatchDeps {
-  credentials: SlackCredentials | undefined;
-  getSession: (sessionId: string) => Promise<ChannelSession | null>;
-  resolveApproval: (
-    sessionId: string,
-    callId: string,
-    decision: ApprovalDecision,
-    auth: AuthContext | null,
-  ) => Promise<PendingApproval>;
-  resolveAuth: (
-    sessionId: string,
-    callId: string,
-    decision: ApprovalDecision,
-    auth: AuthContext | null,
-  ) => Promise<PendingAuth>;
-  waitUntil: (promise: Promise<unknown>) => void;
-  log?: SlackLog;
-  /** Defaults to true. */
-  blockExternals?: boolean;
-}
-
-/**
- * Handle a Socket Mode `interactive` body. Returns true when this was
- * an agent-serve approval action (handled or rejected with a reason).
- */
-export async function dispatchInteractiveFromPayload(
-  payload: unknown,
-  deps: SlackInteractiveDispatchDeps,
-): Promise<boolean> {
-  const log = deps.log ?? defaultSlackLog;
-  const parsed = parseSlackBlockAction(payload);
-  if (parsed === null) {
-    return false;
-  }
-
-  const approvalDecision = decisionFromActionId(parsed.actionId);
-  const authDecision = decisionFromAuthActionId(parsed.actionId);
-  const value = parseApprovalActionValue(parsed.value);
-  if (value === null || (approvalDecision === null && authDecision === null)) {
-    return false;
-  }
-  const decision = approvalDecision ?? authDecision;
-  if (decision === null) {
-    return false;
-  }
-  const kind = approvalDecision !== null ? "approval" : "auth";
-
-  log.info("interactive approval", {
-    decision,
-    session: value.sessionId,
-    call_id: value.callId,
-    user: parsed.userId,
-    channel: parsed.channelId,
-  });
-
-  const session = await deps.getSession(value.sessionId);
-  if (session === null) {
-    log.warn("interactive approval: unknown session", {
-      session: value.sessionId,
-    });
-    return true;
-  }
-
-  const attrs = session.info.auth?.attributes ?? {};
-  const sessionChannel = attrs.channel_id ?? "";
-  const sessionThread = attrs.thread_ts ?? "";
-  if (sessionChannel !== "" && parsed.channelId !== "" && sessionChannel !== parsed.channelId) {
-    log.warn("interactive approval: channel mismatch", {
-      session: value.sessionId,
-      expected: sessionChannel,
-      got: parsed.channelId,
-    });
-    return true;
-  }
-  if (
-    !isSlackImChannel(parsed.channelId) &&
-    sessionThread !== "" &&
-    parsed.threadTs !== "" &&
-    sessionThread !== parsed.threadTs
-  ) {
-    log.warn("interactive approval: thread mismatch", {
-      session: value.sessionId,
-      expected: sessionThread,
-      got: parsed.threadTs,
-    });
-    return true;
-  }
-
-  const sessionAuth = session.info.auth;
-  if (sessionAuth === undefined || sessionAuth === null) {
-    log.warn("interactive approval: session has no auth", {
-      session: value.sessionId,
-    });
-    return true;
-  }
-
-  const teamId = attrs.team_id;
-  if (deps.blockExternals !== false && parsed.userId !== "") {
-    if (teamId === undefined || teamId === "") {
-      log.info("interactive approval dropped (missing team)", {
-        session: value.sessionId,
-        user: parsed.userId,
-      });
-      return true;
-    }
-    if (
-      await isExternalSlackSender({
-        botToken: deps.credentials?.botToken,
-        slackTeamId: teamId,
-        userId: parsed.userId,
-      })
-    ) {
-      log.info("interactive approval dropped (external sender)", {
-        session: value.sessionId,
-        user: parsed.userId,
-        team: teamId,
-      });
-      return true;
-    }
-  }
-
-  const clickingAuth = buildSlackInteractiveApprovalAuth({
-    sessionAuth,
-    channelId: parsed.channelId || sessionChannel,
-    threadTs: parsed.threadTs || sessionThread,
-    teamId: teamId === undefined || teamId === "" ? undefined : teamId,
-    clickingUserId: parsed.userId,
-  });
-
-  try {
-    if (kind === "auth") {
-      await deps.resolveAuth(value.sessionId, value.callId, decision, clickingAuth);
-    } else {
-      await deps.resolveApproval(value.sessionId, value.callId, decision, clickingAuth);
-    }
-  } catch (error) {
-    log.warn("interactive approval resolve failed", {
-      session: value.sessionId,
-      call_id: value.callId,
-      error: error instanceof Error ? error.message : String(error),
-    });
-  }
-  return true;
-}
-
-/**
- * Parse a Socket Mode `block_actions` payload into a {@link SlackBlockAction}.
- * Returns null for non-`block_actions` payloads (view submissions, shortcuts)
- * and malformed bodies.
- */
-export function parseSlackBlockAction(payload: unknown): SlackBlockAction | null {
-  if (typeof payload !== "object" || payload === null) {
-    return null;
-  }
-  const record = payload as Record<string, unknown>;
-  if (record.type !== "block_actions") {
-    return null;
-  }
-  const actions = record.actions;
-  if (!Array.isArray(actions) || actions.length === 0) {
-    return null;
-  }
-  const first = actions[0];
-  if (typeof first !== "object" || first === null) {
-    return null;
-  }
-  const action = first as Record<string, unknown>;
-  if (typeof action.action_id !== "string") {
-    return null;
-  }
-
-  const channel =
-    typeof record.channel === "object" && record.channel !== null
-      ? (record.channel as Record<string, unknown>)
-      : {};
-  const message =
-    typeof record.message === "object" && record.message !== null
-      ? (record.message as Record<string, unknown>)
-      : {};
-  const user =
-    typeof record.user === "object" && record.user !== null
-      ? (record.user as Record<string, unknown>)
-      : {};
-  const team =
-    typeof record.team === "object" && record.team !== null
-      ? (record.team as Record<string, unknown>)
-      : {};
-
-  const channelId = typeof channel.id === "string" ? channel.id : "";
-  const messageTs = typeof message.ts === "string" ? message.ts : "";
-  const threadTs =
-    typeof message.thread_ts === "string"
-      ? message.thread_ts
-      : typeof record.container === "object" &&
-          record.container !== null &&
-          typeof (record.container as { thread_ts?: unknown }).thread_ts === "string"
-        ? (record.container as { thread_ts: string }).thread_ts
-        : messageTs;
-  const userId = typeof user.id === "string" ? user.id : "";
-  const userName =
-    typeof user.username === "string"
-      ? user.username
-      : typeof user.name === "string"
-        ? user.name
-        : undefined;
-  // Payload `team.id` only — never `user.team_id` (Connect home team).
-  // Membership gates must baseline the install workspace separately.
-  const teamId = typeof team.id === "string" ? team.id : undefined;
-  const label =
-    typeof action.text === "object" &&
-    action.text !== null &&
-    typeof (action.text as { text?: unknown }).text === "string"
-      ? (action.text as { text: string }).text
-      : undefined;
-  const actionTs = typeof action.action_ts === "string" ? action.action_ts : "";
-  const messageBlocks = Array.isArray(message.blocks) ? message.blocks : undefined;
-
-  return {
-    actionId: action.action_id,
-    blockId: typeof action.block_id === "string" ? action.block_id : "",
-    value: typeof action.value === "string" ? action.value : "",
-    label,
-    channelId,
-    threadTs,
-    messageTs,
-    messageBlocks,
-    userId,
-    userName,
-    teamId,
-    actionTs,
-  };
-}
-
-/**
- * Swap the clicked message's actions row for a context note (`chat.update`).
- * Strips only the row the click came from (`action.blockId`); every other
- * block survives. Soft: false when the payload carried no message blocks or
- * the update failed — callers treat the dispatched turn as the durable
- * record and the card as best-effort UI.
- */
-export async function resolveBlockActionCard(args: {
-  botToken: SlackBotToken | undefined;
-  action: SlackBlockAction;
-  note: string;
-}): Promise<boolean> {
-  const { action, note } = args;
-  if (action.messageBlocks === undefined) {
-    return false;
-  }
-  const clicked = (block: unknown): boolean =>
-    typeof block === "object" &&
-    block !== null &&
-    (block as { type?: unknown }).type === "actions" &&
-    (block as { block_id?: unknown }).block_id === action.blockId;
-  const result = await updateMessage({
-    botToken: args.botToken,
-    channel: action.channelId,
-    ts: action.messageTs,
-    text: note,
-    blocks: [
-      ...action.messageBlocks.filter(block => !clicked(block)),
-      { type: "context", elements: [{ type: "mrkdwn", text: note }] },
-    ],
-  });
-  return result.ok;
-}
-
-export interface SlackBlockActionDispatchDeps extends SlackContinuationProbes {
-  handler: SlackBlockActionHandler;
-  send: SendMessageFn;
-  continuation?: ContinuationIdentity;
-  credentials: SlackCredentials | undefined;
-  host: HostContext;
-  artifacts: ArtifactsApi;
-  log?: SlackLog;
-  /** Defaults to true. */
-  blockExternals?: boolean;
-  /** Install workspace from `auth.test`; baseline for the external gate. */
-  installTeamId?: string;
-}
-
-/**
- * The click as an inbound-message stand-in: the synthetic ts is the click's
- * `action_ts` (unique per click, never a real thread message), so ask-dedupe
- * claims and `<slack_thread>` exclusions stay per-click.
- */
-function blockActionAsMessage(
-  action: SlackBlockAction,
-  installTeamId: string | undefined,
-): SlackMessage {
-  const text = `[clicked: ${action.label ?? action.actionId}]`;
-  return {
-    text,
-    body: text,
-    markdown: text,
-    ts: action.actionTs,
-    threadTs: action.threadTs,
-    channelId: action.channelId,
-    teamId: installTeamId,
-    author: {
-      userId: action.userId,
-      userName: action.userName,
-      isBot: false,
-    },
-  };
-}
-
-/**
- * Route a non-approval `block_actions` payload to the author handler and
- * dispatch its decision as a turn on the click's thread. Returns true when
- * the payload was a block action (dispatched or deliberately skipped).
- */
-export async function dispatchBlockAction(
-  payload: unknown,
-  deps: SlackBlockActionDispatchDeps,
-): Promise<boolean> {
-  const log = deps.log ?? defaultSlackLog;
-  const action = parseSlackBlockAction(payload);
-  if (action === null) {
-    return false;
-  }
-  if (action.channelId === "" || action.threadTs === "") {
-    log.warn("block action skipped (no conversation)", {
-      action_id: action.actionId,
-      user: action.userId,
-    });
-    return true;
-  }
-  // Slack stamps every real click; without one the synthetic message ts
-  // would alias another click's dedupe claim.
-  if (action.actionTs === "") {
-    log.warn("block action skipped (no action_ts)", {
-      action_id: action.actionId,
-      user: action.userId,
-    });
-    return true;
-  }
-
-  log.info("block action", {
-    action_id: action.actionId,
-    channel: action.channelId,
-    thread_ts: action.threadTs,
-    message_ts: action.messageTs,
-    user: action.userId,
-  });
-
-  await dispatchInboundMessage({
-    kind: "block_action",
-    message: blockActionAsMessage(action, deps.installTeamId),
-    handler: ctx => deps.handler(ctx, action),
-    send: deps.send,
-    credentials: deps.credentials,
-    host: deps.host,
-    artifacts: deps.artifacts,
-    log,
-    // Click text is synthetic — never treat it as a stop/eval directive.
-    evalCommandsEnabled: false,
-    blockExternals: deps.blockExternals,
-    hasContinuationSession: deps.hasContinuationSession,
-    isContinuationBusy: deps.isContinuationBusy,
-    getContinuationLastBotMessageTs: deps.getContinuationLastBotMessageTs,
-    interruptContinuation: deps.interruptContinuation,
-    ...(deps.continuation === undefined ? {} : { continuation: deps.continuation }),
-  });
-  return true;
-}

package/src/channels/slack/links.ts

@@ -1,23 +0,0 @@
-/**
- * Slack deep links for threads / messages.
- */
-
-/** Build a web permalink that opens a Slack thread in the browser. */
-export function slackThreadPermalink(args: {
-  channelId: string;
-  threadTs: string;
-  teamId?: string;
-}): string | null {
-  const channelId = args.channelId.trim();
-  const threadTs = args.threadTs.trim();
-  if (channelId === "" || threadTs === "") {
-    return null;
-  }
-  const teamId = args.teamId?.trim();
-  if (teamId !== undefined && teamId !== "" && teamId !== "unknown") {
-    // Client deep link opens the thread pane in the right workspace.
-    return `https://app.slack.com/client/${encodeURIComponent(teamId)}/${encodeURIComponent(channelId)}/thread/${encodeURIComponent(channelId)}-${encodeURIComponent(threadTs)}`;
-  }
-  const pTs = `p${threadTs.replace(".", "")}`;
-  return `https://app.slack.com/archives/${encodeURIComponent(channelId)}/${pTs}?thread_ts=${encodeURIComponent(threadTs)}`;
-}