@nextgis/ngw-connector 1.12.0 → 1.13.5

package/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./lib/ngw-connector.cjs.prod.js');
-} else {
+if (process.env.NODE_ENV === 'development') {
   module.exports = require('./lib/ngw-connector.cjs.js');
+} else {
+  module.exports = require('./lib/ngw-connector.cjs.prod.js');
 }

package/lib/index.d.ts

@@ -128,6 +128,10 @@ export declare interface FileUploadResp {
 
 export declare type GeometryType = 'POINT' | 'LINESTRING' | 'POLYGON' | 'MULTIPOINT' | 'MULTILINESTRING' | 'MULTIPOLYGON' | 'POINTZ' | 'LINESTRINGZ' | 'POLYGONZ' | 'MULTIPOINTZ' | 'MULTILINESTRINGZ' | 'MULTIPOLYGONZ';
 
+export declare interface GetChildrenOfOptions extends Pick<RequestOptions, 'cache'> {
+    recursive?: boolean;
+}
+
 export declare interface GetRequestItemsResponseMap extends RequestItemKeys {
     'pyramid.route': PyramidRoute;
     'pyramid.settings': PyramidSettings;
@@ -184,6 +188,7 @@ declare class NgwConnector {
     user?: UserInfo;
     resources: ResourcesControl;
     private routeStr;
+    private activeRequests;
     constructor(options: NgwConnectorOptions);
     static create(options: NgwConnectorOptions): NgwConnector;
     /**
@@ -221,6 +226,9 @@ declare class NgwConnector {
      */
     getAuthorizationHeaders(credentials?: Credentials): RequestHeaders | undefined;
     makeClientId(credentials?: Credentials): string | undefined;
+    /** Stop all api requests */
+    abort(): void;
+    getActiveApiRequests(): CancelablePromise<any>[];
     /**
      * Send request to NGW api router.
      * @param name - NGW route name from {@link https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource.html#routes | routes}
@@ -303,11 +311,11 @@ declare class NgwConnector {
     /**
      * {@inheritDoc ResourcesControl.getOne}
      */
-    getResource(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem | undefined>;
+    getResource(resource: ResourceDefinition, requestOptions?: RequestOptions): CancelablePromise<ResourceItem | undefined>;
     /**
      * {@inheritDoc ResourcesControl.getOneOrFail}
      */
-    getResourceOrFail(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem>;
+    getResourceOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions): CancelablePromise<ResourceItem>;
     /**
      * @deprecated - use {@link NgwConnector.getResource}
      */
@@ -323,23 +331,23 @@ declare class NgwConnector {
     /**
      * {@inheritDoc ResourcesControl.getId}
      */
-    getResourceId(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<number | undefined>;
+    getResourceId(resource: ResourceDefinition, requestOptions?: RequestOptions): CancelablePromise<number | undefined>;
     /**
      * {@inheritDoc ResourcesControl.getIdOrFail}
      */
-    getResourceIdOrFail(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<number>;
+    getResourceIdOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions): CancelablePromise<number>;
     /**
      * {@inheritDoc ResourcesControl.getMany}
      */
-    getResourcesBy(resource: DeepPartial<Resource>, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem[]>;
+    getResourcesBy(resource: DeepPartial<Resource>, requestOptions?: RequestOptions): CancelablePromise<ResourceItem[]>;
     /**
      * {@inheritDoc ResourcesControl.getParent}
      */
-    getResourceParent(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem | undefined>;
+    getResourceParent(resource: ResourceDefinition, requestOptions?: RequestOptions): CancelablePromise<ResourceItem | undefined>;
     /**
      * {@inheritDoc ResourcesControl.getChildrenOf}
      */
-    getResourceChildren(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem[]>;
+    getResourceChildren(resource: ResourceDefinition, requestOptions?: GetChildrenOfOptions): CancelablePromise<ResourceItem[]>;
     /**
      * {@inheritDoc ResourcesControl.update}
      */
@@ -349,6 +357,7 @@ declare class NgwConnector {
      */
     deleteResource(resource: ResourceIdKeynameDef): CancelablePromise<void>;
     /* Excluded from this release type: _loadData */
+    private _cleanActiveRequests;
     private _handleHttpError;
 }
 export default NgwConnector;
@@ -379,7 +388,7 @@ declare class NgwError extends Error {
     status_code: number | 404 | 500;
     data?: Record<string, any>;
     guru_meditation: string;
-    constructor(er?: NgwError);
+    constructor(er?: Partial<NgwError>);
 }
 
 export declare type NgwExceptions = 'nextgisweb.resource.exception.ResourceNotFound' | 'nextgisweb.core.exception.InsufficientPermissions';
@@ -681,6 +690,7 @@ export declare interface RequestOptions<M = RequestMethods> {
     withCredentials?: boolean;
     responseType?: 'json' | 'blob';
     cache?: boolean;
+    signal?: AbortSignal;
     onProgress?: (percentComplete: number, event: ProgressEvent) => void;
 }
 
@@ -764,7 +774,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, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem>;
+    getOneOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions): CancelablePromise<ResourceItem>;
     /**
      * A fast way to retrieve resource ID for any resource definition.
      * @param resource - Any available resource definition
@@ -775,7 +785,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, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<number | undefined>;
+    getId(resource: ResourceDefinition, requestOptions?: RequestOptions): CancelablePromise<number | undefined>;
     /**
      * A fast way to retrieve resource ID for any resource definition.
      * @param resource - Any available resource definition
@@ -784,10 +794,11 @@ 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, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<number>;
+    getIdOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions): CancelablePromise<number>;
     getMany(resource: DeepPartial<Resource>, requestOptions?: RequestOptions): CancelablePromise<ResourceItem[]>;
-    getParent(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem | undefined>;
-    getChildrenOf(resource: ResourceDefinition, requestOptions?: Pick<RequestOptions, 'cache'>): CancelablePromise<ResourceItem[]>;
+    getParent(resource: ResourceDefinition, requestOptions?: RequestOptions): CancelablePromise<ResourceItem | undefined>;
+    getChildrenOf(resource: ResourceDefinition, requestOptions?: GetChildrenOfOptions): CancelablePromise<ResourceItem[]>;
+    private _getChildrenOf;
     update(resource: ResourceDefinition, data: DeepPartial<ResourceItem>): CancelablePromise<ResourceItem | undefined>;
     /**
      * Fast way to delete resource from NGW and clean cache.
@@ -800,7 +811,9 @@ declare class ResourcesControl {
     private _resourceCacheFilter;
 }
 
-export declare type ResourceStoreItem<P extends ResourceStoreItemProperties = ResourceStoreItemProperties> = ResourceStoreItemDefault & P;
+export declare type ResourceStoreItem<P extends ResourceStoreItemProperties = ResourceStoreItemProperties> = ResourceStoreItemDefault & {
+    data?: string;
+} & P;
 
 export declare interface ResourceStoreItemDefault {
     [field: string]: string | number | boolean | null | Date;

package/lib/ngw-connector.cjs.js

@@ -1,4 +1,4 @@
-/** Bundle of @nextgis/ngw-connector; version: 1.12.0; author: NextGIS */
+/** Bundle of @nextgis/ngw-connector; version: 1.13.5; author: NextGIS */
 'use strict';
 
 var events = require('events');
@@ -128,6 +128,13 @@ var NgwError = /** @class */ (function (_super) {
     return NgwError;
 }(Error));
 
+function isError(error) {
+    if (utils.isObject(error)) {
+        return error.status_code && error.exception && error.title;
+    }
+    return false;
+}
+
 function isObject(val) {
     return Object.prototype.toString.call(val) === '[object Object]';
 }
@@ -182,7 +189,7 @@ var loadData;
                     }
                     Object.assign(requestOpt.headers, __assign({}, form.getHeaders()));
                 }
-                if (body !== undefined && method !== 'POST') {
+                if (body !== undefined) {
                     Object.assign(requestOpt.headers, {
                         'content-type': 'application/json',
                         'content-length': Buffer.byteLength(body),
@@ -208,10 +215,14 @@ var loadData;
                                 }
                                 catch (er) {
                                     reject(er);
-                                    // throw new Error(er);
                                 }
                                 if (json !== undefined) {
-                                    resolve(json);
+                                    if (isError(json)) {
+                                        reject('extractError(json)');
+                                    }
+                                    else {
+                                        resolve(json);
+                                    }
                                 }
                             }
                         }
@@ -391,7 +402,12 @@ var ResourcesControl = /** @class */ (function () {
             forCache.id = resource;
         }
         else if (isObject(resource)) {
-            forCache.id = resource.id;
+            if (resource.id !== undefined) {
+                forCache.id = resource.id;
+            }
+            else if (resource.keyname) {
+                forCache.keyname = resource.keyname;
+            }
         }
         var makeRequest = function () {
             if (typeof resource === 'string') {
@@ -493,20 +509,35 @@ var ResourcesControl = /** @class */ (function () {
     };
     ResourcesControl.prototype.getChildrenOf = function (resource, requestOptions) {
         var _this = this;
-        return this.getId(resource).then(function (parent) {
-            return _this.connector
-                .get('resource.collection', __assign({ cache: true }, requestOptions), {
-                parent: parent,
-            })
-                .then(function (items) {
-                for (var _i = 0, items_1 = items; _i < items_1.length; _i++) {
-                    var i = items_1[_i];
-                    _this.cache.add('resource.item', CancelablePromise__default.resolve(i), {
-                        id: i.resource.id,
-                    });
+        return this.getIdOrFail(resource).then(function (parent) {
+            return _this._getChildrenOf(parent, requestOptions);
+        });
+    };
+    ResourcesControl.prototype._getChildrenOf = function (parent, requestOptions, _items) {
+        var _this = this;
+        if (_items === void 0) { _items = []; }
+        return this.connector
+            .get('resource.collection', __assign({ cache: true }, requestOptions), {
+            parent: parent,
+        })
+            .then(function (items) {
+            var recursivePromises = [];
+            for (var _i = 0, items_1 = items; _i < items_1.length; _i++) {
+                var item = items_1[_i];
+                _this.cache.add('resource.item', CancelablePromise__default.resolve(item), {
+                    id: item.resource.id,
+                });
+                _items.push(item);
+                if ((requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.recursive) && item.resource.children) {
+                    recursivePromises.push(_this._getChildrenOf(item.resource.id, requestOptions, _items));
                 }
-                return items;
-            });
+            }
+            if (recursivePromises.length) {
+                return CancelablePromise__default.all(recursivePromises).then(function () {
+                    return _items;
+                });
+            }
+            return _items;
         });
     };
     ResourcesControl.prototype.update = function (resource, data) {
@@ -680,6 +711,7 @@ var NgwConnector$1 = /** @class */ (function () {
         this.id = ID++;
         this.emitter = new events.EventEmitter();
         this.routeStr = '/api/component/pyramid/route';
+        this.activeRequests = [];
         var exist = findConnector(options);
         if (exist) {
             return exist;
@@ -765,6 +797,7 @@ var NgwConnector$1 = /** @class */ (function () {
      * Disconnecting a user. Aborting all current requests
      */
     NgwConnector.prototype.logout = function () {
+        this.abort();
         removeConnector(this);
         this.options.auth = undefined;
         this.user = undefined;
@@ -817,6 +850,17 @@ var NgwConnector$1 = /** @class */ (function () {
             }
         }
     };
+    /** Stop all api requests */
+    NgwConnector.prototype.abort = function () {
+        for (var _i = 0, _a = this.activeRequests; _i < _a.length; _i++) {
+            var req = _a[_i];
+            req.cancel();
+        }
+        this.activeRequests = [];
+    };
+    NgwConnector.prototype.getActiveApiRequests = function () {
+        return __spreadArray([], this.activeRequests, true);
+    };
     /**
      * Send request to NGW api router.
      * @param name - NGW route name from {@link https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource.html#routes | routes}
@@ -1031,14 +1075,20 @@ var NgwConnector$1 = /** @class */ (function () {
     NgwConnector.prototype._loadData = function (url, options) {
         var _this = this;
         options.responseType = options.responseType || 'json';
-        return new CancelablePromise__default(function (resolve, reject, onCancel) {
+        var request = new CancelablePromise__default(function (resolve, reject, onCancel) {
             if (_this.user) {
                 options = options || {};
                 // options.withCredentials = true;
                 options.headers = __assign(__assign({}, _this.getAuthorizationHeaders()), options.headers);
             }
             loadData(url, resolve, options, reject, onCancel);
-        }).catch(function (httpError) {
+        })
+            .then(function (resp) {
+            _this._cleanActiveRequests(request);
+            return resp;
+        })
+            .catch(function (httpError) {
+            _this._cleanActiveRequests(request);
             if (httpError instanceof CancelablePromise__default.CancelError) ;
             else {
                 // @ts-ignore
@@ -1051,6 +1101,20 @@ var NgwConnector$1 = /** @class */ (function () {
                 }
             }
         });
+        if (options.signal &&
+            typeof options.signal.addEventListener === 'function') {
+            options.signal.addEventListener('abort', function () {
+                request.cancel();
+            });
+        }
+        this.activeRequests.push(request);
+        return request;
+    };
+    NgwConnector.prototype._cleanActiveRequests = function (request) {
+        var activeRequestIndex = this.activeRequests.indexOf(request);
+        if (activeRequestIndex !== -1) {
+            this.activeRequests.splice(activeRequestIndex, 1);
+        }
     };
     NgwConnector.prototype._handleHttpError = function (er) {
         if (er) {