@adobe/acc-js-sdk 1.0.6 → 1.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "ACC Javascript SDK",
   "main": "src/index.js",
   "homepage": "https://github.com/adobe/acc-js-sdk#readme",
@@ -10,17 +10,16 @@
     "test": "test"
   },
   "dependencies": {
-    "axios": "^0.21.4",
-    "jsdom": "^16.7.0"
+    "axios": "^0.25.0",
+    "jsdom": "^19.0.0"
   },
   "devDependencies": {
     "docdash": "^1.2.0",
-    "eslint": "^7.32.0",
-    "jest": "^27.2.5",
+    "eslint": "^8.7.0",
+    "jest": "^27.4.7",
     "jest-junit": "^13.0.0",
     "jsdoc": "^3.6.7",
-    "jsdoc-to-markdown": "^7.0.1",
-    "jshint": "^2.13.1"
+    "jshint": "^2.13.3"
   },
   "author": "",
   "scripts": {

package/samples/002 - basics - schemas.js

@@ -25,7 +25,7 @@ const utils = require("./utils.js");
     code: async() => {
       return await utils.logon(async (client, NLWS) => {
         const schema = await client.getSchema("xtk:option");
-        console.log(`>> client.getSchema (current representation) => ${JSON.stringify(schema)}`);        
+        console.log(`>> client.getSchema (current representation) : ${JSON.stringify(schema)}`);
       });
     }
   });
@@ -38,7 +38,7 @@ const utils = require("./utils.js");
     code: async() => {
       return await utils.logon(async (client, NLWS) => {
         const schema = await client.getSchema("xtk:option", "xml");
-        console.log(`>> client.getSchema (xml) => ${client.DomUtil.toXMLString(schema)}`);
+        console.log(`>> client.getSchema (xml) : ${client.DomUtil.toXMLString(schema)}`);
       });
     }
   });
@@ -52,7 +52,7 @@ const utils = require("./utils.js");
     code: async() => {
       return await utils.logon(async (client, NLWS) => {
         const schema = await client.getEntityIfMoreRecent("xtk:srcSchema", "nms:rtEvent");
-        console.log(`>> client.getEntityIfMoreRecent => ${JSON.stringify(schema)}`);        
+        console.log(`>> client.getEntityIfMoreRecent : ${JSON.stringify(schema)}`);
       });
     }
   });

package/samples/020 - encryption.js

@@ -31,11 +31,11 @@ const utils = require("./utils.js");
     code: async() => {
       return await utils.logon(async (client, NLWS) => {
         const password = "Hello, World";
-        console.log(`xtk:session#Encrypt => ${await NLWS.xtkSession.encrypt(password)}`);
-        console.log(`xtk:session#EncryptPassword => ${await NLWS.xtkSession.encryptPassword(password)}`);
-        console.log(`xtk:session#EncryptServerPassword => ${await NLWS.xtkSession.encryptServerPassword(password)}`);
-        console.log(`xtk:session#HashPassword => ${await NLWS.xtkSession.hashPassword(password)}`);
-        console.log(`xtk:session#ReEncryptPassword => ${await NLWS.xtkSession.reEncryptPassword(await NLWS.xtkSession.encryptPassword(password))}`);
+        console.log(`xtk:session#Encrypt : ${await NLWS.xtkSession.encrypt(password)}`);
+        console.log(`xtk:session#EncryptPassword : ${await NLWS.xtkSession.encryptPassword(password)}`);
+        console.log(`xtk:session#EncryptServerPassword : ${await NLWS.xtkSession.encryptServerPassword(password)}`);
+        console.log(`xtk:session#HashPassword : ${await NLWS.xtkSession.hashPassword(password)}`);
+        console.log(`xtk:session#ReEncryptPassword : ${await NLWS.xtkSession.reEncryptPassword(await NLWS.xtkSession.encryptPassword(password))}`);
       });
     }
   });

package/src/application.js

@@ -88,6 +88,22 @@ class XtkSchemaKey {
 
 }
 
+/**
+ * A join in a XtkSchemaNode link type
+ *
+ * @private
+ * @class
+ * @constructor
+ * @param {} xml
+ * @memberof Campaign
+ */
+ class XtkJoin {
+
+    constructor(xml) {
+        this.src = EntityAccessor.getAttributeAsString(xml, "xpath-src");
+        this.dst = EntityAccessor.getAttributeAsString(xml, "xpath-dst");
+    }
+}
 // ========================================================================================
 // Schema nodes
 // ========================================================================================
@@ -157,16 +173,37 @@ class XtkSchemaNode {
          * @type {string}
          */
         this.type = EntityAccessor.getAttributeAsString(xml, "type");
+        /**
+         * The node target
+         * @type {string}
+         */
+         this.target = EntityAccessor.getAttributeAsString(xml, "target");
+        /**
+         * The node integrity
+         * @type {string}
+         */
+         this.integrity = EntityAccessor.getAttributeAsString(xml, "integrity");
         /**
          * The node data length (applicable for string-types only)
          * @type {number}
          */
         this.length = EntityAccessor.getAttributeAsLong(xml, "length");
+        /**
+         * The enum of the node
+         * @type {string}
+         */
+        this.enum = EntityAccessor.getAttributeAsString(xml, "enum");
         /**
          * "ref" attribute of the node, which references another node
          * @type {string}
          */
         this.ref = EntityAccessor.getAttributeAsString(xml, "ref");
+
+        /**
+         * Has an unlimited number of children of the same type
+         * @type {boolean}
+         */
+        this.unbound = EntityAccessor.getAttributeAsBoolean(xml, "unbound");
         /**
          * Children of the node. This is a object whose key are the names of the children nodes (without the "@"
          * character for attributes) 
@@ -198,6 +235,15 @@ class XtkSchemaNode {
          * @type {string}
          */
         this.nodePath = this._getNodePath(true)._path;
+        /**
+         * Element of type "link" has an array of XtkJoin
+         * @type {@type {XtkJoin[]}}
+         */
+        this.joins = [];
+
+        for (var child of EntityAccessor.getChildElements(xml, "join")) {
+            this.joins.push(new XtkJoin(child));
+        }
 
         // Children (elements and attributes)
         const childNodes = [];
@@ -242,6 +288,15 @@ class XtkSchemaNode {
         return false;
     }
 
+    /**
+     * Indicates whether the current node has an unlimited number of children of the same type.
+     *
+     * @returns {boolean} a boolean indicating whether the node contains a child with the given name
+     */
+    isUnbound() {
+        return this.unbound;
+    }
+
     /**
      * Computes the path of a node
      * 

package/src/campaign.js

@@ -37,6 +37,7 @@ const { Util } = require("./util.js");
   static SOAP_UNKNOWN_METHOD(schema, method, details)     { return new CampaignException(undefined, 400, 16384, `SDK-000009 Unknown method '${method}' of schema '${schema}'`, details); }
   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); }
+  static SESSION_EXPIRED()                                { return new CampaignException(undefined, 401, 16384, `SDK-000012 "Session has expired or is invalid. Please reconnect.`); }
   
 
   /**
@@ -223,6 +224,9 @@ function makeCampaignException(call, err) {
       faultString = err.data;
       details = undefined;
     }
+    // Session expiration case must return a 401
+    if (err.data && err.data.indexOf(`XSV-350008`) != -1)
+        return CampaignException.SESSION_EXPIRED();
     return new CampaignException(call, err.statusCode, "", faultString, details, err);
   }
 

package/src/client.js

@@ -296,6 +296,7 @@ class ConnectionParameters {
             }    
         }
         this._options._storage = storage;
+        this._options.refreshClient = options.refreshClient;
     }
 
     /**
@@ -478,6 +479,7 @@ class Client {
         this._transport = connectionParameters._options.transport;
         this._traceAPICalls = connectionParameters._options.traceAPICalls;
         this._observers = [];
+        this._refreshClient = connectionParameters._options.refreshClient;
 
         // expose utilities
 
@@ -676,6 +678,38 @@ class Client {
         return soapCall;
     }
 
+    /**
+     * Retry a a SOAP call
+     *
+     * @private
+     * @return {SOAP.SoapMethodCall} a SoapMethodCall to retry
+     * parameters should be set
+     */
+    async _retrySoapCall(soapCall) {
+        soapCall.retry = false;
+        var newClient = await this._refreshClient(this); 
+        soapCall.finalize(newClient._soapEndPoint(), newClient);
+        if (this._traceAPICalls) {
+            const safeCallData = Util.trim(soapCall.request.data);
+            console.log(`RETRY SOAP//request ${safeCallData}`);
+        }
+        await soapCall.execute();
+        if (this._traceAPICalls) {
+            const safeCallResponse = Util.trim(soapCall.response);
+            console.log(`SOAP//response ${safeCallResponse}`);
+        }
+        return;
+    }
+
+    /**
+     *  SOAP Endpoint
+     *
+     * @private
+     * @return {string} soap call End point
+     */
+    _soapEndPoint() {
+        return this._connectionParameters._endpoint + "/nl/jsp/soaprouter.jsp";
+    }
     /**
      * After a SOAP method call has been prepared with '_prepareSoapCall', and parameters have been added,
      * this function actually executes the SOAP call
@@ -687,8 +721,7 @@ class Client {
         const that = this;
         if (soapCall.requiresLogon() && !that.isLogged())
             throw CampaignException.NOT_LOGGED_IN(soapCall, `Cannot execute SOAP call ${soapCall.urn}#${soapCall.methodName}: you are not logged in. Use the Logon function first`);
-        var soapEndpoint = that._connectionParameters._endpoint + "/nl/jsp/soaprouter.jsp";
-        soapCall.finalize(soapEndpoint);
+        soapCall.finalize(this._soapEndPoint());
         
         const safeCallData = Util.trim(soapCall.request.data);
         if (that._traceAPICalls)
@@ -707,7 +740,12 @@ class Client {
                 if (that._traceAPICalls)
                     console.log(`SOAP//failure ${ex.toString()}`);
                 that._notifyObservers((observer) => observer.onSOAPCallFailure && observer.onSOAPCallFailure(soapCall, ex) );
-                return Promise.reject(ex);
+                // Call session expiration callback in case of 401
+                if (ex.statusCode == 401 && that._refreshClient && soapCall.retry) {
+                    return this._retrySoapCall(soapCall);
+                }
+                else
+                    return Promise.reject(ex);
             });
     }
 
@@ -745,6 +783,8 @@ class Client {
         }
         else if (credentials._type == "UserPassword" || credentials._type == "BearerToken") {
             const soapCall = that._prepareSoapCall("xtk:session", credentials._type === "UserPassword" ? "Logon" : "BearerTokenLogon");
+            // No retry for logon SOAP methods
+            soapCall.retry = false;
             if (credentials._type == "UserPassword") {
                 const user = credentials._getUser();
                 const password = credentials._getPassword();
@@ -813,7 +853,6 @@ class Client {
     logoff() {
         var that = this;
         if (!that.isLogged()) return;
-        
         const credentials = this._connectionParameters._credentials;
         if (credentials._type != "SessionToken" && credentials._type != "AnonymousUser") {
             var soapCall = that._prepareSoapCall("xtk:session", "Logoff");

package/src/soap.js

@@ -93,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 || "";
@@ -151,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);
     }
 
     /**
@@ -542,12 +528,50 @@ class SoapMethodCall {
             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;
@@ -565,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
             //

package/src/xtkCaster.js

@@ -12,6 +12,8 @@ governing permissions and limitations under the License.
 (function() {
 "use strict";    
 
+const { Util } = require('./util.js');
+
 /**********************************************************************************
  * 
  * Helper class to cast values to and from their Xtk versions
@@ -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,10 +55,11 @@ 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
  */
 
@@ -85,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";
@@ -97,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
@@ -137,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);
             }
@@ -149,6 +164,7 @@ class XtkCaster {
                 return this.asShort(value);
             }
             case 3:             // FIELD_LONG
+            case "int":
             case "long": {
                 return this.asLong(value);
             }
@@ -175,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}'`);
             }
@@ -354,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
@@ -369,6 +392,35 @@ 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;

package/test/application.test.js

@@ -290,7 +290,10 @@ describe('Schemas', function() {
                                             <value name="prospect" label="Prospect" value="0" img=""/>
                                             <value name="customer" label="Client"   value="1" img=""/>
                                         </enumeration>
-                                        <element name='recipient' label='Recipients'></element>
+                                        <element name='recipient' label='Recipients'>
+                                        <attribute advanced="true" desc="Recipient sex" enum="nms:recipient:gender"
+                                            label="Gender" name="gender" sqlname="iGender" type="byte"/>
+                                        </element>
                                     </schema>`);
             var schema = newSchema(xml);
             var enumerations = schema.enumerations;
@@ -303,6 +306,7 @@ describe('Schemas', function() {
             // at least one img attribute
             expect(enumerations.status2.name).toBe("status2");
             expect(enumerations.status2.hasImage).toBe(false);
+            expect(schema.root.children["@gender"].enum).toBe("nms:recipient:gender");
         })
 
         it("Should list enumeration values", () => {
@@ -383,6 +387,41 @@ describe('Schemas', function() {
         })
     });
 
+    describe("Link", () => {
+        it("Should have a link element", () => {
+            var xml = DomUtil.parse(`<schema namespace='nms' name='recipient'>
+                                        <element name='recipient' label='Recipients'>
+                                            <element integrity="neutral" label="Info on the email" name="emailInfo"
+                                                target="nms:address" type="link" unbound="true">
+                                                <join xpath-dst="@address" xpath-src="@email"/>
+                                                <join xpath-dst="@dst" xpath-src="@source"/>
+                                            </element>
+                                        </element>
+                                    </schema>`);
+            var schema = newSchema(xml);
+            var link = schema.root.children["emailInfo"];
+            expect(link.target).toBe("nms:address");
+            expect(link.integrity).toBe("neutral");
+            expect(link.isUnbound()).toBe(true);
+            expect(link.joins.length).toBe(2);
+            expect(link.joins[0].dst).toBe("@address");
+            expect(link.joins[0].src).toBe("@email");
+
+            xml = DomUtil.parse(`<schema namespace='nms' name='recipient'>
+                                    <element name='recipient' label='Recipients'>
+                                        <element integrity="neutral" label="Info on the email" name="emailInfo"
+                                            target="nms:address" type="link">
+                                            <join xpath-dst="@address" xpath-src="@email"/>
+                                            <join xpath-dst="@dst" xpath-src="@source"/>
+                                        </element>
+                                    </element>
+                                </schema>`);
+            schema = newSchema(xml);
+            link = schema.root.children["emailInfo"];
+            expect(link.isUnbound()).toBe(false);
+        })
+    })
+
     describe("getnodepath", () => {
         var xml = DomUtil.parse(`<schema namespace='nms' name='recipient'>
                 <element name='recipient' label='Recipients'>