v4.5.0

docs/_posts/2018-08-24-v4.5.0.md

@@ -0,0 +1,12 @@
+---
+layout: changelog
+---
+
+## New Features
+
+- `RTMClient.start()` now returns a Promise that resolves with the data emitted with the `authenticated` event - thanks @clavin (#611)
+- Adds the `state` property to the type definition of `Dialog` - thanks @DominikPalo (#619)
+
+## Bug Fixes
+
+- Fixes an issue where `RTMClient` did not emit the `"disconnected"` event when it fails to connect - thanks @clavin (#610)

docs/_reference/RTMClient.md

@@ -23,13 +23,13 @@ messages.
     * [.addOutgoingEvent(awaitReply, type, body)](#module_@slack/client.RTMClient+addOutgoingEvent) ⇒ <code>Promise.&lt;(void\|module:@slack/client.RTMCallResult)&gt;</code>
     * [.addOutgoingEvent(awaitReply, type, body)](#module_@slack/client.RTMClient+addOutgoingEvent) ⇒ [<code>Promise.&lt;RTMCallResult&gt;</code>](#module_@slack/client.RTMCallResult)
     * [.addOutgoingEvent(awaitReply, type, body)](#module_@slack/client.RTMClient+addOutgoingEvent) ⇒ <code>Promise.&lt;void&gt;</code>
-    * [.disconnect()](#module_@slack/client.RTMClient+disconnect)
+    * [.disconnect()](#module_@slack/client.RTMClient+disconnect) ⇒ <code>Promise.&lt;void&gt;</code>
     * [.send(type, body)](#module_@slack/client.RTMClient+send) ⇒ <code>Promise.&lt;number&gt;</code>
     * [.sendMessage(text, conversationId)](#module_@slack/client.RTMClient+sendMessage) ⇒ [<code>Promise.&lt;RTMCallResult&gt;</code>](#module_@slack/client.RTMCallResult)
     * [.sendMessage(text, conversationId, callback)](#module_@slack/client.RTMClient+sendMessage)
     * [.sendMessage(text, conversationId, callback)](#module_@slack/client.RTMClient+sendMessage)
     * [.sendTyping(conversationId)](#module_@slack/client.RTMClient+sendTyping) ⇒ <code>Promise.&lt;void&gt;</code>
-    * [.start(options)](#module_@slack/client.RTMClient+start)
+    * [.start(options)](#module_@slack/client.RTMClient+start) ⇒ [<code>Promise.&lt;WebAPICallResult&gt;</code>](#module_@slack/client.WebAPICallResult)
     * [.subscribePresence(userIds)](#module_@slack/client.RTMClient+subscribePresence) ⇒ <code>Promise.&lt;void&gt;</code>
 
 <a name="module_@slack/client.RTMClient+addOutgoingEvent"></a>
@@ -79,7 +79,7 @@ from the websocket.
 
 <a name="module_@slack/client.RTMClient+disconnect"></a>
 
-### rtmClient.disconnect()
+### rtmClient.disconnect() ⇒ <code>Promise.&lt;void&gt;</code>
 End an RTM session. After this method is called no messages will be sent or received unless you call
 start() again later.
 
@@ -147,7 +147,7 @@ Sends a typing indicator to indicate that the user with `activeUserId` is typing
 
 <a name="module_@slack/client.RTMClient+start"></a>
 
-### rtmClient.start(options)
+### rtmClient.start(options) ⇒ [<code>Promise.&lt;WebAPICallResult&gt;</code>](#module_@slack/client.WebAPICallResult)
 Begin an RTM session using the provided options. This method must be called before any messages can
 be sent or received.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slack/client",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "Slack Developer Kit - official clients for the Web API, RTM API, and Incoming Webhooks",
   "author": "Slack Technologies, Inc.",
   "license": "MIT",

support/jsdoc/@slack-client-dist-methods.js

@@ -57,6 +57,7 @@ export class CursorPaginationEnabled {
  * @property {Array<module:@slack/client/dist/methods.__type>} elements
  * @property {string} [submit_label]
  * @property {boolean} [notify_on_cancel]
+ * @property {string} [state]
  */
 export class Dialog {
 }
@@ -155,3 +156,10 @@ export class TokenOverridable {
 export class TraditionalPagingEnabled {
 }
 
+/**
+ * @interface module:@slack/client/dist/methods.UserPerspectiveEnabled
+ * @property {string} [on_behalf_of]
+ */
+export class UserPerspectiveEnabled {
+}
+

support/jsdoc/@slack-client.js

@@ -188,6 +188,7 @@ Promise.
    * End an RTM session. After this method is called no messages will be sent or received unless you call
    * start() again later.
    * @function module:@slack/client.RTMClient#disconnect
+   * @returns {Promise<void>}
    */
   disconnect() {}
 
@@ -242,6 +243,7 @@ Promise.
    * be sent or received.
    * @param {module:@slack/client/dist/methods.TokenOverridable | module:@slack/client/dist/methods.LocaleAware | module:@slack/client/dist/methods.__type | module:@slack/client/dist/methods.TokenOverridable | module:@slack/client/dist/methods.__type} options
    * @function module:@slack/client.RTMClient#start
+   * @returns {Promise<module:@slack/client.WebAPICallResult>}
    */
   start() {}