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

package/src/nodes/sip-decline.html

@@ -0,0 +1,76 @@
+<!-- Javascript -->
+<script type="text/javascript">
+  RED.nodes.registerType('sip:decline',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+        status: {},
+        statusType: {value: 'num'},
+        reason: {value: ''},
+        reasonType: {value: 'str'}
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { return this.name || 'sip:decline';},
+      oneditprepare: function() {
+        $('#node-input-status').typedInput({
+          default: $('#node-input-statusType').val(),
+          types: ['num','msg', 'flow', 'global'],
+          typeField: $('#node-input-statusType')
+        });
+        $('#node-input-reason').typedInput({
+          default: $('#node-input-reasonType').val(),
+          types: ['str','msg', 'flow', 'global'],
+          typeField: $('#node-input-reasonType')
+        });
+      }
+  });
+
+</script>
+
+
+
+<!-- HTML -->
+<script type="text/html" data-template-name="sip:decline">
+    <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-status">Status</label>
+      <input type="text" id="node-input-status" placeholder="SIP status code">
+      <input type="hidden" id="node-input-statusType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-reason">Reason</label>
+      <input type="text" id="node-input-reason" placeholder="sip reason">
+      <input type="hidden" id="node-input-reasonType">
+    </div>
+  </script>
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="sip:decline">
+    <p>Reject an incoming call with a status code and, optionally, reason</p>
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+      <dt>SIP status code<span class="property-type">number</span></dt>
+      <dd>A valid SIP status code in the range 4XX - 6XX</dd>
+      <dt>Reason<span class="property-type">string</span></dt>
+      <dd>A brief description</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>sip:decline</code> action appended  </dd>
+  </dl>
+  
+  <h3>Details</h3>
+  The sip:decline verb rejects an incoming call.
+  <h3>References</h3>
+    <ul>
+        <li><a href="https://docs.jambonz.org/jambonz/#sipdecline">Jambonz sip:decline reference</a></li>
+    </ul>
+  </script>

package/src/nodes/sip-decline.js

@@ -0,0 +1,25 @@
+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) {
+  /** sip:decline */
+  function sip_decline(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    node.on('input', function(msg) {
+      var status = v_resolve(config.status, config.statusType, this.context(), msg);
+      var reason = v_resolve(config.reason, config.reasonType, this.context(), msg);
+      appendVerb(msg, {
+        verb: 'sip:decline',
+        status: parseInt(status),
+        reason
+      });
+      node.send(msg);
+    });
+  }
+  RED.nodes.registerType('sip:decline', sip_decline);
+
+}

package/src/nodes/sip-refer.html

@@ -0,0 +1,116 @@
+<!-- Javascript -->
+<script type="text/javascript">
+  RED.nodes.registerType('sip:refer',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+        referTo: {required: true},
+        referToType: {value: 'str'},
+        referredBy: {value: ''},
+        referredByType: {value: 'str'},
+        headers: {value: ''},
+        headersType: {value: 'json'},
+        eventHook: {value: ''},
+        eventHookType: {value: 'str'},
+        actionHook: {value: ''},
+        actionHookType: {value: 'str'}     
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { return this.name || 'sip:refer';},
+      oneditprepare: function() {
+
+        $('#node-input-referTo').typedInput({
+          default: $('#node-input-referToType').val(),
+          types: ['str','msg', 'flow', 'global'],
+          typeField: $('#node-input-referToType')
+        });
+        $('#node-input-referredBy').typedInput({
+          default: $('#node-input-referredByType').val(),
+          types: ['str','msg', 'flow', 'global'],
+          typeField: $('#node-input-referredByType')
+        });
+        $('#node-input-actionHook').typedInput({
+          default: $('#node-input-actionHookType').val(),
+          types: ['str','msg', 'flow', 'global'],
+          typeField: $('#node-input-actionHookType')
+        });
+        $('#node-input-eventHook').typedInput({
+          default: $('#node-input-eventHookType').val(),
+          types: ['str','msg', 'flow', 'global'],
+          typeField: $('#node-input-actionHookType')
+        });
+        $('#node-input-headers').typedInput({
+          default: $('#node-input-headersType').val(),
+          types: ['json','msg', 'flow', 'global'],
+          typeField: $('#node-input-headersType')
+        });
+      }
+  });
+
+</script>
+
+
+
+<!-- HTML -->
+<script type="text/html" data-template-name="sip:refer">
+    <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-referTo">referTo</label>
+      <input type="text" id="node-input-referTo" placeholder="address">
+      <input type="hidden" id="node-input-referTobody">
+    </div>
+    <div class="form-row">
+      <label for="node-input-referredBy">referredBy</label>
+      <input type="text" id="node-input-referredBy" placeholder="address">
+      <input type="hidden" id="node-input-referredByType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-actionHook">Action Hook</label>
+      <input type="text" id="node-input-actionHook" placeholder="/action">
+      <input type="hidden" id="node-input-actionHookType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-eventHook">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-headers">Headers</label>
+      <input type="text" id="node-input-headers" placeholder="SIP headers">
+      <input type="hidden" id="node-input-headersType">
+    </div>
+  </script>
+
+
+
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="sip:refer">
+    <p>The sip:refer action will send a sip REFER to the far end carrier or sip phone</p>
+    <h3>Properties</h3>
+    <p><code>referTo</code> -  a sip uri or a phone number / user identifier	</p>
+    <p><code>referredBy</code> -  	a sip uri or a phone number / user identifier; if not provided it will default to the identity of the party being transferred</p>
+    <p><code>actionHook</code> -  a webhook to call when the transfer has completed	</p>
+    <p><code>eventHook</code> -  a webhook to call when NOTIFY messages of follow-on call status are received	</p>
+    <p><code>headers</code> -  additional SIP headers to include in the response	</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>sip:decline</code> action appended  </dd>
+  </dl>
+  
+  <h3>Details</h3>
+  The sip:refer action is used to blind transfer a call. It will send a sip REFER to the far end carrier or sip phone, which must support the REFER in order for the transfer to work. After the sip:refer completes successfully, the call leg will have left the jambonz platform.  <h3>References</h3>
+    <ul>
+        <li><a href="https://www.jambonz.org/docs/webhooks/sip-refer/">Jambonz sip:refer reference</a></li>
+    </ul>
+  </script>

package/src/nodes/sip-refer.js

@@ -0,0 +1,33 @@
+var {createHash} = require('crypto');
+var mustache = require('mustache');
+mustache.escape = function(text) {return text;};
+var {appendVerb, } = require('./libs');
+
+module.exports = function(RED) {
+  function sip_refer(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    node.on('input', function(msg) {
+      Object.keys(config).forEach(function(key, index) {
+        if (config[key] == ''){
+          config[key] = false
+        };
+      });
+      obj = {
+        verb: 'sip:refer',
+        referTo: config.referTo
+      }
+      if (typeof(config.headers == 'string')){
+        config.headers=JSON.parse(config.headers)
+      }
+      config.headers ? obj.headers = config.headers : null
+      config.referredBy ? obj.referredBy = config.referredBy : null
+      config.actionHook ? obj.actionHook = config.actionHook : null
+      config.eventHook ? obj.eventHook = config.eventHook : null
+      appendVerb(msg, obj)
+      node.send(msg);
+    });
+  }
+  RED.nodes.registerType('sip:refer', sip_refer);
+
+}

package/src/nodes/sip-request.html

@@ -0,0 +1,96 @@
+<!-- Javascript -->
+<script type="text/javascript">
+  RED.nodes.registerType('sip:request',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+        method: {required: true},
+        headers: {value: ''},
+        headersType: {value: 'json'},
+        body: {value: ''},
+        bodyType: {value: 'str'},
+        actionHook: {value: ''},
+        actionHookType: {value: 'str'}      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      label: function() { return this.name || 'sip:request';},
+      oneditprepare: function() {
+        $('#node-input-headers').typedInput({
+          default: $('#node-input-headersType').val(),
+          types: ['json','msg', 'flow', 'global'],
+          typeField: $('#node-input-headersType')
+        });
+        $('#node-input-body').typedInput({
+          default: $('#node-input-bodyType').val(),
+          types: ['str','msg', 'flow', 'global'],
+          typeField: $('#node-input-bodyType')
+        });
+        $('#node-input-actionHook').typedInput({
+          default: $('#node-input-actionHookType').val(),
+          types: ['str','msg', 'flow', 'global'],
+          typeField: $('#node-input-actionHookType')
+        });
+      }
+  });
+
+</script>
+
+
+
+<!-- HTML -->
+<script type="text/html" data-template-name="sip:request">
+    <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-method">Method</label>
+      <select id="node-input-method">
+        <option value="INFO" selected>INFO</option>
+        <option value="MESSAGE">MESSAGE</option>
+        <option value="NOTIFY">NOTIFY</option>
+      </select>
+    </div>
+    <div class="form-row">
+      <label for="node-input-headers">Headers</label>
+      <input type="text" id="node-input-headers" placeholder="SIP headers">
+      <input type="hidden" id="node-input-headersType">
+    </div>
+    <div class="form-row">
+      <label for="node-input-body">SIP Body</label>
+      <input type="text" id="node-input-body" placeholder="SIP body">
+      <input type="hidden" id="node-input-reasonbody">
+    </div>
+    <div class="form-row">
+      <label for="node-input-actionHook">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="sip:request">
+    <p>send a SIP INFO, NOTIFY, or MESSAGE request on an established call leg</p>
+    <h3>Properties</h3>
+    <p><code>method</code> -  SIP method, should be one of INFO, MESSAGE, or NOTIFY		</p>
+    <p><code>headers</code> -  additional SIP headers to include in the response	</p>
+    <p><code>body</code> - the body of the SIP request, if any		</p>
+    <p><code>actionHook</code> -  a webhook to call when the sip request has completed		</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>sip:decline</code> action appended  </dd>
+  </dl>
+  
+  <h3>Details</h3>
+  The sip:request verb completes when a response is received from the far end. The actionHook provides the status code of the sip response:  <h3>References</h3>
+    <ul>
+        <li><a href="https://www.jambonz.org/docs/webhooks/sip-request/">Jambonz sip:decline reference</a></li>
+    </ul>
+  </script>

package/src/nodes/sip-request.js

@@ -0,0 +1,36 @@
+var {createHash} = require('crypto');
+const bent = require('bent');
+var mustache = require('mustache');
+mustache.escape = function(text) {return text;};
+var {appendVerb, v_resolve} = require('./libs');
+const { type } = require('os');
+const { ConfigurationOptions } = require('aws-sdk');
+
+module.exports = function(RED) {
+  /** sip:decline */
+  function sip_request(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    node.on('input', function(msg) {
+      obj = {
+        verb: 'sip:request',
+        method: config.method
+      }
+      Object.keys(config).forEach(function(key, index) {
+        if (config[key] == ''){
+          config[key] = false
+        };
+      });
+      if (typeof(config.headers == 'string')){
+        config.headers=JSON.parse(config.headers)
+      }
+      config.headers ? obj.headers = config.headers : null
+      config.body ? obj.body = config.body : null
+      config.actionHook ? obj.actionHook = config.actionHook : null
+      appendVerb(msg, obj)
+      node.send(msg);
+    });
+  }
+  RED.nodes.registerType('sip:request', sip_request);
+
+}

package/src/nodes/tag.html

@@ -0,0 +1,60 @@
+<!-- Javascript -->
+<script type="text/javascript">
+  RED.nodes.registerType('tag',{
+    category: 'jambonz',
+    color: '#bbabaa',
+    defaults: {
+      name: {value: ''},
+      data: {required: true},
+      dataType: {value: 'json'}
+    },
+    inputs:1,
+    outputs:1,
+    icon: "font-awesome/fa-cubes",
+    label: function() { return this.name || 'tag';},
+    oneditprepare: function() {
+      $('#node-input-data').typedInput({
+        default: $('#node-input-dataType').val(),
+        types: ['json', 'msg', 'flow', 'global'],
+        typeField: $('#node-input-dataType')
+      });
+    }
+  });
+
+</script>
+
+<!-- HTML -->
+
+<script type="text/html" data-template-name="tag">
+    <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-length">Data</label>
+      <input type="text" id="node-input-data" placeholder="data object">
+      <input type="hidden" id="node-input-dataType">
+    </div>
+  </script>
+
+<!-- Help Text -->
+<script type="text/html" data-help-name="tag">
+    <p>Add additional metadata to a call</p>
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>Data<span class="property-type">json</span></dt>
+        <dd>A JSON object containing values to be saved and included in future action or call status notifications.</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>tag</code> action appended  </dd>
+    </dl>
+  
+    <h3>Details</h3>
+    The tag verb is used to add properties to the standard call attributes that jambonz includes on every action or call status HTTP POST request.<h3>References</h3>
+    <ul>
+        <li><a href="https://docs.jambonz.org/jambonz/#tag">Jambonz tag reference</a></li>
+    </ul>
+  </script>

package/src/nodes/tag.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} = require('./libs')
+
+
+module.exports = function(RED) {
+  function tag(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    node.on('input', function(msg) {
+      var data = v_resolve(config.data, config.dataType, this.context(), msg, true);
+      appendVerb(msg, {
+        verb: 'tag',
+        data
+      });
+      node.send(msg);
+    });
+  }
+  RED.nodes.registerType('tag', tag);
+}

package/src/nodes/template.html

@@ -0,0 +1,63 @@
+<!-- Javascript -->
+
+
+<script type="text/javascript">
+ RED.nodes.registerType('NAME',{
+      category: 'jambonz',
+      color: '#bbabaa',
+      defaults: {
+        name: {value: ''},
+        XXXX:{},
+        XXXXType:{value: 'str'}
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-cubes",
+      paletteLabel: "NAME",
+      label: function() { return this.name || 'NAME';},
+      oneditprepare: () => {
+        var node = this;
+        $('#node-input-XXXX').typedInput({
+            types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+            typeField: $('#node-input-XXXXType')
+        });
+      }
+  });
+
+
+</script>
+
+
+<!-- HTML -->
+
+<script type="text/html" data-template-name="NAME">
+    <script type="text/html" data-template-name="listen">
+        <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="NAME">
+     <script type="text/html" data-help-name="NAME">
+        <p>DESCRIPTION</p>
+      <h3>Properties</h3>
+          <p><code>XXXX</code> - TEXT</p>
+        
+      <h3>Outputs</h3>
+       <dl class="message-properties">
+         <dt>payload<span class="property-type">object</span></dt>
+         <dd> <code>msg.payload</code> will contain ...  </dd>
+       </dl>
+      
+      <h3>Details</h3>
+      The listen verb establishes a connection to a websocket server and sends live audio for the current call.<h3>References</h3>
+        <ul>
+            <li><a href="https://docs.jambonz.org/jambonz/#listen">Jambonz listen reference</a></li>
+        </ul>
+      </script>
+
+</script>

package/src/nodes/template.js

@@ -0,0 +1,9 @@
+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) {
+
+}

package/src/nodes/userauth.html

@@ -0,0 +1,85 @@
+<!-- Javascript -->
+<script type="text/javascript">
+RED.nodes.registerType('user auth',{
+      category: 'jambonz',
+      color:"#c1f986",
+      defaults: {
+        name: {value: ''},
+        password: {},
+        passwordType: {},
+        ha1: {},
+        ha1Type: {}
+      },
+      inputs:1,
+      outputs:1,
+      icon: "font-awesome/fa-id-badge",
+      label: function() { return this.name || 'user auth';},
+      oneditprepare: function() {
+        $('#node-input-password').typedInput({
+          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-passwordType')
+        });
+        $('#node-input-ha1').typedInput({
+          types: ['str', 'msg', 'flow', 'global', 'jsonata', 'env'],
+          typeField: $('#node-input-ha1Type')
+        });
+      }
+  });
+</script>
+
+
+
+<!-- HTML -->
+ <!-- user auth -->
+<script type="text/html" data-template-name="user auth">
+    <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>
+    <fieldset>
+      <legend>Enter either a plain-text or hashed password</legend>
+      <div class="form-row">
+        <label for="node-input-password">Plain text password</label>
+        <input type="text" id="node-input-password">
+        <input type="hidden" id="node-input-passwordType">
+      </div>
+      <div class="form-row">
+        <label for="node-input-ha1">Hashed</label>
+        <input type="text" id="node-input-ha1">
+        <input type="hidden" id="node-input-ha1Type">
+      </div>
+    </fieldset>
+  </script>
+
+
+
+
+
+<!-- Help Text -->
+<!-- User Text -->
+<script type="text/html" data-help-name="user auth">
+    <p>Authenticate a user</p>
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>authRequest<span class="property-type">object</span></dt>
+        <dd>The digest parameters provided by the user</dd>
+    </dl>
+  
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+     <dt>authResponse<span class="property-type">object</span></dt>
+     <dd>An object containing a status property indicating whether the password provided has successfully authenticated the user</dd>
+  </dl>
+  
+  <h3>Details</h3>
+  The user auth command is used to authenticate a user based on the sip digest they presented and a password retrieved by some means by the application.
+  You may provide either a plaintext password, or a precomputed hash based on <a href="https://tools.ietf.org/html/rfc2617">RFC 2617</a>, i.e. MD5( username ":" realm ":" password ).<br/><br/>
+  It is valid to provide neither the plaintext nor hashed password, and in this case the user authentication will fail.  
+  It is useful to do this, for instance, when either the presented domain or username are unrecognized.<br/><br/>
+  The output of this node is to set <code>msg.authResponse</code> accordingly, and the <code>webhook out</code> node should then be used to send the result back to the jambonz server.
+  <h3>References</h3>
+    <ul>
+        <li><a href="https://docs.jambonz.org/register-hook">Jambonz user authentication reference</a></li>
+    </ul>
+  </script>
+