@nextgis/ngw-connector 1.8.4 → 1.11.0

package/lib/ngw-connector.cjs.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 */
 'use strict';
 
 var events = require('events');
@@ -23,12 +23,17 @@ class NgwError extends Error {
     }
 }
 
+function isObject(val) {
+    return Object.prototype.toString.call(val) === '[object Object]';
+}
+
 let loadData;
 // @ts-ignore
 {
     const url = require('url');
     const http = require('http');
     const https = require('https');
+    const FormData = require('form-data');
     const adapterFor = (inputUrl) => {
         const adapters = {
             'http:': http,
@@ -38,21 +43,41 @@ let loadData;
         return adapters[protocol];
     };
     loadData = (url, callback, options = {}, error, onCancel) => {
+        const { file, headers, method, data, responseType } = options;
         const request = new Promise((resolve, reject) => {
             const adapter = adapterFor(url);
             if (adapter) {
                 const requestOpt = {
-                    headers: options.headers || {},
-                    method: options.method,
+                    headers: headers || {},
+                    method,
                 };
-                const body = typeof options.data === 'string'
-                    ? options.data
-                    : JSON.stringify(options.data);
+                const body = typeof data === 'string' ? data : JSON.stringify(data);
                 // https://stackoverflow.com/questions/35589109/node-http-delete-request-no-longer-works-after-upgrading-from-0-10-40
-                if (body !== undefined && options.method !== 'POST') {
+                let form;
+                let uploadedFile = file;
+                if (file) {
+                    const fileMeta = {};
+                    if (isObject(file) && 'file' in file && 'filename' in file) {
+                        const { file: file_, ...fileMeta_ } = file;
+                        Object.assign(fileMeta, fileMeta_);
+                        uploadedFile = file_;
+                    }
+                    form = new FormData();
+                    form.append('file', uploadedFile, fileMeta);
+                    if (data) {
+                        for (const d in data) {
+                            form.append(d, data[d]);
+                        }
+                    }
+                    Object.assign(requestOpt.headers, {
+                        // 'content-length': form.getLengthSync(),
+                        ...form.getHeaders(),
+                    });
+                }
+                if (body !== undefined && method !== 'POST') {
                     Object.assign(requestOpt.headers, {
-                        'Content-Type': 'application/json',
-                        'Content-Length': Buffer.byteLength(body),
+                        'content-type': 'application/json',
+                        'content-length': Buffer.byteLength(body),
                     });
                 }
                 const req = adapter.request(url, requestOpt, (resp) => {
@@ -62,24 +87,32 @@ let loadData;
                     });
                     resp.on('end', () => {
                         if (data) {
-                            let json;
-                            try {
-                                json = JSON.parse(data);
-                                if (json && json.status_code && json.status_code) {
-                                    reject(json.message);
-                                }
-                            }
-                            catch (er) {
-                                reject(er);
-                                // throw new Error(er);
+                            if (responseType === 'blob') {
+                                resolve(data);
                             }
-                            if (json !== undefined) {
-                                resolve(json);
+                            else {
+                                let json;
+                                try {
+                                    json = JSON.parse(data);
+                                    if (json && json.status_code && json.status_code) {
+                                        reject(json.message);
+                                    }
+                                }
+                                catch (er) {
+                                    reject(er);
+                                    // throw new Error(er);
+                                }
+                                if (json !== undefined) {
+                                    resolve(json);
+                                }
                             }
                         }
                         reject('no data');
                     });
                 });
+                if (form) {
+                    form.pipe(req);
+                }
                 req.on('error', (err) => {
                     reject(err);
                 });
@@ -178,28 +211,36 @@ function removeConnector(connector) {
     }
 }
 
-function isObject(val) {
-    return Object.prototype.toString.call(val) === '[object Object]';
-}
-
+const 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 = '') {
     prefix = prefix ? prefix + '__' : '';
     const query = {};
-    Object.entries(resource).forEach(([key, value]) => {
-        if (isObject(value)) {
-            const children = resourceToQuery(value, key);
-            Object.assign(query, children);
-        }
-        else if (utils.defined(value)) {
-            query[prefix + key] = value;
+    for (const [key, value] of Object.entries(resource)) {
+        if (exclude.indexOf(key) === -1) {
+            if (isObject(value)) {
+                if (key === 'owner_user') {
+                    const children = resourceToQuery(value, key);
+                    Object.assign(query, children);
+                }
+                else if (key === 'parent' && 'id' in value) {
+                    query.parent_id = value.id;
+                }
+            }
+            else if (utils.defined(value)) {
+                query[prefix + key] = value;
+            }
         }
-    });
+    }
     return query;
 }
 
@@ -224,22 +265,33 @@ class ResourcesControl {
      */
     getOne(resource, requestOptions) {
         const cache = new Cache__default();
+        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)) {
+            forCache.id = resource.id;
+        }
         const makeRequest = () => {
             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__default.resolve(undefined);
         };
-        return cache.add('resource', makeRequest, { resource });
+        return cache.addFull('resource', makeRequest, forCache);
     }
-    getOneOrFail(resource) {
-        return this.getOne(resource).then((res) => {
+    getOneOrFail(resource, requestOptions) {
+        return this.getOne(resource, requestOptions).then((res) => {
             if (res) {
                 return res;
             }
@@ -256,12 +308,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 +329,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();
             }
@@ -302,11 +354,11 @@ class ResourcesControl {
                 })
                     .then((resources) => {
                     if (resources) {
-                        resources.forEach((x) => {
+                        for (const x of resources) {
                             this.cache.add('resource.item', CancelablePromise__default.resolve(x), {
                                 id: x.resource.id,
                             });
-                        });
+                        }
                     }
                     return resources;
                 });
@@ -314,18 +366,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) => {
@@ -353,12 +405,35 @@ class ResourcesControl {
         return this.getId(resource).then((id) => {
             if (id !== undefined) {
                 return this.connector.delete('resource.item', null, { id }).then(() => {
-                    this.cache.delete('resource.item', { id });
+                    this._cleanResourceItemCache(id);
                     return undefined;
                 });
             }
         });
     }
+    async _cleanResourceItemCache(id) {
+        const all = this.cache.all();
+        const toDelete = [];
+        for (const c of all) {
+            const cid = c.options && c.options.id;
+            if (['resource.item', 'resource'].includes(c.key) && cid !== undefined) {
+                if (typeof cid === 'number') {
+                    if (cid === id) {
+                        toDelete.push(c);
+                    }
+                }
+                else {
+                    const rid = await this.getId(cid);
+                    if (rid === id) {
+                        toDelete.push(c);
+                    }
+                }
+            }
+        }
+        for (const d of toDelete) {
+            this.cache.delete(d);
+        }
+    }
     _fetchResourceById(id, requestOptions) {
         const promise = () => this.connector.get('resource.item', requestOptions, { id });
         return this.cache
@@ -562,7 +637,7 @@ class NgwConnector$1 {
             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((data) => {
             this.user = data;
@@ -720,7 +795,7 @@ class NgwConnector$1 {
             }
             // remove double slash
             url = utils.fixUrlStr(url);
-            return this._loadData(url, options);
+            return this._loadData(encodeURI(url), options);
         }
         else {
             throw new Error('Empty `url` not allowed');
@@ -732,14 +807,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 +837,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}
@@ -821,7 +896,7 @@ class NgwConnector$1 {
             else {
                 // @ts-ignore
                 {
-                    console.warn(httpError);
+                    console.warn('DEV WARN', httpError);
                 }
                 const er = this._handleHttpError(httpError);
                 if (er) {