@mapcreator/api 2.9.0 → 3.0.1

package/dist/utils/requests.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Encodes an object to a http query string with support for recursion
+ * @param {object<string, *>} paramsObject - data to be encoded
+ * @returns {string} - encoded http query string
+ *
+ * @private
+ */
+export function encodeQueryString(paramsObject: any): string;
+/**
+ * Wraps around ky to ensure that the prefix is correctly set
+ * @param {function(*=, *=): Response} fn - ky instance
+ * @param {string} baseUrl - url to be prefixed
+ * @returns {function(*=, *=): Response}
+ * @private
+ */
+export function wrapKyPrefixUrl(fn: () => Response, baseUrl: string): () => Response;
+/**
+ * @private
+ */
+export const FormData: {
+    new (form?: HTMLFormElement): FormData;
+    prototype: FormData;
+} | typeof import("form-data");
+//# sourceMappingURL=requests.d.ts.map

package/dist/utils/uuid.d.ts

@@ -0,0 +1,19 @@
+/**
+ * UUID util class
+ * @static
+ * @private
+ */
+export default class Uuid extends StaticClass {
+    /**
+     * Generate a UUID4 string
+     * @returns {string} - Uuid
+     */
+    static uuid4(): string;
+    /**
+     * Empty uuid as per spec
+     * @returns {string} - Uuid
+     */
+    static nil(): string;
+}
+import StaticClass from "./StaticClass";
+//# sourceMappingURL=uuid.d.ts.map

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@mapcreator/api",
-  "version": "2.9.0",
+  "version": "3.0.1",
   "description": "Mapcreator JavaScript API",
   "main": "dist/bundle.js",
   "repository": "https://gitlab.com/mapcreator/api-wrapper.git",
   "author": "Bas Bieling <b.bieling@mapcreator.eu>",
   "license": "BSD-3-Clause",
+  "types": "dist/index.d.ts",
   "files": [
     "dist",
     "src",
@@ -48,6 +49,7 @@
     "nyc": "^15.1.0",
     "tap-nyc": "^1.0.3",
     "terser-webpack-plugin": "^3.0.8",
+    "typescript": "^4.9.4",
     "webpack": "^4.43.0",
     "webpack-cli": "^3.3.11",
     "webpack-merge": "^4.2.2",
@@ -55,6 +57,7 @@
   },
   "scripts": {
     "build": "APP_ENV=production npx webpack",
+    "postbuild": "APP_ENV=production npx tsc || true && rm -v dist/*.map dist/**/*.map",
     "watch": "npx webpack --progress --watch",
     "docs": "npx esdoc && ./scripts/inject_docs_viewport.sh",
     "lint": "npx eslint --no-color --format checkstyle --output-file build/checkstyle.xml src",

package/src/Mapcreator.js

@@ -73,6 +73,7 @@ import {
   ProductTour,
   ProductTourStep,
   LayerFaq,
+  LayerGroup,
 } from './resources';
 import ResourceBase from './resources/base/ResourceBase';
 import Injectable from './traits/Injectable';
@@ -84,7 +85,6 @@ 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
@@ -351,7 +351,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Choropleth accessor
    * @see {@link Choropleth}
-   * @returns {GeoResourceProxy} - A proxy for accessing the resource
+   * @returns {GeoResourceProxy<Choropleth>} - A proxy for accessing the resource
    */
   get choropleths () {
     return new GeoResourceProxy(this, Choropleth);
@@ -360,7 +360,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * VectorChoropleth accessor
    * @see {@link VectorChoropleth}
-   * @returns {GeoResourceProxy} - A proxy for accessing the resource
+   * @returns {GeoResourceProxy<VectorChoropleth>} - A proxy for accessing the resource
    */
   get vectorChoropleths () {
     return new GeoResourceProxy(this, VectorChoropleth);
@@ -369,7 +369,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Color accessor
    * @see {@link Color}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Color>} - A proxy for accessing the resource
    */
   get colors () {
     return this.static(Color);
@@ -378,7 +378,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Tag accessor
    * @see {@link Tag}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Tag>} - A proxy for accessing the resource
    */
   get tags () {
     return this.static(Tag);
@@ -386,8 +386,8 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
 
   /**
    * Tag accessor
-   * @see {@link Tag}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @see {@link TagType}
+   * @returns {ResourceProxy<TagType>} - A proxy for accessing the resource
    */
   get tagTypes () {
     return this.static(TagType);
@@ -396,7 +396,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Contract accessor
    * @see {@link Contract}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Contract>} - A proxy for accessing the resource
    */
   get contracts () {
     return this.static(Contract);
@@ -405,7 +405,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Dimension accessor
    * @see {@link Dimension}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Dimension>} - A proxy for accessing the resource
    */
   get dimensions () {
     return this.static(Dimension);
@@ -414,7 +414,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Dimension set accessor
    * @see {@link DimensionSet}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<DimensionSet>} - A proxy for accessing the resource
    */
   get dimensionSets () {
     return this.static(DimensionSet);
@@ -423,7 +423,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Faq accessor
    * @see {@link Faq}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Faq>} - A proxy for accessing the resource
    */
   get faqs () {
     return this.static(Faq);
@@ -432,7 +432,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Feature accessor
    * @see {@link Feature}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Feature>} - A proxy for accessing the resource
    */
   get features () {
     return this.static(Feature);
@@ -441,7 +441,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Featured jobs accessor
    * @see {@link Job}
-   * @returns {SimpleResourceProxy} - A proxy for accessing the resource
+   * @returns {SimpleResourceProxy<Job>} - A proxy for accessing the resource
    */
   get featuredMaps () {
     return new SimpleResourceProxy(this, Job, '/jobs/featured');
@@ -450,7 +450,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Font accessor
    * @see {@link Font}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Font>} - A proxy for accessing the resource
    */
   get fonts () {
     return this.static(Font);
@@ -459,7 +459,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * FontFamily accessor
    * @see {@link FontFamily}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<FontFamily>} - A proxy for accessing the resource
    */
   get fontFamilies () {
     return this.static(FontFamily);
@@ -468,7 +468,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Highlight accessor
    * @see {@link Highlight}
-   * @returns {GeoResourceProxy} - A proxy for accessing the resource
+   * @returns {GeoResourceProxy<Highlight>} - A proxy for accessing the resource
    */
   get highlights () {
     return new GeoResourceProxy(this, Highlight);
@@ -477,7 +477,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * VectorHighlight accessor
    * @see {@link VectorHighlight}
-   * @returns {GeoResourceProxy} - A proxy for accessing the resource
+   * @returns {GeoResourceProxy<VectorHighlight>} - A proxy for accessing the resource
    */
   get vectorHighlights () {
     return new GeoResourceProxy(this, VectorHighlight);
@@ -486,7 +486,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * InsetMap accessor
    * @see {@link InsetMap}
-   * @returns {GeoResourceProxy} - A proxy for accessing the resource
+   * @returns {GeoResourceProxy<InsetMap>} - A proxy for accessing the resource
    */
   get insetMaps () {
     return new GeoResourceProxy(this, InsetMap);
@@ -495,7 +495,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Job accessor
    * @see {@link Job}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Job>} - A proxy for accessing the resource
    */
   get jobs () {
     return this.static(Job);
@@ -504,7 +504,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * JobShare accessor
    * @see {@link JobShare}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<JobShare>} - A proxy for accessing the resource
    */
   get jobShares () {
     return this.static(JobShare);
@@ -513,7 +513,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * JobType accessor
    * @see {@link JobType}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<JobType>} - A proxy for accessing the resource
    */
   get jobTypes () {
     return this.static(JobType);
@@ -522,7 +522,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Language accessor
    * @see {@link Language}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Language>} - A proxy for accessing the resource
    */
   get languages () {
     return this.static(Language);
@@ -531,7 +531,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Layer accessor
    * @see {@link Layer}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Layer>} - A proxy for accessing the resource
    */
   get layers () {
     return this.static(Layer);
@@ -540,7 +540,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * LayerFaq accessor
    * @see {@link LayerFaq}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<LayerFaq>} - A proxy for accessing the resource
    */
   get layerFaqs () {
     return this.static(LayerFaq);
@@ -549,7 +549,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Layer group accessor
    * @see {@link LayerGroup}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<LayerGroup>} - A proxy for accessing the resource
    */
   get layerGroups () {
     return this.static(LayerGroup);
@@ -558,7 +558,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Mapstyle accessor
    * @see {@link Mapstyle}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Mapstyle>} - A proxy for accessing the resource
    */
   get mapstyles () {
     return this.static(Mapstyle);
@@ -567,7 +567,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * MapstyleSet accessor
    * @see {@link MapstyleSet}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<MapstyleSet>} - A proxy for accessing the resource
    */
   get mapstyleSets () {
     return this.static(MapstyleSet);
@@ -576,7 +576,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Notification accessor
    * @see {@link Notification}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Notification>} - A proxy for accessing the resource
    */
   get notifications () {
     return this.static(Notification);
@@ -585,7 +585,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Message accessor
    * @see {@link Message}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Message>} - A proxy for accessing the resource
    */
   get messages () {
     return this.static(Message);
@@ -594,7 +594,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Organisation accessor
    * @see {@link Organisation}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Organisation>} - A proxy for accessing the resource
    */
   get organisations () {
     return this.static(Organisation);
@@ -603,16 +603,26 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Permission accessor
    * @see {@link Permission}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Permission>} - A proxy for accessing the resource
    */
   get permissions () {
     return this.static(Permission);
   }
 
+  /**
+   * Product tour accessor
+   * @see {@link ProductTour}
+   * @returns {ResourceProxy<ProductTour>} - A proxy for accessing the resource
+   */
   get productTours () {
     return this.static(ProductTour);
   }
 
+  /**
+   * Product tour step accessor
+   * @see {@link ProductTourStep}
+   * @returns {ResourceProxy<ProductTourStep>} - A proxy for accessing the resource
+   */
   get productTourSteps () {
     return this.static(ProductTourStep);
   }
@@ -620,7 +630,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Role accessor
    * @see {@link Role}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Role>} - A proxy for accessing the resource
    */
   get roles () {
     return this.static(Role);
@@ -629,7 +639,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * Svg accessor
    * @see {@link Svg}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<Svg>} - A proxy for accessing the resource
    */
   get svgs () {
     return this.static(Svg);
@@ -638,7 +648,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * SvgSet accessor
    * @see {@link SvgSet}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<SvgSet>} - A proxy for accessing the resource
    */
   get svgSets () {
     return this.static(SvgSet);
@@ -647,7 +657,7 @@ export default class Mapcreator extends mix(EventEmitter, Injectable) {
   /**
    * User accessor
    * @see {@link User}
-   * @returns {ResourceProxy} - A proxy for accessing the resource
+   * @returns {ResourceProxy<User>} - A proxy for accessing the resource
    */
   get users () {
     return this.static(User);

package/src/enums/index.js

@@ -30,7 +30,7 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-export Enum from './Enum';
+export { default as Enum } from './Enum';
 export { DeletedState } from './DeletedState';
 export { ResultStatus } from './ResultStatus';
 export { JobShareVisibility } from './JobShareVisibility';

package/src/errors/index.js

@@ -31,9 +31,9 @@
  */
 
 export * from './AbstractError';
-export ApiError from './ApiError';
-export ValidationError from './ValidationError';
-export NodeError from './NodeError';
-export OAuthError from './OAuthError';
-export StaticClassError from './StaticClassError';
-export GeoError from './GeoError';
+export { default as ApiError } from './ApiError';
+export { default as ValidationError } from './ValidationError';
+export { default as NodeError } from './NodeError';
+export { default as OAuthError } from './OAuthError';
+export { default as StaticClassError } from './StaticClassError';
+export { default as GeoError } from './GeoError';

package/src/index.js

@@ -31,34 +31,34 @@
  */
 
 // Core
-export Mapcreator from './Mapcreator';
-export RequestParameters from './RequestParameters';
-export StorageManager from './storage/StorageManager';
+export { default as Mapcreator } from './Mapcreator';
+export { default as RequestParameters } from './RequestParameters';
+export { default as StorageManager } from './storage/StorageManager';
 
 // Enums
-export Enum from './enums/Enum';
+export { default as Enum } from './enums/Enum';
 export { DeletedState, ResultStatus } from './enums';
 
 // Flows
-export OAuth from './oauth/OAuth';
-export OAuthToken from './oauth/OAuthToken';
-export ImplicitFlow from './oauth/ImplicitFlow';
-export ImplicitFlowPopup from './oauth/ImplicitFlowPopup';
-export PasswordFlow from './oauth/PasswordFlow';
-export DummyFlow from './oauth/DummyFlow';
+export { default as OAuth } from './oauth/OAuth';
+export { default as OAuthToken } from './oauth/OAuthToken';
+export { default as ImplicitFlow } from './oauth/ImplicitFlow';
+export { default as ImplicitFlowPopup } from './oauth/ImplicitFlowPopup';
+export { default as PasswordFlow } from './oauth/PasswordFlow';
+export { default as DummyFlow } from './oauth/DummyFlow';
 
 // Exceptions
-export ApiError from './errors/ApiError';
+export { default as ApiError } from './errors/ApiError';
 export * from './errors/AbstractError';
-export ValidationError from './errors/ValidationError';
-export StaticClassError from './errors/StaticClassError';
+export { default as ValidationError } from './errors/ValidationError';
+export { default as StaticClassError } from './errors/StaticClassError';
 
 // Resources
 export * as resources from './resources';
 
 // Helpers
 export * as helpers from './utils/helpers';
-export ResourceLister from './ResourceLister';
+export { default as ResourceLister } from './ResourceLister';
 export * as geo from './utils/geo';
 
 // Errors

package/src/proxy/index.js

@@ -30,8 +30,8 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-export GeoResourceProxy from './GeoResourceProxy';
-export OrganisationProxy from './OrganisationProxy';
-export OwnedResourceProxy from './OwnedResourceProxy';
-export ResourceProxy from './ResourceProxy';
-export SimpleResourceProxy from './SimpleResourceProxy';
+export { default as GeoResourceProxy } from './GeoResourceProxy';
+export { default as OrganisationProxy } from './OrganisationProxy';
+export { default as OwnedResourceProxy } from './OwnedResourceProxy';
+export { default as ResourceProxy } from './ResourceProxy';
+export { default as SimpleResourceProxy } from './SimpleResourceProxy';

package/src/resources/index.js

@@ -30,42 +30,43 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-export Choropleth from './Choropleth';
-export Color from './Color';
-export Contract from './Contract';
-export Dimension from './Dimension';
-export DimensionSet from './DimensionSet';
-export Domain from './Domain';
-export Faq from './Faq';
-export Feature from './Feature';
-export Font from './Font';
-export FontFamily from './FontFamily';
-export Highlight from './Highlight';
-export InsetMap from './InsetMap';
-export Job from './Job';
-export JobResult from './JobResult';
-export JobRevision from './JobRevision';
-export JobShare from './JobShare';
-export JobType from './JobType';
-export Language from './Language';
-export Layer from './Layer';
-export LayerFaq from './LayerFaq';
-export Mapstyle from './Mapstyle';
-export MapstyleSet from './MapstyleSet';
-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';
-export Tag from './Tag';
-export TagType from './TagType';
-export User from './User';
-export VectorHighlight from './VectorHighlight';
-export VectorChoropleth from './VectorChoropleth';
+export { default as Choropleth } from './Choropleth';
+export { default as Color } from './Color';
+export { default as Contract } from './Contract';
+export { default as Dimension } from './Dimension';
+export { default as DimensionSet } from './DimensionSet';
+export { default as Domain } from './Domain';
+export { default as Faq } from './Faq';
+export { default as Feature } from './Feature';
+export { default as Font } from './Font';
+export { default as FontFamily } from './FontFamily';
+export { default as Highlight } from './Highlight';
+export { default as InsetMap } from './InsetMap';
+export { default as Job } from './Job';
+export { default as JobResult } from './JobResult';
+export { default as JobRevision } from './JobRevision';
+export { default as JobShare } from './JobShare';
+export { default as JobType } from './JobType';
+export { default as Language } from './Language';
+export { default as Layer } from './Layer';
+export { default as LayerFaq } from './LayerFaq';
+export { default as LayerGroup } from './LayerGroup';
+export { default as Mapstyle } from './Mapstyle';
+export { default as MapstyleSet } from './MapstyleSet';
+export { default as Message } from './Message';
+export { default as Notification } from './Notification';
+export { default as Organisation } from './Organisation';
+export { default as Permission } from './Permission';
+export { default as ProductTour } from './ProductTour';
+export { default as ProductTourStep } from './ProductTourStep';
+export { default as Role } from './Role';
+export { default as Svg } from './Svg';
+export { default as SvgSet } from './SvgSet';
+export { default as Tag } from './Tag';
+export { default as TagType } from './TagType';
+export { default as User } from './User';
+export { default as VectorHighlight } from './VectorHighlight';
+export { default as VectorChoropleth } from './VectorChoropleth';
 
 import CrudBase from './base/CrudBase';
 import CrudSetBase from './base/CrudSetBase';