Missing type declarations for HomeView

[JustStanix]

Description

TS2339: Property 'team_id' does not exist on type 'View'.   Property 'team_id' does not exist on type 'HomeView'.

From my understanding of the Slack API documentation, the app_home_opened event should always contain a team_id in event.view. If so then HomeView is missing type declarations for this.

What type of issue is this? (place an x in one of the [ ])

• bug
• enhancement (feature request)
• question
• documentation related
• example code related
• testing related
• discussion

Requirements (place an x in each of the [ ])

• I've read and understood the Contributing guidelines and have done my best effort to follow them.
• I've read and agree to the Code of Conduct.
• I've searched for any related issues and avoided creating a duplicate issue.

---

Bug Report

Filling out the following details about bugs will help us solve your issue sooner.

Reproducible in:

package version: 3.3.0

node version: v16.4.2

OS version(s): Windows 11 Pro, WSL 2 (Ubuntu LTS)

Steps to reproduce:

1. Create an app_home_opened event listener.
2. Try to read team_id from event.view

Expected result:

What you expected to happen: TypeScript is happy :))

Actual result:

What actually happened: TypeScript is angy :(

[seratch]

Hi @JustStanix, thanks for taking the time to report this issue. You are right that the type definition for body.event.view of app_home_opened events is incomplete. We will improve this in future versions.

Apart from that, I would suggest using context.teamId instead. You can use the property as the way to know team_id for any type of event.

app.event('app_home_opened', async ({ context }) => {
  console.log(`context.teamId: ${context.teamId}`);
});

[JustStanix]

Hi @seratch! Thank you for the suggestion, that fixes my issue.

[AlexisTonneau]

I also noticed that HomeView type doesn't include some fields, such as view.id whereas returned payload includes an id that could be used to update the view.

My received payload is

  view: {
    id: 'V03GMKH4T5E',
    team_id: 'T01PY724468',
    app_id: 'A034D9Y4U5T',
    app_installed_team_id: 'T01PY724468',
    bot_id: 'B03GMK1H5AL',
    type: 'home',
    blocks: [ [Object], [Object], [Object] ],
    state: { values: {} },
    hash: '1652879745.kmcdqLgk',
    private_metadata: '',
    callback_id: '',
    root_view_id: 'V03GMKH4T5E',
    external_id: '',
    title: { type: 'plain_text', text: 'View Title', emoji: true },
    close: null,
    submit: null,
    previous_view_id: null,
    clear_on_close: false,
    notify_on_close: false
  }

whereas HomeView is declared as

export interface HomeView {
    type: 'home';
    blocks: (KnownBlock | Block)[];
    private_metadata?: string;
    callback_id?: string;
    external_id?: string;
}

[filmaj]

Hey @AlexisTonneau I posted your comment as an issue in the appropriate repo housing that particular type: slackapi/node-slack-sdk#1486.

We can continue discussion on your observation / issue over there.

[jakob-lilliemarck]

hey,
Why is this issue closed? The type for SlackEventMiddlewareArgs<'app_home_opened'> is still inaccurate and is missing declaration for view.team_id