@adobe/acc-js-sdk 1.1.61 → 1.2.0

package/src/xtkCaster.js

@@ -10,22 +10,22 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 (function() {
-"use strict";    
+  "use strict";    
 
-const { Util } = require('./util.js');
+  const { Util } = require('./util.js');
 
-/**********************************************************************************
+  /**********************************************************************************
  * 
  * Helper class to cast values to and from their Xtk versions
  * 
  *********************************************************************************/
- const { CampaignException } = require('./campaign.js');
+  const { CampaignException } = require('./campaign.js');
 
-/**
+  /**
  * @namespace Campaign
  */
 
-/**
+  /**
  * Campaign XTK types
  * 
  * 
@@ -64,12 +64,12 @@ const { Util } = require('./util.js');
  * @memberof Campaign
  */
 
-/** 
+  /** 
  * @memberof Campaign
  * @class
  * @constructor
  */
-class XtkCaster {
+  class XtkCaster {
     
     /**
      * Helpers to convert between JavaScript data types and Campaign XTK data types
@@ -86,51 +86,51 @@ class XtkCaster {
      */
     // See "variant" element in xtk:common srcSchema
     static _variantStorageAttribute(type) {
-        if (type === null || type === undefined) return null;
-        switch(type) {
-            case 0:             // FIELD_NONE
-            case "":
-                return null;
-            case 6:             // FIELD_SZ
-            case "string":
-            case "uuid":
-            case "int64":
-            case "primarykey":
-                return "stringValue";
-            case 12:            // FIELD_MEMO
-            case 13:            // FIELD_MEMOSHORT
-            case "blob":
-            case "html":
-            case "memo":
-            case "CDATA": 
-                    return "memoValue";
-            case 1:             // FIELD_BYTE
-            case "byte":
-            case 2:             // FIELD_SHORT
-            case "short": 
-            case 3:             // FIELD_LONG
-            case "int":
-            case "long":
-            case "timespan":
-                case 15:            // FIELD_BOOLEAN
-            case "boolean":
-                    return "longValue";
-            case 4:             // FIELD_FLOAT
-            case 5:             // FIELD_DOUBLE
-            case "float":
-            case "double":
-                return "doubleValue";
-            case 7:             // FIELD_DATETIME
-            case "datetime": 
-            case "datetimetz": 
-            case "datetimenotz": 
-            case 10:            // FIELD_DATE
-            case "date": 
-                return "timeStampValue";
-            default: {
-                throw CampaignException.BAD_PARAMETER("type", type, `Cannot get variant storage attribute name for type '${type}'`);
-            }
-        }
+      if (type === null || type === undefined) return null;
+      switch(type) {
+      case 0:             // FIELD_NONE
+      case "":
+        return null;
+      case 6:             // FIELD_SZ
+      case "string":
+      case "uuid":
+      case "int64":
+      case "primarykey":
+        return "stringValue";
+      case 12:            // FIELD_MEMO
+      case 13:            // FIELD_MEMOSHORT
+      case "blob":
+      case "html":
+      case "memo":
+      case "CDATA": 
+        return "memoValue";
+      case 1:             // FIELD_BYTE
+      case "byte":
+      case 2:             // FIELD_SHORT
+      case "short": 
+      case 3:             // FIELD_LONG
+      case "int":
+      case "long":
+      case "timespan":
+      case 15:            // FIELD_BOOLEAN
+      case "boolean":
+        return "longValue";
+      case 4:             // FIELD_FLOAT
+      case 5:             // FIELD_DOUBLE
+      case "float":
+      case "double":
+        return "doubleValue";
+      case 7:             // FIELD_DATETIME
+      case "datetime": 
+      case "datetimetz": 
+      case "datetimenotz": 
+      case 10:            // FIELD_DATE
+      case "date": 
+        return "timeStampValue";
+      default: {
+        throw CampaignException.BAD_PARAMETER("type", type, `Cannot get variant storage attribute name for type '${type}'`);
+      }
+      }
     }
 
     /**
@@ -141,72 +141,72 @@ class XtkCaster {
      * @returns {*} the value casted to the requested type, following XTK rules
      */
     static as(value, type) {
-        switch(type) {
-            case 0:             // FIELD_NONE
-            case "": {
-                return value;
-            }
-            case 6:             // FIELD_SZ
-            case 12:            // FIELD_MEMO
-            case 13:            // FIELD_MEMOSHORT
-            case "string":
-            case "memo":
-            case "uuid":
-            case "blob":
-            case "html":
-            case "CDATA": {
-                return this.asString(value);
-            }
-            case 1:             // FIELD_BYTE
-            case "byte": {
-                return this.asByte(value);
-            }
-            case 2:             // FIELD_SHORT
-            case "short": {
-                return this.asShort(value);
-            }
-            case 3:             // FIELD_LONG
-            case "int":
-            case "long": {
-                return this.asLong(value);
-            }
-            case "int64": {
-                return this.asInt64(value);
-            }
-            case 4:             // FIELD_FLOAT
-            case 5:             // FIELD_DOUBLE
-            case "float":
-            case "double": {
-                return this.asNumber(value);
-            }
-            case 15:            // FIELD_BOOLEAN
-            case "boolean": {
-                return this.asBoolean(value);
-            }
-            case 7:             // FIELD_DATETIME
-            case "datetime": 
-            case "datetimetz": 
-            case "datetimenotz": {
-                return this.asTimestamp(value);
-            }
-            case 10:            // FIELD_DATE
-            case "date": {
-                return this.asDate(value);
-            }
-            case "array": {
-                return this.asArray(value);
-            }
-            case 14:            // FIELD_TIMESPAN
-            case "timespan": {
-                return this.asTimespan(value);
-            }
-            case "primarykey": {
-                return this.asPrimaryKey(value);
-            }
-            default: {
-                throw CampaignException.BAD_PARAMETER("type", type, `Cannot convert value type='${type}', value='${value}'`);
-            }
-        }
+      switch(type) {
+      case 0:             // FIELD_NONE
+      case "": {
+        return value;
+      }
+      case 6:             // FIELD_SZ
+      case 12:            // FIELD_MEMO
+      case 13:            // FIELD_MEMOSHORT
+      case "string":
+      case "memo":
+      case "uuid":
+      case "blob":
+      case "html":
+      case "CDATA": {
+        return this.asString(value);
+      }
+      case 1:             // FIELD_BYTE
+      case "byte": {
+        return this.asByte(value);
+      }
+      case 2:             // FIELD_SHORT
+      case "short": {
+        return this.asShort(value);
+      }
+      case 3:             // FIELD_LONG
+      case "int":
+      case "long": {
+        return this.asLong(value);
+      }
+      case "int64": {
+        return this.asInt64(value);
+      }
+      case 4:             // FIELD_FLOAT
+      case 5:             // FIELD_DOUBLE
+      case "float":
+      case "double": {
+        return this.asNumber(value);
+      }
+      case 15:            // FIELD_BOOLEAN
+      case "boolean": {
+        return this.asBoolean(value);
+      }
+      case 7:             // FIELD_DATETIME
+      case "datetime": 
+      case "datetimetz": 
+      case "datetimenotz": {
+        return this.asTimestamp(value);
+      }
+      case 10:            // FIELD_DATE
+      case "date": {
+        return this.asDate(value);
+      }
+      case "array": {
+        return this.asArray(value);
+      }
+      case 14:            // FIELD_TIMESPAN
+      case "timespan": {
+        return this.asTimespan(value);
+      }
+      case "primarykey": {
+        return this.asPrimaryKey(value);
+      }
+      default: {
+        throw CampaignException.BAD_PARAMETER("type", type, `Cannot convert value type='${type}', value='${value}'`);
+      }
+      }
     }
 
     /**
@@ -216,29 +216,29 @@ class XtkCaster {
      * @return {string} a string value, guaranteed to be valid
      */
     static asString(value) {
-        if (value === null || value === undefined) return "";
-        if (value != value || value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY) return "";
-        if (value instanceof Date) {
-            if (isNaN(value.getTime()))
-                return "";  // Invalid JavaScript date
-            return value.toISOString();
+      if (value === null || value === undefined) return "";
+      if (value != value || value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY) return "";
+      if (value instanceof Date) {
+        if (isNaN(value.getTime()))
+          return "";  // Invalid JavaScript date
+        return value.toISOString();
+      }
+      if ((typeof value) == "object") {
+        if (XtkCaster.isPrimaryKey(value)) {
+          let result = value.schemaId;
+          for (let i=0; i<value.values.length; i++) {
+            result = result + "|";
+            let item = value.values[i];
+            if (item === null || item === undefined) continue;
+            if (typeof item !== "string") item = XtkCaster.asString(item);
+            const escaped = item.replace(/\|/g, "\\|").replace(/"/g, "\\\""); // escape | and " chars
+            result = result + escaped;
+          }
+          return result;
         }
-        if ((typeof value) == "object") {
-            if (XtkCaster.isPrimaryKey(value)) {
-                let result = value.schemaId;
-                for (let i=0; i<value.values.length; i++) {
-                    result = result + "|";
-                    let item = value.values[i];
-                    if (item === null || item === undefined) continue;
-                    if (typeof item !== "string") item = XtkCaster.asString(item);
-                    const escaped = item.replace(/\|/g, "\\|").replace(/\"/g, "\\\""); // escape | and " chars
-                    result = result + escaped;
-                }
-                return result;
-            }
-            return "";
-        }
-        return value.toString();
+        return "";
+      }
+      return value.toString();
     }
 
     /**
@@ -249,15 +249,15 @@ class XtkCaster {
      * @return {boolean} a boolean value, guaranteed to be true or false
      */
     static asBoolean(value, defaultValue) {
-        if (defaultValue === undefined) defaultValue = false;
-        if (value === null || value === undefined) return defaultValue;
-        if (value === true || value === false) return value;
-        var stringValue = value.toString().toLowerCase().trim();
-        if (stringValue === "false" || stringValue === "") return false;
-        if (stringValue === "true") return true;
-        var intValue = parseInt(value, 10);
-        if (isNaN(intValue)) return false;
-        return intValue !== 0;
+      if (defaultValue === undefined) defaultValue = false;
+      if (value === null || value === undefined) return defaultValue;
+      if (value === true || value === false) return value;
+      var stringValue = value.toString().toLowerCase().trim();
+      if (stringValue === "false" || stringValue === "") return false;
+      if (stringValue === "true") return true;
+      var intValue = parseInt(value, 10);
+      if (isNaN(intValue)) return false;
+      return intValue !== 0;
     }
 
     /**
@@ -266,14 +266,14 @@ class XtkCaster {
      * @param {*} value is the raw value to convert
      * @return {number} a numercial value, guaranteed to be valid and in the [-128, 127] range
      */
-     static asByte(value) {
-        var number = this.asNumber(value);
-        if( number ) {
-            number = Math.round(number);
-            if( number < -128) number = -128;
-            if( number > 127) number = 127;
-        }
-        return number;
+    static asByte(value) {
+      var number = this.asNumber(value);
+      if( number ) {
+        number = Math.round(number);
+        if( number < -128) number = -128;
+        if( number > 127) number = 127;
+      }
+      return number;
     }
 
     /**
@@ -283,13 +283,13 @@ class XtkCaster {
      * @return {number} a numercial value, guaranteed to be valid and in the [-32768, 32767] range
      */
     static asShort(value) {
-        var number = this.asNumber(value);
-        if( number ) {
-            number = Math.round(number);
-            if( number < -32768) number = -32768;
-            if( number > 32767) number = 32767;
-        }
-        return number;
+      var number = this.asNumber(value);
+      if( number ) {
+        number = Math.round(number);
+        if( number < -32768) number = -32768;
+        if( number > 32767) number = 32767;
+      }
+      return number;
     }
 
     /**
@@ -299,13 +299,13 @@ class XtkCaster {
      * @return {number} a numercial value, guaranteed to be valid and in the [-2147483648, 2147483647] range
      */
     static asLong(value) {
-        var number = this.asNumber(value);
-        if( number ) {
-            number = Math.round(number);
-            if( number < -2147483648) number = -2147483648;
-            if( number > 2147483647) number = 2147483647;
-        }
-        return number;
+      var number = this.asNumber(value);
+      if( number ) {
+        number = Math.round(number);
+        if( number < -2147483648) number = -2147483648;
+        if( number > 2147483647) number = 2147483647;
+      }
+      return number;
     }
 
     /**
@@ -316,14 +316,14 @@ class XtkCaster {
      * @return {string} a string value representing the number
      */
     static asInt64(value) {
-        if (value === null || value === undefined || value === "") return "0";
-        if (isNaN(value) || value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY) return "0";
-        if ((typeof value) == "object") return "0";
-        if ((typeof value) == "boolean") return value ? "1" : "0";
-        var number = String(value).trim();
-        if (number.indexOf(".") != -1) return "0";
-        if (number == "") return "0";
-        return number;
+      if (value === null || value === undefined || value === "") return "0";
+      if (isNaN(value) || value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY) return "0";
+      if ((typeof value) == "object") return "0";
+      if ((typeof value) == "boolean") return value ? "1" : "0";
+      var number = String(value).trim();
+      if (number.indexOf(".") != -1) return "0";
+      if (number == "") return "0";
+      return number;
     }
 
     /**
@@ -333,7 +333,7 @@ class XtkCaster {
      * @return {number} a numercial value, guaranteed to be valid
      */
     static asFloat(value) {
-        return this.asNumber(value);
+      return this.asNumber(value);
     }
 
     /**
@@ -343,7 +343,7 @@ class XtkCaster {
      * @return {number} a numercial value, guaranteed to be valid
      */
     static asDouble(value) {
-        return this.asNumber(value);
+      return this.asNumber(value);
     }
 
     /**
@@ -353,11 +353,11 @@ class XtkCaster {
      * @return {number} a numercial value, guaranteed to be valid
      */
     static asNumber(value) {
-        if (value === null || value === undefined || value === "") return 0;
-        if (isNaN(value) || value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY) return 0;
-        if ((typeof value) == "object") return 0;
-        var number = +value;
-        return number;
+      if (value === null || value === undefined || value === "") return 0;
+      if (isNaN(value) || value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY) return 0;
+      if ((typeof value) == "object") return 0;
+      var number = +value;
+      return number;
     }
 
     /**
@@ -366,8 +366,8 @@ class XtkCaster {
      * @param {*} value is the raw value to convert
      * @return {Date} the timestamp, possibly null
      */
-     static asDatetime(value) {
-        return this.asTimestamp(value);
+    static asDatetime(value) {
+      return this.asTimestamp(value);
     }
 
     /**
@@ -377,32 +377,32 @@ class XtkCaster {
      * @return {Date} the timestamp, possibly null
      */
     static asTimestamp(value) {
-        if (value === null || value === undefined) return null;
-        if ((typeof value) == "string") value = value.trim();
-        if (value === "" || value === true || value === false) return null;
-        if (value !== value || value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY) return null;
-
-        var timestamp = null;
-        if (value instanceof Date)
-            timestamp = value;
+      if (value === null || value === undefined) return null;
+      if ((typeof value) == "string") value = value.trim();
+      if (value === "" || value === true || value === false) return null;
+      if (value !== value || value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY) return null;
+
+      var timestamp = null;
+      if (value instanceof Date)
+        timestamp = value;
         // Number to timestamp -> Consider as number of seconds since epoch
-        else if ((typeof value) == "number") {
-            timestamp = new Date(0);
-            timestamp.setUTCSeconds(value);
+      else if ((typeof value) == "number") {
+        timestamp = new Date(0);
+        timestamp.setUTCSeconds(value);
+      }
+      else {
+        var number = +value;
+        if (number === number){
+          timestamp = new Date(0);
+          timestamp.setUTCSeconds(value);
         }
-        else {
-            var number = +value;
-            if (number === number){
-                timestamp = new Date(0);
-                timestamp.setUTCSeconds(value);
-            }
-            // Parse ISO string. Example: "2018-11-18 01:00:04.690Z"
-            else if ((typeof value) == "string") {
-                timestamp = new Date(value);
-            }
+        // Parse ISO string. Example: "2018-11-18 01:00:04.690Z"
+        else if ((typeof value) == "string") {
+          timestamp = new Date(value);
         }
-        if (!timestamp || isNaN(timestamp.getTime())) return null;
-        return timestamp;
+      }
+      if (!timestamp || isNaN(timestamp.getTime())) return null;
+      return timestamp;
     }
 
     /**
@@ -412,14 +412,14 @@ class XtkCaster {
      * @return {Date} a date
      */
     static asDate(value) {
-        var timestamp = this.asTimestamp(value);
-        if (timestamp) {
-            timestamp.setUTCHours(0);
-            timestamp.setUTCMinutes(0);
-            timestamp.setUTCSeconds(0);
-            timestamp.setUTCMilliseconds(0);
-        }
-        return timestamp;
+      var timestamp = this.asTimestamp(value);
+      if (timestamp) {
+        timestamp.setUTCHours(0);
+        timestamp.setUTCMinutes(0);
+        timestamp.setUTCSeconds(0);
+        timestamp.setUTCMilliseconds(0);
+      }
+      return timestamp;
     }
 
     /**
@@ -429,10 +429,10 @@ class XtkCaster {
      * @param {*} value is the raw value to convert
      * @return {Array} a array
      */
-     static asArray(value) {
-        if (value === null || value === undefined) return [];
-        if (Util.isArray(value)) return value;
-        return [value];
+    static asArray(value) {
+      if (value === null || value === undefined) return [];
+      if (Util.isArray(value)) return value;
+      return [value];
     }
 
     /**
@@ -441,13 +441,13 @@ class XtkCaster {
      * @returns is the time span, in seconds
      */
     static asTimespan(value) {
-        if (value === null || value === undefined) return 0;
-        if ((typeof value) == "string") value = value.trim();
-        if (value === "" || value === true || value === false) return 0;
-        if (value !== value || value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY) return 0;
-        // Number to timespan -> Consider as number of seconds
-        var timespan = XtkCaster.asLong(value);
-        return timespan;
+      if (value === null || value === undefined) return 0;
+      if ((typeof value) == "string") value = value.trim();
+      if (value === "" || value === true || value === false) return 0;
+      if (value !== value || value === Number.POSITIVE_INFINITY || value === Number.NEGATIVE_INFINITY) return 0;
+      // Number to timespan -> Consider as number of seconds
+      var timespan = XtkCaster.asLong(value);
+      return timespan;
     }
     
     /**
@@ -456,27 +456,27 @@ class XtkCaster {
      * @param {*} value is the raw value to convert
      * @return {PrimaryKey} a primary key
      */
-     static asPrimaryKey(value) {
-        if (value === null || value === undefined) return undefined;
-        if (this.isPrimaryKey(value)) return value;
-        value = value.toString();
-        let index = value.indexOf('|');
-        if (index <= 0) return undefined; // no schema id or empty schema id
-        const primaryKey = {
-            schemaId: value.substring(0, index),
-            values: []
-        };
-        value = value.substring(index+1) + "|";
-        let start = 0;
-        for(var i=0; i<value.length; i++) {
-            const c = value[i];
-            if (c === '\\') { i = i + 1; continue; } // escaped char
-            if (c === '|') {
-                primaryKey.values.push(value.substring(start, i).replace(/\\/g, ""));
-                start = i + 1;
-            }
+    static asPrimaryKey(value) {
+      if (value === null || value === undefined) return undefined;
+      if (this.isPrimaryKey(value)) return value;
+      value = value.toString();
+      let index = value.indexOf('|');
+      if (index <= 0) return undefined; // no schema id or empty schema id
+      const primaryKey = {
+        schemaId: value.substring(0, index),
+        values: []
+      };
+      value = value.substring(index+1) + "|";
+      let start = 0;
+      for(var i=0; i<value.length; i++) {
+        const c = value[i];
+        if (c === '\\') { i = i + 1; continue; } // escaped char
+        if (c === '|') {
+          primaryKey.values.push(value.substring(start, i).replace(/\\/g, ""));
+          start = i + 1;
         }
-        return primaryKey;
+      }
+      return primaryKey;
     }
 
     /**
@@ -485,7 +485,7 @@ class XtkCaster {
      * @returns {boolean} true if the type is a date and/or time type
      */
     static isTimeType(type) {
-        return type === "datetime" || type === "datetimetz" || type === "datetimenotz" || type === "timestamp" || type === "date" || type === "time" || type === "timespan" || type === 7 || type === 10 || type === 14;
+      return type === "datetime" || type === "datetimetz" || type === "datetimenotz" || type === "timestamp" || type === "date" || type === "time" || type === "timespan" || type === 7 || type === 10 || type === 14;
     }
 
     /**
@@ -494,7 +494,7 @@ class XtkCaster {
      * @returns {boolean} true if the type is a string type
      */
     static isStringType(type) {
-        return type === "string" || type === "memo" || type === 6 || type === 12 || type === 13 || type === "blob" || type === "html" || type === "CDATA";
+      return type === "string" || type === "memo" || type === 6 || type === 12 || type === 13 || type === "blob" || type === "html" || type === "CDATA";
     }
 
     /**
@@ -503,7 +503,7 @@ class XtkCaster {
      * @returns {boolean} true if the type is a numeric type
      */
     static isNumericType(type) {
-        return type === "byte" || type === 1 || type === "short" || type === 2 || type === "int" || type === "long" || type === 3 || type === "float" || type === 4 || type === "double" || type === 5 || type === "timespan" || type === 14;
+      return type === "byte" || type === 1 || type === "short" || type === 2 || type === "int" || type === "long" || type === 3 || type === "float" || type === 4 || type === "double" || type === 5 || type === "timespan" || type === 14;
     }
 
     /**
@@ -512,12 +512,12 @@ class XtkCaster {
      * @returns true or false depending on whether the object is a primary key or not
      */
     static isPrimaryKey(value) {
-        if (!value) return false;
-        return !!(value.schemaId && value.values && Util.isArray(value.values));
+      if (!value) return false;
+      return !!(value.schemaId && value.values && Util.isArray(value.values));
     }
-}
+  }
 
 
-exports.XtkCaster = XtkCaster;
+  exports.XtkCaster = XtkCaster;
 
 })();