@mastra/slack 1.2.1 → 1.3.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { Mastra } from '@mastra/core/mastra';
-import { ChannelAdapterConfig, ChannelConfig, ChannelHandlers, ChannelProvider, ChannelConnectResult, ChannelInstallationInfo, ChannelPlatformInfo } from '@mastra/core/channels';
+import { ChannelAdapterConfig, StreamingConfig, ToolDisplay, StaticToolDisplay, ChannelHandlers, ChannelConfig, ChannelProvider, ChannelConnectResult, ChannelInstallationInfo, ChannelPlatformInfo } from '@mastra/core/channels';
 import { ApiRoute } from '@mastra/core/server';
 import { SlackAdapterConfig, SlackAdapter } from '@chat-adapter/slack';
 export { SlackAdapter, createSlackAdapter } from '@chat-adapter/slack';
@@ -104,28 +104,102 @@ interface SlackConfigTokens {
 }
 
 /**
- * Per-adapter overrides forwarded to the SlackAdapter entry inside
- * `AgentChannels.adapters` — equivalent to passing
- * `{ adapter, ...adapterConfig }` when wiring up `AgentChannels` manually.
- * The `adapter` instance itself is created by the provider.
+ * Per-adapter overrides shared across both streaming and static branches
+ * of {@link SlackAdapterChannelConfig}.
  */
-type SlackAdapterChannelConfig = Omit<ChannelAdapterConfig, 'adapter'>;
-/** AgentChannels fields that the provider forwards. `adapters` and `userName` are provider-managed. */
-type ForwardedAgentChannelsOptions = Pick<ChannelConfig, 'inlineMedia' | 'inlineLinks' | 'state' | 'threadContext' | 'tools' | 'chatOptions'>;
+interface SlackAdapterChannelConfigBase {
+    /** CORS configuration for the Slack webhook route. */
+    cors?: ChannelAdapterConfig['cors'];
+    /** Slack gateway listener toggle. Currently a no-op for Slack (HTTP-only). */
+    gateway?: ChannelAdapterConfig['gateway'];
+    /** Override how errors are rendered in Slack messages. */
+    formatError?: ChannelAdapterConfig['formatError'];
+    /**
+     * Control Slack typing indicators and Assistant-mode status text.
+     *
+     * - `true` — use built-in defaults: `"is typing…"` while generating text,
+     *   `"is calling {toolName}…"` while a tool runs, `"is waiting for
+     *   approval…"` while a tool is suspended. Slack auto-prepends the app
+     *   name so the user sees `"<App Name> is typing…"`.
+     * - `false` — never call `startTyping`. Useful when a live streaming
+     *   widget (e.g. `toolDisplay: 'grouped'`) already conveys progress.
+     * - `(chunk, ctx) => string | false | null | undefined | void` — set
+     *   custom copy per chunk. Return a string to override the status,
+     *   or `false`/`null`/`undefined` to leave it unchanged. Compose with
+     *   `defaultTypingStatus` (exported from `@mastra/core/channels`) to
+     *   fall back to defaults for chunks you don't handle.
+     *
+     * @default true
+     */
+    typingStatus?: ChannelAdapterConfig['typingStatus'];
+}
 /**
- * Configuration for SlackProvider at the Mastra level.
- *
- * In addition to the provider-specific fields documented below, this accepts
- * options that are forwarded to the underlying `AgentChannels` instances
- * managed by the provider — for example `handlers`, `inlineMedia`, and
- * `adapterConfig`.
+ * Slack adapter overrides with `streaming` enabled (the default). Allows any
+ * `toolDisplay` mode, including the streaming-only `'timeline'` / `'grouped'`.
  */
-interface SlackProviderConfig extends ForwardedAgentChannelsOptions {
+interface SlackAdapterStreamingConfig extends SlackAdapterChannelConfigBase {
     /**
-     * Logger forwarded to the underlying `SlackAdapter` for internal error
-     * reporting. Defaults to the adapter's `ConsoleLogger`.
+     * Stream agent text deltas to Slack as the agent generates them.
+     *
+     * - `true` (default) — stream with default options.
+     * - `{ updateIntervalMs }` — stream with a custom post-and-edit interval.
+     *
+     * @default true
      */
-    logger?: SlackAdapterConfig['logger'];
+    streaming?: Exclude<StreamingConfig, false>;
+    /**
+     * How tool calls are rendered in Slack.
+     *
+     * - `'cards'` — per-tool "Running…" → "Result" Block Kit cards (the streaming
+     *   session is closed/posted/reopened around each card).
+     * - `'text'` — per-tool plain-text messages (no Block Kit).
+     * - `'timeline'` — render tools as inline task entries beside the streaming text.
+     * - `'grouped'` (default in Slack) — collapse all tools into a single
+     *   "Thinking Steps" plan widget. Renders well in Slack's AI Assistant UI.
+     * - `'hidden'` — execute tools silently; only the typing status indicates work.
+     * - Function form ({@link ToolDisplay}): a `ToolDisplayFn` for full control.
+     *
+     * Approve/deny prompts (`requireApproval`) always render as a separate card.
+     *
+     * @default 'grouped'
+     */
+    toolDisplay?: ToolDisplay;
+}
+/**
+ * Slack adapter overrides with `streaming: false`. Restricts `toolDisplay`
+ * to modes that post discrete messages (no `StreamingPlan` available).
+ */
+interface SlackAdapterStaticConfig extends SlackAdapterChannelConfigBase {
+    /**
+     * Disable Slack's native message streaming and buffer text until `step-finish`.
+     * `'timeline'` and `'grouped'` modes require streaming, so they're not
+     * available on this branch.
+     */
+    streaming: false;
+    /**
+     * How tool calls are rendered in Slack (static modes only).
+     *
+     * - `'cards'` (default) — per-tool "Running…" → "Result" Block Kit cards.
+     * - `'text'` — per-tool plain-text messages (no Block Kit).
+     * - `'hidden'` — execute tools silently; only the typing status indicates work.
+     * - Function form ({@link ToolDisplay}): a `ToolDisplayFn` for full control.
+     *
+     * @default 'cards'
+     */
+    toolDisplay?: StaticToolDisplay;
+}
+/**
+ * Per-adapter overrides applied to the Slack entry inside
+ * `AgentChannels.adapters`. `streaming` discriminates which `toolDisplay`
+ * modes are available — `'timeline'` / `'grouped'` need streaming on.
+ */
+type SlackAdapterChannelConfig = SlackAdapterStreamingConfig | SlackAdapterStaticConfig;
+/**
+ * Slack provider fields that are independent of the `streaming` /
+ * `toolDisplay` discrimination — shared by both branches of
+ * {@link SlackProviderConfig}.
+ */
+interface SlackProviderConfigBase extends SlackAdapterChannelConfigBase {
     /**
      * Override built-in event handlers (e.g. `onDirectMessage`, `onMention`).
      * Forwarded to `AgentChannels` for every agent connected via this provider.
@@ -141,12 +215,23 @@ interface SlackProviderConfig extends ForwardedAgentChannelsOptions {
      * ```
      */
     handlers?: ChannelHandlers;
+    /** Which media types to send inline to the model. See `ChannelConfig.inlineMedia`. */
+    inlineMedia?: ChannelConfig['inlineMedia'];
+    /** Promote URLs in message text to file parts. See `ChannelConfig.inlineLinks`. */
+    inlineLinks?: ChannelConfig['inlineLinks'];
+    /** State adapter for deduplication, locking, and subscriptions. */
+    state?: ChannelConfig['state'];
+    /** Fetch recent thread messages from Slack when the agent joins mid-conversation. */
+    threadContext?: ChannelConfig['threadContext'];
+    /** Whether to include channel tools (add_reaction, remove_reaction). */
+    tools?: ChannelConfig['tools'];
+    /** Additional options passed directly to the Chat SDK. */
+    chatOptions?: ChannelConfig['chatOptions'];
     /**
-     * Per-adapter overrides applied to the Slack adapter entry inside
-     * `AgentChannels.adapters` — for example `cards`, `formatToolCall`,
-     * `formatError`.
+     * Logger forwarded to the underlying `SlackAdapter` for internal error
+     * reporting. Defaults to the adapter's `ConsoleLogger`.
      */
-    adapterConfig?: SlackAdapterChannelConfig;
+    logger?: SlackAdapterConfig['logger'];
     /**
      * Slack App Configuration access token for programmatic app creation.
      * Generate at: https://api.slack.com/apps > "Your App Configuration Tokens"
@@ -196,7 +281,69 @@ interface SlackProviderConfig extends ForwardedAgentChannelsOptions {
      * Use a 32+ character random string. Can be set via MASTRA_ENCRYPTION_KEY env var.
      */
     encryptionKey?: string;
+    /**
+     * Per-adapter overrides applied to the Slack adapter entry inside
+     * `AgentChannels.adapters` — for example `toolDisplay`, `streaming`,
+     * `formatError`.
+     *
+     * @deprecated Pass these fields at the top level of `SlackProviderConfig`
+     * instead. Top-level fields win; values from `adapterConfig` are merged in
+     * as a fallback for backwards compatibility.
+     */
+    adapterConfig?: SlackAdapterChannelConfig;
 }
+/**
+ * Slack provider configuration with `streaming` enabled (the default).
+ * Allows any `toolDisplay` mode.
+ */
+interface SlackProviderStreamingConfig extends SlackProviderConfigBase {
+    /**
+     * Stream agent text deltas to Slack as the agent generates them.
+     *
+     * - `true` (default) — stream with default options.
+     * - `{ updateIntervalMs }` — stream with a custom post-and-edit interval.
+     *
+     * @default true
+     */
+    streaming?: Exclude<StreamingConfig, false>;
+    /**
+     * How tool calls are rendered in Slack. See {@link SlackAdapterStreamingConfig#toolDisplay}.
+     *
+     * @default 'grouped'
+     */
+    toolDisplay?: ToolDisplay;
+}
+/**
+ * Slack provider configuration with `streaming: false`. Restricts
+ * `toolDisplay` to modes that post discrete messages.
+ */
+interface SlackProviderStaticConfig extends SlackProviderConfigBase {
+    /**
+     * Disable Slack's native message streaming and buffer text until `step-finish`.
+     * `'timeline'` and `'grouped'` modes require streaming, so they're not
+     * available on this branch.
+     */
+    streaming: false;
+    /**
+     * How tool calls are rendered in Slack (static modes only). See
+     * {@link SlackAdapterStaticConfig#toolDisplay}.
+     *
+     * @default 'cards'
+     */
+    toolDisplay?: StaticToolDisplay;
+}
+/**
+ * Configuration for SlackProvider at the Mastra level.
+ *
+ * Combines Slack-specific fields (tokens, baseUrl, OAuth callbacks),
+ * Slack-adapter overrides (`toolDisplay`, `streaming`, `typingStatus`, …), and a
+ * curated subset of `AgentChannels` options forwarded to every connected agent
+ * (`handlers`, `inlineMedia`, `inlineLinks`, …).
+ *
+ * `streaming` discriminates which `toolDisplay` modes are available —
+ * `'timeline'` / `'grouped'` need streaming on.
+ */
+type SlackProviderConfig = SlackProviderStreamingConfig | SlackProviderStaticConfig;
 /**
  * Options for connecting an agent to Slack via `slack.connect(agentId, options)`.
  * This is serializable and can be stored in the database for stored agents.
@@ -346,6 +493,13 @@ interface SlackAppManifest {
             url: string;
             usage_hint?: string;
         }>;
+        assistant_view?: {
+            assistant_description: string;
+            suggested_prompts?: Array<{
+                title: string;
+                message: string;
+            }>;
+        };
     };
     oauth_config?: {
         redirect_urls?: string[];
@@ -591,7 +745,7 @@ interface SlashCommand {
 /**
  * Default bot scopes required for agent functionality.
  */
-declare const DEFAULT_BOT_SCOPES: readonly ["chat:write", "chat:write.public", "im:write", "channels:history", "channels:read", "groups:history", "groups:read", "im:history", "im:read", "mpim:history", "mpim:read", "app_mentions:read", "users:read", "reactions:write", "files:read"];
+declare const DEFAULT_BOT_SCOPES: readonly ["chat:write", "chat:write.public", "im:write", "channels:history", "channels:read", "groups:history", "groups:read", "im:history", "im:read", "mpim:history", "mpim:read", "app_mentions:read", "users:read", "reactions:write", "files:read", "assistant:write"];
 /**
  * Default bot events to subscribe to.
  */

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Mastra } from '@mastra/core/mastra';
-import { ChannelAdapterConfig, ChannelConfig, ChannelHandlers, ChannelProvider, ChannelConnectResult, ChannelInstallationInfo, ChannelPlatformInfo } from '@mastra/core/channels';
+import { ChannelAdapterConfig, StreamingConfig, ToolDisplay, StaticToolDisplay, ChannelHandlers, ChannelConfig, ChannelProvider, ChannelConnectResult, ChannelInstallationInfo, ChannelPlatformInfo } from '@mastra/core/channels';
 import { ApiRoute } from '@mastra/core/server';
 import { SlackAdapterConfig, SlackAdapter } from '@chat-adapter/slack';
 export { SlackAdapter, createSlackAdapter } from '@chat-adapter/slack';
@@ -104,28 +104,102 @@ interface SlackConfigTokens {
 }
 
 /**
- * Per-adapter overrides forwarded to the SlackAdapter entry inside
- * `AgentChannels.adapters` — equivalent to passing
- * `{ adapter, ...adapterConfig }` when wiring up `AgentChannels` manually.
- * The `adapter` instance itself is created by the provider.
+ * Per-adapter overrides shared across both streaming and static branches
+ * of {@link SlackAdapterChannelConfig}.
  */
-type SlackAdapterChannelConfig = Omit<ChannelAdapterConfig, 'adapter'>;
-/** AgentChannels fields that the provider forwards. `adapters` and `userName` are provider-managed. */
-type ForwardedAgentChannelsOptions = Pick<ChannelConfig, 'inlineMedia' | 'inlineLinks' | 'state' | 'threadContext' | 'tools' | 'chatOptions'>;
+interface SlackAdapterChannelConfigBase {
+    /** CORS configuration for the Slack webhook route. */
+    cors?: ChannelAdapterConfig['cors'];
+    /** Slack gateway listener toggle. Currently a no-op for Slack (HTTP-only). */
+    gateway?: ChannelAdapterConfig['gateway'];
+    /** Override how errors are rendered in Slack messages. */
+    formatError?: ChannelAdapterConfig['formatError'];
+    /**
+     * Control Slack typing indicators and Assistant-mode status text.
+     *
+     * - `true` — use built-in defaults: `"is typing…"` while generating text,
+     *   `"is calling {toolName}…"` while a tool runs, `"is waiting for
+     *   approval…"` while a tool is suspended. Slack auto-prepends the app
+     *   name so the user sees `"<App Name> is typing…"`.
+     * - `false` — never call `startTyping`. Useful when a live streaming
+     *   widget (e.g. `toolDisplay: 'grouped'`) already conveys progress.
+     * - `(chunk, ctx) => string | false | null | undefined | void` — set
+     *   custom copy per chunk. Return a string to override the status,
+     *   or `false`/`null`/`undefined` to leave it unchanged. Compose with
+     *   `defaultTypingStatus` (exported from `@mastra/core/channels`) to
+     *   fall back to defaults for chunks you don't handle.
+     *
+     * @default true
+     */
+    typingStatus?: ChannelAdapterConfig['typingStatus'];
+}
 /**
- * Configuration for SlackProvider at the Mastra level.
- *
- * In addition to the provider-specific fields documented below, this accepts
- * options that are forwarded to the underlying `AgentChannels` instances
- * managed by the provider — for example `handlers`, `inlineMedia`, and
- * `adapterConfig`.
+ * Slack adapter overrides with `streaming` enabled (the default). Allows any
+ * `toolDisplay` mode, including the streaming-only `'timeline'` / `'grouped'`.
  */
-interface SlackProviderConfig extends ForwardedAgentChannelsOptions {
+interface SlackAdapterStreamingConfig extends SlackAdapterChannelConfigBase {
     /**
-     * Logger forwarded to the underlying `SlackAdapter` for internal error
-     * reporting. Defaults to the adapter's `ConsoleLogger`.
+     * Stream agent text deltas to Slack as the agent generates them.
+     *
+     * - `true` (default) — stream with default options.
+     * - `{ updateIntervalMs }` — stream with a custom post-and-edit interval.
+     *
+     * @default true
      */
-    logger?: SlackAdapterConfig['logger'];
+    streaming?: Exclude<StreamingConfig, false>;
+    /**
+     * How tool calls are rendered in Slack.
+     *
+     * - `'cards'` — per-tool "Running…" → "Result" Block Kit cards (the streaming
+     *   session is closed/posted/reopened around each card).
+     * - `'text'` — per-tool plain-text messages (no Block Kit).
+     * - `'timeline'` — render tools as inline task entries beside the streaming text.
+     * - `'grouped'` (default in Slack) — collapse all tools into a single
+     *   "Thinking Steps" plan widget. Renders well in Slack's AI Assistant UI.
+     * - `'hidden'` — execute tools silently; only the typing status indicates work.
+     * - Function form ({@link ToolDisplay}): a `ToolDisplayFn` for full control.
+     *
+     * Approve/deny prompts (`requireApproval`) always render as a separate card.
+     *
+     * @default 'grouped'
+     */
+    toolDisplay?: ToolDisplay;
+}
+/**
+ * Slack adapter overrides with `streaming: false`. Restricts `toolDisplay`
+ * to modes that post discrete messages (no `StreamingPlan` available).
+ */
+interface SlackAdapterStaticConfig extends SlackAdapterChannelConfigBase {
+    /**
+     * Disable Slack's native message streaming and buffer text until `step-finish`.
+     * `'timeline'` and `'grouped'` modes require streaming, so they're not
+     * available on this branch.
+     */
+    streaming: false;
+    /**
+     * How tool calls are rendered in Slack (static modes only).
+     *
+     * - `'cards'` (default) — per-tool "Running…" → "Result" Block Kit cards.
+     * - `'text'` — per-tool plain-text messages (no Block Kit).
+     * - `'hidden'` — execute tools silently; only the typing status indicates work.
+     * - Function form ({@link ToolDisplay}): a `ToolDisplayFn` for full control.
+     *
+     * @default 'cards'
+     */
+    toolDisplay?: StaticToolDisplay;
+}
+/**
+ * Per-adapter overrides applied to the Slack entry inside
+ * `AgentChannels.adapters`. `streaming` discriminates which `toolDisplay`
+ * modes are available — `'timeline'` / `'grouped'` need streaming on.
+ */
+type SlackAdapterChannelConfig = SlackAdapterStreamingConfig | SlackAdapterStaticConfig;
+/**
+ * Slack provider fields that are independent of the `streaming` /
+ * `toolDisplay` discrimination — shared by both branches of
+ * {@link SlackProviderConfig}.
+ */
+interface SlackProviderConfigBase extends SlackAdapterChannelConfigBase {
     /**
      * Override built-in event handlers (e.g. `onDirectMessage`, `onMention`).
      * Forwarded to `AgentChannels` for every agent connected via this provider.
@@ -141,12 +215,23 @@ interface SlackProviderConfig extends ForwardedAgentChannelsOptions {
      * ```
      */
     handlers?: ChannelHandlers;
+    /** Which media types to send inline to the model. See `ChannelConfig.inlineMedia`. */
+    inlineMedia?: ChannelConfig['inlineMedia'];
+    /** Promote URLs in message text to file parts. See `ChannelConfig.inlineLinks`. */
+    inlineLinks?: ChannelConfig['inlineLinks'];
+    /** State adapter for deduplication, locking, and subscriptions. */
+    state?: ChannelConfig['state'];
+    /** Fetch recent thread messages from Slack when the agent joins mid-conversation. */
+    threadContext?: ChannelConfig['threadContext'];
+    /** Whether to include channel tools (add_reaction, remove_reaction). */
+    tools?: ChannelConfig['tools'];
+    /** Additional options passed directly to the Chat SDK. */
+    chatOptions?: ChannelConfig['chatOptions'];
     /**
-     * Per-adapter overrides applied to the Slack adapter entry inside
-     * `AgentChannels.adapters` — for example `cards`, `formatToolCall`,
-     * `formatError`.
+     * Logger forwarded to the underlying `SlackAdapter` for internal error
+     * reporting. Defaults to the adapter's `ConsoleLogger`.
      */
-    adapterConfig?: SlackAdapterChannelConfig;
+    logger?: SlackAdapterConfig['logger'];
     /**
      * Slack App Configuration access token for programmatic app creation.
      * Generate at: https://api.slack.com/apps > "Your App Configuration Tokens"
@@ -196,7 +281,69 @@ interface SlackProviderConfig extends ForwardedAgentChannelsOptions {
      * Use a 32+ character random string. Can be set via MASTRA_ENCRYPTION_KEY env var.
      */
     encryptionKey?: string;
+    /**
+     * Per-adapter overrides applied to the Slack adapter entry inside
+     * `AgentChannels.adapters` — for example `toolDisplay`, `streaming`,
+     * `formatError`.
+     *
+     * @deprecated Pass these fields at the top level of `SlackProviderConfig`
+     * instead. Top-level fields win; values from `adapterConfig` are merged in
+     * as a fallback for backwards compatibility.
+     */
+    adapterConfig?: SlackAdapterChannelConfig;
 }
+/**
+ * Slack provider configuration with `streaming` enabled (the default).
+ * Allows any `toolDisplay` mode.
+ */
+interface SlackProviderStreamingConfig extends SlackProviderConfigBase {
+    /**
+     * Stream agent text deltas to Slack as the agent generates them.
+     *
+     * - `true` (default) — stream with default options.
+     * - `{ updateIntervalMs }` — stream with a custom post-and-edit interval.
+     *
+     * @default true
+     */
+    streaming?: Exclude<StreamingConfig, false>;
+    /**
+     * How tool calls are rendered in Slack. See {@link SlackAdapterStreamingConfig#toolDisplay}.
+     *
+     * @default 'grouped'
+     */
+    toolDisplay?: ToolDisplay;
+}
+/**
+ * Slack provider configuration with `streaming: false`. Restricts
+ * `toolDisplay` to modes that post discrete messages.
+ */
+interface SlackProviderStaticConfig extends SlackProviderConfigBase {
+    /**
+     * Disable Slack's native message streaming and buffer text until `step-finish`.
+     * `'timeline'` and `'grouped'` modes require streaming, so they're not
+     * available on this branch.
+     */
+    streaming: false;
+    /**
+     * How tool calls are rendered in Slack (static modes only). See
+     * {@link SlackAdapterStaticConfig#toolDisplay}.
+     *
+     * @default 'cards'
+     */
+    toolDisplay?: StaticToolDisplay;
+}
+/**
+ * Configuration for SlackProvider at the Mastra level.
+ *
+ * Combines Slack-specific fields (tokens, baseUrl, OAuth callbacks),
+ * Slack-adapter overrides (`toolDisplay`, `streaming`, `typingStatus`, …), and a
+ * curated subset of `AgentChannels` options forwarded to every connected agent
+ * (`handlers`, `inlineMedia`, `inlineLinks`, …).
+ *
+ * `streaming` discriminates which `toolDisplay` modes are available —
+ * `'timeline'` / `'grouped'` need streaming on.
+ */
+type SlackProviderConfig = SlackProviderStreamingConfig | SlackProviderStaticConfig;
 /**
  * Options for connecting an agent to Slack via `slack.connect(agentId, options)`.
  * This is serializable and can be stored in the database for stored agents.
@@ -346,6 +493,13 @@ interface SlackAppManifest {
             url: string;
             usage_hint?: string;
         }>;
+        assistant_view?: {
+            assistant_description: string;
+            suggested_prompts?: Array<{
+                title: string;
+                message: string;
+            }>;
+        };
     };
     oauth_config?: {
         redirect_urls?: string[];
@@ -591,7 +745,7 @@ interface SlashCommand {
 /**
  * Default bot scopes required for agent functionality.
  */
-declare const DEFAULT_BOT_SCOPES: readonly ["chat:write", "chat:write.public", "im:write", "channels:history", "channels:read", "groups:history", "groups:read", "im:history", "im:read", "mpim:history", "mpim:read", "app_mentions:read", "users:read", "reactions:write", "files:read"];
+declare const DEFAULT_BOT_SCOPES: readonly ["chat:write", "chat:write.public", "im:write", "channels:history", "channels:read", "groups:history", "groups:read", "im:history", "im:read", "mpim:history", "mpim:read", "app_mentions:read", "users:read", "reactions:write", "files:read", "assistant:write"];
 /**
  * Default bot events to subscribe to.
  */