src/proxy/OrganisationProxy.js

/*
 * BSD 3-Clause License
 *
 * Copyright (c) 2020, Mapcreator
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 *  Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 *  Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

import { isParentOf } from '../utils/reflection';
import SimpleResourceProxy from './SimpleResourceProxy';
import { makeCancelable } from '../utils/helpers';

export default class OrganisationProxy extends SimpleResourceProxy {
  /**
   * @param {Mapcreator} api - Instance of the api
   * @param {ResourceBase} parent - Parent instance
   */
  constructor (api, parent) {
    // Fixes dependency issue
    const Organisation = require('../resources/Organisation').default;

    super(api, Organisation, `${parent.url}/organisations`, {});

    this._parent = parent;
  }

  /**
   * Returns parent instance
   * @returns {ResourceBase} - Parent instance
   */
  get parent () {
    return this._parent;
  }

  /**
   * Sync organisations to the parent resource
   * The organisations attached to the target resource will be replaced with the organisations provided in the request.
   * @param {Array<Organisation|number>} organisations - List of items to sync
   * @throws {ApiError} - If the api returns errors
   * @returns {CancelablePromise}
   */
  sync (organisations) {
    return this._modifyLink(organisations, 'PATCH', this.Target);
  }

  /**
   * Attach organisations to the parent resource
   * The provided organisations will be attached to the resource if they're not already attached
   * @param {Array<Organisation|number>} organisations - List of items to attach
   * @throws {ApiError} - If the api returns errors
   * @returns {CancelablePromise}
   */
  attach (organisations) {
    return this._modifyLink(organisations, 'POST', this.Target);
  }

  /**
   * Detach organisations from the parent resource
   * The provided organisations will be detached from the resource
   * @param {Array<Organisation|number>} organisations - List of items to detach
   * @throws {ApiError} - If the api returns errors
   * @returns {CancelablePromise}
   */
  detach (organisations) {
    return this._modifyLink(organisations, 'DELETE', this.Target);
  }

  /**
   * Attach all organisations to the parent resource
   * @throws {ApiError} - If the api returns errors
   * @returns {CancelablePromise}
   */
  attachAll () {
    return makeCancelable(async signal => {
      await this.api.ky.post(`${this.baseUrl}/all`, { signal });
    });
  }

  /**
   * Detach all organisations from the parent resource
   * @throws {ApiError} - If the api returns errors
   * @returns {CancelablePromise}
   */
  detachAll () {
    return makeCancelable(async signal => {
      await this.api.ky.delete(`${this.baseUrl}/all`, { signal });
    });
  }

  /**
   * Sync, attach or unlink resources
   * @param {Array<Organisation|Number>|Organisation|Number} items - List of items to sync or attach
   * @param {String} method - Http method to use
   * @param {Class<ResourceBase>} Type - Resource type
   * @param {?String} path - Optional appended resource path, will guess if null
   * @throws {ApiError} - If the api returns errors
   * @protected
   * @returns {CancelablePromise}
   */
  _modifyLink (items, method, Type, path = null) {
    if (!Array.isArray(items)) {
      items = [items];
    }

    if (!path) {
      const resource = Type.resourceName.replace(/s+$/, '');

      path = `${resource}s`;
    }

    const keys = items.map(x => typeof x === 'number' ? x : x.id).map(Number);
    const filter = x => !isParentOf(Type, x) && !Number.isFinite(x);
    const isValid = keys.filter(filter).length === 0;

    if (!isValid) {
      throw new TypeError(`Array must contain either Numbers (resource id) or "${Type.name}".`);
    }

    const url = `${this.parent.url}/${path}`;

    return makeCancelable(async signal => {
      await this.api.ky(url, { method, signal, json: { keys } });
    });
  }
}