adding type for plain_text_input action elements

[br-tim-ray]

Summary

Related to #349

Getting Typescript errors when using a plain_text_input with dispatch_action: true.

Adding definition to resolve those errors.

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.

[CLAassistant]

All committers have signed the CLA.

[codecov]

Codecov Report

Merging #706 (7b43205) into main (3ed08fc) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #706   +/-   ##
=======================================
  Coverage   65.89%   65.89%           
=======================================
  Files          13       13           
  Lines        1173     1173           
  Branches      343      343           
=======================================
  Hits          773      773           
  Misses        334      334           
  Partials       66       66           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3ed08fc...7b43205. Read the comment docs.

[stevengill]

Hey @br-dr-strangecode,

Can you provide a sample of the code you are writing that you are encountering this error with? I just want to reproduce it locally.

[br-tim-ray]

Sure thing

code:

export const configureUserSearchDetails = (bolt: App): void => {
  bolt.action({ type: "block_actions", action_id: /^user_details(.*)/ }, async ({ ack, body, client }) => {
    await ack();
    const username = body.actions[0].value;
    try {
      await client.views.push({
        trigger_id: body.trigger_id,
        view: UserDetailsView(username),
      });
      await client.chat.postMessage({
        channel: logging_channel,
        text: `${body.user.name} clicked on ${username}`,
      });
      console.log(`${body.user.name} searched for ${username}`);
    } catch (error) {
      console.error(error);
    }
  });
};

error:

  Property 'value' does not exist on type 'BlockElementAction'.
  Property 'value' does not exist on type 'UsersSelectAction'.

sample of the response I'm trying to take an action on:

{
  "type": "block_actions",
  "user": {
    "id": "U01CPTM7TJ8",
    "username": "tim.ray",
    "name": "tim.ray",
    "team_id": "T01CB1CPE06"
  },
  "api_app_id": "A01CJ0MSTMH",
  "token": "M6qNFFa5SaLvBzInXAwcYVZP",
  "container": {
    "type": "view",
    "view_id": "V01GFNMRD5G"
  },
  "trigger_id": "1559976302643.1419046796006.9cff3ebe62cded18e8206f7d87e8f6eb",
  "team": {
    "id": "T01CB1CPE06",
    "domain": "trslackbotdev"
  },
  "enterprise": null,
  "is_enterprise_install": false,
  "view": {
    "id": "V01GFNMRD5G",
    "team_id": "T01CB1CPE06",
    "type": "modal",
    "blocks": [
      {
        "type": "input",
        "block_id": "user_search_block",
        "label": {
          "type": "plain_text",
          "text": "Search",
          "emoji": true
        },
        "optional": false,
        "dispatch_action": true,
        "element": {
          "type": "plain_text_input",
          "action_id": "user_search_input",
          "placeholder": {
            "type": "plain_text",
            "text": "name, username, phone",
            "emoji": true
          },
          "dispatch_action_config": {
            "trigger_actions_on": [
              "on_enter_pressed"
            ]
          }
        }
      }
    ],
    "private_metadata": "",
    "callback_id": "",
    "state": {
      "values": {
        "user_search_block": {
          "user_search_input": {
            "type": "plain_text_input",
            "value": "test"
          }
        }
      }
    },
    "hash": "1607466819.LAqne3A8",
    "title": {
      "type": "plain_text",
      "text": "User Search",
      "emoji": true
    },
    "clear_on_close": false,
    "notify_on_close": false,
    "close": {
      "type": "plain_text",
      "text": "Done",
      "emoji": true
    },
    "submit": null,
    "previous_view_id": null,
    "root_view_id": "V01GFNMRD5G",
    "app_id": "A01CJ0MSTMH",
    "external_id": "",
    "app_installed_team_id": "T01CB1CPE06",
    "bot_id": "B01C3417TEK"
  },
  "actions": [
    {
      "type": "plain_text_input",
      "block_id": "user_search_block",
      "action_id": "user_search_input",
      "value": "test",
      "action_ts": "1607466824.040714"
    }
  ]
}

Let me know if this is sufficient or if you need more of the code.

[br-tim-ray]

I should have pointed out that the error occurs on this line:

const username = body.actions[0].value;

[seratch]

Sorry for our slow response here. The change looks great to me. Thanks for your contribution!