@adobe/acc-js-sdk 1.1.32 → 1.1.34

package/docs/_data/navigation.yml

@@ -64,6 +64,8 @@
       link: messageCenter.html
     - name: Reports Data API
       link: reportData.html
+    - name: AEM asset upload API
+      link: uploadAemAsset.html
 - name: --
 - name: Advanced Topics
   children:

package/docs/changeLog.html

@@ -3,6 +3,20 @@ layout: page
 title: Change Log
 ---
 
+<section class="changelog"><h1>Version 1.1.34</h1>
+  <h2>2023/07/25</h2>
+  <li>
+    Added `uploadAemAsset` method which downloads an asset from AEM and uploads it to Campaign. See <a href="https://opensource.adobe.com/acc-js-sdk/uploadAemAsset.html"></a> for more information.
+  </li>
+</section>
+
+<section class="changelog"><h1>Version 1.1.33</h1>
+  <h2>2023/07/08</h2>
+  <li>
+    Because of a server-side bug, there could be shemas with multiple copies of an enumeration. Make sure the SDK will not fail loading such schemas (only the first copy of the enumeration will be considered)
+  </li>
+</section>
+
 <section class="changelog"><h1>Version 1.1.32</h1>
   <h2>2023/06/22</h2>
   <li>

package/docs/uploadAemAsset.html

@@ -0,0 +1,45 @@
+---
+layout: page
+title: AEM asset upload API
+---
+
+<p>Campaign API for downloading & uploading(publishing) AEM cloud asset on campaign publication server. Just like all APIs in the SDK, it's been wrapped into a function and will return a JSON object containing publishedUrl.</p>
+<p class="warning">Note: This API can be used only with assetInfo url of AEM asset. AssetInfo url returns signed download url when called with GET API.
+</p>
+<h1>/nms/aemAssetDownload.jssp</h1>
+<p>This API is authenticated only using ims user token and run directly on the Apache front server.</p>
+<pre class="code">
+const version = sdk.getSDKVersion();
+console.log(`${version.description} version ${version.version}`);
+
+<span class="comment">// Logon to a Campaign instance with ImsBearerToken</span>
+const connectionParameters = sdk.ConnectionParameters.ofImsBearerToken("http://acc-sdk:8080", "ey...", options);
+console.log(connectionParameters);
+
+const client = await sdk.init(connectionParameters);
+await client.logon();
+
+const url = "https://abcd.adobexyzcloud.domain.com/asset/xyz.png";
+const response = await client.fileUploader.uploadAemAsset(url);
+console.log(response);
+</pre>
+
+<p>will return in this format</p>
+<pre class="code">
+{
+    "publishedURL": "http://trk-my-instance.my.domain.com/res/trk-inst/12f6710969d74ad965a333d31cf8c06d.jpeg"
+}
+</pre>
+
+<p class="warning">Note: This API can only be authenticated using ImsBearerToken because the same Ims user token
+    is used to authenticate AEM asset GET call. 
+</p>
+<pre class="code">
+const connectionParameters = sdk.ConnectionParameters.ofImsBearerToken("http://acc-sdk:8080", "ey...", options);
+console.log(connectionParameters);
+</pre>
+
+<p class="info">The API returns error with error code whenever it fails.<br>
+    The sdk error is "SDK-000017 Failed to upload AEM asset". It will also include specific reason for failure
+    and error code.
+</p>

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.32",
+  "version": "1.1.34",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@adobe/acc-js-sdk",
-      "version": "1.1.32",
+      "version": "1.1.34",
       "license": "ISC",
       "dependencies": {
         "axios": "^1.2.1",

package/package.json

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

package/src/application.js

@@ -1224,7 +1224,9 @@ class XtkSchema extends XtkSchemaNode {
          this.enumerations = new ArrayMap();
          for (var child of EntityAccessor.getChildElements(xml, "enumeration")) {
              const e = new XtkEnumeration(this.id, child);
-             this.enumerations._push(e.shortName, e);
+             if (this.enumerations.get(e.shortName) === undefined) {
+                 this.enumerations._push(e.shortName, e);
+             }
          }
      }
 

package/src/campaign.js

@@ -42,6 +42,7 @@ const { Util } = require("./util.js");
   static REPORT_FETCH_FAILED(name, details)               { return new CampaignException(undefined, 500, 16384, `SDK-000014 Failed to fetch report ${name}`, details); }
   static FEATURE_NOT_SUPPORTED(name)                      { return new CampaignException(undefined, 500, 16384, `SDK-000015 ${name} feature is not supported by the ACC instance`); }
   static REQUEST_ABORTED( )                               { return new CampaignException(undefined, 500,   -53, `SDK-000016 Request was aborted by the client`); }
+  static AEM_ASSET_UPLOAD_FAILED(details, statusCode=500) { return new CampaignException(undefined, statusCode, 16384, `SDK-000017 Failed to upload AEM asset`, details); }
 
 
   /**
@@ -226,13 +227,14 @@ function makeCampaignException(call, err) {
 
   if (err.statusCode && ctor && ctor.name == "HttpError") {
     var faultString = err.statusText;
-    var details = err.data;
+    var details = typeof err.data == 'object' ? JSON.stringify(err.data) : err.data;
     if (!faultString) {
-      faultString = err.data;
+      faultString = typeof err.data == 'object' ? JSON.stringify(err.data) : err.data;
       details = undefined;
     }
+
     // Session expiration case must return a 401
-    if (err.data && err.data.indexOf(`XSV-350008`) != -1)
+    if (err.data && typeof err.data == 'string' && err.data.indexOf(`XSV-350008`) != -1)
         return CampaignException.SESSION_EXPIRED();
     return new CampaignException(call, err.statusCode, "", faultString, details, err);
   }

package/src/client.js

@@ -639,6 +639,41 @@ const fileUploader = (client) => {
                     reject(CampaignException.FILE_UPLOAD_FAILED(file.name, ex));
                 }
             });
+        },
+
+        /**
+         * Exposed method to call aemAssetDownload.jssp which will
+         * download the asset from AEM and upload it to Campaign.
+         */
+        uploadAemAsset: async (assetDownloadUrl) => {
+            const url = `${client._connectionParameters._endpoint}/nms/aemAssetDownload.jssp`;
+            const headers = client._getAuthHeaders(false);
+            headers['Content-Type'] = 'application/json';
+
+            try {
+                // We need to pass the Authorization header to AEM to download the asset from AEM
+                // as well as authenticating campaign server.
+                // A user token having access to campaign as well as AEM is required
+                if(headers['Authorization'] === undefined || headers['Authorization'] === '' || headers['Authorization'] === 'null') {
+                    throw 'Bearer token is missing';
+                }
+
+                const response = await client._makeHttpCall({
+                    url: url,
+                    method: 'POST',
+                    data: {assetDownloadUrl: assetDownloadUrl},
+                    headers: headers
+                });
+                if(response.publishedURL)
+                  return response;
+                else
+                  throw 'Publishing failed';
+            } catch (ex) {
+                if(ex instanceof CampaignException)
+                    throw CampaignException.AEM_ASSET_UPLOAD_FAILED(ex.faultString, ex.statusCode);
+                else
+                  throw CampaignException.AEM_ASSET_UPLOAD_FAILED(ex, ex.statusCode);
+            }
         }
     };
 };
@@ -2002,7 +2037,7 @@ class Client {
             if (this._traceAPICalls)
                 console.log("HTTP//failure", err);
             this._notifyObservers((observer) => observer.onHTTPCallFailure && observer.onHTTPCallFailure(request, err) );
-            const ex = makeCampaignException({ request:request, reqponse:err.response }, err);
+            const ex = makeCampaignException({ request:request, response:err.response }, err);
             this._trackEvent('HTTP//failure', event, { }, ex);
             throw ex;
         }

package/test/application.test.js

@@ -345,6 +345,19 @@ describe('Application', () => {
                 expect(enumerations[1].label).toBe("Status code");
             });
 
+            it("Should support duplicate  enumerations", () => {
+                var xml = DomUtil.parse(`<schema namespace='nms' name='recipient'>
+                                            <enumeration name="duplicated" basetype="byte"/>
+                                            <enumeration name="duplicated" basetype="byte"/>
+                                            <element name='recipient' label='Recipients'></element>
+                                        </schema>`);
+                var schema = newSchema(xml);
+                var enumerations = schema.enumerations;
+                expect(enumerations.duplicated.dummy).toBeFalsy();
+                expect(enumerations[0].label).toBe("Duplicated");
+                expect(enumerations[1]).toBeUndefined();
+            });
+
             it("Should test images", () => {
                 var xml = DomUtil.parse(`<schema namespace='nms' name='recipient'>
                                             <enumeration name="gender" basetype="byte">

package/test/client.test.js

@@ -26,6 +26,7 @@ const { Cipher } = require('../src/crypto.js');
 const { EntityAccessor } = require('../src/entityAccessor.js');
 const { JSDOM } = require('jsdom');
 const dom = new JSDOM();
+const { CampaignException } = require('../src/campaign.js');
 
 describe('ACC Client', function () {
 
@@ -1746,6 +1747,83 @@ describe('ACC Client', function () {
         });
     });
 
+    // write unit test for client.fileUploader.uploadAemAsset method
+    describe("Tests for client.fileUploader.uploadAemAsset method", () => {
+        // Case 1: uploadAemAsset method should return a valid response
+        it("Should return correct response", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            const mockResponse = {
+                "publishedURL" : "http://trk-inst-xyz.campaign.adobe.com/res/trk-inst/409afb8798180a36591456e152b6c406.jpeg"
+            };
+            client._bearerToken = 'Bearer 1234567890';
+            client._transport.mockReturnValueOnce(mockResponse);
+            const response = await client.fileUploader.uploadAemAsset("https://author-p74953-e183988-cmstg.adobeaemcloud.com/adobe/repository/content/dam/projects/children-kids-group-eating-ice-cream-funny-party-72701973%20%281%29%20%2812%29%20%282%29%20%283%29.jpg;api=block_download");
+            expect(response).toBe(mockResponse);
+
+            client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+            await client.NLWS.xtkSession.logoff();
+        });
+
+        // Case 2: Bearertoken is not provided, but the client is already authenticated with session token
+        it("Should throw error for missing authentication token", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            await (client.fileUploader.uploadAemAsset("https://author-p74953-e183988-cmstg.adobeaemcloud.com/adobe/repository/content/dam/projects/children-kids-group-eating-ice-cream-funny-party-72701973%20%281%29%20%2812%29%20%282%29%20%283%29.jpg;api=block_download"))
+                  .catch( e => { expect(e).toMatchObject(CampaignException.AEM_ASSET_UPLOAD_FAILED('Bearer token is missing'))});
+
+            client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+            await client.NLWS.xtkSession.logoff();
+        });
+
+        // Case 3: 200 response but publishedURL is not returned
+        // It shouldn't occur as API also checks non-emptiness of publishedURL before returning the response.
+        it("Should throw error for missing publishedURL", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            const mockResponse = {};
+            client._transport.mockReturnValueOnce(mockResponse);
+            client._bearerToken = 'Bearer 1234567890';
+
+            await (client.fileUploader.uploadAemAsset("https://author-p74953-e183988-cmstg.adobeaemcloud.com/adobe/repository/content/dam/projects/children-kids-group-eating-ice-cream-funny-party-72701973%20%281%29%20%2812%29%20%282%29%20%283%29.jpg;api=block_download"))
+                  .catch( e => { console.log(e); expect(e).toMatchObject(CampaignException.AEM_ASSET_UPLOAD_FAILED('Publishing failed'))});
+
+            client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+            await client.NLWS.xtkSession.logoff();
+        });
+
+        // Case 4: AEM Asset upload failed (reason maybe aem not reachable, assetlink not reachable, etc)
+        it("Should throw error when AEM Asset upload failed", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            //const mockResponse = {};
+            client._transport.mockImplementation(() => {
+                var ex = CampaignException.AEM_ASSET_UPLOAD_FAILED('The requested content does not exist', 400);
+                ex.faultString = 'The requested content does not exist';
+                ex.detail = 'Failed to upload AEM asset';
+                throw ex;
+              });
+              client._bearerToken = 'Bearer 1234567890';
+
+            var ex = CampaignException.AEM_ASSET_UPLOAD_FAILED('The requested content does not exist', 400);
+            await (client.fileUploader.uploadAemAsset("https://author-p74953-e183988-cmstg.adobeaemcloud.com/adobe/repository/content/dam/projects/children-kids-group-eating-ice-cream-funny-party-72701973%20%281%29%20%2812%29%20%282%29%20%283%29.jpg;api=block_download"))
+                    .catch( e => { console.log(e); expect(e).toMatchObject(ex)});
+
+            client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+            await client.NLWS.xtkSession.logoff();
+        });
+
+    });
+
+
     describe("Observers", () => {
 
         it("Should observe SOAP api Call (getOption)", async () => {