@jambonz/node-red-contrib-jambonz 2.2.73 → 2.3.1

package/src/nodes/play.html

@@ -0,0 +1,76 @@
+<!-- Javascript -->
+<script type="text/javascript">
+RED.nodes.registerType('play',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+        url: {required: true},
+        urlType: {value: 'str'},
+        early: {value: false},
+        loop: {value: 1, required: true,  validate: RED.validators.number()},
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { return this.name || 'play';},
+      oneditprepare: function() {
+        $('#node-input-url').typedInput({
+          default: $('#node-input-urlType').val(),
+          types: ['str','msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-urlType')
+        });
+      }
+  });
+
+</script>
+
+
+<!-- HTML -->
+<script type="text/html" data-template-name="play">
+    <div class="form-row">
+      <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+      <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+      <label for="node-input-url">Url</label>
+      <input type="text" id="node-input-url" placeholder="url returning .mp3 or .wav file">
+      <input type="hidden" id="node-input-urlType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-early"><i class="icon-tag"></i>Early media</label>
+      <input type="checkbox" id="node-input-early">
+    </div>
+    <div class="form-row">
+      <label for="node-input-loop"><i class="icon-tag"></i>Loop</label>
+      <input type="input" id="node-input-loop" placeholder="number of times to repeat"> 
+    </div>  
+  </script>
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="play">
+    <p>Play a wav or mp3 file</p>
+    <h3>Properties</h3>
+    <p><code>Url</code> - 
+     a single url or array of urls (will play in sequence) to a wav or mp3 file</p>
+    <p><code>Early media</code> - 
+     if checked, play the url over an early media connection</p>
+    <p><code>Loop</code> - 
+     number of times to play the url</p>
+ 
+  
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+     <dt>jambonz<span class="property-type">object</span></dt>
+     <dd> <code>msg.jambonz</code> will contain any previous actions provided to the input with the new <code>play</code> action appended  </dd>
+  </dl>
+  
+  <h3>Details</h3>
+  The play action plays an mp3 or wave file into a call.  If early media is checked, the audio will be played over an early media connection, 
+  if the call has not already been answered.
+  
+  <h3>References</h3>
+    <ul>
+        <li><a href="https://docs.jambonz.org/jambonz/#play">Jambonz play reference</a></li>
+    </ul>
+  </script>

package/src/nodes/play.js

@@ -0,0 +1,23 @@
+var {createHash} = require('crypto');
+const bent = require('bent');
+var mustache = require('mustache');
+mustache.escape = function(text) {return text;};
+var {appendVerb, v_resolve} = require('./libs')
+
+
+module.exports = function(RED) {
+  function play(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    node.on('input', function(msg) {
+      appendVerb(msg,  {
+        verb: 'play',
+        url: v_resolve(config.url, config.urlType, this.context(), msg),
+        earlyMedia: config.early,
+        loop: config.loop
+      });
+      node.send(msg);
+    });
+  }
+  RED.nodes.registerType('play', play);
+}

package/src/nodes/rasa.html

@@ -0,0 +1,106 @@
+<!-- Javascript -->
+
+
+<script type="text/javascript">
+ RED.nodes.registerType('rasa',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+        url:{required : true},
+        urlType:{value: 'str'},
+        prompt:{},
+        promptType:{value: 'str'},
+        eventHook:{},
+        eventHookType:{value: 'str'},
+        actionHook:{},
+        actionHookType:{value: 'str'},
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      paletteLabel: "rasa",
+      label: function() { return this.name || 'rasa';},
+      oneditprepare: () => {
+        var node = this;
+        $('#node-input-url').typedInput({
+            types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+            typeField: $('#node-input-urlType')
+        });
+        $('#node-input-prompt').typedInput({
+            types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+            typeField: $('#node-input-promptType')
+        });
+        $('#node-input-eventHook').typedInput({
+            types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+            typeField: $('#node-input-eventHookType')
+        });
+        $('#node-input-actionHook').typedInput({
+            types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+            typeField: $('#node-input-actionHookType')
+        });
+      }
+  });
+
+
+</script>
+
+
+<!-- HTML -->
+
+<script type="text/html" data-template-name="rasa">
+        <div class="form-row">
+          <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+          <input type="text" id="node-input-name" placeholder="Name">
+        </div>
+        
+        <div class="form-row">
+          <label for="node-input-url"><i class="icon-tag"></i> URL</label>
+          <input type="text" id="node-input-url" placeholder="http">
+          <input type="hidden" id="node-input-urlType">
+        </div>
+        <div class="form-row">
+          <label for="node-input-prompt"><i class="icon-tag"></i> Prompt</label>
+          <input type="text" id="node-input-prompt" placeholder="Hello....">
+          <input type="hidden" id="node-input-promptType">
+        </div>
+        <div class="form-row">
+          <label for="node-input-eventHook"><i class="icon-tag"></i> Event Hook</label>
+          <input type="text" id="node-input-eventHook" placeholder="/event">
+          <input type="hidden" id="node-input-eventHookType">
+        </div>
+        <div class="form-row">
+          <label for="node-input-actionHook"><i class="icon-tag"></i> Action Hook</label>
+          <input type="text" id="node-input-actionHook" placeholder="/action">
+          <input type="hidden" id="node-input-actionHookType">
+        </div>
+</script>
+
+<!-- Help Text -->
+
+<script type="text/html" data-help-name="rasa">
+        <p>The rasa verb is used to connect a call to a Rasa assistant.
+
+        </p>
+      <h3>Properties</h3>
+          <p><code>url</code> - URL to connect to the Rasa assistant using the Rasa RestInput channel</p>
+          <p><code>prompt</code> - an initial greeting to play to the user	</p>
+          <p><code>eventHook</code> - a webhook that is called when the rasa assistant returns either a user message or a bot message</p>
+          <p><code>actionHook	</code> - A webhook that is called when the rasa verb completes	</p>
+
+      <h3>Outputs</h3>
+       <dl class="message-properties">
+         <dt>payload<span class="property-type">object</span></dt>
+         <dd> <code>msg.jambonz</code> will contain any previous actions provided to the input with the new <code>rasa</code> action appended  </dd>
+       </dl>
+      
+      <h3>Details</h3>
+      The rasa verb performs speech recognition on the caller audio stream and sends it as text input to the rasa assistant using the rasa RestInput channel. Text returned from the assistant is played to the caller using text-to-speech. As the conversation proceeds, webhook events can be sent to notify of all of the messages being exchanged between the user and the bot, allowing your application to intercede at any point, e.g. to transfer the call to an agent.
+      
+      <h3>References</h3>
+        <ul>
+            <li><a href="https://www.jambonz.org/docs/webhooks/rasa/">Jambonz rasa reference</a></li>
+        </ul>
+      </script>
+
+</script>

package/src/nodes/rasa.js

@@ -0,0 +1,22 @@
+var {createHash} = require('crypto');
+const bent = require('bent');
+var mustache = require('mustache');
+mustache.escape = function(text) {return text;};
+var {appendVerb, v_resolve, v_text_resolve, doLCC, doCreateCall, doCreateMessage} = require('./libs')
+
+module.exports = function(RED) {
+    function rasa(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+        node.on('input', function(msg) {
+          obj = {verb: 'rasa'}
+          obj.url = config.url
+          config.prompt != '' ? obj.prompt = config.prompt : null
+          config.eventHook != '' ? obj.eventHook = config.eventHook : null
+          config.actionHook != '' ? obj.actionHook = config.actionHook : null
+          appendVerb(msg, obj);
+          node.send(msg);
+        });
+      }
+      RED.nodes.registerType('rasa', rasa);
+}

package/src/nodes/redirect.html

@@ -0,0 +1,64 @@
+<!-- Javascript -->
+<script type="text/javascript">
+  RED.nodes.registerType('redirect', {
+    category: 'jambonz',
+    color: '#bbabaa',
+    defaults: {
+      name: {value: ''},
+      hook: {required: true},
+      hookType: {value: 'str'}
+    },
+    inputs:1,
+    outputs:1,
+    icon: "font-awesome/fa-cubes",
+    label: function() { 
+      return this.name || 'redirect';
+    },
+    oneditprepare: function() {
+      $('#node-input-hook').typedInput({
+        types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+        typeField: $('#node-input-hookType')
+      });
+      }
+  });
+</script>
+
+<!-- HTML -->
+<script type="text/html" data-template-name="redirect">
+    <div class="form-row">
+      <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+      <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+      <label for="node-input-hook">Action hook</label>
+      <input type="text" id="node-input-hook" placeholder="url">
+      <input type="hidden" id="node-input-hookType">
+    </div>
+</script>
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="audio in">
+    <script type="text/html" data-help-name="redirect">
+        <p>Redirect a call to a new application URL</p>
+        <h3>Inputs</h3>
+        <dl class="message-properties">
+            <dt>Action hook<span class="property-type">string</span></dt>
+            <dd>URL of webhook to retrieve new application from.</dd>
+        </dl>
+      
+      <h3>Outputs</h3>
+      <dl class="message-properties">
+         <dt>jambonz<span class="property-type">object</span></dt>
+         <dd> <code>msg.jambonz</code> will contain any previous actions provided to the input with the new <code>redirect</code> action appended  </dd>
+      </dl>
+      
+      <h3>Details</h3>
+      The redirect verb retrieves a new URL to execute for the current call.
+      <h3>References</h3>
+        <ul>
+            <li><a href="https://docs.jambonz.org/jambonz/#redirect">Jambonz redirect reference</a></li>
+        </ul>
+      </script>
+  
+
+</script>

package/src/nodes/redirect.js

@@ -0,0 +1,24 @@
+var {createHash} = require('crypto');
+const bent = require('bent');
+var mustache = require('mustache');
+mustache.escape = function(text) {return text;};
+var {appendVerb, v_resolve} = require('./libs')
+
+
+module.exports = function(RED) {
+  /** redirect */
+  function redirect(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    node.on('input', function(msg, send, done) {
+      var actionHook = v_resolve(config.hook, config.hookType, this.context(), msg);
+      appendVerb(msg, {
+        verb: 'redirect',
+        actionHook
+      });
+      node.send(msg);
+    });
+  }
+  RED.nodes.registerType('redirect', redirect);
+
+}

package/src/nodes/s3-upload.html

@@ -5,13 +5,11 @@
       defaults: {
         name: {value: ''},
         path: {value: ''},
-        region: {value: ''},
         bucket: {value: '', required: true},
-        accesskey: {value: ''},
-        secret: {value: ''}
+        aws: {value: '', type: 'aws_auth'}
       },
       inputs:0,
-      outputs:0,
+      outputs:1,
       icon: 'font-awesome/fa-headphones',
       label: function() { return this.name || 'audio in';},
   });
@@ -22,24 +20,41 @@
     <label for="node-input-name"><i class="icon-tag"></i> Name</label>
     <input type="text" id="node-input-name" placeholder="Name">
   </div>
+  <div class="form-row">
+    <label for="node-input-aws">AWS credentials</label>
+    <input type="text" id="node-input-aws">
+  </div>  
   <div class="form-row">
     <label for="node-input-path">Path</label>
-    <input type="text" id="node-input-path" placeholder="url path of websocket server">
+    <input type="text" id="node-input-path" placeholder="/socket">
   </div>
   <div class="form-row">
-    <label for="node-input-path">S3 Bucket</label>
-    <input type="text" id="node-input-bucket" placeholder="Bucket in which to store audio recording">
+    <label for="node-input-path">S3 Bucket Access Point</label>
+    <input type="text" id="node-input-bucket" placeholder="arn:aws:s3:us-east-1:1234567890:accesspoint/mybucket">
   </div>
 </script>
 
 <script type="text/html" data-help-name="audio in">
   <p>Receives audio from jambonz and uploads to S3</p>
-  <h3>Inputs</h3>
-  <dl class="message-properties">
-    <dt>Path<span class="property-type">string</span></dt>
-    <dd>URL path to listen for incoming audio stream on; i.e. a webhook defined in a dial or listen verb</dd>
-    <dt>S3 Bucket<span class="property-type">string</span></dt>
-    <dd>An S3 bucket to upload recording to.  This bucket must allow public access.</dd>
-</dl>
+  <h3>Outputs</h3>
+          <dl class="message-properties">
+              <dt>msg.event<span class="property-type">enum</span></dt>
+              <dd><code>newSession</code> for the start of a new session<br>
+                  <code>partUploaded</code> when a chunk has been uploaded to S3<br>
+                  <code>finishedUpload</code> when the session has ended and the upload completed
+              </dd>
+              <dt>msg.payload<span class="property-type">object</span></dt>
+              <dd>contains details of the newSession (callid, to from etc.) or the details of the upload to S3.
+              </dd>
+          </dl>
 
+
+  <h3>Details</h3>
+  <dl>
+    <dt>node-input-path</dt>
+    <dd>URL path to listen for incoming audio stream on; i.e. a webhook defined in a dial or listen verb</dd>
+    <dt>S3 Bucket Access Point </dt>dt>
+    <dd>The access point of an S3 bucket to upload recording to.  This must allow public access.</dd>
+  </dl>
+  
 </script>

package/src/nodes/s3-upload.js

@@ -1,3 +1,6 @@
+const { notDeepStrictEqual } = require('assert');
+const { memoryStorage } = require('multer');
+
 module.exports = function(RED) {
   var WebSocket = require('ws');
   var url = require('url');
@@ -26,13 +29,19 @@ module.exports = function(RED) {
     RED.nodes.createNode(this, n);
     var node = this;
 
+    // Get AWS Creds
+    const awsCreds = RED.nodes.getNode(n.aws);
+    if (awsCreds && awsCreds.credentials) {
+        AWS.Credentials({
+          accessKeyId: awsCreds.credentials.accessKey, 
+          secretAccessKey: awsCreds.credentials.secretAccessKey
+        });
+    }
+
     // Store local copies of the node configuration (as defined in the .html)
     [
       'path',
-      'bucket',
-      'region',
-      'accesskey',
-      'secret'
+      'bucket'
     ].forEach(function(attr) { node[attr] = n[attr];});
 
     node._clients = {};
@@ -54,7 +63,9 @@ module.exports = function(RED) {
         try {
           socket.removeAllListeners('message');
           node.metadata = JSON.parse(data);
-          node.log(`received metadata: ${data}`);
+          var msg = {payload : node.metadata}
+          msg.event = 'newSession'
+          node.send(msg)
           const md = {
             callSid: node.metadata.callSid,
             accountSid: node.metadata.accountSid,
@@ -73,18 +84,22 @@ module.exports = function(RED) {
             Metadata: md
           });
           upload.on('error', function(err) {
-            node.log(`Error uploading: ${JSON.stringify(err)}`);
+            node.error(`Error uploading: ${JSON.stringify(err)}`);
           });
           upload.on('part', function(details) {
-            node.log(`part: ${JSON.stringify(details)}`);
+            var msg = {payload : details}
+            msg.event = 'partUploaded'
+            node.send(msg)
           });
           upload.on('uploaded', function(details) {
-            node.log(`uploaded: ${JSON.stringify(details)}`);
+            var msg = {payload : details}
+            msg.event = 'finishedUpload'
+            node.send(msg)
           });
           const duplex = WebSocket.createWebSocketStream(socket);
           duplex.pipe(upload);
         } catch (err) {
-          node.log(`Error starting upload: ${err.message}`);
+          node.error(`Error starting upload: ${err.message}`);
         }
       });
       socket.on('error', function(err) {

package/src/nodes/say.html

@@ -0,0 +1,119 @@
+<!-- Javascript -->
+<script type="text/javascript">
+  RED.nodes.registerType('say',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+        text: {required: true},
+        early: {value: false},
+        loop: {value: 1},
+        vendor: {value: 'default'},
+        lang: {value: 'default'},
+        xlang: {},
+        voice: {value: 'default'},
+        xvoice: {}
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { return this.name || 'say';},
+      oneditprepare: () => {
+        var node = this;
+        prepareTtsControls(node);
+      }
+  });
+
+</script>
+
+
+<!-- HTML -->
+<script type="text/html" data-template-name="say">
+    <div class="form-row">
+      <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+      <input type="text" id="node-input-name" placeholder="Name">
+  </div>
+  <div class="form-row">
+    <label for="node-input-text"><i class="icon-tag"></i> Text</label>
+    <textarea id="node-input-text" rows="4" placeholder="Text or SSML to speak" style="width:70%"></textarea>
+  </div>
+  <div class="form-row">
+    <label for="node-input-early"><i class="icon-tag"></i>Early media</label>
+    <input type="checkbox" id="node-input-early">
+  </div>
+  <div class="form-row">
+    <label for="node-input-loop"><i class="icon-tag"></i>Loop</label>
+    <input type="input" id="node-input-loop" placeholder="number of times to repeat"> 
+  </div>
+  <fieldset>
+    <legend>Speech synthesis options</legend>
+    <div class="form-row">
+      <label for="node-input-vendor">Vendor</label>
+      <select id="node-input-vendor">
+        <option value="default" selected>--application default--</option>
+        <option value="google">google</option>
+        <option value="aws">aws/polly</option>
+        <option value="microsoft">microsoft</option>
+        <option value="ibm">ibm</option>
+        <option value="nuance">nuance</option>
+      </select>
+    </div>
+    <div class="form-row" style="display: none;">
+      <label for="node-input-lang"> Lang</label>
+      <input type="text" id="node-input-lang">
+    </div>
+    <div class="form-row">
+      <label for="node-input-xlang">Language</label>
+      <select id="node-input-xlang">
+        <option value="default" selected>--application default--</option>
+      </select>
+    </div>
+    <div class="form-row" style="display: none;">
+      <label for="node-input-voice"> Voice</label>
+      <input type="text" id="node-input-voice">
+    </div>
+    <div class="form-row">
+      <label for="node-input-xvoice">Voice</label>
+      <select id="node-input-xvoice">
+        <option value="default" selected>--application default--</option>
+      </select>
+    </div>
+  </fieldset>
+  </script>
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="say">
+    <p>Synthesize speech from text or SSML</p>
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+      <dt>Text<span class="property-type">string</span></dt>
+      <dd>text to speak; may contain SSML tags</dd>
+      <dt>Early media<span class="property-type">boolean</span></dt>
+      <dd>if checked, play the prompt over an early media connection</dd>
+      <dt>Loop<span class="property-type">number</span></dt>
+      <dd>number of times to play the prompt</dd>
+      <dt>Vendor<span class="property-type">string</span></dt>
+      <dd>TTS vendor</dd>
+      <dt>Language<span class="property-type">string</span></dt>
+      <dd>TTS language</dd>
+      <dt>Voice<span class="property-type">string</span></dt>
+      <dd>TTS voice</dd>
+    </dl>
+  
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+     <dt>jambonz<span class="property-type">object</span></dt>
+     <dd> <code>msg.jambonz</code> will contain any previous actions provided to the input with the new <code>say</code> action appended  </dd>
+  </dl>
+  
+  <h3>Details</h3>
+  The say command is used to send synthesized speech to the remote party. 
+  The text provided may be either plain text or may use SSML tags.
+  
+  Within the text field you can use mustache syntax to insert properties of the msg, flow or global objects.
+  For example if you wanted to insert the value of msg.payload into the text you could put
+  <code>The payload is {{msg.payload}}</code>
+  <h3>References</h3>
+    <ul>
+        <li><a href="https://docs.jambonz.org/jambonz/#say">Jambonz say reference</a></li>
+  </script>

package/src/nodes/say.js

@@ -0,0 +1,38 @@
+var {createHash} = require('crypto');
+const bent = require('bent');
+var mustache = require('mustache');
+mustache.escape = function(text) {return text;};
+var {appendVerb, v_text_resolve} = require('./libs')
+
+module.exports = function(RED) {
+  /** say */
+  function say(config) {
+    RED.nodes.createNode(this, config);
+    this.text = config.text;
+    this.early = config.early;
+    this.loop = config.loop;
+    var node = this;
+
+    node.on('input', function(msg) {
+      const text = v_text_resolve(node, this.text, this.context(), msg);
+      var obj = {
+        verb: 'say',
+        text,
+        loop: parseInt(node.loop),
+        earlyMedia: node.early
+      };
+      if (config.vendor != 'default') {
+        Object.assign(obj, {
+          synthesizer: {
+            vendor: config.vendor,
+            language: config.lang,
+            voice: config.voice
+          }
+        });
+      }
+      appendVerb(msg, obj);
+      node.send(msg);
+    });
+  }
+  RED.nodes.registerType('say', say);
+}