Skip to content

fix(types): include action_id in WorkflowButton #2693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
deepunyk wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −2
Open

fix(types): include action_id in WorkflowButton #2693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/workflow-button-action-id.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@slack/types": patch
---

fix(types): include `action_id` in `WorkflowButton`
2 changes: 1 addition & 1 deletion packages/types/src/block-kit/block-elements.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,7 @@ export interface URLSourceElement {
* @description Allows users to run a {@link https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-link-triggers/#workflow_buttons link trigger} with customizable inputs.
* @see {@link https://docs.slack.dev/reference/block-kit/block-elements/workflow-button-element Workflow button element reference}.
*/
export interface WorkflowButton extends Confirmable {
export interface WorkflowButton extends Actionable, Confirmable {
/**
* @description The type of element. In this case `type` is always `workflow_button`.
*/
Expand Down
17 changes: 16 additions & 1 deletion packages/types/test/block-elements.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
import { expectAssignable, expectError } from 'tsd';
import type { RichTextInput } from '../src/index';
import type { RichTextInput, WorkflowButton } from '../src/index';

// WorkflowButton happy path
expectAssignable<WorkflowButton>({
type: 'workflow_button',
text: {
type: 'plain_text',
text: 'Run workflow',
},
action_id: 'run_workflow',
workflow: {
trigger: {
url: 'https://example.com/trigger',
},
},
});

// RichTextInput — happy paths
expectAssignable<RichTextInput>({
Expand Down