@elastic/ems-client - npm Package Compare versions

Comparing version 7.6.0 to 7.7.0

CHANGELOG.md

@@ -7,2 +7,14 @@ # Changelog
 
+## [7.7.0] - 2020-03-11
+
+### Changed
+- The default Elastic Maps Service version is now `7.7`.
+
+### Added
+- The `appName` parameter can now be configured to specify the client application. Previously, the client application was hard-coded to `kibana`.
+- The `appVersion` configurable parameter replaces the `kbnVersion` parameter for specifying the client application version, e.g. `7.7.0`.
+
+### Deprecated
+- The `kbnVersion` parameter has been deprecated and the `appVersion` parameter should be used instead.
+
 ## [7.6.0] - 2020-01-13
@@ -9,0 +21,0 @@

package.json

 {
   "name": "@elastic/ems-client",
-  "version": "7.6.0",
+  "version": "7.7.0",
   "description": "JavaScript client library for the Elastic Maps Service",
@@ -5,0 +5,0 @@ "main": "target/node/index.js",

README.md

@@ -26,3 +26,4 @@ # @elastic/ems-client
 const emsClient = new EMSClient({
-  kbnVersion: '7.6.0',
+  appVersion: '7.6.0',
+  appName: 'kibana',
   tileApiUrl: 'https://tiles.maps.elastic.co',
@@ -29,0 +30,0 @@ fileApiUrl: 'https://vector.maps.elastic.co',

src/ems_client.js

@@ -27,3 +27,3 @@ /*
 
-const DEFAULT_EMS_VERSION = '7.6';
+const DEFAULT_EMS_VERSION = '7.7';
 
@@ -97,2 +97,4 @@ const extendUrl = (url, props) => modifyUrlLocal(url, parsed => _.merge(parsed, props));
     kbnVersion,
+    appVersion,
+    appName,
     manifestServiceUrl,
@@ -109,7 +111,12 @@ tileApiUrl,
 
+    // Remove kbnVersion in 8.0
+    if (kbnVersion) {
+      console.warn('The "kbnVersion" parameter for ems-client is deprecated. Please use "appVersion" instead.');
+      appVersion = appVersion || kbnVersion;
+    }
 
     this._queryParams = {
       elastic_tile_service_tos: 'agree',
-      my_app_name: 'kibana',
-      my_app_version: kbnVersion,
+      my_app_name: appName || 'kibana',
+      my_app_version: appVersion,
     };
@@ -116,0 +123,0 @@

target/node/ems_client.js

@@ -24,3 +24,3 @@ "use strict";
 
-const DEFAULT_EMS_VERSION = '7.6';
+const DEFAULT_EMS_VERSION = '7.7';
 
@@ -87,2 +87,4 @@ const extendUrl = (url, props) => modifyUrlLocal(url, parsed => _lodash.default.merge(parsed, props));
     kbnVersion,
+    appVersion,
+    appName,
     manifestServiceUrl,
@@ -100,6 +102,12 @@ tileApiUrl,
 
+    // Remove kbnVersion in 8.0
+    if (kbnVersion) {
+      console.warn('The "kbnVersion" parameter for ems-client is deprecated. Please use "appVersion" instead.');
+      appVersion = appVersion || kbnVersion;
+    }
+
     this._queryParams = {
       elastic_tile_service_tos: 'agree',
-      my_app_name: 'kibana',
-      my_app_version: kbnVersion
+      my_app_name: appName || 'kibana',
+      my_app_version: appVersion
     };
@@ -106,0 +114,0 @@ this._sanitizer = htmlSanitizer ? htmlSanitizer : x => x;

target/web/ems_client.js

@@ -37,3 +37,3 @@ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 import { format as formatUrl, parse as parseUrl } from 'url';
-var DEFAULT_EMS_VERSION = '7.6';
+var DEFAULT_EMS_VERSION = '7.7';
 
@@ -107,2 +107,4 @@ var extendUrl = function extendUrl(url, props) {
     var kbnVersion = _ref.kbnVersion,
+        appVersion = _ref.appVersion,
+        appName = _ref.appName,
         manifestServiceUrl = _ref.manifestServiceUrl,
@@ -122,6 +124,12 @@ tileApiUrl = _ref.tileApiUrl,
 
+    // Remove kbnVersion in 8.0
+    if (kbnVersion) {
+      console.warn('The "kbnVersion" parameter for ems-client is deprecated. Please use "appVersion" instead.');
+      appVersion = appVersion || kbnVersion;
+    }
+
     this._queryParams = {
       elastic_tile_service_tos: 'agree',
-      my_app_name: 'kibana',
-      my_app_version: kbnVersion
+      my_app_name: appName || 'kibana',
+      my_app_version: appVersion
     };
@@ -128,0 +136,0 @@ this._sanitizer = htmlSanitizer ? htmlSanitizer : function (x) {

target/web/file_layer.js

 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(source, true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(source).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
@@ -5,0 +5,0 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

target/web/tms_service.js

 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(source, true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(source).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
 
@@ -5,0 +5,0 @@ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }

test/ems_client_util.js

@@ -42,3 +42,4 @@ /*
     language: 'en',
-    kbnVersion: '7.x.x',
+    appVersion: '7.x.x',
+    appName: 'tester',
     htmlSanitizer: x => x,
@@ -45,0 +46,0 @@ landingPageUrl: 'https://landing.foobar',

test/ems_client.test.js

@@ -39,3 +39,3 @@ /*
     const tileService = tiles[0];
-    expect(await tileService.getUrlTemplate()).toBe('https://tiles.foobar/raster/styles/osm-bright/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=7.x.x');
+    expect(await tileService.getUrlTemplate()).toBe('https://tiles.foobar/raster/styles/osm-bright/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=7.x.x');
 
@@ -61,3 +61,3 @@ expect (tileService.getHTMLAttribution()).toBe('<a rel="noreferrer noopener" href="https://www.openstreetmap.org/copyright">OpenStreetMap contributors</a> | <a rel="noreferrer noopener" href="https://openmaptiles.org">OpenMapTiles</a> | <a rel="noreferrer noopener" href="https://www.maptiler.com">MapTiler</a> | <a rel="noreferrer noopener" href="https://www.elastic.co/elastic-maps-service">Elastic Maps Service</a>');
     const tileService = tiles[0];
-    expect(await tileService.getUrlTemplate()).toBe('https://tiles.foobar/raster/styles/osm-bright/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=7.x.x');
+    expect(await tileService.getUrlTemplate()).toBe('https://tiles.foobar/raster/styles/osm-bright/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=7.x.x');
 
@@ -81,3 +81,3 @@ expect (tileService.getHTMLAttribution()).toBe('<a rel="noreferrer noopener" href="https://www.openstreetmap.org/copyright">OpenStreetMap contributors</a> | <a rel="noreferrer noopener" href="https://openmaptiles.org">OpenMapTiles</a> | <a rel="noreferrer noopener" href="https://www.maptiler.com">MapTiler</a> | <a rel="noreferrer noopener" href="https://www.elastic.co/elastic-maps-service">Elastic Maps Service</a>');
     const urlBefore = await tilesBefore[0].getUrlTemplate();
-    expect(urlBefore).toBe('https://tiles.foobar/raster/styles/osm-bright/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=7.x.x');
+    expect(urlBefore).toBe('https://tiles.foobar/raster/styles/osm-bright/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=7.x.x');
 
@@ -89,3 +89,3 @@ emsClient.addQueryParams({
     let url = await tiles[0].getUrlTemplate();
-    expect(url).toBe('https://tiles.foobar/raster/styles/osm-bright/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=7.x.x&foo=bar');
+    expect(url).toBe('https://tiles.foobar/raster/styles/osm-bright/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=7.x.x&foo=bar');
 
@@ -98,3 +98,3 @@ emsClient.addQueryParams({
     url = await tiles[0].getUrlTemplate();
-    expect(url).toBe('https://tiles.foobar/raster/styles/osm-bright/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=7.x.x&foo=schmoo&bar=foo');
+    expect(url).toBe('https://tiles.foobar/raster/styles/osm-bright/{z}/{x}/{y}.png?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=7.x.x&foo=schmoo&bar=foo');
 
@@ -167,3 +167,3 @@
     expect(layer.getDefaultFormatType()).toBe('geojson');
-    expect(layer.getDefaultFormatUrl()).toBe('https://files.foobar/files/world_countries_v1.geo.json?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=7.x.x&foo=bar');
+    expect(layer.getDefaultFormatUrl()).toBe('https://files.foobar/files/world_countries_v1.geo.json?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=7.x.x&foo=bar');
 
@@ -246,3 +246,3 @@
     const urlTemplate = await tmsServices[0].getUrlTemplate();
-    expect(urlTemplate).toBe('http://proxy.com/foobar/tiles/raster/osm_bright/{x}/{y}/{z}.jpg?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=7.x.x');
+    expect(urlTemplate).toBe('http://proxy.com/foobar/tiles/raster/osm_bright/{x}/{y}/{z}.jpg?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=7.x.x');
 
@@ -252,3 +252,3 @@ const fileLayers = await emsClient.getFileLayers();
     const fileLayer = fileLayers[0];
-    expect(fileLayer.getDefaultFormatUrl()).toBe('http://proxy.com/foobar/vector/files/world_countries.json?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=7.x.x');
+    expect(fileLayer.getDefaultFormatUrl()).toBe('http://proxy.com/foobar/vector/files/world_countries.json?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=7.x.x');
 
@@ -274,3 +274,3 @@ });
     expect(styleSheet.sources.openmaptiles.tiles.length).toBe(1);
-    expect(styleSheet.sources.openmaptiles.tiles[0]).toBe('https://tiles.foobar/data/v3/{z}/{x}/{y}.pbf?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=7.x.x');
+    expect(styleSheet.sources.openmaptiles.tiles[0]).toBe('https://tiles.foobar/data/v3/{z}/{x}/{y}.pbf?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=7.x.x');
 
@@ -300,3 +300,3 @@ });
     expect(styleSheet.sources.openmaptiles.tiles.length).toBe(1);
-    expect(styleSheet.sources.openmaptiles.tiles[0]).toBe('http://proxy.com/foobar/tiles/data/v3/{z}/{x}/{y}.pbf?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=7.x.x');
+    expect(styleSheet.sources.openmaptiles.tiles[0]).toBe('http://proxy.com/foobar/tiles/data/v3/{z}/{x}/{y}.pbf?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=7.x.x');
 
@@ -303,0 +303,0 @@ });

test/integration.test.js

@@ -5,3 +5,3 @@ import { EMSClient } from '../src';
 //   const emsClient = new EMSClient({
-//     kbnVersion: 'v7.6.0',
+//     appVersion: 'v7.6.0',
 //     tileApiUrl: 'https://tiles.maps.elastic.co',
@@ -30,3 +30,3 @@ //     fileApiUrl: 'http://localhost:8000',
 
-//     expect(layer.getDefaultFormatUrl()).toBe('http://localhost:8000/files/world_countries_v1.geo.json?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=v7.6.0');
+//     expect(layer.getDefaultFormatUrl()).toBe('http://localhost:8000/files/world_countries_v1.geo.json?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=v7.6.0');
 //   });
@@ -38,3 +38,3 @@ // });
 //   const emsClient = new EMSClient({
-//     kbnVersion: 'v7.2.0',
+//     appVersion: 'v7.2.0',
 //     manifestServiceUrl: 'https://catalogue.maps.elastic.co/v7.2/manifest',
@@ -62,3 +62,3 @@ //     language: 'en',
 
-//     expect(layer.getDefaultFormatUrl()).toBe('https://vector.maps.elastic.co/files/world_countries_v1.geo.json?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=v7.2.0');
+//     expect(layer.getDefaultFormatUrl()).toBe('https://vector.maps.elastic.co/files/world_countries_v1.geo.json?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=v7.2.0');
 
@@ -71,3 +71,3 @@ //   });
 //   const emsClient = new EMSClient({
-//     kbnVersion: 'v7.2.0',
+//     appVersion: 'v7.2.0',
 //     language: 'en',
@@ -85,3 +85,3 @@ //   });
 //   const emsClient = new EMSClient({
-//     kbnVersion: 'v7.2.0',
+//     appVersion: 'v7.2.0',
 //     manifestServiceUrl: 'https://catalogue.maps.elastic.co/v7.2/manifest',
@@ -110,3 +110,3 @@ //     fileApiUrl: 'https://localhost:8000',
 
-//     expect(layer.getDefaultFormatUrl()).toBe('https://vector.maps.elastic.co/files/world_countries_v1.geo.json?elastic_tile_service_tos=agree&my_app_name=kibana&my_app_version=v7.2.0');
+//     expect(layer.getDefaultFormatUrl()).toBe('https://vector.maps.elastic.co/files/world_countries_v1.geo.json?elastic_tile_service_tos=agree&my_app_name=tester&my_app_version=v7.2.0');
 
@@ -118,3 +118,3 @@ //   });
 //   const emsClient = new EMSClient({
-//     kbnVersion: 'v7.2.2',
+//     appVersion: 'v7.2.2',
 //     manifestServiceUrl: 'https://catalogue.maps.elastic.co/v7.2/manifest',
@@ -148,3 +148,3 @@ //     language: 'en',
   const emsClient = new EMSClient({
-    kbnVersion: 'v7.6.0',
+    appVersion: 'v7.6.0',
     tileApiUrl: 'https://tiles.maps.elastic.co',
@@ -181,3 +181,3 @@ fileApiUrl: 'https://vector-staging.maps.elastic.co',
 //   const emsClient = new EMSClient({
-//     kbnVersion: 'v7.6.0',
+//     appVersion: 'v7.6.0',
 //     tileApiUrl: '/api/maps/ems/tiles',
@@ -184,0 +184,0 @@ //     fileApiUrl: '/api/maps/ems/files',

No alert changes

Improved metrics

Total package byte prevSize

605869

increased by0.22%

Lines of code

21351

increased by0.1%

Number of lines in readme file

45

increased by2.27%

No dependency changes