@jambonz/node-red-contrib-jambonz 2.4.23 → 2.4.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jambonz/node-red-contrib-jambonz",
-  "version": "2.4.23",
+  "version": "2.4.24",
   "description": "Node-RED nodes for jambonz platform",
   "keywords": [
     "node-red"
@@ -48,25 +48,27 @@
       "get_alerts": "src/nodes/get_alerts.js",
       "get_call": "src/nodes/get_call.js",
       "get_calls": "src/nodes/get_calls.js",
-      "get_recent_calls": "src/nodes/get_recent_calls.js"
+      "get_recent_calls": "src/nodes/get_recent_calls.js",
+      "answer": "src/nodes/answer.js",
+      "dub": "src/nodes/dub.js"
     }
   },
   "author": "Dave Horton",
   "license": "MIT",
   "dependencies": {
-    "aws-sdk": "^2.1405.0",
+    "aws-sdk": "^2.1665.0",
     "body-parser": "^1.20.2",
     "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
     "hash-sum": "^2.0.0",
     "is-utf8": "^0.2.1",
     "media-typer": "^1.1.0",
-    "multer": "^1.4.4",
+    "multer": "^1.4.5-lts.1",
     "mustache": "^4.2.0",
     "on-headers": "^1.0.2",
     "raw-body": "^2.5.2",
     "s3-upload-stream": "^1.0.7",
-    "undici": "^5.26.4",
-    "ws": "^8.13.0"
+    "undici": "^5.28.4",
+    "ws": "^8.18.0"
   }
 }

package/src/nodes/answer.html

@@ -0,0 +1,35 @@
+<!-- Javascript -->
+<script type="text/javascript">
+  RED.nodes.registerType('answer',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+      },
+      inputs: 1,
+      outputs: 1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { return this.name || 'answer';},
+  });
+</script>
+
+<!-- HTML -->
+<script type="text/html" data-template-name="answer">
+  <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>
+</script>
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="answer">
+  <p>Answer the call</p>
+
+  <h3>Details</h3>
+  This is rarely used, as the call is typically answered automatically when required by the app,
+    but it can be useful to force an answer before a pause in some cases.
+  <h3>References</h3>
+    <ul>
+        <li><a href="https://www.jambonz.org/docs/webhooks/answer/">Jambonz answer reference</a></li>
+    </ul>
+</script>

package/src/nodes/answer.js

@@ -0,0 +1,16 @@
+var {appendVerb} = require('./libs')
+
+module.exports = function(RED) {
+    function answer(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+        node.on('input', function(msg) {
+          var data = {
+            verb: 'answer'
+          };
+          appendVerb(msg, data);
+          node.send(msg);
+        });
+    }
+    RED.nodes.registerType('answer', answer);
+}

package/src/nodes/config.html

@@ -83,6 +83,14 @@
       sipRequest: { value: false },
       sipRequestWithinDialogHook: { value: "" },
       sipRequestWithinDialogHookType: { value: "str" },
+
+      onHold: { value: false },
+      onHoldMusic: { value: "" },
+      onHoldMusicType: { value: "str" },
+
+      boostAudioSignal: { value: false },
+      boostAudioSignalLevel: { value: "" },
+      boostAudioSignalLevelType: { value: "str" },
     },
     inputs: 1,
     outputs: 1,
@@ -263,6 +271,32 @@
         }
       });
 
+      $("#node-input-onHoldMusic").typedInput({
+        types: ["str", "msg", "flow", "global", "jsonata", "env", mustacheType],
+        typeField: $("#node-input-onHoldMusicType"),
+      });
+      $("#node-input-onHold").change(function () {
+        const doSipRequest = $("#node-input-onHold:checked").val();
+        if (doSipRequest) {
+          $("#onHold-options").show();
+        } else {
+          $("#onHold-options").hide();
+        }
+      });
+
+      $("#node-input-boostAudioSignalLevel").typedInput({
+        types: ["str", "msg", "flow", "global", "jsonata", "env", mustacheType],
+        typeField: $("#node-input-boostAudioSignalLevelType"),
+      });
+      $("#node-input-boostAudioSignal").change(function () {
+        const doSipRequest = $("#node-input-boostAudioSignal:checked").val();
+        if (doSipRequest) {
+          $("#boostAudioSignal-options").show();
+        } else {
+          $("#boostAudioSignal-options").hide();
+        }
+      });
+
       $("#node-input-listenRequest").change(function () {
         const doListen = $("#node-input-listenRequest:checked").val();
         if (doListen) {
@@ -569,6 +603,32 @@
         <input type="hidden" id="node-input-sipRequestWithinDialogHookType">
     </div>
   </div>
+
+  <legend>On Hold Music</legend>
+  <div class="form-row">
+    <label for="node-input-onHold">Modify On Hold Music</label>
+    <input type="checkbox" id="node-input-onHold">
+  </div>
+  <div id="onHold-options">
+    <div class="form-row">
+      <label for="node-input-onHoldMusic">Url</label>
+        <input type="text" id="node-input-onHoldMusic">
+        <input type="hidden" id="node-input-onHoldMusicType">
+    </div>
+  </div>
+
+  <legend>Boost Audio Signal</legend>
+  <div class="form-row">
+    <label for="node-input-boostAudioSignal">Boost Audio</label>
+    <input type="checkbox" id="node-input-boostAudioSignal">
+  </div>
+  <div id="boostAudioSignal-options">
+    <div class="form-row">
+      <label for="node-input-boostAudioSignalLevel">Level</label>
+        <input type="text" id="node-input-boostAudioSignalLevel">
+        <input type="hidden" id="node-input-boostAudioSignalLevelType">
+    </div>
+  </div>
   </fieldset>
 </script>
 

package/src/nodes/config.js

@@ -86,6 +86,14 @@ module.exports = function(RED) {
           if (config.sipRequest) {
             config.sipRequestWithinDialogHook != '' ? obj.sipRequestWithinDialogHook = new_resolve(RED, config.sipRequestWithinDialogHook, config.sipRequestWithinDialogHookType, node, msg) : null;
           }
+
+          if (config.onHold) {
+            config.onHoldMusic != '' ? obj.onHoldMusic = new_resolve(RED, config.onHoldMusic, config.onHoldMusicType, node, msg) : null;
+          }
+
+          if (config.boostAudioSignal) {
+            config.boostAudioSignal != '' ? obj.boostAudioSignal = new_resolve(RED, config.boostAudioSignalLevel, config.boostAudioSignalLevelType, node, msg) : null;
+          }
           appendVerb(msg,  obj);
           node.send(msg);
         });

package/src/nodes/dub.html

@@ -0,0 +1,135 @@
+<!-- Javascript -->
+<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("dub", {
+    category: "jambonz",
+    color: "#bbabaa",
+    defaults: {
+      name: { value: "" },
+      action: { value: "addTrack" },
+      track: { value: "" },
+      trackType: { value: "str" },
+      play: { value: "" },
+      playType: { value: "str" },
+      say: { value: "" },
+      sayType: { value: "str" },
+      loop: { value: false },
+      gain: {
+        value: "",
+        validate: function (v) {
+          if (v.length) {
+            return v.match(/([+-]?\d+(\.\d+)?)\s*db/i) !== null;
+          }
+          return true;
+        },
+      },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-cubes",
+    label: function () {
+      return this.name || "dub";
+    },
+    oneditprepare: function () {
+      var node = this;
+      $("#node-input-track").typedInput({
+        types: ["str", "msg", "flow", "global", "jsonata", "env", mustacheType],
+        typeField: $("#node-input-trackType"),
+      });
+      $("#node-input-play").typedInput({
+        types: ["str", "msg", "flow", "global", "jsonata", "env", mustacheType],
+        typeField: $("#node-input-playType"),
+      });
+      $("#node-input-say").typedInput({
+        types: ["str", "msg", "flow", "global", "jsonata", "env", mustacheType],
+        typeField: $("#node-input-sayType"),
+      });
+    },
+  });
+</script>
+
+<!-- HTML -->
+<script type="text/html" data-template-name="dub">
+  <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-action">Action</label>
+    <select id="node-input-action">
+      <option value="addTrack">addTrack</option>
+      <option value="removeTrack">removeTrack</option>
+      <option value="silenceTrack">silenceTrack</option>
+      <option value="playOnTrack">playOnTrack</option>
+      <option value="sayOnTrack">sayOnTrack</option>
+    </select>
+  </div>
+  <div class="form-row">
+    <label for="node-input-track">Track</label>
+    <input type="text" id="node-input-track" placeholder="The label for the track">
+    <input type="hidden" id="node-input-trackType">
+  </div>
+  <div class="form-row">
+    <label for="node-input-play">Play</label>
+    <input type="text" id="node-input-play" placeholder="The http(s) url to an mp3 file">
+    <input type="hidden" id="node-input-playType">
+  </div>
+  <div class="form-row">
+    <label for="node-input-say">Say</label>
+    <input type="text" id="node-input-say" placeholder="The label for the play">
+    <input type="hidden" id="node-input-sayType">
+  </div>
+  <div class="form-row">
+    <label for="node-input-loop">Loop</label>
+    <input type="checkbox" id="node-input-loop" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-gain">Gain</label>
+    <input
+      type="text"
+      id="node-input-gain"
+      placeholder="The value must be between +- 50 dB"
+    />
+  </div>
+</script>
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="dub">
+  <p>Adds one or more additional audio tracks</p>
+  <h3>Inputs</h3>
+  <h3>Properties</h3>
+  <p>
+    <code>Action</code> - One of 'addTrack', 'removeTrack', 'silenceTrack',
+    'playOnTrack', or 'sayOnTrack'.
+  </p>
+  <p><code>Track</code> - Label for the track</p>
+  <p>
+    <code>Play</code> - An http(s) url to an mp3 file to play into the track
+  </p>
+  <p><code>Loop</code> - Loop the mp3</p>
+  <p>
+    <code>Gain</code> - Decibels to boost or reduce the strength of the audio
+    signal
+  </p>
+
+  <h3>Details</h3>
+  The dub verb adds one or more additional audio tracks into the conversation
+  (currently, a max of two additional audio tracks may be added). Audio can then
+  be inserted into these tracks and it will be blended with the play or say
+  content being sent to the caller/called party. The source of the audio content
+  can be either text to speech or mp3 audio accessible via http(s).
+
+  <h3>References</h3>
+  <ul>
+    <li>
+      <a href="https://www.jambonz.org/docs/webhooks/dub/"
+        >Jambonz dub reference</a
+      >
+    </li>
+  </ul>
+</script>

package/src/nodes/dub.js

@@ -0,0 +1,24 @@
+var {appendVerb, new_resolve} = require('./libs')
+
+module.exports = function(RED) {
+  /** dub */
+  function dub(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+
+    node.on('input', function(msg) {
+      var obj = {
+        verb: 'dub',
+        action: config.action,
+        track: new_resolve(RED, config.track, config.trackType, node, msg),
+        play: new_resolve(RED, config.play, config.playType, node, msg),
+        say: new_resolve(RED, config.say, config.sayType, node, msg),
+        loop: config.loop,
+        gain: config.gain
+      };
+      appendVerb(msg, obj);
+      node.send(msg);
+    });
+  }
+  RED.nodes.registerType('dub', dub);
+}