@adobe/acc-js-sdk 1.0.2 → 1.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.0.2",
+  "version": "1.0.6",
   "description": "ACC Javascript SDK",
   "main": "src/index.js",
   "homepage": "https://github.com/adobe/acc-js-sdk#readme",
@@ -16,15 +16,19 @@
   "devDependencies": {
     "docdash": "^1.2.0",
     "eslint": "^7.32.0",
-    "jest": "^27.2.0",
-    "jest-junit": "^12.2.0",
+    "jest": "^27.2.5",
+    "jest-junit": "^13.0.0",
     "jsdoc": "^3.6.7",
-    "jsdoc-to-markdown": "^7.0.1"
+    "jsdoc-to-markdown": "^7.0.1",
+    "jshint": "^2.13.1"
   },
   "author": "",
   "scripts": {
     "publish:npm": "npm publish --access public",
     "unit-tests": "jest --config test/jest.config.js --maxWorkers=2",
     "jsdoc": "jsdoc -a all -c jsdoc.json -r -R README.md src/*.js -d docs/jsdoc"
+  },
+  "jshintConfig": {
+    "esversion": 8
   }
 }

package/samples/000 - basics - logon.js

@@ -28,6 +28,15 @@ const utils = require("./utils.js");
     }
   });
 
+  await utils.sample({
+    title: "Display the outbound IP address (can be useful to troubleshoot IP whitelisting issues)",
+    labels: [ "Basics", "IP", "Whitelisting", "403" ],
+    code: async () => {
+      const ip = await sdk.ip();
+      console.log(`>> ${JSON.stringify(ip)}`);
+    }
+  });
+
   await utils.sample({
     title: "Log on and log off",
     labels: [ "Basics", "connectionParameters", "ofUserAndPassword", "xtk:session", "logon", "logoff" ],

package/src/application.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,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";
 
 
 /**********************************************************************************
@@ -31,7 +32,7 @@ const EntityAccessor = require('./entityAccessor.js').EntityAccessor;
 // ========================================================================================
  
 // Determine if a name is an attribute name, i.e. if it starts with the "@" character
-const isAttributeName = function(name) { return name.length > 0 && name[0] == '@'; }
+const isAttributeName = function(name) { return name.length > 0 && name[0] == '@'; };
 
 
 /**
@@ -325,7 +326,7 @@ class XtkSchemaNode {
             else if (element.isParent())
                 childNode = node.parent;
             else
-                childNode = node._getChildDefAutoExpand(name, mustExist)
+                childNode = node._getChildDefAutoExpand(name, mustExist);
             node = childNode;
         }
         return node;
@@ -658,8 +659,6 @@ function newCurrentLogin(userInfo) {
 // ========================================================================================
 
 /**
- * The Application object provides access to certain properties of the Campaign server.
- * 
  * @class
  * @constructor
  * @param {Campaign.Client} client The Campaign Client from which this Application object is created
@@ -667,6 +666,12 @@ function newCurrentLogin(userInfo) {
  */
 class Application {
 
+    /**
+     * The Application object provides access to certain properties of the Campaign server.
+     * Do not create this object directly, it's automatically created by the Campaign.Client at Logon time
+     * @private
+     * @param {Campaign.Client} client the Campaign client representing the Campaign instance
+     */
     constructor(client) {
         this.client = client;
         const info = this.client.getSessionInfo();
@@ -737,3 +742,4 @@ exports.Application = Application;
 // For tests
 exports.newSchema = newSchema;
 exports.newCurrentLogin = newCurrentLogin;
+})();

package/src/cache.js

@@ -0,0 +1,275 @@
+/*
+Copyright 2020 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";    
+  
+
+/**********************************************************************************
+ * 
+ * Cache utilities
+ * 
+ *********************************************************************************/
+
+/**
+ * @namespace Utils
+ */
+
+
+/**********************************************************************************
+ * 
+ * A simple cache for XtkEntities, options, etc.
+ * 
+ *********************************************************************************/
+
+/**
+ * @private
+ * @class
+ * @constructor
+ * @memberof Utils
+ */
+class SafeStorage {
+
+  /**
+   * A wrapper to the Storage interface (LocalStorage, etc.) which is "safe", i.e.
+   * 
+   * - it will never throw / support local stroage to be undefined or not accessible
+   * - Handle the notion of "root key", i.e. prefix 
+   * - Set/get values as JSON only and not as strings
+   * - Silently caches all exceptions
+   * - Automatically remove from storage cached values which are not valid, expired, or cannot be parsed
+   * 
+   * SafeStorage objects are created automatically by Caches
+   * 
+   * @param {Storage} delegate an optional delegate options, confomring to the Storage interface (getItem, setItem, removeItem)
+   * @param {string} rootKey an optional prefix which will be prepend to all keys
+   * @param {function} serDeser serializarion & deserialization function. First parameter is the object or value to serialize
+   *                            or deserialize, and second parameter is true for serialization or false for deserialization
+   */
+  constructor(delegate, rootKey, serDeser) {
+    if (!serDeser)
+      serDeser = (item, serDeser) => {
+        if (serDeser) { 
+          if (!item) throw Error(`Cannot serialize falsy cached item`);
+          if (typeof item !== "object") throw Error(`Cannot serialize non-object`);
+          return JSON.stringify(item); 
+        }
+        else { 
+          if (!item) throw Error(`Cannot deserialize falsy cached item`);
+          return JSON.parse(item); 
+        }
+    };
+    this._delegate = delegate;
+    this._rootKey = rootKey ? `${rootKey}$` : "";
+    this._serDeser = serDeser;
+  }
+
+  /**
+   * Get an item from storage
+   * @param {string} key the item key (relative to the root key)
+   * @returns {Utils.CachedObject} the cached object, or undefined if not found. 
+   *                               The storage serDeser fucntion will be used to deserialize the cached value
+   */
+  getItem(key) {
+    if (!this._delegate || this._rootKey === undefined || this._rootKey === null)
+      return;
+    const itemKey = `${this._rootKey}${key}`;
+    const raw = this._delegate.getItem(itemKey);
+    if (!raw)
+      return undefined;
+    try {
+      return this._serDeser(raw, false);
+    } catch(ex) {
+      this.removeItem(key);
+    }
+  }
+
+  /**
+   * Put an item into storage
+   * @param {string} key the item key (relative to the root key)
+   * @param {Utils.CachedObject} json the object to cache
+   *                               The storage serDeser fucntion will be used to serialize the cached value
+   */
+   setItem(key, json) {
+    if (!this._delegate || this._rootKey === undefined || this._rootKey === null)
+      return;
+    try {
+      //if (json && typeof json === "object") {
+      const raw = this._serDeser(json, true);
+      this._delegate.setItem(`${this._rootKey}${key}`, raw);
+      return;
+    } catch(ex) { /* Ignore errors in safe class */
+    }
+    this.removeItem(key);
+  }
+
+  /**
+   * Removes an item from the storage
+   * @param {string} key the item key (relative to the root key)
+   */
+  removeItem(key) {
+    if (!this._delegate || this._rootKey === undefined || this._rootKey === null)
+      return;
+    try {
+      this._delegate.removeItem(`${this._rootKey}${key}`);
+    } catch(ex) { /* Ignore errors in safe class */
+    }
+  }
+}
+
+/**
+ * @private
+ * @class
+ * @constructor
+ * @memberof Utils
+ */
+class CachedObject {
+
+  /**
+   * An object in the cache, i.e. a wrapped to a cached value and additional metadata to manage the cache.
+   * Do not create such objects directly, they are 100% managed by the Cache object
+   * 
+   * @param {*} value the cached value
+   * @param {number} cachedAt the timestamp at which the value was cached
+   * @param {number} expiresAt the timestamp at which the cached value expires
+   */
+  constructor(value, cachedAt, expiresAt) {
+      this.value = value;
+      this.cachedAt = cachedAt;
+      this.expiresAt = expiresAt;
+  }
+}
+
+/** 
+ * @private
+ * @class
+ * @constructor
+ * @memberof Utils
+ */
+class Cache {
+
+  /**
+   * A general purpose in-memory cache with TTL. In addition to caching in memory, the cache has the ability to delegate the caching
+   * to a persistent cache, such as the browser localStorage. The interface is 100% synchronous.
+   * 
+   * By default, caches take a single parameter for the key. It is possible however to use a more complex scenario by setting a makeKeyFn.
+   * When set, such a function will take 1 or more arguments and will be responsible to create a primitive key (a string) from the arguments.
+   * The cache public APIs : get and put therefore can take a variable number of key arguments, which will be combined into the actual primitive key.
+   * 
+   * @param {Storage} storage is an optional Storage object, such as localStorage or sessionStorage. This object will be wrapped into a SafeStorage object to ensure access is safe and will not throw any exceptions
+   * @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
+   * @param {function} makeKeyFn is an optional function which will generate a key for objects in the cache. It's passed the arguments of the cache 'get' function
+   * @param {function} serDeser serializarion & deserialization function. First parameter is the object or value to serialize
+   *                            or deserialize, and second parameter is true for serialization or false for deserialization
+   */
+  constructor(storage, rootKey, ttl, makeKeyFn, serDeser) {
+      this._storage = new SafeStorage(storage, rootKey, serDeser);
+      this._ttl = ttl || 1000*300;
+      this._makeKeyFn = makeKeyFn || ((x) => x);
+      this._cache = {};
+      // timestamp at which the cache was last cleared
+      this._lastCleared = this._loadLastCleared();
+  }
+
+  // Load timestamp at which the cache was last cleared
+  _loadLastCleared() {
+    const json = this._storage.getItem("lastCleared");
+    return json ? json.timestamp : undefined;
+  }
+
+  _saveLastCleared() {
+    const now = Date.now();
+    this._lastCleared = now;
+    this._storage.setItem("lastCleared", { timestamp: now});
+  }
+
+  // Load from local storage
+  _load(key) {
+    const json = this._storage.getItem(key);
+    if (!json || !json.cachedAt || json.cachedAt <= this._lastCleared) {
+      this._storage.removeItem(key);
+      return;
+    }
+    return json;
+  }
+
+  // Save to local storage
+  _save(key, cached) {
+    this._storage.setItem(key, cached);
+  }
+
+  // Remove from local storage
+  _remove(key) {
+    this._storage.removeItem(key);
+  }
+
+  _getIfActive(key) {
+    // In memory cache?
+    var cached = this._cache[key];
+    // Local storage ?
+    if (!cached) {
+      cached = this._load(key);
+      this._cache[key] = cached;
+    }
+    if (!cached) 
+      return undefined;
+    if (cached.expiresAt <= Date.now()) {
+      delete this._cache[key];
+      this._remove(key);
+      return undefined;
+    }
+    return cached.value;
+  }
+
+  /**
+   * Get a value from the cache
+   * @param {*} key the key or keys of the value to retreive
+   * @returns {*} the cached value, or undefined if not found
+   */
+  get() {
+      const key = this._makeKeyFn.apply(this, arguments);
+      const cached = this._getIfActive(key);
+      return cached;
+  }
+
+  /**
+   * Put a value from the cache
+   * @param {*} key the key or keys of the value to retreive
+   * @param {*} value the value to cache
+   * @returns {CachedObject} a cached object containing the cached value
+   */
+   put() {
+      const value = arguments[arguments.length -1];
+      const key = this._makeKeyFn.apply(this, arguments);
+      const now = Date.now();
+      const expiresAt = now + this._ttl;
+      const cached = new CachedObject(value, now, expiresAt);
+      this._cache[key] = cached;
+      this._save(key, cached);
+      return cached;
+  }
+  
+  /**
+   * Removes everything from the cache. It does not directly removes data from persistent storage if there is, but it marks the cache
+   * as cleared so that subsequent get operation will not actually return any data cached in persistent storage
+   */
+  clear() {
+      this._cache = {};
+      this._saveLastCleared();
+  }
+}
+
+// Public expots
+exports.SafeStorage = SafeStorage;
+exports.Cache = Cache;
+
+})();

package/src/campaign.js

@@ -1,8 +1,3 @@
-"use strict";
-
-const { Util } = require("./util.js");
-
-
 /*
 Copyright 2020 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -14,25 +9,18 @@ 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");
+   
 /**
  * @namespace Campaign
  */
 
 /**
- * Represents a Campaign exception, i.e. any kind of error that can happen when calling Campaign APIs, 
- * ranging from HTTP errors, XML serialization errors, SOAP errors, authentication errors, etc.
- * 
- * @todo does not really belong to soap.js. Move it to a better place
  * @class
  * @constructor
- * @param {SoapMethodCall|request} call the call that triggered the error. It can be a SoapMethodCall object, a HTTP request object, or even be undefined if the exception is generated outside of the context of a call
- * @param {number} statusCode the HTTP status code (200, 500, etc.)
- * @param {string} faultCode the fault code, i.e. an error code
- * @param {string} faultString a short description of the error
- * @param {string} detail a more detailed description of the error
- * @param {*} cause an optional error object representing the cause of the exception
  * @memberof Campaign
  */
  class CampaignException {
@@ -50,18 +38,36 @@ governing permissions and limitations under the License.
   static NOT_LOGGED_IN(call, details)                     { return new CampaignException(     call, 400, 16384, `SDK-000010 Cannot call API because client is not logged in`, details); }
   static DECRYPT_ERROR(details)                           { return new CampaignException(undefined, 400, 16384, `SDK-000011 "Cannot decrypt password: password marker is missing`, details); }
   
+
+  /**
+   * Returns a short description of the exception
+   * @returns {string} a short description of the exception
+   */
   toString() {
       return this.message;
   }
 
+  /**
+   * Represents a Campaign exception, i.e. any kind of error that can happen when calling Campaign APIs, 
+   * ranging from HTTP errors, XML serialization errors, SOAP errors, authentication errors, etc.
+   * 
+   * Members of this object are trimmed, and all session tokens, security tokens, passwords, etc. are replaced by "***"
+   * 
+   * @param {SoapMethodCall|request} call the call that triggered the error. It can be a SoapMethodCall object, a HTTP request object, or even be undefined if the exception is generated outside of the context of a call
+   * @param {number} statusCode the HTTP status code (200, 500, etc.)
+   * @param {string} faultCode the fault code, i.e. an error code
+   * @param {string} faultString a short description of the error
+   * @param {string} detail a more detailed description of the error
+   * @param {Error|string} cause an optional error object representing the cause of the exception
+   */  
   constructor(call, statusCode, faultCode, faultString, detail, cause) {
 
       // Provides a shorter and more friendly description of the call and method name
       // depending on whether the exception is thrown by a SOAP or HTTP call
-      var methodCall = undefined;
-      var methodName = undefined;
+      var methodCall;
+      var methodName;
       if (call) {
-          const ctor = call.__proto__.constructor;
+          const ctor = Object.getPrototypeOf(call).constructor;
           if (ctor && ctor.name == "SoapMethodCall") {
               methodCall = {
                   type: "SOAP",
@@ -192,6 +198,7 @@ governing permissions and limitations under the License.
 
 /**
  * Creates a CampaignException for a SOAP call and from a root exception
+ * 
  * @private
  * @param {SoapMethodCall} call the SOAP call
  * @param {*} err the exception causing the SOAP call.
@@ -204,7 +211,7 @@ function makeCampaignException(call, err) {
       return err;
   
   // Wraps DOM exceptions which can occur when dealing with malformed XML
-  const ctor = err.__proto__.constructor;
+  const ctor = Object.getPrototypeOf(err).constructor;
   if (ctor && ctor.name == "DOMException") {
       return new CampaignException(call, 500, err.code, `DOMException (${err.name})`, err.message, err);
   }
@@ -516,7 +523,7 @@ exports.OPERATOR_TYPE_GROUP = 1;
 exports.OPERATOR_TYPE_RIGHT = 2;
 
 exports.WORKFLOWTASK_STATUS_PENDING = 0;
-exports.WORKFLOWTASK_STATUS_COMPLETED = 1
+exports.WORKFLOWTASK_STATUS_COMPLETED = 1;
 
 exports.MOBILE_MSGTYPE_SMS     = 0;
 exports.MOBILE_MSGTYPE_WAPPUSH = 1;
@@ -661,4 +668,6 @@ exports.ACTION_TYPE_EXPIRED = 11;
 
 exports.CONTENT_EDITING_MODE_DEFAULT = 0;
 exports.CONTENT_EDITING_MODE_DCE = 1;
-exports.CONTENT_EDITING_MODE_AEM = 2;
+exports.CONTENT_EDITING_MODE_AEM = 2;
+
+})();