@adobe/acc-js-sdk 1.1.46 → 1.1.47

package/docs/changeLog.html

@@ -2,6 +2,15 @@
 layout: page
 title: Change Log
 ---
+<section class="changelog"><h1>Version 1.1.47</h1>
+  <h2>2024/04/23</h2>
+  <li>
+    Issue 105 (https://github.com/adobe/acc-js-sdk/issues/105). 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/package-lock.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.46",
+  "version": "1.1.47",
   "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/client.js

@@ -1197,7 +1197,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/test/client.test.js

@@ -1061,26 +1061,44 @@ describe('ACC Client', function () {
             await client.NLWS.xtkSession.logon();
 
             client._transport.mockReturnValueOnce(Mock.GET_XTK_WORKFLOW_SCHEMA_RESPONSE);
-            client._transport.mockImplementationOnce(options => {
-                const doc = DomUtil.parse(options.data);
-                const body = DomUtil.findElement(doc.documentElement, "SOAP-ENV:Body");
-                const method = DomUtil.getFirstChildElement(body);
-                const parameters = DomUtil.findElement(method, "parameters");
-                const variables = DomUtil.getFirstChildElement(parameters, "variables");
-                if (!variables)
-                    throw new Error("Did not find 'variables' node");
-                if (variables.getAttribute("hello") != "world")
-                    throw new Error("Did not find 'hello' variable");
 
-                return 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:workflow' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
-                        <SOAP-ENV:Body>
-                        <StartWithParametersResponse xmlns='urn:xtk:workflow' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
-                        </StartWithParametersResponse>
-                        </SOAP-ENV:Body>
-                    </SOAP-ENV:Envelope>`);
-            });
-            await client.NLWS.xtkWorkflow.startWithParameters(4900, { "hello": "world" });
+            const mockImpl = (methodName) => {
+                client._transport.mockImplementationOnce(options => {
+                    const doc = DomUtil.parse(options.data);
+                    const body = DomUtil.findElement(doc.documentElement, "SOAP-ENV:Body");
+                    const method = DomUtil.getFirstChildElement(body);
+                    const parameters = DomUtil.findElement(method, "parameters");
+                    const variables = DomUtil.getFirstChildElement(parameters, "variables");
+                    if (!variables)
+                        throw new Error("Did not find 'variables' node");
+                    if (variables.getAttribute("hello") != "world")
+                        throw new Error("Did not find 'hello' variable");
+
+                    const tagName = methodName + "Response";
+                    return 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:workflow' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+                            <SOAP-ENV:Body>
+                            <${tagName} xmlns='urn:xtk:workflow' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+                            </${tagName}>
+                            </SOAP-ENV:Body>
+                        </SOAP-ENV:Envelope>`);
+                });
+            };
+
+            const variables = { "hello": "world" };
+
+            mockImpl("StartWithParameters");
+            await client.NLWS.xtkWorkflow.startWithParameters(4900, variables);
+            mockImpl("SimulateWithParameters");
+            await client.NLWS.xtkWorkflow.simulateWithParameters(4900, variables);
+            mockImpl("PostEvent");
+            await client.NLWS.xtkWorkflow.postEvent("WFK123", "signal", "", variables, false);
+            
+            // return parameter instanceId has been removed from the mock method definition to simplify the unit test
+            mockImpl("SpawnWithParameters");
+            await client.NLWS.xtkWorkflow.spawnWithParameters(4900, variables);
+            mockImpl("SpawnWithParametersEx");
+            await client.NLWS.xtkWorkflow.spawnWithParametersEx(4900, true, variables);
 
             client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
             await client.NLWS.xtkSession.logoff();

package/test/mock.js

@@ -742,6 +742,34 @@ const GET_XTK_WORKFLOW_SCHEMA_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
                             <param name="parameters" type="DOMElement" inout="in"></param>
                         </parameters>
                     </method>
+                    <method name="SimulateWithParameters" static="true">
+                        <parameters>
+                            <param name="workflowId" type="string" inout="in" />
+                            <param name="parameters" type="DOMElement" inout="in"></param>
+                        </parameters>
+                    </method>
+                    <method name="PostEvent" static="true">              
+                        <parameters>
+                            <param name="workflowId" type="string" inout="in"/>
+                            <param name="activity" type="string" inout="in"/>
+                            <param name="transition"     type="string"      inout="in"/>
+                            <param name="parameters"     type="DOMElement"  inout="in"/>
+                            <param name="complete"       type="boolean"     inout="in"/>
+                        </parameters>
+                    </method>
+                    <method name="SpawnWithParameters" static="true">
+                        <parameters>
+                            <param name="workflowId" type="string" inout="in" />
+                            <param name="parameters" type="DOMElement" inout="in"></param>
+                        </parameters>
+                    </method>
+                    <method name="SpawnWithParametersEx" static="true">
+                        <parameters>
+                            <param name="workflowId" type="string" inout="in" />
+                            <param name="simulation" type="boolean" inout="in"/>
+                            <param name="parameters" type="DOMElement" inout="in"></param>
+                        </parameters>
+                    </method>
                 </methods>
             </schema>
             </pdomDoc>