@elastic/ems-client 7.15.0 → 8.1.0

package/CHANGELOG.md

@@ -3,6 +3,31 @@ 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
+ - Default EMS version is 8.0
+ - Remove unused API descriptors
+
+## [7.16.0] - 2021-10-13
+
+### Changed
+ - Default EMS version is 7.16
+ - Update dependencies using `yarn upgrade`
+ - Better error handling for HTTP responses
+
+## [7.15.1] - 2021-09-01
+
+### Changed
+- Unpinned `semver` dependency [#77](https://github.com/elastic/ems-client/pull/77)
+
 ## [7.15.0] - 2021-08-12
 
 ### Changed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/ems-client",
-  "version": "7.15.0",
+  "version": "8.1.0",
   "description": "JavaScript client library for the Elastic Maps Service",
   "main": "target/node/index.js",
   "browser": "target/web/index.js",
@@ -41,7 +41,7 @@
     "@types/topojson-specification": "^1.0.1",
     "lodash": "^4.17.15",
     "lru-cache": "^6.0.0",
-    "semver": "7.3.2",
+    "semver": "^7.3.2",
     "topojson-client": "^3.1.0"
   },
   "devDependencies": {
@@ -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

@@ -9,13 +9,14 @@ import _ from 'lodash';
 import { TMSService } from './tms_service';
 import { EMSFormatType, FileLayer } from './file_layer';
 import { FeatureCollection } from 'geojson';
+import { Response } from 'node-fetch';
 import semver from 'semver';
 import { format as formatUrl, parse as parseUrl, UrlObject } from 'url';
 import { toAbsoluteUrl } from './utils';
 import { ParsedUrlQueryInput } from 'querystring';
 import LRUCache from 'lru-cache';
 
-const DEFAULT_EMS_VERSION = '7.15';
+const DEFAULT_EMS_VERSION = '8.1';
 
 type URLMeaningfulParts = {
   auth?: string | null;
@@ -278,16 +279,17 @@ export class EMSClient {
   async getManifest<T>(endpointUrl: string): Promise<T> {
     try {
       const url = extendUrl(endpointUrl, { query: this._queryParams });
-      const result = await this._fetchWithTimeout(url);
-      return result ? await result.json() : null;
-    } catch (e) {
-      if (!e) {
-        e = new Error('Unknown error');
+      const response = await this._fetchWithTimeout(url);
+      if (!response.ok) {
+        throw new Error(response.statusText);
       }
-      if (!(e instanceof Error)) {
-        e = new Error(e.data || `status ${e.statusText || e.status}`);
+      return response ? await response.json() : null;
+    } catch (e) {
+      if (e instanceof Error) {
+        throw e;
+      } else {
+        throw new Error('Unknown error');
       }
-      throw new Error(`Unable to retrieve data from ${endpointUrl}: ${e.message}`);
     }
   }
 
@@ -390,14 +392,14 @@ export class EMSClient {
     }
   }
 
-  private _fetchWithTimeout(url: string): Promise<Body> {
-    return new Promise<Body>((resolve, reject) => {
+  private _fetchWithTimeout(url: string): Promise<Response> {
+    return new Promise<Response>((resolve, reject) => {
       const timer = setTimeout(
         () => reject(new Error(`Request to ${url} timed out`)),
         this.EMS_LOAD_TIMEOUT
       );
       this._fetchFunction(url).then(
-        (response: Body) => {
+        (response: Response) => {
           clearTimeout(timer);
           resolve(response);
         },

package/src/file_layer.ts

@@ -41,7 +41,6 @@ export class FileLayer extends AbstractEmsService {
 
     const format = this.getDefaultFormatType();
     const fetchUrl = this.getDefaultFormatUrl();
-    // let fetchedJson;
     let geojson;
     const fetchedJson = await this._emsClient.getManifest(fetchUrl);
     if (fetchedJson) {

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 = '7.15';
+const DEFAULT_EMS_VERSION = '8.1';
 
 /**
  * plugins cannot have upstream dependencies on core/*-kibana.
@@ -176,18 +176,19 @@ class EMSClient {
       const url = extendUrl(endpointUrl, {
         query: this._queryParams
       });
-      const result = await this._fetchWithTimeout(url);
-      return result ? await result.json() : null;
-    } catch (e) {
-      if (!e) {
-        e = new Error('Unknown error');
-      }
+      const response = await this._fetchWithTimeout(url);
 
-      if (!(e instanceof Error)) {
-        e = new Error(e.data || `status ${e.statusText || e.status}`);
+      if (!response.ok) {
+        throw new Error(response.statusText);
       }
 
-      throw new Error(`Unable to retrieve data from ${endpointUrl}: ${e.message}`);
+      return response ? await response.json() : null;
+    } catch (e) {
+      if (e instanceof Error) {
+        throw e;
+      } else {
+        throw new Error('Unknown error');
+      }
     }
   }
   /**

package/target/node/file_layer.js

@@ -44,8 +44,7 @@ class FileLayer extends _ems_service.AbstractEmsService {
     }
 
     const format = this.getDefaultFormatType();
-    const fetchUrl = this.getDefaultFormatUrl(); // let fetchedJson;
-
+    const fetchUrl = this.getDefaultFormatUrl();
     let geojson;
     const fetchedJson = await this._emsClient.getManifest(fetchUrl);
 

package/target/node/index.js

@@ -9,16 +9,16 @@ Object.defineProperty(exports, "EMSClient", {
     return _ems_client.EMSClient;
   }
 });
-Object.defineProperty(exports, "FileLayerField", {
+Object.defineProperty(exports, "EmsSprite", {
   enumerable: true,
   get: function () {
-    return _ems_client.FileLayerField;
+    return _tms_service.EmsSprite;
   }
 });
-Object.defineProperty(exports, "ORIGIN", {
+Object.defineProperty(exports, "EmsSpriteSheet", {
   enumerable: true,
   get: function () {
-    return _origin.ORIGIN;
+    return _tms_service.EmsSpriteSheet;
   }
 });
 Object.defineProperty(exports, "FileLayer", {
@@ -27,6 +27,18 @@ Object.defineProperty(exports, "FileLayer", {
     return _file_layer.FileLayer;
   }
 });
+Object.defineProperty(exports, "FileLayerField", {
+  enumerable: true,
+  get: function () {
+    return _ems_client.FileLayerField;
+  }
+});
+Object.defineProperty(exports, "ORIGIN", {
+  enumerable: true,
+  get: function () {
+    return _origin.ORIGIN;
+  }
+});
 Object.defineProperty(exports, "TMSService", {
   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 = '7.15';
+var DEFAULT_EMS_VERSION = '8.1';
 
 /**
  * plugins cannot have upstream dependencies on core/*-kibana.
@@ -187,7 +187,7 @@ export var EMSClient = /*#__PURE__*/function () {
     key: "getManifest",
     value: function () {
       var _getManifest = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee(endpointUrl) {
-        var url, result;
+        var url, response;
         return regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) {
             switch (_context.prev = _context.next) {
@@ -200,47 +200,55 @@ export var EMSClient = /*#__PURE__*/function () {
                 return this._fetchWithTimeout(url);
 
               case 4:
-                result = _context.sent;
+                response = _context.sent;
 
-                if (!result) {
-                  _context.next = 11;
+                if (response.ok) {
+                  _context.next = 7;
                   break;
                 }
 
-                _context.next = 8;
-                return result.json();
+                throw new Error(response.statusText);
 
-              case 8:
+              case 7:
+                if (!response) {
+                  _context.next = 13;
+                  break;
+                }
+
+                _context.next = 10;
+                return response.json();
+
+              case 10:
                 _context.t0 = _context.sent;
-                _context.next = 12;
+                _context.next = 14;
                 break;
 
-              case 11:
+              case 13:
                 _context.t0 = null;
 
-              case 12:
+              case 14:
                 return _context.abrupt("return", _context.t0);
 
-              case 15:
-                _context.prev = 15;
+              case 17:
+                _context.prev = 17;
                 _context.t1 = _context["catch"](0);
 
-                if (!_context.t1) {
-                  _context.t1 = new Error('Unknown error');
-                }
-
                 if (!(_context.t1 instanceof Error)) {
-                  _context.t1 = new Error(_context.t1.data || "status ".concat(_context.t1.statusText || _context.t1.status));
+                  _context.next = 23;
+                  break;
                 }
 
-                throw new Error("Unable to retrieve data from ".concat(endpointUrl, ": ").concat(_context.t1.message));
+                throw _context.t1;
+
+              case 23:
+                throw new Error('Unknown error');
 
-              case 20:
+              case 24:
               case "end":
                 return _context.stop();
             }
           }
-        }, _callee, this, [[0, 15]]);
+        }, _callee, this, [[0, 17]]);
       }));
 
       function getManifest(_x) {

package/target/web/file_layer.js

@@ -85,8 +85,7 @@ export var FileLayer = /*#__PURE__*/function (_AbstractEmsService) {
 
               case 3:
                 format = this.getDefaultFormatType();
-                fetchUrl = this.getDefaultFormatUrl(); // let fetchedJson;
-
+                fetchUrl = this.getDefaultFormatUrl();
                 _context.next = 7;
                 return this._emsClient.getManifest(fetchUrl);
 

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';