@adobe/acc-js-sdk 1.1.46 → 1.1.48

package/docs/_data/navigation.yml

@@ -66,6 +66,8 @@
       link: reportData.html
     - name: AEM asset upload API
       link: uploadAemAsset.html
+    - name: Downloading files
+      link: download.html
 - name: --
 - name: Advanced Topics
   children:

package/docs/changeLog.html

@@ -2,6 +2,29 @@
 layout: page
 title: Change Log
 ---
+<section class="changelog"><h1>Version 1.1.48</h1>
+  <h2>2024/06/11</h2>
+  <li>
+    <a href="https://github.com/adobe/acc-js-sdk/issues/106">Issue 106</a>. Add support for file download.
+  </li>
+  <li>
+    <a href="https://github.com/adobe/acc-js-sdk/issues/10"7>Issue 107</a>. Ability to create a job interface from a job id and get the job status from here.
+  </li>
+  <li>
+    Updated dependencies to fix <a href="https://github.com/advisories/GHSA-grv7-fg5c-xmjg">vulnerabilities</a>.
+  </li>
+</section>
+
+
+<section class="changelog"><h1>Version 1.1.47</h1>
+  <h2>2024/04/23</h2>
+  <li>
+    <a href="https://github.com/adobe/acc-js-sdk/issues/105">Issue 105</a>. Fix XML name of parameters in workflow functions. The name is expected to be 'variables' and not 'parameters'.
+    Methods StartWithParameters, PostEvent, SimulateWithParameters, SpawnWithParameters, and SpawnWithParametersEx are included.
+  </li>
+</section>
+
+
 <section class="changelog"><h1>Version 1.1.46</h1>
   <h2>2024/03/19</h2>
   <li>

package/docs/download.html

@@ -0,0 +1,25 @@
+---
+layout: page
+title: Downloading files
+---
+
+<p>
+    Files can be downloaded using the <b>client.fileUploader.download</b> method. In order to download a file from the Campaign server, you need the file md5 and extension which act as the file key. For example, the md5 of a file attachment in a delivry is available in the attachment/@md5 attribute.
+</p>
+
+<p>
+    In the following example, a CSV file is downloaded
+</p>
+
+<pre class="code">
+    const responseFile = await client.fileUploader.download("d83d8b9a7504043644e1f2dd0a28bf7f", "csv", {
+        fileName: 'My Sample File.csv',
+        contentType: "txt/csv",
+    });
+</pre>
+
+<p>
+    The function returns a <a href="https://w3c.github.io/FileAPI/#file-section">File Blob</a>
+<p>
+
+<p class="warning">This function only works when using the SDK in the browser.</p>

package/docs/xtkJob.html

@@ -106,6 +106,15 @@ title: XTK Jobs (xkt:job, xkt:jobInterface)
   </tbody>
 </table>
 
+<p>
+  You can get the status of a job, given a job id as follow
+</p>
+
+<pre class="code">
+  const jobId = 'ABC';
+  const job = new XtkJobInterface(client, { jobId });
+  const status = await job.getStatus(12, 500);
+</pre>
 
 <h1>Job Progress</h1>
 <p>

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.46",
+  "version": "1.1.48",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@adobe/acc-js-sdk",
-      "version": "1.1.46",
+      "version": "1.1.48",
       "license": "ISC",
       "dependencies": {
         "axios": "^1.2.1",
@@ -1437,11 +1437,12 @@
       }
     },
     "node_modules/braces": {
-      "version": "3.0.2",
+      "version": "3.0.3",
+      "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
+      "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
       "dev": true,
-      "license": "MIT",
       "dependencies": {
-        "fill-range": "^7.0.1"
+        "fill-range": "^7.1.1"
       },
       "engines": {
         "node": ">=8"
@@ -2179,9 +2180,10 @@
       }
     },
     "node_modules/fill-range": {
-      "version": "7.0.1",
+      "version": "7.1.1",
+      "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
+      "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
       "dev": true,
-      "license": "MIT",
       "dependencies": {
         "to-regex-range": "^5.0.1"
       },
@@ -2557,8 +2559,9 @@
     },
     "node_modules/is-number": {
       "version": "7.0.0",
+      "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+      "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
       "dev": true,
-      "license": "MIT",
       "engines": {
         "node": ">=0.12.0"
       }
@@ -4321,8 +4324,9 @@
     },
     "node_modules/to-regex-range": {
       "version": "5.0.1",
+      "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+      "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
       "dev": true,
-      "license": "MIT",
       "dependencies": {
         "is-number": "^7.0.0"
       },
@@ -5687,10 +5691,12 @@
       }
     },
     "braces": {
-      "version": "3.0.2",
+      "version": "3.0.3",
+      "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
+      "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
       "dev": true,
       "requires": {
-        "fill-range": "^7.0.1"
+        "fill-range": "^7.1.1"
       }
     },
     "browserslist": {
@@ -6159,7 +6165,9 @@
       }
     },
     "fill-range": {
-      "version": "7.0.1",
+      "version": "7.1.1",
+      "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
+      "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
       "dev": true,
       "requires": {
         "to-regex-range": "^5.0.1"
@@ -6385,6 +6393,8 @@
     },
     "is-number": {
       "version": "7.0.0",
+      "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+      "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
       "dev": true
     },
     "is-potential-custom-element-name": {
@@ -7543,6 +7553,8 @@
     },
     "to-regex-range": {
       "version": "5.0.1",
+      "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+      "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
       "dev": true,
       "requires": {
         "is-number": "^7.0.0"

package/package.json

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

package/samples/030 - basics - workflows.js

@@ -0,0 +1,40 @@
+/*
+Copyright 2020 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+const utils = require("./utils.js");
+
+/* Basic samples illustrating how to manage workflows
+ */
+
+( async () => {
+
+  await utils.sample({
+    title: "Activate a workflow via a signal",
+    labels: [ "xtk:workflow", "Basics", "Workflow", "Signal" ],
+    description: `The PostEvent method activats a signal activity of a workflow`,
+    code: async() => {
+      return await utils.logon(async (client, NLWS) => {
+        console.log("This sample will post an event to a signal activity of a workflow.");
+    
+        const workflowIdOrName = "WKF20";
+        const activityName = "signal";
+        const transitionName = "";
+        const variables = { hello: "world" };
+        const complete = false;
+        await NLWS.xtkWorkflow.postEvent(workflowIdOrName, activityName, transitionName, variables, complete);
+
+      });
+    }
+  });
+
+  
+})();
+

package/src/campaign.js

@@ -43,7 +43,7 @@ const { Util } = require("./util.js");
   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); }
-
+  static FILE_DOWNLOAD_FAILED(name, details)              { return new CampaignException(undefined, 500, 16384, `SDK-000018 "Failed to download file ${name}`, details); }
 
   /**
    * Returns a short description of the exception
@@ -67,7 +67,6 @@ const { Util } = require("./util.js");
    * @param {Error|string} cause an optional error object representing the cause of the exception
    */
   constructor(call, statusCode, faultCode, faultString, detail, cause) {
-
       // Provides a shorter and more friendly description of the call and method name
       // depending on whether the exception is thrown by a SOAP or HTTP call
       var methodCall;

package/src/client.js

@@ -702,7 +702,61 @@ const fileUploader = (client) => {
                 else
                   throw CampaignException.AEM_ASSET_UPLOAD_FAILED(ex, ex.statusCode);
             }
+        },
+
+        /**
+         * Exposed public method of the fileUploader api,
+         * specifically designed to download files from the 'upload' folder of the Campaign instance
+         * @param {string} md5 md5 of the file content
+         * @param {string} ext (original) file extension
+         * @param {Object | undefined} options
+         * @param {string} options.fileName to rename the name in save as dialog of web browser 
+         * (force this dialog) must be in UTF-8
+         * @param {string} options.contentType change the content-type of the response (to help browser to
+         * handle this file) expl : image/png, text/plain;charset=ISO-8859-1
+         * @returns {Promise<File(string)>}
+         */
+        download: async (md5, ext, options) => {
+          if (!md5 || typeof md5 !== 'string') {
+            throw CampaignException.BAD_PARAMETER(
+                "md5",
+                md5,
+                "'md5' is mandatory parameter with type as 'string' for download file."
+              );
+          }
+
+          if (!ext || typeof ext !== "string") {
+            throw CampaignException.BAD_PARAMETER(
+                "ext",
+                ext,
+                "'ext' is mandatory parameter with type as 'string' for download file."
+              );
+          }
+
+          try {
+            const fileName =
+              options && options.fileName ? options.fileName : md5;
+            const contentType =
+              options && options.contentType ? options.contentType : "";
+
+            let queryString = `md5=${encodeURIComponent(md5)}&ext=${encodeURIComponent(ext)}&fileName=${encodeURIComponent(fileName)}`;
+
+            if (contentType) {
+              queryString += `&contentType=${encodeURIComponent(contentType)}`;
+            }
+
+            const headers = client._getAuthHeaders(false);
+            const rawFileResponse = await client._makeHttpCall({
+              url: `${client._connectionParameters._endpoint}/nl/jsp/downloadFile.jsp?${queryString}`,
+              headers: headers,
+            });
+
+            return rawFileResponse;
+          } catch (ex) {
+            throw CampaignException.FILE_DOWNLOAD_FAILED(md5, ex);
+          }
         }
+
     };
 };
 
@@ -1197,7 +1251,9 @@ class Client {
                     // Hack for workflow API. The C++ code checks that the name of the XML element is <variables>. When
                     // using xml representation at the SDK level, it's ok since the SDK caller will set that. But this does
                     // not work when using "BadgerFish" representation where we do not know the root element name.
-                    if (entitySchemaId == "xtk:workflow" && methodName == "StartWithParameters" && paramName == "parameters")
+                    if (entitySchemaId == "xtk:workflow" && paramName == "parameters" && (
+                        methodName == "StartWithParameters" || methodName == "PostEvent" || methodName == "SimulateWithParameters" ||
+                        methodName == "SpawnWithParameters" || methodName == "SpawnWithParametersEx") )
                         docName = "variables";
                     if (entitySchemaId == "nms:rtEvent" && methodName == "PushEvent")
                         docName = "rtEvent";

package/src/xtkJob.js

@@ -32,6 +32,7 @@ const { XtkCaster } = require("./xtkCaster.js");
  * @property {string} xtkschema - the method schema id. It can be ommited if the object has a xtkschema property
  * @property {any} object - the object ("this") to call the method with, possibly null for static methods. Should implement the xtk:job interface
  * @property {Array} args - the list of arguments to the SOAP call
+ * @property {(string|number)} [jobId] - the optional job id, which can be used for subsequent calls
  * @memberOf Campaign
  */
 
@@ -77,10 +78,11 @@ class XtkJobInterface {
      * @param {Campaign.XtkSoapCallSpec} soapCallSpec the definition of the SOAP call
      */
     constructor(client, soapCallSpec) {
+        this._reset();
         this._client = client;
         this._soapCall = soapCallSpec;
         this._maxLogCount = 100; // default fetch size
-        this._reset();
+        this.jobId = soapCallSpec ? soapCallSpec.jobId : undefined;
     }
 
     // Reset state before executing or submitting a job