@adobe/acc-js-sdk 1.1.22 → 1.1.24

package/package.json

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

package/samples/011 - basics - packages.js

@@ -21,7 +21,7 @@ const utils = require("./utils.js");
 ( async () => {
 
   await utils.sample({
-    title: "Testing generating and importing packages",
+    title: "Testing generating and importing packages (in XML)",
     labels: [ "Basics", "Packages", "xtk:builder", "InstallPackage" ],
     description: `The xtkBuilder.installPackage() can be used to import packages`,
     code: async() => {
@@ -51,6 +51,40 @@ const utils = require("./utils.js");
         // Install package. The package is in XML format and we set the timeout to 5 mins to prevent any issues
         console.log(`Installing package`, DomUtil.toXMLString(doc));
         await NLWS.xml.pushDown({ timeout: 5*60*1000 }).xtkBuilder.installPackage(doc);      
+      });
+    }
+  });
+
+  await utils.sample({
+    title: "Testing generating and importing packages (in JSON)",
+    labels: [ "Basics", "Packages", "xtk:builder", "InstallPackage" ],
+    description: `The xtkBuilder.installPackage() can be used to import packages`,
+    code: async() => {
+      return await utils.logon(async (client, NLWS) => {
+        console.log(`Generating package with a service named 'newsletterTest'`);
+
+        const jsonPackage = { 
+            package: {
+              buildNumber: "*",
+              buildVersion: "*",
+              entities: {
+                schema:"nms:service",
+                service: {
+                  label: "NewsletterTest",
+                  name: "newsletterTest", 
+                  folder: {
+                    _operation: "none",
+                    name: "nmsSetOfServices"
+                  },
+                  visitorFolder: {
+                    _operation: "none",
+                    name: "nmsVisitor"
+                  }
+                }
+              }
+            }
+          };
+        await NLWS.pushDown({ timeout: 5*60*1000 }).xtkBuilder.installPackage(jsonPackage);
         console.log(`Package installed`);
       });
     }

package/src/application.js

@@ -19,7 +19,7 @@ governing permissions and limitations under the License.
  * https://docs.adobe.com/content/help/en/campaign-classic/technicalresources/api/c-Application.html
  * 
  *********************************************************************************/
-const { DomException, XPath } = require('./domUtil.js');
+const { DomException, DomUtil, XPath } = require('./domUtil.js');
 const XtkCaster = require('./xtkCaster.js').XtkCaster;
 const EntityAccessor = require('./entityAccessor.js').EntityAccessor;
 const { ArrayMap } = require('./util.js');
@@ -35,11 +35,14 @@ const PACKAGE_STATUS = { "never": 0, "always": 1, "default": 2, "preCreate": 3 }
 // ========================================================================================
 
 /**
-  * Creates a schema object from an XML representation
-  * This function is not intended to be used publicly.
+  * Creates a schema object from an XML representation.
+  * The returned XtkSchema object will not be added to the application schema cache.
+  * If you do not pass an application object, it will not be possible to follow
+  * references or get enumeration values from the returned XtkSchema
   * 
   * @private
   * @param {DOMElement|DOMDocument} xml the XML document or element representing the schema
+  * @param {Campaign.Application|undefined} the application object which will be used to follow links and references
   * @returns {XtkSchema} a schema object
   * @see {@link XtkSchema}
   * @memberof Campaign
@@ -416,6 +419,18 @@ class XtkSchemaNode {
          */
         this.childrenCount = 0;
 
+        /**
+         * Get the default value of a node
+         * @type {string}
+         */
+        this.default = EntityAccessor.getAttributeAsString(xml, "default");
+
+        /**
+         * Get the default translation for the default value of a node
+         * @type {string}
+         */
+        this.translatedDefault = EntityAccessor.getAttributeAsString(xml, "translatedDefault");
+
         /**
          * Indicates if the node is the root node, i.e. the first child node of the schema, whose name is the same as the schema name
          * @type {boolean}
@@ -636,6 +651,16 @@ class XtkSchemaNode {
                 this.expr = EntityAccessor.getAttributeAsString(child, "expr");
                 this.isCalculated = false;
             }
+            if (child.tagName === "default") {
+                if(this.unbound) {
+                    // Default value for a collection of elements
+                    const xml = DomUtil.parse(`<xml>${child.textContent}</xml>`);
+                    const json = DomUtil.toJSON(xml);
+                    this.default = XtkCaster.asArray(json[this.name]);
+                } else {
+                    this.default = child.textContent;
+                }
+            }
         }
         for (const childNode of childNodes) {
             this.children._push(childNode.name, childNode);
@@ -1094,6 +1119,7 @@ class XtkEnumeration {
  * @private
  * @class
  * @constructor
+ * @param {Campaign.Application|undefined} the application object which will be used to follow links and references
  * @augments Campaign.XtkSchemaNode
  * @param {XML.XtkObject} xml the schema definition
  * @memberof Campaign

package/src/cache.js

@@ -12,7 +12,7 @@ governing permissions and limitations under the License.
 (function() {
 "use strict";    
   
-const { Util } = require("./util");
+const { Util } = require("./util.js");
 
 
 /**********************************************************************************

package/src/campaign.js

@@ -41,6 +41,7 @@ const { Util } = require("./util.js");
   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`); }
+  static REQUEST_ABORTED( )                               { return new CampaignException(undefined, 500,   -53, `SDK-000016 Request was aborted by the client`); }
 
 
   /**
@@ -214,6 +215,9 @@ function makeCampaignException(call, err) {
   if (err instanceof CampaignException)
       return err;
 
+  if (err && err.name == "AbortError") 
+        throw CampaignException.REQUEST_ABORTED();
+ 
   // Wraps DOM exceptions which can occur when dealing with malformed XML
   const ctor = Object.getPrototypeOf(err).constructor;
   if (ctor && ctor.name == "DOMException") {

package/src/client.js

@@ -33,7 +33,7 @@ const MethodCache = require('./methodCache.js').MethodCache;
 const OptionCache = require('./optionCache.js').OptionCache;
 const CacheRefresher = require('./cacheRefresher.js').CacheRefresher;
 const request = require('./transport.js').request;
-const Application = require('./application.js').Application;
+const { Application, newSchema } = require('./application.js');
 const EntityAccessor = require('./entityAccessor.js').EntityAccessor;
 const { Util } = require('./util.js');
 const { XtkJobInterface } = require('./xtkJob.js');
@@ -1629,6 +1629,20 @@ class Client {
         return outputParams[0].value;
     }
 
+    /**
+     * Creates a schema object from an XML representation.
+     * The returned XtkSchema object will not be added to the application schema cache.
+     * If you do not pass an application object, it will not be possible to follow
+     * references or get enumeration values from the returned XtkSchema
+     * 
+     * @param {DOMElement|DOMDocument} xml the XML document or element representing the schema
+     * @returns {Campaign.XtkSchema} a schema object
+     * @see {@link Campaign.XtkSchema}
+     */
+    newSchema(xml) {
+        return newSchema(xml, this.application);
+    }
+
     /**
      * Get a compiled schema (not a source schema) definition as a DOM or JSON object depending on hte current representation
      *

package/src/domUtil.js

@@ -114,7 +114,6 @@ class DomUtil {
         const doc = dom.window.document;
         doc.__jsdom__ = dom;
         return doc;
-        //return parseXML(xmlString);
     }
 
     /**

package/src/transport.js

@@ -74,6 +74,7 @@ if (!Util.isBrowser()) {
       headers: options.headers,
       data: options.data,
       timeout: requestOptions.timeout || 5000,
+      signal: requestOptions.signal,
     };
     return axios(request)
     .then((response) => {
@@ -104,8 +105,8 @@ if (!Util.isBrowser()) {
  *********************************************************************************/
  else {
 
-  const request = function(options) {
-
+  const request = function(options, requestOptions) {
+    requestOptions = requestOptions || {};
     const headers = new Headers();
     for (var k in options.headers) {
         headers.append(k, options.headers[k]);
@@ -114,6 +115,7 @@ if (!Util.isBrowser()) {
         method: options.method,
         headers: headers,
         body: options.data,
+        signal : requestOptions.signal,
     });
 
     const p = fetch(r).then(async (response) => {
@@ -123,6 +125,9 @@ if (!Util.isBrowser()) {
             return blob.text();
         });
     }).catch((ex) => {
+      if(ex.name === 'AbortError'){
+        throw ex;
+      }
       const proto = Object.getPrototypeOf(ex);
       if (proto.constructor.name == "HttpError")
         throw ex;

package/test/application.test.js

@@ -1939,6 +1939,86 @@ describe('Application', () => {
             });
         });
 
+        describe("default values", () => {
+            
+            it("Should extract default", async () => {
+                var xml = DomUtil.parse(`<schema namespace='xtk' name='workflow'>
+                    <element name='workflow' label='Workflow'>
+                        <attribute default="true" label="In simulation mode:  execute" name="runOnsimulation" type="boolean" xml="true"/>
+                    </element>
+                </schema>`);
+                var schema = newSchema(xml);
+
+                var node = await schema.root.findNode("@runOnsimulation");
+                expect(node).toMatchObject({ name:"@runOnsimulation", childrenCount:0, default: 'true' });
+            });
+
+            it("Should extract default values of a collection of elements", async () => {
+                var xml = DomUtil.parse(`<schema namespace='xtk' name='workflow'>
+                    <element name='workflow' label='Workflow'>
+                        <element name="fork" label="Fork">
+                            <element label="Transitions" name="transitions" xml="true">
+                                <element label="transition" name="transition" ref="transition" unbound="true" xml="true">
+                                    <default>
+                                       &lt;transition name="transition1" enabled="true"/&gt;
+                                       &lt;transition name="transition2" enabled="true"/&gt;
+                                    </default>
+                                </element>
+                            </element>
+                        </element>
+                    </element>
+                </schema>`);
+                var schema = newSchema(xml);
+
+                var node = await schema.root.findNode("fork/transitions/transition");
+                expect(node).toMatchObject({ name:"transition", childrenCount:0, default: [
+                    {
+                      "enabled": "true",
+                      "name": "transition1"
+                    },
+                    {
+                      "enabled": "true",
+                      "name": "transition2"
+                    }
+                  ] });
+            });
+
+            it("Should extract default values of a memo", async () => {
+                var xml = DomUtil.parse(`<schema namespace='xtk' name='workflow'>
+                    <element name='workflow' label='Workflow'>
+                        <element name="directorywatcher" label="File collector">
+                            <element name="period" type="memo" label="Schedule">
+                                <default>"m_abDay='7' m_abDay[0]='0' m_abDay[1]='0'"</default>
+                            </element>
+                        </element>
+                    </element>
+                </schema>`);
+                var schema = newSchema(xml);
+
+                var node = await schema.root.findNode("directorywatcher/period");
+                expect(node).toMatchObject({ name:"period", childrenCount:0, default: "\"m_abDay='7' m_abDay[0]='0' m_abDay[1]='0'\"" });
+            });
+
+            it("Should extract translatedDefault", async () => {
+                var xml = DomUtil.parse(`<schema namespace='xtk' name='workflow'>
+                    <element name='workflow' label='Workflow'>
+                        <element name="delivery" label="Delivery">
+                            <element label="Transitions" name="transitions" xml="true">
+                                <element label="transition" name="done" xml="true">
+                                    <attribute label="Label" name="label" type="string" translatedDefault="'Ok'" xml="true"/>
+                                </element>
+                            </element>
+                        </element>
+                    </element>
+                </schema>`);
+                var schema = newSchema(xml);
+
+                var node = await schema.root.findNode("delivery/transitions/done/@label");
+                expect(node).toMatchObject({ name:"@label", childrenCount:0, translatedDefault: "'Ok'" });
+            });
+
+        });
+
         describe("toString", () => {
             var xml = DomUtil.parse(`<schema namespace='nms' name='recipient' label="Recipients" labelSingular="Recipient">
                     <element name='recipient'>

package/test/client.test.js

@@ -3702,4 +3702,72 @@ describe('ACC Client', function () {
         });
     });
 
+    describe("New schema", () => {
+        it("Should create XtkSchema from XML Document", async () => {
+            const client = await Mock.makeClient();
+            const xml = DomUtil.parse("<schema namespace='nms' name='recipient'></schema>");
+            const schema = client.newSchema(xml);
+            expect(client.application).toBeNull(); // client not logged. newSchema should support undefined application object
+            expect(schema.name).toBe('recipient');
+        });
+
+        it("Should create XtkSchema from XML Element", async () => {
+            const client = await Mock.makeClient();
+            const xml = DomUtil.parse("<schema namespace='nms' name='recipient'></schema>");
+            const schema = client.newSchema(xml.documentElement);
+            expect(client.application).toBeNull(); // client not logged. newSchema should support undefined application object
+            expect(schema.name).toBe('recipient');
+        });
+
+        it("Should create XtkSchema from XML Document on a logged client", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            expect(client.application).not.toBeNull();
+            const xml = DomUtil.parse("<schema namespace='nms' name='recipient'></schema>");
+            const schema = client.newSchema(xml);
+            expect(schema.name).toBe('recipient');
+        });
+
+        it("Should not add created XtkSchema to the application cache", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            const xml = DomUtil.parse("<schema namespace='nms' name='recipient'></schema>");
+            /*const schema = */client.newSchema(xml);
+            expect(client.application._schemaCache._schemas['nms:recipient']).toBeUndefined()
+        });
+
+        it("Should follow references", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            const xml = DomUtil.parse(`<schema namespace='nms' name='recipient'>
+                    <element name='recipient' label='Recipients'>
+                        <element name="jobs" target="xtk:job" type="link" unbound="true">
+                        </element>
+                    </element>
+                </schema>`);
+            const schema = client.newSchema(xml);
+            const jobs = schema.root.children["jobs"];
+            expect(jobs.target).toBe("xtk:job");
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_JOB_SCHEMA_RESPONSE);
+            const target = await jobs.linkTarget();
+            expect(target.name).toBe("job");
+        });
+
+        it("Should not follow references if no application object", async () => {
+            const client = await Mock.makeClient();
+            const xml = DomUtil.parse(`<schema namespace='nms' name='recipient'>
+                    <element name='recipient' label='Recipients'>
+                        <element name="jobs" target="xtk:job" type="link" unbound="true">
+                        </element>
+                    </element>
+                </schema>`);
+            const schema = client.newSchema(xml);
+            const jobs = schema.root.children["jobs"];
+            expect(jobs.target).toBe("xtk:job");
+            await expect(jobs.linkTarget()).rejects.toThrow("Cannot read property 'getSchema' of null");
+        });
+    });
 });

package/test/domUtil.test.js

@@ -943,5 +943,5 @@ describe('DomUtil', function() {
             expect(new XPathElement("..").isParent()).toBe(true);
             expect(new XPathElement(".").isParent()).toBe(false);
         })
-    })
+    });
 });

package/test/soap.test.js

@@ -551,7 +551,7 @@ describe('SOAP', function() {
           return call.execute().then(() => {
               expect(call.getNextString()).toBe("XSV-350008 Session has expired or is invalid. Please reconnect.");
           });
-      });
+        });
 
         it("Should should read Element response", function() {
             const xml = '<root att="Hello"><child/></root>';
@@ -853,6 +853,18 @@ describe("Campaign exception", () => {
 
     })
 
+    it("aborting pending HTTP calls to avoid unnecessary attempts to re-render.", function() {
+        const transport = function() { 
+            return Promise.reject({name: 'AbortError'}); 
+        };
+        const call = makeSoapMethodCall(transport, "xtk:session", "Date", "$session$", "$security$");
+        return call.execute().catch((ex) => {
+            expect(ex.statusCode).toBe(500);
+            expect(ex.faultCode).toBe(-53);
+            expect(ex.message).toBe(`500 - Error -53: SDK-000016 Request was aborted by the client`);
+        });
+    });
+
     describe("User agent", () => {
         it("Should set user agent", () => {
             const call = makeSoapMethodCall(undefined, "xtk:session", "Date", "$session$", "$security$", "My User Agent");