connectwise-rest 1.1.0 → 1.2.1

package/.eslintignore

@@ -1 +0,0 @@
-scratch

package/LICENSE.md

@@ -1,7 +1,7 @@
-Copyright (c) 2015 Kevin Grube
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2015-2022 Kevin Grube
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -152,10 +152,10 @@ You can also manually access the API without typings:
 
 ```javascript
 
-    const { Manage, Automate } = require('connectwise-rest');
+    const { ManageAPI, AutomateAPI } = require('connectwise-rest');
 
-    const cwm = new Manage(CWMOptions);
-    const cwa = new Automate(CWAOptions);
+    const cwm = new ManageAPI(CWMOptions);
+    const cwa = new AutomateAPI(CWAOptions);
     
     // use cwa.request or cwm.request
     cwm.request({

package/dist/utils/ReportInterpolate.d.ts

@@ -0,0 +1,7 @@
+import type { ReportDataResponse } from '../Manage/SystemAPI';
+/**
+ * Transform a report column/value response object into an array
+ * @param {ReportDataResponse} args
+ */
+export declare function reportInterpolate(...args: ReportDataResponse[]): Record<string, unknown>[];
+//# sourceMappingURL=ReportInterpolate.d.ts.map

package/dist/utils/ReportInterpolate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReportInterpolate.d.ts","sourceRoot":"","sources":["../../src/utils/ReportInterpolate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAE7D;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,IAAI,EAAE,kBAAkB,EAAE,6BAuB9D"}

package/dist/utils/ReportInterpolate.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reportInterpolate = void 0;
+/**
+ * Transform a report column/value response object into an array
+ * @param {ReportDataResponse} args
+ */
+function reportInterpolate(...args) {
+    const data = args.length > 0 && args[0] !== undefined ? args[0] : { column_definitions: [], row_values: [] };
+    /* report data comes in like this:
+     *  {
+     *    column_definitions: [{ ColumnName: { DataType: 'number', IsNullable: true/false } } ... { ... } ],
+     *    row_values: [ [1, 2, 'some string', '1900-01-01etc', null, null, false, ... ], [ ... ] ]
+     *  }
+     */
+    const column_definitions = data.column_definitions || [];
+    const row_values = data.row_values || [];
+    return row_values.map((rowArray) => {
+        const rowObj = {};
+        rowArray.forEach((value, idx) => {
+            const key = Object.keys(column_definitions[idx])[0];
+            rowObj[key] = value;
+        });
+        return rowObj;
+    });
+    // return an array like: [ { key: value, key2: value2 ... }, ... ]
+}
+exports.reportInterpolate = reportInterpolate;
+//# sourceMappingURL=ReportInterpolate.js.map

package/dist/utils/ReportInterpolate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReportInterpolate.js","sourceRoot":"","sources":["../../src/utils/ReportInterpolate.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,GAAG,IAA0B;IAC7D,MAAM,IAAI,GACR,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAA;IAEjG;;;;;OAKG;IAEH,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAA;IACxD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,CAAA;IAExC,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,QAAwB,EAAE,EAAE;QACjD,MAAM,MAAM,GAA4B,EAAE,CAAA;QAC1C,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACnD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QACrB,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC,CAAC,CAAA;IACF,kEAAkE;AACpE,CAAC;AAvBD,8CAuBC"}

package/dist/utils/index.d.ts

@@ -2,6 +2,7 @@ import type * as SeriesTypes from './Series';
 import type * as CallbackTypes from './Callback';
 import Series from './Series';
 import Callback from './Callback';
+import { reportInterpolate } from './ReportInterpolate';
 export type { SeriesTypes, CallbackTypes };
-export { Series, Callback };
+export { Series, Callback, reportInterpolate };
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,WAAW,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,KAAK,aAAa,MAAM,YAAY,CAAA;AAChD,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,QAAQ,MAAM,YAAY,CAAA;AAEjC,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,WAAW,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,KAAK,aAAa,MAAM,YAAY,CAAA;AAChD,OAAO,MAAM,MAAM,UAAU,CAAA;AAC7B,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAEvD,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,CAAA"}

package/dist/utils/index.js

@@ -3,9 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Callback = exports.Series = void 0;
+exports.reportInterpolate = exports.Callback = exports.Series = void 0;
 const Series_1 = __importDefault(require("./Series"));
 exports.Series = Series_1.default;
 const Callback_1 = __importDefault(require("./Callback"));
 exports.Callback = Callback_1.default;
+const ReportInterpolate_1 = require("./ReportInterpolate");
+Object.defineProperty(exports, "reportInterpolate", { enumerable: true, get: function () { return ReportInterpolate_1.reportInterpolate; } });
 //# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;AAEA,sDAA6B;AAIpB,iBAJF,gBAAM,CAIE;AAHf,0DAAiC;AAGhB,mBAHV,kBAAQ,CAGU"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;AAEA,sDAA6B;AAKpB,iBALF,gBAAM,CAKE;AAJf,0DAAiC;AAIhB,mBAJV,kBAAQ,CAIU;AAHzB,2DAAuD;AAG5B,kGAHlB,qCAAiB,OAGkB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "connectwise-rest",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "A nodejs module for interacting with the ConnectWise Manage and Automate REST APIs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -69,7 +69,7 @@
     "mocha": "^9.2.2",
     "mocha-lcov-reporter": "^1.3.0",
     "nyc": "^15.1.0",
-    "openapi-typescript": "^5.2.0",
+    "openapi-typescript": "^5.4.1",
     "prettier": "^2.6.0",
     "rimraf": "^3.0.2",
     "ts-node": "^10.7.0",

package/src/utils/ReportInterpolate.ts

@@ -0,0 +1,30 @@
+import type { ReportDataResponse } from '../Manage/SystemAPI'
+
+/**
+ * Transform a report column/value response object into an array
+ * @param {ReportDataResponse} args
+ */
+export function reportInterpolate(...args: ReportDataResponse[]) {
+  const data =
+    args.length > 0 && args[0] !== undefined ? args[0] : { column_definitions: [], row_values: [] }
+
+  /* report data comes in like this:
+   *  {
+   *    column_definitions: [{ ColumnName: { DataType: 'number', IsNullable: true/false } } ... { ... } ],
+   *    row_values: [ [1, 2, 'some string', '1900-01-01etc', null, null, false, ... ], [ ... ] ]
+   *  }
+   */
+
+  const column_definitions = data.column_definitions || []
+  const row_values = data.row_values || []
+
+  return row_values.map((rowArray: Array<unknown>) => {
+    const rowObj: Record<string, unknown> = {}
+    rowArray.forEach((value, idx) => {
+      const key = Object.keys(column_definitions[idx])[0]
+      rowObj[key] = value
+    })
+    return rowObj
+  })
+  // return an array like: [ { key: value, key2: value2 ... }, ... ]
+}

package/src/utils/index.ts

@@ -2,6 +2,7 @@ import type * as SeriesTypes from './Series'
 import type * as CallbackTypes from './Callback'
 import Series from './Series'
 import Callback from './Callback'
+import { reportInterpolate } from './ReportInterpolate'
 
 export type { SeriesTypes, CallbackTypes }
-export { Series, Callback }
+export { Series, Callback, reportInterpolate }

package/test/ts-test-utils.ts

@@ -1,27 +0,0 @@
-export type PromiseArray<T> = Array<Promise<T>>
-
-export function isPromise(input: unknown): input is Promise<unknown> {
-  return (
-    !!input &&
-    (typeof input === 'object' || typeof input === 'function') &&
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    typeof input.then === 'function'
-  )
-}
-
-export function isPromiseType(input: unknown): input is Promise<unknown> {
-  return isPromise(input)
-}
-
-export function isArrayOfPromises(input: unknown): input is PromiseArray<unknown> {
-  if (Array.isArray(input)) {
-    if (Array.length === 0) {
-      return true
-    }
-    if (isPromise(input.pop)) {
-      return true
-    }
-  }
-  return false
-}