node-slack-sdk icon indicating copy to clipboard operation
node-slack-sdk copied to clipboard

Incomplete types for ChatUnfurlArguments

Open modestfake opened this issue 2 years ago • 1 comments

According to documentation chat.unfurl accepts either unfurl_id and source or channel and ts. But ChatUnfurlArguments type misses unfurl_id and source params (source).

Packages:

Select all that apply:

  • [x] @slack/web-api
  • [ ] @slack/rtm-api
  • [ ] @slack/webhooks
  • [ ] @slack/oauth
  • [ ] @slack/socket-mode
  • [ ] @slack/types
  • [ ] I don't know

modestfake avatar Sep 02 '22 22:09 modestfake

Hi @modestfake, thanks a lot for taking the time to report this issue! You are right that those newly added parameters are not yet supported in this SDK. We will add them here in the next release.

seratch avatar Sep 05 '22 08:09 seratch

There's a discussion in the relevant PR for this issue, #1551, about how to model the mutually-exclusive nature of the pairs of properties channel and ts vs. source and unfurl_id. If folks have opinions on that, like if it's worth it, and different ways of implementing it, please chime in!

filmaj avatar Oct 28 '22 19:10 filmaj

This is now fixed in @slack/web-api v6.8.0 which was just released to npm, btw.

filmaj avatar Nov 08 '22 21:11 filmaj