@kweli/cs-rest/src/Session.ts

Simple authentication and REST calls for OpenText Content Server.

import axiosFactory, { CSRestOptions } from "./utils/axios-factory";
import Auth from "./handlers/auth";
import Nodes from "./handlers/nodes";
import Workflow from "./handlers/workflow";
import RHCore from "./handlers/rhcore";
import Search from "./handlers/search";
import Members from "./handlers/members";
import Versions from "./handlers/versions";
import WebReports from "./handlers/webreports";
import RPCClient from "./rpc-client/index";
import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";

export default class Session {
  protected readonly axios: AxiosInstance;
  protected _nodes: Nodes;
  protected _auth: Auth;
  protected _workflow: any;
  protected _rhcore: RHCore;
  protected _members: Members;
  protected _search: Search;
  protected _webreports: WebReports;
  protected _versions: Versions;

  public readonly baseUrl: string;

  constructor(options: CSRestOptions) {
    this.baseUrl = options.baseUrl;
    this.axios = axiosFactory(options);
  }

  get nodes(): Nodes {
    if (this._nodes === undefined) {
      this._nodes = new Nodes(this);
    }

    return this._nodes;
  }

  get auth(): Auth {
    if (this._auth === undefined) {
      this._auth = new Auth(this);
    }

    return this._auth;
  }

  get workflow(): Workflow {
    if (this._workflow === undefined) {
      this._workflow = new Workflow(this);
    }

    return this._workflow;
  }

  get rhcore(): RHCore {
    if (this._rhcore === undefined) {
      this._rhcore = new RHCore(this);
    }

    return this._rhcore;
  }

  get members(): Members {
    if (this._members === undefined) {
      this._members = new Members(this);
    }

    return this._members;
  }

  get search(): Search {
    if (this._search === undefined) {
      this._search = new Search(this);
    }

    return this._search;
  }

  get webreports(): WebReports {
    if (this._webreports === undefined) {
      this._webreports = new WebReports(this);
    }

    return this._webreports;
  }

  get versions(): Versions {
    if (this._versions === undefined) {
      this._versions = new Versions(this);
    }

    return this._versions;
  }

  rpcClient(relativePath = "/api/v1/rh/rpc/rhnode/") {
    return new RPCClient(this, relativePath);
  }

  _isObject(value: unknown): value is Object {
    return value && typeof value === "object" && value.constructor === Object;
  }

  _isString(value: unknown): value is string {
    return typeof value === "string" || value instanceof String;
  }

  _isBoolean(value: unknown): value is boolean {
    return typeof value === "boolean";
  }

  _isFile(value: any): value is File {
    return typeof value?.name === "string";
  }

  putForm<T>(url: string, params: Record<string, any>) {
    return this.put<T>(url, this.objectToForm(params), {
      headers: {
        "Content-Type": "multipart/form-data",
      },
    });
  }

  postForm<T>(url: string, params: Record<string, any>) {
    return this.post<T>(url, this.objectToForm(params), {
      headers: {
        "Content-Type": "multipart/form-data",
      },
      maxBodyLength: Infinity,
    });
  }

  patchForm<T>(url: string, params: Record<string, any>) {
    return this.patch<T>(url, this.objectToForm(params), {
      headers: {
        "Content-Type": "multipart/form-data",
      },
    });
  }

  deleteForm(url: string, params: Record<string, any>) {
    // FormData does not working on Delete!!
    // See here: https://stackoverflow.com/questions/51069552/axios-delete-request-with-body-and-headers
    // const formData = this.objectToForm(params)

    return this.delete(url);
  }

  objectToForm(obj: Record<string, any>) {
    return Object.entries(obj).reduce(
      (a: Record<string, any>, [key, value]) => {
        return {
          ...a,
          [key]:
            Array.isArray(value) || this._isObject(value)
              ? JSON.stringify(value)
              : value,
        };
      },
      {}
    );
  }

  putBody(url: string, body) {
    return this.putForm(url, {
      body,
    });
  }

  postBody<T>(url: string, body: Record<string, any>) {
    return this.postForm<T>(url, {
      body,
    });
  }

  patchBody(url: string, body: Record<string, any>) {
    return this.patchForm(url, {
      body,
    });
  }

  deleteBody(url: string, body: Record<string, any>) {
    return this.deleteForm(url, {
      body,
    });
  }

  get<T = any>(url: string, config?: AxiosRequestConfig) {
    return this.axios.get<T>(url, config);
  }

  post<T = any>(url: string, data?: any, config?: AxiosRequestConfig) {
    return this.axios.post<T>(url, data, config);
  }

  put<T = any>(url: string, data?: any, config?: AxiosRequestConfig) {
    return this.axios.put<T>(url, data, config);
  }

  patch<T = any>(url: string, data?: any, config?: AxiosRequestConfig) {
    return this.axios.patch<T>(url, data, config);
  }

  options<T = any>(url: string, config?: AxiosRequestConfig) {
    return this.axios.options<T>(url, config);
  }

  delete<T = any>(url: string, config?: AxiosRequestConfig) {
    return this.axios.delete<T>(url, config);
  }

  async $get<T = any>(url: string, config?: AxiosRequestConfig): Promise<T> {
    const response = await this.get<T>(url, config);
    return response.data;
  }
}