Fix #1512 Remove say from SlackShortcutMiddlewareArgs for GlobalSho…

[mlauter]

Summary

This pull request resolves #1512 by removing say from the SlackShortcutMiddlewareArgs type for GlobalShortcuts. Global shortcuts are not associated with a conversation, so global shortcut listeners are not passed a say function.

Details

Global shortcuts are not associated with a conversation (the payloads do not have a channel id), so no say function is set in listenerArgs for them.

Message shortcuts are associated with a conversation, so listeners do receive the say function.

This change uses a conditional type to set the type of say to SayFn for a message shortcut's SlackShortcutMiddlewareArgs but undefined otherwise.

Testing

• Automated tests are passing.
• I've added two new type tests for this change. I'm a new contributor though, and I was unsure looking at the test suite whether there are other tests you'd like to see added.
• I set up a dummy slack app and linked my working copy of the bolt-js repo to confirm that the types work as expected:

// No type errors
app.shortcut<MessageShortcut>(
  'shortcut_echo',
  async ({ ack, payload, say }) => {
    ack();
    say(payload.message);
    console.log(payload);
  },
);

// Type error
app.shortcut<GlobalShortcut>('wave', async ({ ack, payload, say }) => {
  ack();
  say('hi'); // Cannot invoke an object which is possibly 'undefined'.ts(2722) (parameter) say: undefined
  console.log(payload);
});

// Type error -- caller must verify that say exists
app.shortcut('wave', async ({ ack, payload, say }) => {
  ack();
  say('hi'); // Cannot invoke an object which is possibly 'undefined'.ts(2722) (parameter) say: SayFn | undefined
  console.log(payload);
});

Requirements (place an x in each [ ])

• 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.

[salesforce-cla]

Thanks for the contribution! Before we can merge this, we need @mlauter to sign the Salesforce Inc. Contributor License Agreement.

[codecov]

Codecov Report

Merging #1849 (a30d034) into main (a3532c3) will not change coverage.
The diff coverage is n/a.

❗ Current head a30d034 differs from pull request most recent head 0144e24. Consider uploading reports for the commit 0144e24 to get more accurate results

@@           Coverage Diff           @@
##             main    #1849   +/-   ##
=======================================
  Coverage   82.15%   82.15%           
=======================================
  Files          18       18           
  Lines        1519     1519           
  Branches      435      435           
=======================================
  Hits         1248     1248           
  Misses        175      175           
  Partials       96       96           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[seratch]

Thanks, LGTM 👍

[seratch]

Thanks a lot for your contribution! If there is no objection from other maintainers, we can merge this PR tomorrow in Pacific timezone.

[mlauter]

@seratch let me know if there's anything else you need from me

[seratch]

@mlauter Thanks for the reminder. I was on PTO yesterday. Now we can merge this PR 👍