@nextgis/ngw-connector 2.5.0 → 3.0.0-alpha.1

package/lib/ngw-connector.cjs.js

@@ -1,9 +1,8 @@
-/** Bundle of @nextgis/ngw-connector; version: 2.5.0; author: NextGIS */
+/** Bundle of @nextgis/ngw-connector; version: 3.0.0-alpha.1; author: NextGIS */
 'use strict';
 
 var events = require('events');
 var Cache = require('@nextgis/cache');
-var CancelablePromise = require('@nextgis/cancelable-promise');
 var utils = require('@nextgis/utils');
 
 var __defProp$4 = Object.defineProperty;
@@ -90,39 +89,27 @@ class ResourcesControl {
    * Fetching resource would be cached to speed up next call
    */
   getOne(resource, requestOptions) {
-    const cache = this.cache;
-    const forCache = {};
-    const opt = { ...requestOptions, cache: false };
-    if (typeof resource === "string") {
-      forCache.keyname = resource;
-    } else if (typeof resource === "number") {
-      forCache.id = resource;
-    } else if (isObject(resource)) {
+    const opt = { ...requestOptions };
+    if (typeof resource === "string") ; else if (typeof resource === "number") ; else if (isObject(resource)) {
       if (resource.id !== void 0) {
-        forCache.id = resource.id;
+        resource.id;
       } else {
         if (resource.keyname) {
-          forCache.keyname = resource.keyname;
+          resource.keyname;
         }
         if (resource.display_name) {
-          forCache.display_name = resource.display_name;
+          resource.display_name;
         }
       }
     }
-    const makeRequest = () => {
-      if (typeof resource === "string") {
-        return this._fetchResourceBy({ keyname: resource }, opt);
-      } else if (typeof resource === "number") {
-        return this._fetchResourceById(resource, opt);
-      } else if (isObject(resource)) {
-        return this._fetchResourceBy(resource, opt);
-      }
-      return CancelablePromise.resolve(void 0);
-    };
-    if (requestOptions == null ? void 0 : requestOptions.cache) {
-      return cache.addFull("resource", makeRequest, forCache);
+    if (typeof resource === "string") {
+      return this._fetchResourceBy({ keyname: resource }, opt);
+    } else if (typeof resource === "number") {
+      return this._fetchResourceById(resource, opt);
+    } else if (isObject(resource)) {
+      return this._fetchResourceBy(resource, opt);
     }
-    return makeRequest();
+    return Promise.resolve(void 0);
   }
   getOneOrFail(resource, requestOptions) {
     return this.getOne(resource, requestOptions).then((res) => {
@@ -144,7 +131,7 @@ class ResourcesControl {
    */
   getId(resource, requestOptions) {
     if (typeof resource === "number") {
-      return CancelablePromise.resolve(resource);
+      return Promise.resolve(resource);
     } else if (typeof resource === "string" || isObject(resource)) {
       return this.getOne(resource, requestOptions).then((res) => {
         if (res) {
@@ -152,7 +139,7 @@ class ResourcesControl {
         }
       });
     }
-    return CancelablePromise.resolve(void 0);
+    return Promise.resolve(void 0);
   }
   /**
    * A fast way to retrieve resource ID for any resource definition.
@@ -183,9 +170,9 @@ class ResourcesControl {
           serialization: "full",
           ...query
         }).then((resources) => {
-          if (resources) {
+          if ((requestOptions == null ? void 0 : requestOptions.cache) && resources) {
             for (const x of resources) {
-              this.cache.add("resource.item", CancelablePromise.resolve(x), {
+              this.cache.add("resource.item", Promise.resolve(x), {
                 id: x.resource.id
               });
             }
@@ -201,7 +188,7 @@ class ResourcesControl {
       if (child) {
         return this.getOne(child.resource.parent.id, requestOptions);
       }
-      return CancelablePromise.resolve(void 0);
+      return Promise.resolve(void 0);
     });
   }
   getChildrenOf(resource, requestOptions) {
@@ -231,18 +218,16 @@ class ResourcesControl {
     });
   }
   _getChildrenOf(parent, requestOptions, _items = []) {
-    return this.connector.get(
-      "resource.collection",
-      { cache: true, ...requestOptions },
-      {
-        parent
-      }
-    ).then((items) => {
+    return this.connector.get("resource.collection", requestOptions, {
+      parent
+    }).then((items) => {
       const recursivePromises = [];
       for (const item of items) {
-        this.cache.add("resource.item", CancelablePromise.resolve(item), {
-          id: item.resource.id
-        });
+        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(
@@ -251,7 +236,7 @@ class ResourcesControl {
         }
       }
       if (recursivePromises.length) {
-        return CancelablePromise.all(recursivePromises).then(() => {
+        return Promise.all(recursivePromises).then(() => {
           return _items;
         });
       }
@@ -259,10 +244,11 @@ class ResourcesControl {
     });
   }
   async _cleanResourceItemCache(id) {
+    var _a;
     const all = this.cache.all();
     const toDelete = [];
     for (const c of all) {
-      const cid = c.options && c.options.id;
+      const cid = (_a = c.props) == null ? void 0 : _a.id;
       if (["resource.item", "resource"].includes(c.key) && cid !== void 0) {
         if (typeof cid === "number") {
           if (cid === id) {
@@ -281,18 +267,7 @@ class ResourcesControl {
     }
   }
   _fetchResourceById(id, requestOptions) {
-    const promise = () => this.connector.get("resource.item", requestOptions, { id });
-    if (requestOptions == null ? void 0 : requestOptions.cache) {
-      return this.cache.add("resource.item", promise, {
-        id
-      }).catch((er) => {
-        if (!(er instanceof ResourceNotFoundError)) {
-          throw er;
-        }
-        return void 0;
-      });
-    }
-    return promise();
+    return this.connector.get("resource.item", requestOptions, { id });
   }
   _fetchResourceBy(resource, requestOptions) {
     return this.getMany(resource, requestOptions).then((resources) => {
@@ -300,7 +275,7 @@ class ResourcesControl {
     });
   }
   _resourceCacheFilter(resource) {
-    return CancelablePromise.all(this.cache.matchAll("resource.item")).then(
+    return Promise.all(this.cache.matchAll("resource.item")).then(
       (resources) => {
         const items = [];
         resources.filter((x) => {
@@ -344,6 +319,13 @@ function removeConnector(connector) {
   }
 }
 
+class AbortError extends Error {
+  constructor(message = "AbortError") {
+    super(message);
+    this.name = "AbortError";
+  }
+}
+
 var __defProp$1 = Object.defineProperty;
 var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$1 = (obj, key, value) => __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -369,59 +351,54 @@ function template(str, data) {
   });
 }
 
-function apiRequest(opt) {
-  const params = opt.params;
-  return new CancelablePromise((resolve, reject) => {
-    return opt.connector.connect().then((apiItems) => {
-      let apiItem = apiItems && apiItems[opt.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);
-          }
+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 (params) {
-          const paramArray = [];
-          const paramList = params.paramList;
-          if (Array.isArray(paramList)) {
-            delete params.paramList;
-            paramList.forEach((x) => {
-              paramArray.push(`${x[0]}=${x[1]}`);
-            });
-          }
-          for (const p in params) {
-            if (apiItem.indexOf(p) === -1) {
-              paramArray.push(`${p}=${params[p]}`);
-            }
-          }
-          if (paramArray.length) {
-            url = url + "?" + paramArray.join("&");
-          }
-        }
-        if (url) {
-          resolve(opt.connector.makeQuery(url, params, opt.requestOptions));
-        } else {
-          reject(new Error("request url is not set"));
+      }
+      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]}`);
         }
-      } else {
-        resolve(void 0);
       }
-    }).catch((er) => {
-      reject(er);
-    });
-  });
+      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;
+  }
 }
 
 function isError(error) {
@@ -556,6 +533,7 @@ 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, typeof key !== "symbol" ? key + "" : key, value);
 let ID = 0;
+let REQUEST_ID = 0;
 class NgwConnector {
   constructor(options) {
     this.options = options;
@@ -566,7 +544,7 @@ class NgwConnector {
     __publicField(this, "cache");
     __publicField(this, "withCredentials");
     __publicField(this, "routeStr", "/api/component/pyramid/route");
-    __publicField(this, "activeRequests", []);
+    __publicField(this, "activeRequests", {});
     __publicField(this, "requestTransform");
     const exist = findConnector(options);
     this.cache = new Cache({ namespace: options.cacheId });
@@ -626,31 +604,27 @@ class NgwConnector {
    *   .catch((er) => console.log('Connection problem', er));
    * ```
    */
-  connect() {
+  async connect() {
     const auth = this.options.auth;
-    const makeConnect = () => new CancelablePromise((resolve, reject) => {
-      const makeQuery = () => {
-        return this.makeQuery(this.routeStr, {}, {}).then((route) => {
-          resolve(route);
-        }).catch((er) => {
-          reject(er);
-        });
-      };
-      if (auth) {
-        const { login, password } = auth;
-        if (login && password) {
-          return this._login({ login, password }).then(() => {
-            return makeQuery();
-          }).catch((er) => reject(er));
+    if (auth) {
+      const { login, password } = auth;
+      if (login && password) {
+        await this._login({ login, password });
+      }
+    }
+    return await this.makeQuery(
+      this.routeStr,
+      {},
+      {
+        cacheName: "route",
+        cache: true,
+        cacheProps: {
+          id: this.id,
+          auth,
+          baseUrl: this.options.baseUrl
         }
       }
-      return makeQuery();
-    });
-    return this.cache.add("route", makeConnect, {
-      id: this.id,
-      auth,
-      baseUrl: this.options.baseUrl
-    });
+    );
   }
   /**
    * Quick way to change NextGIS Web user.
@@ -672,16 +646,15 @@ class NgwConnector {
     this.clearCache();
     this.emitter.emit("logout");
   }
-  getUserInfo(credentials, options) {
+  async getUserInfo(credentials, options) {
     if (this.user && this.user.id) {
-      return CancelablePromise.resolve(this.user);
+      return this.user;
     }
     if (credentials) {
       this.options.auth = credentials;
     }
     const options_ = {
       headers: this.getAuthorizationHeaders(credentials),
-      // withCredentials: true
       ...options
     };
     return this.makeQuery(
@@ -697,7 +670,7 @@ class NgwConnector {
     const client = this.makeClientId(credentials);
     if (client) {
       return {
-        Authorization: "Basic " + client
+        Authorization: `Basic ${client}`
       };
     }
   }
@@ -705,21 +678,22 @@ class NgwConnector {
     credentials = credentials || this.options.auth;
     if (credentials) {
       const { login, password } = credentials;
-      const str = unescape(encodeURIComponent(`${login}:${password}`));
+      const str = `${login}:${password}`;
+      const encodedStr = encodeURIComponent(str);
       {
-        return Buffer.from(str).toString("base64");
+        return Buffer.from(encodedStr).toString("base64");
       }
     }
   }
   /** Stop all api requests */
   abort() {
-    for (const req of this.activeRequests) {
-      req.cancel();
+    for (const abortController of Object.values(this.activeRequests)) {
+      abortController.abort();
     }
-    this.activeRequests = [];
+    this.activeRequests = {};
   }
   getActiveApiRequests() {
-    return [...this.activeRequests];
+    return { ...this.activeRequests };
   }
   /**
    * Send request to NGW api router.
@@ -751,28 +725,10 @@ class NgwConnector {
    * ```
    */
   apiRequest(name, params_ = {}, requestOptions = {}) {
-    var _a, _b;
-    requestOptions = {
-      withCredentials: this.withCredentials,
-      ...requestOptions
-    };
-    const { method, headers, withCredentials, responseType } = requestOptions;
+    var _a;
     params_ = (_a = requestOptions.params) != null ? _a : params_;
     const params = utils.objectRemoveEmpty(params_);
-    const makeApiRequest = () => apiRequest({ name, params, requestOptions, connector: this });
-    if (requestOptions.cache && method === "GET") {
-      return this.cache.add(name, makeApiRequest, {
-        params,
-        ...utils.objectRemoveEmpty({
-          headers,
-          withCredentials,
-          responseType,
-          baseUrl: this.options.baseUrl,
-          userId: (_b = this.user) == null ? void 0 : _b.id
-        })
-      });
-    }
-    return makeApiRequest();
+    return apiRequest({ name, params, requestOptions, connector: this });
   }
   /**
    * Shortcut method for send POST request to NGW.
@@ -862,17 +818,67 @@ class NgwConnector {
    * @param params - Query params
    * @param options - Request options
    */
-  makeQuery(url, params, options = {}) {
+  async makeQuery(url, params, options = {}) {
+    var _a;
     url = (this.options.baseUrl ? this.options.baseUrl : "") + url;
-    if (url) {
-      if (params) {
-        url = template(url, params);
-      }
-      url = encodeURI(utils.fixUrlStr(url));
-      return this._loadData(url, options);
-    } else {
+    if (!url) {
       throw new Error("Empty `url` not allowed");
     }
+    if (params) {
+      const { paramList, ...restParams } = params;
+      url = template(url, restParams);
+    }
+    url = encodeURI(utils.fixUrlStr(url));
+    options = { withCredentials: this.withCredentials, ...options };
+    const {
+      cache,
+      signal: externalSignal,
+      method = "GET",
+      headers,
+      cacheName,
+      cacheProps,
+      responseType,
+      withCredentials
+    } = options;
+    const internalAbortController = new AbortController();
+    const internalSignal = internalAbortController.signal;
+    if (externalSignal) {
+      if (externalSignal.aborted) {
+        throw new AbortError();
+      }
+      externalSignal.addEventListener("abort", () => {
+        internalAbortController.abort();
+      });
+    }
+    options.signal = internalSignal;
+    const createPromise = async () => {
+      const id = REQUEST_ID++;
+      this.activeRequests[id] = internalAbortController;
+      try {
+        return this._loadData(url, options);
+      } finally {
+        this._cleanActiveRequest(id);
+      }
+    };
+    if (cache && method === "GET") {
+      const cacheOptions = cacheProps ? cacheProps : {
+        ...utils.objectRemoveEmpty({
+          headers,
+          withCredentials,
+          responseType,
+          baseUrl: this.options.baseUrl,
+          userId: (_a = this.user) == null ? void 0 : _a.id
+        }),
+        params
+      };
+      return this.cache.add(
+        cacheName || url,
+        createPromise,
+        cacheOptions,
+        false
+      );
+    }
+    return createPromise();
   }
   // -------------------------------------------------------------------------
   // Resource Methods
@@ -954,10 +960,8 @@ class NgwConnector {
    */
   _loadData(url, options) {
     options.responseType = options.responseType || "json";
-    if (options.signal && options.signal.aborted) {
-      return CancelablePromise.reject(new CancelablePromise.CancelError());
-    }
-    const request = new CancelablePromise((resolve, reject, onCancel) => {
+    return new Promise((resolve, reject) => {
+      var _a;
       if (this.user) {
         options = options || {};
         options.headers = {
@@ -970,13 +974,18 @@ class NgwConnector {
         url = transUrl;
         options = transOptions;
       }
-      loadData(url, resolve, options, reject, onCancel);
-    }).then((resp) => {
-      this._cleanActiveRequests(request);
-      return resp;
+      let runOnAbort = void 0;
+      loadData(url, resolve, options, reject, (handler) => {
+        runOnAbort = handler;
+      });
+      (_a = options.signal) == null ? void 0 : _a.addEventListener("abort", () => {
+        if (runOnAbort !== void 0) {
+          runOnAbort();
+        }
+        reject(new AbortError());
+      });
     }).catch((httpError) => {
-      this._cleanActiveRequests(request);
-      if (httpError instanceof CancelablePromise.CancelError) ; else {
+      if (httpError.name !== "AbortError") {
         {
           console.warn("DEV WARN", httpError);
         }
@@ -985,32 +994,23 @@ class NgwConnector {
           throw er;
         }
       }
+      throw httpError;
     });
-    if (options.signal && typeof options.signal.addEventListener === "function") {
-      options.signal.addEventListener("abort", () => {
-        request.cancel();
-        this._cleanActiveRequests(request);
-      });
-    }
-    this.activeRequests.push(request);
-    return request;
   }
-  _login(credentials, options) {
-    return this.getUserInfo(credentials, options).then((data) => {
+  async _login(credentials, options) {
+    try {
+      const data = await this.getUserInfo(credentials, options);
       this.user = data;
       this.emitter.emit("login", data);
       return data;
-    }).catch((er) => {
+    } catch (er) {
       this.emitter.emit("login:error", er);
       throw er;
-    });
-  }
-  _cleanActiveRequests(request) {
-    const activeRequestIndex = this.activeRequests.indexOf(request);
-    if (activeRequestIndex !== -1) {
-      this.activeRequests.splice(activeRequestIndex, 1);
     }
   }
+  _cleanActiveRequest(requestId) {
+    delete this.activeRequests[requestId];
+  }
   _handleHttpError(er) {
     if (er) {
       if (er instanceof NgwError) {