connectwise-rest 0.25.1 → 1.0.2

package/src/Manage.ts

@@ -0,0 +1,161 @@
+import axios, { AxiosError, AxiosInstance, AxiosResponse } from 'axios'
+import { makeRequest, makePaginate, PaginationOptions, PaginationApiMethod } from './BaseAPI'
+import promiseRetry from 'promise-retry'
+import type { CWMOptions } from './ManageAPI'
+import { CWLogger, DataResponse, ErrorResponse, RequestOptions, RetryOptions } from './types'
+
+const CW_MANAGE_DEBUG = !!process.env.CW_MANAGE_DEBUG
+
+export const DEFAULTS: {
+  retryOptions: RetryOptions
+  apiPath: string
+  logger: (debug: boolean) => CWLogger
+} = {
+  apiPath: '/apis/3.0',
+  retryOptions: {
+    retries: 4,
+    minTimeout: 50,
+    maxTimeout: 20000,
+    randomize: true,
+  },
+  logger:
+    (debug = false) =>
+    (level, text, meta) => {
+      switch (level) {
+        case 'error':
+          console.error(`${level}: ${text}`, meta)
+          return
+        case 'warn':
+          if (debug) {
+            console.log(`${level}: ${text}`, meta)
+          }
+          return
+        case 'info': {
+          if (debug) {
+            console.info(`${level}: ${text}`, meta)
+          }
+          return
+        }
+        default:
+          console.log(`${level}: ${text}`, meta)
+          return
+      }
+    },
+}
+
+export interface ManageConfig extends CWMOptions {
+  authorization: string
+  entryPoint: string
+  timeout: number
+  apiVersion: string
+  retry: boolean
+  retryOptions: RetryOptions
+  logger: CWLogger
+  debug: boolean
+}
+
+/**
+ * @internal
+ */
+export default class Manage {
+  config: ManageConfig
+  private instance: AxiosInstance
+  /**
+   * @public
+   */
+  request: (args: RequestOptions) => Promise<any>
+  /**
+   * @public
+   */
+  paginate: (
+    apiMethod: PaginationApiMethod,
+    paginateArgs: PaginationOptions,
+    ...methodArgs: Record<string, unknown>[]
+  ) => Promise<unknown[]>
+
+  constructor({
+    companyId,
+    publicKey,
+    privateKey,
+    companyUrl,
+    clientId,
+    entryPoint = 'v4_6_release',
+    timeout = 20000,
+    apiVersion = '2021.1',
+    retry = false,
+    retryOptions = DEFAULTS.retryOptions,
+    logger,
+    debug = false,
+  }: CWMOptions) {
+    if (!companyId || !publicKey || !privateKey || !companyUrl || !clientId) {
+      throw new Error('Missing options [companyId, publicKey, privateKey, companyUrl, clientId]')
+    }
+
+    this.config = {
+      companyId,
+      publicKey,
+      privateKey,
+      companyUrl,
+      clientId,
+      entryPoint,
+      apiVersion,
+      retry,
+      timeout,
+      logger: logger ? logger : DEFAULTS.logger(debug || CW_MANAGE_DEBUG),
+      debug: debug || CW_MANAGE_DEBUG,
+      retryOptions: {
+        ...DEFAULTS.retryOptions,
+        ...retryOptions,
+      },
+      authorization: `Basic ${Buffer.from(`${companyId}+${publicKey}:${privateKey}`).toString(
+        'base64',
+      )}`,
+    }
+
+    this.instance = axios.create({
+      timeout,
+      baseURL: `https://${companyUrl}/${entryPoint}${DEFAULTS.apiPath}`,
+      headers: {
+        Accept: `application/vnd.connectwise.com+json; version=${apiVersion}, application/json`,
+        'Cache-Control': 'no-cache',
+        Authorization: this.config.authorization,
+        clientId: this.config.clientId,
+      },
+    })
+
+    this.request = makeRequest({ config: this.config, api: this.api, thisObj: this })
+    this.paginate = makePaginate({ thisObj: this })
+  }
+
+  /**
+   * @internal
+   */
+  private async api({
+    path,
+    method,
+    params,
+    data,
+  }: RequestOptions): Promise<ErrorResponse | DataResponse> {
+    try {
+      const result = await this.instance({
+        url: path,
+        method,
+        params,
+        data,
+      })
+
+      return result?.data
+    } catch (error: any) {
+      if (error.isAxiosError) {
+        throw {
+          status: error.response?.status,
+          data: error.response?.data,
+          message: error?.message,
+        }
+      }
+
+      // something else catastrophic went wrong
+      throw error
+    }
+  }
+}

package/src/ManageAPI.ts

@@ -0,0 +1,170 @@
+import Manage from './Manage'
+import { CompanyAPI } from './Manage/CompanyAPI'
+import { ConfigurationsAPI } from './Manage/ConfigurationsAPI'
+import { ExpenseAPI } from './Manage/ExpenseAPI'
+import { FinanceAPI } from './Manage/FinanceAPI'
+import { MarketingAPI } from './Manage/MarketingAPI'
+import { ProcurementAPI } from './Manage/ProcurementAPI'
+import { ProjectAPI } from './Manage/ProjectAPI'
+import { SalesAPI } from './Manage/SalesAPI'
+import { ScheduleAPI } from './Manage/ScheduleAPI'
+import { ServiceAPI } from './Manage/ServiceAPI'
+import { SystemAPI } from './Manage/SystemAPI'
+import { TimeAPI } from './Manage/TimeAPI'
+import type * as CompanyAPITypes from './Manage/CompanyAPI'
+import type * as ConfigurationsAPITypes from './Manage/ConfigurationsAPI'
+import type * as ExpenseAPITypes from './Manage/ExpenseAPI'
+import type * as FinanceAPITypes from './Manage/FinanceAPI'
+import type * as MarketingAPITypes from './Manage/MarketingAPI'
+import type * as ProcurementAPITypes from './Manage/ProcurementAPI'
+import type * as ProjectAPITypes from './Manage/ProjectAPI'
+import type * as SalesAPITypes from './Manage/SalesAPI'
+import type * as ScheduleAPITypes from './Manage/ScheduleAPI'
+import type * as ServiceAPITypes from './Manage/ServiceAPI'
+import type * as SystemAPITypes from './Manage/SystemAPI'
+import type * as TimeAPITypes from './Manage/TimeAPI'
+import { CWLogger, RetryOptions } from './types'
+
+/**
+ * @public
+ * Manage patch operation input object, usually passed in an array of operations
+ */
+export type PatchOperation = {
+  op: 'add' | 'replace' | 'remove'
+  path: string
+  value: Record<string, unknown> | Record<string, unknown>[] | string | null
+}
+
+/**
+ * @public
+ * Manage common parameters
+ */
+export type CommonParameters = {
+  conditions?: string
+  childConditions?: string
+  customFieldConditions?: string
+  orderBy?: string
+  fields?: string
+  page?: number
+  pageSize?: number
+  pageId?: number
+}
+
+/**
+ * @public
+ */
+export interface CWMOptions {
+  /**
+   * Your CW Manage Company ID
+   */
+  companyId: string
+  /**
+   * api public key
+   */
+  publicKey: string
+  /**
+   * api private key
+   */
+  privateKey: string
+  /**
+   * Your CW Manage instance URI
+   * e.g. my.domain.com
+   */
+  companyUrl: string
+  /**
+   * Request a client ID from developer.connectwise.com
+   */
+  clientId: string
+  /**
+   * Defaults to 'v4_6_release'
+   */
+  entryPoint?: string
+  /**
+   * Default timeout in milliseconds
+   */
+  timeout?: number
+  /**
+   * Api version, defaults to 2021.1
+   */
+  apiVersion?: string
+  /**
+   * Enable automatic retry.  Defaults to false.
+   */
+  retry?: boolean
+  /**
+   * @see {@link RetryOptions} type
+   */
+  retryOptions?: RetryOptions
+  /**
+   * Pass in a custom logger function, otherwise the default
+   * will be used
+   * @example
+   * ```js
+   * const logger = (level, text, meta) => console.log(level, text, meta)
+   * ```
+   */
+  logger?: CWLogger
+
+  /**
+   * Enable debug output.  Defaults to false.
+   */
+  debug?: boolean
+}
+
+/**
+ * @public
+ */
+class ManageAPI extends Manage {
+  CompanyAPI: CompanyAPI
+  ConfigurationsAPI: ConfigurationsAPI
+  ExpenseAPI: ExpenseAPI
+  FinanceAPI: FinanceAPI
+  MarketingAPI: MarketingAPI
+  ProcurementAPI: ProcurementAPI
+  ProjectAPI: ProjectAPI
+  SalesAPI: SalesAPI
+  ScheduleAPI: ScheduleAPI
+  ServiceAPI: ServiceAPI
+  SystemAPI: SystemAPI
+  TimeAPI: TimeAPI
+
+  constructor(options: CWMOptions) {
+    super(options)
+
+    this.CompanyAPI = new CompanyAPI(options)
+    this.ConfigurationsAPI = new ConfigurationsAPI(options)
+    this.ExpenseAPI = new ExpenseAPI(options)
+    this.FinanceAPI = new FinanceAPI(options)
+    this.MarketingAPI = new MarketingAPI(options)
+    this.ProcurementAPI = new ProcurementAPI(options)
+    this.ProjectAPI = new ProjectAPI(options)
+    this.SalesAPI = new SalesAPI(options)
+    this.ScheduleAPI = new ScheduleAPI(options)
+    this.ServiceAPI = new ServiceAPI(options)
+    this.SystemAPI = new SystemAPI(options)
+    this.TimeAPI = new TimeAPI(options)
+  }
+}
+
+/**
+ * @public
+ */
+export default ManageAPI
+
+/**
+ * @public
+ */
+export type {
+  CompanyAPITypes,
+  ConfigurationsAPITypes,
+  ExpenseAPITypes,
+  FinanceAPITypes,
+  MarketingAPITypes,
+  ProcurementAPITypes,
+  ProjectAPITypes,
+  SalesAPITypes,
+  ScheduleAPITypes,
+  ServiceAPITypes,
+  SystemAPITypes,
+  TimeAPITypes,
+}