@mapcreator/api 2.6.0 → 2.7.0

package/manual/js/sandbox.js

@@ -20,7 +20,7 @@ function easyAuth() {
 
 console.log('You can play around with the api in here, the library is bound to window.mapcreator. Authentication ');
 console.log('can easily be done by running the command easyAuth(). See the docs for more information here: ');
-console.log('https://docs.mapcreator.io/wrapper/manual/example/examples.authentication.html');
+console.log('https://docs.mapcreator.io/wrapper/manual/examples.authentication.html');
 console.log('Example: easyAuth().then(api => window.api = api);');
 console.log('window.mapcreator =', window.mapcreator);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapcreator/api",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "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';
@@ -81,6 +83,7 @@ import ValidationError from './errors/ValidationError';
 import ApiError from './errors/ApiError';
 import { wrapKyPrefixUrl } from './utils/requests';
 import EventEmitter from 'events';
+import LayerGroup from './resources/LayerGroup';
 
 /**
  * Base API class
@@ -533,6 +536,15 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
     return this.static(Layer);
   }
 
+  /**
+   * Layer group accessor
+   * @see {@link LayerGroup}
+   * @returns {ResourceProxy} - A proxy for accessing the resource
+   */
+  get layerGroups () {
+    return this.static(LayerGroup);
+  }
+
   /**
    * Mapstyle accessor
    * @see {@link Mapstyle}
@@ -587,6 +599,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/LayerGroup.js

@@ -0,0 +1,57 @@
+/*
+ * 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 OwnableResource from '../traits/OwnableResource';
+import { mix } from '../utils/reflection';
+import Layer from './Layer';
+import CrudSetBase from './base/CrudSetBase';
+import { OwnedResourceProxy } from '../proxy';
+
+/**
+ * Layer
+ * @extends CrudBase
+ * @mixes OwnableResource
+ * @mixes HandlesImages
+ */
+export default class LayerGroup extends mix(CrudSetBase, OwnableResource) {
+  static get resourceName () {
+    return 'layer-groups';
+  }
+
+  get items () {
+    return new OwnedResourceProxy(this.api, this, this._Child);
+  }
+
+  get _Child () {
+    return Layer;
+  }
+}

package/src/resources/Organisation.js

@@ -48,6 +48,7 @@ import Tag from './Tag';
 import User from './User';
 import { makeCancelable } from '../utils/helpers';
 import { encodeQueryString } from '../utils/requests';
+import LayerGroup from './LayerGroup';
 
 
 export default class Organisation extends CrudBase {
@@ -120,6 +121,14 @@ export default class Organisation extends CrudBase {
     return new OwnedResourceProxy(this.api, this, Layer);
   }
 
+  /**
+   * Get a proxy for layer groups linked to the organisation
+   * @returns {OwnedResourceProxy} - A proxy for accessing the resource
+   */
+  get layerGroups () {
+    return new OwnedResourceProxy(this.api, this, LayerGroup);
+  }
+
   /**
    * Get a proxy for jobs linked to the organisation, also known as company maps
    * @returns {SimpleResourceProxy} - A proxy for accessing the resource

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/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';