@nextgis/ngw-connector 1.18.21 → 1.19.6

package/lib/index.d.ts

@@ -149,6 +149,12 @@ export declare interface GetRequestItemsResponseMap extends RequestItemKeys {
     'feature_layer.feature.count': FeatureLayerCount;
     'pyramid.company_logo': string;
     'spatial_ref_sys.collection': SrsItem[];
+    'render.legend_symbols': RenderLegendSymbol[];
+}
+
+declare interface Icon {
+    format: string;
+    data: string;
 }
 
 export declare interface IdOnly {
@@ -187,6 +193,7 @@ declare class NgwConnector {
     emitter: EventEmitter;
     user?: UserInfo;
     resources: ResourcesControl;
+    private client;
     private routeStr;
     private activeRequests;
     private requestTransform?;
@@ -471,6 +478,11 @@ export declare interface PyramidSettingsPyramidCompanyLogo {
     enabled: boolean;
 }
 
+export declare interface RenderLegendSymbol {
+    display_name: string;
+    icon: Icon;
+}
+
 export declare interface RequestHeaders {
     [header: string]: string | undefined;
     Authorization?: string;

package/lib/ngw-connector.cjs.js

@@ -1,15 +1,71 @@
-/** Bundle of @nextgis/ngw-connector; version: 1.18.21; author: NextGIS */
+/** Bundle of @nextgis/ngw-connector; version: 1.19.6; 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 Cache = require('@nextgis/cache');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
 
-var CancelablePromise__default = /*#__PURE__*/_interopDefaultLegacy(CancelablePromise);
 var Cache__default = /*#__PURE__*/_interopDefaultLegacy(Cache);
+var CancelablePromise__default = /*#__PURE__*/_interopDefaultLegacy(CancelablePromise);
+
+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...
@@ -23,219 +79,6 @@ class NgwError extends Error {
     }
 }
 
-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]';
-}
-
-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,
-            'https:': https,
-        };
-        const protocol = url.parse(inputUrl).protocol || 'https:';
-        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: headers || {},
-                    method,
-                };
-                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
-                let form;
-                let uploadedFile = file;
-                if (file) {
-                    const fileMeta = {};
-                    if (isObject(file) &&
-                        'file' in file &&
-                        ('filename' in file || 'name' in file)) {
-                        const { file: file_, name, ...fileMeta_ } = file;
-                        if (name && !fileMeta_.filename) {
-                            fileMeta_.filename = name;
-                        }
-                        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) {
-                    Object.assign(requestOpt.headers, {
-                        'content-type': 'application/json',
-                        'content-length': Buffer.byteLength(body),
-                    });
-                }
-                const req = adapter.request(url, requestOpt, (resp) => {
-                    let data = '';
-                    resp.on('data', (chunk) => {
-                        data += chunk;
-                    });
-                    resp.on('end', () => {
-                        if (data) {
-                            if (responseType === 'blob') {
-                                resolve(data);
-                            }
-                            else {
-                                let json;
-                                try {
-                                    json = JSON.parse(data);
-                                    if (json && json.status_code && json.status_code) {
-                                        reject(json.message);
-                                    }
-                                }
-                                catch (er) {
-                                    reject(er);
-                                }
-                                if (json !== undefined) {
-                                    if (isError(json)) {
-                                        reject('extractError(json)');
-                                    }
-                                    else {
-                                        resolve(json);
-                                    }
-                                }
-                            }
-                        }
-                        reject('no data');
-                    });
-                });
-                if (form) {
-                    form.pipe(req);
-                }
-                req.on('error', (err) => {
-                    reject(err);
-                });
-                if (body) {
-                    req.write(body);
-                }
-                onCancel(() => {
-                    req.abort();
-                });
-                req.end();
-            }
-            else {
-                throw new Error(`Given URL '${url}' is not correct`);
-            }
-        });
-        return request
-            .then((data) => {
-            if (callback) {
-                callback(data);
-            }
-            return data;
-        })
-            .catch((er) => {
-            if (error) {
-                error(er);
-            }
-            else {
-                throw new Error(er);
-            }
-        });
-    };
-}
-
-// 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__default((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 ...
  */
@@ -248,42 +91,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 utils.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 utils.objectDeepEqual(res1, res2);
 }
 
 const exclude = ['description'];
@@ -319,10 +132,6 @@ function resourceToQuery(resource, prefix = '') {
     return query;
 }
 
-function resourceCompare(res1, res2) {
-    return utils.objectDeepEqual(res1, res2);
-}
-
 class ResourcesControl {
     constructor(connector) {
         this.connector = connector;
@@ -563,12 +372,260 @@ 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 utils.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__default((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);
+        });
+    });
+}
+
+function isError(error) {
+    if (utils.isObject(error)) {
+        return error.status_code && error.exception && error.title;
+    }
+    return false;
+}
+
+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,
+            'https:': https,
+        };
+        const protocol = url.parse(inputUrl).protocol || 'https:';
+        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: headers || {},
+                    method,
+                };
+                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
+                let form;
+                let uploadedFile = file;
+                if (file) {
+                    const fileMeta = {};
+                    if (isObject(file) &&
+                        'file' in file &&
+                        ('filename' in file || 'name' in file)) {
+                        const { file: file_, name, ...fileMeta_ } = file;
+                        if (name && !fileMeta_.filename) {
+                            fileMeta_.filename = name;
+                        }
+                        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) {
+                    Object.assign(requestOpt.headers, {
+                        'content-type': 'application/json',
+                        'content-length': Buffer.byteLength(body),
+                    });
+                }
+                const req = adapter.request(url, requestOpt, (resp) => {
+                    let data = '';
+                    resp.on('data', (chunk) => {
+                        data += chunk;
+                    });
+                    resp.on('end', () => {
+                        if (data) {
+                            if (responseType === 'blob') {
+                                resolve(data);
+                            }
+                            else {
+                                let json;
+                                try {
+                                    json = JSON.parse(data);
+                                    if (json && json.status_code && json.status_code) {
+                                        reject(json.message);
+                                    }
+                                }
+                                catch (er) {
+                                    reject(er);
+                                }
+                                if (json !== undefined) {
+                                    if (isError(json)) {
+                                        reject('extractError(json)');
+                                    }
+                                    else {
+                                        resolve(json);
+                                    }
+                                }
+                            }
+                        }
+                        reject('no data');
+                    });
+                });
+                if (form) {
+                    form.pipe(req);
+                }
+                req.on('error', (err) => {
+                    reject(err);
+                });
+                if (body) {
+                    req.write(body);
+                }
+                onCancel(() => {
+                    req.abort();
+                });
+                req.end();
+            }
+            else {
+                throw new Error(`Given URL '${url}' is not correct`);
+            }
+        });
+        return request
+            .then((data) => {
+            if (callback) {
+                callback(data);
+            }
+            return data;
+        })
+            .catch((er) => {
+            if (error) {
+                error(er);
+            }
+            else {
+                throw new Error(er);
+            }
+        });
+    };
+}
+
 let ID = 0;
 class NgwConnector$1 {
     constructor(options) {
         this.options = options;
         this.id = ID++;
         this.emitter = new events.EventEmitter();
+        this.client = `NextGIS-NGW-Connector/${pkg.version}`;
         this.routeStr = '/api/component/pyramid/route';
         this.activeRequests = [];
         const exist = findConnector(options);
@@ -620,7 +677,8 @@ class NgwConnector$1 {
         const auth = this.options.auth;
         const makeConnect = () => new CancelablePromise__default((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);
                 })