@elastic/ems-client 8.0.0 → 8.1.0

package/CHANGELOG.md

@@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [8.1.0] - 2021-11-09
+
+### Changed
+ - Default EMS version is 8.1
+ - Export EmsSprite and EmsSpritesheet types
+ - Inherit types from maplibre-gl
+
 ## [8.0.0] - 2021-10-20
 
 ### Changed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/ems-client",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "description": "JavaScript client library for the Elastic Maps Service",
   "main": "target/node/index.js",
   "browser": "target/web/index.js",
@@ -63,6 +63,7 @@
     "eslint-plugin-prettier": "^3.1.3",
     "husky": "^4.2.5",
     "jest": "^26.4.0",
+    "maplibre-gl": "^1.15.2",
     "node-fetch": "^2.6.1",
     "prettier": "^2.0.5",
     "ts-jest": "^26.2.0",

package/src/ems_client.ts

@@ -16,7 +16,7 @@ import { toAbsoluteUrl } from './utils';
 import { ParsedUrlQueryInput } from 'querystring';
 import LRUCache from 'lru-cache';
 
-const DEFAULT_EMS_VERSION = '8.0';
+const DEFAULT_EMS_VERSION = '8.1';
 
 type URLMeaningfulParts = {
   auth?: string | null;

package/src/index.ts

@@ -8,4 +8,4 @@
 export { EMSClient, FileLayerField } from './ems_client';
 export { ORIGIN } from './origin';
 export { FileLayer } from './file_layer';
-export { TMSService } from './tms_service';
+export { TMSService, EmsSprite, EmsSpriteSheet } from './tms_service';

package/src/tms_service.ts

@@ -6,52 +6,31 @@
  */
 
 import _ from 'lodash';
+import { Style as MapLibreStyle, VectorSource as MapLibreVectorSource } from 'maplibre-gl';
 import { EMSClient, EmsTmsFormat, TMSServiceConfig } from './ems_client';
 import { AbstractEmsService } from './ems_service';
 
-type EmsVectorSource = {
-  type: 'vector';
-  url: string;
-  tiles: string[];
-  bounds?: number[];
-  scheme?: 'xyz' | 'tms';
-  minzoom?: number;
-  maxzoom?: number;
-  attribution?: string;
-};
-
-type EmsVectorSources = {
-  [sourceName: string]: EmsVectorSource;
-};
-
-type EmsVectorStyle = {
-  sources: EmsVectorSources;
-  sprite: string;
-  glyphs: string;
-  bearing?: number;
-  center?: number[];
-  layers?: unknown[];
-  metadata?: unknown;
-  name?: string;
-  pitch?: number;
-  light?: unknown;
-  transition?: unknown;
-  version: number;
-  zoom?: number;
-};
-
-type EmsSprite = {
+export type EmsSprite = {
   height: number;
   pixelRatio: number;
   width: number;
   x: number;
   y: number;
+  sdf?: boolean;
 };
 
-type EmsSpriteSheet = {
+export type EmsSpriteSheet = {
   [spriteName: string]: EmsSprite;
 };
 
+type EmsVectorSources = {
+  [sourceName: string]: MapLibreVectorSource;
+};
+
+type EmsVectorStyle = MapLibreStyle & {
+  sources: EmsVectorSources;
+};
+
 type EmsRasterStyle = {
   tilejson: string;
   name: string;
@@ -98,19 +77,20 @@ export class TMSService extends AbstractEmsService {
       const { sources } = vectorJson;
       for (const sourceName of Object.getOwnPropertyNames(sources)) {
         const { url } = sources[sourceName];
-        const sourceUrl = this._proxyPath + this._getAbsoluteUrl(url);
-        const extendedUrl = this._emsClient.extendUrlWithParams(sourceUrl);
-        const sourceJson = await this._emsClient.getManifest<EmsVectorSource>(extendedUrl);
-
-        const extendedTileUrls = sourceJson.tiles.map((tileUrl: string) => {
-          const url = this._proxyPath + this._getAbsoluteUrl(tileUrl);
-          return this._emsClient.extendUrlWithParams(url);
-        });
-        inlinedSources[sourceName] = {
-          ...sourceJson,
-          type: 'vector',
-          tiles: extendedTileUrls,
-        };
+        if (url) {
+          const sourceUrl = this._proxyPath + this._getAbsoluteUrl(url);
+          const extendedUrl = this._emsClient.extendUrlWithParams(sourceUrl);
+          const sourceJson = await this._emsClient.getManifest<MapLibreVectorSource>(extendedUrl);
+          const tiles = sourceJson?.tiles?.map((tileUrl) => {
+            const directUrl = this._proxyPath + this._getAbsoluteUrl(tileUrl);
+            return this._emsClient.extendUrlWithParams(directUrl);
+          });
+          inlinedSources[sourceName] = {
+            ...sourceJson,
+            type: 'vector',
+            tiles,
+          };
+        }
       }
       return {
         ...vectorJson,
@@ -155,11 +135,9 @@ export class TMSService extends AbstractEmsService {
 
   async getUrlTemplateForVector(sourceId: string): Promise<string> {
     const tileJson = await this._getVectorStyleJsonInlined();
-    if (!tileJson) {
-      return '';
-    }
-    if (tileJson.sources[sourceId] && tileJson.sources[sourceId].tiles) {
-      const directUrl = this._proxyPath + this._getAbsoluteUrl(tileJson.sources[sourceId].tiles[0]);
+    const url = tileJson?.sources[sourceId]?.tiles?.pop();
+    if (url) {
+      const directUrl = this._proxyPath + this._getAbsoluteUrl(url);
       return this._emsClient.extendUrlWithParams(directUrl);
     } else {
       return '';
@@ -271,7 +249,7 @@ export class TMSService extends AbstractEmsService {
 
   private async _getSpriteSheetRootPath(): Promise<string> {
     const vectorStyleJson = await this._getVectorStyleJsonRaw();
-    if (vectorStyleJson) {
+    if (vectorStyleJson?.sprite) {
       return this._proxyPath + this._getAbsoluteUrl(vectorStyleJson.sprite);
     } else {
       return '';
@@ -280,7 +258,7 @@ export class TMSService extends AbstractEmsService {
 
   private async _getUrlTemplateForGlyphs(): Promise<string> {
     const vectorStyleJson = await this._getVectorStyleJsonRaw();
-    if (vectorStyleJson) {
+    if (vectorStyleJson?.glyphs) {
       return this._proxyPath + this._getAbsoluteUrl(vectorStyleJson.glyphs);
     } else {
       return '';

package/target/index.d.ts

@@ -1,4 +1,4 @@
 export { EMSClient, FileLayerField } from './ems_client';
 export { ORIGIN } from './origin';
 export { FileLayer } from './file_layer';
-export { TMSService } from './tms_service';
+export { TMSService, EmsSprite, EmsSpriteSheet } from './tms_service';

package/target/node/ems_client.js

@@ -23,7 +23,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-const DEFAULT_EMS_VERSION = '8.0';
+const DEFAULT_EMS_VERSION = '8.1';
 
 /**
  * plugins cannot have upstream dependencies on core/*-kibana.

package/target/node/index.js

@@ -9,6 +9,18 @@ Object.defineProperty(exports, "EMSClient", {
     return _ems_client.EMSClient;
   }
 });
+Object.defineProperty(exports, "EmsSprite", {
+  enumerable: true,
+  get: function () {
+    return _tms_service.EmsSprite;
+  }
+});
+Object.defineProperty(exports, "EmsSpriteSheet", {
+  enumerable: true,
+  get: function () {
+    return _tms_service.EmsSpriteSheet;
+  }
+});
 Object.defineProperty(exports, "FileLayer", {
   enumerable: true,
   get: function () {

package/target/node/tms_service.js

@@ -59,20 +59,24 @@ class TMSService extends _ems_service.AbstractEmsService {
             url
           } = sources[sourceName];
 
-          const sourceUrl = this._proxyPath + this._getAbsoluteUrl(url);
+          if (url) {
+            var _sourceJson$tiles;
 
-          const extendedUrl = this._emsClient.extendUrlWithParams(sourceUrl);
+            const sourceUrl = this._proxyPath + this._getAbsoluteUrl(url);
 
-          const sourceJson = await this._emsClient.getManifest(extendedUrl);
-          const extendedTileUrls = sourceJson.tiles.map(tileUrl => {
-            const url = this._proxyPath + this._getAbsoluteUrl(tileUrl);
+            const extendedUrl = this._emsClient.extendUrlWithParams(sourceUrl);
 
-            return this._emsClient.extendUrlWithParams(url);
-          });
-          inlinedSources[sourceName] = { ...sourceJson,
-            type: 'vector',
-            tiles: extendedTileUrls
-          };
+            const sourceJson = await this._emsClient.getManifest(extendedUrl);
+            const tiles = sourceJson === null || sourceJson === void 0 ? void 0 : (_sourceJson$tiles = sourceJson.tiles) === null || _sourceJson$tiles === void 0 ? void 0 : _sourceJson$tiles.map(tileUrl => {
+              const directUrl = this._proxyPath + this._getAbsoluteUrl(tileUrl);
+
+              return this._emsClient.extendUrlWithParams(directUrl);
+            });
+            inlinedSources[sourceName] = { ...sourceJson,
+              type: 'vector',
+              tiles
+            };
+          }
         }
 
         return { ...vectorJson,
@@ -116,14 +120,13 @@ class TMSService extends _ems_service.AbstractEmsService {
   }
 
   async getUrlTemplateForVector(sourceId) {
-    const tileJson = await this._getVectorStyleJsonInlined();
+    var _tileJson$sources$sou, _tileJson$sources$sou2;
 
-    if (!tileJson) {
-      return '';
-    }
+    const tileJson = await this._getVectorStyleJsonInlined();
+    const url = tileJson === null || tileJson === void 0 ? void 0 : (_tileJson$sources$sou = tileJson.sources[sourceId]) === null || _tileJson$sources$sou === void 0 ? void 0 : (_tileJson$sources$sou2 = _tileJson$sources$sou.tiles) === null || _tileJson$sources$sou2 === void 0 ? void 0 : _tileJson$sources$sou2.pop();
 
-    if (tileJson.sources[sourceId] && tileJson.sources[sourceId].tiles) {
-      const directUrl = this._proxyPath + this._getAbsoluteUrl(tileJson.sources[sourceId].tiles[0]);
+    if (url) {
+      const directUrl = this._proxyPath + this._getAbsoluteUrl(url);
 
       return this._emsClient.extendUrlWithParams(directUrl);
     } else {
@@ -241,7 +244,7 @@ class TMSService extends _ems_service.AbstractEmsService {
   async _getSpriteSheetRootPath() {
     const vectorStyleJson = await this._getVectorStyleJsonRaw();
 
-    if (vectorStyleJson) {
+    if (vectorStyleJson !== null && vectorStyleJson !== void 0 && vectorStyleJson.sprite) {
       return this._proxyPath + this._getAbsoluteUrl(vectorStyleJson.sprite);
     } else {
       return '';
@@ -251,7 +254,7 @@ class TMSService extends _ems_service.AbstractEmsService {
   async _getUrlTemplateForGlyphs() {
     const vectorStyleJson = await this._getVectorStyleJsonRaw();
 
-    if (vectorStyleJson) {
+    if (vectorStyleJson !== null && vectorStyleJson !== void 0 && vectorStyleJson.glyphs) {
       return this._proxyPath + this._getAbsoluteUrl(vectorStyleJson.glyphs);
     } else {
       return '';

package/target/tms_service.d.ts

@@ -1,43 +1,23 @@
+import { Style as MapLibreStyle, VectorSource as MapLibreVectorSource } from 'maplibre-gl';
 import { EMSClient, TMSServiceConfig } from './ems_client';
 import { AbstractEmsService } from './ems_service';
-declare type EmsVectorSource = {
-    type: 'vector';
-    url: string;
-    tiles: string[];
-    bounds?: number[];
-    scheme?: 'xyz' | 'tms';
-    minzoom?: number;
-    maxzoom?: number;
-    attribution?: string;
-};
-declare type EmsVectorSources = {
-    [sourceName: string]: EmsVectorSource;
-};
-declare type EmsVectorStyle = {
-    sources: EmsVectorSources;
-    sprite: string;
-    glyphs: string;
-    bearing?: number;
-    center?: number[];
-    layers?: unknown[];
-    metadata?: unknown;
-    name?: string;
-    pitch?: number;
-    light?: unknown;
-    transition?: unknown;
-    version: number;
-    zoom?: number;
-};
-declare type EmsSprite = {
+export declare type EmsSprite = {
     height: number;
     pixelRatio: number;
     width: number;
     x: number;
     y: number;
+    sdf?: boolean;
 };
-declare type EmsSpriteSheet = {
+export declare type EmsSpriteSheet = {
     [spriteName: string]: EmsSprite;
 };
+declare type EmsVectorSources = {
+    [sourceName: string]: MapLibreVectorSource;
+};
+declare type EmsVectorStyle = MapLibreStyle & {
+    sources: EmsVectorSources;
+};
 declare type EmsRasterStyle = {
     tilejson: string;
     name: string;

package/target/web/ems_client.js

@@ -23,7 +23,7 @@ import semver from 'semver';
 import { format as formatUrl, parse as parseUrl } from 'url';
 import { toAbsoluteUrl } from './utils';
 import LRUCache from 'lru-cache';
-var DEFAULT_EMS_VERSION = '8.0';
+var DEFAULT_EMS_VERSION = '8.1';
 
 /**
  * plugins cannot have upstream dependencies on core/*-kibana.

package/target/web/index.js

@@ -7,4 +7,4 @@
 export { EMSClient, FileLayerField } from './ems_client';
 export { ORIGIN } from './origin';
 export { FileLayer } from './file_layer';
-export { TMSService } from './tms_service';
+export { TMSService, EmsSprite, EmsSpriteSheet } from './tms_service';

package/target/web/tms_service.js

@@ -118,7 +118,7 @@ export var TMSService = /*#__PURE__*/function (_AbstractEmsService) {
     }))));
 
     _defineProperty(_assertThisInitialized(_this), "_getVectorStyleJsonInlined", _.once( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee3() {
-      var vectorJson, inlinedSources, sources, _iterator, _step, _sourceName, url, sourceUrl, extendedUrl, sourceJson, extendedTileUrls;
+      var vectorJson, inlinedSources, sources, _iterator, _step, _sourceName, url, _sourceJson$tiles, sourceUrl, extendedUrl, sourceJson, tiles;
 
       return regeneratorRuntime.wrap(function _callee3$(_context3) {
         while (1) {
@@ -131,7 +131,7 @@ export var TMSService = /*#__PURE__*/function (_AbstractEmsService) {
               vectorJson = _context3.sent;
 
               if (!vectorJson) {
-                _context3.next = 43;
+                _context3.next = 44;
                 break;
               }
 
@@ -144,64 +144,70 @@ export var TMSService = /*#__PURE__*/function (_AbstractEmsService) {
 
             case 9:
               if ((_step = _iterator.n()).done) {
-                _context3.next = 21;
+                _context3.next = 22;
                 break;
               }
 
               _sourceName = _step.value;
               url = sources[_sourceName].url;
+
+              if (!url) {
+                _context3.next = 20;
+                break;
+              }
+
               sourceUrl = _this._proxyPath + _this._getAbsoluteUrl(url);
               extendedUrl = _this._emsClient.extendUrlWithParams(sourceUrl);
-              _context3.next = 16;
+              _context3.next = 17;
               return _this._emsClient.getManifest(extendedUrl);
 
-            case 16:
+            case 17:
               sourceJson = _context3.sent;
-              extendedTileUrls = sourceJson.tiles.map(function (tileUrl) {
-                var url = _this._proxyPath + _this._getAbsoluteUrl(tileUrl);
+              tiles = sourceJson === null || sourceJson === void 0 ? void 0 : (_sourceJson$tiles = sourceJson.tiles) === null || _sourceJson$tiles === void 0 ? void 0 : _sourceJson$tiles.map(function (tileUrl) {
+                var directUrl = _this._proxyPath + _this._getAbsoluteUrl(tileUrl);
 
-                return _this._emsClient.extendUrlWithParams(url);
+                return _this._emsClient.extendUrlWithParams(directUrl);
               });
               inlinedSources[_sourceName] = _objectSpread(_objectSpread({}, sourceJson), {}, {
                 type: 'vector',
-                tiles: extendedTileUrls
+                tiles: tiles
               });
 
-            case 19:
+            case 20:
               _context3.next = 9;
               break;
 
-            case 21:
-              _context3.next = 26;
+            case 22:
+              _context3.next = 27;
               break;
 
-            case 23:
-              _context3.prev = 23;
+            case 24:
+              _context3.prev = 24;
               _context3.t0 = _context3["catch"](7);
 
               _iterator.e(_context3.t0);
 
-            case 26:
-              _context3.prev = 26;
+            case 27:
+              _context3.prev = 27;
 
               _iterator.f();
 
-              return _context3.finish(26);
+              return _context3.finish(27);
 
-            case 29:
+            case 30:
               _context3.t1 = _objectSpread;
               _context3.t2 = _objectSpread({}, vectorJson);
               _context3.t3 = {};
               _context3.t4 = inlinedSources;
-              _context3.next = 35;
+              _context3.next = 36;
               return _this._getSpriteSheetRootPath();
 
-            case 35:
+            case 36:
               _context3.t5 = _context3.sent;
-              _context3.next = 38;
+              _context3.next = 39;
               return _this._getUrlTemplateForGlyphs();
 
-            case 38:
+            case 39:
               _context3.t6 = _context3.sent;
               _context3.t7 = {
                 sources: _context3.t4,
@@ -210,15 +216,15 @@ export var TMSService = /*#__PURE__*/function (_AbstractEmsService) {
               };
               return _context3.abrupt("return", (0, _context3.t1)(_context3.t2, _context3.t3, _context3.t7));
 
-            case 43:
+            case 44:
               return _context3.abrupt("return");
 
-            case 44:
+            case 45:
             case "end":
               return _context3.stop();
           }
         }
-      }, _callee3, null, [[7, 23, 26, 29]]);
+      }, _callee3, null, [[7, 24, 27, 30]]);
     }))));
 
     _this._config = config;
@@ -315,7 +321,9 @@ export var TMSService = /*#__PURE__*/function (_AbstractEmsService) {
     key: "getUrlTemplateForVector",
     value: function () {
       var _getUrlTemplateForVector = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee6(sourceId) {
-        var tileJson, directUrl;
+        var _tileJson$sources$sou, _tileJson$sources$sou2;
+
+        var tileJson, url, directUrl;
         return regeneratorRuntime.wrap(function _callee6$(_context6) {
           while (1) {
             switch (_context6.prev = _context6.next) {
@@ -325,27 +333,20 @@ export var TMSService = /*#__PURE__*/function (_AbstractEmsService) {
 
               case 2:
                 tileJson = _context6.sent;
+                url = tileJson === null || tileJson === void 0 ? void 0 : (_tileJson$sources$sou = tileJson.sources[sourceId]) === null || _tileJson$sources$sou === void 0 ? void 0 : (_tileJson$sources$sou2 = _tileJson$sources$sou.tiles) === null || _tileJson$sources$sou2 === void 0 ? void 0 : _tileJson$sources$sou2.pop();
 
-                if (tileJson) {
-                  _context6.next = 5;
+                if (!url) {
+                  _context6.next = 9;
                   break;
                 }
 
-                return _context6.abrupt("return", '');
-
-              case 5:
-                if (!(tileJson.sources[sourceId] && tileJson.sources[sourceId].tiles)) {
-                  _context6.next = 10;
-                  break;
-                }
-
-                directUrl = this._proxyPath + this._getAbsoluteUrl(tileJson.sources[sourceId].tiles[0]);
+                directUrl = this._proxyPath + this._getAbsoluteUrl(url);
                 return _context6.abrupt("return", this._emsClient.extendUrlWithParams(directUrl));
 
-              case 10:
+              case 9:
                 return _context6.abrupt("return", '');
 
-              case 11:
+              case 10:
               case "end":
                 return _context6.stop();
             }
@@ -703,7 +704,7 @@ export var TMSService = /*#__PURE__*/function (_AbstractEmsService) {
               case 2:
                 vectorStyleJson = _context14.sent;
 
-                if (!vectorStyleJson) {
+                if (!(vectorStyleJson !== null && vectorStyleJson !== void 0 && vectorStyleJson.sprite)) {
                   _context14.next = 7;
                   break;
                 }
@@ -742,7 +743,7 @@ export var TMSService = /*#__PURE__*/function (_AbstractEmsService) {
               case 2:
                 vectorStyleJson = _context15.sent;
 
-                if (!vectorStyleJson) {
+                if (!(vectorStyleJson !== null && vectorStyleJson !== void 0 && vectorStyleJson.glyphs)) {
                   _context15.next = 7;
                   break;
                 }

package/test/ems_client.test.ts

@@ -431,8 +431,8 @@ it('should retrieve vectorstylesheet with all sources inlined)', async () => {
 
   expect(styleSheet!.layers!.length).toBe(111);
   expect(styleSheet!.sprite).toBe('https://tiles.foobar/styles/osm-bright/sprite');
-  expect(styleSheet!.sources!.openmaptiles!.tiles.length).toBe(1);
-  expect(styleSheet!.sources!.openmaptiles!.tiles[0]).toBe(
+  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=tester&my_app_version=7.x.x'
   );
   expect(styleSheet!.sources!.openmaptiles!.type).toBe('vector');