@adobe/acc-js-sdk 1.0.2 → 1.0.6

package/src/crypto.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";    
+    
 const { Util } = require('./util.js');
 
 
@@ -128,3 +129,5 @@ if (!Util.isBrowser()) {
   exports.Cipher = Cipher;
 }
 
+
+})();

package/src/domUtil.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,11 +9,13 @@ 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 XtkCaster = require('./xtkCaster.js').XtkCaster;
 const { Util } = require("./util.js");
 
-var JSDOM = undefined;
+var JSDOM;
 
 /* istanbul ignore else */
 if (!Util.isBrowser()) {
@@ -34,11 +35,11 @@ else {
     var dom = parser.parseFromString(text, "application/xml");
     this.window = {
         document: dom
-    }
+    };
     this.serialize = function() {
         return new XMLSerializer().serializeToString(dom);
-    }
-  }
+    };
+  };
 
   JSDOM = jsdom;
 }
@@ -90,12 +91,17 @@ class DomException {
 
 
 /**
- * Helpers for common manipulation of DOM documents
  * @memberof XML
  * @class
  * @constructor
  */
 class DomUtil {
+
+    /**
+     * Helpers for common manipulation of DOM documents. Al functions are static, it is not necessary to create new instances of this object
+     */
+    constructor() {
+    }
     
     /**
      * Parse an XML string as a DOM Document
@@ -377,6 +383,15 @@ class DomUtil {
         return doc;
     }
 
+    static _getTextIfTextNode(xml) {
+        const child = xml.firstChild;
+        if (!child) return null;                   // no children
+        if (child.nextSibling) return null;        // more than 1 child
+        if (child.nodeType !== 3 && child.nodeType !== 4) return null;
+        const text = child.nodeValue;
+        return text;
+    }
+
     /**
      * Internal recursive method to convert an XML element to a object literal (JSON)
      * This function does not return anything. Instead it creates children elements in the passed 'json' object
@@ -408,20 +423,36 @@ class DomUtil {
             if (isArray && !Util.isArray(json[childName]))
                 json[childName] = [ json[childName] ];
             if (child.nodeType == 1) {  // element
-                const jsonChild = flavor == "BadgerFish" ? new BadgerFishObject() : {};
-                this._toJSON(child, jsonChild, flavor);
-                if (isArray) 
-                    json[childName].push(jsonChild);
-                else
-                    json[childName] = jsonChild;
+                // In SimpleJson representation, ensure we have proper transformation
+                // of text and CDATA nodes. For instance, the following
+                //  <workflow><desc>Hello</desc></workflow>
+                // should be transformed into { "$desc": "Hello" }
+                // Note that an empty element such as
+                //  <workflow><desc></desc></workflow>
+                // will be transformed into { "desc": {} }
+                // because there is an ambiguity and, unless we have information
+                // from the schema, we cannot know if <desc></desc> should be
+                // transformed into "$desc": "" or into "desc": {}
+                const text = this._getTextIfTextNode(child);
+                if (text !== null && flavor == "SimpleJson") {
+                    json[`$${childName}`] = text;
+                }
+                else {
+                    const jsonChild = flavor == "BadgerFish" ? new BadgerFishObject() : {};
+                    this._toJSON(child, jsonChild, flavor);
+                    if (isArray) 
+                        json[childName].push(jsonChild);
+                    else
+                        json[childName] = jsonChild;
+                }
             }
             else if (child.nodeType === 3 || child.nodeType === 4) { // text and CDATA
                 if (flavor == "BadgerFish") {
-                    var text = child.nodeValue;
-                    if (json["$"] === undefined)
-                        json["$"] = text;
+                    const text = child.nodeValue;
+                    if (json.$ === undefined)
+                        json.$ = text;
                     else 
-                        json["$"] = json["$"] + text;
+                        json.$ = json.$ + text;
                 }
             }
             child = child.nextSibling;
@@ -442,9 +473,9 @@ class DomUtil {
             throw new DomException(`Invalid JSON flavor '${flavor}'. Should be 'SimpleJson' or 'BadgerFish'`);
         if (xml.nodeType == 9)
             xml = xml.documentElement;
-        var json = flavor == "BadgerFish" ? new BadgerFishObject() : {};
-        this._toJSON(xml, json, flavor);
-        return json;
+            var json = flavor == "BadgerFish" ? new BadgerFishObject() : {};
+            this._toJSON(xml, json, flavor);
+            return json;
     }
 
 }
@@ -613,3 +644,5 @@ exports.DomException = DomException;
 exports.BadgerFishObject = BadgerFishObject;
 exports.XPath = XPath;
 exports.XPathElement = XPathElement;
+
+})();

package/src/entityAccessor.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";
 
 /**********************************************************************************
  * 
@@ -204,3 +204,5 @@ class EntityAccessor {
 
 // Public exports
 exports.EntityAccessor = EntityAccessor;
+
+})();

package/src/index.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,113 +9,154 @@ 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";    
+    
 /**********************************************************************************
  * 
  * Adobe Campaign Classic Core SDK
  * 
  *********************************************************************************/
 
-'use strict'
-
 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;
 
 /**
- * @namespace Campaign
+ * 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
+ * 
+ * const t = jest.fn();
+ * const old = sdk._transport(t);
+ * try {
+ *   t.mockReturnValueOnce(Promise.resolve(...);
+ *   ... call sdk function which uses the transport layer, for instance ip()
+ * } finally {
+ *   sdk._transport(old);
+ * }
  */
 
-/**
- * Returns a Client interface which allows you to logon on to an ACC instance and call SOAP methods
- *
- * @memberof Campaign
- * @param {ConnectionParameters} connectionParameters. Use ConnectionParameters.ofUserAndPassword for example
- * @return {Promise<Client>} an ACC client object
- */
-async function init (connectionParameters) {
-    const client = new Client(this, connectionParameters);
-    return client;
-}
+var transport = request;
 
 /**
- * @typedef {Object} SDKVersion
- * @property {string} version - the version of the SDK (example: "1.0.0")
- * @property {string} name - the name of the npm package ("@adobe/acc-js-sdk")
- * @property {string} description - the version of the SDK (example: "ACC JavaScript SDK")
- * @memberOf Campaign
+ * @namespace Campaign
  */
+class SDK {
 
-/**
- * Get client SDK version
- * @memberof Campaign
- * @returns {Campaign.SDKVersion} an object containing information about the SDK, such as it's name, version, etc.
- */
-function getSDKVersion() {
-    return {
-        version: pjson.version,
-        name: pjson.name,
-        description: pjson.description
+    constructor() {
     }
-}
 
-/** 
- * Escapes and quotes string contained in Xtk expressions. It's common to build xtk expressions such as "@name='Hello'". If 'Hello' is a variable, it's
- * tempting to write "@name='" + hello + "'", or `@name='${hello}'`. The issue is that if the hello variable contains characters such as a
- * simple quote, there can be security concerns (xtk injections). The escapeXtk function ensure proper escaping in this case. In addition, it will also
- * surround the string with quotes, so you can write `@name=${escapeXtk(hello)}`.
- * <p>
- * There are 2 alternate signatures for this function
- * <ul>
- * <li> the first one takes one single parameter which is a string and returns the escaped, quoted string
- * <li> the second one takes 2 array of strings and is called when using the function in tagged string litterals. The first array is the constant parts
- *   of the string litteral, and the second array contains the variable parts. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals
- * </ul>
- * <p>
- * The function can be used in a tagged string litterals like this: "var expr = escapeXtk`@name=${hello}`"
- * <p>
- * @memberof Campaign
- * @param {string|string[]} p1 is the text to escape. If the text is null or undefined, it will be handled as an empty string. when using the escapeXtk for a tagged string litteral, this parameter is the array of constant values in the template.
- * @param {undefined|string[]} p2 when using the escapeXtk for a tagged string litteral, this parameter is the array of expression values in the template.
- * @returns {string} the escaped and quoted (simple quotes) text.
- * 
- * @example
- * expect(sdk.escapeXtk("Rock 'n' Roll")).toBe("'Rock \\'n\\' Roll'");
- * 
- * @example
- * expect(sdk.escapeXtk`@name=${"Rock 'n' Roll"}`).toBe("@name='Rock \\'n\\' Roll'");
- */
-function 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,  "\\'") + "'";
+    _transport(t) {
+        if (t) {
+            const old = transport;
+            transport = t;
+            return old;
+        }
+        return transport;
+    }
+    
+    /**
+     * Returns a Client interface which allows you to logon on to an ACC instance and call SOAP methods
+     *
+     * @memberof Campaign
+     * @param {ConnectionParameters} connectionParameters. Use ConnectionParameters.ofUserAndPassword for example
+     * @return {Promise<Client>} an ACC client object
+     */
+    async init (connectionParameters) {
+        const client = new Client(this, connectionParameters);
+        return client;
+    }
+
+    /**
+     * @typedef {Object} SDKVersion
+     * @property {string} version - the version of the SDK (example: "1.0.0")
+     * @property {string} name - the name of the npm package ("@adobe/acc-js-sdk")
+     * @property {string} description - the version of the SDK (example: "ACC JavaScript SDK")
+     * @memberOf Campaign
+     */
+
+    /**
+     * Get client SDK version
+     * @memberof Campaign
+     * @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
+        };
+    }
+
+    /**
+     * Get the outbound IP address (https://api.db-ip.com/v2/free/self)
+     * 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;
     }
 
-    // Second syntax: for use in tagged template litterals
-    // 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 + escapeXtk(p2[i-1]) + p1[i];
+    /** 
+     * Escapes and quotes string contained in Xtk expressions. It's common to build xtk expressions such as "@name='Hello'". If 'Hello' is a variable, it's
+     * tempting to write "@name='" + hello + "'", or `@name='${hello}'`. The issue is that if the hello variable contains characters such as a
+     * simple quote, there can be security concerns (xtk injections). The escapeXtk function ensure proper escaping in this case. In addition, it will also
+     * surround the string with quotes, so you can write `@name=${escapeXtk(hello)}`.
+     * <p>
+     * There are 2 alternate signatures for this function
+     * <ul>
+     * <li> the first one takes one single parameter which is a string and returns the escaped, quoted string
+     * <li> the second one takes 2 array of strings and is called when using the function in tagged string litterals. The first array is the constant parts
+     *   of the string litteral, and the second array contains the variable parts. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals
+     * </ul>
+     * <p>
+     * The function can be used in a tagged string litterals like this: "var expr = escapeXtk`@name=${hello}`"
+     * <p>
+     * @memberof Campaign
+     * @param {string|string[]} p1 is the text to escape. If the text is null or undefined, it will be handled as an empty string. when using the escapeXtk for a tagged string litteral, this parameter is the array of constant values in the template.
+     * @param {undefined|string[]} p2 when using the escapeXtk for a tagged string litteral, this parameter is the array of expression values in the template.
+     * @returns {string} the escaped and quoted (simple quotes) text.
+     * 
+     * @example
+     * expect(sdk.escapeXtk("Rock 'n' Roll")).toBe("'Rock \\'n\\' Roll'");
+     * 
+     * @example
+     * 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 litterals
+        // 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;
     }
-    return str;
 }
 
+const sdk = new SDK();
+sdk.XtkCaster = XtkCaster;
+sdk.Credentials = Credentials;
+sdk.DomUtil = DomUtil;
+sdk.ConnectionParameters = ConnectionParameters;
+
 // Public exports
-module.exports = {
-    init: init,
-    getSDKVersion: getSDKVersion,
-    escapeXtk: escapeXtk,
-    XtkCaster: XtkCaster,
-    DomUtil: DomUtil,
-    Credentials: Credentials,
-    ConnectionParameters: ConnectionParameters
-};
+module.exports = sdk;
+
 
+})();

package/src/methodCache.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";    
+    
 
 /**********************************************************************************
  * 
@@ -19,6 +20,7 @@ governing permissions and limitations under the License.
  *********************************************************************************/
 
 const DomUtil = require('./domUtil.js').DomUtil;
+const { Cache } = require('./cache.js');
 
 /**
  * @namespace Campaign
@@ -28,39 +30,61 @@ const DomUtil = require('./domUtil.js').DomUtil;
  */
 
 /**
- * A in-memory cache for SOAP call method definitions. Not intended to be used directly,
- * but an internal cache for the Campaign.Client object
- * 
  * @private
  * @class
  * @constructor
  * @memberof Campaign
  */
-class MethodCache {
-    
-    constructor() {
-        /**
-         * Method definitions, keyed but schema id. Value is a map whose key is a method name. Value is the DOM element
-         * corresponding to a method
-         * @type {Object<string, Object<string, Campaign.SoapMethodDefinition>>}
-         */
-        this.methodsBySchema = {};
+class MethodCache extends Cache {
 
-        /** 
-         * Soap action headers for each method. Key is schema id, value is a map whose key is a method name. Value is the SOAP action
-         * for the method. For interface method (ex: xtk:session#Write, the SOAP action is actually
-         * xtk:persist#Write, using the interface id, not the session id)
-         * @type {Object<string, Object<string, string>>}
-         */
-        this.soapUrns = {};
+    /**
+     * A in-memory cache for SOAP call method definitions. Not intended to be used directly,
+     * but an internal cache for the Campaign.Client object
+     * 
+     * Cached object are made of
+     * - the key is a string in the form <schemaId>#<methodName>, such as "xtk:session#GetServerTime"
+     * - the value is a JSON object made of two attributes:
+     *          - the "urn" attribute, such as "xtk:persist", which is the URN to use to make the SOAP call
+     *          - the "method" attribute, a DOM element corresponding to the method XML element
+     * 
+     * @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, ((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;
+            }
+        });
     }
 
     /**
      * Caches all methods of a schema
+     * For backward compatibility purpose. Use "put" instead
      * 
+     * @deprecated
      * @param {Element} schema DOM document node represening the schema 
      */
     cache(schema) {
+        return this.put(schema);
+    }
+    
+    /**
+     * Caches all methods of a schema
+     * 
+     * @param {Element} schema DOM document node represening the schema 
+     */
+    put(schema) {
         var namespace = DomUtil.getAttributeAsString(schema, "namespace");
         var name = DomUtil.getAttributeAsString(schema, "name");
         var impls = DomUtil.getAttributeAsString(schema, "implements");
@@ -82,17 +106,12 @@ class MethodCache {
             }
 
             if (schemaId) {
-                this.methodsBySchema[schemaId] = this.methodsBySchema[schemaId] || {};
-                this.methodsBySchema[soapUrn] = this.methodsBySchema[soapUrn] || {};
-                this.soapUrns[schemaId] = this.soapUrns[schemaId] || {};
-                this.soapUrns[soapUrn] = this.soapUrns[soapUrn] || {};
                 var child = DomUtil.getFirstChildElement(root, "method");
                 while (child) {
                     const methodName = DomUtil.getAttributeAsString(child, "name");
-                    this.methodsBySchema[schemaId][methodName] = child;
-                    this.methodsBySchema[soapUrn][methodName] = child; /// version 0.1.23: cache the method in both the schema id and interface id form compatibility reasons
-                    this.soapUrns[schemaId][methodName] = soapUrn;
-                    this.soapUrns[soapUrn][methodName] = soapUrn;
+                    const cached = { method: child, urn: soapUrn };
+                    super.put(schemaId, methodName, cached);
+                    super.put(soapUrn, methodName, cached); /// version 0.1.23: cache the method in both the schema id and interface id form compatibility reasons
                     child = DomUtil.getNextSiblingElement(child, "method");
                 }
             }
@@ -108,10 +127,8 @@ class MethodCache {
      * @returns {Campaign.SoapMethodDefinition} the method definition, or undefined if the schema or the method is not found
      */
     get(schemaId, methodName) {
-        var dict = this.methodsBySchema[schemaId];
-        if (dict) 
-            dict = dict[methodName];
-        return dict;
+        const cached = super.get(schemaId, methodName);
+        return cached ? cached.method : undefined;
     }
 
     /**
@@ -122,21 +139,13 @@ class MethodCache {
      * @returns {string} the URN (or Soap action header), or undefined if the schema or the method is not found
      */
     getSoapUrn(schemaId, methodName) {
-        var soapUrn = this.soapUrns[schemaId];
-        if (soapUrn) 
-            soapUrn = soapUrn[methodName];
-        return soapUrn;
+        const cached = super.get(schemaId, methodName);
+        return cached ? cached.urn : undefined;
     }
-
-    /**
-     * Clears the cache
-     */
-    clear() {
-        this.methodsBySchema = {};
-    }
-
 }
 
 
 // Public exports
-exports.MethodCache = MethodCache;
+exports.MethodCache = MethodCache;
+
+})();