@mapcreator/api 2.4.1 → 2.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapcreator/api",
-  "version": "2.4.1",
+  "version": "2.6.1",
   "description": "Mapcreator JavaScript API",
   "main": "dist/bundle.js",
   "repository": "https://gitlab.com/mapcreator/api-wrapper.git",

package/src/Mapcreator.js

@@ -58,6 +58,7 @@ import {
   Layer,
   Mapstyle,
   MapstyleSet,
+  Message,
   Notification,
   Organisation,
   Permission,
@@ -559,6 +560,15 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
     return this.static(Notification);
   }
 
+  /**
+   * Message accessor
+   * @see {@link Message}
+   * @returns {ResourceProxy} - A proxy for accessing the resource
+   */
+  get messages () {
+    return this.static(Message);
+  }
+
   /**
    * Organisation accessor
    * @see {@link Organisation}

package/src/resources/Message.js

@@ -0,0 +1,94 @@
+/*
+ * 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 CrudBase from './base/CrudBase';
+import MessageVariant from './MessageVariant';
+import { makeCancelable } from '../utils/helpers';
+import { camel as camelCase, snake as snakeCase } from 'case';
+
+export default class Message extends CrudBase {
+  static get resourceName () {
+    return 'messages';
+  }
+
+  toObject (camelCaseKeys = false) {
+    const superObject = super.toObject(camelCaseKeys);
+
+    superObject.variants = superObject.variants.map(variant => {
+      if (variant instanceof MessageVariant) {
+        return variant.toObject(camelCaseKeys);
+      }
+
+      const caseFn = camelCaseKeys ? camelCase : snakeCase;
+      const res = {};
+      const fields = Object.keys(variant);
+
+      for (const field of fields) {
+        res[caseFn(field)] = variant[field];
+      }
+
+      return res;
+    });
+
+    return superObject;
+  }
+
+  _guessType (name, value) {
+    if (name === 'variants') {
+      return Array.from(value).map(data => new MessageVariant(this.api, data));
+    }
+
+    return super._guessType(name, value);
+  }
+
+  _buildCreateData () {
+    return this.toObject();
+  }
+
+  _update () {
+    return makeCancelable(async signal => {
+      const json = this.toObject();
+
+      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;
+    });
+  }
+}

package/src/resources/MessageVariant.js

@@ -0,0 +1,37 @@
+/*
+ * 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 MessageVariant extends ResourceBase {
+}

package/src/resources/User.js

@@ -46,6 +46,7 @@ import Language from './Language';
 import Layer from './Layer';
 import Mapstyle from './Mapstyle';
 import MapstyleSet from './MapstyleSet';
+import Message from './Message';
 import Notification from './Notification';
 import Organisation from './Organisation';
 import Permission from './Permission';
@@ -101,6 +102,23 @@ export default class User extends CrudBase {
     return this._proxyResourceList(Notification);
   }
 
+  /**
+   * Get a list of read/unread messages for the user
+   * @returns {CancelablePromise<{read: Message[], unread: Message[]}>} - Read and unread messages
+   */
+  messages () {
+    const url = `${this.url}/messages`;
+
+    return makeCancelable(async signal => {
+      const { data } = await this.api.ky.get(url, { signal }).json();
+
+      return {
+        read: data.read.map(o => new Message(this.api, o)),
+        unread: data.unread.map(o => new Message(this.api, o)),
+      };
+    });
+  }
+
   /**
    * Get the list mapstyle sets linked to the user
    * @returns {SimpleResourceProxy} - A proxy for accessing the resource

package/src/resources/base/CrudBase.js

@@ -111,7 +111,7 @@ export default class CrudBase extends ResourceBase {
    * @returns {CancelablePromise<CrudBase>} - Current instance
    * @throws {ApiError} - If the api returns errors
    * @throws {ValidationError} - If the submitted data isn't valid
-   * @private
+   * @protected
    */
   _update () {
     this._updateProperties();

package/src/resources/base/ResourceBase.js

@@ -37,7 +37,7 @@ import SimpleResourceProxy from '../../proxy/SimpleResourceProxy';
 import Injectable from '../../traits/Injectable';
 import { fnv32b } from '../../utils/hash';
 import { isParentOf, mix } from '../../utils/reflection';
-import { makeCancelable } from '../../utils/helpers';
+import { clone, makeCancelable } from '../../utils/helpers';
 
 function unique (input) {
   return input.filter((v, i) => input.findIndex(vv => vv === v) === i);
@@ -62,7 +62,7 @@ export default class ResourceBase extends mix(null, Injectable) {
     this.api = api;
 
     // De-reference
-    data = { ...data };
+    data = clone(data);
 
     // Normalize keys to snake_case
     // Fix data types
@@ -75,7 +75,7 @@ export default class ResourceBase extends mix(null, Injectable) {
         continue;
       }
 
-      data[newKey] = this.constructor._guessType(newKey, data[key]);
+      data[newKey] = this._guessType(newKey, data[key]);
 
       if (newKey !== key) {
         delete data[key];
@@ -295,7 +295,7 @@ export default class ResourceBase extends mix(null, Injectable) {
 
     if (!this.constructor.protectedFields.includes(key) && !this.constructor.readonly) {
       desc.set = val => {
-        this._properties[key] = ResourceBase._guessType(key, val);
+        this._properties[key] = this._guessType(key, val);
         delete this._url; // Clears url cache
       };
     }
@@ -309,10 +309,10 @@ export default class ResourceBase extends mix(null, Injectable) {
    * Guess type based on property name
    * @param {string} name - Field name
    * @param {*} value - Field Value
-   * @private
+   * @protected
    * @returns {*} - Original or converted value
    */
-  static _guessType (name, value) {
+  _guessType (name, value) {
     if (name.endsWith('_at') || name.startsWith('date_')) {
       return typeof value === 'string' ? new Date(value.replace(' ', 'T')) : value;
     } else if (/(_|^)id$/.test(name) && value !== null) {

package/src/resources/index.js

@@ -51,6 +51,7 @@ export Language from './Language';
 export Layer from './Layer';
 export Mapstyle from './Mapstyle';
 export MapstyleSet from './MapstyleSet';
+export Message from './Message';
 export Notification from './Notification';
 export Organisation from './Organisation';
 export Permission from './Permission';

package/src/utils/helpers.js

@@ -154,3 +154,25 @@ export function serializeUTCDate (date) {
 
   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;
+}