@mapcreator/api 3.3.1 → 5.0.0-alpha.13

package/src/resources/VectorChoropleth.js

@@ -1,40 +0,0 @@
-/*
- * 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 ResourceBase from './base/ResourceBase';
-
-export default class VectorChoropleth extends ResourceBase {
-  static get resourceName () {
-    return 'choropleths/vector';
-  }
-}

package/src/resources/VectorHighlight.js

@@ -1,40 +0,0 @@
-/*
- * 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 ResourceBase from './base/ResourceBase';
-
-export default class VectorHighlight extends ResourceBase {
-  static get resourceName () {
-    return 'highlights/vector';
-  }
-}

package/src/resources/base/CrudBase.js

@@ -1,204 +0,0 @@
-/*
- * 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;
-  }
-}

package/src/resources/base/CrudSetBase.js

@@ -1,83 +0,0 @@
-/*
- * 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 { AbstractError } from '../../errors/AbstractError';
-import CrudBase from './CrudBase';
-import { camel as camelCase } from 'case';
-
-/**
- * Crud base for resource sets
- * @abstract
- */
-export default class CrudSetBase extends CrudBase {
-
-  /**
-   * Get items associated with the set
-   * @returns {SimpleResourceProxy} - A proxy for accessing the resource
-   */
-  get items () {
-    const url = `${this.url}/items`;
-    const data = {};
-
-    data[this.constructor.foreignKeyName] = this.id;
-
-    return this._proxyResourceList(this._Child, url, data);
-  }
-
-  /**
-   * Child constructor
-   * @returns {Class<ResourceBase>} - Child constructor
-   * @abstract
-   * @protected
-   */
-  get _Child () {
-    throw new AbstractError();
-  }
-
-  /**
-   * Get the foreign key name
-   * @returns {string} - Foreign key name
-   * @example
-   * api.fontFamilies.select(1).constructor.foreignKeyName === 'fontFamilyId'
-   */
-  static get foreignKeyName () {
-    if (!this._fk) {
-      let key = this.name; // ex: FontFamily
-
-      key = camelCase(key); // ex: fontFamily
-
-      this._fk = `${key}Id`;
-    }
-
-    return this._fk;
-  }
-}

package/src/resources/base/CrudSetItemBase.js

@@ -1,82 +0,0 @@
-/*
- * 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/AbstractError';
-import CrudBase from './CrudBase';
-import { camel as camelCase } from 'case';
-
-/**
- * Items that are part of a set
- * @abstract
- */
-export default class CrudSetItemBase extends CrudBase {
-  /**
-   * @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();
-    }
-  }
-
-  get hasParent () {
-    const parentKey = camelCase(this.constructor.parentKey);
-
-    return this.hasOwnProperty(parentKey);
-  }
-
-  /**
-   * Get the parent id
-   * @returns {number|undefined} - Parent number
-   */
-  get parentId () {
-    if (this.hasParent) {
-      const parentKey = camelCase(this.constructor.parentKey);
-
-      return Number(this[parentKey]);
-    }
-
-    return void 0;
-  }
-
-  /**
-   * Get the parent key
-   * @returns {string} - Parent key
-   */
-  static get parentKey () {
-    return this.resourceName.replace(/s$/, '_set_id');
-  }
-}

package/src/resources/base/DownloadedResource.js

@@ -1,165 +0,0 @@
-/*
- * 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 { base64Encode } from '../../utils/base64';
-import { isNode } from '../../utils/node';
-
-/**
- * Downloaded resource from the api
- */
-export default class DownloadedResource {
-  /**
-   *
-   * @param {ArrayBuffer|Buffer} data - Data
-   * @param {string} [type=application/octet-stream] - Mime-type
-   * @param {string} [fileName=Untitled] - File name
-   */
-  constructor (data, type = 'application/octet-stream', fileName = 'Untitled') {
-    this._data = data;
-    this._type = type;
-    this._fileName = fileName;
-  }
-
-  /**
-   * Build instance from response
-   * @param {Response} response - Response
-   * @returns {DownloadedResource} - Instance
-   */
-  static async fromResponse (response) {
-    // Get data
-    const data = await response.arrayBuffer();
-
-    // Find mimeType
-    let mimeType;
-    const contentType = response.headers.get('content-type');
-
-    if (contentType) {
-      mimeType = contentType.split(';')[0].trim();
-    }
-
-    // Extract file name
-    let fileName;
-    const contentDisposition = response.headers.get('content-disposition');
-
-    if (contentDisposition) {
-      const regex = /filename[^;=\n]*=((['"])(.*?)\2|([^;\s]*))/i;
-      const matches = regex.exec(contentDisposition);
-
-      if (matches) {
-        fileName = matches[3] || matches[4];
-      }
-    }
-
-    return new DownloadedResource(data, mimeType, fileName);
-  }
-
-  /**
-   * In Nodejs it will return a {@link Buffer} and in the browser it will respond with a {@link ArrayBuffer}
-   * @returns {ArrayBuffer|Buffer} - Resource data
-   */
-  get data () {
-    return this._data;
-  }
-
-  /**
-   * Resource mime-type
-   * @return {string} - Mime-type
-   */
-  get type () {
-    return this._type;
-  }
-
-  /**
-   * Resource file name, if available
-   * @return {string} - File name
-   */
-  get fileName () {
-    return this._fileName;
-  }
-
-  /**
-   * Get the size of the data
-   * @return {Number} - Size in bytes
-   */
-  get size () {
-    return this.data.length;
-  }
-
-  /**
-   * Create a object url
-   * The URL lifetime is tied to the document in the window on which it
-   * was created. The new object URL represents the resource.
-   * *Do not forget* to release the object urls once used.
-   * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL
-   * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL#Memory_management
-   * @return {string} - Object url
-   */
-  createObjectUrl () {
-    if (isNode()) {
-      throw new Error('Object urls are not supported by Node');
-    }
-
-    return URL.createObjectURL(this.createBlob());
-  }
-
-  /**
-   * Create a blob from the resource
-   * @returns {Blob}
-   */
-  createBlob () {
-    return new Blob([this.data], { type: this.type });
-  }
-
-  /**
-   * Get base64-encoded data uri
-   * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
-   * @returns {string} - Data uri
-   */
-  toDataUri () {
-    return `data:${this.type};base64,${this.toBase64()}`;
-  }
-
-  /**
-   * Base64 encode data
-   * @returns {string} - Base64 encoded data
-   */
-  toBase64 () {
-    return base64Encode(this.data);
-  }
-
-  /**
-   * @inheritDoc
-   */
-  toString () {
-    return this.data.toString();
-  }
-}