Fix #894 Unable to build options request objects in TypeScript #900
Conversation
seratch
added
bug
Codecov Report
@@ Coverage Diff @@
## main #900 +/- ##
=======================================
Coverage 66.19% 66.19%
=======================================
Files 13 13
Lines 1204 1204
Branches 355 355
=======================================
Hits 797 797
Misses 338 338
Partials 69 69
Continue to review full report at Codecov.
|
| export interface OptionsRequest<Source extends OptionsSource = OptionsSource> extends StringIndexed { | ||
| export type OptionsSource = 'interactive_message' | 'dialog_suggestion' | 'block_suggestion'; | ||
|
|
||
| export type SlackOptions = BlockSuggestion | InteractiveMessageSuggestion | DialogSuggestion; |
There was a problem hiding this comment.
This may sound a bit unnatural but this is consistent with other union types (e.g., SlackAction, SlackEvent, SlackShortcut, SlackViewAction)
| type: Source; | ||
| } | ||
|
|
||
| type OptionsPayloadFromType<T extends string> = KnownOptionsPayloadFromType<T> extends never |
There was a problem hiding this comment.
This is the same approach with Events API payload handling.
| /** | ||
| * external data source in blocks | ||
| */ | ||
| export interface BlockSuggestion extends StringIndexed { |
There was a problem hiding this comment.
I wanted to remove StringIndexed but it's not backward compatible.
| team: { | ||
| id: string; | ||
| domain: string; | ||
| enterprise_id?: string; // undocumented |
There was a problem hiding this comment.
"undocumented " here could be outdated comments
Summary
This pull request resolves #894 by correcting the types for external data source request payloads. @trevor-gullstad flagged this issue by sending pull request #893 (thank you very much!). Refer to the issue and my comments in this pull request for more details.
Requirements (place an
xin each[ ])