Skip to content

fix(web-api): remove bounds on assistant.threads.setSuggestedPrompts prompts count in types#2297

Merged
zimeg merged 2 commits into
mainfrom
zimeg-fix-web-api-assistant-suggested-prompts-type
Jul 12, 2025
Merged

fix(web-api): remove bounds on assistant.threads.setSuggestedPrompts prompts count in types#2297
zimeg merged 2 commits into
mainfrom
zimeg-fix-web-api-assistant-suggested-prompts-type

Conversation

@zimeg

@zimeg zimeg commented Jul 11, 2025

Copy link
Copy Markdown
Member

Summary

This PR removes the minimum bounds in types for the assistant.threads.setSuggestedPrompts method prompts property.

Fixes issues noted in slack-samples/bolt-js-assistant-template#46 and slackapi/bolt-js#2506.

Notes

Requirements

@zimeg zimeg added this to the web-api@7.9.4 milestone Jul 11, 2025
@zimeg zimeg self-assigned this Jul 11, 2025
@zimeg zimeg added bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented semver:patch area:typescript issues that specifically impact using the package from typescript projects pkg:web-api applies to `@slack/web-api` labels Jul 11, 2025
@codecov

codecov Bot commented Jul 11, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.71%. Comparing base (d084bfc) to head (875d21c).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2297   +/-   ##
=======================================
  Coverage   92.71%   92.71%           
=======================================
  Files          38       38           
  Lines       10607    10607           
  Branches      683      683           
=======================================
  Hits         9834     9834           
  Misses        761      761           
  Partials       12       12           
Flag Coverage Δ
cli-hooks 95.23% <ø> (ø)
cli-test 94.74% <ø> (ø)
oauth 77.39% <ø> (ø)
socket-mode 61.87% <ø> (ø)
web-api 97.97% <ø> (ø)
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.

@zimeg

zimeg commented Jul 11, 2025

Copy link
Copy Markdown
Member Author

📝 Testing notes for the kind reviewers can use changes to the sample of slack-samples/bolt-js-assistant-template#48 and this PR:

$ npm pack  # Package these changes before testing the sample app
$ cd ~/path/to/bolt-js
$ npm install ../node-slack-sdk/packages/web-api
$ npm pack
$ cd
$ slack create asdf -t slack-samples/bolt-js-assistant-template -b zimeg-fix-suggested-prompts-types
$ cd asdf
$ npm run check                                           # Attempt the type check test
$ npm install ../path/to/node-slack-sdk/packages/web-api  # Install these changes
$ npm run check                                           # Confirm the sample passes the type check

🗣️ Unrelated errors might be addressed in #2296!

@zimeg zimeg linked an issue Jul 11, 2025 that may be closed by this pull request

@WilliamBergamin WilliamBergamin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

:shipit:

@zimeg

zimeg commented Jul 12, 2025

Copy link
Copy Markdown
Member Author

@WilliamBergamin Indeed. 🚢 💨

I'll plan to release this soon and bring similar changes and an update to @slack/bolt for slackapi/bolt-js#2506 🙏

@zimeg zimeg merged commit b363cd3 into main Jul 12, 2025
57 checks passed
@zimeg zimeg deleted the zimeg-fix-web-api-assistant-suggested-prompts-type branch July 12, 2025 01:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:typescript issues that specifically impact using the package from typescript projects bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented pkg:web-api applies to `@slack/web-api` semver:patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Assistant types are difficult to use

2 participants