feat: add a new boolean argument in report method to force POST request

Author: citizensas

src/Api.ts

@@ -387,10 +387,20 @@ export class Api {
      * @memberOf Api
      * @param {String} objCode    One of object codes from {@link https://developers.workfront.com/api-docs/api-explorer/|Workfront API Explorer}
      * @param {Object} query    An object with search criteria and aggregate functions
+     * @param {Boolean} [useHttpPost=false] Whenever to use POST to send query params
      * @return {Promise}    A promise which will resolved with results if everything went ok and rejected otherwise
      */
-    report(objCode: string, query: object) {
-        return this.request(objCode + '/report', query, null, Api.Methods.GET)
+    report(objCode: string, query: object, useHttpPost = false) {
+        let reportQuery, method
+        if (useHttpPost) {
+            reportQuery = {...query, method: Api.Methods.GET}
+            method = Api.Methods.POST
+        }
+        else {
+            reportQuery = query
+            method = Api.Methods.GET
+        }
+        return this.request(objCode + '/report', reportQuery, null, method)
     }
 
     /**

test/integration/report.spec.ts

@@ -24,7 +24,6 @@ import fixture from '../../fixtures/report.json'
 const API_URL = 'http://foobar:8080'
 
 describe('Report', function() {
-
     afterEach(fetchMock.reset)
     afterEach(fetchMock.restore)
 
@@ -38,26 +37,34 @@ describe('Report', function() {
     })
 
     beforeEach(function() {
-        fetchMock.mock(
-            `begin:${API_URL}/attask/api`,
-            fixture,
-            {
-                name: 'report'
-            }
-        )
+        fetchMock.mock(`begin:${API_URL}/attask/api`, fixture, {
+            name: 'report'
+        })
     })
+    const objCode = 'TASK',
+        query = {
+            ['status' + GROUPBY]: true
+        }
     it('makes a request with proper params, url and method', function() {
-        const objCode = 'TASK',
-            query = {
-                ['status' + GROUPBY]: true
-            }
         return this.api.report(objCode, query).then(function(data) {
             const [url, opts] = fetchMock.lastCall('report')
             should(opts.method).equal('GET')
             should(opts.body).be.null()
             should(url).endWith(`${objCode}/report?status${GROUPBY}=true`)
-            should(data).have.propertyByPath('CPL', 'dcount_ID').be.Number()
-            should(data.CPL).have.property('status').be.equal('CPL')
+            should(data)
+                .have.propertyByPath('CPL', 'dcount_ID')
+                .be.Number()
+            should(data.CPL)
+                .have.property('status')
+                .be.equal('CPL')
+        })
+    })
+    it('should do a request with POST method when the useHttpPost=true', function() {
+        return this.api.report(objCode, query, true).then(function() {
+            const [url, opts] = fetchMock.lastCall('report')
+            should(url).endWith(`${objCode}/report`)
+            should(opts.method).equal('POST')
+            should(opts.body).equals(`status${GROUPBY}=true&method=GET`)
         })
     })
 })