@nextgis/ngw-connector 1.18.21 → 1.19.6

package/lib/ngw-connector.esm-bundler.js

@@ -1,21 +1,64 @@
-/** Bundle of @nextgis/ngw-connector; version: 1.18.21; author: NextGIS */
+/** Bundle of @nextgis/ngw-connector; version: 1.19.6; author: NextGIS */
 import { EventEmitter } from 'events';
+import Cache from '@nextgis/cache';
 import CancelablePromise from '@nextgis/cancelable-promise';
 import { objectDeepEqual, defined, objectRemoveEmpty, fixUrlStr } from '@nextgis/utils';
-import Cache from '@nextgis/cache';
 
-/**
- * Thrown when...
- */
-class NetworkError extends Error {
-    constructor(url) {
-        super();
-        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}`; // /control-panel/cors
-    }
-}
+var pkg = {
+	name: "@nextgis/ngw-connector",
+	version: "1.19.6",
+	_priority: 12,
+	description: "A lightweight HTTP client optimized for use with NextGIS Web API",
+	main: "index.js",
+	module: "lib/ngw-connector.esm-bundler.js",
+	unpkg: "lib/ngw-connector.global.prod.js",
+	jsdelivr: "lib/ngw-connector.global.prod.js",
+	types: "lib/index.d.ts",
+	dependencies: {
+		"@nextgis/cache": "^1.19.0",
+		"@nextgis/cancelable-promise": "^1.19.0",
+		"@nextgis/utils": "^1.19.0",
+		"@types/events": "^3.0.0",
+		events: "^3.3.0",
+		"form-data": "^4.0.0"
+	},
+	devDependencies: {
+		"@nextgis/build-tools": "^1.19.0"
+	},
+	scripts: {
+		clean: "rimraf ./lib",
+		dev: "node ../build-tools/lib/build.js",
+		prod: "npm run dev -- --release",
+		lint: "eslint ./src/**/*.ts --fix --c ../../.eslintrc",
+		watch: "npm run dev -- --watch",
+		"gen:types": "node ./scripts/generator"
+	},
+	buildOptions: {
+		name: "NgwConnector",
+		formats: [
+			"esm-bundler",
+			"esm-browser",
+			"cjs",
+			"global"
+		]
+	},
+	keywords: [
+		"NextGIS",
+		"MAP"
+	],
+	author: "NextGIS",
+	files: [
+		"index.js",
+		"lib"
+	],
+	license: "MIT",
+	homepage: "https://github.com/nextgis/nextgis_frontend/tree/master/packages/ngw-connector#readme",
+	repository: {
+		type: "git",
+		url: "git://github.com/nextgis/nextgis_frontend.git"
+	},
+	gitHead: "edc68033f914f6c95c4125b9738bba6d36e990b4"
+};
 
 /**
  * Thrown when...
@@ -29,193 +72,6 @@ class NgwError extends Error {
     }
 }
 
-function isObject(val) {
-    return Object.prototype.toString.call(val) === '[object Object]';
-}
-
-let loadData;
-// @ts-ignore
-{
-    loadData = (url, callback, options = {}, error, onCancel) => {
-        options.method = options.method || 'GET';
-        const xhr = new XMLHttpRequest();
-        xhr.open(options.method || 'GET', url, true); // true for asynchronous
-        if (options.responseType === 'blob') {
-            xhr.responseType = options.responseType;
-        }
-        const getResponseText = () => {
-            try {
-                return JSON.parse(xhr.responseText);
-            }
-            catch (er) {
-                return xhr.responseText;
-            }
-        };
-        const processingResponse = (forError = false) => {
-            const cb = forError ? error : callback;
-            if (options.responseType === 'blob') {
-                cb(xhr.response);
-            }
-            else {
-                if (xhr.responseText) {
-                    cb(getResponseText());
-                }
-                else {
-                    error({ message: '' });
-                }
-            }
-        };
-        xhr.onload = () => {
-            if ([401, 403, 404, 422, 500].indexOf(xhr.status) !== -1) {
-                error(new NgwError(getResponseText()));
-            }
-            processingResponse();
-        };
-        // xhr.onreadystatechange = () => {
-        //   if (
-        //     (xhr.readyState === 4 && xhr.status === 200) ||
-        //     (xhr.readyState === 3 && xhr.status === 201)
-        //   ) {
-        //     processingResponse();
-        //   } else if (xhr.readyState === 3 && xhr.status === 400) {
-        //     processingResponse();
-        //   } else if (xhr.readyState === 4 && xhr.status === 500) {
-        //     processingResponse();
-        //   } else if (xhr.readyState === 4 && xhr.status === 401) {
-        //     error(xhr.statusText);
-        //   } else if (xhr.readyState === 4) {
-        //     error('request error');
-        //   }
-        // };
-        xhr.onerror = (er) => {
-            if (xhr.status === 0) {
-                error(new NetworkError(url));
-            }
-            else {
-                error(er);
-            }
-        };
-        xhr.upload.onprogress = function (e) {
-            if (e.lengthComputable) {
-                const percentComplete = (e.loaded / e.total) * 100;
-                if (options.onProgress) {
-                    options.onProgress(percentComplete, e);
-                }
-                // console.log(percentComplete + '% uploaded');
-            }
-        };
-        const headers = options.headers;
-        if (headers) {
-            for (const h in headers) {
-                const header = headers[h];
-                if (typeof header === 'string') {
-                    xhr.setRequestHeader(h, header);
-                }
-            }
-        }
-        if (options.withCredentials !== undefined) {
-            xhr.withCredentials = options.withCredentials;
-        }
-        let data;
-        if (options.file) {
-            data = new FormData();
-            data.append('file', options.file);
-            if (options.data) {
-                for (const d in options.data) {
-                    data.append(d, data[d]);
-                }
-            }
-        }
-        else {
-            data = options.data
-                ? typeof options.data === 'string'
-                    ? options.data
-                    : JSON.stringify(options.data)
-                : null;
-        }
-        if (onCancel) {
-            onCancel(() => {
-                xhr.abort();
-            });
-        }
-        xhr.send(data);
-    };
-}
-
-// https://github.com/Leaflet/Leaflet/blob/b507e21c510b53cd704fb8d3f89bb46ea925c8eb/src/core/Util.js#L165
-const templateRe = /\{ *([\w_-]+) *\}/g;
-function template(str, data) {
-    return str.replace(templateRe, (s, key) => {
-        let value = data[key];
-        if (value === undefined) {
-            throw new Error('No value provided for letiable ' + s);
-        }
-        else if (typeof value === 'function') {
-            value = value(data);
-        }
-        return value;
-    });
-}
-
-function apiRequest(opt) {
-    const params = opt.params;
-    return new CancelablePromise((resolve, reject) => {
-        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] === undefined) {
-                            throw new Error('`' + arg + '`' + ' url api argument is not specified');
-                        }
-                    }
-                    if (url) {
-                        url = template(url, replaceParams);
-                    }
-                }
-                // Transfer part of the parameters from `params` to the URL string
-                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'));
-                }
-            }
-            else {
-                resolve(undefined);
-            }
-        })
-            .catch((er) => {
-            reject(er);
-        });
-    });
-}
-
 /**
  * Thrown when ...
  */
@@ -228,42 +84,12 @@ class ResourceNotFoundError extends NgwError {
     }
 }
 
-/**
- * Thrown when ...
- */
-class InsufficientPermissionsError extends NgwError {
-    constructor(obj) {
-        super(obj);
-        this.name = 'InsufficientPermissionsError';
-        this.exception = 'nextgisweb.core.exception.InsufficientPermissions';
-        Object.setPrototypeOf(this, InsufficientPermissionsError.prototype);
-    }
+function isObject(val) {
+    return Object.prototype.toString.call(val) === '[object Object]';
 }
 
-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 objectDeepEqual(x.options.auth, options.auth);
-                }
-            }
-            else {
-                // if auth not in find options; use first connector with same url
-                return true;
-            }
-        }
-    });
-}
-function removeConnector(connector) {
-    const index = CONNECTORS.indexOf(connector);
-    if (index !== -1) {
-        CONNECTORS.splice(index, 1);
-    }
+function resourceCompare(res1, res2) {
+    return objectDeepEqual(res1, res2);
 }
 
 const exclude = ['description'];
@@ -299,10 +125,6 @@ function resourceToQuery(resource, prefix = '') {
     return query;
 }
 
-function resourceCompare(res1, res2) {
-    return objectDeepEqual(res1, res2);
-}
-
 class ResourcesControl {
     constructor(connector) {
         this.connector = connector;
@@ -543,12 +365,247 @@ class ResourcesControl {
     }
 }
 
+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 objectDeepEqual(x.options.auth, options.auth);
+                }
+            }
+            else {
+                // if auth not in find options; use first connector with same url
+                return true;
+            }
+        }
+    });
+}
+function removeConnector(connector) {
+    const index = CONNECTORS.indexOf(connector);
+    if (index !== -1) {
+        CONNECTORS.splice(index, 1);
+    }
+}
+
+/**
+ * Thrown when ...
+ */
+class InsufficientPermissionsError extends NgwError {
+    constructor(obj) {
+        super(obj);
+        this.name = 'InsufficientPermissionsError';
+        this.exception = 'nextgisweb.core.exception.InsufficientPermissions';
+        Object.setPrototypeOf(this, InsufficientPermissionsError.prototype);
+    }
+}
+
+// https://github.com/Leaflet/Leaflet/blob/b507e21c510b53cd704fb8d3f89bb46ea925c8eb/src/core/Util.js#L165
+const templateRe = /\{ *([\w_-]+) *\}/g;
+function template(str, data) {
+    return str.replace(templateRe, (s, key) => {
+        let value = data[key];
+        if (value === undefined) {
+            throw new Error('No value provided for letiable ' + s);
+        }
+        else if (typeof value === 'function') {
+            value = value(data);
+        }
+        return value;
+    });
+}
+
+function apiRequest(opt) {
+    const params = opt.params;
+    return new CancelablePromise((resolve, reject) => {
+        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] === undefined) {
+                            throw new Error('`' + arg + '`' + ' url api argument is not specified');
+                        }
+                    }
+                    if (url) {
+                        url = template(url, replaceParams);
+                    }
+                }
+                // Transfer part of the parameters from `params` to the URL string
+                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'));
+                }
+            }
+            else {
+                resolve(undefined);
+            }
+        })
+            .catch((er) => {
+            reject(er);
+        });
+    });
+}
+
+/**
+ * Thrown when...
+ */
+class NetworkError extends Error {
+    constructor(url) {
+        super();
+        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}`; // /control-panel/cors
+    }
+}
+
+let loadData;
+// @ts-ignore
+{
+    loadData = (url, callback, options = {}, error, onCancel) => {
+        options.method = options.method || 'GET';
+        const xhr = new XMLHttpRequest();
+        xhr.open(options.method || 'GET', url, true); // true for asynchronous
+        if (options.responseType === 'blob') {
+            xhr.responseType = options.responseType;
+        }
+        const getResponseText = () => {
+            try {
+                return JSON.parse(xhr.responseText);
+            }
+            catch (er) {
+                return xhr.responseText;
+            }
+        };
+        const processingResponse = (forError = false) => {
+            const cb = forError ? error : callback;
+            if (options.responseType === 'blob') {
+                cb(xhr.response);
+            }
+            else {
+                if (xhr.responseText) {
+                    cb(getResponseText());
+                }
+                else {
+                    error({ message: '' });
+                }
+            }
+        };
+        xhr.onload = () => {
+            if ([401, 403, 404, 422, 500].indexOf(xhr.status) !== -1) {
+                error(new NgwError(getResponseText()));
+            }
+            processingResponse();
+        };
+        // xhr.onreadystatechange = () => {
+        //   if (
+        //     (xhr.readyState === 4 && xhr.status === 200) ||
+        //     (xhr.readyState === 3 && xhr.status === 201)
+        //   ) {
+        //     processingResponse();
+        //   } else if (xhr.readyState === 3 && xhr.status === 400) {
+        //     processingResponse();
+        //   } else if (xhr.readyState === 4 && xhr.status === 500) {
+        //     processingResponse();
+        //   } else if (xhr.readyState === 4 && xhr.status === 401) {
+        //     error(xhr.statusText);
+        //   } else if (xhr.readyState === 4) {
+        //     error('request error');
+        //   }
+        // };
+        xhr.onerror = (er) => {
+            if (xhr.status === 0) {
+                error(new NetworkError(url));
+            }
+            else {
+                error(er);
+            }
+        };
+        xhr.upload.onprogress = function (e) {
+            if (e.lengthComputable) {
+                const percentComplete = (e.loaded / e.total) * 100;
+                if (options.onProgress) {
+                    options.onProgress(percentComplete, e);
+                }
+                // console.log(percentComplete + '% uploaded');
+            }
+        };
+        const headers = options.headers;
+        if (headers) {
+            for (const h in headers) {
+                const header = headers[h];
+                if (typeof header === 'string') {
+                    xhr.setRequestHeader(h, header);
+                }
+            }
+        }
+        if (options.withCredentials !== undefined) {
+            xhr.withCredentials = options.withCredentials;
+        }
+        let data;
+        if (options.file) {
+            data = new FormData();
+            data.append('file', options.file);
+            if (options.data) {
+                for (const d in options.data) {
+                    data.append(d, data[d]);
+                }
+            }
+        }
+        else {
+            data = options.data
+                ? typeof options.data === 'string'
+                    ? options.data
+                    : JSON.stringify(options.data)
+                : null;
+        }
+        if (onCancel) {
+            onCancel(() => {
+                xhr.abort();
+            });
+        }
+        xhr.send(data);
+    };
+}
+
 let ID = 0;
 class NgwConnector$1 {
     constructor(options) {
         this.options = options;
         this.id = ID++;
         this.emitter = new EventEmitter();
+        this.client = `NextGIS-NGW-Connector/${pkg.version}`;
         this.routeStr = '/api/component/pyramid/route';
         this.activeRequests = [];
         const exist = findConnector(options);
@@ -600,7 +657,8 @@ class NgwConnector$1 {
         const auth = this.options.auth;
         const makeConnect = () => new CancelablePromise((resolve, reject) => {
             const makeQuery = () => {
-                return this.makeQuery(this.routeStr, {}, {})
+                const routeUrl = `${this.routeStr}?client=${this.client}`;
+                return this.makeQuery(routeUrl.toString(), {}, {})
                     .then((route) => {
                     resolve(route);
                 })