@elastic/ems-client 7.16.0 → 7.17.2

package/target/file_layer.d.ts

@@ -5,7 +5,7 @@ export declare enum EMSFormatType {
     geojson = "geojson",
     topojson = "topojson"
 }
-export declare type EMSFormatTypeStrings = keyof typeof EMSFormatType;
+export type EMSFormatTypeStrings = keyof typeof EMSFormatType;
 export declare class FileLayer extends AbstractEmsService {
     protected readonly _config: FileLayerConfig;
     constructor(config: FileLayerConfig, emsClient: EMSClient, proxyPath: string);

package/target/file_layer.js

@@ -0,0 +1,176 @@
+"use strict";
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileLayer = exports.EMSFormatType = void 0;
+const url_1 = __importDefault(require("url"));
+const ems_service_1 = require("./ems_service");
+const topojson = __importStar(require("topojson-client"));
+var EMSFormatType;
+(function (EMSFormatType) {
+    EMSFormatType["geojson"] = "geojson";
+    EMSFormatType["topojson"] = "topojson";
+})(EMSFormatType || (exports.EMSFormatType = EMSFormatType = {}));
+class FileLayer extends ems_service_1.AbstractEmsService {
+    constructor(config, emsClient, proxyPath) {
+        super(config, emsClient, proxyPath);
+        this._config = config;
+    }
+    getGeoJson() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const cachedGeoJson = this._emsClient.getCachedGeoJson(this.getId());
+            if (cachedGeoJson) {
+                return cachedGeoJson;
+            }
+            const format = this.getDefaultFormatType();
+            const fetchUrl = this.getDefaultFormatUrl();
+            let geojson;
+            const fetchedJson = yield this._emsClient.getManifest(fetchUrl);
+            if (fetchedJson) {
+                if (format === 'geojson') {
+                    geojson = fetchedJson;
+                }
+                else if (format === 'topojson') {
+                    const meta = this.getDefaultFormatMeta();
+                    const featureCollectionPath = (_a = meta === null || meta === void 0 ? void 0 : meta.feature_collection_path) !== null && _a !== void 0 ? _a : 'data';
+                    // @ts-expect-error see https://github.com/DefinitelyTyped/DefinitelyTyped/pull/52156
+                    geojson = topojson.feature(fetchedJson, featureCollectionPath);
+                }
+                else {
+                    return;
+                }
+                this._emsClient.cacheGeoJson(this.getId(), geojson);
+                return geojson;
+            }
+            return;
+        });
+    }
+    getFields() {
+        return this._config.fields;
+    }
+    getFieldsInLanguage() {
+        return this.getFields().map((field) => {
+            return {
+                type: field.type,
+                name: field.id,
+                description: this._emsClient.getValueInLanguage(field.label),
+            };
+        });
+    }
+    getDisplayName() {
+        const layerName = this._emsClient.getValueInLanguage(this._config.layer_name);
+        return layerName ? layerName : '';
+    }
+    getId() {
+        return this._config.layer_id;
+    }
+    hasId(id) {
+        const matchesLegacyId = this._config.legacy_ids.indexOf(id) >= 0;
+        return this._config.layer_id === id || matchesLegacyId;
+    }
+    getEMSHotLink() {
+        const landingPageString = this._emsClient.getLandingPageUrl();
+        const urlObject = url_1.default.parse(landingPageString, true);
+        urlObject.hash = `file/${this.getId()}`;
+        urlObject.query = Object.assign(Object.assign({}, urlObject.query), { locale: this._emsClient.getLocale() });
+        return url_1.default.format(urlObject);
+    }
+    getDefaultFormatType() {
+        const format = this._getDefaultFormat();
+        return format.type;
+    }
+    getFormatOfType(type) {
+        const format = this._getFormatOfType(type);
+        return format.type;
+    }
+    getDefaultFormatMeta() {
+        const format = this._getDefaultFormat();
+        return this._getFormatMeta(format);
+    }
+    getFormatOfTypeMeta(type) {
+        const format = this._getFormatOfType(type);
+        return this._getFormatMeta(format);
+    }
+    getDefaultFormatUrl() {
+        const format = this._getDefaultFormat();
+        return this._getFormatUrl(format);
+    }
+    getFormatOfTypeUrl(type) {
+        const format = this._getFormatOfType(type);
+        return this._getFormatUrl(format);
+    }
+    getCreatedAt() {
+        return this._config.created_at;
+    }
+    getApiUrl() {
+        return this._emsClient.getFileApiUrl();
+    }
+    _getFormatUrl(format) {
+        const url = this._proxyPath + this._getAbsoluteUrl(format.url);
+        return this._emsClient.extendUrlWithParams(url);
+    }
+    _getFormatMeta(format) {
+        if ('meta' in format) {
+            return format.meta;
+        }
+        else {
+            return;
+        }
+    }
+    _getDefaultFormat() {
+        const defaultFormat = this._config.formats.find((format) => {
+            return format.legacy_default;
+        });
+        if (defaultFormat) {
+            return defaultFormat;
+        }
+        return this._config.formats[0];
+    }
+    _getFormatOfType(type) {
+        const requestedFormat = this._config.formats.find((format) => {
+            return format.type === type;
+        });
+        return requestedFormat || this._getDefaultFormat();
+    }
+}
+exports.FileLayer = FileLayer;

package/target/index.js

@@ -0,0 +1,16 @@
+"use strict";
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TMSService = exports.FileLayer = exports.LATEST_API_URL_PATH = exports.EMSClient = void 0;
+var ems_client_1 = require("./ems_client");
+Object.defineProperty(exports, "EMSClient", { enumerable: true, get: function () { return ems_client_1.EMSClient; } });
+Object.defineProperty(exports, "LATEST_API_URL_PATH", { enumerable: true, get: function () { return ems_client_1.LATEST_API_URL_PATH; } });
+var file_layer_1 = require("./file_layer");
+Object.defineProperty(exports, "FileLayer", { enumerable: true, get: function () { return file_layer_1.FileLayer; } });
+var tms_service_1 = require("./tms_service");
+Object.defineProperty(exports, "TMSService", { enumerable: true, get: function () { return tms_service_1.TMSService; } });

package/target/node/ems_client.js

@@ -4,27 +4,23 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.EMSClient = void 0;
-
 var _lodash = _interopRequireDefault(require("lodash"));
-
 var _tms_service = require("./tms_service");
-
 var _file_layer = require("./file_layer");
-
 var _semver = _interopRequireDefault(require("semver"));
-
 var _url = require("url");
-
 var _utils = require("./utils");
-
 var _lruCache = _interopRequireDefault(require("lru-cache"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-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.16';
-
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+const DEFAULT_EMS_VERSION = '7.17';
 /**
  * plugins cannot have upstream dependencies on core/*-kibana.
  * Work-around by copy-pasting modifyUrl routine here.
@@ -32,13 +28,14 @@ const DEFAULT_EMS_VERSION = '7.16';
  * @param block
  */
 function modifyUrlLocal(url, block) {
-  const parsed = (0, _url.parse)(url, true); // copy over the most specific version of each
+  const parsed = (0, _url.parse)(url, true);
+
+  // copy over the most specific version of each
   // property. By default, the parsed url includes
   // several conflicting properties (like path and
   // pathname + search, or search and query) and keeping
   // track of which property is actually used when they
   // are formatted is harder than necessary
-
   const meaningfulParts = {
     protocol: parsed.protocol,
     slashes: parsed.slashes,
@@ -48,10 +45,12 @@ function modifyUrlLocal(url, block) {
     pathname: parsed.pathname,
     query: parsed.query || {},
     hash: parsed.hash
-  }; // the block modifies the meaningfulParts object, or returns a new one
+  };
 
-  const modifiedParts = block(meaningfulParts) || meaningfulParts; // format the modified/replaced meaningfulParts back into a url
+  // the block modifies the meaningfulParts object, or returns a new one
+  const modifiedParts = block(meaningfulParts) || meaningfulParts;
 
+  // format the modified/replaced meaningfulParts back into a url
   return (0, _url.format)({
     protocol: modifiedParts.protocol,
     slashes: modifiedParts.slashes,
@@ -63,65 +62,43 @@ function modifyUrlLocal(url, block) {
     hash: modifiedParts.hash
   });
 }
-
 const extendUrl = (url, props) => modifyUrlLocal(url, parsed => _lodash.default.merge(parsed, props));
+
 /**
  *  Unescape a url template that was escaped by encodeURI() so leaflet
  *  will be able to correctly locate the variables in the template
  *  @param  {String} url
  *  @return {String}
  */
-
-
 const unescapeTemplateVars = url => {
   const ENCODED_TEMPLATE_VARS_RE = /%7B(\w+?)%7D/g;
   return url.replace(ENCODED_TEMPLATE_VARS_RE, (total, varName) => `{${varName}}`);
 };
-
 //this is not the default locale from Kibana, but the default locale supported by the Elastic Maps Service
 const DEFAULT_LANGUAGE = 'en';
-
 class EMSClient {
-  /**
-   * these methods are assigned outside the constructor
-   */
   constructor(config) {
     _defineProperty(this, "EMS_LOAD_TIMEOUT", 32000);
-
     _defineProperty(this, "_queryParams", void 0);
-
     _defineProperty(this, "_appVersion", void 0);
-
     _defineProperty(this, "_fetchFunction", void 0);
-
     _defineProperty(this, "_sanitizer", void 0);
-
     _defineProperty(this, "_manifestServiceUrl", void 0);
-
     _defineProperty(this, "_fileApiUrl", void 0);
-
     _defineProperty(this, "_tileApiUrl", void 0);
-
     _defineProperty(this, "_emsVersion", void 0);
-
     _defineProperty(this, "_emsLandingPageUrl", void 0);
-
     _defineProperty(this, "_language", void 0);
-
     _defineProperty(this, "_proxyPath", void 0);
-
     _defineProperty(this, "_cache", void 0);
-
+    /**
+     * these methods are assigned outside the constructor
+     */
     _defineProperty(this, "_getMainCatalog", void 0);
-
     _defineProperty(this, "_getDefaultTMSCatalog", void 0);
-
     _defineProperty(this, "_getDefaultFileCatalog", void 0);
-
     _defineProperty(this, "_loadTMSServices", void 0);
-
     _defineProperty(this, "_loadFileLayers", void 0);
-
     // Remove kbnVersion in 8.0
     if ('kbnVersion' in config) {
       console.warn('The "kbnVersion" parameter for ems-client is deprecated. Please use "appVersion" instead.');
@@ -129,7 +106,6 @@ class EMSClient {
     } else {
       this._appVersion = config.appVersion;
     }
-
     this._queryParams = {
       elastic_tile_service_tos: 'agree',
       my_app_name: config.appName || 'kibana',
@@ -147,41 +123,33 @@ class EMSClient {
     this._cache = new _lruCache.default({
       max: config.cacheSize || 10
     });
-
     this._invalidateSettings();
   }
-
   getDefaultLocale() {
     return DEFAULT_LANGUAGE;
   }
-
   getLocale() {
     return this._language;
   }
-
   getValueInLanguage(i18nObject) {
     if (!i18nObject) {
       return '';
     }
-
     return i18nObject[this._language] ? i18nObject[this._language] : i18nObject[DEFAULT_LANGUAGE];
   }
+
   /**
    * this internal method is overridden by the tests to simulate custom manifest.
    */
-
-
   async getManifest(endpointUrl) {
     try {
       const url = extendUrl(endpointUrl, {
         query: this._queryParams
       });
       const response = await this._fetchWithTimeout(url);
-
       if (!response.ok) {
         throw new Error(response.statusText);
       }
-
       return response ? await response.json() : null;
     } catch (e) {
       if (e instanceof Error) {
@@ -191,116 +159,91 @@ class EMSClient {
       }
     }
   }
+
   /**
    * Add optional query-parameters to all requests
    *
    * @param additionalQueryParams
    */
-
-
   addQueryParams(additionalQueryParams) {
     for (const key in additionalQueryParams) {
       if (additionalQueryParams.hasOwnProperty(key)) {
         if (additionalQueryParams[key] !== this._queryParams[key]) {
           //changes detected.
           this._queryParams = _lodash.default.assign({}, this._queryParams, additionalQueryParams);
-
           this._invalidateSettings();
-
           break;
         }
       }
     }
   }
-
   async getMainManifest() {
     return await this._getMainCatalog();
   }
-
   async getDefaultFileManifest() {
     return await this._getDefaultFileCatalog();
   }
-
   async getDefaultTMSManifest() {
     return await this._getDefaultTMSCatalog();
   }
-
   async getFileLayers() {
     return await this._loadFileLayers();
   }
-
   async getTMSServices() {
     return await this._loadTMSServices();
   }
-
   cacheGeoJson(layerId, geoJson) {
     this._cache.set(layerId, geoJson);
-
     return;
   }
-
   getCachedGeoJson(layerId) {
     return this._cache.get(layerId);
   }
-
   getTileApiUrl() {
     return this._tileApiUrl;
   }
-
   getFileApiUrl() {
     return this._fileApiUrl;
   }
-
   getLandingPageUrl() {
     return this._emsLandingPageUrl;
   }
-
   sanitizeHtml(html) {
     return this._sanitizer(html);
   }
-
   extendUrlWithParams(url) {
     return unescapeTemplateVars(extendUrl(url, {
       query: this._queryParams
     }));
   }
-
   async findFileLayerById(id) {
     const fileLayers = await this.getFileLayers();
-
     for (let i = 0; i < fileLayers.length; i++) {
       if (fileLayers[i].hasId(id)) {
         return fileLayers[i];
       }
     }
   }
-
   async findTMSServiceById(id) {
     const tmsServices = await this.getTMSServices();
-
     for (let i = 0; i < tmsServices.length; i++) {
       if (tmsServices[i].hasId(id)) {
         return tmsServices[i];
       }
     }
   }
-
   _getEmsVersion(version) {
     const userVersion = _semver.default.valid(_semver.default.coerce(version));
-
     const semverVersion = userVersion ? userVersion : _semver.default.coerce(DEFAULT_EMS_VERSION);
-
     if (semverVersion) {
       return `v${_semver.default.major(semverVersion)}.${_semver.default.minor(semverVersion)}`;
     } else {
       throw new Error(`Invalid version: ${version}`);
     }
   }
-
   _fetchWithTimeout(url) {
     return new Promise((resolve, reject) => {
       const timer = setTimeout(() => reject(new Error(`Request to ${url} timed out`)), this.EMS_LOAD_TIMEOUT);
-
       this._fetchFunction(url).then(response => {
         clearTimeout(timer);
         resolve(response);
@@ -310,15 +253,12 @@ class EMSClient {
       });
     });
   }
-
   async _getManifestWithParams(url) {
     const extendedUrl = this.extendUrlWithParams(url);
     return await this.getManifest(extendedUrl);
   }
-
   _invalidateSettings() {
     this._cache.reset();
-
     this._getMainCatalog = _lodash.default.once(async () => {
       // Preserve manifestServiceUrl parameter for backwards compatibility with EMS v7.2
       if (this._manifestServiceUrl) {
@@ -327,21 +267,18 @@ class EMSClient {
         return await this._getManifestWithParams(this._manifestServiceUrl);
       } else {
         const services = [];
-
         if (this._tileApiUrl) {
           services.push({
             type: 'tms',
             manifest: (0, _utils.toAbsoluteUrl)(this._tileApiUrl, `${this._emsVersion}/manifest`)
           });
         }
-
         if (this._fileApiUrl) {
           services.push({
             type: 'file',
             manifest: (0, _utils.toAbsoluteUrl)(this._fileApiUrl, `${this._emsVersion}/manifest`)
           });
         }
-
         return {
           services: services
         };
@@ -350,30 +287,27 @@ class EMSClient {
     this._getDefaultTMSCatalog = _lodash.default.once(async () => {
       const catalogue = await this._getMainCatalog();
       const firstService = catalogue.services.find(service => service.type === 'tms');
-
       if (!firstService) {
         return {
           services: []
         };
       }
-
       const url = this._proxyPath + firstService.manifest;
       return await this.getManifest(url);
     });
     this._getDefaultFileCatalog = _lodash.default.once(async () => {
       const catalogue = await this._getMainCatalog();
       const firstService = catalogue.services.find(service => service.type === 'file');
-
       if (!firstService) {
         return {
           layers: []
         };
       }
-
       const url = this._proxyPath + firstService.manifest;
       return await this.getManifest(url);
-    }); //Cache the actual instances of TMSService as these in turn cache sub-manifests for the style-files
+    });
 
+    //Cache the actual instances of TMSService as these in turn cache sub-manifests for the style-files
     this._loadTMSServices = _lodash.default.once(async () => {
       const tmsManifest = await this._getDefaultTMSCatalog();
       return tmsManifest.services.map(serviceConfig => new _tms_service.TMSService(serviceConfig, this, this._proxyPath));
@@ -383,7 +317,5 @@ class EMSClient {
       return fileManifest.layers.map(layerConfig => new _file_layer.FileLayer(layerConfig, this, this._proxyPath));
     });
   }
-
 }
-
 exports.EMSClient = EMSClient;

package/target/node/ems_service.js

@@ -4,21 +4,24 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.AbstractEmsService = void 0;
-
 var _origin = require("./origin");
-
 var _utils = require("./utils");
-
-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; }
-
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
 class AbstractEmsService {
   constructor(config, emsClient, proxyPath) {
     _defineProperty(this, "_emsClient", void 0);
-
     _defineProperty(this, "_config", void 0);
-
     _defineProperty(this, "_proxyPath", void 0);
-
+    /**
+     * Checks if url is absolute. If not, prepend the basePath.
+     */
     _defineProperty(this, "_getAbsoluteUrl", url => {
       if (/^https?:\/\//.test(url)) {
         return url;
@@ -26,45 +29,30 @@ class AbstractEmsService {
         return (0, _utils.toAbsoluteUrl)(this.getApiUrl(), url);
       }
     });
-
     this._config = config;
     this._emsClient = emsClient;
     this._proxyPath = proxyPath;
   }
-
   getAttributions() {
     return this._config.attribution.map(attribution => {
       const url = this._emsClient.getValueInLanguage(attribution.url);
-
       const label = this._emsClient.getValueInLanguage(attribution.label);
-
       return {
         url: url,
         label: label
       };
     });
   }
-
   getMarkdownAttribution() {
     const attributions = this._config.attribution.map(attribution => {
       const url = this._emsClient.getValueInLanguage(attribution.url);
-
       const label = this._emsClient.getValueInLanguage(attribution.label);
-
       return `[${label}](${url})`;
     });
-
     return attributions.join('|');
   }
-
   getOrigin() {
     return _origin.ORIGIN.EMS;
   }
-  /**
-   * Checks if url is absolute. If not, prepend the basePath.
-   */
-
-
 }
-
 exports.AbstractEmsService = AbstractEmsService;