@adobe/acc-js-sdk 1.0.7 → 1.1.0

package/src/client.js

@@ -225,16 +225,16 @@ class Credentials {
 
 /**
  * @typedef {Object} ConnectionOptions
- * @property {string} representation - the representation to use, i.e. "SimpleJson" (the default), "BadgerFish", or "xml"
- * @property {boolean} rememberMe - The Campaign `rememberMe` attribute which can be used to extend the lifetime of session tokens
- * @property {number} entityCacheTTL - The TTL (in milliseconds) after which cached XTK entities expire. Defaults to 5 minutes
- * @property {number} methodCacheTTL - The TTL (in milliseconds) after which cached XTK methods expire. Defaults to 5 minutes
- * @property {number} optionCacheTTL - The TTL (in milliseconds) after which cached XTK options expire. Defaults to 5 minutes
- * @property {boolean} traceAPICalls - Activates the tracing of all API calls
- * @property {Utils.Transport} transport - Overrides the transport (i.e. HTTP layer)
- * @property {boolean} noStorage - De-activate using of local storage. By default, and in addition to in-memory cache, entities, methods, and options are also persisted in local storage if there is one.
- * @property {Storage} storage - Overrides the storage interface (i.e. LocalStorage)
- * @memberOf Campaign
+    * @property {string} representation - the representation to use, i.e. "SimpleJson" (the default), "BadgerFish", or "xml"
+    * @property {boolean} rememberMe - The Campaign `rememberMe` attribute which can be used to extend the lifetime of session tokens
+    * @property {number} entityCacheTTL - The TTL (in milliseconds) after which cached XTK entities expire. Defaults to 5 minutes
+    * @property {number} methodCacheTTL - The TTL (in milliseconds) after which cached XTK methods expire. Defaults to 5 minutes
+    * @property {number} optionCacheTTL - The TTL (in milliseconds) after which cached XTK options expire. Defaults to 5 minutes
+    * @property {boolean} traceAPICalls - Activates the tracing of all API calls
+    * @property {Utils.Transport} transport - Overrides the transport (i.e. HTTP layer)
+    * @property {boolean} noStorage - De-activate using of local storage. By default, and in addition to in-memory cache, entities, methods, and options are also persisted in local storage if there is one.
+    * @property {Storage} storage - Overrides the storage interface (i.e. LocalStorage)
+    * @memberOf Campaign
  */
  
 
@@ -1102,6 +1102,14 @@ class Client {
         var urn = that._methodCache.getSoapUrn(schemaId, methodName);
         var soapCall = that._prepareSoapCall(urn, methodName);
 
+        // If method is called with one parameter which is a function, then we assume it's a hook: the function will return
+        // the actual list of parameters
+        let isfunc = parameters && typeof parameters === "function";
+        if (!isfunc && parameters && parameters.length >= 1 && typeof parameters[0] === "function")
+            isfunc = true;
+        if (isfunc)
+            parameters = parameters[0](method, callContext);
+
         const isStatic = DomUtil.getAttributeAsBoolean(method, "static");
         var object = callContext.object;
         if (!isStatic) {

package/src/domUtil.js

@@ -19,7 +19,7 @@ var JSDOM;
 
 /* istanbul ignore else */
 if (!Util.isBrowser()) {
-  JSDOM = require("jsdom").JSDOM;
+    JSDOM = require("jsdom").JSDOM;
 }
 
 /**********************************************************************************
@@ -40,7 +40,7 @@ else {
         return new XMLSerializer().serializeToString(dom);
     };
   };
-
+  
   JSDOM = jsdom;
 }
 
@@ -562,7 +562,10 @@ class XPathElement {
 class XPath {
 
     constructor(path) {
-        this._path = (path || "").trim();
+        path = (path || "").trim();
+        if (path && path.startsWith("[") && path.endsWith("]"))
+            path = path.substring(1, path.length - 1).trim();
+        this._path = path;
     }
 
     /**

package/src/entityAccessor.js

@@ -69,7 +69,7 @@ class EntityAccessor {
      */
     static getAttributeAsString(entity, name) {
         if (entity.documentElement) entity = entity.documentElement;
-        if (entity.insertAdjacentElement)
+        if (entity.nodeType && entity.tagName)
             return DomUtil.getAttributeAsString(entity, name);
         else if (entity instanceof BadgerFishObject)
             return XtkCaster.asString(entity[`@${name}`]);
@@ -95,7 +95,7 @@ class EntityAccessor {
      */
     static getAttributeAsLong(entity, name) {
         if (entity.documentElement) entity = entity.documentElement;
-        if (entity.insertAdjacentElement)
+        if (entity.nodeType && entity.tagName)
             return DomUtil.getAttributeAsLong(entity, name);
         else if (entity instanceof BadgerFishObject)
             return XtkCaster.asLong(entity[`@${name}`]);
@@ -121,7 +121,7 @@ class EntityAccessor {
      */
     static getAttributeAsBoolean(entity, name) {
         if (entity.documentElement) entity = entity.documentElement;
-        if (entity.insertAdjacentElement)
+        if (entity.nodeType && entity.tagName)
             return DomUtil.getAttributeAsBoolean(entity, name);
         else if (entity instanceof BadgerFishObject)
             return XtkCaster.asBoolean(entity[`@${name}`]);
@@ -148,7 +148,7 @@ class EntityAccessor {
      */
     static getChildElements(entity, tagName) {
         if (entity.documentElement) entity = entity.documentElement;
-        if (entity.insertAdjacentElement) {
+        if (entity.nodeType && entity.tagName) {
             const elements = [];
             var child = DomUtil.getFirstChildElement(entity);
             while (child) {
@@ -184,7 +184,7 @@ class EntityAccessor {
      */
     static getElement(entity, tagName) {
         if (entity.documentElement) entity = entity.documentElement;
-        if (entity.insertAdjacentElement) {
+        if (entity.nodeType && entity.tagName) {
             var child = DomUtil.getFirstChildElement(entity);
             while (child) {
                 if (tagName == child.tagName)

package/src/index.js

@@ -23,6 +23,7 @@ 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');
 
 /**
  * Get/Set the transport function (defaults to Axios). This function is used for testing / mocking the transport layer.
@@ -127,8 +128,7 @@ class SDK {
      * @example
      * expect(sdk.escapeXtk`@name=${"Rock 'n' Roll"}`).toBe("@name='Rock \\'n\\' Roll'");
      */
-    escapeXtk(p1, ...p2)
-    {
+    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)
@@ -147,9 +147,65 @@ class SDK {
         }
         return str;
     }
+
+    /**
+     * Escapes a string of characters so that in can be used in a SQL like statement.
+     * @param {string | any} text the text to escape. If not a string, it will be casted to a xtk string first
+     * @param {boolean?} escapeXtkParams indicates that the escape text contains Xtk parameters (using $ character)
+     * @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') + '");
+      return text;
+    }
+
+    /**
+     * Expands an xpath, i.e. enclose it with [..] brackets if necessary
+     * @param {string} xpath the xpath
+     * @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}]`;
+    }
+
+    unexpandXPath(xpath) {
+        if (!xpath) return xpath;
+        if (xpath.startsWith("[") && xpath.endsWith("]"))
+            return xpath.substring(1, xpath.length - 1);
+        return xpath;
+    }
+
+    /**
+     * Convert a javascript value into an xtk constant with proper quoting
+     * @param {any} value the value to convert
+     * @param {string} type the xtk type
+     * @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;
+    }
 }
 
 const sdk = new SDK();
+sdk.TestUtil = TestUtil;
 sdk.XtkCaster = XtkCaster;
 sdk.Credentials = Credentials;
 sdk.DomUtil = DomUtil;

package/src/testUtil.js

@@ -0,0 +1,47 @@
+const { DomUtil } = require("./domUtil");
+
+/*
+Copyright 2022 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+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 { newSchema } = require("./application");
+
+/**********************************************************************************
+ * 
+ * Utilities for testing
+ * 
+ *********************************************************************************/
+
+/**
+ * @namespace Utils
+ */
+
+/**
+ * @memberof Utils
+ * @class
+ * @constructor
+ */
+class TestUtil {
+
+  static newSchema(xml) {
+    if (typeof xml === "string") 
+      xml = DomUtil.parse(xml);
+    return newSchema(xml);
+  }
+}
+
+
+// Public expots
+exports.TestUtil = TestUtil;
+
+})();

package/src/util.js

@@ -135,7 +135,151 @@ class Util {
   }
 }
 
+/**
+ * The ArrayMap object is used to access elements as either an array or a map
+ * 
+ * @class
+ * @constructor
+ * @memberof Utils
+ */
+
+class ArrayMap {
+  constructor() {
+      // List of items, as an ordered array. Use defineProperty to make it non-enumerable
+      // and support for for ... in loop to iterate by item key
+      Object.defineProperty(this, "_items", {
+        value: [],
+        writable: false,
+        enumerable: false,
+      });
+
+      Object.defineProperty(this, "_map", {
+        value: [],
+        writable: false,
+        enumerable: false,
+      });
+      
+      // Number of items. Use defineProperty to make it non-enumerable
+      // and support for for ... in loop to iterate by item key
+      Object.defineProperty(this, "length", {
+        value: 0,
+        writable: true,
+        enumerable: false,
+      });
+  }
+
+  _push(key, value) {
+      let isNumKey = false;
+      if (key) {
+        // reserved keyworkds
+        const isReserved = key === "_items" || key === "length" || key === "_push" || key === "forEach" || key === "map" || key === "_map" || key === "get" || key === "find" || key === "flatMap" || key === "filter";
+
+        // already a child with the name => there's a problem with the schema
+        if (!isReserved && this[key]) throw new Error(`Failed to add element '${key}' to ArrayMap. There's already an item with the same name`);
+
+        // Set key as a enumerable property, so that elements can be accessed by key, 
+        // but also iterated on with a for ... in loop
+        // For compatibility 
+        if (!isReserved) this[key] = value;
+        this._map[key] = value;
+
+        // Special case where keys are numbers or strings convertible with numbers
+        const numKey = +key;
+        if (numKey === numKey) {
+          // keys is a number. If it matches the current index, then we are good,
+          // and we can add the property as an enumerable property
+          isNumKey = true;
+        }
+      }
+
+      if (!isNumKey) {
+        // Set the index property so that items can be accessed by array index.
+        // However, make it non-enumerable to make sure indexes do not show up in a for .. in loop
+        Object.defineProperty(this, this._items.length, {
+          value: value,
+          writable: false,
+          enumerable: false,
+        });
+      }
+      // Add to array and set length
+      this._items.push(value);
+      this.length = this._items.length;
+  }
+
+  /**
+   * Executes a provided function once for each array element.
+   * @param {*} callback Function that is called for every element of the array
+   * @param {*} thisArg Optional value to use as this when executing the callback function.
+   * @returns a new array
+   */
+  forEach(callback, thisArg) {
+      return this._items.forEach(callback, thisArg);
+  }
+
+  /**
+   * Returns the first element that satisfies the provided testing function. If no values satisfy the testing function, undefined is returned.
+   * @param {*} callback Function that is called for every element of the array
+   * @param {*} thisArg Optional value to use as this when executing the callback function.
+   * @returns the first element matching the testing function
+   */
+  find(callback, thisArg) {
+    return this._items.find(callback, thisArg);
+  }
+
+  /**
+   * creates a new array with all elements that pass the test implemented by the provided function.
+   * @param {*} callback Function that is called for every element of the array
+   * @param {*} thisArg Optional value to use as this when executing the callback function.
+   * @returns an array containing elements passing the test function
+   */
+   filter(callback, thisArg) {
+    return this._items.filter(callback, thisArg);
+  }
+
+  /**
+   * Get a element by either name (access as a map) or index (access as an array). Returns undefined if the element does not exist or
+   * if the array index is out of range.
+   * @param {string|number} indexOrKey the name or index of the element
+   * @returns the element matching the name or index
+   */
+  get(indexOrKey) {
+    if (typeof indexOrKey === 'number') return this._items[indexOrKey];
+    return this._map[indexOrKey];
+  }
+
+  /**
+   * Creates a new array populated with the results of calling a provided function on every element in the calling array.
+   * @param {*} callback Function that is called for every element of the array
+   * @param {*} thisArg Optional value to use as this when executing the callback function.
+   * @returns a new array
+   */
+  map(callback, thisArg) {
+    return this._items.map(callback, thisArg);
+  }
+
+  /**
+   * Returns a new array formed by applying a given callback function to each element of the array, and then flattening the result by one level. 
+   * @param {*} callback Function that is called for every element of the array
+   * @param {*} thisArg Optional value to use as this when executing the callback function.
+   * @returns a new array
+   */
+  flatMap(callback, thisArg) {
+    return this._items.flatMap(callback, thisArg);
+  }
+
+  /**
+   * Iterates over all the elements using the for ... of syntax.
+   * @returns returns each element one after the other
+   */
+  *[Symbol.iterator] () {
+      for (const item of this._items) {
+          yield item;
+      }
+  }
+}
+
 // Public expots
 exports.Util = Util;
+exports.ArrayMap = ArrayMap;
 
 })();

package/src/xtkCaster.js

@@ -341,6 +341,16 @@ class XtkCaster {
         return number;
     }
 
+    /**
+     * Convert a raw value into a timestamp (alias to the "asTimestamp" function)
+     * 
+     * @param {*} value is the raw value to convert
+     * @return {Date} the timestamp, possibly null
+     */
+     static asDatetime(value) {
+        return this.asTimestamp(value);
+    }
+
     /**
      * Convert a raw value into a timestamp
      * 
@@ -421,8 +431,35 @@ class XtkCaster {
         return timespan;
     }
 
+    /**
+     * Tests if a given type is a date or time type
+     * @param {string|number} type the type name
+     * @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;
+    }
+
+    /**
+     * Tests if a given type is a string type
+     * @param {string|number} type the type name
+     * @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";
+    }
+
+    /**
+     * Tests if a given type is a numeric type
+     * @param {string|number} type the type name
+     * @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;
+    }
 }
 
+
 exports.XtkCaster = XtkCaster;
 
 })();