@adobe/acc-js-sdk 1.0.3 → 1.0.7

package/src/optionCache.js

@@ -1,4 +1,3 @@
-"use strict";
 /*
 Copyright 2020 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -10,7 +9,8 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-
+(function() {
+"use strict";    
 
 /**********************************************************************************
  * 
@@ -18,6 +18,8 @@ governing permissions and limitations under the License.
  * 
  *********************************************************************************/
 const XtkCaster = require('./xtkCaster.js').XtkCaster;
+const { Cache } = require('./cache.js');
+
 
 /**
  * @namespace Campaign
@@ -31,23 +33,40 @@ const XtkCaster = require('./xtkCaster.js').XtkCaster;
 
 
 /**
- * A in-memory cache for xtk option values. Not intended to be used directly,
- * but an internal cache for the Campaign.Client object
- * 
  * @private
  * @class
  * @constructor
  * @memberof Campaign
  */
-class OptionCache {
+class OptionCache extends Cache {
     
-    constructor() {
-        /**
-         * The option values, by option name
-         * @private
-         * @type {Object<string,Campaign.XtkOption>}
-         */
-        this._optionsByName = {};
+    /**
+     * A in-memory cache for xtk option values. Not intended to be used directly,
+     * but an internal cache for the Campaign.Client object
+     * 
+     * Cached object are made of
+     * - the key is the option name
+     * - the value is the option, a JSON object made of value, type, and rawValue properties
+     * 
+     * @param {Storage} storage is an optional Storage object, such as localStorage or sessionStorage
+     * @param {string} rootKey is an optional root key to use for the storage object
+     * @param {number} ttl is the TTL for objects in ms. Defaults to 5 mins
+     */
+     constructor(storage, rootKey, ttl) {
+        super(storage, rootKey, ttl);
+    }
+
+    /**
+     * Cache an option and its value
+     * For backward compatibility purpose. Use "put" instead
+     * 
+     * @deprecated
+     * @param {string} name is the option name
+     * @param {Array} rawValueAndtype a 2 elements array, whose first element is the raw option value (text serialized) and the second element 
+     * is the data type of the option. Such an array is returned by the xtk:session#GetOption method
+     */
+     cache(schemaId, methodName) {
+        return this.put(schemaId, methodName);
     }
 
     /**
@@ -57,16 +76,16 @@ class OptionCache {
      * @param {Array} rawValueAndtype a 2 elements array, whose first element is the raw option value (text serialized) and the second element 
      * is the data type of the option. Such an array is returned by the xtk:session#GetOption method
      */
-    cache(name, rawValueAndtype) {
+    put(name, rawValueAndtype) {
         var value = null;
         var type = 0;
-        var rawValue = undefined;
+        var rawValue;
         if (rawValueAndtype && rawValueAndtype[1] != 0) {
             rawValue = rawValueAndtype[0];
             type = rawValueAndtype[1];
             value = XtkCaster.as(rawValue, type);
         }
-        this._optionsByName[name] = { value:value, type:type, rawValue:rawValue };
+        super.put(name, { value:value, type:type, rawValue:rawValue });
         return value;
     }
 
@@ -77,7 +96,7 @@ class OptionCache {
      * @returns {*} the option value
      */
     get(name) {
-        const option = this._optionsByName[name];
+        const option = super.get(name);
         return option ? option.value : undefined;
     }
 
@@ -88,19 +107,12 @@ class OptionCache {
      * @returns {Campaign.XtkOption} the option
      */
     getOption(name) {
-        const option = this._optionsByName[name];
-        return option;
+        return super.get(name);
     }
-
-    /**
-     * Clears the cache
-     */
-    clear() {
-        this._optionsByName = {};
-    }
-
 }
 
 
 // Public exports
-exports.OptionCache = OptionCache;
+exports.OptionCache = OptionCache;
+
+})();

package/src/soap.js

@@ -1,4 +1,3 @@
-"use strict";
 /*
 Copyright 2020 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -10,7 +9,9 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-
+(function() {
+"use strict";    
+    
 
 /**********************************************************************************
  * 
@@ -92,6 +93,8 @@ class SoapMethodCall {
         // Soap calls marked as internal are calls performed by the framework internally
         // (such as GetEntityIfMoreRecent calls needed to lookup schemas)
         this.internal = false;
+        // Enable soap retry
+        this.retry = true;
 
         this._sessionToken = sessionToken || "";
         this._securityToken = securityToken || "";
@@ -118,7 +121,8 @@ class SoapMethodCall {
      * @returns {boolean} indicates if the call requires a Logon first
      */
     requiresLogon() {
-        const requiresLogon = !(this.urn === "xtk:session" && this.methodName === "Logon");
+        const requiresLogon = !(this.urn === "xtk:session" && 
+                               (this.methodName === "Logon" || this.methodName === "BearerTokenLogon") ) ;
         return requiresLogon;
     }
 
@@ -149,22 +153,6 @@ class SoapMethodCall {
         this._method.setAttribute(`xmlns:m`, urnPath);
         this._method.setAttribute(`SOAP-ENV:encodingStyle`, encoding);
         this._data.appendChild(this._method);
-
-        if (this._sessionToken) {
-            const cookieHeader = this._doc.createElement("Cookie");
-            cookieHeader.textContent = `__sessiontoken=${this._sessionToken}`;
-            this._header.appendChild(cookieHeader);
-        }
-
-        const securityTokenHeader = this._doc.createElement("X-Security-Token");
-        securityTokenHeader.textContent = this._securityToken;
-        this._header.appendChild(securityTokenHeader);
-
-        // Always write a sessiontoken element as the first parameter. Even when using SecurityToken authentication
-        // and when the session token is actually passed implicitely as a cookie, one must write a sessiontoken
-        // element. If not, authentication will fail because the first parameter is interpreted as the "authentication mode"
-        // and eventually passed as the first parameter of CXtkLocalSessionPart::GetXtkSecurity
-        this.writeString("sessiontoken", this._sessionToken);
     }
 
     /**
@@ -514,7 +502,7 @@ class SoapMethodCall {
      * @returns a boolean set to true if ther are no more response args to read
      */ 
     checkNoMoreArgs() {
-        return !this.elemCurrent
+        return !this.elemCurrent;
     }
 
     /**
@@ -535,17 +523,55 @@ class SoapMethodCall {
             data: DomUtil.toXMLString(this._doc)
         };
         if (this._sessionToken)
-            options.headers['Cookie'] = '__sessiontoken=' + this._sessionToken;
+            options.headers.Cookie = '__sessiontoken=' + this._sessionToken;
         if (this._userAgentString)
             options.headers['User-Agent'] = this._userAgentString;
         return options;
     }
-
+    
     /**
      * Finalize a SOAP call just before sending
      * @param {string} url the endpoint (/nl/jsp/soaprouter.jsp)
+     * @param {client.Client} sdk client (optional)
      */
-    finalize(url) {
+    finalize(url, client) {
+        if (client) {
+            this._sessionToken = client._sessionToken;
+            this._securityToken = client._securityToken;
+        }
+
+        var cookieHeader = DomUtil.findElement(this._header, "Cookie");
+        if (this._sessionToken) {
+            if (!cookieHeader) {
+                cookieHeader = this._doc.createElement("Cookie");
+                this._header.appendChild(cookieHeader);
+            }
+            cookieHeader.textContent = `__sessiontoken=${this._sessionToken}`;
+        } else if (cookieHeader) {
+            cookieHeader.remove();
+        }
+
+        var securityTokenHeader = DomUtil.findElement(this._header, "X-Security-Token");
+        if (!securityTokenHeader) {
+            securityTokenHeader = this._doc.createElement("X-Security-Token");
+            this._header.appendChild(securityTokenHeader);
+        }
+        securityTokenHeader.textContent = this._securityToken;
+
+        // Always write a sessiontoken element as the first parameter. Even when using SecurityToken authentication
+        // and when the session token is actually passed implicitely as a cookie, one must write a sessiontoken
+        // element. If not, authentication will fail because the first parameter is interpreted as the "authentication mode"
+        // and eventually passed as the first parameter of CXtkLocalSessionPart::GetXtkSecurity
+        var sessionTokenElem = DomUtil.findElement(this._method, "sessiontoken");
+        if (sessionTokenElem) {
+            sessionTokenElem.textContent = this._sessionToken;
+        } else {
+            sessionTokenElem = this._doc.createElement("sessiontoken");
+            sessionTokenElem.setAttribute("xsi:type", "xsd:string");
+            // sessionTokenElem.setAttribute("SOAP-ENV:encodingStyle", SOAP_ENCODING_NATIVE);
+            sessionTokenElem.textContent = this._sessionToken;
+            this._method.prepend(sessionTokenElem);
+        }
         const options = this._createHTTPRequest(url);
         // Prepare request and empty response objects
         this.request = options;
@@ -563,6 +589,8 @@ class SoapMethodCall {
         const that = this;
         const promise = this._transport(this.request);
         return promise.then(function(body) {
+            if (body.indexOf(`XSV-350008`) != -1)
+                throw CampaignException.SESSION_EXPIRED();
             that.response = body;
             // Response is a serialized XML document with the following structure
             //
@@ -636,3 +664,5 @@ class SoapMethodCall {
 
 // Public exports
 exports.SoapMethodCall = SoapMethodCall;
+
+})();

package/src/transport.js

@@ -9,6 +9,8 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+(function() {
+"use strict";    
 
 const { Util } = require('./util.js');
 
@@ -70,9 +72,8 @@ if (!Util.isBrowser()) {
         return Promise.reject(new HttpError(500, error ? error.toString() : undefined));
       // HTTP errors (400, 404, 500, etc.) are returned here
       return Promise.reject(new HttpError(response.status, response.statusText, response.data));
-    })
-  }
-
+    });
+  };
 
   exports.request = request;
   exports.HttpError = HttpError;
@@ -107,13 +108,16 @@ if (!Util.isBrowser()) {
             return blob.text();
         });
     }).catch((ex) => {
-      if (ex.__proto__.constructor.name == "HttpError")
+      const proto = Object.getPrototypeOf(ex);
+      if (proto.constructor.name == "HttpError")
         throw ex;
       throw new HttpError(ex.status, ex.statusText);
-    })
+    });
     return p;
-  }
+  };
 
   module.exports.request = request;
 
-}
+}
+
+})();

package/src/util.js

@@ -1,5 +1,3 @@
-"use strict";
-
 /*
 Copyright 2020 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -11,7 +9,9 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-
+(function() {
+"use strict";    
+  
 
 /**********************************************************************************
  * 
@@ -20,83 +20,122 @@ governing permissions and limitations under the License.
  *********************************************************************************/
 
 /**
- * @namespace Campaign
+ * @namespace Utils
  */
 
 /**
- * Helpers for common manipulation of DOM documents
- * @memberof Campaign
+ * @memberof Utils
  * @class
  * @constructor
  */
 class Util {
 
-    static isBrowser() {
-        const browser = typeof window !== 'undefined';
-        return browser;
-    }
-    
-    static isArray(o) {
-        if (o === null || o === undefined) return false;
-        // JavaScript arrays are objects
-        if (typeof o != "object") return false;
-        // They also have a length property. But checking the length is not enough
-        // since, it can also be an object litteral with a "length" property. Campaign
-        // schema attributes typically have a "length" attribute and are not arrays
-        if (o.length === undefined || o.length === null) return false;
-        // So check for a "push" function
-        if (o.push === undefined || o.push === null) return false;
-        if (typeof o.push != "function") 
-            return false;
-        return true;
-    }
+  /**
+   * Generic helper functions available everywhere in the SDK. Al functions are static, it is not necessary to create new instances of this object
+   */
+  constructor() {
+  }
 
+  /**
+   * Indicates whether the SDK is running in a browser or not
+   * @returns {boolean} a boolean indicating if the SDK is running in a browser or not
+   */
+  static isBrowser() {
+    const browser = typeof window !== 'undefined';
+    return browser;
+  }
+  
+  /**
+   * Tests if an object is a JavaScript array
+   * @param {*} obj the object to test, may be undefined
+   * @returns {boolean} true if the object is an array
+   */
+  static isArray(obj) {
+    if (obj === null || obj === undefined) return false;
+    // JavaScript arrays are objects
+    if (typeof obj != "object") return false;
+    // They also have a length property. But checking the length is not enough
+    // since, it can also be an object litteral with a "length" property. Campaign
+    // schema attributes typically have a "length" attribute and are not arrays
+    if (obj.length === undefined || obj.length === null) return false;
+    // So check for a "push" function
+    if (obj.push === undefined || obj.push === null) return false;
+    if (typeof obj.push != "function") 
+        return false;
+    return true;
+  }
 
-    static _removeBetween(text, from, to) {
-        var index = 0;
-        while (index < text.length) {
-          index = text.indexOf(from, index);
-          if (index == -1) break;
-          const index2 = text.indexOf(to, index);
-          if (index2 == -1) {
-            break;
-          }
-          text = text.substring(0, index + from.length) + '***' + text.substring(index2);
-          index = index2;
-        }
-        return text;
+  // Helper function for trim() to replace text between 2 indices
+  static _removeBetween(text, from, to) {
+    var index = 0;
+    while (index < text.length) {
+      index = text.indexOf(from, index);
+      if (index == -1) break;
+      const index2 = text.indexOf(to, index);
+      if (index2 == -1) {
+        break;
       }
-    
-      static trim(text) {
-        if (text == null || text == undefined) return undefined;
-        if (Util.isArray(text)) {
-          const a = [];
-          for (const p of text) {
-            a.push(Util.trim(p));
-          }
-          return a;
-        }
-        if (typeof text == "object") {
-          for (const p in text) {
-            text[p] = Util.trim(text[p]);
+      text = text.substring(0, index + from.length) + '***' + text.substring(index2);
+      index = index2;
+    }
+    return text;
+  }
+  
+  /**
+   * Trims a text, an object or an array and remove sensitive information, such as session tokens, passwords, etc.
+   * 
+   * @param {string|Object|Array} obj is the object to trim
+   * @returns {string|Object|Array} the trimmed object
+   */
+  static trim(obj) {
+    if (obj == null || obj == undefined) return undefined;
+    if (Util.isArray(obj)) {
+      const a = [];
+      for (const p of obj) {
+        a.push(Util.trim(p));
+      }
+      return a;
+    }
+    if (typeof obj == "object") {
+      for (const p in obj) {
+        if (p.toLowerCase() === "x-security-token")
+          obj[p] = "***";
+        else if (p === "Cookie") {
+          var index = obj[p].toLowerCase().indexOf("__sessiontoken");
+          if (index !== -1) {
+            index = obj[p].indexOf("=", index);
+            if (index !== -1) {
+              index = index + 1;
+              const endIndex = obj[p].indexOf(";", index);
+              if (endIndex == -1)
+                obj[p] = obj[p].substring(0, index) + "***";
+              else 
+                obj[p] = obj[p].substring(0, index) + "***" + obj[p].substring(endIndex);
+            }
           }
         }
-        if (typeof text == "string") {
-          // Remove trailing blanks
-          while (text && (text.endsWith(' ') || text.endsWith('\n') || text.endsWith('\r') || text.endsWith('\t')))
-            text = text.substring(0, text.length - 1);
-    
-          // Hide session tokens
-          text = this._removeBetween(text, "<Cookie>__sessiontoken=", "</Cookie>");
-          text = this._removeBetween(text, "<X-Security-Token>", "</X-Security-Token>");
-          text = this._removeBetween(text, '<sessiontoken xsi:type="xsd:string">', '</sessiontoken>');
-          text = this._removeBetween(text, "<pstrSessionToken xsi:type='xsd:string'>", "</pstrSessionToken>");
-          text = this._removeBetween(text, "<pstrSecurityToken xsi:type='xsd:string'>", "</pstrSecurityToken>");
-        }
-        return text;
+        else
+          obj[p] = Util.trim(obj[p]);
       }
+    }
+    if (typeof obj == "string") {
+      // Remove trailing blanks
+      while (obj && (obj.endsWith(' ') || obj.endsWith('\n') || obj.endsWith('\r') || obj.endsWith('\t')))
+        obj = obj.substring(0, obj.length - 1);
 
+      // Hide session tokens
+      obj = this._removeBetween(obj, "<Cookie>__sessiontoken=", "</Cookie>");
+      obj = this._removeBetween(obj, "<X-Security-Token>", "</X-Security-Token>");
+      obj = this._removeBetween(obj, '<sessiontoken xsi:type="xsd:string">', '</sessiontoken>');
+      obj = this._removeBetween(obj, "<pstrSessionToken xsi:type='xsd:string'>", "</pstrSessionToken>");
+      obj = this._removeBetween(obj, "<pstrSecurityToken xsi:type='xsd:string'>", "</pstrSecurityToken>");
+      obj = this._removeBetween(obj, '<password xsi:type="xsd:string">', '</password>');
+    }
+    return obj;
+  }
 }
 
 // Public expots
 exports.Util = Util;
+
+})();

package/src/xtkCaster.js

@@ -1,4 +1,3 @@
-"use strict";
 /*
 Copyright 2020 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -10,7 +9,10 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+(function() {
+"use strict";    
 
+const { Util } = require('./util.js');
 
 /**********************************************************************************
  * 
@@ -37,11 +39,15 @@ governing permissions and limitations under the License.
 |     Xtk type |    | JS type | Comment |
 | ------------ |----|-------- | --- |
 |       string |  6 |  string | never null, defaults to "" |
-|         memo | 12 |  string |
-|        CDATA | 13 |  string |
+|         memo | 12 |  string | large strings. Never null, defaults to ""
+|        CDATA | 13 |  string | string in the CDATA section of an XML document. Never null, defaults to ""
+|         uuid |    |  string |
+|         blob |    |  string | 
+|         html |    |  string | 
 |         byte |  1 |  number | signed integer in the [-128, 128[ range. Never null, defaults to 0 |
 |        short |  2 |  number | signed 16 bits integer in the [-32768, 32768[ range. Never null, defaults to 0 |
 |         long |  3 |  number | signed 32 bits integer. Never null, defaults to 0 |
+|          int |    |  number | signed 32 bits integer. Never null, defaults to 0 |
 |        int64 |    | string  | signed 64 bits integer. As JavaScript handles all numbers as doubles, it's not possible to properly represent an int64 as a number, and it's therefore represented as a string.
 |        float |  4 |  number | single-percision numeric value. Never null, defaults to 0 |
 |       double |  5 |  number | single-percision numeric value. Never null, defaults to 0 |
@@ -49,22 +55,24 @@ governing permissions and limitations under the License.
 |   datetimetz |    |         | |
 | datetimenotz |    |         | |
 |         date | 10 |    Date | UTC timestamp with day precision. Can be null |
+|     timespan | 14 |  number | A timespan, in seconds
 |      boolean | 15 | boolean | boolean value, defaultint to false. Cannot be null |
-|     timespan |    |         | |
+|        array |    |   Array | a array or a collection
 
- * @typedef {(0|''|6|'string'|'int64'|12|13|'memo'|'CDATA'|1|'byte'|2|'short'|3|'long'|15|'boolean'|4|5|'float'|'double'|7|'datetime'|'datetimetz'|'datetimenotz'|10|'date')} XtkType
+ * @typedef {(0|''|6|'string'|'int64'|12|13|'memo'|'CDATA'|1|'byte'|2|'short'|3|'long'|15|'boolean'|4|5|'float'|'double'|7|'datetime'|'datetimetz'|'datetimenotz'|10|'date'|14|'timespan'|'array')} XtkType
  * @memberof Campaign
  */
 
-/**
- * Helpers to convert between JavaScript data types and Campaign XTK data types
- * 
+/** 
  * @memberof Campaign
  * @class
  * @constructor
  */
 class XtkCaster {
     
+    /**
+     * Helpers to convert between JavaScript data types and Campaign XTK data types
+     */
     constructor() {
     }
 
@@ -84,10 +92,13 @@ class XtkCaster {
                 return null;
             case 6:             // FIELD_SZ
             case "string":
+            case "uuid":
             case "int64":
                 return "stringValue";
             case 12:            // FIELD_MEMO
             case 13:            // FIELD_MEMOSHORT
+            case "blob":
+            case "html":
             case "memo":
             case "CDATA": 
                     return "memoValue";
@@ -96,8 +107,10 @@ class XtkCaster {
             case 2:             // FIELD_SHORT
             case "short": 
             case 3:             // FIELD_LONG
+            case "int":
             case "long":
-            case 15:            // FIELD_BOOLEAN
+            case "timespan":
+                case 15:            // FIELD_BOOLEAN
             case "boolean":
                     return "longValue";
             case 4:             // FIELD_FLOAT
@@ -111,7 +124,7 @@ class XtkCaster {
             case "datetimenotz": 
             case 10:            // FIELD_DATE
             case "date": 
-                return "timeStampValue"
+                return "timeStampValue";
             default: {
                 throw CampaignException.BAD_PARAMETER("type", type, `Cannot get variant storage attribute name for type '${type}'`);
             }
@@ -136,6 +149,9 @@ class XtkCaster {
             case 13:            // FIELD_MEMOSHORT
             case "string":
             case "memo":
+            case "uuid":
+            case "blob":
+            case "html":
             case "CDATA": {
                 return this.asString(value);
             }
@@ -148,6 +164,7 @@ class XtkCaster {
                 return this.asShort(value);
             }
             case 3:             // FIELD_LONG
+            case "int":
             case "long": {
                 return this.asLong(value);
             }
@@ -174,6 +191,13 @@ class XtkCaster {
             case "date": {
                 return this.asDate(value);
             }
+            case "array": {
+                return this.asArray(value);
+            }
+            case 14:            // FIELD_TIMESPAN
+            case "timespan": {
+                return this.asTimespan(value);
+            }
             default: {
                 throw CampaignException.BAD_PARAMETER("type", type, `Cannot convert value type='${type}', value='${value}'`);
             }
@@ -353,7 +377,7 @@ class XtkCaster {
     }
 
     /**
-     * Convert a raw value into a  date. This is a UTC timestamp where time fields are 0
+     * Convert a raw value into a date. This is a UTC timestamp where time fields are 0
      *
      * @param {*} value is the raw value to convert
      * @return {Date} a date
@@ -368,6 +392,37 @@ class XtkCaster {
         }
         return timestamp;
     }
+
+    /**
+     * Convert a raw value into an array (if it is not an array yet). Null and undefined will be
+     * converted into an empty array
+     *
+     * @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];
+    }
+
+    /**
+     * Convert a raw value into a timespan, in seconds
+     * @param {*} value is the raw value to convert
+     * @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;
+    }
+
 }
 
 exports.XtkCaster = XtkCaster;
+
+})();