connectwise-rest 1.2.1 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "connectwise-rest",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "A nodejs module for interacting with the ConnectWise Manage and Automate REST APIs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,9 @@
     "clean:dist": "npx rimraf dist/",
     "clean:src": "npx rimraf src/Manage/ & npx rimraf src/Automate/",
     "clean": "npm run clean:dist & npm run clean:generator & npm run clean:src",
-    "test": "npx nyc mocha",
+    "test": "npm run test:manage",
+    "test:automate": "npx nyc mocha test/test-automate.js",
+    "test:manage": "npx nyc mocha test/test-manage.js",
     "pregenerate": "npm run clean",
     "generate:automate": "node generator/automate-generator.js",
     "generate:manage": "node generator/manage-generator.js",
@@ -27,7 +29,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/covenanttechnologysolutions/connectwise-rest"
+    "url": "git+https://github.com/covenanttechnologysolutions/connectwise-rest"
   },
   "keywords": [
     "connectwise",
@@ -47,7 +49,7 @@
   },
   "homepage": "https://github.com/covenanttechnologysolutions/connectwise-rest",
   "dependencies": {
-    "axios": "^0.26.1",
+    "axios": "^1.6.7",
     "promise-retry": "^2.0.1"
   },
   "devDependencies": {
@@ -69,7 +71,7 @@
     "mocha": "^9.2.2",
     "mocha-lcov-reporter": "^1.3.0",
     "nyc": "^15.1.0",
-    "openapi-typescript": "^5.4.1",
+    "openapi-typescript": "^6.7.4",
     "prettier": "^2.6.0",
     "rimraf": "^3.0.2",
     "ts-node": "^10.7.0",

package/src/Manage/SystemAPI.ts

@@ -6407,7 +6407,7 @@ export class SystemAPI extends Manage {
     params: CommonParameters = {},
   ): Promise<Array<WorkflowActionUserDefinedField>> {
     return this.request({
-      path: `/system/workflows/userdefinedfields/events${grandparentId}/actions/${parentId}`,
+      path: `/system/workflows/userdefinedfields/events/${grandparentId}/actions/${parentId}`,
       method: 'get',
       params,
     })

package/src/Manage.ts

@@ -1,4 +1,4 @@
-import axios, { AxiosError, AxiosInstance, AxiosResponse } from 'axios'
+import axios, { AxiosInstance, InternalAxiosRequestConfig } from 'axios'
 import { makeRequest, makePaginate, PaginationOptions, PaginationApiMethod } from './BaseAPI'
 import promiseRetry from 'promise-retry'
 import type { CWMOptions } from './ManageAPI'
@@ -6,6 +6,13 @@ import { CWLogger, DataResponse, ErrorResponse, RequestOptions, RetryOptions } f
 
 const CW_MANAGE_DEBUG = !!process.env.CW_MANAGE_DEBUG
 
+/**
+ * DEFAULTS variable.
+ * @type {Object}
+ * @property {RetryOptions} retryOptions - Retry options for API requests.
+ * @property {string} apiPath - The endpoint path for API requests.
+ * @property {(debug: boolean) => CWLogger} logger - Logger function that takes a boolean flag to enable debug mode.
+ */
 export const DEFAULTS: {
   retryOptions: RetryOptions
   apiPath: string
@@ -43,6 +50,12 @@ export const DEFAULTS: {
     },
 }
 
+/**
+ * Represents a class for managing configuration options.
+ *
+ * @interface
+ * @extends CWMOptions
+ */
 export interface ManageConfig extends CWMOptions {
   authorization: string
   entryPoint: string
@@ -133,6 +146,26 @@ export default class Manage {
       },
     })
 
+    this.instance.interceptors.request.use((config: InternalAxiosRequestConfig) => {
+      if (
+        config.url &&
+        config.headers &&
+        config.method === 'get' &&
+        config.headers.Accept &&
+        typeof config.headers.Accept === 'string'
+      ) {
+        //check for requests to /system/documents/{id}/download
+        const documentDownloadEndpointRegExp = /^\/system\/documents\/[0-9]*\/download$/
+        if (documentDownloadEndpointRegExp.test(config.url)) {
+          //replace the string "application/json" with "blob" in the Accept header
+          config.headers.Accept = config.headers.Accept.replace('application/json', 'blob')
+          //add response type 'stream' to axios response type
+          config.responseType = 'stream'
+        }
+      }
+      return config
+    })
+
     this.request = makeRequest({ config: this.config, api: this.api, thisObj: this })
     this.paginate = makePaginate({ thisObj: this })
   }

package/src/ManageAPI.ts

@@ -32,7 +32,7 @@ import { CWLogger, RetryOptions } from './types'
 export type PatchOperation = {
   op: 'add' | 'replace' | 'remove'
   path: string
-  value: Record<string, unknown> | Record<string, unknown>[] | string | null
+  value: unknown
 }
 
 /**

package/swagger-errors.md

@@ -23,3 +23,6 @@ getRequest specified as path but should be query
 
 **System.getSystemWorkflowsByParentIdEventsByIdTest**
 Missing return type
+
+**System.getSystemWorkflowsUserdefinedfieldsByGrandparentIdActionsByParentId**
+Missing slash in path

package/test/test-automate.js

@@ -0,0 +1,120 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const dotenv = require('dotenv')
+const path = require('path')
+const { AutomateAPI } = require('../dist')
+const assert = require('assert')
+const { describe, it } = require('mocha')
+
+dotenv.config({ path: path.join(__dirname, '.env') })
+
+const { AUTOMATE_API_CLIENT_ID, AUTOMATE_API_PASSWORD, AUTOMATE_API_URL, AUTOMATE_API_USER } =
+  process.env
+
+const cwa = new AutomateAPI({
+  clientId: AUTOMATE_API_CLIENT_ID,
+  serverUrl: AUTOMATE_API_URL,
+  username: AUTOMATE_API_USER,
+  password: AUTOMATE_API_PASSWORD,
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  logger: () => {},
+})
+
+describe('Automate', () => {
+  describe('instance', () => {
+    it('should be an instance of Automate', (done) => {
+      assert(cwa instanceof AutomateAPI)
+      done()
+    })
+
+    it('should have AVTemplatePoliciesAPI', (done) => {
+      assert(cwa.AVTemplatePoliciesAPI)
+      done()
+    })
+    it('should have ClientsAPI', (done) => {
+      assert(cwa.ClientsAPI)
+      done()
+    })
+    it('should have CommandsAPI', (done) => {
+      assert(cwa.CommandsAPI)
+      done()
+    })
+    it('should have ComputersAPI', (done) => {
+      assert(cwa.ComputersAPI)
+      done()
+    })
+    it('should have ContactsAPI', (done) => {
+      assert(cwa.ContactsAPI)
+      done()
+    })
+    it('should have DataViewsAPI', (done) => {
+      assert(cwa.DataViewsAPI)
+      done()
+    })
+    it('should have DrivesAPI', (done) => {
+      assert(cwa.DrivesAPI)
+      done()
+    })
+    it('should have EventLogsAPI', (done) => {
+      assert(cwa.EventLogsAPI)
+      done()
+    })
+    it('should have LocationsAPI', (done) => {
+      assert(cwa.LocationsAPI)
+      done()
+    })
+    it('should have MaintenanceWindowDefinitionsAPI', (done) => {
+      assert(cwa.MaintenanceWindowDefinitionsAPI)
+      done()
+    })
+    it('should have MonitorsAPI', (done) => {
+      assert(cwa.MonitorsAPI)
+      done()
+    })
+    it('should have NetworkDevicesAPI', (done) => {
+      assert(cwa.NetworkDevicesAPI)
+      done()
+    })
+    it('should have PatchingAPI', (done) => {
+      assert(cwa.PatchingAPI)
+      done()
+    })
+    it('should have RemoteAgentAPI', (done) => {
+      assert(cwa.RemoteAgentAPI)
+      done()
+    })
+    it('should have ScriptingAPI', (done) => {
+      assert(cwa.ScriptingAPI)
+      done()
+    })
+    it('should have SearchesAPI', (done) => {
+      assert(cwa.SearchesAPI)
+      done()
+    })
+    it('should have SystemAPI', (done) => {
+      assert(cwa.SystemAPI)
+      done()
+    })
+    it('should have TicketsAPI', (done) => {
+      assert(cwa.TicketsAPI)
+      done()
+    })
+    it('should have UserProfilesAPI', (done) => {
+      assert(cwa.UserProfilesAPI)
+      done()
+    })
+  })
+
+  describe('ComputersAPI', () => {
+    it('should return a list of computers', (done) => {
+      cwa.ComputersAPI.getComputerList({ pageSize: 1 })
+        .then((results) => {
+          assert(results.length === 1)
+          const computer = results[0]
+          assert(computer.Id)
+          assert(computer.ComputerName)
+          done()
+        })
+        .catch((error) => done(error))
+    })
+  })
+})

package/test/{test.js → test-manage.js}

@@ -4,7 +4,7 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 const dotenv = require('dotenv')
 const path = require('path')
-const { ManageAPI, AutomateAPI, utils } = require('../dist')
+const { ManageAPI, utils } = require('../dist')
 const assert = require('assert')
 const { describe, it } = require('mocha')
 const { isPromise } = require('./test-utils.js')
@@ -17,10 +17,6 @@ const {
   MANAGE_API_PUBLIC_KEY,
   MANAGE_API_PRIVATE_KEY,
   MANAGE_API_CLIENT_ID,
-  AUTOMATE_API_CLIENT_ID,
-  AUTOMATE_API_PASSWORD,
-  AUTOMATE_API_URL,
-  AUTOMATE_API_USER,
 } = process.env
 
 const cwm = new ManageAPI({
@@ -34,115 +30,6 @@ const cwm = new ManageAPI({
   logger: () => {},
 })
 
-const cwa = new AutomateAPI({
-  clientId: AUTOMATE_API_CLIENT_ID,
-  serverUrl: AUTOMATE_API_URL,
-  username: AUTOMATE_API_USER,
-  password: AUTOMATE_API_PASSWORD,
-  // eslint-disable-next-line @typescript-eslint/no-empty-function
-  logger: () => {},
-})
-
-describe('Automate', () => {
-  describe('instance', () => {
-    it('should be an instance of Automate', (done) => {
-      assert(cwa instanceof AutomateAPI)
-      done()
-    })
-
-    it('should have AVTemplatePoliciesAPI', (done) => {
-      assert(cwa.AVTemplatePoliciesAPI)
-      done()
-    })
-    it('should have ClientsAPI', (done) => {
-      assert(cwa.ClientsAPI)
-      done()
-    })
-    it('should have CommandsAPI', (done) => {
-      assert(cwa.CommandsAPI)
-      done()
-    })
-    it('should have ComputersAPI', (done) => {
-      assert(cwa.ComputersAPI)
-      done()
-    })
-    it('should have ContactsAPI', (done) => {
-      assert(cwa.ContactsAPI)
-      done()
-    })
-    it('should have DataViewsAPI', (done) => {
-      assert(cwa.DataViewsAPI)
-      done()
-    })
-    it('should have DrivesAPI', (done) => {
-      assert(cwa.DrivesAPI)
-      done()
-    })
-    it('should have EventLogsAPI', (done) => {
-      assert(cwa.EventLogsAPI)
-      done()
-    })
-    it('should have LocationsAPI', (done) => {
-      assert(cwa.LocationsAPI)
-      done()
-    })
-    it('should have MaintenanceWindowDefinitionsAPI', (done) => {
-      assert(cwa.MaintenanceWindowDefinitionsAPI)
-      done()
-    })
-    it('should have MonitorsAPI', (done) => {
-      assert(cwa.MonitorsAPI)
-      done()
-    })
-    it('should have NetworkDevicesAPI', (done) => {
-      assert(cwa.NetworkDevicesAPI)
-      done()
-    })
-    it('should have PatchingAPI', (done) => {
-      assert(cwa.PatchingAPI)
-      done()
-    })
-    it('should have RemoteAgentAPI', (done) => {
-      assert(cwa.RemoteAgentAPI)
-      done()
-    })
-    it('should have ScriptingAPI', (done) => {
-      assert(cwa.ScriptingAPI)
-      done()
-    })
-    it('should have SearchesAPI', (done) => {
-      assert(cwa.SearchesAPI)
-      done()
-    })
-    it('should have SystemAPI', (done) => {
-      assert(cwa.SystemAPI)
-      done()
-    })
-    it('should have TicketsAPI', (done) => {
-      assert(cwa.TicketsAPI)
-      done()
-    })
-    it('should have UserProfilesAPI', (done) => {
-      assert(cwa.UserProfilesAPI)
-      done()
-    })
-  })
-
-  describe('ComputersAPI', () => {
-    it('should return a list of computers', (done) => {
-      cwa.ComputersAPI.getComputerList({ pageSize: 1 })
-        .then((results) => {
-          assert(results.length === 1)
-          const computer = results[0]
-          assert(computer.Id)
-          assert(computer.ComputerName)
-          done()
-        })
-        .catch((error) => done(error))
-    })
-  })
-})
-
 describe('Manage', () => {
   describe('instance', () => {
     it('should be an instance of Manage', (done) => {
@@ -278,10 +165,12 @@ describe('Manage', () => {
       cwm
         .paginate(cwm.CompanyAPI.getCompanyCommunicationTypes, { pageSize: 2, startPage: 1 }, {})
         .then((pagedResults) => {
-          return cwm.CompanyAPI.getCompanyCommunicationTypes().then((unPagedResults) => {
-            assert(unPagedResults.length === pagedResults.length)
-            done()
-          })
+          return cwm.CompanyAPI.getCompanyCommunicationTypes({ pageSize: 50 }).then(
+            (unPagedResults) => {
+              assert(unPagedResults.length === pagedResults.length)
+              done()
+            },
+          )
         })
         .catch((err) => done(err))
     })