@sap/async-xsjs 1.0.2

package/docs/styles/jsdoc-default.css

@@ -0,0 +1,382 @@
+html{
+    overflow: auto;
+    background-color: #fff;}
+
+body{
+    font: 14px "DejaVu Sans Condensed", "Liberation Sans", "Nimbus Sans L", Tahoma, Geneva, "Helvetica Neue", Helvetica, Arial, sans serif;
+    line-height: 130%;
+    color: #000;
+    background-color: #fff;}
+
+a{
+    color: #444;}
+
+a:visited{
+    color: #444;}
+
+a:active{
+    color: #444;}
+
+header{
+    display: block;
+    padding: 6px 4px;}
+
+.class-description{
+    font-style: italic;
+    font-family: Palatino, 'Palatino Linotype', serif;
+    font-size: 130%;
+    line-height: 140%;
+    margin-bottom: 1em;
+    margin-top: 1em;}
+
+#main{
+    float: left;
+    width: 100%;}
+
+.oblique{
+    color: #888;
+    font-size: 85%;}
+
+section{
+    display: block;
+    background-color: #fff;
+    padding: 12px 24px;
+    border-bottom: 1px solid #ccc;
+    margin-right: 240px;}
+
+.optional:after{
+    content: "opt";
+    font-size: 60%;
+    color: #aaa;
+    font-style: italic;
+    font-weight: lighter;}
+
+nav{
+    display: block;
+    float: left;
+    margin-left: -230px;
+    margin-top: 28px;
+    width: 220px;
+    border-left: 1px solid #ccc;
+    padding-left: 9px;}
+
+nav ul{
+    font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
+    font-size: 100%;
+    line-height: 17px;
+    padding:0;
+    margin:0;
+    list-style-type:none;}
+
+nav h2 a, nav h2 a:visited{
+    color: #A35A00;
+    text-decoration: none;}
+
+nav h3{
+    margin-top: 12px;}
+
+nav li{
+    margin-top: 6px;}
+
+nav a{
+    color: #2C2924;}
+
+nav a:visited{
+    color: #5D5954;}
+
+nav a:active{
+    color: #5D5954;}
+
+footer{
+    display: block;
+    padding: 6px;
+    margin-top: 12px;
+    font-style: italic;
+    font-size: 90%;}
+
+h1{
+    font-size: 200%;
+    font-weight: bold;
+    letter-spacing: -0.01em;
+    margin: 6px 0 9px 0;}
+
+h2{
+    font-size: 170%;
+    font-weight: bold;
+    letter-spacing: -0.01em;
+    margin: 6px 0 3px 0;}
+
+h3{
+    font-size: 150%;
+    font-weight: bold;
+    letter-spacing: -0.01em;
+    margin-top: 16px;
+    margin: 6px 0 3px 0;}
+
+h4{
+    font-size: 130%;
+    font-weight: bold;
+    letter-spacing: -0.01em;
+    margin-top: 16px;
+    margin: 18px 0 3px 0;
+    color: #A35A00;}
+
+h5, .container-overview .subsection-title{
+    font-size: 120%;
+    font-weight: bold;
+    letter-spacing: -0.01em;
+    margin: 8px 0 3px -16px;}
+
+h6{
+    font-size: 100%;
+    letter-spacing: -0.01em;
+    margin: 6px 0 3px 0;
+    font-style: italic;}
+
+.ancestors{ color: #999; }
+.ancestors a{
+    color: #999 !important;
+    text-decoration: none;}
+
+.important{
+    font-weight: bold;
+    color: #950B02;}
+
+.yes-def{
+    text-indent: -1000px;}
+
+.type-signature{
+    color: #aaa;}
+
+.name, .signature{
+    font-family: Consolas, "Lucida Console", Monaco, monospace;}
+
+.details{ margin-top: 14px;}
+.details dt{ width:100px; float:left; border-left: 2px solid #DDD; padding-left: 10px;  padding-top: 6px;}
+.details dd{ margin-left: 50px;}
+.details ul{ margin: 0;}
+.details ul{ list-style-type: none;}
+.details li{ margin-left: 30px; padding-top: 6px;}
+
+.description{
+    margin-bottom: 1em;
+    margin-left: -16px;
+    margin-top: 1em;}
+
+.code-caption{
+    font-style: italic;
+    font-family: Palatino, 'Palatino Linotype', serif;
+    font-size: 107%;
+    margin: 0;}
+
+.prettyprint{
+    border: 1px solid #ddd;
+    width: 80%;
+    overflow: auto;
+	padding-left: 2em;}
+
+.prettyprint.source{
+    width: inherit;}
+
+.prettyprint code{
+    font-family: Consolas, 'Lucida Console', Monaco, monospace;
+    font-size: 100%;
+    line-height: 18px;
+    display: block;
+    padding-left: 0.5em;
+    background-color: #fff;
+    color: #000;
+    border-left: 3px #ddd solid;}
+
+.prettyprint code span.line-numbers{
+	color: #888;
+	pointer-events: none;
+	font-size: 85%;
+	display: inline-block;
+	width: 0em; /* works for line-numbers below 1000 lines */
+	letter-spacing: -1px;
+	-webkit-user-select: none;
+	-khtml-user-select: none;
+	-moz-user-select: none;
+	-ms-user-select: none;
+	-o-user-select: none;
+	user-select: none;}
+
+span.line-numbers:after{
+	display: inline-block;
+	text-align: right;
+	content: attr(rowId);
+	position: relative;
+	left: -4em;
+	width: 2em;
+	padding: 0 0.5em;}
+
+.params, .props{
+    border-spacing: 0;
+    border: 0;
+    border-collapse: collapse;}
+
+.params .name, .props .name, .name code{
+    color: #A35A00;
+    font-family: Consolas, 'Lucida Console', Monaco, monospace;
+    font-size: 100%;}
+
+.params td, .params th, .props td, .props th{
+    border: 1px solid #ddd;
+    margin: 0px;
+    text-align: left;
+    vertical-align: top;
+    padding: 4px 6px;
+    display: table-cell;}
+
+.params thead tr, .props thead tr{
+    background-color: #ddd;
+    font-weight: bold;}
+
+.params .params thead tr, .props .props thead tr{
+    background-color: #fff;
+    font-weight: bold;}
+
+.params th, .props th{ border-right: 1px solid #aaa;}
+.params thead .last, .props thead .last{ border-right: 1px solid #ddd;}
+
+.disabled{
+    color: #454545;}
+
+.message{
+        -webkit-background-size: 40px 40px;
+        -moz-background-size: 40px 40px;
+        background-size: 40px 40px;
+        background-image: -webkit-gradient(linear, left top, right bottom,
+                                color-stop(.25, rgba(255, 255, 255, .075)), color-stop(.25, transparent),
+                                color-stop(.5, transparent), color-stop(.5, rgba(255, 255, 255, .075)),
+                                color-stop(.75, rgba(255, 255, 255, .075)), color-stop(.75, transparent),
+                                to(transparent));
+        background-image: -webkit-linear-gradient(135deg, rgba(255, 255, 255, .075) 25%, transparent 25%,
+                            transparent 50%, rgba(255, 255, 255, .075) 50%, rgba(255, 255, 255, .075) 75%,
+                            transparent 75%, transparent);
+        background-image: -moz-linear-gradient(135deg, rgba(255, 255, 255, .075) 25%, transparent 25%,
+                            transparent 50%, rgba(255, 255, 255, .075) 50%, rgba(255, 255, 255, .075) 75%,
+                            transparent 75%, transparent);
+        background-image: -ms-linear-gradient(135deg, rgba(255, 255, 255, .075) 25%, transparent 25%,
+                            transparent 50%, rgba(255, 255, 255, .075) 50%, rgba(255, 255, 255, .075) 75%,
+                            transparent 75%, transparent);
+        background-image: -o-linear-gradient(135deg, rgba(255, 255, 255, .075) 25%, transparent 25%,
+                            transparent 50%, rgba(255, 255, 255, .075) 50%, rgba(255, 255, 255, .075) 75%,
+                            transparent 75%, transparent);
+        background-image: linear-gradient(135deg, rgba(255, 255, 255, .075) 25%, transparent 25%,
+                            transparent 50%, rgba(255, 255, 255, .075) 50%, rgba(255, 255, 255, .075) 75%,
+                            transparent 75%, transparent);
+        box-shadow: 3px 3px 2px rgba(0,0,0,.4);
+        border: 1px solid;
+        color: #fff;
+        padding: 15px;
+        text-shadow: 1px 2px 0 rgba(0,0,0,.5);}
+
+.warning{
+         background-color: #A35A00;
+         border-color: #713C00;}
+
+
+/* Tomorrow Theme */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* Pretty printing styles. Used with prettify.js. */
+/* SPAN elements with the classes below are added by prettyprint. */
+/* plain text */
+.pln{
+  color: #4d4d4c;}
+
+@media screen{
+  /* string content */
+  .str{
+    color: #718c00;}
+
+  /* a keyword */
+  .kwd{
+    color: #8959a8;}
+
+  /* a comment */
+  .com{
+    color: #8e908c;}
+
+  /* a type name */
+  .typ{
+    color: #4271ae;}
+
+  /* a literal value */
+  .lit{
+    color: #f5871f;}
+
+  /* punctuation */
+  .pun{
+    color: #4d4d4c;}
+
+  /* lisp open bracket */
+  .opn{
+    color: #4d4d4c;}
+
+  /* lisp close bracket */
+  .clo{
+    color: #4d4d4c;}
+
+  /* a markup tag name */
+  .tag{
+    color: #c82829;}
+
+  /* a markup attribute name */
+  .atn{
+    color: #f5871f;}
+
+  /* a markup attribute value */
+  .atv{
+    color: #3e999f;}
+
+  /* a declaration */
+  .dec{
+    color: #f5871f;}
+
+  /* a variable name */
+  .var{
+    color: #c82829;}
+
+  /* a function name */
+  .fun{
+    color: #4271ae;} }
+/* Use higher contrast and text-weight for printable form. */
+@media print, projection{
+  .str{
+    color: #060;}
+
+  .kwd{
+    color: #006;
+    font-weight: bold;}
+
+  .com{
+    color: #600;
+    font-style: italic;}
+
+  .typ{
+    color: #404;
+    font-weight: bold;}
+
+  .lit{
+    color: #044;}
+
+  .pun, .opn, .clo{
+    color: #440;}
+
+  .tag{
+    color: #006;
+    font-weight: bold;}
+
+  .atn{
+    color: #404;}
+
+  .atv{
+    color: #060;} }
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums{
+  margin-top: 0;
+  margin-bottom: 0;}
+

package/lib/AppConfig.js

@@ -0,0 +1,36 @@
+'use strict';
+
+var os = require('os');
+
+
+module.exports = AppConfig;
+
+function AppConfig(port) {
+  var vcapApplication = process.env.VCAP_APPLICATION && JSON.parse(process.env.VCAP_APPLICATION);
+
+  this.port = port || process.env.PORT;
+  this.host = cfHost(vcapApplication) || os.hostname(); // may contain port if running on the tub
+  this.url = getAppUrl(vcapApplication, this.port);
+}
+
+function cfHost(vcapApplication) {
+  if (vcapApplication) {
+    var uris = vcapApplication.uris;
+    if (uris.length > 0 && uris[0]) {
+      return uris[0];
+    }
+  }
+}
+
+function getAppUrl(vcapApplication, port) {
+  if (vcapApplication) {
+    if (vcapApplication.full_application_uris && vcapApplication.full_application_uris[0]) {
+      return vcapApplication.full_application_uris[0];
+    }
+    if (vcapApplication.uris && vcapApplication.uris[0]) {
+      return 'https://' + vcapApplication.uris[0];
+    }
+  }
+
+  return os.hostname() + ':' + port;
+}

package/lib/AuditLogger.js

@@ -0,0 +1,41 @@
+'use strict';
+
+var auditLog = require('@sap/audit-logging');
+
+module.exports = AuditLogger;
+
+function AuditLogger(credentials) {
+  this._credentials = credentials;
+  this._client = null;
+}
+
+AuditLogger.prototype.getClient = function (cb) {
+  if (this._client) {
+    return cb(null, this._client);
+  }
+
+  var self = this;
+  var credentials = this._credentials;
+  auditLog.v2(credentials, function (err, auditLogV2) {
+    // the client might have already been set by another call to this method,
+    // let's not overwrite what have been set
+    if (!self._client) {
+      var client = err ? auditLog(credentials) : auditLogV2;
+      self._client = client;
+    }
+
+    cb(null, self._client);
+  });
+};
+
+AuditLogger.prototype.logSecurityEvent = function (req, message, user, cb) {
+  var ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress;
+  ip = ip.split(',')[0];
+
+  this.getClient(function (err, client) {
+    client.securityMessage(message)
+      .by(user)
+      .externalIP(ip)
+      .log(cb);
+  });
+};

package/lib/cacert.js

@@ -0,0 +1,26 @@
+'use strict';
+
+var https = require('https');
+var assert = require('assert');
+var xsenv = require('@sap/xsenv');
+var logger = require('./logging').logger;
+
+exports.loadCertificates = loadCertificates;
+
+function loadCertificates(options) {
+  assert(!options.ca || Array.isArray(options.ca), 'ca option should be an array');
+
+  // options object is already cloned so it is ok to modify it here
+  options.ca = options.ca || xsenv.loadCertificates();
+  if (options.ca) {
+    https.globalAgent.options.ca = options.ca;
+  }
+
+  if (options.hana) {
+    if (options.hana.ca || options.hana.certificate) {
+      logger.info('Using encrypted HANA connection.');
+    } else {
+      logger.warn('Using unencrypted HANA connection.');
+    }
+  }
+}

package/lib/ctypes.js

@@ -0,0 +1,153 @@
+'use strict';
+
+var bigNumber = require('big.js');
+
+var MAX_INT64 = '9223372036854775807'; // 2^64 / 2 - 1
+var MIN_INT64 = '-9223372036854775808'; // -(2^64 / 2)
+var MAX_UINT64 = '18446744073709551615'; // 2^64 - 1
+
+var ctypes = {};
+function Int64(val) {
+  var sVal = val;
+  if (val instanceof ctypes.Int64 || val instanceof ctypes.UInt64) {
+    sVal = val.valueOf();
+  }
+  if (typeof sVal === 'string' && (sVal.indexOf('0x') === 0 || sVal.indexOf('-0x') === 0)) {
+    sVal = parseInt(sVal, 16);
+  }
+  _validateInt64(sVal);
+
+  if (!(this instanceof ctypes.Int64 || this instanceof ctypes.UInt64)) {
+    return new ctypes.Int64(sVal);
+  }
+  this._val = sVal;
+}
+
+function UInt64(val) {
+  var sVal = val;
+  if (val instanceof ctypes.Int64 || val instanceof ctypes.UInt64) {
+    sVal = val.valueOf();
+  }
+  if (typeof sVal === 'string' && (sVal.indexOf('0x') === 0 || sVal.indexOf('-0x') === 0)) {
+    sVal = parseInt(sVal, 16);
+  }
+  _validateUInt64(sVal);
+
+  if (!(this instanceof ctypes.Int64 || this instanceof ctypes.UInt64)) {
+    return new ctypes.UInt64(sVal);
+  }
+  this._val = sVal;
+}
+
+function valueOf() {
+  return this._val.toString();
+}
+
+function _compare(n1, n2) {
+  var a = bigNumber(n1.valueOf());
+  var b = bigNumber(n2.valueOf());
+
+  if (a.gt(b)) {
+    return 1;
+  } else if (a.eq(b)) {
+    return 0;
+  } else {
+    return -1;
+  }
+}
+
+function _validateInt64(val) {
+  var isInt64String = isInteger(val) && _compareNumericStrings(val, MAX_INT64) <= 0 && _compareNumericStrings(val, MIN_INT64) >= 0;
+
+  if (!isInt64String) {
+    throw new Error('expected type int64, got ' + JSON.stringify(val));
+  }
+}
+
+function _validateUInt64(val) {
+  var isUInt64String = isInteger(val) && _compareNumericStrings(val, MAX_UINT64) <= 0 && _compareNumericStrings(val, '0') >= 0;
+
+  if (!isUInt64String) {
+    throw new Error('expected type uint64, got ' + JSON.stringify(val));
+  }
+}
+
+function _compareInt64(n1, n2) {
+  if (!(n1 instanceof ctypes.Int64) || !(n2 instanceof ctypes.Int64)) {
+    throw new Error('compare takes two Int64 arguments');
+  }
+  return _compare(n1, n2);
+}
+
+function _compareUInt64(n1, n2) {
+  if (!(n1 instanceof ctypes.UInt64) || !(n2 instanceof ctypes.UInt64)) {
+    throw new Error('compare takes two UInt64 arguments');
+  }
+  return _compare(n1, n2);
+}
+
+function _compareNumericStrings(n1, n2) {
+  n1 = n1.toString();
+  n2 = n2.toString();
+  var normalizedPair;
+  if (n1.indexOf('-') === -1 && n2.indexOf('-') === -1) {
+    normalizedPair = _normalizePairWithLeadingZeros(n1, n2);
+    n1 = normalizedPair.n1;
+    n2 = normalizedPair.n2;
+    return (n1 > n2) ? 1 : (n1 === n2) ? 0 : -1;
+  } else if (n1.indexOf('-') === 0 && n2.indexOf('-') === -1) {
+    return -1;
+  } else if (n1.indexOf('-') === -1 && n2.indexOf('-') === 0) {
+    return 1;
+  } else if (n1.indexOf('-') === 0 && n2.indexOf('-') === 0) {
+    n1 = n1.substring(1, n1.length);
+    n2 = n2.substring(1, n2.length);
+    normalizedPair = _normalizePairWithLeadingZeros(n1, n2);
+    n1 = normalizedPair.n1;
+    n2 = normalizedPair.n2;
+    return (n1 < n2) ? 1 : (n1 === n2) ? 0 : -1;
+  }
+}
+
+function _normalizePairWithLeadingZeros(n1, n2) {
+  var diff;
+  var prefix;
+  if (n1.length > n2.length) {
+    diff = n1.length - n2.length;
+    prefix = new Array(diff + 1).join('0');
+    n2 = prefix.concat(n2);
+  } else if (n1.length < n2.length) {
+    diff = n2.length - n1.length;
+    prefix = new Array(diff + 1).join('0');
+    n1 = prefix.concat(n1);
+  }
+  return {n1: n1, n2: n2};
+}
+
+function toJSON() {
+  return this._val;
+}
+
+function isInteger(value) {
+  if (isNaN(value)) {
+    return false;
+  }
+  value = parseFloat(value);
+  return Number(value) === value && value % 1 === 0;
+}
+
+Int64.prototype.toJSON = toJSON;
+UInt64.prototype.toJSON = toJSON;
+Int64.prototype.valueOf = valueOf;
+UInt64.prototype.valueOf = valueOf;
+Int64.prototype.toString = valueOf;
+UInt64.prototype.toString = valueOf;
+ctypes.Int64 = Int64;
+ctypes.UInt64 = UInt64;
+ctypes.Int64.compare = _compareInt64;
+ctypes.UInt64.compare = _compareUInt64;
+ctypes.MAX_INT64 = MAX_INT64;
+ctypes.MIN_INT64 = MIN_INT64;
+ctypes.MAX_UINT64 = MAX_UINT64;
+
+module.exports = ctypes;

package/lib/destinations/dest-provider.js

@@ -0,0 +1,57 @@
+'use strict';
+
+var _ = require('lodash');
+var assert = require('assert');
+var VError = require('verror');
+var xsenv = require('@sap/xsenv');
+var utils = require('../utils');
+
+exports.defineDestinationProviderFunction = defineDestinationProviderFunction;
+exports.createDestinationProviderFunction = createDestinationProviderFunction;
+
+/**
+ * @param readServiceFunction - synchronous CF service read function accepting
+ * one argument the service name and returning the service details
+ * @returns {Function}
+ */
+function createDestinationProviderFunction(readServiceFunction) {
+  assert(_.isFunction(readServiceFunction),
+      'Valid service reader function should be provided');
+
+  return function getDestination(packagename, objectname, dtDescriptor) {
+    var destinationName = utils.toXSObjectId(packagename, objectname);
+    assert(destinationName,
+        'Valid destination packagename or objectname should be provided');
+
+    var rtDestination = readServiceFunction(destinationName);
+
+    if (!rtDestination) {
+      throw new VError(
+          'Configuration was not found for destination with name "%s"',
+          destinationName);
+    }
+
+    if (!dtDescriptor) {
+      return rtDestination;
+    }
+
+    return _.extend({}, dtDescriptor, rtDestination);
+  };
+}
+
+function defineDestinationProviderFunction(rt) {
+  assert(rt && rt.get, 'Valid runtime object should be provided');
+  var customProvider = rt.get('destinationProvider');
+
+  return (customProvider) ?
+      customProvider :
+      createDestinationProviderFunction(readService);
+}
+
+function readService(serviceName) {
+  var services = xsenv.filterCFServices(serviceName);
+  if (services.length > 0) {
+    return services[0].credentials;
+  }
+  return;
+}