autoinspector 1.0.0

package/resources/HTTPClient.ts

@@ -0,0 +1,97 @@
+import axios, { AxiosResponse } from 'axios';
+import { IHeaders, IHTTPClient, IMakeRequest } from '../types/http';
+
+/**
+ * @classdesc Represents the class that implements some HTTP client third library. It's an extra layer for in case if we need to change the implementation be one hundred percent sure we can do it without problems.
+ * @class
+ */
+export class HTTPClient {
+  private headers: IHeaders = {};
+  private timeout: number;
+  private baseURL: string;
+  private pathPrefix: string;
+
+  /**
+   * Create HTTPClient instance to start making request in another class.
+   * @constructor
+   * @param input - An object with common parameters that we need to set in the http client third party library.
+   * @param {Object} input.headers - An object with the headers to send in each makeRequest() call.
+   * @param {Object} input.timeout - The timeout that each request will have. That means, the time in milliseconds maximum that request will wait until cancel it.
+   * @param {Object} input.baseURL - The baseURL to make the requests.
+   */
+  constructor(input: IHTTPClient) {
+    this.headers = input.headers;
+    this.timeout = input.timeout;
+    this.baseURL = input.baseURL;
+    this.pathPrefix = input.pathPrefix;
+  }
+
+  /**
+   * Make a request to a specific endpoint.
+   * @param input - An object that contains the essential information make the request.
+   * @param {Object} input.method - Represents the method of the http request.
+   * @param {Object} input.path - Represents the path where the request will take place.
+   * @param {String} input.body - Represents the body to send. It only will be sended if input.method is not `GET`.
+   * @param {String} input.params - Represents the query parameters to send in the request. It only will be sended if input.method is `GET`.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  public makeRequest(input: IMakeRequest): Promise<any> {
+    const path = `${this.baseURL}${this.pathPrefix}${input.path}`;
+
+    const options = {
+      headers: {
+        ...input.headers,
+        ...this.headers,
+      },
+      params: input.params,
+      timeout: this.timeout,
+    };
+
+    switch (input.method) {
+      case 'GET':
+        return axios
+          .get(path, options)
+          .then((res: AxiosResponse<any>) => {
+            return res.data;
+          })
+          .catch((err) => this.handleError(err));
+
+      case 'PUT':
+        return axios
+          .put(path, input.body, options)
+          .then((res: AxiosResponse<any>) => {
+            return res.data;
+          })
+          .catch((err) => this.handleError(err));
+
+      case 'POST':
+        return axios
+          .post(path, input.body, options)
+          .then((res: AxiosResponse<any>) => {
+            return res.data;
+          })
+          .catch((err) => this.handleError(err));
+
+      case 'DELETE':
+        return axios
+          .post(path, input.body, options)
+          .then((res: AxiosResponse<any>) => {
+            return res.data;
+          })
+          .catch((err) => this.handleError(err));
+    }
+  }
+
+  private handleError(err: any) {
+    const isAxiosError = axios.isAxiosError(err);
+
+    if (isAxiosError) {
+      return Promise.reject(err.response?.data);
+    }
+
+    if (!isAxiosError) {
+      return Promise.reject(err);
+    }
+  }
+}

package/resources/Helper.ts

@@ -0,0 +1,13 @@
+import { IHeaders } from '../types/http';
+
+export class Helper {
+  static buildOptionalHeaders(accessToken?: string): IHeaders | undefined {
+    if (accessToken) {
+      return {
+        Authorization: `Bearer ${accessToken}`,
+      };
+    }
+
+    return;
+  }
+}

package/resources/Image.ts

@@ -0,0 +1,45 @@
+import { IAPISucessResponse } from '../types/api';
+import { IUploadImage } from '../types/image';
+import { HTTPClient } from './HTTPClient';
+import FormData from 'form-data';
+
+export abstract class Image {
+  constructor(private readonly httpRef: HTTPClient) {}
+
+  /**
+   * Upload an image for specific product inspection item. For the moment, this method is only available for the inspection with mode full_control.
+   * @param input - An object that contains the essential information for upload the image.
+   * @param {String} input.productId - Represents the id of the product that you would like to attach a new photo.
+   * @param {Buffer} input.image - Represents the image to upload.
+   * @param {String} input.side - Represents the side of the image/photo to upload.
+   * @param {String} input.date - Represents the date when the photo was taken.
+   * @param {Object} input.coordinates - Represents the coordinates of the image/photo.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  uploadImage(input: IUploadImage): Promise<IAPISucessResponse> {
+    const form = new FormData();
+
+    form.append('side', input.side);
+    form.append('image', input.image);
+
+    if (input.coordinates) {
+      form.append('coordinates', JSON.stringify(input.coordinates));
+    }
+
+    if (input.date) {
+      form.append('date', input.date.toISOString());
+    }
+
+    console.log('FORM DATA!', form);
+
+    return this.httpRef.makeRequest({
+      method: 'POST',
+      path: `/inspection/image/${input.productId}`,
+      body: form,
+      headers: {
+        ...form.getHeaders(),
+      },
+    });
+  }
+}

package/resources/Inspections.ts

@@ -0,0 +1,77 @@
+import { IAPISucessResponse } from '../types/api';
+import { IFinishInspection, IGetInspection, IInspection } from '../types/inspection';
+import { IPagination, IPaginationResponse } from '../types/pagination';
+import { Goods } from './Goods';
+import { HTTPClient } from './HTTPClient';
+import { Machinery } from './Machinery';
+import { People } from './People';
+import { Vehicle } from './Vehicle';
+
+/**
+ * @classdesc Represents the class that contains the methods or actions that somebody can do using apikey and access_token.
+ * @class
+ */
+export class Inspections {
+  public machinery: Machinery;
+  public people: People;
+  public goods: Goods;
+  public vehicle: Vehicle;
+
+  constructor(private readonly httpClient: HTTPClient) {
+    this.machinery = new Machinery(httpClient);
+    this.people = new People(httpClient);
+    this.goods = new Goods(httpClient);
+    this.vehicle = new Vehicle(httpClient);
+  }
+
+  /**
+   * Finish the inspection to indicate that it will not receive more photos/images.
+   * @param input - An object that contains the essential information for upload the image.
+   * @param {String} input.inspectionId - Represents the id of the inspection.
+   * @param {Buffer} input.image - Represents the image to upload.
+   * @param {String} input.side - Represents the side of the image/photo to upload.
+   * @param {String} input.date - Represents the date when the photo was taken.
+   * @param {Object} input.coordinates - Represents the coordinates of the image/photo.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  finishInspection(input: IFinishInspection): Promise<IAPISucessResponse> {
+    return this.httpClient.makeRequest({
+      method: 'POST',
+      path: `/inspection/finish/${input.inspectionId}`,
+      body: {},
+    });
+  }
+
+  /**
+   * Get a specific inspection object.
+   * @param input - An object that contains the essential information for upload the image.
+   * @param {String} input.inspectionId - Represents the id of the inspection that you want to retrieve.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  getInspection(input: IGetInspection): Promise<IInspection> {
+    return this.httpClient.makeRequest({
+      method: 'GET',
+      path: `/inspection/${input.inspectionId}`,
+    });
+  }
+
+  /**
+   * Get a list of n inspections with pagination.
+   * @param input - An object that contains filters for list the inspections.
+   * @param {Number} input.page - Represents the specific page that you want to retrieve the inspections.
+   * @param {Number} input.limit - Represents the limit of the quantity of records that you want to retrieve for page.
+   * @param {String} input.status - Represents the status that inspections retrieved should have.
+   * @param {String} input.type - Represents the type that inspections retrieved should have.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  listInspections(input: Partial<IPagination> = {}): Promise<IPaginationResponse<IInspection[]>> {
+    return this.httpClient.makeRequest({
+      method: 'GET',
+      path: `/inspection`,
+      params: input,
+    });
+  }
+}

package/resources/Machinery.ts

@@ -0,0 +1,56 @@
+import { IUpdateResourceResponse } from '../types/api';
+import { ICreateInspectionOutput } from '../types/inspection';
+import { ICreateMachineryInspection, IUpdateMachineryInspection } from '../types/machinery';
+import { IProductMethods } from '../types/productMethods';
+import { Helper } from './Helper';
+import { HTTPClient } from './HTTPClient';
+import { Image } from './Image';
+
+/**
+ * @classdesc Represents the class that handle all the requests related to an inspection of type machinery.
+ * @class
+ */
+export class Machinery extends Image implements IProductMethods {
+  constructor(private readonly httpClient: HTTPClient) {
+    super(httpClient);
+  }
+
+  /**
+   * Create an inspection of type machinery
+   * @param input - An object that contains the essential information for create an inspection.
+   * @param {Object} input.consumer - Represents the consumer who will do the inspection.
+   * @param {Object} input.machinery - Represents the machinery to be attached to the inspection.
+   * @param {String} input.mode - Represents the mode of the inspection. See more details: {@link https://www.autoinspector.com.ar/docs/api/start#inspection_mode}
+   * @param {String} input.kindOf - Represents the template that inspection will have. This only matters if the input.mode is normal.
+   * @param {Object} input.metadata - Represents a dinamic object where you can store any key-value pairs.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  create(input: ICreateMachineryInspection): Promise<ICreateInspectionOutput> {
+    return this.httpClient.makeRequest({
+      method: 'POST',
+      path: `/inspection/machinery`,
+      body: input,
+      headers: Helper.buildOptionalHeaders(input.accessToken),
+    });
+  }
+
+  /**
+   * Update a machinery inspection.
+   * @param input - An object with the values to update.
+   * @param {Object} input.consumer - Represents the consumer who will do the inspection.
+   * @param {String} input.productId - Represents the unique identifier of the machinery.
+   * @param {Object} input.machinery - Represents the machinery to be attached to the inspection.
+   * @param {Object} input.metadata - Represents a dinamic object where you can store any key-value pairs.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  update(input: IUpdateMachineryInspection): Promise<IUpdateResourceResponse> {
+    return this.httpClient.makeRequest({
+      method: 'PUT',
+      path: `/inspection/machinery/${input.productId}`,
+      body: input,
+      headers: Helper.buildOptionalHeaders(input.accessToken),
+    });
+  }
+}

package/resources/OAuth20.ts

@@ -0,0 +1,69 @@
+import {
+  IExchangeCodeForAccessToken,
+  IExchangeCodeForAccessTokenOutput,
+  IOAuth20Credentials,
+  IRefreshAccessToken,
+  IRefreshAccessTokenOutput,
+} from '../types/oauth20';
+import { HTTPClient } from './HTTPClient';
+import { OAuthUser } from './OAuthUser';
+
+/**
+ * @classdesc Represents the class that has the responsability for make the request to every endpoint about oauth.
+ * @class
+ */
+export class OAuth20 {
+  private credentials: Partial<IOAuth20Credentials>;
+  public user: OAuthUser;
+
+  /**
+   * Create OAuth20 instance to implement and execute methods in another class.
+   * @constructor
+   * @param httpClient - The httpClient that needs to be injected in the constructor. This is done by this way for inherit the http configuration from the Autoinspector constructor.
+   * @param credentials - An object with the neccessary credentials for interact with oauth endpoints.
+   * @param {String} credentials.clientappId - Represents the identification value that is generated when register an application into Autoinspector Dashboard.
+   * @param {String} credentials.clientSecret - Represents the token that is generated when register an application in Autoinspector Dashboard. It's an sensitive key. so it will only be exported/used in back channel.
+   */
+  constructor(private readonly httpClient: HTTPClient, credentials: Partial<IOAuth20Credentials>) {
+    this.credentials = credentials;
+    this.user = new OAuthUser(httpClient);
+  }
+
+  /**
+   * Exchange some authorization code for a valid access_token.
+   * @param input - An object that contains the essential information for make the trade.
+   * @param {String} input.code - Represents the code received from Autoinspector in callbackURL.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  exchangeCodeForAccessToken(
+    input: IExchangeCodeForAccessToken
+  ): Promise<IExchangeCodeForAccessTokenOutput> {
+    return this.httpClient.makeRequest({
+      method: 'POST',
+      path: '/account/oauth/exchange_code',
+      body: {
+        ...input,
+        ...this.credentials,
+      },
+    });
+  }
+
+  /**
+   * Refresh some access_token for obtain a new one. This is useful for keep a long-term access_token.
+   * @param input - An object that contains the essential information refresh the token.
+   * @param {String} input.refreshToken - Represents the refresh token received when exchanged the code for an access_token.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  refreshAccessToken(input: IRefreshAccessToken): Promise<IRefreshAccessTokenOutput> {
+    return this.httpClient.makeRequest({
+      method: 'POST',
+      path: '/account/oauth/refresh_token',
+      body: {
+        ...input,
+        ...this.credentials,
+      },
+    });
+  }
+}

package/resources/OAuthUser.ts

@@ -0,0 +1,62 @@
+import {
+  IAuthenticatedUserListInspections,
+  IListAuthenticatedUserInspectionsOutput,
+  IListMemberships,
+  IListMembershipsOutput,
+} from '../types/authenticatedUser';
+import { Helper } from './Helper';
+import { HTTPClient } from './HTTPClient';
+import { Inspections } from './Inspections';
+
+/**
+ * @classdesc Represents the class that contains the methods/actions availables that somebody can do using the access_token received in the oauth 2.0 authorization code flow.
+ * @class
+ */
+export class OAuthUser {
+  public inspections: Inspections;
+
+  constructor(private readonly httpClient: HTTPClient) {
+    this.inspections = new Inspections(httpClient);
+  }
+
+  /**
+   * List all the inspections with a couple of filters.
+   * @param  input - An object that contains the information for make the request.
+   * @param {String} input.scope - Indicates if the inspections to retrieve will be where the user authenticated is the producer or where the users created by the user authenticated invite before.
+   * @param {String} input.accessToken - Represents the token that belongs to the authenticated user.
+   * @param  input.params - An object that contains the filters.
+   * @param {String} input.params.from - Represents the base date in ISO format of the inspections to retrieve.
+   * @param {String} input.params.to - Represents the limit date in ISO format of the inspections to retrieve.
+   * @param {String} input.params.result - Represents the result that inspections to retrieve should have.
+   * @param {String} input.params.search - Represents a general search that will match with the consumer: identification, firstName and email.
+   * @param {String} input.params.status - Represents the status that inspections to retrieve should have.
+   * @param {Number} input.params.page - Represents the specific page that you want to retrieve the inspections.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  listInspections(
+    input: IAuthenticatedUserListInspections
+  ): Promise<IListAuthenticatedUserInspectionsOutput[]> {
+    return this.httpClient.makeRequest({
+      method: 'GET',
+      path: `/inspection/${input.scope}?membershipId=${input.membershipId}`,
+      params: input.params,
+      headers: Helper.buildOptionalHeaders(input.accessToken),
+    });
+  }
+
+  /**
+   * List all the memberships accepted by the user authenticated related with companies.
+   * @param  input - An object that contains the information for make the request.
+   * @param {String} input.accessToken - Represents the token that belongs to the authenticated user.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  listMemberships(input: IListMemberships): Promise<IListMembershipsOutput> {
+    return this.httpClient.makeRequest({
+      method: 'GET',
+      path: `/account/membership/authenticated`,
+      headers: Helper.buildOptionalHeaders(input.accessToken),
+    });
+  }
+}

package/resources/People.ts

@@ -0,0 +1,49 @@
+import { IUpdateResourceResponse } from '../types/api';
+import { ICreateInspectionOutput } from '../types/inspection';
+import { ICreatePeopleInspection, IUpdatePeopleInspection } from '../types/people';
+import { IProductMethods } from '../types/productMethods';
+import { Helper } from './Helper';
+import { HTTPClient } from './HTTPClient';
+import { Image } from './Image';
+
+export class People extends Image implements IProductMethods {
+  constructor(private readonly httpClient: HTTPClient) {
+    super(httpClient);
+  }
+  /**
+   * Create an inspection of type people
+   * @param input - An object that contains the essential information for create an inspection.
+   * @param {Object} input.consumer - Represents the consumer who will do the inspection.
+   * @param {Object} input.people - Represents the people to be attached to the inspection.
+   * @param {String} input.mode - Represents the mode of the inspection. See more details: {@link https://www.autoinspector.com.ar/docs/api/start#inspection_mode}
+   * @param {String} input.kindOf - Represents the template that inspection will have. This only matters if the input.mode is normal.
+   * @param {Object} input.metadata - Represents a dinamic object where you can store any key-value pairs.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  create(input: ICreatePeopleInspection): Promise<ICreateInspectionOutput> {
+    return this.httpClient.makeRequest({
+      method: 'POST',
+      path: `/inspection/people`,
+      body: input,
+      headers: Helper.buildOptionalHeaders(input.accessToken),
+    });
+  }
+
+  /**
+   * Update an inspection of type people
+   * @param input - An object that contains the essential information for create an inspection.
+   * @param {Object} input.consumer - Represents the user who do the inspection.
+   * @param {Object} input.metadata - Represents a dinamic object where you can store any key-value pairs.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  update(input: IUpdatePeopleInspection): Promise<IUpdateResourceResponse> {
+    return this.httpClient.makeRequest({
+      method: 'PUT',
+      path: `/inspection/people/${input.productId}`,
+      body: input,
+      headers: Helper.buildOptionalHeaders(input.accessToken),
+    });
+  }
+}

package/resources/Vehicle.ts

@@ -0,0 +1,51 @@
+import { IUpdateResourceResponse } from '../types/api';
+import { ICreateInspectionOutput } from '../types/inspection';
+import { IProductMethods } from '../types/productMethods';
+import { ICreateVehicleInspection, IUpdateVehicleInspection } from '../types/vehicle';
+import { Helper } from './Helper';
+import { HTTPClient } from './HTTPClient';
+import { Image } from './Image';
+
+export class Vehicle extends Image implements IProductMethods {
+  constructor(private readonly httpClient: HTTPClient) {
+    super(httpClient);
+  }
+
+  /**
+   * Create an inspection of type vehicle
+   * @param input - An object that contains the essential information for create an inspection.
+   * @param {Object} input.consumer - Represents the consumer who will do the inspection.
+   * @param {Object} input.vehicle - Represents the vehicle to be attached to the inspection.
+   * @param {String} input.mode - Represents the mode of the inspection. See more details: {@link https://www.autoinspector.com.ar/docs/api/start#inspection_mode}
+   * @param {String} input.kindOf - Represents the template that inspection will have. This only matters if the input.mode is normal.
+   * @param {Object} input.metadata - Represents a dinamic object where you can store any key-value pairs.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  create(input: ICreateVehicleInspection): Promise<ICreateInspectionOutput> {
+    return this.httpClient.makeRequest({
+      method: 'POST',
+      path: `/inspection/vehicle`,
+      body: input,
+      headers: Helper.buildOptionalHeaders(input.accessToken),
+    });
+  }
+
+  /**
+   * Update an inspection of type vehicle.
+   * @param input - An object that contains the essential information for create an inspection.
+   * @param {Object} input.consumer - Represents the consumer who will do the inspection.
+   * @param {Object} input.vehicle - Represents the vehicle to be attached to the inspection.
+   * @param {Object} input.metadata - Represents a dinamic object where you can store any key-value pairs.
+   * @return {Promise} - Returns a Promise that, when fulfilled, will either return an JSON Object with the requested
+   * data or an Error with the problem.
+   */
+  update(input: IUpdateVehicleInspection): Promise<IUpdateResourceResponse> {
+    return this.httpClient.makeRequest({
+      method: 'PUT',
+      path: `/inspection/vehicle/${input.productId}`,
+      body: input,
+      headers: Helper.buildOptionalHeaders(input.accessToken),
+    });
+  }
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ES2015" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
+    "strict": true /* Enable all strict type-checking options. */,
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    "skipLibCheck": true /* Skip type checking of declaration files. */,
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */,
+    "declaration": true,
+    "outDir": "./dist",
+    "resolveJsonModule": true
+  }
+}

package/types/api.ts

@@ -0,0 +1,15 @@
+export interface IAPISucessResponse {
+  message: string;
+}
+
+export interface IAutoinspectorError {
+  code: string;
+  status: number;
+  detail: string;
+}
+
+export type APIMethods = 'POST' | 'GET' | 'PUT' | 'DELETE';
+
+export interface IUpdateResourceResponse {
+  message: string;
+}

package/types/authenticatedUser.ts

@@ -0,0 +1,71 @@
+import { InspectionStatus, InspectionVeredict } from './inspection';
+
+export interface IListInspections {
+  from: Date;
+  to: Date;
+  veredict: InspectionVeredict;
+  search: string;
+  status: InspectionStatus;
+  page: number;
+}
+
+export interface IAuthenticatedUserCommonParams {
+  accessToken: string;
+}
+
+export interface IAuthenticatedUserListInspections extends IAuthenticatedUserCommonParams {
+  scope: 'all' | 'mine';
+  params: IListInspections;
+  membershipId: string;
+}
+
+export interface IPaginationOutput {
+  hasNextPage: boolean;
+  hasPrevPage: boolean;
+  limit: number;
+  nextPage?: number;
+  page: number;
+  pagingCounter: number;
+  prevPage?: number;
+  totalDocs: number;
+  totalPages: number;
+}
+
+export interface IInspectionItemOutput {
+  accessCode: string;
+  consumer: {
+    firstName: string;
+    identification: string;
+    lastName: string;
+  };
+  createdAt: string;
+  id: string;
+  producer: {
+    companyId: string;
+    user: { _id: string; username: string };
+    userId: string;
+  };
+  status: string;
+  type: string;
+  _id: string;
+}
+
+export interface IListAuthenticatedUserInspectionsOutput {
+  pagination: IPaginationOutput;
+  inspection: IInspectionItemOutput[];
+}
+
+export interface IListMemberships extends IAuthenticatedUserCommonParams {}
+
+export interface ICompany {
+  logo: string;
+  societyReason: string;
+}
+
+export interface IMembershipItem {
+  role: string;
+  company: ICompany;
+  _id: string;
+}
+
+export type IListMembershipsOutput = IMembershipItem[];

package/types/autoinspector.ts

@@ -0,0 +1,7 @@
+import { IOAuth20Credentials } from './oauth20';
+
+export interface IAutoinspector {
+  apikey: string;
+  timeout?: number;
+  oauthCredentials?: IOAuth20Credentials;
+}

package/types/colors.ts

@@ -0,0 +1,10 @@
+export type Colors =
+  | 'yellow'
+  | 'blue'
+  | 'white'
+  | 'gold'
+  | 'grey'
+  | 'orange'
+  | 'black'
+  | 'red'
+  | 'green';