@adobe/acc-js-sdk 1.1.1 → 1.1.2

package/CHANGELOG.md

@@ -5,6 +5,11 @@ This is a node.js SDK for Campaign API. It exposes the Campaign API exactly like
 
 # Changelog 
 
+## Version 1.1.2
+_2022/03/22_
+
+* Add support for choosing the representation (XML or JSON) at the method level using NLWS.xml or NLWS.json.
+
 ## Version 1.1.1
 _2022/03/10_
 

package/README.md

@@ -304,6 +304,15 @@ const queryDef = {
 };
 ```
 
+## Method-level representation
+
+The client object is created with a default representation which is used for all API calls in the context of this client. Since version 1.1.2, it is also possible to set the representation at the method level, i.e. use a particular representation for a particular API call.
+
+* `client.NLWS`: use the default representation set at the client level
+* `client.NLWS.xml`: use the XML reresentation
+* `client.NLWS.json`: use the SimpleJson representation
+
+
 ## SimpleJson format
 The Simple JSON format works like this:
 
@@ -324,7 +333,7 @@ XML elements are mapped to JSON objects
 * XML: `<root><item id=1/></root>`
 * JSON: `{ item: { id:1 } }`
 
-If the parent element tag ends with `-collecion` children are always an array, even if there are no children, or if there is just one child. The rationale is that XML/JSON conversion is ambigous : XML can have multiple elements with the same tag and when there's only one such element, it's not possible to determine if it should be represented as a JSON object or JSON array unless we have additional metadata. 
+If the parent element tag ends with `-collection` children are always an array, even if there are no children, or if there is just one child. The rationale is that XML/JSON conversion is ambigous : XML can have multiple elements with the same tag and when there's only one such element, it's not possible to determine if it should be represented as a JSON object or JSON array unless we have additional metadata. 
 
 * XML: `<root-collection><item id=1/></root>`
 * JSON: `{ item: [ { id:1 } ] }`

package/package-lock.json

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

package/package.json

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

package/src/client.js

@@ -96,65 +96,77 @@ const xtkObjectHandler = {
  * <code>
  * result = await client.NLWS.xtkSession.getServerTime();
  * </code>
+ * 
+ * To get a handler, call the `clientHandler` function and optionally pass a representation.
+ * If no representation is passed (undefined), the representation set at the client level
+ * will be used, which is the default behavior.
+ * To get a proxy with a specific representation, use NLWS.xml or NMWS.json
  *
  * @private
  * @memberof Campaign
  */
-const clientHandler = {
-    get: function(client, namespace) {
-        return new Proxy({ client:client, namespace:namespace}, {
-            get: function(callContext, methodName) {
-                if (methodName == ".") return callContext;
-
-                // get Schema id from namespace (find first upper case letter)
-                var schemaId = "";
-                for (var i=0; i<namespace.length; i++) {
-                    const c = namespace[i];
-                    if (c >='A' && c<='Z') {
-                        schemaId = schemaId + ":" + c.toLowerCase() + namespace.substr(i+1);
-                        break;
-                    }
-                    schemaId = schemaId + c;
-                }
-                callContext.schemaId = schemaId;
-
-                const caller = function(thisArg, argumentsList) {
-                    const callContext = thisArg["."];
-                    const namespace = callContext.namespace;
-                    const methodNameLC = methodName.toLowerCase();
-                    methodName = methodName.substr(0, 1).toUpperCase() + methodName.substr(1);
-                    if (namespace == "xtkSession" && methodNameLC == "logon")
-                        return callContext.client.logon(argumentsList[0]);
-                    else if (namespace == "xtkSession" && methodNameLC == "logoff")
-                        return callContext.client.logoff();
-                    else if (namespace == "xtkSession" && methodNameLC == "getoption") {
-                        var promise = callContext.client._callMethod(methodName, callContext, argumentsList);
-                        return promise.then(function(optionAndValue) {
-                            const optionName = argumentsList[0];
-                            client._optionCache.put(optionName, optionAndValue);
-                            return optionAndValue;
-                        });
+const clientHandler = (representation) => {
+    return {
+        get: function(client, namespace) {
+            // Force XML or JSON representation (NLWS.xml or NLWS.json)
+            if (namespace == "xml") return new Proxy(client, clientHandler("xml"));
+            if (namespace == "json") return new Proxy(client, clientHandler("SimpleJson"));
+
+            return new Proxy({ client:client, namespace:namespace}, {
+                get: function(callContext, methodName) {
+                    callContext.representation = representation;
+                    if (methodName == ".") return callContext;
+
+                    // get Schema id from namespace (find first upper case letter)
+                    var schemaId = "";
+                    for (var i=0; i<namespace.length; i++) {
+                        const c = namespace[i];
+                        if (c >='A' && c<='Z') {
+                            schemaId = schemaId + ":" + c.toLowerCase() + namespace.substr(i+1);
+                            break;
+                        }
+                        schemaId = schemaId + c;
                     }
-                    // static method
-                    var result = callContext.client._callMethod(methodName, callContext, argumentsList);
-                    return result;
-                };
-
-                if (methodName == "create") {
-                    return function(body) {
-                        callContext.object = body;
-                        return new Proxy(callContext, xtkObjectHandler);
+                    callContext.schemaId = schemaId;
+
+                    const caller = function(thisArg, argumentsList) {
+                        const callContext = thisArg["."];
+                        const namespace = callContext.namespace;
+                        const methodNameLC = methodName.toLowerCase();
+                        methodName = methodName.substr(0, 1).toUpperCase() + methodName.substr(1);
+                        if (namespace == "xtkSession" && methodNameLC == "logon")
+                            return callContext.client.logon(argumentsList[0]);
+                        else if (namespace == "xtkSession" && methodNameLC == "logoff")
+                            return callContext.client.logoff();
+                        else if (namespace == "xtkSession" && methodNameLC == "getoption") {
+                            var promise = callContext.client._callMethod(methodName, callContext, argumentsList);
+                            return promise.then(function(optionAndValue) {
+                                const optionName = argumentsList[0];
+                                client._optionCache.put(optionName, optionAndValue);
+                                return optionAndValue;
+                            });
+                        }
+                        // static method
+                        var result = callContext.client._callMethod(methodName, callContext, argumentsList);
+                        return result;
                     };
-                }
 
-                return new Proxy(caller, {
-                    apply: function(target, thisArg, argumentsList) {
-                        return target(thisArg, argumentsList);
-                    }                
-                });
-            }
-        });
-    }
+                    if (methodName == "create") {
+                        return function(body) {
+                            callContext.object = body;
+                            return new Proxy(callContext, xtkObjectHandler);
+                        };
+                    }
+
+                    return new Proxy(caller, {
+                        apply: function(target, thisArg, argumentsList) {
+                            return target(thisArg, argumentsList);
+                        }                
+                    });
+                }
+            });
+        }
+    };
 };
 
 // ========================================================================================
@@ -477,7 +489,7 @@ class Client {
         this._entityCache = new XtkEntityCache(this._storage, `${rootKey}.XtkEntityCache`, connectionParameters._options.entityCacheTTL);
         this._methodCache = new MethodCache(this._storage, `${rootKey}.MethodCache`, connectionParameters._options.methodCacheTTL);
         this._optionCache = new OptionCache(this._storage, `${rootKey}.OptionCache`, connectionParameters._options.optionCacheTTL);
-        this.NLWS = new Proxy(this, clientHandler);
+        this.NLWS = new Proxy(this, clientHandler());
 
         this._transport = connectionParameters._options.transport;
         this._traceAPICalls = connectionParameters._options.traceAPICalls;
@@ -1122,7 +1134,7 @@ class Client {
                 throw CampaignException.SOAP_UNKNOWN_METHOD(schemaId, methodName, `Cannot call non-static method '${methodName}' of schema '${schemaId}' : no object was specified`);
 
             const rootName = schemaId.substr(schemaId.indexOf(':') + 1);
-            object = that._fromRepresentation(rootName, object);
+            object = that._fromRepresentation(rootName, object, callContext.representation);
             soapCall.writeDocument("document", object);
         }
 
@@ -1170,7 +1182,7 @@ class Client {
                             const index = xtkschema.indexOf(":");
                             docName = xtkschema.substr(index+1);
                         }
-                        var xmlValue = that._fromRepresentation(docName, paramValue);
+                        var xmlValue = that._fromRepresentation(docName, paramValue, callContext.representation);
                         if (type == "DOMDocument")
                             soapCall.writeDocument(paramName, xmlValue);
                         else
@@ -1189,7 +1201,7 @@ class Client {
                 // the method is called. This is the new version of the object (in XML form)
                 const entity = soapCall.getEntity();
                 if (entity) {
-                    callContext.object = that._toRepresentation(entity);
+                    callContext.object = that._toRepresentation(entity, callContext.representation);
                 }
             }
 
@@ -1220,7 +1232,7 @@ class Client {
                             returnValue = soapCall.getNextDate();
                         else if (type == "DOMDocument") {
                             returnValue = soapCall.getNextDocument();
-                            returnValue = that._toRepresentation(returnValue);
+                            returnValue = that._toRepresentation(returnValue, callContext.representation);
                             if (schemaId === "xtk:queryDef" && methodName === "ExecuteQuery" && paramName === "output") {
                                 // https://github.com/adobe/acc-js-sdk/issues/3
                                 // Check if query operation is "getIfExists". The "object" variable at this point
@@ -1240,7 +1252,7 @@ class Client {
                         }
                         else if (type == "DOMElement") {
                             returnValue = soapCall.getNextElement();
-                            returnValue = that._toRepresentation(returnValue);
+                            returnValue = that._toRepresentation(returnValue, callContext.representation);
                         }
                         else {
                             // type can reference a schema element. The naming convension is that the type name
@@ -1254,7 +1266,7 @@ class Client {
                                     if (element.getAttribute("name") == shortTypeName) {
                                         // Type found in schema: Process as a DOM element
                                         returnValue = soapCall.getNextElement();
-                                        returnValue = that._toRepresentation(returnValue);
+                                        returnValue = that._toRepresentation(returnValue, callContext.representation);
                                         break;
                                     }
                                     element = DomUtil.getNextSiblingElement(element, "element");

package/test/client.test.js

@@ -2283,15 +2283,15 @@ describe('ACC Client', function () {
         it("Should ignore protocol for local storage root key", async () => {
             var connectionParameters = sdk.ConnectionParameters.ofUserAndPassword("http://acc-sdk:8080", "admin", "admin", {});
             var client = await sdk.init(connectionParameters);
-            expect(client._optionCache._storage._rootKey).toBe("acc.js.sdk.1.1.1.acc-sdk:8080.cache.OptionCache$");
+            expect(client._optionCache._storage._rootKey).toBe("acc.js.sdk.1.1.2.acc-sdk:8080.cache.OptionCache$");
 
             connectionParameters = sdk.ConnectionParameters.ofUserAndPassword("https://acc-sdk:8080", "admin", "admin", {});
             client = await sdk.init(connectionParameters);
-            expect(client._optionCache._storage._rootKey).toBe("acc.js.sdk.1.1.1.acc-sdk:8080.cache.OptionCache$");
+            expect(client._optionCache._storage._rootKey).toBe("acc.js.sdk.1.1.2.acc-sdk:8080.cache.OptionCache$");
 
             connectionParameters = sdk.ConnectionParameters.ofUserAndPassword("acc-sdk:8080", "admin", "admin", {});
             client = await sdk.init(connectionParameters);
-            expect(client._optionCache._storage._rootKey).toBe("acc.js.sdk.1.1.1.acc-sdk:8080.cache.OptionCache$");
+            expect(client._optionCache._storage._rootKey).toBe("acc.js.sdk.1.1.2.acc-sdk:8080.cache.OptionCache$");
         })
 
         it("Should support no storage", async () => {
@@ -2422,4 +2422,56 @@ describe('ACC Client', function () {
             expect(paramsFn.mock.calls[0][1]).toMatchObject({ schemaId: "xtk:session", namespace: "xtkSession" });
         });
     });
+
+    describe("Method-level representation", () => {
+        it("Should force an xml representation", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_QUERY_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Mock.GET_QUERY_EXECUTE_RESPONSE);
+            const queryDef = DomUtil.parse(`
+                <queryDef schema="nms:extAccount" operation="select">
+                    <select>
+                        <node expr="@id"/>
+                        <node expr="@name"/>
+                    </select>
+                </queryDef>
+            `);
+            const query = client.NLWS.xml.xtkQueryDef.create(queryDef);
+            const result = await query.executeQuery();
+            const xml = DomUtil.toXMLString(result);
+            expect(xml).toBe(`<extAccount-collection xmlns="urn:xtk:queryDef">
+            <extAccount id="1816" name="defaultPopAccount"/>
+            <extAccount id="1818" name="defaultOther"/>
+            <extAccount id="1849" name="billingReport"/>
+            <extAccount id="12070" name="TST_EXT_ACCOUNT_POSTGRESQL"/>
+            <extAccount id="1817" name="defaultEmailBulk"/>
+            <extAccount id="2087" name="ffda"/>
+            <extAccount id="2088" name="defaultEmailMid"/>
+        </extAccount-collection>`);
+        });
+
+        it("Should force an json representation", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+            client._transport.mockReturnValueOnce(Mock.GET_XTK_QUERY_SCHEMA_RESPONSE);
+            client._transport.mockReturnValueOnce(Mock.GET_QUERY_EXECUTE_RESPONSE);
+            const queryDef = {
+                "schema": "nms:extAccount",
+                "operation": "select",
+                "select": {
+                    "node": [
+                        { "expr": "@id" },
+                        { "expr": "@name" }
+                    ]
+                }
+            };
+            const query = client.NLWS.json.xtkQueryDef.create(queryDef);
+            const result = await query.executeQuery();
+            const json = JSON.stringify(result);
+            expect(json).toBe('{"#text":[],"extAccount":[{"id":"1816","name":"defaultPopAccount"},{"id":"1818","name":"defaultOther"},{"id":"1849","name":"billingReport"},{"id":"12070","name":"TST_EXT_ACCOUNT_POSTGRESQL"},{"id":"1817","name":"defaultEmailBulk"},{"id":"2087","name":"ffda"},{"id":"2088","name":"defaultEmailMid"}]}');
+        });
+    });
 });