@mapcreator/api 3.3.0 → 5.0.0-alpha.12

package/src/utils/geo.js

@@ -1,139 +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 GeoError from '../errors/GeoError';
-
-/**
- * A geographical point
- */
-export class GeoPoint {
-  /**
-   * Geographical point
-   * @param {Number} lat - latitude
-   * @param {Number} lng - longitude
-   */
-  constructor (lat, lng) {
-    this.lat = lat;
-    this.lng = lng;
-  }
-
-  /**
-   * Get latitude
-   * @returns {Number} - latitude
-   */
-  get lat () {
-    return this._lat;
-  }
-
-  /**
-   * Set latitude
-   * @param {Number} value - latitude
-   */
-  set lat (value) {
-    value = Number(value);
-
-    if (!Number.isFinite(value)) {
-      throw new GeoError(`Invalid latitude: ${value}`);
-    }
-
-    this._lat = Math.min(90, Math.max(-90, value));
-  }
-
-  /**
-   * Get longitude
-   * @returns {Number} - longitude
-   */
-  get lng () {
-    return this._lng;
-  }
-
-  /**
-   * Set longitude
-   * @param {Number} value - longitude
-   */
-  set lng (value) {
-    value = Number(value);
-
-    if (!Number.isFinite(value)) {
-      throw new GeoError(`Invalid longitude: ${value}`);
-    }
-
-    this._lng = value;
-  }
-
-  /**
-   * Get data to be JSON encoded
-   * @returns {{lat: Number, lng: Number}} - data
-   */
-  toJSON () {
-    return { lat: this.lat, lng: this.lng };
-  }
-}
-
-/**
- * Geometric boundary
- */
-export class GeoBoundary {
-  /**
-   * Geometric boundary
-   * @param {Object} topLeft - top left corner of the boundary
-   * @param {Number} topLeft.lat - top left corner latitude
-   * @param {Number} topLeft.lng - top left corner longitude
-   * @param {Object} bottomRight - bottom right corner of the boundary
-   * @param {Number} bottomRight.lat - bottom right corner latitude
-   * @param {Number} bottomRight.lng - bottom right corner longitude
-   */
-  constructor ({ lat: lat1, lng: lng1 }, { lat: lat2, lng: lng2 }) {
-    this.topLeft = new GeoPoint(lat1, lng1);
-    this.bottomRight = new GeoPoint(lat2, lng2);
-  }
-
-  getCenter () {
-    const lat = (this.topLeft.lat + this.bottomRight.lat) / 2;
-    const lng = (this.topLeft.lng + this.bottomRight.lng) / 2;
-
-    return new GeoPoint(lat, lng);
-  }
-
-  /**
-   * Top left coordinate
-   * @type {GeoPoint}
-   */
-  topLeft;
-
-  /**
-   * Bottom right coordinate
-   * @type {GeoPoint}
-   */
-  bottomRight;
-}

package/src/utils/hash.js

@@ -1,72 +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 stringify from 'json-stable-stringify';
-
-const FNV1_32A_INIT = 0x811c9dc5;
-
-/**
- * Fast hash function for non-cryptographic use
- * @param {string} str - Input to be hashed
- * @returns {string} - String representation of the hash
- * @private
- */
-export function fnv32b (str) {
-  let hash = str
-    .split('')
-    .map(x => x.charCodeAt(0))
-    .reduce((sum, val) => {
-      sum ^= val;
-
-      return sum + (sum << 1) + (sum << 4) + (sum << 7) + (sum << 8) + (sum << 24);
-    }, FNV1_32A_INIT);
-
-  // Avalanche
-  hash ^= hash << 3;
-  hash += hash >> 5;
-  hash ^= hash << 4;
-  hash += hash >> 17;
-  hash ^= hash << 25;
-  hash += hash >> 6;
-
-  return `0000000${(hash >>> 0).toString(16)}`.substr(-8);
-}
-
-/**
- * Fast object hashing for non-cryptographic use
- * @param {object} data - input data
- * @returns {string} - String reprisentation of the hash
- * @private
- */
-export function hashObject (data) {
-  return fnv32b(stringify(data));
-}

package/src/utils/helpers.js

@@ -1,178 +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.
- */
-
-/**
- * Get all the pages from a {@link PaginatedResourceListing} or a range
- * @param {Promise<PaginatedResourceListing>|PaginatedResourceListing} page - Promise that returns a {@link PaginatedResourceListing}
- * @param {?Number} [start=1] - Start page
- * @param {?Number} [stop] - Stop page, defaults to the page count if not filled in.
- * @returns {Promise<Array<ResourceBase>>} - multiple pages
- * @throws {ApiError} - If the api returns errors
- * @example
- * import { helpers } from "@mapcreator/api";
- *
- * const promise = api.users.list(1, 50); // 50 per page is more efficient
- *
- * helpers.getPaginatedRange(promise).then(data => {
- *    data.map(row => `[${row.id}] ${row.name}`) // We just want the names
- *        .forEach(console.log) // Log the names and ids of every user
- * })
- */
-export async function getPaginatedRange (page, start = 1, stop) {
-  // Resolve promise if any
-  if (page instanceof Promise) {
-    page = await page;
-  }
-
-  const out = page.data;
-  const promises = [];
-
-  // Handle defaults
-  start = start || page.page;
-  stop = stop || page.pageCount;
-
-  if (start === page.page) {
-    start++;
-  }
-
-  // Get all pages
-  for (let i = start; i <= stop; i++) {
-    promises.push(page.get(i));
-  }
-
-  // Resolve
-  const rows = await Promise.all(promises);
-
-  return out.concat(...rows.map(x => x.data));
-}
-
-/**
- * Async delay
- * @private
- * @param {number} ms - milliseconds
- * @returns {Promise}
- */
-export const delay = ms => new Promise(resolve => setTimeout(resolve, ms));
-
-/**
- * Wraps around ky to make it return cancelable requests
- * @param {function(*=, *=): Response} fn - ky instance
- * @returns {function(*=, *=): Response}
- * @private
- */
-export function wrapKyCancelable (fn) {
-  return (input, options = {}) => {
-    if (typeof options === 'object' && options.hasOwnProperty('signal')) {
-      return fn(input, options);
-    }
-
-    const controller = new AbortController();
-    const promise = fn(input, { signal: controller.signal, ...options });
-
-    promise.cancel = () => controller.abort();
-
-    return promise;
-  };
-}
-
-/**
- * @typedef {Promise} CancelablePromise
- * @property {function(): void} cancel - Cancel the promise
- */
-
-/**
- * Makes a promise cancelable by passing it a signal
- * @param {function} fn - async method
- * @returns {CancelablePromise}
- * @private
- */
-export function makeCancelable (fn) {
-  const controller = new AbortController();
-
-  const promise = fn(controller.signal);
-
-  if (promise instanceof Promise) {
-    promise.cancel = () => controller.abort();
-  }
-
-  return promise;
-}
-
-/**
- * Convert Date into server format
- * @param {Date} date - Target
- * @returns {String} - Formatted date
- * @private
- */
-export function serializeUTCDate (date) {
-  if (!(date instanceof Date)) {
-    throw new TypeError('Expected date to be of type Date');
-  }
-
-  const pad = num => `00${num}`.slice(-Math.max(String(num).length, 2));
-
-  let out = [
-    date.getUTCFullYear(),
-    date.getUTCMonth() + 1,
-    date.getUTCDate(),
-  ].map(pad).join('-');
-
-  out += ` ${[
-    date.getUTCHours(),
-    date.getUTCMinutes(),
-    date.getUTCSeconds(),
-  ].map(pad).join(':')}`;
-
-  return out;
-}
-
-export function clone (input, clonePrivate = true) {
-  const _clone = value => clone(value, clonePrivate);
-
-  if (typeof input !== 'object' || input === null) {
-    return input;
-  } else if (Array.isArray(input)) {
-    return input.map(_clone);
-  }
-
-  const output = {};
-
-  for (const key of Object.keys(input)) {
-    if (!clonePrivate && key.startsWith('_')) {
-      continue;
-    }
-
-    output[key] = _clone(input[key]);
-  }
-
-  return output;
-}

package/src/utils/node.js

@@ -1,55 +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.
- */
-
-/**
- * Test if the application is running under nodejs
- * @returns {boolean} - Is the application running under node?
- * @see https://nodejs.org
- * @private
- */
-export function isNode () {
-  try {
-    return Object.prototype.toString.call(typeof process === 'undefined' ? 0 : process) === '[object process]';
-  } catch (_) {
-    return false;
-  }
-}
-
-/**
- * Quickly check if the window contains a variable
- * @param {string} str - target variable
- * @returns {boolean} - If the window contains the variable
- * @private
- */
-export function windowTest (str) {
-  return typeof window !== 'undefined' && typeof window[str] !== 'undefined';
-}

package/src/utils/reflection.js

@@ -1,170 +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 Trait from '../traits/Trait';
-import { fnv32b } from './hash';
-
-/**
- * Tests if the parent is a parent of child
- * @param {Class|object} parent - Instance or Class
- * @param {Class|object} child - Instance or Class
- * @returns {boolean} - is parent a parent of child
- * @private
- * @example
- * class A {}
- * class B extends A {}
- * class C extends B {}
- *
- * isParentOf(A, C) // true
- * isParentOf(B, C) // true
- * isParentOf(C, C) // true
- * isParentOf(B, A) // false
- */
-export function isParentOf (parent, child) {
-  if (parent === null || child === null) {
-    return false;
-  }
-
-  parent = typeof parent === 'function' ? parent : parent.constructor;
-  child = typeof child === 'function' ? child : child.constructor;
-
-  do {
-    if (child.name === parent.name) {
-      return true;
-    }
-
-    child = Object.getPrototypeOf(child);
-  } while (child.name !== '');
-
-  return false;
-}
-
-
-/**
- * Get the name of the value type
- * @param {*} value - Any value
- * @private
- * @returns {string} - Value type name
- */
-export function getTypeName (value) {
-  if (typeof value === 'undefined') {
-    return 'undefined';
-  }
-
-  value = typeof value === 'function' ? value : value.constructor;
-
-  return value.name;
-
-}
-
-/**
- * Helper class for mix
- * @see {@link mix}
- */
-class Empty {
-}
-
-/**
- * Copy properties from source to target
- * @param {object} target - Object for the properties to be copied to
- * @param {object} source - Object containing properties to be copied
- */
-function copyProps (target, source) {
-  Object
-    .getOwnPropertyNames(source)
-    .concat(Object.getOwnPropertySymbols(source))
-    .forEach(prop => {
-      if (!prop.match(/^(?:constructor|initializer|prototype|arguments|caller|name|bind|call|apply|toString|length)$/)) {
-        Object.defineProperty(target, prop, Object.getOwnPropertyDescriptor(source, prop));
-      }
-    });
-}
-
-/**
- * Mix traits into the target class
- * @param {Class} baseClass - Target base class for the traits to be applied to
- * @param {Class<Trait>} mixins - Traits to be applied
- * @returns {Class} - Constructor with any traits applied
- * @private
- */
-export function mix (baseClass, ...mixins) {
-  const cocktail = class _Cocktail extends (baseClass || Empty) {
-    constructor (...args) {
-      super(...args);
-
-      mixins
-        .map(mixin => mixin.prototype.initializer)
-        .filter(initializer => typeof initializer === 'function')
-        .forEach(initializer => initializer.call(this));
-    }
-  };
-
-
-  for (const mixin of mixins) {
-    if (!isParentOf(Trait, mixin)) {
-      throw new TypeError(`Expected mixin to implement Trait for ${mixin.name}`);
-    }
-
-    copyProps(cocktail.prototype, mixin.prototype);
-    copyProps(cocktail, mixin);
-  }
-
-  cocktail.__mixins = mixins;
-
-  const hash = fnv32b(mixins.map(x => x.name).join(','));
-
-  Object.defineProperty(cocktail, 'name', { value: `Cocktail_${hash}` });
-
-  return cocktail;
-}
-
-/**
- * Checks if the target has a certain trait.
- *
- * @param {Class|Object} Subject - Instance or class
- * @param {Class<Trait>} TraitClass - Trait to check for
- * @returns {boolean} - If the subject has the trait
- * @private
- */
-export function hasTrait (Subject, TraitClass) {
-  Subject = typeof Subject === 'function' ? Subject : Subject.constructor;
-
-  do {
-    if (Array.isArray(Subject.__mixins) && Subject.__mixins.includes(TraitClass)) {
-      return true;
-    }
-
-    Subject = Object.getPrototypeOf(Subject);
-  } while (Subject.name !== '');
-
-  return false;
-}