feat: Allow DS for service program return value (#217)

Author: abmusse

lib/Deprecated.js

@@ -109,18 +109,25 @@ class iPgm {
 
   /**
    * @description adds a return element to the program XML
-   * @param {string} data
+   * @param {string} value
    * @param {string} type
    * @param {object} [options]
    */
-  addReturn(data, type = '1024a', options) {
-    if (!type) {
-      iPgmDeprecate('defaulting return type to 1024a has been deprecated. You should specify a type instead.');
-      // eslint-disable-next-line no-param-reassign
-      type = '1024a';
+  addReturn(value, type = '1024a', options) {
+    const data = {};
+    data.type = type;
+    data.value = value;
+    if (!data.type) {
+      iPgmDeprecate('defaulting return data type to 1024a has been deprecated. You should specify a type instead.');
+      data.type = '1024a';
+    }
+
+    if (typeof options === 'object') { // <data> options
+      Object.keys(options).forEach((key) => {
+        data[key] = options[key];
+      });
     }
-    iPgmDeprecate('As of v1.0, \'iPgm.addReturn()\' is deprecated. Please use \'ProgramCall.addParam()\' instead.');
-    return this.ProgramCall.addReturn(data, type, options);
+    return this.ProgramCall.addReturn(data);
   }
 
   /**

lib/ProgramCall.js

@@ -92,25 +92,19 @@ class ProgramCall {
 
   /**
    * @description adds a return element to the program XML
-   * @param {string} data
-   * @param {string} type
-   * @param {object} [options]
+   * @param {object} data
    */
-  addReturn(data, type, options = null) {
-    if (!type) {
-      throw new Error('Specifying the return type is required.');
+  addReturn(data = {}) {
+    if (typeof data !== 'object') {
+      throw new Error('Expected the first parameter to be an object');
     }
-    this.xml += '<return>';
-
-    if (options && typeof options === 'object') {
-      this.xml += `<data type='${type}'`;
-      Object.keys(options).forEach((key) => {
-        this.xml += ` ${key}='${options[key]}'`;
-      });
-    } else {
-      this.xml += `<data type='${type}'`;
+    if (data.type === undefined) {
+      throw new Error('Expected \'type\' key on the data object');
     }
-    this.xml += `>${data}</data></return>`;
+
+    this.xml += '<return>';
+    this.__addData__(data);
+    this.xml += '</return>';
   }
 
   /**

test/unit/ProgamCallUnit.js

@@ -139,7 +139,7 @@ describe('ProgramCall Class Unit Tests', () => {
       const pgm = new ProgramCall('MYPGM', { lib: 'MYLIB', func: 'MY_PROCEDURE' });
 
       pgm.addParam({ value: '', type: '1A', by: 'val' });
-      pgm.addReturn('', '2A', 'output');
+      pgm.addReturn({ name: 'output', type: '2A', value: '' });
 
       const lookAtXML = pgm.toXML();
       expect(lookAtXML).to.match(/<parm .*by='val'.*>/);
@@ -156,7 +156,7 @@ describe('ProgramCall Class Unit Tests', () => {
       pgm.addParam({
         name: 'inds', type: 'ds', by: 'val', fields: params,
       });
-      pgm.addReturn('', '2A', { name: 'output' });
+      pgm.addReturn({ name: 'output', type: '2A', value: '' });
 
       const lookAtXML = pgm.toXML();
       expect(lookAtXML).to.match(/<parm .*by='val'.*>/);
@@ -168,7 +168,7 @@ describe('ProgramCall Class Unit Tests', () => {
       pgm.addParam({
         value: '', type: '1A', by: 'val', io: 'both',
       });
-      pgm.addReturn('', '2A', { name: 'output' });
+      pgm.addReturn({ name: 'output', type: '2A', value: '' });
 
       const lookAtXML = pgm.toXML();
       expect(lookAtXML).to.match(/<parm .*by='val'.*>/);
@@ -186,7 +186,7 @@ describe('ProgramCall Class Unit Tests', () => {
       pgm.addParam({
         name: 'inds', type: 'ds', by: 'val', io: 'both', fields: params,
       });
-      pgm.addReturn('', '2A', { name: 'output' });
+      pgm.addReturn({ name: 'output', type: '2A', value: '' });
 
       const lookAtXML = pgm.toXML();
       expect(lookAtXML).to.match(/<parm .*by='val'.*>/);
@@ -204,12 +204,32 @@ describe('ProgramCall Class Unit Tests', () => {
           error: 'fast',
         });
 
-      pgm.addReturn('0', '20A');
+      pgm.addReturn({ type: '20A', value: '0' });
 
       const expectedXML = '<pgm name=\'QTOCNETSTS\' lib=\'QSYS\' func=\'QtoRtvTCPA\' '
       + 'error=\'fast\'><return><data type=\'20A\'>0</data></return></pgm>';
 
       expect(pgm.toXML()).to.equal(expectedXML);
     });
+
+    it('appends return with ds to pgm xml', () => {
+      const pgm = new ProgramCall('TEST');
+
+      const ds = {
+        name: 'test_ds',
+        type: 'ds',
+        io: 'out',
+        fields: [
+          { type: '10i0', value: 0 },
+          { type: '10A', value: '' },
+        ],
+      };
+      pgm.addReturn(ds);
+
+      const expectedXML = "<pgm name='TEST' error='fast'><return><ds name='test_ds'>"
+      + "<data type='10i0'>0</data><data type='10A'></data></ds></return></pgm>";
+
+      expect(pgm.toXML()).to.equal(expectedXML);
+    });
   });
 });