@adobe/acc-js-sdk 1.1.12 → 1.1.13

package/compile.js

@@ -41,6 +41,7 @@ var resources = [
     { name: "./crypto.js" },
     { name: "./application.js" },
     { name: "./testUtil.js" },
+    { file: "../node_modules/qs-stringify/index.js", name: "qs-stringify" },
     { name: "./client.js" },
     { name: "./index.js" },
 ];

package/docs/_data/navigation.yml

@@ -62,6 +62,8 @@
       link: midSourcing.html
     - name: Message Center
       link: messageCenter.html
+    - name: Reports Data API
+      link: reportData.html
 - name: --
 - name: Advanced Topics
   children:

package/docs/application.html

@@ -264,7 +264,7 @@ const root = await node.linkTarget();
     <tr><td><b>isNotNull</b></td><td>Returns a boolean which indicates whether or not the current node can take the null value into account.</td></tr>
     <tr><td><b>isRequired</b></td><td>Returns a boolean which indicates whether or not the value of the current node is mandatory.</td></tr>
     <tr><td><b>isRoot</b></td><td>Indicates if the node is the root node of a schema, i.e. the first child of the schema node, whose name matches the schema name</td></tr>
-    <tr><td><b>isSQL</b></td><td>Returns a boolean which indicates whether the current node is mapped in SQL.</td></tr>
+    <tr><td><b>isSQL</b></td><td>Returns a boolean which indicates whether the current node is mapped in SQL. There are some inconsistencies in ACC schemas, and sometimes attributes may be defined as both sql and xml (for example: nms:delivery/properties/seedProcessed). Such nodes with have both isSql=true and isMappedAsXml=true</td></tr>
     <tr><td><b>isTemporaryTable</b></td><td>Returns a boolean indicating whether the table is a temporary table. The table will not be created during database creation.</td></tr>
     <tr><td><b>unbound</b></td><td>Returns a boolean which indicates whether the current node has an unlimited number of children of the same type.</td></tr>
     <tr><td><b>joins</b></td><td>Element of type "link" has an array of XtkJoin. See <b>joinNodes</b> method.</td></tr>

package/docs/changeLog.html

@@ -2,6 +2,14 @@
 layout: page
 title: Change Log
 ---
+<section class="changelog"><h1>Version 1.1.13</h1>
+  <h2>2022/11/24</h2>
+  
+  <li>Fix a bug with file upload API: API call payload was not passed with the right property. The transport interface uses the "data" property and not the "body" property</li>
+  <li>Add "getReportData" API to fetch the data use to create a particular report</li>
+  <li>Add unit test to check that schema nodes mapped as both xml and sql are properly handled (as SQL)</li>
+</section>
+
 <section class="changelog"><h1>Version 1.1.12</h1>
   <h2>2022/11/16</h2>
   

package/docs/reportData.html

@@ -0,0 +1,92 @@
+---
+layout: page
+title: Reports Data API
+---
+
+<p>Campaign provides an API to fetch reports data. Just like all APIs in the SDK, it's been wrapped into a function and will return a XML or JSON object based on the requested representation</p>
+
+<p>Function Definition</p>
+<pre class="code">
+client.getReportData = (callContext: any, representation: string) : Promise<any>
+</pre>
+<p>callContext</p>
+<pre class="code">
+{
+  reportName: string(Report Name),
+  context: string("selection"|"global"),
+  schema: string(entity type to be used for selection),
+  selection: string(Comma separated list of entity IDs),
+  formData: any
+}
+</pre>
+
+<p>Usage</p>
+<pre class="code">
+const report = await client.getReportData({
+  reportName: "throughput",
+  context: "selection",
+  schema: "nms:delivery",
+  selection: "12133"
+});
+console.log(JSON.stringify(report));
+</pre>
+<p>Usage with multiple entities</p>
+<pre class="code">
+const report = await client.getReportData({
+  reportName: "throughput",
+  context: "selection",
+  schema: "nms:delivery",
+  selection: "12133,12134"
+});
+console.log(JSON.stringify(report));
+</pre>
+<p>Usage with form data</p>
+<pre class="code">
+const report = await client.getReportData({
+  reportName: "throughput",
+  context: "selection",
+  schema: "nms:delivery",
+  selection: "12133",
+  formData: {
+    vars_opens: 1,
+    userAction: "next",
+    ctx: {
+      _context: 'selection',
+      _reportContext: 'throughput',
+      _hasFilter: 'false',
+      _selectionCount: '1',
+      _selection: '12133',
+      vars: {
+        '$period': '21600',
+        '$trunc': '600',
+        '$valueScaleFactor': '6',
+        '$dateStepType': 'minute',
+        '$dateStepFactor': '10'
+      },
+      data: {
+        deliveryStat: { deliveryStat: [Array] },
+        bandwidth: { deliveryStat: [Object] }
+      }
+    }
+  }
+});
+console.log(JSON.stringify(report));
+</pre>
+
+<p>A given representation can be forced</p>
+<pre class="code">
+const xmlReport = await client.getReportData({
+  reportName: "throughput",
+  context: "selection",
+  schema: "nms:delivery",
+  selection: "12133"
+}, "xml");
+const jsonReport = await client.getReportData({
+  reportName: "throughput",
+  context: "selection",
+  schema: "nms:delivery",
+  selection: "12133"
+}, "SimpleJson");
+</pre>
+
+

package/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.12",
+  "version": "1.1.13",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -3362,6 +3362,11 @@
       "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz",
       "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A=="
     },
+    "qs-stringify": {
+      "version": "1.2.1",
+      "resolved": "https://registry.npmjs.org/qs-stringify/-/qs-stringify-1.2.1.tgz",
+      "integrity": "sha512-2N5xGLGZUxpgAYq1fD1LmBSCbxQVsXYt5JU0nU3FuPWO8PlCnKNFQwXkZgyB6mrTdg7IbexX4wxIR403dJw9pw=="
+    },
     "react-is": {
       "version": "17.0.2",
       "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.12",
+  "version": "1.1.13",
   "description": "ACC Javascript SDK",
   "main": "src/index.js",
   "homepage": "https://github.com/adobe/acc-js-sdk#readme",
@@ -11,7 +11,8 @@
   },
   "dependencies": {
     "axios": "^0.25.0",
-    "jsdom": "^19.0.0"
+    "jsdom": "^19.0.0",
+    "qs-stringify": "^1.2.1"
   },
   "devDependencies": {
     "docdash": "^1.2.0",

package/src/campaign.js

@@ -39,6 +39,8 @@ const { Util } = require("./util.js");
   static DECRYPT_ERROR(details)                           { return new CampaignException(undefined, 400, 16384, `SDK-000011 "Cannot decrypt password: password marker is missing`, details); }
   static SESSION_EXPIRED()                                { return new CampaignException(undefined, 401, 16384, `SDK-000012 "Session has expired or is invalid. Please reconnect.`); }
   static FILE_UPLOAD_FAILED(name, details)                { return new CampaignException(undefined, 500, 16384, `SDK-000013 "Failed to upload file ${name}`, details); }
+  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`); }
 
 
   /**

package/src/client.js

@@ -36,6 +36,7 @@ const request = require('./transport.js').request;
 const Application = require('./application.js').Application;
 const EntityAccessor = require('./entityAccessor.js').EntityAccessor;
 const { Util } = require('./util.js');
+const qsStringify = require('qs-stringify');
 
 /**
  * @namespace Campaign
@@ -54,6 +55,9 @@ const { Util } = require('./util.js');
  *
  * @typedef {Object} Observer
  * @memberOf Campaign
+ *
+ * @typedef {Object} ReportContext
+ * @memberOf Campaign
 */
 
 
@@ -548,7 +552,7 @@ const fileUploader = (client) => {
                         processData: false,
                         credentials: 'include',
                         method: 'POST',
-                        body: data,
+                        data: data,
                         headers: {
                             'x-security-token': client._securityToken,
                             'Cookie': '__sessiontoken=' + client._sessionToken,
@@ -1764,6 +1768,46 @@ class Client {
         return result;
     }
 
+    /**
+     * This is the exposed/public method to request context data for a specific report.
+     * @param {*} callContext: {reportName: string, schema: string, context: string, selection: string, formData: any}
+     * @param {string} representation the expected representation ('xml', 'BadgerFish', or 'SimpleJson'). If not set, will use the current representation
+     *
+     * @returns {Campaign.ReportContext} an object containing the context data for a specific report
+     */
+    async getReportData(callContext, representation) {
+        try {
+            if(callContext.formData && callContext.formData.ctx) {
+                var xmlCtx = this._fromRepresentation('ctx', callContext.formData.ctx);
+                callContext.formData.ctx = DomUtil.toXMLString(xmlCtx);
+            }
+            const selectionCount = callContext.selection.split(',').length;
+
+            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,
+                    'Cookie': '__sessiontoken=' + this._sessionToken, 
+                    'Content-Type': 'application/x-www-form-urlencoded'
+                },
+                method: 'POST',
+                credentials: 'include',
+                data : qsStringify(callContext.formData)
+            };
+            
+            for (let h in this._connectionParameters._options.extraHttpHeaders)
+                request.headers[h] = this._connectionParameters._options.extraHttpHeaders[h];
+            const body = await this._makeHttpCall(request);
+            if(!body.startsWith("<ctx"))
+                throw CampaignException.FEATURE_NOT_SUPPORTED("Reports Data");
+            const xml = DomUtil.parse(body);
+            const result = this._toRepresentation(xml, representation);
+            return result;
+        } catch(ex) {
+             throw CampaignException.REPORT_FETCH_FAILED(callContext.reportName, ex);
+        }
+    }
+
     /**
      * Ping a Message Center Campaign server (/nl/jsp/mcPing.jsp).
      * Assumes Message Center is installed

package/test/application.test.js

@@ -1973,6 +1973,28 @@ describe('Application', () => {
                 expect(node.isSQL).toBe(false);
             });
 
+            it("Should have isSQL even if it also has isXML", async () => {
+                const xml = DomUtil.parse(`<schema namespace='nms' name='delivery' mappingType="sql">
+                    <element name='delivery' sqltable="NmsDelivery">
+                        <element name='properties'>
+                            <attribute name="midAccountUsedName" type="string" xml="true"/>
+                            <attribute name="seedProcessed" sqlname="iSeedProcessed" type="long" xml="true"/>
+                        </element>
+                    </element>
+                </schema>`);
+                const schema = newSchema(xml);
+                const properties = await schema.root.findNode("properties");
+                expect(properties.isSQL).toBe(false);
+                // xml only node is not sql
+                const midAccountUsedName = await properties.findNode("@midAccountUsedName");
+                expect(midAccountUsedName.isSQL).toBe(false);
+                expect(midAccountUsedName.isMappedAsXML).toBe(true);
+                // node may be both xml and sql. If that's the case, it's considered sql
+                const seedProcessed = await properties.findNode("@seedProcessed");
+                expect(seedProcessed.isSQL).toBe(true);
+                expect(seedProcessed.isMappedAsXML).toBe(true);
+            });
+
             it("Should be memo and memo data" , async () => {
                 const xml = DomUtil.parse(`<schema namespace='nms' name='recipient' label="Recipients" labelSingular="Recipient">
                     <element name='recipient' sqltable="NmsRecipient">

package/test/client.test.js

@@ -3224,6 +3224,17 @@ describe('ACC Client', function () {
                 type: 'text/html',
                 size: 12345
             })
+            expect(client._transport).toHaveBeenNthCalledWith(2,
+                expect.objectContaining({
+                    data: expect.anything(),
+                    url: expect.any(String),
+                    method: 'POST',
+                    processData: false,
+                    credentials: 'include',
+                    headers: expect.anything(),
+                })
+            );
+
             expect(result).toMatchObject({
                 md5: "d8e8fca2dc0f896fd7cb4cb0031ba249",
                 name: "test.txt",
@@ -3467,4 +3478,66 @@ describe('ACC Client', function () {
         });
     });
 
+    describe("getReport API", () => {
+        it("Should call report API", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            client._transport.mockReturnValueOnce(Mock.REPORT_RESPONSE);
+            const report = await client.getReportData({
+                reportName: "throughput",
+                context: "selection",
+                selection: "12133",
+                schema: "nms:delivery",
+                formData: {ctx: {}}
+            });
+            expect(report._reportContext).toBe("throughput");
+            expect(report._selection).toBe("12133");
+            expect(report.vars.$period).toBe("604800");
+            expect(report.delivery.scheduling.contactDate).toBe("2021-12-07 17:13:39.507Z");
+            expect(report.data.bandwidth.deliveryStat.size).toBe("1.34");
+            expect(report.userInfo).toBeDefined();
+            expect(report.activityHistory).toBeDefined();
+
+            client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+            await client.NLWS.xtkSession.logoff();
+        });
+
+        it("Should fail to get report data, if API is not supported", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            client._transport.mockReturnValueOnce("Invalid response");
+            await expect(client.getReportData({
+                reportName: "throughput",
+                context: "selection",
+                selection: "12133",
+                schema: "nms:delivery"
+            })).rejects.toMatchObject({ statusCode:500, message:"500 - Error 16384: SDK-000014 Failed to fetch report throughput. 500 - Error 16384: SDK-000015 Reports Data feature is not supported by the ACC instance" });
+
+            client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+            await client.NLWS.xtkSession.logoff();
+        });
+
+        it("Should fail to call getReport API", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            client.traceAPICalls(true);
+
+            client._transport.mockRejectedValueOnce(new HttpError(500, "Error rc=-57"));
+            await expect(client.getReportData({
+                reportName: "throughput",
+                context: "selection",
+                selection: "12133",
+                schema: "nms:delivery"
+            })).rejects.toMatchObject({ statusCode:500, message:"500 - Error 16384: SDK-000014 Failed to fetch report throughput. 500 - Error calling method '/report/throughput?_noRender=true&_schema=nms:delivery&_context=selection&_selection=12133&_selectionCount=1': Error rc=-57" });
+
+            client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+            await client.NLWS.xtkSession.logoff();
+        });
+    });
+
 });

package/test/mock.js

@@ -70,6 +70,39 @@ const PING = Promise.resolve("OK\n2021-08-27 15:43:48.862Z\n");
 const MC_PING = Promise.resolve("Ok\n2021-08-27 15:48:07.893Z\n7/400 pending events");
 const MC_PING_ERROR = Promise.resolve("Error\nThe queue is full (7/400)");
 
+const REPORT_RESPONSE = Promise.resolve(`<ctx lang="en" date="2022-11-09T06:10:27Z" _target="web" alt_period="604800" statsCount="1" webApp-id="1569" _context="selection" _reportContext="throughput" _hasFilter="false" _selectionCount="1" _selection="12133" _schema="nms:delivery" _folderModel="nmsDelivery" _folderLinkId="@folder-id" _folderLink="folder" activityHist="xxx">
+	<userInfo datakitInDatabase="true" homeDir="" instanceLocale="en-US" locale="en-US" login="admin" loginCS="Administrator (admin)" loginId="1059" noConsoleCnx="false" orgUnitId="0" theme="" timezone="Asia/Kolkata" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="urn:xtk:session" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+		<login-group id="1060"/>
+		<login-right right="admin"/>
+	</userInfo>
+	<vars>
+		<period>604800</period>
+		<trunc>3600</trunc>
+		<valueScaleFactor>1</valueScaleFactor>
+		<dateStepType>hour</dateStepType>
+		<dateStepFactor>1</dateStepFactor>
+	</vars>
+	<activityHistory>
+		<activity name="page" type="page"/>
+		<activity name="script" type="script"/>
+		<activity name="query2" type="query"/>
+		<activity name="test" type="test"/>
+	</activityHistory>
+	<delivery label="Email delivery">
+		<scheduling contactDate="2021-12-07 17:13:39.507Z"/>
+	</delivery>
+	<title>Delivery: Email delivery</title>
+	<data>
+		<deliveryStat>
+		<deliveryStat date="2021-12-07 17:30:00.000Z" count="1" series="Success"/>
+		<deliveryStat date="2021-12-07 17:30:00.000Z" count="0" series="Errors"/>
+		</deliveryStat>
+		<bandwidth>
+		<deliveryStat date="2021-12-07 17:30:00.000Z" size="1.34"/>
+		</bandwidth>
+	</data>
+	</ctx>`);
+
 const LOGON_RESPONSE = 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>
@@ -828,6 +861,7 @@ exports.Mock = {
   PING: PING,
   MC_PING: MC_PING,
   MC_PING_ERROR: MC_PING_ERROR,
+  REPORT_RESPONSE: REPORT_RESPONSE,
   LOGON_RESPONSE: LOGON_RESPONSE,
   BEARER_LOGON_RESPONSE: BEARER_LOGON_RESPONSE,
   LOGON_RESPONSE_NO_SESSIONTOKEN: LOGON_RESPONSE_NO_SESSIONTOKEN,