@nextgis/ngw-connector 1.8.4 → 1.11.0

package/lib/ngw-connector.global.js

@@ -1,4 +1,4 @@
-/** Bundle of @nextgis/ngw-connector; version: 1.8.4; author: NextGIS */
+/** Bundle of @nextgis/ngw-connector; version: 1.11.0; author: NextGIS */
 var NgwConnector = (function () {
     'use strict';
 
@@ -44,10 +44,52 @@ var NgwConnector = (function () {
         return __assign.apply(this, arguments);
     };
 
-    function __spreadArray(to, from) {
-        for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
-            to[j] = from[i];
-        return to;
+    function __awaiter(thisArg, _arguments, P, generator) {
+        function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+        return new (P || (P = Promise))(function (resolve, reject) {
+            function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+            function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+            function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+            step((generator = generator.apply(thisArg, _arguments || [])).next());
+        });
+    }
+
+    function __generator(thisArg, body) {
+        var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+        return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+        function verb(n) { return function (v) { return step([n, v]); }; }
+        function step(op) {
+            if (f) throw new TypeError("Generator is already executing.");
+            while (_) try {
+                if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+                if (y = 0, t) op = [op[0] & 2, t.value];
+                switch (op[0]) {
+                    case 0: case 1: t = op; break;
+                    case 4: _.label++; return { value: op[1], done: false };
+                    case 5: _.label++; y = op[1]; op = [0]; continue;
+                    case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                    default:
+                        if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                        if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                        if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                        if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                        if (t[2]) _.ops.pop();
+                        _.trys.pop(); continue;
+                }
+                op = body.call(thisArg, _);
+            } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+            if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+        }
+    }
+
+    function __spreadArray(to, from, pack) {
+        if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+            if (ar || !(i in from)) {
+                if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+                ar[i] = from[i];
+            }
+        }
+        return to.concat(ar || Array.prototype.slice.call(from));
     }
 
     var events = {exports: {}};
@@ -909,6 +951,23 @@ var NgwConnector = (function () {
      */
     function defined(val) {
         return val !== undefined && val !== null;
+    }
+    /**
+     * from https://github.com/CesiumGS/cesium/blob/master/Source/Core/defined.js
+     *
+     * @param val - The object.
+     * @returns Returns true if the object is defined and not empty string, returns false otherwise.
+     *
+     * @example
+     * ```javascript
+     * full('foo') // true
+     * full('') // false
+     * full(undefined) // false
+     * full(0) // true
+     * ```
+     */
+    function full(val) {
+        return typeof val === 'string' ? !!val : defined(val);
     }
 
     function isEqual(a, b, o, p) {
@@ -977,13 +1036,46 @@ var NgwConnector = (function () {
         return url.replace(/([^:]\/)\/+/g, '$1');
     }
 
+    /**
+     * @example
+     * ```javascript
+     * const cache1 = new Cache();
+     * cache1.add('foo', 'value');
+     *
+     * const cache2 = new Cache();
+     * cache2.match('foo'); // value
+     *
+     * const cache3 = new Cache({ namespace: 'foo' });
+     * cache3.match('foo'); // undefined
+     * ```
+     *
+     * @example
+     * ```javascript
+     * let COUNTER = 0;
+     * const createPromise = () => new Promise((res) => {
+     *   COUNTER++
+     *   setTimeout(() => res('Ok'), 300)
+     * });
+     *
+     * const cache = new Cache();
+     * for (let i = 0; i < 10; i++) {
+     *   cache.add('foo', createPromise).then((data) => {
+     *     console.log(data); // 'Ok'
+     *   });
+     * }
+     * console.log(COUNTER); // 1
+     * ```
+     */
     var Cache$1 = /** @class */ (function () {
-        function Cache() {
+        function Cache(options) {
+            if (options === void 0) { options = {}; }
+            var _a;
             this.cache = [];
-            if (Cache.instance) {
-                return Cache.instance;
+            var namespace = (_a = options.namespace) !== null && _a !== void 0 ? _a : 'default';
+            if (Cache.instance[namespace]) {
+                return Cache.instance[namespace];
             }
-            Cache.instance = this;
+            Cache.instance[namespace] = this;
             return this;
         }
         Cache.prototype.clean = function () {
@@ -992,9 +1084,34 @@ var NgwConnector = (function () {
         Cache.prototype.all = function () {
             return this.cache;
         };
-        Cache.prototype.add = function (key, valueToSet, options) {
+        /**
+         * Caching only a non-empty value.
+         *
+         * Useful for get or create strategy
+         * @example
+         * ```javascript
+         * const cache = new Cache();
+         * const getItemFunc = () => fetch(url).then((data) => {
+         *  return data.json(); // undefined
+         * });
+         * const item = await cache.addFull('foo', getItemFunc);
+         * if (!item) {
+         *   await createItem(); // 'New item'
+         * }
+         *
+         * // somewhere else in the code
+         * const item = await cache.addFull('foo', getItemFunc).then((resp) => {
+         *   console.log(resp); // 'New item'
+         * })
+         *
+         * ```
+         */
+        Cache.prototype.addFull = function (key, valueToSet, props) {
+            return this.add(key, valueToSet, props, true);
+        };
+        Cache.prototype.add = function (key, valueToSet, props, onlyFull) {
             var _this = this;
-            var exist = this._find(key, options);
+            var exist = this._find(key, props);
             if (!exist) {
                 var value = void 0;
                 if (valueToSet instanceof Function) {
@@ -1003,18 +1120,31 @@ var NgwConnector = (function () {
                 else {
                     value = valueToSet;
                 }
-                var options_ = options && JSON.parse(JSON.stringify(objectRemoveEmpty(options)));
+                var props_ = props && JSON.parse(JSON.stringify(objectRemoveEmpty(props)));
                 var cacheItem = {
                     key: key,
                     value: value,
-                    options: options_,
+                    props: props_,
+                    // TODO: remove backward compatibility use only props
+                    options: props_,
                 };
+                if (onlyFull && !full(value)) {
+                    return value;
+                }
                 this.cache.push(cacheItem);
                 if (value instanceof Promise) {
                     value.catch(function (er) {
-                        _this.delete(key, options);
+                        _this.delete(key, props);
                         throw er;
                     });
+                    if (onlyFull) {
+                        value.then(function (x) {
+                            if (!full(x)) {
+                                _this.delete(key, props);
+                            }
+                            return x;
+                        });
+                    }
                     return value;
                 }
                 return value;
@@ -1023,43 +1153,52 @@ var NgwConnector = (function () {
                 return exist.value;
             }
         };
-        Cache.prototype.match = function (key, options) {
-            var cacheRecord = this._find(key, options);
+        Cache.prototype.match = function (key, props) {
+            var cacheRecord = this._find(key, props);
             if (cacheRecord) {
                 return cacheRecord.value;
             }
         };
-        Cache.prototype.matchAll = function (key, options) {
+        Cache.prototype.matchAll = function (key, props) {
             var _this = this;
             if (key) {
                 return this.cache
-                    .filter(function (x) { return _this._filter(x, key, options); })
+                    .filter(function (x) { return _this._filter(x, key, props); })
                     .map(function (x) { return x.value; });
             }
             return this.cache.map(function (x) { return x.value; });
         };
-        Cache.prototype.delete = function (key, options) {
+        Cache.prototype.delete = function (keyOrItem, props) {
             var _this = this;
-            var exist = this.cache.filter(function (x) { return _this._filter(x, key, options); });
+            var exist = [];
+            if (typeof keyOrItem === 'string') {
+                exist = this.cache.filter(function (x) { return _this._filter(x, keyOrItem, props); });
+            }
+            else {
+                exist.push(keyOrItem);
+            }
             for (var _i = 0, exist_1 = exist; _i < exist_1.length; _i++) {
                 var e = exist_1[_i];
                 var index = this.cache.indexOf(e);
                 this.cache.splice(index, 1);
             }
         };
-        Cache.prototype._find = function (key, options) {
+        Cache.prototype._find = function (key, props) {
             var _this = this;
-            return this.cache.find(function (x) { return _this._filter(x, key, options); });
+            return this.cache.find(function (x) { return _this._filter(x, key, props); });
         };
-        Cache.prototype._filter = function (item, key, options) {
+        Cache.prototype._filter = function (item, key, props) {
             if (item.key === key) {
-                if (options) {
-                    return objectDeepEqual(item.options || {}, objectRemoveEmpty(options));
+                if (props) {
+                    // TODO: remove backward compatibility
+                    var itemProps = item.props || item.options;
+                    return objectDeepEqual(itemProps || {}, objectRemoveEmpty(props));
                 }
                 return true;
             }
             return false;
         };
+        Cache.instance = {};
         return Cache;
     }());
 
@@ -1095,12 +1234,16 @@ var NgwConnector = (function () {
             var _this = _super.call(this) || this;
             _this.name = 'NetworkError';
             Object.setPrototypeOf(_this, NetworkError.prototype);
-            _this.message = "Unable to request " + url + ".\n    Possibly invalid NGW URL entered or CORS not configured to get request from " + location.origin; // /control-panel/cors
+            _this.message = "Unable to request ".concat(url, ".\n    Possibly invalid NGW URL entered or CORS not configured to get request from ").concat(location.origin); // /control-panel/cors
             return _this;
         }
         return NetworkError;
     }(Error));
 
+    function isObject(val) {
+        return Object.prototype.toString.call(val) === '[object Object]';
+    }
+
     var loadData;
     // @ts-ignore
     {
@@ -1136,7 +1279,7 @@ var NgwConnector = (function () {
                 }
             };
             xhr.onload = function () {
-                if ([401, 403, 404, 500].indexOf(xhr.status) !== -1) {
+                if ([401, 403, 404, 422, 500].indexOf(xhr.status) !== -1) {
                     error(new NgwError(getResponseText()));
                 }
                 processingResponse();
@@ -1191,7 +1334,7 @@ var NgwConnector = (function () {
                 data = new FormData();
                 data.append('file', options.file);
                 if (options.data) {
-                    for (var d in data) {
+                    for (var d in options.data) {
                         data.append(d, data[d]);
                     }
                 }
@@ -1283,30 +1426,38 @@ var NgwConnector = (function () {
         }
     }
 
-    function isObject(val) {
-        return Object.prototype.toString.call(val) === '[object Object]';
-    }
-
+    var exclude = ['description'];
     /**
+     * @remarks
+     * https://docs.nextgis.ru/docs_ngweb_dev/doc/developer/resource.html#search-resources
+     *
      * ```
-     * { keyname, parent: { id }} > { keyname, parent__id }
+     * { keyname, owner_user: { id }} > { keyname, owner_user__id }
      * ```
+     *
      * @param resource - Any property from NGW resource item
      */
     function resourceToQuery(resource, prefix) {
         if (prefix === void 0) { prefix = ''; }
         prefix = prefix ? prefix + '__' : '';
         var query = {};
-        Object.entries(resource).forEach(function (_a) {
-            var key = _a[0], value = _a[1];
-            if (isObject(value)) {
-                var children = resourceToQuery(value, key);
-                Object.assign(query, children);
-            }
-            else if (defined(value)) {
-                query[prefix + key] = value;
+        for (var _i = 0, _a = Object.entries(resource); _i < _a.length; _i++) {
+            var _b = _a[_i], key = _b[0], value = _b[1];
+            if (exclude.indexOf(key) === -1) {
+                if (isObject(value)) {
+                    if (key === 'owner_user') {
+                        var children = resourceToQuery(value, key);
+                        Object.assign(query, children);
+                    }
+                    else if (key === 'parent' && 'id' in value) {
+                        query.parent_id = value.id;
+                    }
+                }
+                else if (defined(value)) {
+                    query[prefix + key] = value;
+                }
             }
-        });
+        }
         return query;
     }
 
@@ -1332,22 +1483,33 @@ var NgwConnector = (function () {
         ResourcesControl.prototype.getOne = function (resource, requestOptions) {
             var _this = this;
             var cache = new Cache();
+            var forCache = {};
+            var opt = __assign(__assign({}, requestOptions), { cache: false });
+            if (typeof resource === 'string') {
+                forCache.keyname = resource;
+            }
+            else if (typeof resource === 'number') {
+                forCache.id = resource;
+            }
+            else if (isObject(resource)) {
+                forCache.id = resource.id;
+            }
             var makeRequest = function () {
                 if (typeof resource === 'string') {
-                    return _this._fetchResourceBy({ keyname: resource }, requestOptions);
+                    return _this._fetchResourceBy({ keyname: resource }, opt);
                 }
                 else if (typeof resource === 'number') {
-                    return _this._fetchResourceById(resource, requestOptions);
+                    return _this._fetchResourceById(resource, opt);
                 }
                 else if (isObject(resource)) {
-                    return _this._fetchResourceBy(resource, requestOptions);
+                    return _this._fetchResourceBy(resource, opt);
                 }
                 return CancelablePromise.resolve(undefined);
             };
-            return cache.add('resource', makeRequest, { resource: resource });
+            return cache.addFull('resource', makeRequest, forCache);
         };
-        ResourcesControl.prototype.getOneOrFail = function (resource) {
-            return this.getOne(resource).then(function (res) {
+        ResourcesControl.prototype.getOneOrFail = function (resource, requestOptions) {
+            return this.getOne(resource, requestOptions).then(function (res) {
                 if (res) {
                     return res;
                 }
@@ -1364,12 +1526,12 @@ var NgwConnector = (function () {
          * 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.
          */
-        ResourcesControl.prototype.getId = function (resource) {
+        ResourcesControl.prototype.getId = function (resource, requestOptions) {
             if (typeof resource === 'number') {
                 return CancelablePromise.resolve(resource);
             }
             else if (typeof resource === 'string' || isObject(resource)) {
-                return this.getOne(resource).then(function (res) {
+                return this.getOne(resource, requestOptions).then(function (res) {
                     if (res) {
                         return res.resource.id;
                     }
@@ -1385,8 +1547,8 @@ var NgwConnector = (function () {
          * 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
          */
-        ResourcesControl.prototype.getIdOrFail = function (resource) {
-            return this.getId(resource).then(function (resp) {
+        ResourcesControl.prototype.getIdOrFail = function (resource, requestOptions) {
+            return this.getId(resource, requestOptions).then(function (resp) {
                 if (resp === undefined) {
                     throw new Error();
                 }
@@ -1408,11 +1570,12 @@ var NgwConnector = (function () {
                         .get('resource.search', requestOptions, __assign({ serialization: 'full' }, query))
                         .then(function (resources) {
                         if (resources) {
-                            resources.forEach(function (x) {
+                            for (var _i = 0, resources_1 = resources; _i < resources_1.length; _i++) {
+                                var x = resources_1[_i];
                                 _this.cache.add('resource.item', CancelablePromise.resolve(x), {
                                     id: x.resource.id,
                                 });
-                            });
+                            }
                         }
                         return resources;
                     });
@@ -1420,20 +1583,20 @@ var NgwConnector = (function () {
                 return items;
             });
         };
-        ResourcesControl.prototype.getParent = function (resource) {
+        ResourcesControl.prototype.getParent = function (resource, requestOptions) {
             var _this = this;
-            return this.connector.getResource(resource).then(function (child) {
+            return this.getOne(resource, requestOptions).then(function (child) {
                 if (child) {
-                    return _this.connector.getResource(child.resource.parent.id);
+                    return _this.getOne(child.resource.parent.id, requestOptions);
                 }
                 return CancelablePromise.resolve(undefined);
             });
         };
-        ResourcesControl.prototype.getChildrenOf = function (resource) {
+        ResourcesControl.prototype.getChildrenOf = function (resource, requestOptions) {
             var _this = this;
             return this.getId(resource).then(function (parent) {
                 return _this.connector
-                    .get('resource.collection', { cache: true }, {
+                    .get('resource.collection', __assign({ cache: true }, requestOptions), {
                     parent: parent,
                 })
                     .then(function (items) {
@@ -1464,12 +1627,52 @@ var NgwConnector = (function () {
             return this.getId(resource).then(function (id) {
                 if (id !== undefined) {
                     return _this.connector.delete('resource.item', null, { id: id }).then(function () {
-                        _this.cache.delete('resource.item', { id: id });
+                        _this._cleanResourceItemCache(id);
                         return undefined;
                     });
                 }
             });
         };
+        ResourcesControl.prototype._cleanResourceItemCache = function (id) {
+            return __awaiter(this, void 0, void 0, function () {
+                var all, toDelete, _i, all_1, c, cid, rid, _a, toDelete_1, d;
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
+                        case 0:
+                            all = this.cache.all();
+                            toDelete = [];
+                            _i = 0, all_1 = all;
+                            _b.label = 1;
+                        case 1:
+                            if (!(_i < all_1.length)) return [3 /*break*/, 5];
+                            c = all_1[_i];
+                            cid = c.options && c.options.id;
+                            if (!(['resource.item', 'resource'].includes(c.key) && cid !== undefined)) return [3 /*break*/, 4];
+                            if (!(typeof cid === 'number')) return [3 /*break*/, 2];
+                            if (cid === id) {
+                                toDelete.push(c);
+                            }
+                            return [3 /*break*/, 4];
+                        case 2: return [4 /*yield*/, this.getId(cid)];
+                        case 3:
+                            rid = _b.sent();
+                            if (rid === id) {
+                                toDelete.push(c);
+                            }
+                            _b.label = 4;
+                        case 4:
+                            _i++;
+                            return [3 /*break*/, 1];
+                        case 5:
+                            for (_a = 0, toDelete_1 = toDelete; _a < toDelete_1.length; _a++) {
+                                d = toDelete_1[_a];
+                                this.cache.delete(d);
+                            }
+                            return [2 /*return*/];
+                    }
+                });
+            });
+        };
         ResourcesControl.prototype._fetchResourceById = function (id, requestOptions) {
             var _this = this;
             var promise = function () {
@@ -1520,7 +1723,7 @@ var NgwConnector = (function () {
                 .then(function (apiItems) {
                 var apiItem = apiItems && apiItems[opt.name];
                 if (apiItem) {
-                    apiItem = __spreadArray([], apiItem);
+                    apiItem = __spreadArray([], apiItem, true);
                     var url = apiItem.shift();
                     if (apiItem.length) {
                         var replaceParams = {};
@@ -1542,12 +1745,12 @@ var NgwConnector = (function () {
                         if (Array.isArray(paramList)) {
                             delete params.paramList;
                             paramList.forEach(function (x) {
-                                paramArray_1.push(x[0] + "=" + x[1]);
+                                paramArray_1.push("".concat(x[0], "=").concat(x[1]));
                             });
                         }
                         for (var p in params) {
                             if (apiItem.indexOf(p) === -1) {
-                                paramArray_1.push(p + "=" + params[p]);
+                                paramArray_1.push("".concat(p, "=").concat(params[p]));
                             }
                         }
                         if (paramArray_1.length) {
@@ -1681,7 +1884,7 @@ var NgwConnector = (function () {
                 headers: this.getAuthorizationHeaders(credentials),
                 // withCredentials: true
             };
-            // Do not use request('auth.current_user') to avoid circular-references
+            // Do not use apiRequest('auth.current_user') to avoid circular-references
             return this.makeQuery('/api/component/auth/current_user', {}, options)
                 .then(function (data) {
                 _this.user = data;
@@ -1708,7 +1911,7 @@ var NgwConnector = (function () {
             credentials = credentials || this.options.auth;
             if (credentials) {
                 var login = credentials.login, password = credentials.password;
-                var str = unescape(encodeURIComponent(login + ":" + password));
+                var str = unescape(encodeURIComponent("".concat(login, ":").concat(password)));
                 // @ts-ignore
                 {
                     return window.btoa(str);
@@ -1842,7 +2045,7 @@ var NgwConnector = (function () {
                 }
                 // remove double slash
                 url = fixUrlStr(url);
-                return this._loadData(url, options);
+                return this._loadData(encodeURI(url), options);
             }
             else {
                 throw new Error('Empty `url` not allowed');
@@ -1854,14 +2057,14 @@ var NgwConnector = (function () {
         /**
          * {@inheritDoc ResourcesControl.getOne}
          */
-        NgwConnector.prototype.getResource = function (resource) {
-            return this.resources.getOne(resource);
+        NgwConnector.prototype.getResource = function (resource, requestOptions) {
+            return this.resources.getOne(resource, requestOptions);
         };
         /**
          * {@inheritDoc ResourcesControl.getOneOrFail}
          */
-        NgwConnector.prototype.getResourceOrFail = function (resource) {
-            return this.resources.getOneOrFail(resource);
+        NgwConnector.prototype.getResourceOrFail = function (resource, requestOptions) {
+            return this.resources.getOneOrFail(resource, requestOptions);
         };
         /**
          * @deprecated - use {@link NgwConnector.getResource}
@@ -1884,32 +2087,32 @@ var NgwConnector = (function () {
         /**
          * {@inheritDoc ResourcesControl.getId}
          */
-        NgwConnector.prototype.getResourceId = function (resource) {
-            return this.resources.getId(resource);
+        NgwConnector.prototype.getResourceId = function (resource, requestOptions) {
+            return this.resources.getId(resource, requestOptions);
         };
         /**
          * {@inheritDoc ResourcesControl.getIdOrFail}
          */
-        NgwConnector.prototype.getResourceIdOrFail = function (resource) {
-            return this.resources.getIdOrFail(resource);
+        NgwConnector.prototype.getResourceIdOrFail = function (resource, requestOptions) {
+            return this.resources.getIdOrFail(resource, requestOptions);
         };
         /**
          * {@inheritDoc ResourcesControl.getMany}
          */
-        NgwConnector.prototype.getResourcesBy = function (resource) {
-            return this.resources.getMany(resource);
+        NgwConnector.prototype.getResourcesBy = function (resource, requestOptions) {
+            return this.resources.getMany(resource, requestOptions);
         };
         /**
          * {@inheritDoc ResourcesControl.getParent}
          */
-        NgwConnector.prototype.getResourceParent = function (resource) {
-            return this.resources.getParent(resource);
+        NgwConnector.prototype.getResourceParent = function (resource, requestOptions) {
+            return this.resources.getParent(resource, requestOptions);
         };
         /**
          * {@inheritDoc ResourcesControl.getChildrenOf}
          */
-        NgwConnector.prototype.getResourceChildren = function (resource) {
-            return this.resources.getChildrenOf(resource);
+        NgwConnector.prototype.getResourceChildren = function (resource, requestOptions) {
+            return this.resources.getChildrenOf(resource, requestOptions);
         };
         /**
          * {@inheritDoc ResourcesControl.update}
@@ -1941,7 +2144,7 @@ var NgwConnector = (function () {
                 else {
                     // @ts-ignore
                     {
-                        console.warn(httpError);
+                        console.warn('DEV WARN', httpError);
                     }
                     var er = _this._handleHttpError(httpError);
                     if (er) {