@nextgis/ngw-connector 3.0.0-alpha.7 → 3.0.0

package/lib/ngw-connector.cjs.js

@@ -1,13 +1,76 @@
-/** Bundle of @nextgis/ngw-connector; version: 3.0.0-alpha.7; author: NextGIS */
+/** Bundle of @nextgis/ngw-connector; version: 3.0.0; author: NextGIS */
 'use strict';
 
 var utils = require('@nextgis/utils');
-var events = require('events');
 var Cache = require('@nextgis/cache');
+var events = require('events');
+
+const templateRe = /\{ *([\w_-]+) *\}/g;
+function template(str, data) {
+  return str.replace(templateRe, (s, key) => {
+    let value = data[key];
+    if (value === void 0) {
+      throw new Error("No value provided for letiable " + s);
+    } else if (typeof value === "function") {
+      value = value(data);
+    }
+    return value;
+  });
+}
+
+async function apiRequest(opt) {
+  const { params, name, connector, requestOptions } = opt;
+  const apiItems = await connector.connect();
+  let apiItem = apiItems && apiItems[name];
+  if (apiItem) {
+    apiItem = [...apiItem];
+    let url = apiItem.shift();
+    if (apiItem.length) {
+      const replaceParams = {};
+      for (let fry = 0; fry < apiItem.length; fry++) {
+        const arg = apiItem[fry];
+        replaceParams[fry] = `{${arg}}`;
+        if (params[arg] === void 0) {
+          throw new Error(`\`${arg}\` URL API argument is not specified`);
+        }
+      }
+      if (url) {
+        url = template(url, replaceParams);
+      }
+    }
+    if (params) {
+      const paramArray = [];
+      const paramList = params.paramList;
+      if (Array.isArray(paramList)) {
+        paramList.forEach(([key, value]) => {
+          paramArray.push(`${key}=${value}`);
+        });
+      }
+      for (const p in params) {
+        if (apiItem.indexOf(p) === -1) {
+          paramArray.push(`${p}=${params[p]}`);
+        }
+      }
+      if (paramArray.length) {
+        url = `${url}?${paramArray.join("&")}`;
+      }
+    }
+    if (url) {
+      return connector.makeQuery(url, params, {
+        cacheName: name,
+        ...requestOptions
+      });
+    } else {
+      throw new Error("Request URL is not set");
+    }
+  } else {
+    return void 0;
+  }
+}
 
 var pkg = {
 	name: "@nextgis/ngw-connector",
-	version: "3.0.0-alpha.7",
+	version: "3.0.0",
 	_priority: 12,
 	description: "A lightweight HTTP client optimized for use with NextGIS Web API",
 	main: "index.js",
@@ -16,15 +79,15 @@ var pkg = {
 	jsdelivr: "lib/ngw-connector.global.prod.js",
 	types: "lib/index.d.ts",
 	dependencies: {
-		"@nextgis/cache": "^3.0.0-alpha.7",
-		"@nextgis/cancelable-promise": "^3.0.0-alpha.5",
-		"@nextgis/utils": "^3.0.0-alpha.5",
+		"@nextgis/cache": "3.0.0",
+		"@nextgis/cancelable-promise": "3.0.0",
+		"@nextgis/utils": "3.0.0",
 		"@types/events": "^3.0.0",
 		events: "*",
 		"form-data": "^4.0.0"
 	},
 	devDependencies: {
-		"@nextgis/build-tools": "^3.0.0-alpha.5"
+		"@nextgis/build-tools": "3.0.0"
 	},
 	scripts: {
 		clean: "rimraf ./lib",
@@ -64,30 +127,6 @@ var pkg = {
 	gitHead: "edc68033f914f6c95c4125b9738bba6d36e990b4"
 };
 
-const CONNECTORS = [];
-function addConnector(connector) {
-  CONNECTORS.push(connector);
-}
-function findConnector(options) {
-  return CONNECTORS.find((x) => {
-    if (x.options.baseUrl === options.baseUrl) {
-      if (options.auth) {
-        if (x.options.auth) {
-          return utils.objectDeepEqual(x.options.auth, options.auth);
-        }
-      } else {
-        return true;
-      }
-    }
-  });
-}
-function removeConnector(connector) {
-  const index = CONNECTORS.indexOf(connector);
-  if (index !== -1) {
-    CONNECTORS.splice(index, 1);
-  }
-}
-
 class AbortError extends Error {
   constructor(message = "AbortError") {
     super(message);
@@ -95,37 +134,95 @@ class AbortError extends Error {
   }
 }
 
-var __defProp$6 = Object.defineProperty;
-var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$6 = (obj, key, value) => __defNormalProp$6(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$8 = Object.defineProperty;
+var __defNormalProp$8 = (obj, key, value) => key in obj ? __defProp$8(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$8 = (obj, key, value) => __defNormalProp$8(obj, typeof key !== "symbol" ? key + "" : key, value);
 class NgwError extends Error {
   constructor(er) {
     super();
-    __publicField$6(this, "name", "NgwError");
-    __publicField$6(this, "title");
-    __publicField$6(this, "message");
-    __publicField$6(this, "detail");
-    __publicField$6(this, "exception");
-    __publicField$6(this, "status_code");
-    __publicField$6(this, "data");
-    __publicField$6(this, "guru_meditation");
+    __publicField$8(this, "name", "NgwError");
+    __publicField$8(this, "title");
+    __publicField$8(this, "message");
+    __publicField$8(this, "detail");
+    __publicField$8(this, "exception");
+    __publicField$8(this, "status_code");
+    __publicField$8(this, "data");
+    __publicField$8(this, "guru_meditation");
     Object.assign(this, er);
     Object.setPrototypeOf(this, NgwError.prototype);
   }
 }
 
-var __defProp$5 = Object.defineProperty;
-var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField$5 = (obj, key, value) => __defNormalProp$5(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __defProp$7 = Object.defineProperty;
+var __defNormalProp$7 = (obj, key, value) => key in obj ? __defProp$7(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$7 = (obj, key, value) => __defNormalProp$7(obj, typeof key !== "symbol" ? key + "" : key, value);
 class InsufficientPermissionsError extends NgwError {
   constructor(obj) {
     super(obj);
-    __publicField$5(this, "name", "InsufficientPermissionsError");
-    __publicField$5(this, "exception", "nextgisweb.core.exception.InsufficientPermissions");
+    __publicField$7(this, "name", "InsufficientPermissionsError");
+    __publicField$7(this, "exception", "nextgisweb.core.exception.InsufficientPermissions");
     Object.setPrototypeOf(this, InsufficientPermissionsError.prototype);
   }
 }
 
+var __defProp$6 = Object.defineProperty;
+var __defNormalProp$6 = (obj, key, value) => key in obj ? __defProp$6(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$6 = (obj, key, value) => __defNormalProp$6(obj, typeof key !== "symbol" ? key + "" : key, value);
+let NetworksResponseError$1 = class NetworksResponseError extends NgwError {
+  constructor(obj) {
+    super(obj);
+    __publicField$6(this, "message", "There is no response from the server or problem connecting to server.");
+    __publicField$6(this, "title", "Network error");
+    __publicField$6(this, "detail", "Check network connectivity and try again later.");
+    Object.setPrototypeOf(this, NetworksResponseError.prototype);
+  }
+};
+
+function extractError(error) {
+  if (utils.isObject(error)) {
+    if (error.name && error.message && error.title) {
+      return {
+        title: error.title,
+        message: error.message,
+        detail: error.detail || null,
+        data: error.data && error.data.data ? error.data.data : null
+      };
+    } else if (error.exception) {
+      if (error.status === void 0 || error.status === 0 || error.data === void 0) {
+        return new NetworksResponseError$1({
+          title: error.title,
+          status_code: error.status_code,
+          exception: error.exception
+        });
+      }
+    }
+    return {
+      title: typeof error.title === "string" ? error.title : "Unexpected error",
+      message: typeof error.message === "string" ? error.message : "Something went wrong."
+    };
+  }
+}
+
+function isError(error) {
+  if (utils.isObject(error)) {
+    return error.status_code && error.exception && error.title;
+  }
+  return false;
+}
+
+var __defProp$5 = Object.defineProperty;
+var __defNormalProp$5 = (obj, key, value) => key in obj ? __defProp$5(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$5 = (obj, key, value) => __defNormalProp$5(obj, key + "" , value);
+class NetworkError extends Error {
+  constructor(url) {
+    super();
+    __publicField$5(this, "name", "NetworkError");
+    Object.setPrototypeOf(this, NetworkError.prototype);
+    this.message = `Unable to request ${url}.
+    Possibly invalid NGW URL entered or CORS not configured to get request from ${location.origin}`;
+  }
+}
+
 var __defProp$4 = Object.defineProperty;
 var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$4 = (obj, key, value) => __defNormalProp$4(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -138,6 +235,18 @@ class ResourceNotFoundError extends NgwError {
   }
 }
 
+var errors = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  AbortError: AbortError,
+  InsufficientPermissionsError: InsufficientPermissionsError,
+  NetworkError: NetworkError,
+  NetworksResponseError: NetworksResponseError$1,
+  NgwError: NgwError,
+  ResourceNotFoundError: ResourceNotFoundError,
+  extractError: extractError,
+  isError: isError
+});
+
 var __defProp$3 = Object.defineProperty;
 var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$3 = (obj, key, value) => __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -209,7 +318,7 @@ function lunkwillCheckResponse(lwResp) {
 async function responseJson(response) {
   try {
     return response.json();
-  } catch (e) {
+  } catch {
     throw new Error();
   }
 }
@@ -230,7 +339,7 @@ async function lunkwillResponseUrl(lwResp) {
     try {
       lwResp2 = await fetch(sum, { credentials: "same-origin" });
       lwData2 = await lwResp2.json();
-    } catch (e) {
+    } catch {
       failed = true;
       continue;
     }
@@ -258,7 +367,7 @@ async function lunkwillResponseUrl(lwResp) {
 async function lunkwillFetch(lwRespUrl) {
   try {
     return await window.fetch(lwRespUrl, { credentials: "same-origin" });
-  } catch (e) {
+  } catch {
     throw new NetworksResponseError();
   }
 }
@@ -302,7 +411,7 @@ function generateUrl(path, query) {
   return path + urlParams;
 }
 async function request(path, options, cacheEngine) {
-  var _a;
+  var _a, _b;
   const defaults = {
     method: "GET",
     credentials: "same-origin",
@@ -322,6 +431,7 @@ async function request(path, options, cacheEngine) {
     ...defaults,
     ...options
   };
+  opt.method = (_a = opt.method) == null ? void 0 : _a.toUpperCase();
   if (withCredentials) {
     opt.credentials = "include";
   }
@@ -344,7 +454,7 @@ async function request(path, options, cacheEngine) {
     try {
       response = await fetch(url, opt);
     } catch (e) {
-      if (e.name === "AbortError") {
+      if (opt.signal && opt.signal.aborted) {
         throw e;
       }
       throw new NetworksResponseError();
@@ -379,14 +489,26 @@ async function request(path, options, cacheEngine) {
     }
     return body;
   };
-  if (cacheEngine && cache && ((_a = opt.method) == null ? void 0 : _a.toUpperCase()) === "GET") {
-    const cacheOptions = cacheProps ? cacheProps : {
-      ...utils.objectRemoveEmpty({
-        withCredentials,
-        responseType
-      })
-    };
-    return cacheEngine.add(cacheName || url, makeRequest, cacheOptions, false);
+  if (cacheEngine) {
+    if (((_b = opt.method) == null ? void 0 : _b.toUpperCase()) === "GET") {
+      if (cache !== false) {
+        const props = cacheProps ? cacheProps : {
+          ...utils.objectRemoveEmpty({
+            withCredentials,
+            responseType
+          })
+        };
+        return cacheEngine.add(cacheName || url, makeRequest, {
+          props,
+          expirationTime: cache ? void 0 : 500
+        });
+      }
+    } else {
+      const ignoredForClean = ["api/feature_layer/identify"];
+      if (ignoredForClean.every((part) => !path.includes(part))) {
+        cacheEngine.clean();
+      }
+    }
   }
   return makeRequest();
 }
@@ -436,42 +558,40 @@ function route(name, connector, ...rest) {
   };
   const methods = ["get", "post", "put", "delete", "patch"];
   for (const method of methods) {
-    const methodResp = async (requestOptions) => {
+    const methodResp = (requestOptions) => {
       var _a;
       const { headers: optHeaders, ...restOpt } = requestOptions || {};
-      const routeData = await connector.connect();
-      const template = routeURL(
-        name,
-        (_a = connector.options.baseUrl) != null ? _a : "",
-        routeData,
-        ...rest
-      );
-      const headers = utils.objectRemoveEmpty({
-        ...connector.getAuthorizationHeaders(),
-        ...optHeaders != null ? optHeaders : {}
+      if ((_a = requestOptions == null ? void 0 : requestOptions.signal) == null ? void 0 : _a.aborted) {
+        throw new AbortError();
+      }
+      return connector.connect().then((routeData) => {
+        var _a2;
+        const template = routeURL(
+          name,
+          (_a2 = connector.options.baseUrl) != null ? _a2 : "",
+          routeData,
+          ...rest
+        );
+        const headers = utils.objectRemoveEmpty({
+          ...connector.getAuthorizationHeaders(),
+          ...optHeaders != null ? optHeaders : {}
+        });
+        return request(
+          template,
+          {
+            headers,
+            ...restOpt,
+            method
+          },
+          connector.cache
+        );
       });
-      return request(
-        template,
-        {
-          headers,
-          ...restOpt,
-          method
-        },
-        connector.cache
-      );
     };
     result[method] = methodResp;
   }
   return result;
 }
 
-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]";
 }
@@ -597,18 +717,29 @@ let loadData;
   };
 }
 
-const templateRe = /\{ *([\w_-]+) *\}/g;
-function template(str, data) {
-  return str.replace(templateRe, (s, key) => {
-    let value = data[key];
-    if (value === void 0) {
-      throw new Error("No value provided for letiable " + s);
-    } else if (typeof value === "function") {
-      value = value(data);
+const CONNECTORS = [];
+function addConnector(connector) {
+  CONNECTORS.push(connector);
+}
+function findConnector(options) {
+  return CONNECTORS.find((x) => {
+    if (x.options.baseUrl === options.baseUrl) {
+      if (options.auth) {
+        if (x.options.auth) {
+          return utils.objectDeepEqual(x.options.auth, options.auth);
+        }
+      } else {
+        return true;
+      }
     }
-    return value;
   });
 }
+function removeConnector(connector) {
+  const index = CONNECTORS.indexOf(connector);
+  if (index !== -1) {
+    CONNECTORS.splice(index, 1);
+  }
+}
 
 var __defProp$2 = Object.defineProperty;
 var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -623,12 +754,16 @@ class NgwConnector {
     __publicField$2(this, "user");
     __publicField$2(this, "cache");
     __publicField$2(this, "withCredentials");
+    // Dedicated cache for route requests, as these are executed before any other requests.
+    // This cache does not need to be cleared during the session.
+    __publicField$2(this, "routeCache");
     __publicField$2(this, "client", `NextGIS-NGW-Connector/${pkg.version}`);
     __publicField$2(this, "routeStr", "/api/component/pyramid/route");
     __publicField$2(this, "activeRequests", {});
     __publicField$2(this, "requestTransform");
     const exist = findConnector(options);
     this.cache = new Cache({ namespace: options.cacheId });
+    this.routeCache = new Cache({ namespace: "routecache" });
     if (exist) {
       return exist;
     } else {
@@ -677,7 +812,9 @@ class NgwConnector {
    *   .catch((er) => console.log('Connection problem', er));
    * ```
    */
-  async connect() {
+  async connect({
+    signal
+  } = {}) {
     const auth = this.options.auth;
     if (auth) {
       const { login, password } = auth;
@@ -686,18 +823,9 @@ class NgwConnector {
       }
     }
     const routeUrl = `${this.routeStr}?client=${this.client}`;
-    return await this.makeQuery(
-      routeUrl,
-      {},
-      {
-        cacheName: "route",
-        cache: true,
-        cacheProps: {
-          id: this.id,
-          auth,
-          baseUrl: this.options.baseUrl
-        }
-      }
+    return this.routeCache.add(
+      this.options.baseUrl || String(this.id),
+      () => this.makeQuery(routeUrl, null, { signal, cache: false })
     );
   }
   /**
@@ -717,6 +845,7 @@ class NgwConnector {
     removeConnector(this);
     this.options.auth = void 0;
     this.user = void 0;
+    this.routeCache.clean();
     this.clearCache();
     this.emitter.emit("logout");
   }
@@ -821,7 +950,7 @@ class NgwConnector {
         this._cleanActiveRequest(id);
       }
     };
-    if (method === "GET") {
+    if (method === "GET" && cache !== false) {
       const cacheOptions = cacheProps ? cacheProps : {
         ...utils.objectRemoveEmpty({
           headers,
@@ -905,10 +1034,7 @@ class NgwConnector {
     return er;
   }
 }
-__publicField$2(NgwConnector, "errors", {
-  NgwError,
-  ResourceNotFoundError
-});
+__publicField$2(NgwConnector, "errors", errors);
 
 function resourceCompare(res1, res2) {
   return utils.objectDeepEqual(res1, res2);
@@ -922,7 +1048,10 @@ function resourceToQuery(resource, prefix = "") {
     if (exclude.indexOf(key) === -1) {
       if (isObject(value)) {
         if (key === "owner_user") {
-          const children = resourceToQuery(value, key);
+          const children = resourceToQuery(
+            value,
+            key
+          );
           Object.assign(query, children);
         } else if (key === "parent" && "id" in value) {
           query.parent_id = value.id;
@@ -1036,9 +1165,12 @@ class ResourcesControl {
         } else {
           Object.assign(query, resourceToQuery(resource));
         }
-        return this.connector.get("resource.search", requestOptions, {
-          serialization: "full",
-          ...query
+        return this.connector.route("resource.search").get({
+          ...requestOptions,
+          query: {
+            serialization: "full",
+            ...query
+          }
         }).then((resources) => {
           if ((requestOptions == null ? void 0 : requestOptions.cache) && resources) {
             for (const x of resources) {
@@ -1055,7 +1187,8 @@ class ResourcesControl {
   }
   getParent(resource, requestOptions) {
     return this.getOne(resource, requestOptions).then((child) => {
-      if (child) {
+      var _a, _b;
+      if ((_b = (_a = child == null ? void 0 : child.resource) == null ? void 0 : _a.parent) == null ? void 0 : _b.id) {
         return this.getOne(child.resource.parent.id, requestOptions);
       }
       return Promise.resolve(void 0);
@@ -1087,31 +1220,41 @@ class ResourcesControl {
       }
     });
   }
-  _getChildrenOf(parent, requestOptions, _items = []) {
-    return this.connector.get("resource.collection", requestOptions, {
-      parent
-    }).then((items) => {
-      const recursivePromises = [];
-      for (const item of items) {
-        if (requestOptions == null ? void 0 : requestOptions.cache) {
-          this.cache.add("resource.item", Promise.resolve(item), {
-            id: item.resource.id
-          });
-        }
-        _items.push(item);
-        if ((requestOptions == null ? void 0 : requestOptions.recursive) && item.resource.children) {
-          recursivePromises.push(
-            this._getChildrenOf(item.resource.id, requestOptions, _items)
-          );
-        }
+  async _getChildrenOf(parentDef, requestOptions, _items = []) {
+    let parent = void 0;
+    if (typeof parentDef === "string") {
+      parent = await this.getId(parentDef, requestOptions);
+    } else if (typeof parentDef === "object") {
+      parent = parentDef.id;
+    } else {
+      parent = parentDef;
+    }
+    const items = await this.connector.route("resource.collection").get({
+      ...requestOptions,
+      query: {
+        parent
       }
-      if (recursivePromises.length) {
-        return Promise.all(recursivePromises).then(() => {
-          return _items;
+    });
+    const recursivePromises = [];
+    for (const item of items) {
+      if (requestOptions == null ? void 0 : requestOptions.cache) {
+        this.cache.add("resource.item", Promise.resolve(item), {
+          id: item.resource.id
         });
       }
-      return _items;
-    });
+      _items.push(item);
+      if ((requestOptions == null ? void 0 : requestOptions.recursive) && item.resource.children) {
+        recursivePromises.push(
+          this._getChildrenOf(item.resource.id, requestOptions, _items)
+        );
+      }
+    }
+    if (recursivePromises.length) {
+      return Promise.all(recursivePromises).then(() => {
+        return _items;
+      });
+    }
+    return _items;
   }
   async _cleanResourceItemCache(id) {
     var _a;
@@ -1137,7 +1280,7 @@ class ResourcesControl {
     }
   }
   _fetchResourceById(id, requestOptions) {
-    return this.connector.get("resource.item", requestOptions, { id });
+    return this.connector.route("resource.item", { id }).get(requestOptions);
   }
   _fetchResourceBy(resource, requestOptions) {
     return this.getMany(resource, requestOptions).then((resources) => {
@@ -1165,56 +1308,6 @@ class ResourcesControl {
   }
 }
 
-async function apiRequest(opt) {
-  const { params, name, connector, requestOptions } = opt;
-  const apiItems = await connector.connect();
-  let apiItem = apiItems && apiItems[name];
-  if (apiItem) {
-    apiItem = [...apiItem];
-    let url = apiItem.shift();
-    if (apiItem.length) {
-      const replaceParams = {};
-      for (let fry = 0; fry < apiItem.length; fry++) {
-        const arg = apiItem[fry];
-        replaceParams[fry] = `{${arg}}`;
-        if (params[arg] === void 0) {
-          throw new Error(`\`${arg}\` URL API argument is not specified`);
-        }
-      }
-      if (url) {
-        url = template(url, replaceParams);
-      }
-    }
-    if (params) {
-      const paramArray = [];
-      const paramList = params.paramList;
-      if (Array.isArray(paramList)) {
-        paramList.forEach(([key, value]) => {
-          paramArray.push(`${key}=${value}`);
-        });
-      }
-      for (const p in params) {
-        if (apiItem.indexOf(p) === -1) {
-          paramArray.push(`${p}=${params[p]}`);
-        }
-      }
-      if (paramArray.length) {
-        url = `${url}?${paramArray.join("&")}`;
-      }
-    }
-    if (url) {
-      return connector.makeQuery(url, params, {
-        cacheName: name,
-        ...requestOptions
-      });
-    } else {
-      throw new Error("Request URL is not set");
-    }
-  } else {
-    return void 0;
-  }
-}
-
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => __defNormalProp(obj, key + "" , value);