@adobe/acc-js-sdk 1.1.62 → 1.2.0

package/src/entityAccessor.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";
 
-/**********************************************************************************
+  /**********************************************************************************
  * 
  * Helper function to navigate an entity, regardless of its representation
  * 
  *********************************************************************************/
-const XtkCaster = require('./xtkCaster.js').XtkCaster;
-const { DomUtil, BadgerFishObject } = require('./domUtil.js');
-const { Util } = require("./util.js");
+  const XtkCaster = require('./xtkCaster.js').XtkCaster;
+  const { DomUtil, BadgerFishObject } = require('./domUtil.js');
+  const { Util } = require("./util.js");
 
-/**
+  /**
  * @namespace XML
  */
 
-/**
+  /**
  * The XtkObject type is a Campaign entity, represented either as a DOM element, or as a JavaScript
  * literal object, depending on the selected representation (xml, SimpleJson or BadgerFish)
  * 
@@ -33,7 +33,7 @@ const { Util } = require("./util.js");
  * @memberOf XML
  */
 
-/**
+  /**
  * An entity accessor enables you to access properties of entity objects manipulated by
  * the JS SDK. With the representations mechanism, the SDK can work with either xml or
  * json documents. You can use the DOM API to manipulate XML documents, and native
@@ -45,7 +45,7 @@ const { Util } = require("./util.js");
  * @class
  * @memberof XML
  */
-class EntityAccessor {
+  class EntityAccessor {
     
     constructor() {
     }
@@ -68,13 +68,13 @@ class EntityAccessor {
      * expect(EntityAccessor.getAttributeAsString(entity, "hello")).toBe("world");
      */
     static getAttributeAsString(entity, name) {
-        if (entity.documentElement) entity = entity.documentElement;
-        if (entity.nodeType && entity.tagName)
-            return DomUtil.getAttributeAsString(entity, name);
-        else if (entity instanceof BadgerFishObject)
-            return XtkCaster.asString(entity[`@${name}`]);
-        else 
-            return XtkCaster.asString(entity[name]);
+      if (entity.documentElement) entity = entity.documentElement;
+      if (entity.nodeType && entity.tagName)
+        return DomUtil.getAttributeAsString(entity, name);
+      else if (entity instanceof BadgerFishObject)
+        return XtkCaster.asString(entity[`@${name}`]);
+      else 
+        return XtkCaster.asString(entity[name]);
     }
 
     /**
@@ -94,13 +94,13 @@ class EntityAccessor {
      * expect(EntityAccessor.getAttributeAsLong(entity, "hello")).toBe(42);
      */
     static getAttributeAsLong(entity, name) {
-        if (entity.documentElement) entity = entity.documentElement;
-        if (entity.nodeType && entity.tagName)
-            return DomUtil.getAttributeAsLong(entity, name);
-        else if (entity instanceof BadgerFishObject)
-            return XtkCaster.asLong(entity[`@${name}`]);
-        else 
-            return XtkCaster.asLong(entity[name]);
+      if (entity.documentElement) entity = entity.documentElement;
+      if (entity.nodeType && entity.tagName)
+        return DomUtil.getAttributeAsLong(entity, name);
+      else if (entity instanceof BadgerFishObject)
+        return XtkCaster.asLong(entity[`@${name}`]);
+      else 
+        return XtkCaster.asLong(entity[name]);
     }
 
     /**
@@ -120,13 +120,13 @@ class EntityAccessor {
      * expect(EntityAccessor.getAttributeAsBoolean(entity, "hello")).toBe(true);
      */
     static getAttributeAsBoolean(entity, name) {
-        if (entity.documentElement) entity = entity.documentElement;
-        if (entity.nodeType && entity.tagName)
-            return DomUtil.getAttributeAsBoolean(entity, name);
-        else if (entity instanceof BadgerFishObject)
-            return XtkCaster.asBoolean(entity[`@${name}`]);
-        else 
-            return XtkCaster.asBoolean(entity[name]);
+      if (entity.documentElement) entity = entity.documentElement;
+      if (entity.nodeType && entity.tagName)
+        return DomUtil.getAttributeAsBoolean(entity, name);
+      else if (entity instanceof BadgerFishObject)
+        return XtkCaster.asBoolean(entity[`@${name}`]);
+      else 
+        return XtkCaster.asBoolean(entity[name]);
     }
 
     /**
@@ -147,22 +147,22 @@ class EntityAccessor {
      * EntityAccessor.getChildElements(entity, "chapter");
      */
     static getChildElements(entity, tagName) {
-        if (entity.documentElement) entity = entity.documentElement;
-        if (entity.nodeType && entity.tagName) {
-            const elements = [];
-            var child = DomUtil.getFirstChildElement(entity);
-            while (child) {
-                if (!tagName || tagName == child.tagName)
-                    elements.push(child);
-                child = DomUtil.getNextSiblingElement(child);
-            }
-            return elements;
-        }
-        else {
-            var elements = entity[tagName] || [];
-            if (!Util.isArray(elements)) elements = [ elements ];
-            return elements;
+      if (entity.documentElement) entity = entity.documentElement;
+      if (entity.nodeType && entity.tagName) {
+        const elements = [];
+        var child = DomUtil.getFirstChildElement(entity);
+        while (child) {
+          if (!tagName || tagName == child.tagName)
+            elements.push(child);
+          child = DomUtil.getNextSiblingElement(child);
         }
+        return elements;
+      }
+      else {
+        var elements = entity[tagName] || [];
+        if (!Util.isArray(elements)) elements = [ elements ];
+        return elements;
+      }
     }
 
     /**
@@ -183,26 +183,26 @@ class EntityAccessor {
      * EntityAccessor.getElement(entity, "body");
      */
     static getElement(entity, tagName) {
-        if (entity.documentElement) entity = entity.documentElement;
-        if (entity.nodeType && entity.tagName) {
-            var child = DomUtil.getFirstChildElement(entity);
-            while (child) {
-                if (tagName == child.tagName)
-                    return child;
-                child = DomUtil.getNextSiblingElement(child);
-            }
-            return null;
-        }
-        else {
-            const child = entity[tagName];
-            return child ? child : null;
+      if (entity.documentElement) entity = entity.documentElement;
+      if (entity.nodeType && entity.tagName) {
+        var child = DomUtil.getFirstChildElement(entity);
+        while (child) {
+          if (tagName == child.tagName)
+            return child;
+          child = DomUtil.getNextSiblingElement(child);
         }
+        return null;
+      }
+      else {
+        const child = entity[tagName];
+        return child ? child : null;
+      }
     }
 
-}
+  }
 
 
-// Public exports
-exports.EntityAccessor = EntityAccessor;
+  // Public exports
+  exports.EntityAccessor = EntityAccessor;
 
 })();

package/src/index.js

@@ -10,23 +10,23 @@ 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";    
     
-/**********************************************************************************
+  /**********************************************************************************
  * 
  * Adobe Campaign Classic Core SDK
  * 
  *********************************************************************************/
 
-const pjson = require('../package.json');
-const DomUtil = require('./domUtil.js').DomUtil;
-const XtkCaster = require('./xtkCaster.js').XtkCaster;
-const { Client, Credentials, ConnectionParameters } = require('./client.js');
-const request = require('./transport.js').request;
-const { TestUtil } = require('./testUtil.js');
-const { HttpError } = require('./transport.js');
+  const pjson = require('../package.json');
+  const DomUtil = require('./domUtil.js').DomUtil;
+  const XtkCaster = require('./xtkCaster.js').XtkCaster;
+  const { Client, Credentials, ConnectionParameters } = require('./client.js');
+  const request = require('./transport.js').request;
+  const { TestUtil } = require('./testUtil.js');
+  const { HttpError } = require('./transport.js');
 
-/**
+  /**
  * Get/Set the transport function (defaults to Axios). This function is used for testing / mocking the transport layer.
  * Called without arguments, it returns the current transport function
  * Called with an argument, it sets the current transport function and returns the previous one
@@ -41,23 +41,23 @@ const { HttpError } = require('./transport.js');
  * }
  */
 
-var transport = request;
+  var transport = request;
 
-/**
+  /**
  * @namespace Campaign
  */
-class SDK {
+  class SDK {
 
     constructor() {
     }
 
     _transport(t) {
-        if (t) {
-            const old = transport;
-            transport = t;
-            return old;
-        }
-        return transport;
+      if (t) {
+        const old = transport;
+        transport = t;
+        return old;
+      }
+      return transport;
     }
     
     /**
@@ -68,8 +68,8 @@ class SDK {
      * @return {Promise<Client>} an ACC client object
      */
     async init (connectionParameters) {
-        const client = new Client(this, connectionParameters);
-        return client;
+      const client = new Client(this, connectionParameters);
+      return client;
     }
 
     /**
@@ -86,11 +86,11 @@ class SDK {
      * @returns {Campaign.SDKVersion} an object containing information about the SDK, such as it's name, version, etc.
      */
     getSDKVersion() {
-        return {
-            version: pjson.version,
-            name: pjson.name,
-            description: pjson.description
-        };
+      return {
+        version: pjson.version,
+        name: pjson.name,
+        description: pjson.description
+      };
     }
 
     /**
@@ -98,9 +98,9 @@ class SDK {
      * Can be useful to troubleshoot IP whitelisting issues
      */
     async ip() {
-        const transport = this._transport();
-        const ip = await transport({ url: "https://api.db-ip.com/v2/free/self" });
-        return ip;
+      const transport = this._transport();
+      const ip = await transport({ url: "https://api.db-ip.com/v2/free/self" });
+      return ip;
     }
 
     /** 
@@ -130,23 +130,23 @@ class SDK {
      * expect(sdk.escapeXtk`@name=${"Rock 'n' Roll"}`).toBe("@name='Rock \\'n\\' Roll'");
      */
     escapeXtk(p1, ...p2) {
-        // first syntax: only one parameter which is a string => returns the escaped string.
-        // that's how the Campaign function in common.js behaves
-        if (p1 === undefined || p1 === null)
-            return "''";
-        if (typeof p1 === 'string') {
-            return "'" + String(p1).replace(/\\/g, "\\\\").replace(/'/g,  "\\'") + "'";
-        }
-
-        // Second syntax: for use in tagged template literals
-        // instead of writing:  { expr: "@name = " + escapeXtk(userName) }
-        // you write { expr: escapeXtk`@name = {userName}` }
-        if (p1.length == 0) return "''";
-        var str = p1[0];
-        for (var i=1; i<p1.length; i++) {
-            str = str + this.escapeXtk(p2[i-1]) + p1[i];
-        }
-        return str;
+      // first syntax: only one parameter which is a string => returns the escaped string.
+      // that's how the Campaign function in common.js behaves
+      if (p1 === undefined || p1 === null)
+        return "''";
+      if (typeof p1 === 'string') {
+        return "'" + String(p1).replace(/\\/g, "\\\\").replace(/'/g,  "\\'") + "'";
+      }
+
+      // Second syntax: for use in tagged template literals
+      // instead of writing:  { expr: "@name = " + escapeXtk(userName) }
+      // you write { expr: escapeXtk`@name = {userName}` }
+      if (p1.length == 0) return "''";
+      var str = p1[0];
+      for (var i=1; i<p1.length; i++) {
+        str = str + this.escapeXtk(p2[i-1]) + p1[i];
+      }
+      return str;
     }
 
     /**
@@ -156,14 +156,14 @@ class SDK {
      * @returns the escaped string
      */
     escapeForLike(text, escapeXtkParams) {
-        text = XtkCaster.asString(text);
-        if (!text) return "";    
-        text = text.replace(/\\/g, "\\\\")
-                    .replace(/'/g,  "\\'")
-                    .replace(/%/g,  "\\%")
-                    .replace(/_/g,  "\\_");
-        if (escapeXtkParams)
-            text = text.replace(/\$/g, "' + Char('36') + '");
+      text = XtkCaster.asString(text);
+      if (!text) return "";    
+      text = text.replace(/\\/g, "\\\\")
+        .replace(/'/g,  "\\'")
+        .replace(/%/g,  "\\%")
+        .replace(/_/g,  "\\_");
+      if (escapeXtkParams)
+        text = text.replace(/\$/g, "' + Char('36') + '");
       return text;
     }
 
@@ -173,19 +173,19 @@ class SDK {
      * @returns {string} the expanded xpath
      */
     expandXPath(xpath) {
-        if (!xpath) return xpath;
-        if (xpath.startsWith("[") && xpath.endsWith("]"))
-            return xpath;
-        if (xpath.indexOf('/') === -1 && xpath.indexOf('-') === -1 && xpath.indexOf(':') === -1)
-            return xpath;
-        return `[${xpath}]`;
+      if (!xpath) return xpath;
+      if (xpath.startsWith("[") && xpath.endsWith("]"))
+        return xpath;
+      if (xpath.indexOf('/') === -1 && xpath.indexOf('-') === -1 && xpath.indexOf(':') === -1)
+        return xpath;
+      return `[${xpath}]`;
     }
 
     unexpandXPath(xpath) {
-        if (!xpath) return xpath;
-        if (xpath.startsWith("[") && xpath.endsWith("]"))
-            return xpath.substring(1, xpath.length - 1);
-        return xpath;
+      if (!xpath) return xpath;
+      if (xpath.startsWith("[") && xpath.endsWith("]"))
+        return xpath.substring(1, xpath.length - 1);
+      return xpath;
     }
 
     /**
@@ -195,26 +195,26 @@ class SDK {
      * @returns {string} the text literal which can be used in a Xtk expression or condition
      */
     xtkConstText(value, type) {
-        if (!type || type === 'string' || type === 'memo') {
-            return sdk.escapeXtk(XtkCaster.asString(value));
-        }
-        const constText = XtkCaster.asString(XtkCaster.as(value, type));
-        if (XtkCaster.isTimeType(type))
-            return `#${constText}#`;
-        return constText;
+      if (!type || type === 'string' || type === 'memo') {
+        return sdk.escapeXtk(XtkCaster.asString(value));
+      }
+      const constText = XtkCaster.asString(XtkCaster.as(value, type));
+      if (XtkCaster.isTimeType(type))
+        return `#${constText}#`;
+      return constText;
     }
-}
-
-const sdk = new SDK();
-sdk.TestUtil = TestUtil;
-sdk.XtkCaster = XtkCaster;
-sdk.Credentials = Credentials;
-sdk.DomUtil = DomUtil;
-sdk.ConnectionParameters = ConnectionParameters;
-sdk.HttpError = HttpError;
-
-// Public exports
-module.exports = sdk;
+  }
+
+  const sdk = new SDK();
+  sdk.TestUtil = TestUtil;
+  sdk.XtkCaster = XtkCaster;
+  sdk.Credentials = Credentials;
+  sdk.DomUtil = DomUtil;
+  sdk.ConnectionParameters = ConnectionParameters;
+  sdk.HttpError = HttpError;
+
+  // Public exports
+  module.exports = sdk;
 
 
 })();

package/src/methodCache.js

@@ -10,32 +10,32 @@ 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";    
     
 
-/**********************************************************************************
+  /**********************************************************************************
  * 
  * A cache for Campaign SOAP methods definition
  * 
  *********************************************************************************/
 
-const DomUtil = require('./domUtil.js').DomUtil;
-const { Cache } = require('./cache.js');
+  const DomUtil = require('./domUtil.js').DomUtil;
+  const { Cache } = require('./cache.js');
 
-/**
+  /**
  * @namespace Campaign
  * 
  * @typedef {DOMElement} SoapMethodDefinition
  * @memberof Campaign
  */
 
-/**
+  /**
  * @private
  * @class
  * @constructor
  * @memberof Campaign
  */
-class MethodCache extends Cache {
+  class MethodCache extends Cache {
 
     /**
      * A in-memory cache for SOAP call method definitions. Not intended to be used directly,
@@ -52,20 +52,20 @@ class MethodCache extends Cache {
      * @param {number} ttl is the TTL for objects in ms. Defaults to 5 mins
      */
     constructor(storage, rootKey, ttl) {
-        super(storage, rootKey, ttl, ((schemaId, methodName) => schemaId + "#" + methodName ), (item, serDeser) => {
-            if (serDeser) {
-                if (!item || !item.value || !item.value.method) throw Error(`Cannot serialize falsy cached item`);
-                const value = Object.assign({}, item);          // shallow copy
-                value.value = Object.assign({}, value.value);   // dummy deep copy
-                value.value.method = DomUtil.toXMLString(item.value.method);
-                return JSON.stringify(value);
-            }
-            else {
-                const json = JSON.parse(item);
-                json.value.method = DomUtil.parse(json.value.method).documentElement;
-                return json;
-            }
-        });
+      super(storage, rootKey, ttl, ((schemaId, methodName) => schemaId + "#" + methodName ), (item, serDeser) => {
+        if (serDeser) {
+          if (!item || !item.value || !item.value.method) throw Error(`Cannot serialize falsy cached item`);
+          const value = Object.assign({}, item);          // shallow copy
+          value.value = Object.assign({}, value.value);   // dummy deep copy
+          value.value.method = DomUtil.toXMLString(item.value.method);
+          return JSON.stringify(value);
+        }
+        else {
+          const json = JSON.parse(item);
+          json.value.method = DomUtil.parse(json.value.method).documentElement;
+          return json;
+        }
+      });
     }
 
     /**
@@ -76,7 +76,7 @@ class MethodCache extends Cache {
      * @param {Element} schema DOM document node represening the schema 
      */
     async cache(schema) {
-        return await this.put(schema);
+      return await this.put(schema);
     }
     
     /**
@@ -85,49 +85,49 @@ class MethodCache extends Cache {
      * @param {Element} schema DOM document node represening the schema 
      */
     async put(schema) {
-        var namespace = DomUtil.getAttributeAsString(schema, "namespace");
-        var name = DomUtil.getAttributeAsString(schema, "name");
-        var impls = DomUtil.getAttributeAsString(schema, "implements");
-        var root = DomUtil.getFirstChildElement(schema);
-        while (root) {
-            let schemaId;
-            if (root.nodeName == "interface") {
-                const nodeName = DomUtil.getAttributeAsString(root, "name");
-                schemaId = `${namespace}:${nodeName}`;
-            }
-            else if (root.nodeName == "methods") {
-                schemaId = `${namespace}:${name}`;
-            }
-            if (schemaId) {
-                var child = DomUtil.getFirstChildElement(root, "method");
-                while (child) {
-                    const methodName = DomUtil.getAttributeAsString(child, "name");
-                    const cached = { method: child, urn: schemaId };
-                    await super.put(schemaId, methodName, cached);
-                    child = DomUtil.getNextSiblingElement(child, "method");
-                }
-            }
-            root = DomUtil.getNextSiblingElement(root);
+      var namespace = DomUtil.getAttributeAsString(schema, "namespace");
+      var name = DomUtil.getAttributeAsString(schema, "name");
+      var impls = DomUtil.getAttributeAsString(schema, "implements");
+      var root = DomUtil.getFirstChildElement(schema);
+      while (root) {
+        let schemaId;
+        if (root.nodeName == "interface") {
+          const nodeName = DomUtil.getAttributeAsString(root, "name");
+          schemaId = `${namespace}:${nodeName}`;
+        }
+        else if (root.nodeName == "methods") {
+          schemaId = `${namespace}:${name}`;
+        }
+        if (schemaId) {
+          var child = DomUtil.getFirstChildElement(root, "method");
+          while (child) {
+            const methodName = DomUtil.getAttributeAsString(child, "name");
+            const cached = { method: child, urn: schemaId };
+            await super.put(schemaId, methodName, cached);
+            child = DomUtil.getNextSiblingElement(child, "method");
+          }
         }
+        root = DomUtil.getNextSiblingElement(root);
+      }
 
-        // If the schema implements an interface, then add the interface methods to the schema
-        // methods in the cache, using the "<interface>|<schemaId>" urn
-        // example: xtk:session implements xtk:persist, and therefore will have xtk:persist methods
-        // under the urn "xtk:persist|xtk:session"
-        if (impls) {
-            const schemaId = `${namespace}:${name}`;
-            const prefix = `${impls}#`;
-            const urn = `${impls}|${schemaId}`;
-            const keys = Object.keys(this._cache);
-            for (const key of keys) {
-                if (key.startsWith(prefix)) {
-                    let cached = this._cache[key].value;
-                    cached = { method: cached.method, urn: urn };
-                    const methodName = DomUtil.getAttributeAsString(cached.method, "name");
-                    await super.put(schemaId, methodName, cached);
-                }
-            }
+      // If the schema implements an interface, then add the interface methods to the schema
+      // methods in the cache, using the "<interface>|<schemaId>" urn
+      // example: xtk:session implements xtk:persist, and therefore will have xtk:persist methods
+      // under the urn "xtk:persist|xtk:session"
+      if (impls) {
+        const schemaId = `${namespace}:${name}`;
+        const prefix = `${impls}#`;
+        const urn = `${impls}|${schemaId}`;
+        const keys = Object.keys(this._cache);
+        for (const key of keys) {
+          if (key.startsWith(prefix)) {
+            let cached = this._cache[key].value;
+            cached = { method: cached.method, urn: urn };
+            const methodName = DomUtil.getAttributeAsString(cached.method, "name");
+            await super.put(schemaId, methodName, cached);
+          }
         }
+      }
     }
 
     /**
@@ -138,8 +138,8 @@ class MethodCache extends Cache {
      * @returns {Campaign.SoapMethodDefinition} the method definition, or undefined if the schema or the method is not found
      */
     async get(schemaId, methodName) {
-        const cached = await super.get(schemaId, methodName);
-        return cached ? cached.method : undefined;
+      const cached = await super.get(schemaId, methodName);
+      return cached ? cached.method : undefined;
     }
 
     /**
@@ -150,13 +150,13 @@ class MethodCache extends Cache {
      * @returns {string} the URN (or Soap action header), or undefined if the schema or the method is not found
      */
     async getSoapUrn(schemaId, methodName) {
-        const cached = await super.get(schemaId, methodName);
-        return cached ? cached.urn : undefined;
+      const cached = await super.get(schemaId, methodName);
+      return cached ? cached.urn : undefined;
     }
-}
+  }
 
 
-// Public exports
-exports.MethodCache = MethodCache;
+  // Public exports
+  exports.MethodCache = MethodCache;
 
 })();