@nextgis/ngw-connector 1.8.0 → 1.9.2

package/README.md

@@ -83,7 +83,138 @@ ngwConnector.getResources({ cls: 'vector_layer', parent__id: 0 }); // find resou
 ngwConnector.getResource({ display_name: 'My layer', parent__id: 0 }); // get first
 ```
 
-Check out the [API Documentation](https://github.com/nextgis/nextgis_frontend/blob/master/markdown/ngw-connector.md)
+Check out the [API Documentation](https://code-api.nextgis.com/modules/ngw_connector.html)
+
+## NGW API
+
+[NextGIS Web API Doc](http://docs.nextgis.ru/docs_ngweb_dev/doc/developer/toc.html)
+
+```javascript
+ngwConnector.get(request_name, request_options, arguments);
+```
+
+[request_options](https://code-api.nextgis.com/interfaces/ngw_connector.RequestOptions.html)
+
+| request name | url | arguments |
+| - | - | - |
+| auth.current_user | /api/component/auth/current_user |  |
+| auth.group.collection | /api/component/auth/group/ |  |
+| auth.group.create | /auth/group/create |  |
+| auth.group.delete | /auth/group/{0}/delete | id |
+| auth.group.edit | /auth/group/{0}/edit | id |
+| auth.group.item | /api/component/auth/group/{0} | id |
+| auth.login_cookies | /api/component/auth/login |  |
+| auth.logout_cookies | /api/component/auth/logout |  |
+| auth.profile | /api/component/auth/profile |  |
+| auth.register | /api/component/auth/register |  |
+| auth.user.collection | /api/component/auth/user/ |  |
+| auth.user.create | /auth/user/create |  |
+| auth.user.delete | /auth/user/{0}/delete | id |
+| auth.user.edit | /auth/user/{0}/edit | id |
+| auth.user.item | /api/component/auth/user/{0} | id |
+| collector.resource.read | /collector/resource/{0}/read | id |
+| collector.resource.users | /collector/resource/{0}/users | id |
+| collector.settings | /api/component/collector/settings |  |
+| collector.settings.users | /collector/user |  |
+| collector.user | /collector/user/{0} | user_id |
+| feature_attachment.collection | /api/resource/{0}/feature/{1}/attachment/ | id,fid |
+| feature_attachment.download | /api/resource/{0}/feature/{1}/attachment/{2}/download | id,fid,aid |
+| feature_attachment.image | /api/resource/{0}/feature/{1}/attachment/{2}/image | id,fid,aid |
+| feature_attachment.item | /api/resource/{0}/feature/{1}/attachment/{2} | id,fid,aid |
+| feature_layer.feature.browse | /resource/{0}/feature/ | id |
+| feature_layer.feature.collection | /api/resource/{0}/feature/ | id |
+| feature_layer.feature.count | /api/resource/{0}/feature_count | id |
+| feature_layer.feature.item | /api/resource/{0}/feature/{1} | id,fid |
+| feature_layer.feature.item_extent | /api/resource/{0}/feature/{1}/extent | id,fid |
+| feature_layer.feature.show | /resource/{0}/feature/{1} | id,feature_id |
+| feature_layer.feature.update | /resource/{0}/feature/{1}/update | id,feature_id |
+| feature_layer.field | /resource/{0}/field/ | id |
+| feature_layer.geojson | /api/resource/{0}/geojson | id |
+| feature_layer.identify | /api/feature_layer/identify |  |
+| feature_layer.mvt | /api/component/feature_layer/mvt |  |
+| feature_layer.store | /api/resource/{0}/store/ | id |
+| feature_layer.store.item | /resource/{0}/store/{1} | id,feature_id |
+| file_upload.collection | /api/component/file_upload/ |  |
+| file_upload.item | /api/component/file_upload/{0} | id |
+| file_upload.upload | /api/component/file_upload/upload |  |
+| formbuilder.formbuilder_form_ngfp | /api/resource/{0}/ngfp | id |
+| layer.extent | /api/resource/{0}/extent | id |
+| postgis.connection.inspect | /api/resource/{0}/inspect/ | id |
+| postgis.connection.inspect.table | /api/resource/{0}/inspect/{1}/ | id,table_name |
+| pyramid.company_logo | /api/component/pyramid/company_logo |  |
+| pyramid.control_panel | /control-panel |  |
+| pyramid.control_panel.sysinfo | /control-panel/sysinfo |  |
+| pyramid.cors | /api/component/pyramid/cors |  |
+| pyramid.custom_css | /api/component/pyramid/custom_css |  |
+| pyramid.estimate_storage | /api/component/pyramid/estimate_storage |  |
+| pyramid.healthcheck | /api/component/pyramid/healthcheck |  |
+| pyramid.home_path | /api/component/pyramid/home_path |  |
+| pyramid.kind_of_data | /api/component/pyramid/kind_of_data |  |
+| pyramid.locdata | /api/component/pyramid/locdata/{0}/{1} | component,locale |
+| pyramid.logo | /api/component/pyramid/logo |  |
+| pyramid.pkg_version | /api/component/pyramid/pkg_version |  |
+| pyramid.route | /api/component/pyramid/route |  |
+| pyramid.settings | /api/component/pyramid/settings |  |
+| pyramid.statistics | /api/component/pyramid/statistics |  |
+| pyramid.storage | /api/component/pyramid/storage |  |
+| pyramid.system_name | /api/component/pyramid/system_name |  |
+| qgis.style_qml | /api/resource/{0}/qml | id |
+| render.image | /api/component/render/image |  |
+| render.legend | /api/resource/{0}/legend | id |
+| render.tile | /api/component/render/tile |  |
+| render.tile_cache.seed_status | /api/resource/{0}/tile_cache/seed_status | id |
+| resource.collection | /api/resource/ |  |
+| resource.create | /resource/{0}/create | id |
+| resource.delete | /resource/{0}/delete | id |
+| resource.export | /api/resource/{0}/export | id |
+| resource.file_download | /api/resource/{0}/file/{1} | id,name |
+| resource.item | /api/resource/{0} | id |
+| resource.json | /resource/{0}/json | id |
+| resource.permission | /api/resource/{0}/permission | id |
+| resource.permission.explain | /api/resource/{0}/permission/explain | id |
+| resource.preview | /api/resource/{0}/preview.png | id |
+| resource.quota | /api/resource/quota |  |
+| resource.resource_export | /api/component/resource/resource_export |  |
+| resource.schema | /resource/schema |  |
+| resource.search | /api/resource/search/ |  |
+| resource.show | /resource/{0} | id |
+| resource.tree | /resource/{0}/tree | id |
+| resource.update | /resource/{0}/update | id |
+| resource.volume | /api/resource/{0}/volume | id |
+| resource.widget | /resource/widget |  |
+| spatial_ref_sys.collection | /api/component/spatial_ref_sys/ |  |
+| spatial_ref_sys.convert | /api/component/spatial_ref_sys/convert |  |
+| spatial_ref_sys.geom_area | /api/component/spatial_ref_sys/{0}/geom_area | id |
+| spatial_ref_sys.geom_length | /api/component/spatial_ref_sys/{0}/geom_length | id |
+| spatial_ref_sys.geom_transform | /api/component/spatial_ref_sys/{0}/geom_transform | id |
+| spatial_ref_sys.get | /api/component/spatial_ref_sys/{0} | id |
+| srs.create | /srs/create |  |
+| srs.delete | /srs/{0}/delete | id |
+| srs.edit | /srs/{0}/edit | id |
+| tmsclient.connection.layers | /api/component/tmsclient/{0}/layers/ | id |
+| tracker.export_to_gpx | /tracker/gpx |  |
+| tracker.get.stops | /tracker/stops |  |
+| tracker.get_amd_static_url | /tracker/amd/static/url/ |  |
+| tracker.get_device_types | /tracker/device_types |  |
+| tracker.get_full_tracks | /tracker/tracks/full |  |
+| tracker.get_last_activity_tracker | /tracker/activity/last |  |
+| tracker.get_short_tracks | /tracker/tracks/short |  |
+| tracker.get_tracker_last_points | /tracker/last/points |  |
+| tracker.get_tracker_lines | /tracker/lines |  |
+| tracker.get_tracker_points | /tracker/points |  |
+| tracker.get_trackers | /tracker/trackers/tree |  |
+| tracker.receive_packet | /tracker/{0}/receive | unique_id |
+| tracker.reports | /tracker/reports/ |  |
+| tracker.reports.build | /tracker/report/build/ |  |
+| tracker.settings | /api/component/tracker/settings |  |
+| vector_layer.dataset | /api/component/vector_layer/dataset |  |
+| webmap.annotation.collection | /api/resource/{0}/annotation/ | id |
+| webmap.annotation.item | /api/resource/{0}/annotation/{1} | id,annotation_id |
+| webmap.display | /resource/{0}/display | id |
+| webmap.display.tiny | /resource/{0}/display/tiny | id |
+| webmap.settings | /api/component/webmap/settings |  |
+| wfsserver.wfs | /api/resource/{0}/wfs | id |
+| wmsserver.wms | /api/resource/{0}/wms | id |
 
 ## Commercial support
 

package/lib/index.d.ts

@@ -303,11 +303,11 @@ declare class NgwConnector {
     /**
      * {@inheritDoc ResourcesControl.getOne}
      */
-    getResource(resource: ResourceDefinition): CancelablePromise<ResourceItem | undefined>;
+    getResource(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem | undefined>;
     /**
      * {@inheritDoc ResourcesControl.getOneOrFail}
      */
-    getResourceOrFail(resource: ResourceDefinition): CancelablePromise<ResourceItem>;
+    getResourceOrFail(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem>;
     /**
      * @deprecated - use {@link NgwConnector.getResource}
      */
@@ -323,23 +323,23 @@ declare class NgwConnector {
     /**
      * {@inheritDoc ResourcesControl.getId}
      */
-    getResourceId(resource: ResourceDefinition): CancelablePromise<number | undefined>;
+    getResourceId(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<number | undefined>;
     /**
      * {@inheritDoc ResourcesControl.getIdOrFail}
      */
-    getResourceIdOrFail(resource: ResourceDefinition): CancelablePromise<number>;
+    getResourceIdOrFail(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<number>;
     /**
      * {@inheritDoc ResourcesControl.getMany}
      */
-    getResourcesBy(resource: DeepPartial<Resource>): CancelablePromise<ResourceItem[]>;
+    getResourcesBy(resource: DeepPartial<Resource>, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem[]>;
     /**
      * {@inheritDoc ResourcesControl.getParent}
      */
-    getResourceParent(resource: ResourceDefinition): CancelablePromise<ResourceItem | undefined>;
+    getResourceParent(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem | undefined>;
     /**
      * {@inheritDoc ResourcesControl.getChildrenOf}
      */
-    getResourceChildren(resource: ResourceDefinition): CancelablePromise<ResourceItem[]>;
+    getResourceChildren(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem[]>;
     /**
      * {@inheritDoc ResourcesControl.update}
      */
@@ -702,7 +702,7 @@ export declare interface Resource {
     scopes: string[];
 }
 
-export declare type ResourceCls = 'vector_layer' | 'resource_group' | 'postgis_layer' | 'wmsserver_service' | 'basemap_layer' | 'postgis_connection' | 'webmap' | 'wfsserver_service' | 'vector_layer' | 'raster_layer' | 'mapserver_style' | 'qgis_vector_style' | 'qgis_raster_style' | 'raster_style' | 'file_bucket' | 'lookup_table' | 'wmsclient_layer' | 'wmsclient_connection' | 'formbuilder_form' | 'file_bucket' | 'terrain_provider' | 'model_3d' | 'tmsclient_layer';
+export declare type ResourceCls = 'resource_group' | 'postgis_layer' | 'wmsserver_service' | 'basemap_layer' | 'postgis_connection' | 'webmap' | 'wfsserver_service' | 'vector_layer' | 'raster_layer' | 'mapserver_style' | 'qgis_vector_style' | 'qgis_raster_style' | 'raster_style' | 'file_bucket' | 'lookup_table' | 'wmsclient_layer' | 'wmsclient_connection' | 'formbuilder_form' | 'file_bucket' | 'terrain_provider' | 'model_3d' | 'tmsclient_layer';
 
 export declare type ResourceDefinition = ResourceIdKeynameDef | DeepPartial<Resource>;
 
@@ -758,7 +758,7 @@ declare class ResourcesControl {
      * Fetching resource would be cached to speed up next call
      */
     getOne(resource: ResourceDefinition, requestOptions?: RequestOptions): CancelablePromise<ResourceItem | undefined>;
-    getOneOrFail(resource: ResourceDefinition): CancelablePromise<ResourceItem>;
+    getOneOrFail(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem>;
     /**
      * A fast way to retrieve resource ID for any resource definition.
      * @param resource - Any available resource definition
@@ -769,7 +769,7 @@ declare class ResourcesControl {
      * then this method will come in handy to facilitate the extraction of the identifier
      * if the resource is specified through a keyname or other parameters.
      */
-    getId(resource: ResourceDefinition): CancelablePromise<number | undefined>;
+    getId(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<number | undefined>;
     /**
      * A fast way to retrieve resource ID for any resource definition.
      * @param resource - Any available resource definition
@@ -778,10 +778,10 @@ declare class ResourcesControl {
      * Similar with {@link NgwConnector.getResourceId | getResourceId} but rise error if resource is not exist.
      * To not make one more checks if the resource is definitely exists
      */
-    getIdOrFail(resource: ResourceDefinition): CancelablePromise<number>;
+    getIdOrFail(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<number>;
     getMany(resource: DeepPartial<Resource>, requestOptions?: RequestOptions): CancelablePromise<ResourceItem[]>;
-    getParent(resource: ResourceDefinition): CancelablePromise<ResourceItem | undefined>;
-    getChildrenOf(resource: ResourceDefinition): CancelablePromise<ResourceItem[]>;
+    getParent(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem | undefined>;
+    getChildrenOf(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem[]>;
     update(resource: ResourceDefinition, data: DeepPartial<ResourceItem>): CancelablePromise<ResourceItem | undefined>;
     /**
      * Fast way to delete resource from NGW and clean cache.

package/lib/ngw-connector.cjs.js

@@ -1,4 +1,4 @@
-/** Bundle of @nextgis/ngw-connector; version: 1.8.0; author: NextGIS */
+/** Bundle of @nextgis/ngw-connector; version: 1.9.2; author: NextGIS */
 'use strict';
 
 var events = require('events');
@@ -6,7 +6,7 @@ var CancelablePromise = require('@nextgis/cancelable-promise');
 var utils = require('@nextgis/utils');
 var Cache = require('@nextgis/cache');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e['default'] : e; }
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
 
 var CancelablePromise__default = /*#__PURE__*/_interopDefaultLegacy(CancelablePromise);
 var Cache__default = /*#__PURE__*/_interopDefaultLegacy(Cache);
@@ -238,8 +238,8 @@ class ResourcesControl {
         };
         return cache.add('resource', makeRequest, { resource });
     }
-    getOneOrFail(resource) {
-        return this.getOne(resource).then((res) => {
+    getOneOrFail(resource, requestOptions) {
+        return this.getOne(resource, requestOptions).then((res) => {
             if (res) {
                 return res;
             }
@@ -256,12 +256,12 @@ class ResourcesControl {
      * then this method will come in handy to facilitate the extraction of the identifier
      * if the resource is specified through a keyname or other parameters.
      */
-    getId(resource) {
+    getId(resource, requestOptions) {
         if (typeof resource === 'number') {
             return CancelablePromise__default.resolve(resource);
         }
         else if (typeof resource === 'string' || isObject(resource)) {
-            return this.getOne(resource).then((res) => {
+            return this.getOne(resource, requestOptions).then((res) => {
                 if (res) {
                     return res.resource.id;
                 }
@@ -277,8 +277,8 @@ class ResourcesControl {
      * Similar with {@link NgwConnector.getResourceId | getResourceId} but rise error if resource is not exist.
      * To not make one more checks if the resource is definitely exists
      */
-    getIdOrFail(resource) {
-        return this.getId(resource).then((resp) => {
+    getIdOrFail(resource, requestOptions) {
+        return this.getId(resource, requestOptions).then((resp) => {
             if (resp === undefined) {
                 throw new Error();
             }
@@ -314,18 +314,18 @@ class ResourcesControl {
             return items;
         });
     }
-    getParent(resource) {
-        return this.connector.getResource(resource).then((child) => {
+    getParent(resource, requestOptions) {
+        return this.getOne(resource, requestOptions).then((child) => {
             if (child) {
-                return this.connector.getResource(child.resource.parent.id);
+                return this.getOne(child.resource.parent.id, requestOptions);
             }
             return CancelablePromise__default.resolve(undefined);
         });
     }
-    getChildrenOf(resource) {
+    getChildrenOf(resource, requestOptions) {
         return this.getId(resource).then((parent) => {
             return this.connector
-                .get('resource.collection', { cache: true }, {
+                .get('resource.collection', { cache: true, ...requestOptions }, {
                 parent,
             })
                 .then((items) => {
@@ -732,14 +732,14 @@ class NgwConnector$1 {
     /**
      * {@inheritDoc ResourcesControl.getOne}
      */
-    getResource(resource) {
-        return this.resources.getOne(resource);
+    getResource(resource, requestOptions) {
+        return this.resources.getOne(resource, requestOptions);
     }
     /**
      * {@inheritDoc ResourcesControl.getOneOrFail}
      */
-    getResourceOrFail(resource) {
-        return this.resources.getOneOrFail(resource);
+    getResourceOrFail(resource, requestOptions) {
+        return this.resources.getOneOrFail(resource, requestOptions);
     }
     /**
      * @deprecated - use {@link NgwConnector.getResource}
@@ -762,32 +762,32 @@ class NgwConnector$1 {
     /**
      * {@inheritDoc ResourcesControl.getId}
      */
-    getResourceId(resource) {
-        return this.resources.getId(resource);
+    getResourceId(resource, requestOptions) {
+        return this.resources.getId(resource, requestOptions);
     }
     /**
      * {@inheritDoc ResourcesControl.getIdOrFail}
      */
-    getResourceIdOrFail(resource) {
-        return this.resources.getIdOrFail(resource);
+    getResourceIdOrFail(resource, requestOptions) {
+        return this.resources.getIdOrFail(resource, requestOptions);
     }
     /**
      * {@inheritDoc ResourcesControl.getMany}
      */
-    getResourcesBy(resource) {
-        return this.resources.getMany(resource);
+    getResourcesBy(resource, requestOptions) {
+        return this.resources.getMany(resource, requestOptions);
     }
     /**
      * {@inheritDoc ResourcesControl.getParent}
      */
-    getResourceParent(resource) {
-        return this.resources.getParent(resource);
+    getResourceParent(resource, requestOptions) {
+        return this.resources.getParent(resource, requestOptions);
     }
     /**
      * {@inheritDoc ResourcesControl.getChildrenOf}
      */
-    getResourceChildren(resource) {
-        return this.resources.getChildrenOf(resource);
+    getResourceChildren(resource, requestOptions) {
+        return this.resources.getChildrenOf(resource, requestOptions);
     }
     /**
      * {@inheritDoc ResourcesControl.update}