jsforce/src/api/apex.ts

Salesforce API Library for JavaScript

/**
 * @file Manages Salesforce Apex REST endpoint calls
 * @author Shinichi Tomita <shinichi.tomita@gmail.com>
 */
import { registerModule } from '../jsforce';
import Connection from '../connection';
import { HttpRequest, HttpMethods, Schema } from '../types';

/**
 * API class for Apex REST endpoint call
 */
export class Apex<S extends Schema> {
  _conn: Connection<S>;

  /**
   *
   */
  constructor(conn: Connection<S>) {
    this._conn = conn;
  }

  /* @private */
  _baseUrl() {
    return `${this._conn.instanceUrl}/services/apexrest`;
  }

  /**
   * @private
   */
  _createRequestParams(
    method: HttpMethods,
    path: string,
    body?: Object,
    options: { headers?: HttpRequest['headers'] } = {},
  ): HttpRequest {
    const headers: HttpRequest['headers'] =
      typeof options.headers === 'object' ? options.headers : {};
    if (!/^(GET|DELETE)$/i.test(method)) {
      headers['content-type'] = 'application/json';
    }
    const params: HttpRequest = {
      method,
      url: this._baseUrl() + path,
      headers,
    };
    if (body) {
      params.body = JSON.stringify(body);
    }
    return params;
  }

  /**
   * Call Apex REST service in GET request
   */
  get<R = unknown>(path: string, options?: Object) {
    return this._conn.request<R>(
      this._createRequestParams('GET', path, undefined, options),
    );
  }

  /**
   * Call Apex REST service in POST request
   */
  post<R = unknown>(path: string, body?: Object, options?: Object) {
    const params = this._createRequestParams('POST', path, body, options);
    return this._conn.request<R>(params);
  }

  /**
   * Call Apex REST service in PUT request
   */
  put<R = unknown>(path: string, body?: Object, options?: Object) {
    const params = this._createRequestParams('PUT', path, body, options);
    return this._conn.request<R>(params);
  }

  /**
   * Call Apex REST service in PATCH request
   */
  patch<R = unknown>(path: string, body?: Object, options?: Object) {
    const params = this._createRequestParams('PATCH', path, body, options);
    return this._conn.request<R>(params);
  }

  /**
   * Call Apex REST service in DELETE request
   */
  delete<R = unknown>(path: string, options?: Object) {
    return this._conn.request<R>(
      this._createRequestParams('DELETE', path, undefined, options),
    );
  }

  /**
   * Synonym of Apex#delete()
   */
  del = this.delete;
}

/*--------------------------------------------*/
/*
 * Register hook in connection instantiation for dynamically adding this API module features
 */
registerModule('apex', (conn) => new Apex(conn));

export default Apex;