connectwise-rest 0.25.1 → 1.0.2

package/dist/AutomateTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AutomateTypes.js.map

package/dist/AutomateTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutomateTypes.js","sourceRoot":"","sources":["../src/AutomateTypes.ts"],"names":[],"mappings":""}

package/dist/BaseAPI.d.ts

@@ -0,0 +1,26 @@
+import { RequestOptions } from './types';
+import Manage, { ManageConfig } from './Manage';
+import Automate, { AutomateConfig } from './Automate';
+/**
+ * curried request function
+ * @internal
+ */
+export declare const makeRequest: ({ config, api, thisObj, }: {
+    config: ManageConfig | AutomateConfig;
+    api: (args: RequestOptions) => Promise<unknown>;
+    thisObj: InstanceType<typeof Automate | typeof Manage>;
+}) => (args: RequestOptions) => Promise<unknown>;
+export interface PaginationConfig {
+    thisObj: InstanceType<typeof Automate | typeof Manage>;
+}
+export declare type PaginationApiMethod = Function;
+export declare type PaginationOptions = {
+    pageSize?: number;
+    startPage?: number;
+};
+/**
+ * curried paginate function
+ * @internal
+ */
+export declare const makePaginate: ({ thisObj }: PaginationConfig) => (apiMethod: PaginationApiMethod, paginateArgs?: PaginationOptions, ...methodArgs: Record<string, unknown>[]) => Promise<unknown[]>;
+//# sourceMappingURL=BaseAPI.d.ts.map

package/dist/BaseAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseAPI.d.ts","sourceRoot":"","sources":["../src/BaseAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC,OAAO,MAAM,EAAE,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC/C,OAAO,QAAQ,EAAE,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAGrD;;;GAGG;AACH,eAAO,MAAM,WAAW;YAMZ,YAAY,GAAG,cAAc;gBACzB,cAAc,KAAK,QAAQ,OAAO,CAAC;aACtC,aAAa,eAAe,GAAG,aAAa,CAAC;aAC5C,cAAc,KAAK,QAAQ,OAAO,CAgE7C,CAAA;AAEH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,YAAY,CAAC,OAAO,QAAQ,GAAG,OAAO,MAAM,CAAC,CAAA;CACvD;AAGD,oBAAY,mBAAmB,GAAG,QAAQ,CAAA;AAE1C,oBAAY,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,YAAY,gBACT,gBAAgB,iBAEjB,mBAAmB,iBAChB,iBAAiB,iBAChB,OAAO,MAAM,EAAE,OAAO,CAAC,EAAE,KACvC,QAAQ,OAAO,EAAE,CA6BnB,CAAA"}

package/dist/BaseAPI.js

@@ -0,0 +1,116 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makePaginate = exports.makeRequest = void 0;
+const promise_retry_1 = __importDefault(require("promise-retry"));
+/**
+ * curried request function
+ * @internal
+ */
+const makeRequest = ({ config, api, thisObj, }) => ({ path, method = 'get', params, data }) => {
+    const retryCodes = ['ECONNRESET', 'ETIMEDOUT', 'ESOCKETTIMEDOUT'];
+    const boundApi = api.bind(thisObj);
+    if (!path) {
+        throw new Error('path must be defined.');
+    }
+    let startTime = Date.now();
+    const { retry, retryOptions, logger } = config;
+    if (!retry) {
+        return boundApi({ path, method, params, data })
+            .then((result) => {
+            logger('info', `${method} ${path} ${Date.now() - startTime}ms params=${JSON.stringify(params)}`);
+            return result;
+        })
+            .catch((error) => {
+            logger('error', `${method} ${path} ${Date.now() - startTime}ms params=${JSON.stringify(params)}`, error);
+            throw error;
+        });
+    }
+    else {
+        return (0, promise_retry_1.default)(retryOptions, (retry, number) => {
+            return boundApi({ path, method, params, data }).catch((error) => {
+                logger('warn', `${method} ${path} ${Date.now() - startTime}ms error occurred: ${error.code}, retry=${number}, params=${JSON.stringify(params)}`);
+                startTime = Date.now();
+                if (retryCodes.includes(error.code)) {
+                    return retry(error);
+                }
+                throw error;
+            });
+        })
+            .then((result) => {
+            logger('info', `${method} ${path} ${Date.now() - startTime}ms params=${JSON.stringify(params)}`);
+            return result;
+        })
+            .catch((error) => {
+            logger('error', `${method} ${path} ${Date.now() - startTime}ms error occurred: ${error.code}, params=${JSON.stringify(params)}`, error);
+            throw error;
+        });
+    }
+};
+exports.makeRequest = makeRequest;
+/**
+ * curried paginate function
+ * @internal
+ */
+const makePaginate = ({ thisObj }) => (apiMethod, paginateArgs = {}, ...methodArgs) => {
+    const { startPage = 0, pageSize = 1000 } = paginateArgs;
+    return new Promise(async (resolve, reject) => {
+        let results = [];
+        let page = startPage;
+        if (startPage === undefined || startPage < 1) {
+            page = 0;
+        }
+        while (true) {
+            try {
+                const result = await getPage(apiMethod, methodArgs, thisObj, page++, pageSize);
+                // complete page returned, loop again
+                if (Array.isArray(result) && result.length > 0) {
+                    results = results.concat(result);
+                }
+                else {
+                    // incomplete page, this is the last page of results, exit loop and return
+                    break;
+                }
+            }
+            catch (error) {
+                return reject(error);
+            }
+        }
+        return resolve(results);
+    });
+};
+exports.makePaginate = makePaginate;
+/**
+ * @internal
+ */
+function getPage(apiMethod, methodArgs, thisObj, page = 1, pageSize = 1000) {
+    // Javascript Function.length returns number of non-default values
+    // the method args will always be greater than the api method args
+    // due to this, if params is not passed in, even as an empty object,
+    // we need to throw an error
+    if (methodArgs.length < apiMethod.length) {
+        throw new Error(`CommonParams must be passed in for pagination to work properly for function ${apiMethod.name}`);
+    }
+    // look for CommonParams and inject page and pageSize
+    // check for apiMethod function args length
+    // get last arg
+    const commonParams = methodArgs.pop();
+    commonParams.page = page;
+    commonParams.pageSize = pageSize;
+    methodArgs.push(commonParams);
+    return apiMethod.apply(thisObj, methodArgs);
+}
+/**
+ * @internal
+ */
+function isCommonParametersLike(input) {
+    if (typeof input === 'object' && input !== null) {
+        return true;
+    }
+    else {
+        return false;
+    }
+}
+//# sourceMappingURL=BaseAPI.js.map

package/dist/BaseAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseAPI.js","sourceRoot":"","sources":["../src/BaseAPI.ts"],"names":[],"mappings":";;;;;;AACA,kEAAwC;AAKxC;;;GAGG;AACI,MAAM,WAAW,GACtB,CAAC,EACC,MAAM,EACN,GAAG,EACH,OAAO,GAKR,EAAgD,EAAE,CACnD,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,EAAE,MAAM,EAAE,IAAI,EAAkB,EAAoB,EAAE;IAC3E,MAAM,UAAU,GAAG,CAAC,YAAY,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAA;IACjE,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAElC,IAAI,CAAC,IAAI,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;KACzC;IAED,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IAC1B,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IAE9C,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;aAC5C,IAAI,CAAC,CAAC,MAAW,EAAE,EAAE;YACpB,MAAM,CACJ,MAAM,EACN,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CACjF,CAAA;YACD,OAAO,MAAM,CAAA;QACf,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAA0C,EAAE,EAAE;YACpD,MAAM,CACJ,OAAO,EACP,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EAChF,KAAK,CACN,CAAA;YACD,MAAM,KAAK,CAAA;QACb,CAAC,CAAC,CAAA;KACL;SAAM;QACL,OAAO,IAAA,uBAAY,EAAC,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAClD,OAAO,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC9D,MAAM,CACJ,MAAM,EACN,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,sBACzC,KAAK,CAAC,IACR,WAAW,MAAM,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CACtD,CAAA;gBACD,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;gBACtB,IAAI,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;oBACnC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAA;iBACpB;gBACD,MAAM,KAAK,CAAA;YACb,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC;aACC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,MAAM,CACJ,MAAM,EACN,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CACjF,CAAA;YAED,OAAO,MAAM,CAAA;QACf,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,MAAM,CACJ,OAAO,EACP,GAAG,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,sBACzC,KAAK,CAAC,IACR,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EACpC,KAAK,CACN,CAAA;YACD,MAAM,KAAK,CAAA;QACb,CAAC,CAAC,CAAA;KACL;AACH,CAAC,CAAA;AAzEU,QAAA,WAAW,eAyErB;AAcH;;;GAGG;AACI,MAAM,YAAY,GACvB,CAAC,EAAE,OAAO,EAAoB,EAAE,EAAE,CAClC,CACE,SAA8B,EAC9B,eAAkC,EAAE,EACpC,GAAG,UAAqC,EACpB,EAAE;IACtB,MAAM,EAAE,SAAS,GAAG,CAAC,EAAE,QAAQ,GAAG,IAAI,EAAE,GAAG,YAAY,CAAA;IAEvD,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,OAAO,GAAc,EAAE,CAAA;QAE3B,IAAI,IAAI,GAAG,SAAS,CAAA;QAEpB,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,GAAG,CAAC,EAAE;YAC5C,IAAI,GAAG,CAAC,CAAA;SACT;QAED,OAAO,IAAI,EAAE;YACX,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,QAAQ,CAAC,CAAA;gBAC9E,qCAAqC;gBACrC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC9C,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;iBACjC;qBAAM;oBACL,0EAA0E;oBAC1E,MAAK;iBACN;aACF;YAAC,OAAO,KAAc,EAAE;gBACvB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;aACrB;SACF;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,CAAA;IACzB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAnCU,QAAA,YAAY,gBAmCtB;AAEH;;GAEG;AACH,SAAS,OAAO,CACd,SAA8B,EAC9B,UAAqC,EACrC,OAAsD,EACtD,IAAI,GAAG,CAAC,EACR,QAAQ,GAAG,IAAI;IAEf,kEAAkE;IAClE,kEAAkE;IAClE,oEAAoE;IACpE,4BAA4B;IAC5B,IAAI,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE;QACxC,MAAM,IAAI,KAAK,CACb,+EAA+E,SAAS,CAAC,IAAI,EAAE,CAChG,CAAA;KACF;IAED,qDAAqD;IACrD,2CAA2C;IAC3C,eAAe;IACf,MAAM,YAAY,GAAqB,UAAU,CAAC,GAAG,EAAE,CAAA;IACvD,YAAY,CAAC,IAAI,GAAG,IAAI,CAAA;IACxB,YAAY,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAEhC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IAE7B,OAAO,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;AAC7C,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,KAAc;IAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;QAC/C,OAAO,IAAI,CAAA;KACZ;SAAM;QACL,OAAO,KAAK,CAAA;KACb;AACH,CAAC"}