@jambonz/node-red-contrib-jambonz 2.5.3 → 2.6.1

package/src/nodes/lex.html

@@ -1,281 +0,0 @@
-<!-- Javascript -->
-<script src="resources/@jambonz/node-red-contrib-jambonz/editor.js"></script>
-<script type="text/javascript">
-  var mustacheType = {
-  value: 'mustache',
-  label: 'mustache',
-  hasvalue: true,
-  icon: 'resources/@jambonz/node-red-contrib-jambonz/icons/mustache.svg'
-}
-  RED.nodes.registerType('lex',{
-      category: 'jambonz',
-      color: '#bbabaa',
-      defaults: {
-        name: {value: ''},
-        aws: {value: '', type: 'aws_auth'},
-        bot: {required: true},
-        botType: {value: 'str'},
-        alias: {required: true},
-        aliasType: {value: 'str'},
-        region: {required: true, value: 'us-east-1'},
-        locale: {value: 'en_US'},
-        localeType: {value: 'str'},
-        specifyIntent: {value: true},
-        intent: {value: ''},
-        intentType: {value: 'str'},
-        slots: {value: ''},
-        slotsType: {value: 'json'},
-        metadata: {value: ''},
-        metadataType: {value: 'json'},
-        welcomeMessage: {value: 'str'},
-        eventHook: {},
-        eventHookType: {value: 'str'},
-        actionHook: {},
-        actionHookType: {value: 'str'},
-        bargein: {value: true},
-        inputTimeout: {},
-        inputTimeoutType: {value: 'num'},
-        passDtmf: {value: true},
-        prompt: {value: 'lex', required: true},
-        vendor: {value: 'default'},
-        lang: {value: 'default'},
-        voice: {value: 'default'},
-        xlang: {},
-        xvoice: {}
-      },
-      inputs:1,
-      outputs:1,
-      icon: "font-awesome/fa-cubes",
-      label: function() { return this.name || 'lex';},
-      oneditprepare: () => {
-        var node = this;
-        var promptElem = $('#node-input-prompt');
-        var ttsDiv = $('#tts-options');
-
-        prepareTtsControls(node);
-
-        $('#node-input-eventHook').typedInput({
-          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
-          typeField: $('#node-input-eventHookType')
-        });
-        $('#node-input-actionHook').typedInput({
-          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
-          typeField: $('#node-input-actionHookType')
-        });
-
-        $('#node-input-bot').typedInput({
-          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
-          typeField: $('#node-input-botType')
-        });
-        $('#node-input-alias').typedInput({
-          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
-          typeField: $('#node-input-aliasType')
-        });
-        $('#node-input-locale').typedInput({
-          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
-          typeField: $('#node-input-localeType')
-        });
-        $('#node-input-inputTimeout').typedInput({
-          types: ['num', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
-          typeField: $('#node-input-inputTimeoutType')
-        });
-        $('#node-input-intent').typedInput({
-          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env', mustacheType],
-          typeField: $('#node-input-intentType')
-        });
-        $('#node-input-slots').typedInput({
-          typeField: $('#node-input-slotsType'),
-          types: ['json', 'msg', 'flow', 'global'],
-        });
-        $('#node-input-metadata').typedInput({
-          typeField: $('#node-input-metadataType'),
-          types: ['json', 'msg', 'flow', 'global'],
-        });
-
-        var onPromptChanged = function () {
-          node.action = promptElem.find(':selected').val();
-          if ('tts' === node.action) ttsDiv.show();
-          else ttsDiv.hide();
-        }
-
-        promptElem.change(onPromptChanged);
-        $('#node-input-specifyIntent').change(function() {
-          const doIntent = $('#node-input-specifyIntent:checked').val();
-          console.log('intent? ' + doIntent);
-          if (doIntent) {
-            $('#intent-options').show();
-            $('#welcome-msg-options').hide();
-          }
-          else {
-            $('#intent-options').hide();
-            $('#welcome-msg-options').show();
-          }
-        });
-      }
-  });
-</script>
-
-<!-- HTML -->
-<script type="text/html" data-template-name="lex">
-    <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-aws">AWS credentials</label>
-      <input type="text" id="node-input-aws">
-    </div>  
-    <div class="form-row">
-      <label for="node-input-bot">Bot ID</label>
-      <input type="text" id="node-input-bot" placeholder="bot name">
-      <input type="hidden" id="node-input-botType">
-    </div>
-    <div class="form-row">
-      <label for="node-input-alias">Bot Alias</label>
-      <input type="text" id="node-input-alias" placeholder="bot alias">
-      <input type="hidden" id="node-input-aliasType">
-    </div>
-    <div class="form-row">
-      <label for="node-input-locale">Locale</label>
-      <input type="text" id="node-input-locale" placeholder="en_US">
-      <input type="hidden" id="node-input-localeType">
-    </div>
-    <div class="form-row">
-      <label for="node-input-region">Region</label>
-      <select id="node-input-region">
-        <option value="ap-northeast-1">Tokyo (ap-northeast-1)</option>
-        <option value="ap-southeast-1">Singapore (ap-southeast-1)</option>
-        <option value="ap-southeast-2">Sydney (ap-southeast-2)</option>
-        <option value="eu-central-1">Frankfurt (eu-central-1)</option>
-        <option value="eu-west-1">Ireland (eu-west-1)</option>
-        <option value="eu-west-2">London (eu-west-2)</option>
-        <option value="us-east-1" selected>N. Virginia (us-east-1)</option>
-        <option value="us-west-2">Oregon (us-west-2)</option>
-      </select>
-    </div>
-    <div class="form-row">
-      <label for="node-input-specifyIntent">Initial intent?</label>
-      <input type="checkbox" id="node-input-specifyIntent">
-    </div>
-    <div id="intent-options">
-      <div class="form-row">
-        <label for="node-input-intent">Intent name</label>
-        <input type="text" id="node-input-intent" placeholder="name of initial intent (if any)">
-        <input type="hidden" id="node-input-intentType">
-      </div>
-      <div class="form-row">
-        <label for="node-input-slots">Slots</label>
-        <input type="text" id="node-input-slots" placeholder="initial slot values (if any)">
-        <input type="hidden" id="node-input-slotsType">
-      </div>
-    </div>
-    <div id="welcome-msg-options">
-      <div class="form-row">
-        <label for="node-input-welcomeMessage">Welcome message</label>
-        <textarea id="node-input-welcomeMessage" rows="2" placeholder="Initial message to speak, if any" style="width:65%"></textarea>
-      </div>
-    </div>
-    <div class="form-row">
-      <label for="node-input-metadata">Metadata</label>
-      <input type="text" id="node-input-metadata" placeholder="key-value pairs to send to lex (if any)">
-      <input type="hidden" id="node-input-metadataType">
-    </div>
-    <div class="form-row">
-      <label for="node-input-inputTimeout">Input timeout</label>
-      <input type="text" id="node-input-inputTimeout" placeholder="speech timeout, in seconds">
-      <input type="hidden" id="node-input-inputTimeoutType">
-    </div>
-    <div class="form-row">
-      <label for="node-input-beep">Enable barge-in</label>
-      <input type="checkbox" id="node-input-bargein">
-    </div>
-    <div class="form-row">
-      <label for="node-input-passDtmf">Enable dtmf</label>
-      <input type="checkbox" id="node-input-passDtmf">
-    </div>
-    <div class="form-row">
-      <label for="node-input-eventHook">Event Hook</label>
-      <input type="text" id="node-input-eventHook">
-      <input type="hidden" id="node-input-eventHookType">
-    </div>
-    <div class="form-row">
-      <label for="node-input-actionHook">Action Hook</label>
-      <input type="text" id="node-input-actionHook">
-      <input type="hidden" id="node-input-actionHookType">
-    </div>
-    <div class="form-row">
-      <label for="node-input-prompt">Prompt audio</label>
-      <select id="node-input-prompt">
-        <option value="lex">Use Lex-provided audio</option>
-        <option value="tts">Use text to speech</option>
-      </select>
-    </div>
-    <div id="tts-options">
-      <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>
-    </div>
-  </script>
-
-<!-- Help Text -->
-<script type="text/html" data-help-name="lex">
-  <p>Connects a call to a Amazon lex bot</p>
-
-  <h3>Properties</h3>
-  <p><code>Name</code> -  Label for the node</p>
-  <p><code>AWS Credentias</code> -  A config node containing AWS credentials that will execute the lex bot.</p>
-  <p><code>Bot ID</code> -  ID of the Lex bot on AWS</p>
-  <p><code>Bot Alias</code> -  Lex bot alias ID	</p>
-  <p><code>Locale</code> -    language code of speaker (currently supported languages:  en_AU, en_GB, en_US, fr_CA, fr_FR, es_ES, es_US, it_IT)</p>
-  <p><code>Region</code> -  AWS region bot is running in</p>
-  <p><code>Initial Intent?</code> -  Should lex use an initial intent on connection</p>
-  <p><code>Intent name</code> -  initial intent to trigger (i.e. "welcome intent")	</p>
-  <p><code>Slots</code> - key-value pairs for slot names and initial values to be pre-filled  </p>
-  <p><code>Metadata</code> - key-value pairs for context data to pass to Lex bot	  </p>
-  <p><code>Input timeout</code> - timeout in millseconds Lex will wait for a response before triggering fallback intent	  </p>
-  <p><code>Enable barge-in </code> - ??  </p>
-  <p><code>Enable DTMF </code> - If enabled then <code>dtmf</code> events will be sent to the event Hook  </p>
-  <p><code>Event Hook </code> - A webhook url to invoke when a Lex event occurs (e.g intent detected, transcription, etc)  </p>
-  <p><code>Action Hook </code> -  ?? </p>
-
-  <p><code>Prompt audio</code> - Controls whether jambonz wil playback the audio received from Lex or use its own text to speech to render the response   </p>
-  <p><code>Vendor</code> -  If using TTS then which vendor to use </p>
-  <p><code>Language </code> -  If using TTS then which language to use  </p>
-  <p><code>Voice </code> -  If using TTS then which voice to use  </p>
-  <p><code> </code> -   </p>
-  <p><code> </code> -   </p>
-
-  <h3>References</h3>
-    <ul>
-        <li><a href="https://www.jambonz.org/docs/webhooks/lex/">Jambonz lex reference</a></li>
-    </ul>
-</script>

package/src/nodes/lex.js

@@ -1,69 +0,0 @@
-var {appendVerb, new_resolve} = require('./libs')
-
-module.exports = function(RED) {
- /** lex */
- function lex(config) {
-    RED.nodes.createNode(this, config);
-    var node = this;
-    const awsCreds = RED.nodes.getNode(config.aws);
-    node.on('input', async function(msg) {
-      let accessKey, secretAccessKey;
-      if (awsCreds && awsCreds.credentials) {
-        accessKey = awsCreds.credentials.accessKey;
-        secretAccessKey = awsCreds.credentials.secretAccessKey;
-      }
-      var eventHook = await new_resolve(RED, config.eventHook, config.eventHookType, node, msg);
-      var actionHook = await new_resolve(RED, config.actionHook, config.actionHookType, node, msg);
-      var botId = await new_resolve(RED, config.bot, config.botType, node, msg);
-      var botAlias = await new_resolve(RED, config.alias, config.aliasType, node, msg);
-      var locale = await new_resolve(RED, config.locale, config.localeType, node, msg) || 'en_US';  
-      var val = await new_resolve(RED, config.inputTimeout, config.inputTimeoutType, node, msg);
-      var timeout = /^\d+$/.test(val) ? parseInt(val) : 0;
-      var slots, intentName;
-      if (config.specifyIntent) {
-        intentName =  await new_resolve(RED, config.intent, config.intentType, node, msg);
-        if (intentName) {
-          slots =  await new_resolve(RED, config.slots, config.slotsType, node, msg);
-        }
-      }
-      var metadata =  await new_resolve(RED, config.metadata, config.metadataType, node, msg);
-
-      const obj = {
-        verb: 'lex',
-        botId,
-        botAlias,
-        region: config.region,
-        locale,
-        bargein: config.bargein,
-        passDtmf: config.passDtmf
-      };
-      if (accessKey) Object.assign(obj, {credentials: {accessKey, secretAccessKey}});
-      if (eventHook && eventHook.length > 0) obj.eventHook = eventHook;
-      if (actionHook && actionHook.length > 0) obj.actionHook = actionHook;
-      if (!config.specifyIntent && config.welcomeMessage && config.welcomeMessage.length) obj.welcomeMessage = config.welcomeMessage;
-      if (timeout) obj.noInputTimeout = timeout;
-      if (config.prompt === 'tts') {
-        obj.tts = {
-          vendor: config.vendor,
-          language: config.lang,
-          voice: config.voice
-        };
-      }
-
-      if (intentName) {
-        const intent = {name: intentName};
-        if (slots && typeof slots === 'object' && Object.keys(slots).length > 0) {
-          intent.slots = slots;
-        }
-        obj.intent = intent;
-      }
-      if (metadata && typeof metadata === 'object' && Object.keys(metadata).length > 0) {
-        obj.metadata = metadata;
-      }
-
-      appendVerb(msg, obj);
-      node.send(msg);
-    });
-  }
-  RED.nodes.registerType('lex', lex);
-}

package/src/nodes/s3-upload.html

@@ -1,66 +0,0 @@
-<script type="text/javascript">
-  RED.nodes.registerType('audio in',{
-      category: 'jambonz',
-      color: '#f093ea',
-      defaults: {
-        name: {value: ''},
-        path: {value: ''},
-        bucket: {value: '', required: true},
-        aws: {value: '', type: 'aws_auth'}
-      },
-      inputs:0,
-      outputs:1,
-      icon: 'font-awesome/fa-headphones',
-      label: function() { return this.name || 'audio in';},
-  });
-</script>
-
-<script type="text/html" data-template-name="audio in">
-  <div class="form-row ui-state-error">
-    <strong>Attention:</strong> 
-      This node has been deprecated. <a href="https://github.com/jambonz/node-red-contrib-jambonz/issues/53" target="_blank">See issue #53<i class="fa fa-external-link external-link"></i></a> for more details.
-  </div>
-  <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-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="/socket">
-  </div>
-  <div class="form-row">
-    <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">
-  <div class="ui-state-error">
-    <strong>Attention:</strong> 
-      This node has been deprecated.
-  </div>
-  <p>Receives audio from jambonz and uploads to S3</p>
-  <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,140 +0,0 @@
-module.exports = function(RED) {
-  var WebSocket = require('ws');
-  var url = require('url');
-  var AWS = require('aws-sdk') ;
-  var S3Stream = require('s3-upload-stream');
-
-  var serverUpgradeAdded = false;
-  function handleServerUpgrade(request, socket, head) {
-    const pathname = url.parse(request.url).pathname;
-    if (listenerNodes.hasOwnProperty(pathname)) {
-      listenerNodes[pathname].server.handleUpgrade(request, socket, head, function done(ws) {
-        listenerNodes[pathname].server.emit('connection', ws, request);
-      });
-    } else {
-      // Don't destroy the socket as other listeners may want to handle the
-      // event.
-    }
-  }
-  var listenerNodes = {};
-
-  // A node red node that sets up a local websocket server
-  function WebSocketListenerNode(n) {
-    // Create a RED node
-    RED.nodes.createNode(this, n);
-    var node = this;
-
-    node.warn("This node has been deprecated. See https://github.com/jambonz/node-red-contrib-jambonz/issues/53");
-
-    // 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'
-    ].forEach(function(attr) { node[attr] = n[attr];});
-
-    node._clients = {};
-    node.closing = false;
-
-    function handleConnection(/*socket*/socket) {
-      var id = (1 + Math.random() * 4294967295).toString(16);
-      node._clients[id] = socket;
-      node.emit('opened', {count: Object.keys(node._clients).length, id:id});
-      socket.on('open', function() {
-        node.emit('opened', {count:'', id:id});
-      });
-      socket.on('close', function() {
-        delete node._clients[id];
-        node.emit('closed', {count:Object.keys(node._clients).length,id:id});
-      });
-      socket.on('message', function(data) {
-        // first message is a JSON object containing metadata
-        try {
-          socket.removeAllListeners('message');
-          node.metadata = JSON.parse(data);
-          var msg = {payload : node.metadata}
-          msg.event = 'newSession'
-          node.send(msg)
-          const md = {
-            callSid: node.metadata.callSid,
-            accountSid: node.metadata.accountSid,
-            applicationSid: node.metadata.applicationSid,
-            from: node.metadata.from,
-            to: node.metadata.to,
-            callId: node.metadata.callId
-          };
-          if (node.metadata.parentCallSid) md.parentCallSid = node.metadata.parentCallSid;
-          const s3Stream = new S3Stream(new AWS.S3());
-          const upload = s3Stream.upload({
-            Bucket: node.bucket,
-            Key: `${node.metadata.callSid}.L16`,
-            ACL: 'public-read',
-            ContentType: `audio/L16;rate=${node.metadata.sampleRate};channels=${node.metadata.mixType === 'stereo' ? 2 : 1}`,
-            Metadata: md
-          });
-          upload.on('error', function(err) {
-            node.error(`Error uploading: ${JSON.stringify(err)}`);
-          });
-          upload.on('part', function(details) {
-            var msg = {payload : details}
-            msg.event = 'partUploaded'
-            node.send(msg)
-          });
-          upload.on('uploaded', function(details) {
-            var msg = {payload : details}
-            msg.event = 'finishedUpload'
-            node.send(msg)
-          });
-          const duplex = WebSocket.createWebSocketStream(socket);
-          duplex.pipe(upload);
-        } catch (err) {
-          node.error(`Error starting upload: ${err.message}`);
-        }
-      });
-      socket.on('error', function(err) {
-        node.emit('error', {err:err, id:id});
-      });
-    }
-
-    if (!serverUpgradeAdded) {
-      RED.server.on('upgrade', handleServerUpgrade);
-      serverUpgradeAdded = true;
-    }
-
-    var path = RED.settings.httpNodeRoot || '/';
-    path = path + (path.slice(-1) == '/' ? '' : '/') + (node.path.charAt(0) == '/' ?
-      node.path.substring(1) :
-      node.path);
-    node.fullPath = path;
-
-    if (listenerNodes.hasOwnProperty(path)) {
-      node.error(RED._('websocket.errors.duplicate-path', {path: node.path}));
-      return;
-    }
-    listenerNodes[node.fullPath] = node;
-    var serverOptions = {
-      noServer: true
-    }
-    if (RED.settings.webSocketNodeVerifyClient) {
-      serverOptions.verifyClient = RED.settings.webSocketNodeVerifyClient;
-    }
-    // Create a WebSocket Server
-    node.server = new WebSocket.Server(serverOptions);
-    node.server.setMaxListeners(0);
-    node.server.on('connection', handleConnection);
-
-    node.on('close', function() {
-      delete listenerNodes[node.fullPath];
-      node.server.close();
-    });
-  }
-  RED.nodes.registerType('audio in', WebSocketListenerNode);
-}