Skip to content

Comments

feat(web-api): add chat.{appendStream|startStream|stopStream} methods#2362

Merged
zimeg merged 1 commit intoai-appsfrom
zimeg-feat-web-api-chat-stream-methods
Sep 10, 2025
Merged

feat(web-api): add chat.{appendStream|startStream|stopStream} methods#2362
zimeg merged 1 commit intoai-appsfrom
zimeg-feat-web-api-chat-stream-methods

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Sep 9, 2025

Summary

This PR adds the chat.{appendStream|startStream|stopStream} methods to @slack/web-api 👾 ✨

Preview

const response1 = await client.chat.startStream({
  channel: "C0123456789",
});
const response2 = await client.chat.appendStream({
  channel: "C0123456789",
  ts: "0123456789.00001",
  markdown_text: "hello",
});
const response3 = await client.chat.stopStream({
  channel: "C0123456789",
  ts: "0123456789.00001",
});

Requirements

@zimeg zimeg requested a review from mwbrooks September 9, 2025 23:15
@zimeg zimeg self-assigned this Sep 9, 2025
@zimeg zimeg added semver:minor enhancement M-T: A feature request for new functionality pkg:web-api applies to `@slack/web-api` labels Sep 9, 2025
@codecov
Copy link

codecov bot commented Sep 9, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.78%. Comparing base (893a37d) to head (4df11a2).
⚠️ Report is 1 commits behind head on ai-apps.

Additional details and impacted files 
@@             Coverage Diff             @@
##           ai-apps    #2362      +/-   ##
===========================================
+ Coverage    92.77%   92.78%   +0.01%     
===========================================
  Files           39       39              
  Lines        10693    10711      +18     
  Branches       692      692              
===========================================
+ Hits          9920     9938      +18     
  Misses         761      761              
  Partials        12       12
Flag Coverage Δ
cli-hooks 95.23% <ø> (ø)
cli-test 94.80% <ø> (ø)
oauth 77.39% <ø> (ø)
socket-mode 61.87% <ø> (ø)
web-api 98.00% <100.00%> (+<0.01%) ⬆️
webhook 96.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

mwbrooks
mwbrooks reviewed Sep 9, 2025
View reviewed changes
Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙌🏻 Looking awesome! We paired on this and while reviewing the PR, we noticed that the chat.stopStream response should also include a message object. I've left a comment about it in the code.

packages/web-api/src/types/response/ChatStopStreamResponse.ts
@@ -0,0 +1,9 @@
import type { WebAPICallResult } from '../../WebClient';
export type ChatStopStreamResponse = WebAPICallResult & {
Copy link
Member

@mwbrooks mwbrooks Sep 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Looking at the reference, we'll also want a message object type that includes a streaming_state string.

mwbrooks
mwbrooks approved these changes Sep 10, 2025
View reviewed changes
Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Approving! We've decided to follow-up on streaming_state because it must be added to both the chat.stopStream method and the message_changed event.

@zimeg
Copy link
Member Author

zimeg commented Sep 10, 2025

@mwbrooks Sweet! Thanks for keeping note of what's needed next 🏁 ✨

I'll merge this now to keep our changesets clear, but think the streaming_state parameter in the method response is useful before prereleases and such. I'm also curious if this appears in responses from the start stream method too but haven't found options other than:

  • "in_progress" for the message_changed event
  • "completed" from the chat.stopStream method

@zimeg zimeg merged commit dd6c548 into ai-apps Sep 10, 2025
57 checks passed
@zimeg zimeg deleted the zimeg-feat-web-api-chat-stream-methods branch September 10, 2025 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mwbrooks mwbrooks mwbrooks approved these changes

Assignees

@zimeg zimeg

Labels

enhancement M-T: A feature request for new functionality pkg:web-api applies to `@slack/web-api` semver:minor

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@zimeg @mwbrooks