@adobe/acc-js-sdk 1.1.48 → 1.1.50

package/docs/changeLog.html

@@ -2,6 +2,24 @@
 layout: page
 title: Change Log
 ---
+<section class="changelog"><h1>Version 1.1.50</h1>
+  <h2>2024/07/18</h2>
+  <li>
+    <a href="https://github.com/adobe/acc-js-sdk/pull/110">Issue 110</a>. Update fileUploader iframe style so it remains hidden.
+  </li>
+</section>
+
+<section class="changelog"><h1>Version 1.1.49</h1>
+  <h2>2024/07/07</h2>
+  <li>
+    <a href="https://github.com/adobe/acc-js-sdk/pull/109">Issue 109</a>. Extra HTTP headers were not passed in all API calls.
+  </li>
+  <li>
+    Updated dependencies to fix vulnerabilities.
+  </li>
+</section>
+
+
 <section class="changelog"><h1>Version 1.1.48</h1>
   <h2>2024/06/11</h2>
   <li>

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.48",
+  "version": "1.1.50",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@adobe/acc-js-sdk",
-      "version": "1.1.48",
+      "version": "1.1.50",
       "license": "ISC",
       "dependencies": {
         "axios": "^1.2.1",
@@ -4587,14 +4587,15 @@
       }
     },
     "node_modules/ws": {
-      "version": "8.11.0",
-      "license": "MIT",
+      "version": "8.18.0",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.0.tgz",
+      "integrity": "sha512-8VbfWfHLbbwu3+N6OKsOMpBdT4kXPDDB9cJk2bJ6mh9ucxdlnNvH1e+roYkKmN9Nxw2yjz7VzeO9oOz2zJ04Pw==",
       "engines": {
         "node": ">=10.0.0"
       },
       "peerDependencies": {
         "bufferutil": "^4.0.1",
-        "utf-8-validate": "^5.0.2"
+        "utf-8-validate": ">=5.0.2"
       },
       "peerDependenciesMeta": {
         "bufferutil": {
@@ -7716,7 +7717,9 @@
       }
     },
     "ws": {
-      "version": "8.11.0",
+      "version": "8.18.0",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.0.tgz",
+      "integrity": "sha512-8VbfWfHLbbwu3+N6OKsOMpBdT4kXPDDB9cJk2bJ6mh9ucxdlnNvH1e+roYkKmN9Nxw2yjz7VzeO9oOz2zJ04Pw==",
       "requires": {}
     },
     "xml": {

package/package.json

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

package/src/client.js

@@ -595,6 +595,8 @@ const fileUploader = (client) => {
                     const data = new FormData();
                     data.append('file_noMd5', file);
                     const headers = client._getAuthHeaders(false);
+                    for (let h in client._connectionParameters._options.extraHttpHeaders)
+                        headers[h] = client._connectionParameters._options.extraHttpHeaders[h];
                     client._makeHttpCall({
                         url: `${client._connectionParameters._endpoint}/nl/jsp/uploadFile.jsp`,
                         processData: false,
@@ -607,6 +609,7 @@ const fileUploader = (client) => {
                         }
                         const iframe = document.createElement('iframe');
                         iframe.style.display = 'block';
+                        iframe.style.border = 'none';
                         iframe.style.height = 0;
                         iframe.style.width = 0;
                         if(options && options.className) {
@@ -680,7 +683,8 @@ const fileUploader = (client) => {
                 const jsonData = JSON.stringify({
                     'assetDownloadUrl': assetDownloadUrl
                 });
-
+                for (let h in client._connectionParameters._options.extraHttpHeaders)
+                    headers[h] = client._connectionParameters._options.extraHttpHeaders[h];
                 var response = await client._makeHttpCall({
                     url: url,
                     method: 'POST',
@@ -746,6 +750,8 @@ const fileUploader = (client) => {
             }
 
             const headers = client._getAuthHeaders(false);
+            for (let h in client._connectionParameters._options.extraHttpHeaders)
+                headers[h] = client._connectionParameters._options.extraHttpHeaders[h];
             const rawFileResponse = await client._makeHttpCall({
               url: `${client._connectionParameters._endpoint}/nl/jsp/downloadFile.jsp?${queryString}`,
               headers: headers,

package/src/xtkJob.js

@@ -112,7 +112,8 @@ class XtkJobInterface {
             client: this._client,
             object: this._soapCall.object,
             schemaId: 'xtk:jobInterface',
-            entitySchemaId: entitySchemaId
+            entitySchemaId: entitySchemaId,
+            headers: this._client._connectionParameters._options.extraHttpHeaders
         };
         var jobId = await callContext.client._callMethod("Execute", callContext, [ methodName ]);
         this.jobId = jobId;
@@ -135,7 +136,8 @@ class XtkJobInterface {
             client: this._client,
             object: this._soapCall.object,
             schemaId: 'xtk:jobInterface',
-            entitySchemaId: entitySchemaId
+            entitySchemaId: entitySchemaId,
+            headers: this._client._connectionParameters._options.extraHttpHeaders
         };
         var jobId = await callContext.client._callMethod("Submit", callContext, [ this._soapCall.method ]);
         this.jobId = jobId;
@@ -156,8 +158,8 @@ class XtkJobInterface {
             object: this._soapCall.object,
             schemaId: 'xtk:jobInterface',
             entitySchemaId: entitySchemaId,
+            headers: this._client._connectionParameters._options.extraHttpHeaders
         };
-
         const methodName = this._soapCall.method;
         var schema = await this._client.getSchema(entitySchemaId, "xml", true);
         if (!schema)

package/test/client.test.js

@@ -3717,7 +3717,60 @@ describe('ACC Client', function () {
                 url: "http://hello.com",
                 });
             });
+            it("Should add extraHttpHeaders in the headers", async () => {
+                // Create a mock client and logon
+                const extraHttpHeaders = {'x-api-key': 'check'};
+                const client = await Mock.makeClient({extraHttpHeaders});
+                client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+                await client.NLWS.xtkSession.logon();
+
+                // Mock the upload protocol
+                // - the upload.jsp (which returns the content of an iframe and JS to eval)
+                // - call to xtk:counter#IncreaseValue (first, retrieve the schema xtk:counter then call the function)
+                // - call to xtk:session#Write
+                // - call to xtk:fileRes#PublishIfNeeded
+                // - call to xtk:fileRes#GetURL
+                
+                client._transport.mockReturnValueOnce(
+                Promise.resolve(`Ok 
+                <html xmlns="http://www.w3.org/1999/xhtml">
+                    <head>
+                    <script type="text/javascript">if(window.parent&&window.parent.document.controller&&"function"==typeof window.parent.document.controller.uploadFileCallBack){var aFilesInfo=new Array;aFilesInfo.push({paramName:"file",fileName:"test.txt",newFileName:"d8e8fca2dc0f896fd7cb4cb0031ba249.txt",md5:"d8e8fca2dc0f896fd7cb4cb0031ba249"}),window.parent.document.controller.uploadFileCallBack(aFilesInfo)}</script>
+                    </head>
+                <body></body>
+                </html>`)
+                ); // upload.jsp
+
+                client._transport.mockReturnValueOnce(
+                Promise.resolve(Mock.GET_XTK_COUNTER_RESPONSE)
+                ); // GetEntityIfMoreRecentResponse - counter
+                client._transport.mockReturnValueOnce(Mock.INCREASE_VALUE_RESPONSE); // xtk:counter#IncreaseValue
+
+                client._transport.mockReturnValueOnce(
+                Mock.GET_XTK_SESSION_SCHEMA_RESPONSE
+                ); // GetEntityIfMoreRecentResponse - session
+                client._transport.mockReturnValueOnce(Mock.FILE_RES_WRITE_RESPONSE); // xtk:session#Write
+
+                client._transport.mockReturnValueOnce(
+                Promise.resolve(Mock.GET_FILERES_QUERY_SCHEMA_RESPONSE)
+                ); // GetEntityIfMoreRecentResponse - fileRes
+                client._transport.mockReturnValueOnce(
+                Promise.resolve(Mock.PUBLISH_IF_NEEDED_RESPONSE)
+                ); // xtk:fileRes#PublishIfNeeded
 
+                client._transport.mockReturnValueOnce(
+                Promise.resolve(Mock.GET_URL_RESPONSE)
+                ); // xtk:fileRes#GetURL
+
+                // Call upload
+                await client.fileUploader.upload({
+                type: "text/html",
+                size: 12345,
+                });
+                expect(client._transport.mock.calls[0][0]).toMatchObject(expect.objectContaining({
+                    headers: expect.objectContaining(extraHttpHeaders),
+                }));
+            });
             it("throws error with dependant failures", async () => {
                 // Create a mock client and logon
                 const client = await Mock.makeClient();
@@ -4107,6 +4160,26 @@ describe('ACC Client', function () {
               await client.NLWS.xtkSession.logoff();
             });
 
+            it("Should add extraHttpHeaders in the headers", async () => {
+                const extraHttpHeaders = {'x-api-key': 'check'};
+                const client = await Mock.makeClient({extraHttpHeaders});
+                client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+                await client.NLWS.xtkSession.logon();
+  
+                const mockResponse = {
+                  publishedURL:
+                    "http://trk-inst-xyz.camp.adobe.com/res/trk-inst/409afb8798180a36591456e152b6c406.jpeg",
+                };
+                client._bearerToken = "Bearer 1234567890";
+                client._transport.mockReturnValueOnce(mockResponse);
+                await client.fileUploader.uploadAemAsset(
+                  "https://author-stg.aem.adobe.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(client._transport.mock.calls[0][0]).toMatchObject(expect.objectContaining({
+                    headers: expect.objectContaining(extraHttpHeaders),
+                }));
+            });            
+
             // 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();
@@ -4244,6 +4317,26 @@ describe('ACC Client', function () {
             expect(response).toStrictEqual(mockResponse);
           });
 
+          it("Should add extraHttpHeaders in the headers", async () => {
+            const extraHttpHeaders = {'x-api-key': 'check'}
+            const client = await Mock.makeClient({extraHttpHeaders});
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            const mockResponse = Mock.FILE_DOWNLOAD_RESPONSE;
+            client._transport.mockReturnValueOnce(mockResponse);
+
+            await client.fileUploader.download(
+              fileMd5,
+              fileExt,
+              fileOptions,
+            );
+
+            expect(client._transport.mock.calls[0][0]).toMatchObject(expect.objectContaining({
+                headers: expect.objectContaining(extraHttpHeaders),
+            }));
+          });
+
           it("Should return correct response without fileOptions", async () => {
             const client = await Mock.makeClient();
             client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);

package/test/xtkJob.test.js

@@ -176,7 +176,7 @@ describe('XRK Jobs', function () {
 
     describe("Execute", () => {
         it("Execute with success", async () => {
-            const client = { _callMethod: jest.fn() };
+            const client = { _callMethod: jest.fn(), _connectionParameters: { _options: {}} };
             const job = new XtkJobInterface(client, { xtkschema: "nms:delivery", object: "Hello World", method: "Prepare" });
             client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
             const jobId = await job.execute();
@@ -191,8 +191,26 @@ describe('XRK Jobs', function () {
             expect(client._callMethod.mock.calls[0][2]).toEqual([ "Prepare" ]);
         });
 
+        it("Execute should pass extraHttpHeaders in headers", async () => {
+            const extraHttpHeaders = {'x-api-key': 'check'};
+            const client = { _callMethod: jest.fn(), _connectionParameters: { _options: { extraHttpHeaders }} };
+            const job = new XtkJobInterface(client, { xtkschema: "nms:delivery", object: "Hello World", method: "Prepare" });
+            client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
+            const jobId = await job.execute();
+            expect(jobId).toBe("9876");
+            expect(client._callMethod.mock.calls.length).toBe(1);
+            expect(client._callMethod.mock.calls[0][0]).toBe("Execute");
+            expect(client._callMethod.mock.calls[0][1]).toMatchObject({
+                entitySchemaId: "nms:delivery",
+                schemaId: "xtk:jobInterface",
+                object: "Hello World",
+                headers: extraHttpHeaders,
+            });
+            expect(client._callMethod.mock.calls[0][2]).toEqual([ "Prepare" ]);
+        });
+
         it("Infer schema from objects", async () => {
-            const client = { _callMethod: jest.fn() };
+            const client = { _callMethod: jest.fn(), _connectionParameters: { _options: {}} };
             const job = new XtkJobInterface(client, { object: { xtkschema: "nms:delivery", name: "Hello World" }, method: "Prepare" });
             client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
             const jobId = await job.execute();
@@ -238,7 +256,7 @@ describe('XRK Jobs', function () {
 
     describe("Submit", () => {
         it("Submit with success", async () => {
-            const client = { _callMethod: jest.fn() };
+            const client = { _callMethod: jest.fn(), _connectionParameters: { _options: {}} };
             const job = new XtkJobInterface(client, { xtkschema: "nms:delivery", object: "Hello World", method: "Prepare" });
             client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
             const jobId = await job.submit();
@@ -253,8 +271,26 @@ describe('XRK Jobs', function () {
             expect(client._callMethod.mock.calls[0][2]).toEqual([ "Prepare" ]);
         });
 
+        it("Submit should pass extraHttpHeaders in headers", async () => {
+            const extraHttpHeaders = {'x-api-key': 'check'};
+            const client = { _callMethod: jest.fn(), _connectionParameters: { _options: { extraHttpHeaders }} };
+            const job = new XtkJobInterface(client, { xtkschema: "nms:delivery", object: "Hello World", method: "Prepare" });
+            client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
+            const jobId = await job.submit();
+            expect(jobId).toBe("9876");
+            expect(client._callMethod.mock.calls.length).toBe(1);
+            expect(client._callMethod.mock.calls[0][0]).toBe("Submit");
+            expect(client._callMethod.mock.calls[0][1]).toMatchObject({
+                entitySchemaId: "nms:delivery",
+                schemaId: "xtk:jobInterface",
+                object: "Hello World",
+                headers: extraHttpHeaders,
+            });
+            expect(client._callMethod.mock.calls[0][2]).toEqual([ "Prepare" ]);
+        });
+
         it("Infer schema from objects", async () => {
-            const client = { _callMethod: jest.fn() };
+            const client = { _callMethod: jest.fn(), _connectionParameters: { _options: {}} };
             const job = new XtkJobInterface(client, { object: { xtkschema: "nms:delivery", name: "Hello World" }, method: "Prepare" });
             client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
             const jobId = await job.submit();
@@ -301,7 +337,7 @@ describe('XRK Jobs', function () {
 
     describe("SubmitSoapCall", () => {
         it("SubmitSoapCall with success", async () => {
-            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()} };
+            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()}, _connectionParameters: { _options: {}} };
             const job = new XtkJobInterface(client, { xtkschema: "nms:delivery", object: "Hello World", method: "Prepare" });
             client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
             client.getSchema.mockReturnValueOnce(Promise.resolve(true));
@@ -325,8 +361,27 @@ describe('XRK Jobs', function () {
             } ]);
         });
 
+        it("SubmitSoapCall should pass extraHttpHeaders in headers", async () => {
+            const extraHttpHeaders = {'x-api-key': 'check'};
+            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()}, _connectionParameters: { _options: { extraHttpHeaders }} };
+            const job = new XtkJobInterface(client, { xtkschema: "nms:delivery", object: "Hello World", method: "Prepare" });
+            client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
+            client.getSchema.mockReturnValueOnce(Promise.resolve(true));
+            client._methodCache.get.mockReturnValueOnce(DomUtil.parse("<method></method>").documentElement);
+            const jobId = await job.submitSoapCall();
+            expect(jobId).toBe("9876");
+            expect(client._callMethod.mock.calls.length).toBe(1);
+            expect(client._callMethod.mock.calls[0][0]).toBe("SubmitSoapCall");
+            expect(client._callMethod.mock.calls[0][1]).toMatchObject({
+                entitySchemaId: "nms:delivery",
+                schemaId: "xtk:jobInterface",
+                object: "Hello World",
+                headers: extraHttpHeaders,
+            });
+        });
+
         it("SubmitSoapCall a non-persistant and static job with success", async () => {
-            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()} };
+            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()}, _connectionParameters: { _options: {}} };
             const jobDescription = { 
                 doNotPersist: "true",
                 xtkschema: 'nms:webApp',
@@ -368,7 +423,7 @@ describe('XRK Jobs', function () {
         });
 
         it("Infer schema from objects", async () => {
-            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()} };
+            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()}, _connectionParameters: { _options: {}} };
             const job = new XtkJobInterface(client, { object: { xtkschema: "nms:delivery", name: "Hello World" }, method: "Prepare" });
             client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
             client.getSchema.mockReturnValueOnce(Promise.resolve(true));
@@ -383,7 +438,7 @@ describe('XRK Jobs', function () {
         });
 
         it("Should fail on missing schema", async () => {
-            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()} };
+            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()}, _connectionParameters: { _options: {}} };
             const job = new XtkJobInterface(client, { method: "Prepare" });
             client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
             client.getSchema.mockReturnValueOnce(Promise.resolve(false));
@@ -400,7 +455,7 @@ describe('XRK Jobs', function () {
         });
 
         it("Should fail on invalid schema", async () => {
-            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()} };
+            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()}, _connectionParameters: { _options: {}} };
             const job = new XtkJobInterface(client, { object: { xtkschema: "nms:notFound", name: "Hello World" }, method: "Prepare" });
             client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
             client.getSchema.mockReturnValueOnce(Promise.resolve(false));
@@ -417,7 +472,7 @@ describe('XRK Jobs', function () {
         });
 
         it("Should fail on method not found", async () => {
-            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()} };
+            const client = { _callMethod: jest.fn(), getSchema: jest.fn(), _methodCache: { get: jest.fn()}, _connectionParameters: { _options: {}} };
             const job = new XtkJobInterface(client, { object: { xtkschema: "nms:delivery", name: "Hello World" }, method: "NotFound" });
             client._callMethod.mockReturnValueOnce(Promise.resolve("9876"));
             client.getSchema.mockReturnValueOnce(Promise.resolve(true));