@zwerm/zwermapi-client - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

CHANGELOG.md

@@ -9,2 +9,13 @@ # Changelog
 
+## [0.6.0] - 2018-07-20
+
+### Added
+ - Definitions for `WelcomeEvent` (`zwerm.welcome` event). ([17b683a], [e737cf4])
+ - Definitions for `WelcomeBackEvent` (`zwerm.welcome-back` event). ([7fde191], [b986018])
+ - Definitions for `TimerStartEvent` (`zwerm.timer.start` event). ([0071d05], [b686e4b])
+ - Definitions for `TimerCancelEvent` (`zwerm.timer.cancel` event). ([5261272], [2910329])
+
+### Removed
+ - Deprecated `ZwermAPI~NEW_CONVESRATION_EVENT` method in favor of `ZwermAPI~NEW_CONVERSATION_EVENT` method. ([cb72e4b])
+
 ## [0.5.0] - 2018-06-22
@@ -93,4 +104,5 @@
 
-[Unreleased]: https://github.com/zwerm/api-client-js/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/zwerm/api-client-js/compare/v0.6.0...HEAD
 
+[0.6.0]: https://github.com/zwerm/api-client-js/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/zwerm/api-client-js/compare/v0.4.0...v0.5.0
@@ -102,2 +114,11 @@ [0.4.0]: https://github.com/zwerm/api-client-js/compare/v0.3.0...v0.4.0
 
+[17b683a]: https://github.com/zwerm/api-client-js/commit/17b683a
+[e737cf4]: https://github.com/zwerm/api-client-js/commit/e737cf4
+[7fde191]: https://github.com/zwerm/api-client-js/commit/7fde191
+[b986018]: https://github.com/zwerm/api-client-js/commit/b986018
+[0071d05]: https://github.com/zwerm/api-client-js/commit/0071d05
+[b686e4b]: https://github.com/zwerm/api-client-js/commit/b686e4b
+[5261272]: https://github.com/zwerm/api-client-js/commit/5261272
+[2910329]: https://github.com/zwerm/api-client-js/commit/2910329
+[cb72e4b]: https://github.com/zwerm/api-client-js/commit/cb72e4b
 [c082ab8]: https://github.com/zwerm/api-client-js/commit/c082ab8
@@ -104,0 +125,0 @@ [c0d770c]: https://github.com/zwerm/api-client-js/commit/c0d770c

index.d.ts

@@ -351,2 +351,67 @@ import { StaMP } from '@stampit/stamp';
 
+        // region namespace: WelcomeEvent
+        type WELCOME = 'zwerm.welcome';
+        type WelcomeEvent = WelcomeEvent.WelcomeEvent;
+
+        namespace WelcomeEvent {
+            interface WelcomeEvent extends StaMP.Protocol.Messages.StandardisedEventMessage<WelcomeEventData> {
+                event: WELCOME;
+                payload: WelcomeEventData;
+            }
+
+            interface WelcomeEventData {
+            }
+        }
+        // endregion
+        // region namespace: WelcomeBackEvent
+        type WELCOME_BACK = 'zwerm.welcome-back';
+        type WelcomeBackEvent = WelcomeBackEvent.WelcomeBackEvent;
+
+        namespace WelcomeBackEvent {
+            interface WelcomeBackEvent extends StaMP.Protocol.Messages.StandardisedEventMessage<WelcomeBackEventData> {
+                event: WELCOME_BACK;
+                payload: WelcomeBackEventData;
+            }
+
+            interface WelcomeBackEventData {
+            }
+        }
+        // endregion
+        // region namespace: TimerStartEvent
+        type TIMER_START = 'zwerm.timer.start';
+        type TimerStartEvent = TimerStartEvent.TimerStartEvent;
+
+        namespace TimerStartEvent {
+            interface TimerStartEvent extends StaMP.Protocol.Messages.StandardisedEventMessage<TimerStartEventData> {
+                event: TIMER_START;
+                payload: TimerStartEventData;
+            }
+
+            interface TimerStartEventData {
+                /**
+                 * Stringified json of the StaMP event to send when the timer ends.
+                 */
+                event: string;
+                timestamp: string;
+                endpoint: string;
+                route?: string;
+                value?: string;
+            }
+        }
+        // endregion
+        // region namespace: TimerCancelEvent
+        type TIMER_CANCEL = 'zwerm.timer.cancel';
+        type TimerCancelEvent = TimerCancelEvent.TimerCancelEvent;
+
+        namespace TimerCancelEvent {
+            interface TimerCancelEvent extends StaMP.Protocol.Messages.StandardisedEventMessage<TimerCancelEventData> {
+                event: TIMER_START;
+                payload: TimerCancelEventData;
+            }
+
+            interface TimerCancelEventData {
+                id: string;
+            }
+        }
+        // endregion
         // region namespace: UnknownMessageEvent
@@ -353,0 +418,0 @@ type UNKNOWN_MESSAGE = 'zwerm.unknown';

package.json

 {
     "name": "@zwerm/zwermapi-client",
-    "version": "0.5.0",
+    "version": "0.6.0",
     "private": false,
@@ -5,0 +5,0 @@ "description": "Client for using the ZwermAPI",

ZwermAPI.js

@@ -33,2 +33,3 @@ 'use strict';
     // region getter constants
+    // region routes
     /**
@@ -50,2 +51,6 @@ * @return {Zwerm.DISABLED_ROUTING}
 
+    // endregion
+    // region event constants
+    // region system events
+    // region connect events
     /**
@@ -75,2 +80,4 @@ * @return {Zwerm.Events.UNKNOWN_MESSAGE}
 
+    // endregion
+    // region user events
     /**
@@ -92,7 +99,19 @@ * @return {Zwerm.Events.NEW_USER}
 
+    // endregion
+    // region conversation events
     /**
      * @return {Zwerm.Events.NEW_CONVERSATION}
      * @static
+     *
+     * @deprecated in favor of {@link NEW_CONVERSATION_EVENT}
      */
     static get NEW_CONVESRATION_EVENT() {
+        return ZwermAPI.NEW_CONVERSATION_EVENT;
+    }
+
+    /**
+     * @return {Zwerm.Events.NEW_CONVERSATION}
+     * @static
+     */
+    static get NEW_CONVERSATION_EVENT() {
         return 'zwerm.conversations.new';
@@ -118,2 +137,39 @@ }
     // endregion
+    // endregion
+    // region conversational events
+    // region welcome events
+    /**
+     * @return {Zwerm.Events.WELCOME}
+     * @static
+     */
+    static get WELCOME_EVENT() {
+        return 'zwerm.welcome';
+    }
+    /**
+     * @return {Zwerm.Events.WELCOME_BACK}
+     * @static
+     */
+    static get WELCOME_BACK_EVENT() {
+        return 'zwerm.welcome-back';
+    }
+    // endregion
+    // region timer events
+    /**
+     * @return {Zwerm.Events.TIMER_START}
+     * @static
+     */
+    static get TIMER_START_EVENT() {
+        return 'zwerm.timer.start';
+    }
+    /**
+     * @return {Zwerm.Events.TIMER_CANCEL}
+     * @static
+     */
+    static get TIMER_CANCEL_EVENT() {
+        return 'zwerm.timer.cancel';
+    }
+    // endregion
+    // endregion
+    // endregion
+    // endregion
     // region getters & setters
@@ -120,0 +176,0 @@ // region apiUrl (get & set)

No alert changes

Improved metrics

Total package byte prevSize

198334

increased by2.44%

Lines of code

4097

increased by2.81%

No dependency changes