@mapcreator/api 3.3.1 → 5.0.0-alpha.12

package/src/storage/DataStoreContract.js

@@ -1,111 +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.
- */
-
-/* eslint-disable no-unused-vars */
-
-import { AbstractClassError, AbstractMethodError } from '../errors/AbstractError';
-
-/**
- * @private
- */
-export default class DataStoreContract {
-  constructor () {
-    if (this.constructor === DataStoreContract) {
-      throw new AbstractClassError();
-    }
-
-    if (!this.constructor.available) {
-      throw new Error(`${this.constructor.name} is unavailable`);
-    }
-  }
-
-  /**
-   * If the driver is currently available
-   * @returns {boolean} - Driver availability
-   */
-  static get available () {
-    return false;
-  }
-
-  /**
-   * If the storage is secure
-   * @returns {boolean} - Secure storage
-   */
-  static get secure () {
-    return false;
-  }
-
-  /**
-   * Store a value in the storage
-   * @param {String} name - value name
-   * @param {*} value - value
-   * @abstract
-   */
-  set (name, value) {
-    throw new AbstractMethodError();
-  }
-
-  /**
-   * Get a value from the store
-   * @param {String} name - value name
-   * @returns {String} - value
-   * @abstract
-   */
-  get (name) {
-    throw new AbstractMethodError();
-  }
-
-  /**
-   * Remove a value from the store
-   * @param {String} name - value name
-   * @abstract
-   */
-  remove (name) {
-    throw new AbstractMethodError();
-  }
-
-  /**
-   * Clear storage
-   */
-  clear () {
-    this.keys().map(key => this.remove(key));
-  }
-
-  /**
-   * Storage keys
-   * @returns {Array<String>} - Stored keys
-   * @abstract
-   */
-  keys () {
-    throw new AbstractMethodError();
-  }
-}

package/src/storage/DummyDriver.js

@@ -1,91 +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 { isNode } from '../utils/node';
-import DataStoreContract from './DataStoreContract';
-
-/**
- * Used for storing data during tests
- * @private
- */
-export default class DummyDriver extends DataStoreContract {
-  static _data = {};
-
-  /**
-   * @inheritDoc
-   */
-  static get available () {
-    return isNode() && process.env.NODE_ENV === 'test';
-  }
-
-  /**
-   * If the storage is secure
-   * @returns {boolean} - Secure storage
-   */
-  static get secure () {
-    return true;
-  }
-
-  /**
-   * Store a value in the storage
-   * @param {String} name - value name
-   * @param {*} value - value
-   */
-  set (name, value) {
-    this.constructor._data[name] = value;
-  }
-
-  /**
-   * Get a value from the store
-   * @param {String} name - value name
-   * @returns {*} - value
-   */
-  get (name) {
-    return this.constructor._data[name];
-  }
-
-  /**
-   * Remove a value from the store
-   * @param {String} name - value name
-   */
-  remove (name) {
-    delete this.constructor._data[name];
-  }
-
-  /**
-   * Storage keys
-   * @returns {Array<String>} - Stored keys
-   */
-  keys () {
-    return Object.keys(this.constructor._data);
-  }
-}

package/src/storage/FileDriver.js

@@ -1,174 +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 { isNode } from '../utils/node';
-import DataStoreContract from './DataStoreContract';
-
-/**
- * @private
- */
-export default class FileDriver extends DataStoreContract {
-  /**
-   * @param {String} path - File storage path
-   * @inheritDoc
-   */
-  constructor (path = '.m4n') {
-    super();
-
-    this._path = path;
-  }
-
-  /**
-   * File storage path
-   * @returns {String} - path
-   */
-  get path () {
-    return this._path;
-  }
-
-  /**
-   * File storage path
-   * @param {String} value - path
-   */
-  set path (value) {
-    if (typeof value !== 'string') {
-      throw new TypeError('Expected "path" value to be of type "string"');
-    }
-
-    this._path = value;
-  }
-
-  /**
-   * @inheritDoc
-   */
-  static get available () {
-    return isNode();
-  }
-
-  /**
-   * @inheritDoc
-   */
-  static get secure () {
-    return true;
-  }
-
-  /**
-   * @inheritDoc
-   */
-  set (name, value) {
-    const data = this._read();
-
-    data[name] = value;
-
-    this._write(data);
-  }
-
-  /**
-   * @inheritDoc
-   */
-  get (name) {
-    return this._read()[name];
-  }
-
-  /**
-   * @inheritDoc
-   */
-  remove (name) {
-    const data = this._read();
-
-    delete data[name];
-
-    this._write(data);
-  }
-
-  /**
-   * @inheritDoc
-   */
-  clear () {
-    this._write({});
-  }
-
-  /**
-   * @inheritDoc
-   */
-  keys () {
-    return Object.keys(this._read());
-  }
-
-  /**
-   * Read file and parse
-   * @returns {Object<String, String>} - Key, value object
-   * @private
-   */
-  _read () {
-    let data;
-
-    try {
-      data = this._fs.readFileSync(this.path).toString();
-    } catch (e) {
-      data = '{}';
-    }
-
-    if (!data) {
-      return {};
-    }
-
-    return JSON.parse(data);
-  }
-
-  /**
-   * Write data to file
-   * @param {Object<String, String>} obj - Key, value object
-   * @private
-   */
-  _write (obj) {
-    const data = JSON.stringify(obj);
-    const fd = this._fs.openSync(this.path, 'w');
-
-    this._fs.writeSync(fd, data);
-    this._fs.closeSync(fd);
-  }
-
-  /**
-   * Get fs instance
-   * @returns {fs} - fs instance
-   * @private
-   */
-  get _fs () {
-    if (!this.__fs) {
-      // eslint-disable-next-line no-eval
-      this.__fs = eval('require("fs")');
-    }
-
-    return this.__fs;
-  }
-}

package/src/storage/LocalStorageDriver.js

@@ -1,108 +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 DataStoreContract from './DataStoreContract';
-import { isNode } from '../utils/node';
-
-/**
- * @private
- */
-export default class LocalStorageDriver extends DataStoreContract {
-  /**
-   * LocalStorage name prefix
-   * @returns {String} - Prefix
-   * @private
-   */
-  static get _prefix () {
-    return '_m4n_';
-  }
-
-  /**
-   * @inheritDoc
-   */
-  static get available () {
-    return !isNode();
-  }
-
-  /**
-   * Store a value in the storage
-   * @param {String} name - value name
-   * @param {*} value - value
-   */
-  set (name, value) {
-    name = LocalStorageDriver._prefix + name;
-
-    window.localStorage.setItem(name, value);
-  }
-
-  /**
-   * Get a value from the store
-   * @param {String} name - value name
-   */
-  get (name) {
-    name = LocalStorageDriver._prefix + name;
-
-    return window.localStorage.getItem(name);
-  }
-
-  /**
-   * Remove a value from the store
-   * @param {String} name - value name
-   */
-  remove (name) {
-    name = LocalStorageDriver._prefix + name;
-
-    window.localStorage.removeItem(name);
-  }
-
-  /**
-   * Storage keys
-   * @returns {Array<String>} - Stored keys
-   */
-  keys () {
-    const keys = [];
-    const storage = window.localStorage;
-    const prefix = LocalStorageDriver._prefix;
-
-    for (let i = 0; i < storage.length; i++) {
-      let key = storage.key(i);
-
-      if (key.startsWith(prefix)) {
-        key = key.replace(new RegExp(`^${prefix}`), '');
-
-        keys.push(key);
-      }
-    }
-
-    return keys;
-  }
-}

package/src/storage/StorageManager.js

@@ -1,109 +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 StaticClass from '../utils/StaticClass';
-import CookiesDriver from './CookiesDriver';
-import DummyDriver from './DummyDriver';
-import FileDriver from './FileDriver';
-import LocalStorageDriver from './LocalStorageDriver';
-
-/**
- * @private
- */
-export default class StorageManager extends StaticClass {
-  /**
-   * Available storage drivers
-   * @returns {Array.<function>} - Available storage drivers
-   */
-  static get available () {
-    return [
-      DummyDriver,
-      LocalStorageDriver,
-      // CookiesDriver,
-      FileDriver,
-    ].filter(x => x.available);
-  }
-
-  /**
-   * Get LocalStorageDriver instance
-   * @returns {LocalStorageDriver} - Instance
-   */
-  static get localStorage () {
-    return new LocalStorageDriver();
-  }
-
-  /**
-   * Get CookiesDriver instance
-   * @returns {CookiesDriver} - Instance
-   */
-  static get cookies () {
-    return new CookiesDriver();
-  }
-
-  /**
-   * Get FileDriver instance
-   * @returns {FileDriver} - Instance
-   */
-  static get file () {
-    return new FileDriver();
-  }
-
-  /**
-   * Get DummyDriver instance
-   * @returns {DummyDriver} - Instance
-   */
-  static get dummy () {
-    return new DummyDriver();
-  }
-
-  /**
-   * Returns the best available storage driver. For a secure driver use {@link StorageManager#secure}
-   * @returns {DataStoreContract} - Best available storage driver
-   */
-  static get best () {
-    return new this.available[0]();
-  }
-
-  /**
-   * Returns the a secure storage driver
-   * @returns {DataStoreContract} - Secure storage driver
-   */
-  static get secure () {
-    const C = this.available.filter(x => x.secure)[0];
-
-    if (typeof C === 'undefined') {
-      return StorageManager.best;
-    }
-
-    return new C();
-  }
-}

package/src/traits/HandlesImages.js

@@ -1,50 +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 './Trait';
-import ImageHandler from '../ImageHandler';
-
-
-/**
- * Adds the imageHandler to a resource
- *
- * @mixin
- */
-export default class HandlesImages extends Trait {
-  /**
-   * Handler for item image management
-   * @returns {ImageHandler} - Image handler
-   */
-  get imageHandler () {
-    return new ImageHandler(this.api, this);
-  }
-}