src/resources/base/CrudBase.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 { AbstractClassError } from '../../errors';
import ResourceBase from './ResourceBase';
import { makeCancelable, serializeUTCDate } from '../../utils/helpers';

/**
 * Base of all resource items that support Crud operations
 * @abstract
 */
export default class CrudBase extends ResourceBase {
  /**
   * @param {Mapcreator} api - Api instance
   * @param {Object<String, *>} data - Item data
   * @param {String} [altUrl] - Internal use, Optional alternative url for more complex routing
   */
  constructor (api, data = {}, altUrl = null) {
    super(api, data, altUrl);

    if (this.constructor === CrudBase) {
      throw new AbstractClassError();
    }
  }

  /**
   * Build data for create operation
   * @returns {Object<String, *>} - Create data
   * @protected
   */
  _buildCreateData () {
    this._updateProperties();

    const out = {};
    const keys = [].concat(
      Object.keys(this._properties),
      Object.keys(this._baseProperties),
    ).filter((item, pos, self) => self.indexOf(item) === pos);

    for (const key of keys) {
      out[key] = this._properties[key] || this._baseProperties[key];
    }

    delete out.id;

    return out;
  }

  /**
   * Save item. This will create a new item if `id` is unset
   * @returns {CancelablePromise<CrudBase>} - Current instance
   * @throws {ApiError} - If the api returns errors
   * @throws {ValidationError} - If the submitted data isn't valid
   */
  save () {
    return this.id ? this._update() : this._create();
  }

  /**
   * Store new item
   * @returns {CancelablePromise<CrudBase>} - Current instance
   * @throws {ApiError} - If the api returns errors
   * @throws {ValidationError} - If the submitted data isn't valid
   * @private
   */
  _create () {
    return makeCancelable(async signal => {
      const json = this._prepareData(this._buildCreateData());

      const { data } = await this.api.ky.post(this.baseUrl, { json, signal }).json();

      this._properties = {};
      this._baseProperties = data;

      this._updateProperties();

      return this;
    });
  }

  /**
   * Update existing item
   * @returns {CancelablePromise<CrudBase>} - Current instance
   * @throws {ApiError} - If the api returns errors
   * @throws {ValidationError} - If the submitted data isn't valid
   * @protected
   */
  _update () {
    this._updateProperties();

    return makeCancelable(async signal => {
      // We'll just fake it, no need to bother the server
      // with an empty request.
      if (Object.keys(this._properties).length === 0) {
        return this;
      }

      const json = this._prepareData(this._properties);

      await this.api.ky.patch(this.url, { json, signal });

      // Reset changes
      Object.assign(this._baseProperties, this._properties);
      this._properties = {};

      if ('updated_at' in this._baseProperties) {
        this._baseProperties['updated_at'] = new Date();
      }

      return this;
    });
  }

  /**
   * Delete item
   * @param {Boolean} [updateSelf=true] - Update current instance (set the deletedAt property)
   * @returns {CancelablePromise<CrudBase>} - Current instance
   * @throws {ApiError} - If the api returns errors
   * @throws {ValidationError} - If the submitted data isn't valid
   */
  delete (updateSelf = true) {
    return makeCancelable(async signal => {
      await this.api.ky.delete(this.url, { signal });

      if (updateSelf) {
        this._baseProperties['deleted_at'] = new Date();
      }

      return this;
    });
  }

  /**
   * Restore item
   * @param {Boolean} [updateSelf=true] - Update current instance (unset the deletedAt property)
   * @returns {CancelablePromise<CrudBase>} - New restored instance
   * @throws {ApiError} - If the api returns errors
   * @throws {ValidationError} - If the submitted data isn't valid
   */
  restore (updateSelf = true) {
    return makeCancelable(async signal => {
      const { data } = await this.api.ky.put(this.url, { signal }).json();
      const instance = new this.constructor(this.api, data);

      if (updateSelf) {
        this._properties = {};
        this._baseProperties = data;

        this._updateProperties();
      }

      return instance;
    });
  }

  /**
   * Prepare data to be sent to the api
   * @param {Object} data
   * @returns {Object} prepared
   * @private
   */
  _prepareData (data) {
    const output = {};

    for (const [key, value] of Object.entries(data)) {
      if (value instanceof Date) {
        output[key] = serializeUTCDate(value);
      } else {
        output[key] = value;
      }
    }

    return output;
  }
}