@adobe/acc-js-sdk 1.1.34 → 1.1.36

package/docs/changeLog.html

@@ -3,6 +3,20 @@ layout: page
 title: Change Log
 ---
 
+<section class="changelog"><h1>Version 1.1.36</h1>
+  <h2>2023/07/28</h2>
+  <li>
+    Fixed the `uploadAemAsset` method when used from a browser, using fetch for HTTP requests.
+  </li>
+</section>
+
+<section class="changelog"><h1>Version 1.1.35</h1>
+  <h2>2023/07/25</h2>
+  <li>
+    Added `sessionInfo` parameter to `ofImsBearerToken` function. When this parameter is used, the logon call will make sure user and server informations are returned. See <a href="https://opensource.adobe.com/acc-js-sdk/connecting.html"></a> for more information.
+  </li>
+</section>
+
 <section class="changelog"><h1>Version 1.1.34</h1>
   <h2>2023/07/25</h2>
   <li>

package/docs/connecting.html

@@ -140,6 +140,23 @@ const connectionParameters = sdk.ConnectionParameters.ofBearerToken(
                                 "ims_bearer_token");
 </pre>
 
+<p>
+    One caveat with ofImsBearerToken mechanism is that logon will not actually call any SOAP logon APIs. The bearer token is just stored in memory and will be passed along with subsequent calls.
+</p>
+<p>
+    This can be a concern because "xtk:session#Logon" and "xtk:session#BearerTokenLogon" return a session info object containing information about the server and the logged user. 
+    This includes the server version and build number, the list of active packages, etc. This information is not available when using ofImsBearerToken.
+</p>
+<p>
+    In Version 1.1.35 of the SDK, it is possible to get this information consistently with other Logon method by passing the "sessionInfo" option to the ofImsBearerToken call.
+</p>
+<pre class="code">
+    const connectionParameters = sdk.ConnectionParameters.ofImsBearerToken(
+                                    "https://myInstance.campaign.adobe.com", 
+                                    "ims_bearer_token", 
+                                    { sessionInfo: true });
+</pre>
+
 
 <h2>Login with Session token</h2>
 <p>

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.34",
+  "version": "1.1.36",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@adobe/acc-js-sdk",
-      "version": "1.1.34",
+      "version": "1.1.36",
       "license": "ISC",
       "dependencies": {
         "axios": "^1.2.1",
@@ -3041,9 +3041,10 @@
       }
     },
     "node_modules/jest-snapshot/node_modules/semver": {
-      "version": "7.3.8",
+      "version": "7.5.4",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz",
+      "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==",
       "dev": true,
-      "license": "ISC",
       "dependencies": {
         "lru-cache": "^6.0.0"
       },
@@ -3357,26 +3358,6 @@
         "node": ">=v12.22.7"
       }
     },
-    "node_modules/jsdom/node_modules/tough-cookie": {
-      "version": "4.1.2",
-      "license": "BSD-3-Clause",
-      "dependencies": {
-        "psl": "^1.1.33",
-        "punycode": "^2.1.1",
-        "universalify": "^0.2.0",
-        "url-parse": "^1.5.3"
-      },
-      "engines": {
-        "node": ">=6"
-      }
-    },
-    "node_modules/jsdom/node_modules/universalify": {
-      "version": "0.2.0",
-      "license": "MIT",
-      "engines": {
-        "node": ">= 4.0.0"
-      }
-    },
     "node_modules/jsesc": {
       "version": "2.5.2",
       "dev": true,
@@ -4053,9 +4034,10 @@
       "license": "MIT"
     },
     "node_modules/semver": {
-      "version": "6.3.0",
+      "version": "6.3.1",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz",
+      "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==",
       "dev": true,
-      "license": "ISC",
       "bin": {
         "semver": "bin/semver.js"
       }
@@ -4274,6 +4256,20 @@
         "node": ">=8.0"
       }
     },
+    "node_modules/tough-cookie": {
+      "version": "4.1.3",
+      "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.1.3.tgz",
+      "integrity": "sha512-aX/y5pVRkfRnfmuX+OdbSdXvPe6ieKX/G2s7e98f4poJHnqH3281gDPm/metm6E/WRamfx7WC4HUqkWHfQHprw==",
+      "dependencies": {
+        "psl": "^1.1.33",
+        "punycode": "^2.1.1",
+        "universalify": "^0.2.0",
+        "url-parse": "^1.5.3"
+      },
+      "engines": {
+        "node": ">=6"
+      }
+    },
     "node_modules/tr46": {
       "version": "3.0.0",
       "license": "MIT",
@@ -4324,6 +4320,14 @@
       "dev": true,
       "license": "MIT"
     },
+    "node_modules/universalify": {
+      "version": "0.2.0",
+      "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.2.0.tgz",
+      "integrity": "sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg==",
+      "engines": {
+        "node": ">= 4.0.0"
+      }
+    },
     "node_modules/update-browserslist-db": {
       "version": "1.0.10",
       "dev": true,
@@ -4464,8 +4468,9 @@
       }
     },
     "node_modules/word-wrap": {
-      "version": "1.2.3",
-      "license": "MIT",
+      "version": "1.2.5",
+      "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz",
+      "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==",
       "engines": {
         "node": ">=0.10.0"
       }
@@ -6618,7 +6623,9 @@
       },
       "dependencies": {
         "semver": {
-          "version": "7.3.8",
+          "version": "7.5.4",
+          "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz",
+          "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==",
           "dev": true,
           "requires": {
             "lru-cache": "^6.0.0"
@@ -6808,18 +6815,6 @@
           "requires": {
             "xmlchars": "^2.2.0"
           }
-        },
-        "tough-cookie": {
-          "version": "4.1.2",
-          "requires": {
-            "psl": "^1.1.33",
-            "punycode": "^2.1.1",
-            "universalify": "^0.2.0",
-            "url-parse": "^1.5.3"
-          }
-        },
-        "universalify": {
-          "version": "0.2.0"
         }
       }
     },
@@ -7242,7 +7237,9 @@
       "version": "2.1.2"
     },
     "semver": {
-      "version": "6.3.0",
+      "version": "6.3.1",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz",
+      "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==",
       "dev": true
     },
     "shebang-command": {
@@ -7379,6 +7376,17 @@
         "is-number": "^7.0.0"
       }
     },
+    "tough-cookie": {
+      "version": "4.1.3",
+      "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.1.3.tgz",
+      "integrity": "sha512-aX/y5pVRkfRnfmuX+OdbSdXvPe6ieKX/G2s7e98f4poJHnqH3281gDPm/metm6E/WRamfx7WC4HUqkWHfQHprw==",
+      "requires": {
+        "psl": "^1.1.33",
+        "punycode": "^2.1.1",
+        "universalify": "^0.2.0",
+        "url-parse": "^1.5.3"
+      }
+    },
     "tr46": {
       "version": "3.0.0",
       "requires": {
@@ -7408,6 +7416,11 @@
       "version": "1.13.6",
       "dev": true
     },
+    "universalify": {
+      "version": "0.2.0",
+      "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.2.0.tgz",
+      "integrity": "sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg=="
+    },
     "update-browserslist-db": {
       "version": "1.0.10",
       "dev": true,
@@ -7493,7 +7506,9 @@
       }
     },
     "word-wrap": {
-      "version": "1.2.3"
+      "version": "1.2.5",
+      "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz",
+      "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA=="
     },
     "wrap-ansi": {
       "version": "7.0.0",

package/package.json

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

package/src/application.js

@@ -1365,9 +1365,11 @@ class Application {
              * The server version, formatted as major.minor.servicePack (ex: 8.2.10)
              * @type {string}
              */
-            this.version = EntityAccessor.getAttributeAsString(serverInfo, "majNumber") + "." +
-                           EntityAccessor.getAttributeAsString(serverInfo, "minNumber") + "." +
-                           EntityAccessor.getAttributeAsString(serverInfo, "servicePack");
+            const majNumber = EntityAccessor.getAttributeAsString(serverInfo, "majNumber");
+            const minNumber = EntityAccessor.getAttributeAsString(serverInfo, "minNumber");
+            const servicePack = EntityAccessor.getAttributeAsString(serverInfo, "servicePack");
+            if (majNumber && minNumber && servicePack)
+                this.version = majNumber + "." + minNumber + "." + servicePack;
             /**
              * The Campaign instance name
              * @type {string}

package/src/client.js

@@ -657,13 +657,22 @@ const fileUploader = (client) => {
                 if(headers['Authorization'] === undefined || headers['Authorization'] === '' || headers['Authorization'] === 'null') {
                     throw 'Bearer token is missing';
                 }
+                // Serialize json data (required for fetch)
+                const jsonData = JSON.stringify({
+                    'assetDownloadUrl': assetDownloadUrl
+                });
 
-                const response = await client._makeHttpCall({
+                var response = await client._makeHttpCall({
                     url: url,
                     method: 'POST',
-                    data: {assetDownloadUrl: assetDownloadUrl},
+                    data: jsonData,
                     headers: headers
                 });
+
+                // response is returned as string when using fetch(in browser)
+                // & returned as json using axios(nodejs).
+                if(typeof response === 'string')
+                  response = JSON.parse(response);
                 if(response.publishedURL)
                   return response;
                 else
@@ -1412,6 +1421,52 @@ class Client {
         delete this._observabilityContext.session;
     }
 
+    _updateSessionInfo(sessionInfo, soapCall) {
+        this._sessionInfo = sessionInfo;
+        this._installedPackages = {};
+        const userInfo = DomUtil.findElement(sessionInfo, "userInfo");
+        if (!userInfo)
+            throw CampaignException.UNEXPECTED_SOAP_RESPONSE(soapCall, `userInfo structure missing`);
+        let pack = DomUtil.getFirstChildElement(userInfo, "installed-package");
+        while (pack) {
+            const name = `${DomUtil.getAttributeAsString(pack, "namespace")}:${DomUtil.getAttributeAsString(pack, "name")}`;
+            this._installedPackages[name] = name;
+            pack = DomUtil.getNextSiblingElement(pack);
+        }
+    }
+
+    async _fetchSessionInfo() {
+        const userInfoPromise = this.NLWS.xml.xtkSession.getUserInfo();
+        const testPromise = this.test();
+        const all = Promise.all([userInfoPromise, testPromise]);
+        const values = await all;
+
+        const sessionInfo = DomUtil.newDocument("sessionInfo");
+        const sessionInfoRoot = sessionInfo.documentElement;
+        const userInfo = sessionInfo.importNode(values[0], true);
+        sessionInfoRoot.appendChild(userInfo);
+        const serverInfo = sessionInfo.createElement('serverInfo');
+        sessionInfoRoot.appendChild(serverInfo);
+        const test = values[1];
+        if (test["date"])
+            serverInfo.setAttribute("serverDate", new Date(Date.parse(test["date"])).toISOString());
+        serverInfo.setAttribute("instanceName", test["instance"]);
+        if (test["version"]) {
+            const versionParts = test["version"].split(".");
+            serverInfo.setAttribute("majNumber", versionParts[0]);
+            serverInfo.setAttribute("minNumber", versionParts[1]);
+            serverInfo.setAttribute("servicePack", versionParts[2]);
+        }
+        let buildNumber = test["build"];
+        // Alternative method to get the build number (not available unless server has been upgraded at least once)
+        if (!buildNumber)
+            buildNumber = await this.getOption("NmsServer_LastPostUpgrade", false);
+        if (!buildNumber)
+            throw CampaignException.UNEXPECTED_SOAP_RESPONSE(undefined, `buildNumber structure missing for both /r/test and NmsServer_LastPostUpgrade option`);
+        serverInfo.setAttribute("buildNumber", buildNumber);
+        return sessionInfoRoot;
+    }
+
     /**
      * Login to an instance
      */
@@ -1466,8 +1521,18 @@ class Client {
             that._sessionToken = "";
             that._securityToken = "";
             that._bearerToken = credentials._bearerToken;
-            that._onLogon();
-            return Promise.resolve();
+
+            // With IMS Bearer token, we do not call the Logon or BearerTokenLogon method any more. As a consequence,
+            // we do not have the user and server information returned by those methods, so we need to get the corresponding
+            // information by other means
+            if (!this._connectionParameters._options.sessionInfo) {
+                that._onLogon();
+                return Promise.resolve();
+            }
+            return that._fetchSessionInfo().then((sessionInfo) => {
+                that._updateSessionInfo(sessionInfo, undefined);
+                that._onLogon();
+            });
         }
         else if (credentials._type == "UserPassword" || credentials._type == "BearerToken") {
             const soapCall = that._prepareSoapCall("xtk:session", credentials._type === "UserPassword" ? "Logon" : "BearerTokenLogon", true, false, this._connectionParameters._options.extraHttpHeaders);
@@ -1493,19 +1558,8 @@ class Client {
             }
             return this._makeSoapCall(soapCall).then(function() {
                 const sessionToken = soapCall.getNextString();
-
-                that._sessionInfo = soapCall.getNextDocument();
-                that._installedPackages = {};
-                const userInfo = DomUtil.findElement(that._sessionInfo, "userInfo");
-                if (!userInfo)
-                    throw CampaignException.UNEXPECTED_SOAP_RESPONSE(soapCall, `userInfo structure missing`);
-                var pack = DomUtil.getFirstChildElement(userInfo, "installed-package");
-                while (pack) {
-                    const name = `${DomUtil.getAttributeAsString(pack, "namespace")}:${DomUtil.getAttributeAsString(pack, "name")}`;
-                    that._installedPackages[name] = name;
-                    pack = DomUtil.getNextSiblingElement(pack);
-                }
-
+                const sessionInfo = soapCall.getNextDocument();
+                that._updateSessionInfo(sessionInfo, soapCall);
                 const securityToken = soapCall.getNextString();
                 soapCall.checkNoMoreArgs();
                 // Sanity check: we should have both a session token and a security token.

package/test/imBearerToken.test.js

@@ -171,4 +171,65 @@ describe('IMS Bearer Toekn', function () {
         // when using one of the Logon methods (Logno or BearertokenLogon)
         expect(application.packages).toBeUndefined();
     });
+
+    it('Should logon with IMS Bearer Token and return session info. No version string or date', async () => {
+        const client = await makeImsClient({ sessionInfo: true });
+        // As session info is asked, GetUserInfo and /r/test will be called
+        client._transport.mockReturnValueOnce(Promise.resolve(`<redir status='OK' build='9236' sha1='cc45440' instance='xxx_mkt_prod1' sourceIP='193.104.215.11' host='xxxol.campaign.adobe.com' localHost='xxxol-mkt-prod1-1'/>`));
+        client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+        client._transport.mockReturnValueOnce(Mock.GET_USER_INFO_RESPONSE);
+        await client.NLWS.xtkSession.logon();
+        expect(client.isLogged()).toBe(true);
+        expect(client.application.buildNumber).toBe("9236");
+        expect(client.application.version).toBe(undefined);
+        expect(client.application.instanceName).toBe("xxx_mkt_prod1");
+        expect(client.application.operator.login).toBe("admin");
+    });
+
+    it('Should logon with IMS Bearer Token and return session info', async () => {
+        const client = await makeImsClient({ sessionInfo: true });
+        // As session info is asked, GetUserInfo and /r/test will be called
+        client._transport.mockReturnValueOnce(Promise.resolve(`<redir status='OK' date='2021-08-27 08:02:07.963-07' version='8.5.1' build='9236' sha1='cc45440' instance='xxx_mkt_prod1' sourceIP='193.104.215.11' host='xxxol.campaign.adobe.com' localHost='xxxol-mkt-prod1-1'/>`));
+        client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+        client._transport.mockReturnValueOnce(Mock.GET_USER_INFO_RESPONSE);
+        await client.NLWS.xtkSession.logon();
+        expect(client.isLogged()).toBe(true);
+        expect(client.application.buildNumber).toBe("9236");
+        expect(client.application.version).toBe("8.5.1");
+    });
+
+    it('Should logon with IMS Bearer Token and return session info. Build number is missing from /r/test', async () => {
+        const client = await makeImsClient({ sessionInfo: true });
+        // As session info is asked, GetUserInfo and /r/test will be called
+        client._transport.mockReturnValueOnce(Promise.resolve(`<redir status='OK' date='2021-08-27 08:02:07.963-07'/>`));
+        client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+        client._transport.mockReturnValueOnce(Mock.GET_USER_INFO_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:session' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+        <SOAP-ENV:Body>
+            <GetOptionResponse xmlns='urn:xtk:session' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+                <pstrValue xsi:type='xsd:string'>9999</pstrValue>
+                <pbtType xsi:type='xsd:byte'>6</pbtType>
+            </GetOptionResponse>
+        </SOAP-ENV:Body>
+        </SOAP-ENV:Envelope>`));
+        // As build number is missing getOption will be called
+        await client.NLWS.xtkSession.logon();
+        expect(client.isLogged()).toBe(true);
+        expect(client.application.buildNumber).toBe("9999");
+    });
+
+    it('Should fail to logon with IMS Bearer Token because build number is missing', async () => {
+        const client = await makeImsClient({ sessionInfo: true });
+        // As session info is asked, GetUserInfo and /r/test will be called
+        client._transport.mockReturnValueOnce(Promise.resolve(`<redir status='OK' date='2021-08-27 08:02:07.963-07'/>`));
+        client._transport.mockReturnValueOnce(Mock.GET_XTK_SESSION_SCHEMA_RESPONSE);
+        client._transport.mockReturnValueOnce(Mock.GET_USER_INFO_RESPONSE);
+        client._transport.mockReturnValueOnce(Mock.GET_OPTION_NOTFOUND_RESPONSE);
+        // As build number is missing getOption will be called
+        await expect(async() => {
+            await client.NLWS.xtkSession.logon();
+        }).rejects.toMatchObject({ errorCode: "SDK-000007" });
+    });
+
 });