@adobe/acc-js-sdk 1.1.25 → 1.1.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.25",
+  "version": "1.1.27",
   "description": "ACC Javascript SDK",
   "main": "src/index.js",
   "homepage": "https://github.com/adobe/acc-js-sdk#readme",

package/src/application.js

@@ -95,7 +95,8 @@ class SchemaCache {
         if (schema === undefined) {
             schema = await this._client.application._getSchema(schemaId);
             if (!schema) schema = null; // null = not found
-            this._schemas[schemaId] = schema;
+            if (!schemaId.startsWith("temp:group:"))
+                this._schemas[schemaId] = schema;
         }
         return schema;
     }

package/src/client.js

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 */
 (function() {
 "use strict";
-
+/*jshint sub:true*/
 
 /**********************************************************************************
  *
@@ -244,12 +244,12 @@ class Credentials {
      */
     constructor(type, sessionToken, securityToken) {
         if (type != "UserPassword" && type != "ImsServiceToken" && type != "SessionToken" &&
-            type != "AnonymousUser" && type != "SecurityToken" && type != "BearerToken")
+            type != "AnonymousUser" && type != "SecurityToken" && type != "BearerToken" && type != "ImsBearerToken")
             throw CampaignException.INVALID_CREDENTIALS_TYPE(type);
         this._type = type;
         this._sessionToken = sessionToken || "";
         this._securityToken = securityToken || "";
-        if (type == "BearerToken") {
+        if (type == "BearerToken" || type === "ImsBearerToken") {
             this._bearerToken = sessionToken || "";
             this._sessionToken = "";
         }
@@ -397,8 +397,13 @@ class ConnectionParameters {
     }
 
     /**
-     * Creates connection parameters for a Campaign instance from bearer token
-     *
+     * Creates connection parameters for a Campaign instance from bearer token.
+     * This authentication method uses an IMS Bearer token and calls the xtk:session#BearerTokenLogin method
+     * which will exchange the IMS bearer token with Campaign session and security tokens.
+     * This is a legacy method. Campaign 8.5 will has an authentication method which allows to directly
+     * use the IMS bearer token and which is recommended. 
+     * To avoid an extra call to "BearerTokenLogin", use the "ofImsBearerToken" method.
+     * 
      * @param {string} endpoint The campaign endpoint (URL)
      * @param {string} bearerToken IMS bearer token
      * @param {*} options connection options
@@ -408,6 +413,23 @@ class ConnectionParameters {
         const credentials = new Credentials("BearerToken", bearerToken);
         return new ConnectionParameters(endpoint, credentials, options);
     }
+
+    /**
+     * Creates connection parameters for a Campaign instance from a IMS bearer token.
+     * This authentication method does not require exchange the IMS token with session and security tokens
+     * and only works in ACC 8.5 and above.
+     * For older version of ACC or to use session/seurity tokens, use the "ofBearerToken" method.
+     * 
+     * @param {string} endpoint The campaign endpoint (URL)
+     * @param {string} bearerToken IMS bearer token
+     * @param {*} options connection options
+     * @returns {ConnectionParameters} a ConnectionParameters object which can be used to create a Client
+     */
+    static ofImsBearerToken(endpoint, bearerToken, options) {
+        const credentials = new Credentials("ImsBearerToken", bearerToken);
+        return new ConnectionParameters(endpoint, credentials, options);
+    }
+
     /**
      * Creates connection parameters for a Campaign instance, using an IMS service token and a user name (the user to impersonate)
      *
@@ -557,15 +579,13 @@ const fileUploader = (client) => {
                     }
                     const data = new FormData();
                     data.append('file_noMd5', file);
+                    const headers = client._getAuthHeaders(false);
                     client._makeHttpCall({
                         url: `${client._connectionParameters._endpoint}/nl/jsp/uploadFile.jsp`,
                         processData: false,
                         method: 'POST',
                         data: data,
-                        headers: {
-                            'X-Security-Token': client._securityToken,
-                            'X-Session-Token': client._sessionToken,
-                        }
+                        headers: headers
                     }).then((okay) => {
                         if (!okay.startsWith('Ok')) {
                             throw okay;
@@ -645,13 +665,28 @@ class Client {
      */
     constructor(sdk, connectionParameters) {
         this.sdk = sdk;
+        this.reinit(connectionParameters);
+
+        this._observers = [];
+        this._cacheChangeListeners = [];
+    }
+
+    /**
+     * Re-initialize a client with new connection parameters.
+     * Typically called from the refreshClient callback after a connection expires.
+     * Conserves observers
+     *
+     * @param {Campaign.ConnectionParameters} user user name, for instance admin
+     */
+    reinit(connectionParameters) {
         this._connectionParameters = connectionParameters; // ## TODO security concern (password kept in memory)
         this._representation = connectionParameters._options.representation;
 
         this._sessionInfo = undefined;
         this._sessionToken = undefined;
         this._securityToken = undefined;
-        this._installedPackages = {};     // package set (key and value = package id, ex: "nms:amp")
+        this._bearerToken = undefined;      // set when using Bearer authentication and "ImsBearer" credential type
+        this._installedPackages = {};       // package set (key and value = package id, ex: "nms:amp")
 
         this._secretKeyCipher = undefined;
 
@@ -667,7 +702,7 @@ class Client {
         const rootKeyType = connectionParameters._options.cacheRootKey;
         let rootKey = "";
         if (!rootKeyType || rootKeyType === "default")
-            rootKey = `acc.js.sdk.${sdk.getSDKVersion().version}.${instanceKey}.cache.`;
+            rootKey = `acc.js.sdk.${this.sdk.getSDKVersion().version}.${instanceKey}.cache.`;
 
         // Clear storage cache if the sdk versions or the instances are different
         if (this._storage && typeof this._storage.removeItem === 'function') {
@@ -687,8 +722,6 @@ class Client {
 
         this._transport = connectionParameters._options.transport;
         this._traceAPICalls = connectionParameters._options.traceAPICalls;
-        this._observers = [];
-        this._cacheChangeListeners = [];
         this._refreshClient = connectionParameters._options.refreshClient;
 
         // expose utilities
@@ -749,6 +782,26 @@ class Client {
         return `${version.name}/${version.version} ${version.description}`;
     }
 
+    /**
+     * Get HTTP authentication headers
+     * @param
+     * @returns {Object} the headers
+     */
+    _getAuthHeaders(setCookie) {
+        const headers = {};
+        if (this._bearerToken) {
+            headers['Authorization'] = `Bearer ${this._bearerToken}`;
+        }
+        else {
+            headers['X-Security-Token'] = this._securityToken;
+            headers['X-Session-Token'] = this._sessionToken;
+            if (setCookie) {
+                headers['Cookie'] = '__sessiontoken=' + this._sessionToken;
+            }
+        }
+        return headers;
+    }
+
     /**
      * Convert an XML object into a representation
      *
@@ -929,6 +982,9 @@ class Client {
         const credentialsType = this._connectionParameters._credentials._type;
         if (credentialsType == "AnonymousUser")
             return true;
+        else if (credentialsType == "ImsBearerToken") {
+            return !!this._bearerToken;
+        }
 
         // When using bearer token authentication we are considered logged only after
         // the bearer token has been converted into session token and security token
@@ -967,7 +1023,8 @@ class Client {
                                             this._sessionToken, this._securityToken,
                                             this._getUserAgentString(),
                                             Object.assign({}, this._connectionParameters._options, pushDownOptions),
-                                            extraHttpHeaders);
+                                            extraHttpHeaders,
+                                            this._bearerToken);
         soapCall.internal = !!internal;
         soapCall.isStatic = isStatic;
         return soapCall;
@@ -1324,6 +1381,7 @@ class Client {
         this.application = null;
         this._sessionToken = "";
         this._securityToken = "";
+        this._bearerToken = undefined;
         const credentials = this._connectionParameters._credentials;
 
         const sdkVersion = this.sdk.getSDKVersion();
@@ -1349,6 +1407,7 @@ class Client {
             that._installedPackages = {};
             that._sessionToken = credentials._sessionToken;
             that._securityToken = "";
+            that._bearerToken = undefined;
             that._onLogon();
             return Promise.resolve();
         }
@@ -1357,6 +1416,16 @@ class Client {
             that._installedPackages = {};
             that._sessionToken = "";
             that._securityToken = credentials._securityToken;
+            that._bearerToken = undefined;
+            that._onLogon();
+            return Promise.resolve();
+        }
+        else if (credentials._type == "ImsBearerToken") {
+            that._sessionInfo = undefined;
+            that._installedPackages = {};
+            that._sessionToken = "";
+            that._securityToken = "";
+            that._bearerToken = credentials._bearerToken;
             that._onLogon();
             return Promise.resolve();
         }
@@ -1407,6 +1476,7 @@ class Client {
                 // store member variables after all parameters are decode the ensure atomicity
                 that._sessionToken = sessionToken;
                 that._securityToken = securityToken;
+                that._bearerToken = undefined;
 
                 that._onLogon();
             });
@@ -1444,6 +1514,7 @@ class Client {
                 return this._makeSoapCall(soapCall).then(function() {
                     that._sessionToken = "";
                     that._securityToken = "";
+                    that._bearerToken = undefined;
                     that.application = null;
                     soapCall.checkNoMoreArgs();
                 });
@@ -1451,6 +1522,7 @@ class Client {
             else {
                 that._sessionToken = "";
                 that._securityToken = "";
+                that._bearerToken = undefined;
                 that.application = null;
             }
         } finally {
@@ -1668,16 +1740,55 @@ class Client {
     async getSchema(schemaId, representation, internal) {
         var entity = await this._entityCache.get("xtk:schema", schemaId);
         if (!entity) {
-          entity = await this.getEntityIfMoreRecent("xtk:schema", schemaId, "xml", internal);
-          if (entity) {
-            const impls = DomUtil.getAttributeAsString(entity, "implements");
-            if (impls === "xtk:persist" && schemaId !== "xtk:session" && schemaId !== "xtk:persist") {
-                // Ensure xtk:persist is present by loading the xtk:session schema
-                await this.getSchema("xtk:session", "xml", true);
+              // special case of "temp:group:*" schemas for nms:group
+              // Schema "temp:group:*" is not cached because life cycle of this kind of schema is not the same as the others schemas
+              if (schemaId.startsWith("temp:group:")) {
+                  const parts = schemaId.split(":");
+                  let queryDef = {
+                    "schema": "nms:group",
+                    "operation": "get",
+                    "select": {
+                      "node": [
+                        { "expr": "@id" },
+                        { "expr": "extension" }
+                      ]
+                    },
+                    "where": {
+                      "condition": [
+                        { "expr": "@id=" + XtkCaster.asLong(parts[2]) }
+                      ]
+                    }
+                  };
+                  // Convert to current representation
+                  queryDef = this._convertToRepresentation(queryDef, "SimpleJson", "xml");
+                  const query = this.NLWS.xml.xtkQueryDef.create(queryDef);
+                  try {
+                      const groupSchema = await query.executeQuery();
+                      const extension = DomUtil.findElement(groupSchema, "extension");
+                      if (extension) {
+                          entity = extension;
+                      } else {
+                          entity = null;
+                      }
+                  } catch (ex) {
+                      if (ex.name == 'CampaignException' && ex.errorCode == 'SOP-330011') {
+                          entity = null;
+                      } else {
+                          throw ex;
+                      }
+                  }
+              } else {
+                  entity = await this.getEntityIfMoreRecent("xtk:schema", schemaId, "xml", internal);
+                  if (entity) {
+                      const impls = DomUtil.getAttributeAsString(entity, "implements");
+                      if (impls === "xtk:persist" && schemaId !== "xtk:session" && schemaId !== "xtk:persist") {
+                        // Ensure xtk:persist is present by loading the xtk:session schema
+                        await this.getSchema("xtk:session", "xml", true);
+                      }
+                      await this._entityCache.put("xtk:schema", schemaId, entity);
+                      await this._methodCache.put(entity);
+                  }
             }
-            await this._entityCache.put("xtk:schema", schemaId, entity);
-            await this._methodCache.put(entity);
-          }
         }
         entity = this._toRepresentation(entity, representation);
         return entity;
@@ -1914,13 +2025,10 @@ class Client {
      * @returns {Campaign.PingStatus} an object describing the server status
      */
     async ping() {
+        const headers = this._getAuthHeaders(true);
         const request = {
             url: `${this._connectionParameters._endpoint}/nl/jsp/ping.jsp`,
-            headers: {
-                'X-Security-Token': this._securityToken,
-                'X-Session-Token': this._sessionToken,
-                'Cookie': '__sessiontoken=' + this._sessionToken
-            }
+            headers: headers,
         };
         for (let h in this._connectionParameters._options.extraHttpHeaders)
             request.headers[h] = this._connectionParameters._options.extraHttpHeaders[h];
@@ -1953,14 +2061,12 @@ class Client {
                 callContext.formData.ctx = DomUtil.toXMLString(xmlCtx);
             }
             const selectionCount = callContext.selection.split(',').length;
-
+            
+            const headers = this._getAuthHeaders(false);
+            headers['Content-Type'] = 'application/x-www-form-urlencoded';
             const request = {
                 url: `${this._connectionParameters._endpoint}/report/${callContext.reportName}?${encodeURI(`_noRender=true&_schema=${callContext.schema}&_context=${callContext.context}&_selection=${callContext.selection}`)}&_selectionCount=${selectionCount}`,
-                headers: {
-                    'X-Security-Token': this._securityToken,
-                    'X-Session-Token': this._sessionToken,
-                    'Content-Type': 'application/x-www-form-urlencoded'
-                },
+                headers: headers,
                 method: 'POST',
                 data : qsStringify(callContext.formData)
             };
@@ -1985,13 +2091,10 @@ class Client {
      * @returns {Campaign.McPingStatus} an object describing Message Center server status
      */
     async mcPing() {
+        const headers = this._getAuthHeaders(true);
         const request = {
             url: `${this._connectionParameters._endpoint}/nl/jsp/mcPing.jsp`,
-            headers: {
-                'X-Security-Token': this._securityToken,
-                'X-Session-Token': this._sessionToken,
-                'Cookie': '__sessiontoken=' + this._sessionToken
-            }
+            headers: headers
         };
         for (let h in this._connectionParameters._options.extraHttpHeaders)
             request.headers[h] = this._connectionParameters._options.extraHttpHeaders[h];

package/src/domUtil.js

@@ -341,20 +341,18 @@ class DomUtil {
                     xmlElement.textContent = value;
                     xmlRoot.appendChild(xmlElement);
                 }
-                else if (t == "object") {
-                    if (value.length !== undefined && value.length !== null) {
-                        for (var i=0; i<value.length; i++) {
-                            const xmlElement = doc.createElement(att);
-                            this._fromJSON(doc, xmlElement, value[i], flavor);
-                            xmlRoot.appendChild(xmlElement);
-                        }
-                    }
-                    else {
+                else if (Util.isArray(value)) {
+                    for (var i=0; i<value.length; i++) {
                         const xmlElement = doc.createElement(att);
-                        this._fromJSON(doc, xmlElement, value, flavor);
+                        this._fromJSON(doc, xmlElement, value[i], flavor);
                         xmlRoot.appendChild(xmlElement);
                     }
                 }
+                else if (t == "object") {
+                    const xmlElement = doc.createElement(att);
+                    this._fromJSON(doc, xmlElement, value, flavor);
+                    xmlRoot.appendChild(xmlElement);
+                }
                 else
                     throw new DomException(`Cannot cast JSON to XML: element '${att}' type '${t}' is unknown or not supported yet`);
             }

package/src/soap.js

@@ -11,7 +11,7 @@ governing permissions and limitations under the License.
 */
 (function() {
 "use strict";    
-    
+/*jshint sub:true*/
 
 /**********************************************************************************
  * 
@@ -80,11 +80,12 @@ const NS_XSD = "http://www.w3.org/2001/XMLSchema";
  * @param {string} userAgentString The user agent string to use for HTTP requests
  * @param {string} pushDownOptions Options to push down to the request (comes from connectionParameters._options)
  * @param {{ name:string, value:string}} extraHttpHeaders key/value pair of HTTP header (will override any other headers)
+ * @param {string} bearerToken The bearer token to use for HTTP requests. Only required for ImsBearerToken authentication
  * @memberof SOAP
  */
 class SoapMethodCall {
     
-    constructor(transport, urn, methodName, sessionToken, securityToken, userAgentString, pushDownOptions, extraHttpHeaders) {
+    constructor(transport, urn, methodName, sessionToken, securityToken, userAgentString, pushDownOptions, extraHttpHeaders, bearerToken) {
         this.request = undefined;       // The HTTP request (object literal passed to the transport layer)
         this.requestOptions = undefined;
         this.response = undefined;      // The HTTP response object (in case of success)
@@ -103,6 +104,7 @@ class SoapMethodCall {
 
         this._sessionToken = sessionToken || "";
         this._securityToken = securityToken || "";
+        this._bearerToken = bearerToken; // may be undefined if not using bearer token authentication
         this._userAgentString = userAgentString;
         this._pushDownOptions = pushDownOptions || {};
         this._charset = this._pushDownOptions.charset || '';
@@ -538,9 +540,14 @@ class SoapMethodCall {
         const headers = {
             'Content-type': `application/soap+xml${this._charset ? ";charset=" + this._charset : ""}`,
             'SoapAction': `${this.urn}#${this.methodName}`,
-            'X-Security-Token': this._securityToken,
-            'X-Session-Token': this._sessionToken,
         };
+        if (this._bearerToken) {
+            headers['Authorization'] = `Bearer ${this._bearerToken}`;
+        }
+        else {
+            headers['X-Security-Token'] = this._securityToken;
+            headers['X-Session-Token'] = this._sessionToken;
+        }
 
         // Add HTTP headers specific to the SOAP call for better tracing/troubleshooting
         if (this._extraHttpHeaders && this._extraHttpHeaders['ACC-SDK-Version']) {
@@ -579,6 +586,7 @@ class SoapMethodCall {
         if (client) {
             this._sessionToken = client._sessionToken;
             this._securityToken = client._securityToken;
+            this._bearerToken = client._bearerToken;
         }
 
         var cookieHeader = DomUtil.findElement(this._header, "Cookie");

package/src/util.js

@@ -51,18 +51,7 @@ class Util {
    * @returns {boolean} true if the object is an array
    */
   static isArray(obj) {
-    if (obj === null || obj === undefined) return false;
-    // JavaScript arrays are objects
-    if (typeof obj != "object") return false;
-    // They also have a length property. But checking the length is not enough
-    // since, it can also be an object literal with a "length" property. Campaign
-    // schema attributes typically have a "length" attribute and are not arrays
-    if (obj.length === undefined || obj.length === null) return false;
-    // So check for a "push" function
-    if (obj.push === undefined || obj.push === null) return false;
-    if (typeof obj.push != "function") 
-        return false;
-    return true;
+    return Array.isArray(obj);
   }
 
   // Helper function for trim() to replace text between 2 indices

package/test/application.test.js

@@ -1499,6 +1499,66 @@ describe('Application', () => {
                 const isoA3 = await recipient.root.findNode("country/@isoA3");
                 expect(isoA3).toBeFalsy();
             });
+
+            it("Should not cache temp:group: schemas", async () => {
+                const client = await Mock.makeClient();
+                client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+                await client.NLWS.xtkSession.logon();
+               
+                client._transport.mockReturnValueOnce(Mock.GET_XTK_QUERY_SCHEMA_RESPONSE);
+                client._transport.mockReturnValueOnce(Promise.resolve(`<?xml version='1.0'?>
+                      <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:queryDef' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+                        <SOAP-ENV:Body>
+                            <ExecuteQueryResponse xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+                                <pdomOutput xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
+                                <group expirationDate="" folder-id="1199" id="2200" label="testlist" name="LST260" schema="nms:recipient" type="1">
+                                  <extension label="email is not empty" mappingType="sql" name="query" namespace="temp">
+                                    <element advanced="false" dataSource="nms:extAccount:ffda" label="email is not empty" name="query" pkSequence="" sqltable="grp2200" unbound="false">
+                                      <compute-string expr=""/>
+                                      <key internal="true" name="internal">
+                                        <keyfield xpath="@id"/>
+                                      </key>
+                                      <attribute advanced="false" belongsTo="@id" label="Primary key" length="0" name="id" notNull="false" sql="true" sqlname="uId" type="uuid" xml="false"/>
+                                      <element advanced="false" externalJoin="true" label="Targeting dimension" name="target" revLink="" target="nms:recipient" type="link" unbound="false">
+                                        <join xpath-dst="@id" xpath-src="@id"/>
+                                      </element>
+                                    </element>
+                                  </extension>
+                                </group>
+                                </pdomOutput>
+                            </ExecuteQueryResponse>
+                        </SOAP-ENV:Body>
+                      </SOAP-ENV:Envelope>`));
+                const group = await client.application.getSchema('temp:group:2200');
+                expect(group.label).toBe("email is not empty");
+
+                // return updated schema with label changed
+                client._transport.mockReturnValueOnce(Promise.resolve(`<?xml version='1.0'?>
+                      <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:xtk:queryDef' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+                        <SOAP-ENV:Body>
+                            <ExecuteQueryResponse xmlns='urn:xtk:queryDef' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+                                <pdomOutput xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
+                                <group expirationDate="" folder-id="1199" id="2200" label="testlist" name="LST260" schema="nms:recipient" type="1">
+                                  <extension label="email is empty" mappingType="sql" name="query" namespace="temp">
+                                    <element advanced="false" dataSource="nms:extAccount:ffda" label="email is empty" name="query" pkSequence="" sqltable="grp2200" unbound="false">
+                                      <compute-string expr=""/>
+                                      <key internal="true" name="internal">
+                                        <keyfield xpath="@id"/>
+                                      </key>
+                                      <attribute advanced="false" belongsTo="@id" label="Primary key" length="0" name="id" notNull="false" sql="true" sqlname="uId" type="uuid" xml="false"/>
+                                      <element advanced="false" externalJoin="true" label="Targeting dimension" name="target" revLink="" target="nms:recipient" type="link" unbound="false">
+                                        <join xpath-dst="@id" xpath-src="@id"/>
+                                      </element>
+                                    </element>
+                                  </extension>
+                                </group>
+                                </pdomOutput>
+                            </ExecuteQueryResponse>
+                        </SOAP-ENV:Body>
+                      </SOAP-ENV:Envelope>`));
+                const group2 = await client.application.getSchema('temp:group:2200');
+                expect(group2.label).toBe("email is empty");
+            });
         });
 
         describe("Ref nodes", () => {