passbolt-styleguide/src/shared/lib/apiClient/apiClientOptions.js

Passbolt styleguide contains common styling assets used by the different sites, plugin, etc.

/**
 * Passbolt ~ Open source password manager for teams
 * Copyright (c) 2020 Passbolt SA (https://www.passbolt.com)
 *
 * Licensed under GNU Affero General Public License version 3 of the or any later version.
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) 2020 Passbolt SA (https://www.passbolt.com)
 * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
 * @link          https://www.passbolt.com Passbolt(tm)
 */
import {CsrfToken} from "./csrfToken";

export class ApiClientOptions {
  /**
   * Set base url
   *
   * @param {string|URL} baseUrl
   * @throws {TypeError} if baseUrl is empty, or not a string or valid URL
   * @returns {ApiClientOptions}
   * @public
   */
  setBaseUrl(baseUrl) {
    if (!baseUrl) {
      throw new TypeError('ApiClientOption baseUrl is required.');
    }
    if (typeof baseUrl === 'string') {
      try {
        this.baseUrl = new URL(baseUrl);
      } catch (e) {
        throw new TypeError('ApiClientOption baseUrl is invalid.');
      }
    } else {
      if (baseUrl instanceof URL) {
        this.baseUrl = baseUrl;
      } else {
        throw new TypeError('ApiClientOptions baseurl should be a string or URL');
      }
    }
    return this;
  }

  /**
   * Set CSRF Token
   *
   * @throws {TypeError} if csrfToken is empty or not a string or CsrfToken object
   * @param {string|CsrfToken} csrfToken
   * @public
   */
  setCsrfToken(csrfToken) {
    if (!csrfToken) {
      throw new TypeError('ApiClientOption csrfToken is required.');
    }
    if (typeof csrfToken === 'string') {
      this.csrfToken = new CsrfToken(csrfToken);
    } else {
      if (csrfToken instanceof CsrfToken) {
        this.csrfToken = csrfToken;
      } else {
        throw new TypeError('ApiClientOption csrfToken should be a string or a valid CsrfToken.');
      }
    }
    return this;
  }

  /**
   * Set the resource name
   *
   * @throws {TypeError} if resourceName is empty, or not a string
   * @param {string} resourceName name
   * @returns {ApiClientOptions}
   * @public
   */
  setResourceName(resourceName) {
    if (!resourceName) {
      throw new TypeError('ApiClientOptions.setResourceName resourceName is required.');
    }
    if (typeof resourceName !== 'string') {
      throw new TypeError('ApiClientOptions.setResourceName resourceName should be a valid string.');
    }
    this.resourceName = resourceName;
    return this;
  }

  /**
   * @returns {URL} baseUrl
   * @public
   */
  getBaseUrl() {
    return this.baseUrl;
  }

  /**
   * @returns {string} resourceName
   * @public
   */
  getResourceName() {
    return this.resourceName;
  }

  /**
   * Returns the relevant client options as fetch options headers
   *
   * @returns {*}
   */
  getHeaders() {
    if (this.csrfToken) {
      return this.csrfToken.toFetchHeaders();
    }
  }
}