baqend/lib/intersection/Modules.ts

Baqend JavaScript SDK

import * as message from '../message';
import type { EntityManager } from '../EntityManager';
import {
  RequestBody, RequestBodyType, ResponseBodyType, Message,
} from '../connector';

/**
 * An executor of Modules running on Baqend.
 */
export class Modules {
  entityManager: EntityManager;

  /**
   * @param entityManager
   */
  constructor(entityManager: EntityManager) {
    this.entityManager = entityManager;
  }

  /**
   * Calls the module, which is identified by the given bucket
   *
   * The optional query parameter will be attached as GET-parameters.
   *
   * @param bucket Name of the module
   * @param query GET-Parameter as key-value-pairs or query string
   * @param options Additional request options
   * @param options.responseType The type used to provide the response data, defaults to text oder json
   * depends on the received data, can be one of arraybuffer, blob, json, text, base64, data-url
   * @param doneCallback
   * @param failCallback
   * @return
   */
  get(bucket: string, query?: { [param: string]: string } | string | Function,
    options?: { responseType?: ResponseBodyType } | Function, doneCallback?: any, failCallback?: any): Promise<any> {
    if (query instanceof Function) {
      return this.get(bucket, {}, query, options, doneCallback);
    }

    if (options instanceof Function) {
      return this.get(bucket, query, {}, options, doneCallback);
    }

    const opt = options || {};

    const msg = new message.GetBaqendModule(bucket)
      .addQueryString(query || '')
      .responseType(opt.responseType || null);

    return this.send(msg, doneCallback, failCallback);
  }

  /**
   * Calls the module, which is identified by the given bucket
   *
   * @param bucket Name of the module
   * @param [body] The POST-body data to send
   * @param options Additional request options
   * @param options.requestType A optional type hint used to correctly interpret the provided data, can be one
   * of arraybuffer, blob, json, text, base64, data-url, form
   * @param options.mimeType The mimType of the body. Defaults to the mimeType of the provided data if
   * it is a file object, blob or data-url
   * @param options.responseType The type used to provide the response data, defaults to text oder json
   * depends on the received data, can be one of arraybuffer, blob, json, text, base64, data-url
   * @param doneCallback
   * @param failCallback
   * @return
   */
  post(bucket: string, body: RequestBody, options?: { requestType?: RequestBodyType, mimeType?: string,
    responseType?: ResponseBodyType }, doneCallback?: any, failCallback?: any): Promise<any> {
    if (typeof options === 'function') {
      return this.post(bucket, body, {}, options, doneCallback);
    }

    const opt = options || {};

    const msg = new message.PostBaqendModule(bucket)
      .entity(body, opt.requestType)
      .mimeType(opt.mimeType || null)
      .responseType(opt.responseType || null);

    return this.send(msg, doneCallback, failCallback);
  }

  send(msg: Message, doneCallback?: any, failCallback?: any) {
    return this.entityManager.send(msg)
      .then((response) => response.entity)
      .then(doneCallback, failCallback);
  }
}