prg-chatbot - npm Package Compare versions

Comparing version 0.11.0 to 0.12.0

package.json

 {
   "name": "prg-chatbot",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Facebook Messenger Chatbot Framework",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -747,3 +747,3 @@ # Prg-chatbot - Facebook Messenger platform framework
     * [new Router()](#new_Router_new)
-    * [.use([action], [pattern], reducer)](#Router+use) ⇒ <code>Object</code>
+    * [.use([action], [pattern], ...reducers)](#Router+use) ⇒ <code>Object</code>
     * [.reduce(req, res, postBack)](#ReducerWrapper+reduce)
@@ -758,3 +758,3 @@
 
-### router.use([action], [pattern], reducer) ⇒ <code>Object</code>
+### router.use([action], [pattern], ...reducers) ⇒ <code>Object</code>
 Appends middleware, action handler or another router
@@ -768,3 +768,3 @@
 | [pattern] | <code>RegExp</code> &#124; <code>string</code> &#124; <code>function</code> |  |
-| reducer | <code>function</code> &#124; <code>[Router](#Router)</code> |  |
+| ...reducers | <code>function</code> &#124; <code>[Router](#Router)</code> |  |
 
@@ -783,3 +783,4 @@ **Example**
 
-// route with matching function
+// route with matching function (the function is considered as matcher
+// in case of the function accepts zero or one arguments)
 router.use('action', req => req.text() === 'a', (req, res) => {
@@ -789,2 +790,8 @@ res.text('Hello!');
 
+// use multiple reducers
+router.use('/path', reducer1, reducer2)
+   .next('exitAction', (data, req, res, postBack, next) => {
+       postBack('anotherAction', { someData: true })
+   });
+
 // append router with exit action
@@ -791,0 +798,0 @@ router.use('/path', subRouter)

src/Processor.js

@@ -24,9 +24,30 @@ /*
      * @param {ReducerWrapper|function|Router} reducer
-     * @param {{appUrl?:string, translator?:function, timeout?:number, log?:object,
-        defaultState?:object, cookieName?:string, pageToken:string, appSecret:string,
-        chatLog?:object, tokenStorage?:object, senderFnFactory?:function,
-        securityMiddleware?:object, loadUsers?:boolean, loadUsers?:object,
-        onSenderError?:function }} options
-     * @param {{getOrCreateAndLock:function, saveState:function,
-        onAfterStateLoad:function}} [stateStorage]
+     * @param {{
+        pageToken:string,
+        appSecret:string,
+        appUrl?:string,
+        translator?:function,
+        timeout?:number,
+        log?:object,
+        defaultState?:object,
+        cookieName?:string,
+        chatLog?:object,
+        tokenStorage?:object,
+        senderFnFactory?:function,
+        securityMiddleware?:object,
+        loadUsers?:boolean,
+        loadUsers?:object,
+        onSenderError?:function,
+        autoTyping?: boolean|{
+            time?: number,
+            perCharacters?: number,
+            minTime?: number,
+            maxTime?: number
+        }
+       }} options
+     * @param {{
+        getOrCreateAndLock:function,
+        saveState:function,
+        onAfterStateLoad:function
+       }} [stateStorage]
      *
@@ -33,0 +54,0 @@ * @memberOf Processor

src/Responder.js

@@ -36,2 +36,10 @@ /*
         Object.assign(this.options, options);
+        if (this.options.autoTyping) {
+            this.options.autoTyping = Object.assign({
+                time: 600,
+                perCharacters: 'Sample text Sample texts'.length,
+                minTime: 500,
+                maxTime: 2700
+            }, this.options.autoTyping);
+        }
 
@@ -99,2 +107,3 @@ this._t = this.options.translator;
 
+        this._autoTypingIfEnabled(messageData.message.text);
         this._send(messageData);
@@ -180,2 +189,3 @@ return this;
 
+        this._autoTypingIfEnabled(null);
         this._send(messageData);
@@ -202,2 +212,3 @@ return this;
 
+        this._autoTypingIfEnabled(null);
         this._send(messageData);
@@ -359,4 +370,31 @@ return this;
     }
+
+    _autoTypingIfEnabled (text) {
+        if (!this.options.autoTyping) {
+            return;
+        }
+        const typingTime = this._getTypingTimeForText(text);
+        this.typingOn().wait(typingTime);
+    }
+
+    _getTypingTimeForText (text) {
+
+        const textLength = typeof text === 'string'
+            ? text.length
+            : this.options.autoTyping.perCharacters;
+
+        const timePerCharacter = this.options.autoTyping.time
+            / this.options.autoTyping.perCharacters;
+
+        return Math.min(
+            Math.max(
+                textLength * timePerCharacter,
+                this.options.autoTyping.minTime
+            ),
+            this.options.autoTyping.maxTime
+        );
+    }
+
 }
 
 module.exports = Responder;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

148412

increased by1.19%

Lines of code

3261

increased by1.65%

Number of lines in readme file

1331

increased by0.53%

No dependency changes