fix: require markdown_text in chat.appendStream method

zimeg · zimeg · commit bdf134c5b8c0 · 2025-09-18T12:34:12.000-07:00
diff --git a/packages/web-api/src/types/request/chat.ts b/packages/web-api/src/types/request/chat.ts
@@ -154,7 +154,7 @@ export interface Unfurls {
   unfurl_media?: boolean;
 }
 
-export interface ChatAppendStreamArguments extends TokenOverridable, ChannelAndTS, Partial<MarkdownText> {}
+export interface ChatAppendStreamArguments extends TokenOverridable, ChannelAndTS, MarkdownText {}
 
 // https://docs.slack.dev/reference/methods/chat.delete
 export interface ChatDeleteArguments extends ChannelAndTS, AsUser, TokenOverridable {}
diff --git a/packages/web-api/test/types/methods/chat.test-d.ts b/packages/web-api/test/types/methods/chat.test-d.ts
@@ -10,21 +10,21 @@ expectError(web.chat.appendStream()); // lacking argument
 expectError(web.chat.appendStream({})); // empty argument
 expectError(
   web.chat.appendStream({
-    channel: 'C1234', // missing ts
+    channel: 'C1234', // missing ts and markdown_text
   }),
 );
 expectError(
   web.chat.appendStream({
-    ts: '1234.56', // missing channel
+    ts: '1234.56', // missing channel and markdown_text
   }),
 );
-// -- happy path
-expectAssignable<Parameters<typeof web.chat.appendStream>>([
-  {
-    channel: 'C1234',
+expectError(
+  web.chat.appendStream({
+    channel: 'C1234', // missing_markdown_text
     ts: '1234.56',
-  },
-]);
+  }),
+);
+// -- happy path
 expectAssignable<Parameters<typeof web.chat.appendStream>>([
   {
     channel: 'C1234',

Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,7 @@ export interface Unfurls {`
`154`	`154`	`unfurl_media?: boolean;`
`155`	`155`	`}`
`156`	`156`
`157`		`-export interface ChatAppendStreamArguments extends TokenOverridable, ChannelAndTS, Partial<MarkdownText> {}`
	`157`	`+export interface ChatAppendStreamArguments extends TokenOverridable, ChannelAndTS, MarkdownText {}`
`158`	`158`
`159`	`159`	`// https://docs.slack.dev/reference/methods/chat.delete`
`160`	`160`	`export interface ChatDeleteArguments extends ChannelAndTS, AsUser, TokenOverridable {}`