@mapcreator/api 2.5.0 → 2.6.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapcreator/api",
-  "version": "2.5.0",
+  "version": "2.6.2",
   "description": "Mapcreator JavaScript API",
   "main": "dist/bundle.js",
   "repository": "https://gitlab.com/mapcreator/api-wrapper.git",
@@ -56,7 +56,7 @@
   "scripts": {
     "build": "APP_ENV=production npx webpack",
     "watch": "npx webpack --progress --watch",
-    "docs": "npx esdoc",
+    "docs": "npx esdoc && ./scripts/inject_docs_viewport.sh",
     "lint": "npx eslint --no-color --format checkstyle --output-file build/checkstyle.xml src",
     "clean": "rm -fr dist docs build || true",
     "all": "npm run clean && npm run lint && npm run build && npm run test && npm run docs",

package/src/Mapcreator.js

@@ -70,6 +70,8 @@ import {
   User,
   VectorHighlight,
   VectorChoropleth,
+  ProductTour,
+  ProductTourStep,
 } from './resources';
 import ResourceBase from './resources/base/ResourceBase';
 import Injectable from './traits/Injectable';
@@ -587,6 +589,14 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
     return this.static(Permission);
   }
 
+  get productTours () {
+    return this.static(ProductTour);
+  }
+
+  get productTourSteps () {
+    return this.static(ProductTourStep);
+  }
+
   /**
    * Role accessor
    * @see {@link Role}

package/src/resources/Message.js

@@ -32,12 +32,36 @@
 
 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));
@@ -45,4 +69,26 @@ export default class Message extends CrudBase {
 
     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/ProductTour.js

@@ -0,0 +1,53 @@
+/*
+ * 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 { mix } from '../utils/reflection';
+import CrudSetBase from './base/CrudSetBase';
+import ProductTourStep from './ProductTourStep';
+
+/**
+ * Mapstyle set
+ * @extends CrudSetBase
+ */
+export default class ProductTour extends mix(CrudSetBase) {
+  static get resourcePath () {
+    return '/product-tours/{id}';
+  }
+
+  static get resourceName () {
+    return 'product-tours';
+  }
+
+  get _Child () {
+    return ProductTourStep;
+  }
+}

package/src/resources/ProductTourStep.js

@@ -0,0 +1,48 @@
+/*
+ * 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 { mix } from '../utils/reflection';
+import CrudSetItemBase from './base/CrudSetItemBase';
+
+/**
+ * @extends CrudSetItemBase
+ */
+export default class ProductTourStep extends mix(CrudSetItemBase) {
+  static get resourceName () {
+    return 'product-tours/steps';
+  }
+
+  static get parentKey () {
+    return 'product_tour_id';
+  }
+}
+

package/src/resources/User.js

@@ -103,11 +103,20 @@ export default class User extends CrudBase {
   }
 
   /**
-   * Get the list messagse linked to the user
-   * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+   * Get a list of read/unread messages for the user
+   * @returns {CancelablePromise<{read: Message[], unread: Message[]}>} - Read and unread messages
    */
-  get messages () {
-    return this._proxyResourceList(Message);
+  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)),
+      };
+    });
   }
 
   /**

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/index.js

@@ -55,6 +55,8 @@ export Message from './Message';
 export Notification from './Notification';
 export Organisation from './Organisation';
 export Permission from './Permission';
+export ProductTour from './ProductTour';
+export ProductTourStep from './ProductTourStep';
 export Role from './Role';
 export Svg from './Svg';
 export SvgSet from './SvgSet';