connectwise-rest 0.23.3 → 1.0.0

package/src/Automate.ts

@@ -0,0 +1,216 @@
+import axios, { AxiosInstance, AxiosError } from 'axios'
+import { CWLogger, DataResponse, ErrorResponse, RequestOptions, RetryOptions } from './types'
+import { CWAOptions } from './AutomateAPI'
+import { components } from './AutomateTypes'
+import { makeRequest } from './BaseAPI'
+type schemas = components['schemas']
+type TokenResult = schemas['Automate.Api.Domain.Contracts.Security.TokenResult']
+
+const CW_AUTOMATE_DEBUG = !!process.env.CW_AUTOMATE_DEBUG
+
+export const DEFAULTS: {
+  entryPoint: string
+  retryOptions: RetryOptions
+  logger: (debug: boolean) => CWLogger
+} = {
+  entryPoint: 'cwa',
+  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 AutomateConfig extends CWAOptions {
+  logger: CWLogger
+  retry: boolean
+  retryOptions: RetryOptions
+}
+
+/**
+ * @internal
+ */
+export default class Automate {
+  config: AutomateConfig
+  private instance: AxiosInstance
+  /**
+   * @public
+   */
+  request: (args: RequestOptions) => Promise<any>
+
+  constructor({
+    serverUrl,
+    username,
+    password,
+    twoFactorPasscode,
+    token,
+    clientId,
+    timeout = 20000,
+    retry = false,
+    retryOptions = DEFAULTS.retryOptions,
+    logger,
+    debug,
+  }: CWAOptions) {
+    if (token && username && password) {
+      throw new Error(
+        'Authenticate with token or username and password only, do not pass both methods',
+      )
+    }
+
+    if (!token && !username && !password) {
+      throw new Error('Missing options [token] or [username, password]')
+    }
+
+    if (!clientId) {
+      throw new Error('Missing option [clientId]')
+    }
+
+    this.config = {
+      serverUrl,
+      username,
+      password,
+      twoFactorPasscode,
+      clientId,
+      timeout,
+      retry,
+      retryOptions: { ...DEFAULTS.retryOptions, ...retryOptions },
+      logger: logger ? logger : DEFAULTS.logger(debug || CW_AUTOMATE_DEBUG),
+      debug: debug || CW_AUTOMATE_DEBUG,
+    }
+
+    this.instance = axios.create()
+
+    if (token) {
+      this.config.token = token
+      this.createAxiosInstance()
+    }
+
+    this.request = makeRequest({ config: this.config, api: this.api, thisObj: this })
+  }
+
+  get token() {
+    return this.config.token
+  }
+
+  set token(token) {
+    this.config.token = token
+  }
+
+  static async getToken({
+    username,
+    password,
+    twoFactorPasscode,
+    serverUrl,
+  }: {
+    username?: string
+    password?: string
+    twoFactorPasscode?: string
+    serverUrl: string
+  }): Promise<TokenResult> {
+    const result = await axios.post(`https://${serverUrl}/${DEFAULTS.entryPoint}/api/v1/apitoken`, {
+      username,
+      password,
+      twoFactorPasscode,
+    })
+
+    return result.data
+  }
+
+  static async refreshToken({
+    username,
+    password,
+    serverUrl,
+  }: {
+    username: string
+    password: string
+    serverUrl: string
+  }) {
+    // @todo how
+  }
+
+  async verifyToken() {
+    try {
+      const result = await this.api({ path: '/api/v1/FeatureFlags', method: 'get' })
+      return true
+    } catch (err) {
+      return false
+    }
+  }
+
+  /**
+   * @internal
+   */
+  private async api({
+    path,
+    method,
+    params,
+    data,
+  }: RequestOptions): Promise<ErrorResponse | DataResponse> {
+    const { username, password, serverUrl, twoFactorPasscode } = this.config
+    if (!this.config.token || !this.instance) {
+      const result = await Automate.getToken({ username, password, serverUrl, twoFactorPasscode })
+      this.config.token = result.AccessToken
+      this.createAxiosInstance()
+    }
+
+    try {
+      const result = await this.instance({
+        url: path,
+        method,
+        params,
+        data,
+      })
+
+      return result?.data
+    } catch (error: any) {
+      if (error.isAxiosError()) {
+        return {
+          status: error.response?.status,
+          data: error.response?.data,
+          message: error?.message,
+        }
+      }
+
+      // something else catastrophic went wrong
+      throw error
+    }
+  }
+
+  private createAxiosInstance() {
+    const { serverUrl, timeout, clientId } = this.config
+    this.instance = axios.create({
+      timeout,
+      baseURL: `https://${serverUrl}/${DEFAULTS.entryPoint}`,
+      headers: {
+        Accept: `application/json`,
+        'Cache-Control': 'no-cache',
+        Authorization: `Bearer ${this.config.token}`,
+        clientId,
+      },
+    })
+  }
+}

package/src/AutomateAPI.ts

@@ -0,0 +1,144 @@
+import Automate from './Automate'
+import { CWLogger, RetryOptions } from './types'
+import AVTemplatePoliciesAPI from './Automate/AVTemplatePoliciesAPI'
+import ClientsAPI from './Automate/ClientsAPI'
+import CommandsAPI from './Automate/CommandsAPI'
+import ComputersAPI from './Automate/ComputersAPI'
+import ContactsAPI from './Automate/ContactsAPI'
+import DataViewsAPI from './Automate/DataViewsAPI'
+import DrivesAPI from './Automate/DrivesAPI'
+import EventLogsAPI from './Automate/EventLogsAPI'
+import LocationsAPI from './Automate/LocationsAPI'
+import MaintenanceWindowDefinitionsAPI from './Automate/MaintenanceWindowDefinitionsAPI'
+import MonitorsAPI from './Automate/MonitorsAPI'
+import NetworkDevicesAPI from './Automate/NetworkDevicesAPI'
+import PatchingAPI from './Automate/PatchingAPI'
+import RemoteAgentAPI from './Automate/RemoteAgentAPI'
+import ScriptingAPI from './Automate/ScriptingAPI'
+import SearchesAPI from './Automate/SearchesAPI'
+import SystemAPI from './Automate/SystemAPI'
+import TicketAPI from './Automate/TicketsAPI'
+import UserProfilesAPI from './Automate/UserProfilesAPI'
+
+export type {
+  AVTemplatePoliciesAPI,
+  ClientsAPI,
+  CommandsAPI,
+  ComputersAPI,
+  ContactsAPI,
+  DataViewsAPI,
+  DrivesAPI,
+  EventLogsAPI,
+  LocationsAPI,
+  MaintenanceWindowDefinitionsAPI,
+  MonitorsAPI,
+  NetworkDevicesAPI,
+  PatchingAPI,
+  RemoteAgentAPI,
+  ScriptingAPI,
+  SearchesAPI,
+  SystemAPI,
+  TicketAPI,
+  UserProfilesAPI,
+}
+
+/**
+ * @public
+ */
+export type CWAOptions = {
+  serverUrl: string
+  username?: string
+  password?: string
+  twoFactorPasscode?: string
+  token?: string
+  clientId: string
+  timeout?: number
+  retry?: boolean
+  retryOptions?: RetryOptions
+  logger?: CWLogger
+  debug?: boolean
+}
+
+export type OrderBy = {
+  name?: string
+  type?: 'Undefined' | 'Ascending' | 'Descending'
+}
+
+/**
+ * @public
+ */
+export type CommonParameters = {
+  orderBy?: OrderBy
+  page?: number
+  pageSize?: number
+  condition?: string
+  expands?: {
+    [key: string]: QueryOptionExpand
+  }
+  includedFields?: Array<string>
+  excludedFields?: Array<string>
+  ids?: Array<string>
+  timeout?: number
+}
+
+export type QueryOptionExpand = {
+  fieldName?: string
+  page?: number
+  pageSize?: number
+  condition?: string
+  expands?: {
+    [key: string]: QueryOptionExpand
+  }
+  orderBy?: OrderBy
+  includedFields?: string[]
+  excludedFields?: string[]
+}
+
+/**
+ * @public
+ */
+export default class AutomateAPI extends Automate {
+  AVTemplatePoliciesAPI: AVTemplatePoliciesAPI
+  ClientsAPI: ClientsAPI
+  CommandsAPI: CommandsAPI
+  ComputersAPI: ComputersAPI
+  ContactsAPI: ContactsAPI
+  DataViewsAPI: DataViewsAPI
+  DrivesAPI: DrivesAPI
+  EventLogsAPI: EventLogsAPI
+  LocationsAPI: LocationsAPI
+  MaintenanceWindowDefinitionsAPI: MaintenanceWindowDefinitionsAPI
+  MonitorsAPI: MonitorsAPI
+  NetworkDevicesAPI: NetworkDevicesAPI
+  PatchingAPI: PatchingAPI
+  RemoteAgentAPI: RemoteAgentAPI
+  ScriptingAPI: ScriptingAPI
+  SearchesAPI: SearchesAPI
+  SystemAPI: SystemAPI
+  TicketAPI: TicketAPI
+  UserProfilesAPI: UserProfilesAPI
+
+  constructor(options: CWAOptions) {
+    super(options)
+
+    this.AVTemplatePoliciesAPI = new AVTemplatePoliciesAPI(options)
+    this.ClientsAPI = new ClientsAPI(options)
+    this.CommandsAPI = new CommandsAPI(options)
+    this.ComputersAPI = new ComputersAPI(options)
+    this.ContactsAPI = new ContactsAPI(options)
+    this.DataViewsAPI = new DataViewsAPI(options)
+    this.DrivesAPI = new DrivesAPI(options)
+    this.EventLogsAPI = new EventLogsAPI(options)
+    this.LocationsAPI = new LocationsAPI(options)
+    this.MaintenanceWindowDefinitionsAPI = new MaintenanceWindowDefinitionsAPI(options)
+    this.MonitorsAPI = new MonitorsAPI(options)
+    this.NetworkDevicesAPI = new NetworkDevicesAPI(options)
+    this.PatchingAPI = new PatchingAPI(options)
+    this.RemoteAgentAPI = new RemoteAgentAPI(options)
+    this.ScriptingAPI = new ScriptingAPI(options)
+    this.SearchesAPI = new SearchesAPI(options)
+    this.SystemAPI = new SystemAPI(options)
+    this.TicketAPI = new TicketAPI(options)
+    this.UserProfilesAPI = new UserProfilesAPI(options)
+  }
+}