.github/contributing.md

@@ -53,7 +53,7 @@ If the contribution doesn't meet the above criteria, you may fail our automated
 3.  :herb: Create a new branch and check it out.
 4.  :crystal_ball: Make your changes and commit them locally. Magic happens here!
 5.  :arrow_heading_up: Push your new branch to your fork. (e.g. `git push username fix-issue-16`).
-6.  :inbox_tray: Open a Pull Request on github.com from your new branch on your fork to `master` in this
+6.  :inbox_tray: Open a Pull Request on github.com from your new branch on your fork to `main` in this
     repository.
 
 ## Maintainers

.github/issue_template.md

@@ -11,7 +11,7 @@ Describe your issue here.
 - [ ] discussion
 
 ### Requirements (place an `x` in each of the `[ ]`)
-* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/node-slack-sdk/blob/master/.github/contributing.md) and have done my best effort to follow them.
+* [ ] I've read and understood the [Contributing guidelines](https://github.com/slackapi/node-slack-sdk/blob/main/.github/contributing.md) and have done my best effort to follow them.
 * [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).
 * [ ] I've searched for any related issues and avoided creating a duplicate issue.
 

.github/maintainers_guide.md

@@ -165,6 +165,8 @@ Releasing can feel intimidating at first, but rest assured: if you make a mistak
 ### 🔖 Versioning and Tags
 This project is versioned using [Semantic Versioning](http://semver.org/), particularly in the [npm flavor](https://docs.npmjs.com/getting-started/semantic-versioning). Each release is tagged using git. The naming convention for tags is `{package_name}@{version}`. For example, the tag `@slack/web-api@v5.0.0` marks the v5.0.0 release of the `@slack/web-api` package. A single commit will have multiple tags when multiple packages are released simultaneously.
 
+One package that expands upon the standard major.minor.patch version schema typically associated with Semantic Versioning is the `@slack/cli-test` package. This package employs standard major.minor.patch version, in addition to a [build metadata suffix](https://semver.org/#spec-item-10) suffix of the form `+cli.X.Y.Z`, e.g. `0.1.0+cli.2.24.0`. The version after `+cli.` communicates compatibility between the `@slack/cli-test` package and the [Slack Platfrom CLI](https://api.slack.com/automation/quickstart) itself.
+
 ### 🪵 Branches
 `main` is where active development occurs. Long running named feature branches are occasionally created for collaboration on a feature that has a large scope (because everyone cannot push commits to another person's open Pull Request). After a major version increment, a maintenance branch for the older major version is left open (e.g. `v3`, `v4`, etc).
 

.github/pull_request_template.md

@@ -4,5 +4,5 @@ Describe the goal of this PR. Mention any related Issue numbers.
 
 ### Requirements (place an `x` in each `[ ]`)
 
-* [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/node-slack-sdk/blob/master/.github/contributing.md) and have done my best effort to follow them.
+* [ ] I've read and understood the [Contributing Guidelines](https://github.com/slackapi/node-slack-sdk/blob/main/.github/contributing.md) and have done my best effort to follow them.
 * [ ] I've read and agree to the [Code of Conduct](https://slackhq.github.io/code-of-conduct).

.github/workflows/ci-build.yml

@@ -15,14 +15,15 @@ jobs:
       matrix:
         node-version: [18.x, 20.x]
         package:
-          - packages/cli-hooks
-          - packages/logger
-          - packages/oauth
-          - packages/rtm-api
-          - packages/socket-mode
-          - packages/types
-          - packages/web-api
-          - packages/webhook
+          - cli-hooks
+          - cli-test
+          - logger
+          - oauth
+          - rtm-api
+          - socket-mode
+          - types
+          - web-api
+          - webhook
     steps:
     - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}
@@ -32,15 +33,28 @@ jobs:
     - name: Get Development Dependencies
       run: npm i
     - name: Build and Run Tests in Each Package
-      working-directory: ${{ matrix.package }}
+      working-directory: packages/${{ matrix.package }}
       run: |
         npm install || npm list
         # depending on which package we are testing, also npm link up other dependent packages
         case "$PWD" in
           */webhook) pushd ../types && npm i && popd && npm link ../types;;
           */web-api) pushd ../types && npm i && popd && npm link ../types && pushd ../logger && npm i && popd && npm link ../logger;;
           */oauth) pushd ../logger && npm i && popd && npm link ../logger && pushd ../web-api && npm i && popd && npm link ../web-api;;
-          # TODO: add socket-mode here once new major version released
+          */socket-mode) pushd ../logger && npm i && popd && npm link ../logger && pushd ../web-api && npm i && popd && npm link ../web-api;;
           *) ;; # default
         esac
         npm test
+    - name: Check for coverage report existence
+      id: check_coverage
+      uses: andstor/file-existence-action@v3
+      with:
+        files: packages/${{ matrix.package }}/coverage/lcov.info
+    - name: Upload code coverage
+      if: matrix.node-version == '20.x' && steps.check_coverage.outputs.files_exists == 'true'
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        directory: packages/${{ matrix.package }}/coverage
+        flags: ${{ matrix.package }}
+        verbose: true

README.md

@@ -1,6 +1,6 @@
 # Node Slack SDK
 
-[![build-ci](https://github.com/slackapi/node-slack-sdk/workflows/Node.js/badge.svg)](https://github.com/slackapi/node-slack-sdk/actions?query=workflow%3A%22Node.js%22)
+[![build-ci](https://github.com/slackapi/node-slack-sdk/actions/workflows/ci-build.yml/badge.svg)](https://github.com/slackapi/node-slack-sdk/actions/workflows/ci-build.yml)
 <!-- TODO: npm versions with scoped packages: https://github.com/rvagg/nodei.co/issues/24 -->
 ___
 

codecov.yml

@@ -0,0 +1,28 @@
+comment:
+  layout: "condensed_header, diff, flags"
+
+flags:
+  cli-hooks:
+    paths:
+      - packages/cli-hooks/**
+    carryforward: true
+  logger:
+    paths:
+      - packages/logger/**
+    carryforward: true
+  oauth:
+    paths:
+      - packages/oauth/**
+    carryforward: true
+  socket-mode:
+    paths:
+      - packages/socket-mode/**
+    carryforward: true
+  web-api:
+    paths:
+      - packages/web-api/**
+    carryforward: true
+  webhook:
+    paths:
+      - packages/webhook/**
+    carryforward: true

docs/_layouts/default.html

@@ -26,7 +26,7 @@
 
                 <ul class="sidebar_menu_list footer_nav">
                     <li><a href="{{ site.code_of_conduct_url }}">Code of Conduct</a></li>
-                    <li><a href="https://github.com/{{ site.github_username }}/{{ site.repo_name }}/blob/master/.github/contributing.md">Contributing</a></li>
+                    <li><a href="https://github.com/{{ site.github_username }}/{{ site.repo_name }}/blob/main/.github/contributing.md">Contributing</a></li>
                     <li><a href="{{ site.cla_url }}">Contributor License Agreement</a></li>
                 </ul>
 

docs/_main/about.md

@@ -8,5 +8,5 @@ hidden: true
 {{ site.title }} is proudly maintained with :sparkling_heart: by the Slack Platform team
 
   * [Code of Conduct]({{ site.code_of_conduct_url }})
-  * [Contributing](https://github.com/{{ site.github_username }}/{{ site.repo_name }}/blob/master/.github/contributing.md)
+  * [Contributing](https://github.com/{{ site.github_username }}/{{ site.repo_name }}/blob/main/.github/contributing.md)
   * [Contributor License Agreement]({{ site.cla_url }})

docs/_main/typescript.md

@@ -12,7 +12,9 @@ This page helps describe how to use this package from a project that also uses T
 
 ### Minimum version
 
-The latest major versions of the `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` packages (v6.x) are supported to build against the minimum TypeScript version v4.1.0. See also: https://slack.dev/node-slack-sdk/tutorials/migrating-to-v6
+Latest major versions of `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` packages are supported to build against TypeScript version 5.3.x. You can try to use a greater minor version of Typescript like 5.4 or above, but beware that [API Breaking Changes](https://github.com/microsoft/TypeScript/wiki/API-Breaking-Changes) can be introduced in minor Typescript versions that break compatibility.
+
+The v6 versions of `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` packages are supported to build against the minimum TypeScript version v4.1.0. See also [v5 to v6 migration guide](https://slack.dev/node-slack-sdk/tutorials/migrating-to-v6) for more details.
 
 The v5 versions of `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` packages are supported to build against TypeScript v3.3.0 or higher. The v4 versions of the `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` packages are supported to build against TypeScript v2.7.0 or higher.
 

docs/_packages/socket_mode.md

@@ -7,133 +7,11 @@ anchor_links_header: Usage
 
 # Slack Socket Mode
 
+For baseline package documentation, please see the project's [`README`](https://github.com/slackapi/node-slack-sdk/tree/main/packages/socket-mode#readme) or the [documentation on npm](https://www.npmjs.com/package/@slack/socket-mode).
 
-## Installation
+The following contain additional examples that may be useful for consumers.
 
-```shell
-$ npm install @slack/socket-mode
-```
-
----
-
-### Prerequisites
-
-This package requires a Slack app with an **App-level token**.
-
-To create a new Slack app, head over to [api.slack.com/apps/new](https://api.slack.com/apps?new_app=1).
-
-To generate an **App Token** for your app, on your app's page on [api.slack.com/apps](https://api.slack.com/apps), under the main **Basic Information** page, scroll down to **App-Level Tokens**. Click **Generate Token and Scopes**, add a name for your app token, and click **Add Scope**. Choose `connections:write` and then click **Generate**. Copy and safely store the generated token!
-
-### Initialize the client
-
-This package is designed to support [**Socket Mode**](https://api.slack.com/socket-mode), which allows your app to receive events from Slack over a WebSocket connection.
-
-The package exports a `SocketModeClient` class. Your app will create an instance of the class for each workspace it communicates with.
-
-```javascript
-const { SocketModeClient } = require('@slack/socket-mode');
-
-// Read a token from the environment variables
-const appToken = process.env.SLACK_APP_TOKEN;
-
-// Initialize
-const socketModeClient = new SocketModeClient({ appToken });
-```
-
-### Connect to Slack
-
-After your client establishes a connection, your app can send data to and receive data from Slack. Connecting is as easy as calling the `.start()` method.
-
-```javascript
-const { SocketModeClient } = require('@slack/socket-mode');
-const appToken = process.env.SLACK_APP_TOKEN;
-
-const socketModeClient = new SocketModeClient({ appToken });
-
-(async () => {
-  // Connect to Slack
-  await socketModeClient.start();
-})();
-```
----
-
-### Listen for an event
-
-Bolt apps register [listener functions](https://slack.dev/bolt-js/reference#listener-functions), which are triggered when a specific event type is received by the client.
-
-If you've used Node's [`EventEmitter`](https://nodejs.org/api/events.html#events_class_eventemitter) pattern
-before, then you're already familiar with how this works, since the client is an `EventEmitter`.
-
-The `event` argument passed to the listener is an object. Its content corresponds to the [type of
-event](https://api.slack.com/events) it's registered for.
-
-```javascript
-const { SocketModeClient } = require('@slack/socket-mode');
-const appToken = process.env.SLACK_APP_TOKEN;
-
-const socketModeClient = new SocketModeClient({ appToken });
-
-// Attach listeners to events by type. See: https://api.slack.com/events/message
-socketModeClient.on('message', async ({ event }) => {
-  console.log(event);
-});
-
-(async () => {
-  await socketModeClient.start();
-})();
-```
-
----
-
-### Send a message
-
-To respond to events and send messages back into Slack, we recommend using the `@slack/web-api` package with a `bot token`.
-
-```javascript
-const { SocketModeClient } = require('@slack/socket-mode');
-const { WebClient } = require('@slack/web-api');
-
-const appToken = process.env.SLACK_APP_TOKEN;
-const socketModeClient = new SocketModeClient({ appToken });
-
-const { WebClient } = require('@slack/web-api');
-const webClient = new WebClient(process.env.SLACK_BOT_TOKEN);
-
-// Attach listeners to events by type. See: https://api.slack.com/events/message
-socketModeClient.on('member_joined_channel', async ({event, body, ack}) => {
-  try {
-    // send acknowledgement back to slack over the socketMode websocket connection
-    // this is so slack knows you have received the event and are processing it
-    await ack();
-    await webClient.chat.postMessage({
-      blocks: [
-        {
-          type: 'section',
-          text: {
-            type: 'mrkdwn',
-            text: `Welcome to the channel, <@${event.user}>. We're here to help. Let us know if you have an issue.`,
-          },
-          accessory: {
-            type: 'button',
-            text: {
-              type: 'plain_text',
-              text: 'Get Help',
-            },
-            value: 'get_help',
-          },
-        },
-      ],
-      channel: event.channel,
-    });
-  } catch (error) {
-    console.log('An error occurred', error);
-  }
-});
-```
----
-
-
-### Listen for Interactivity Events
+## Listen for Interactivity Events
 
 To receive interactivity events such as shorcut invocations, button clicks, and modal data submission, your listener can subscribe to "interactive" events.
 
@@ -182,108 +60,4 @@ socketModeClient.on('slash_commands', async ({ body, ack }) => {
 });
 ```
 
-When your app has multiple interactive events or slash commands, you will need to include your own routing logic. This is a good time to consider using Slack's Bolt framework, which provides an easier ways to register listeners for events and user actions. You can learn more in [Bolt's Socket Mode documentation](https://slack.dev/bolt-js/concepts#socket-mode).
-
----
-
-### Lifecycle events
-
-The client's connection to Slack has a lifecycle. This means the client can be seen as a state machine which transitions through a few states as it connects, disconnects, reconnects, and synchronizes with Slack. The client emits an event for each state it transitions to throughout its lifecycle. If your app simply needs to know whether the client is connected or not, the `.connected` boolean property can be checked.
-
-In the table below, the client's states are listed, which are also the names of the events you can use to observe the transition to that state. The table also includes descriptions for the states and arguments that a listener would receive.
-
-| Event Name      | Arguments | Description |
-|-----------------|-----------------|-------------|
-| `connecting`    |  | The client is in the process of connecting to the platform. |
-| `authenticated` | `(connectData)` - the response from `apps.connections.open` | The client has authenticated with the platform. This is a sub-state of `connecting`. |
-| `connected`     |  | The client is connected to the platform and incoming events will start being emitted. |
-| `ready`         |  | The client is ready to send outgoing messages. This is a sub-state of `connected` |
-| `disconnecting` |  | The client is no longer connected to the platform and cleaning up its resources. It will soon transition to `disconnected`. |
-| `reconnecting`  |  | The client is no longer connected to the platform and cleaning up its resources. It will soon transition to `connecting`. |
-| `disconnected`  | `(error)` | The client is not connected to the platform. This is a steady state - no attempt to connect is occurring. The `error` argument will be `undefined` when the client initiated the disconnect (normal). |
-
-The client also emits events that are part of its lifecycle, but aren't states. Instead, they represent specific moments that might be helpful to your app. The following table lists these events, their description, and includes the arguments that a listener would receive.
-
-| Event Name      | Arguments | Description |
-|-----------------|-----------|-------------|
-| `error`         | `(error)` | An error has occurred. See [error handling](#handle-errors) for details. |
-| `slack_event`   | `(eventType, event)` | An incoming Slack event has been received. |
-| `unable_to_socket_mode_start` | `(error)` | A problem occurred while connecting, a reconnect may or may not occur. |
-
----
-
-### Logging
-
-The `SocketModeClient` will log interesting information to the console by default. You can use the `logLevel` to decide how much or what kind of information should be output. There are a few possible log levels, which you can find in the `LogLevel` export. By default, the value is set to `LogLevel.INFO`. While you're in development, it's sometimes helpful to set this to the most verbose: `LogLevel.DEBUG`.
-
-```javascript
-// Import LogLevel from the package
-const { SocketModeClient, LogLevel } = require('@slack/socket-mode');
-const appToken = process.env.SLACK_APP_TOKEN;
-
-// Log level is one of the options you can set in the constructor
-const socketModeClient = new SocketModeClient({
-  appToken,
-  logLevel: LogLevel.DEBUG,
-});
-
-(async () => {
-  await socketModeClient.start();
-})();
-```
-
-All the log levels, in order of most to least information are: `DEBUG`, `INFO`, `WARN`, and `ERROR`.
-
-<details>
-<summary markdown="span">
-<strong><i>Sending log output somewhere besides the console</i></strong>
-</summary>
-
-You can also choose to have logs sent to a custom logger using the `logger` option. A custom logger needs to implement specific methods (known as the `Logger` interface):
-
-| Method       | Parameters        | Return type |
-|--------------|-------------------|-------------|
-| `setLevel()` | `level: LogLevel` | `void`      |
-| `setName()`  | `name: string`    | `void`      |
-| `debug()`    | `...msgs: any[]`  | `void`      |
-| `info()`     | `...msgs: any[]`  | `void`      |
-| `warn()`     | `...msgs: any[]`  | `void`      |
-| `error()`    | `...msgs: any[]`  | `void`      |
-
-A very simple custom logger might ignore the name and level, and write all messages to a file.
-
-```javascript
-const { createWriteStream } = require('fs');
-const logWritable = createWriteStream('/var/my_log_file'); // Not shown: close this stream
-
-const socketModeClient = new SocketModeClient({
-  appToken,
-  // Creating a logger as a literal object. It's more likely that you'd create a class.
-  logger: {
-    debug(...msgs): { logWritable.write('debug: ' + JSON.stringify(msgs)); },
-    info(...msgs): { logWritable.write('info: ' + JSON.stringify(msgs)); },
-    warn(...msgs): { logWritable.write('warn: ' + JSON.stringify(msgs)); },
-    error(...msgs): { logWritable.write('error: ' + JSON.stringify(msgs)); },
-    setLevel(): { },
-    setName(): { },
-  },
-});
-
-(async () => {
-  await socketModeClient.start();
-})();
-```
-</details>
-
----
-
-## Requirements
-
-This package supports Node v14 and higher. It's highly recommended to use [the latest LTS version of
-node](https://github.com/nodejs/Release#release-schedule), and the documentation is written using syntax and features from that version.
-
-## Getting Help
-
-If you get stuck, we're here to help. The following are the best ways to get assistance working through your issue:
-
-  * [Issue Tracker](http://github.com/slackapi/node-slack-sdk/issues) for questions, feature requests, bug reports and general discussion related to these packages. Try searching before you create a new issue.
+When your app has multiple interactive events or slash commands, you will need to include your own routing logic. This is a good time to consider using Slack's Bolt framework, which provides an easier way to register listeners for events and user actions. You can learn more in [Bolt's Socket Mode documentation](https://slack.dev/bolt-js/concepts#socket-mode).