@elastic/ems-client 8.3.3 → 8.4.1

package/.backportrc.json

@@ -2,25 +2,13 @@
   "upstream": "elastic/ems-client",
   "branches": [
     {
-      "name": "8.3",
+      "name": "8.4",
       "checked": true
     },
-    "8.2",
-    "8.1",
-    "8.0",
-    "7.17",
-    "7.16",
-    "7.16",
-    "7.15",
-    "7.14",
-    "7.12",
-    "7.11",
-    "7.10",
-    "7.9",
-    "7.8",
-    "7.7",
-    "7.6",
-    "7.2"
+    {
+      "name": "7.17",
+      "checked": true
+    }
   ],
   "labels": [
     "backport"

package/.buildkite/build.sh

@@ -0,0 +1,16 @@
+#
+# Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+# or more contributor license agreements. Licensed under the Elastic License;
+# you may not use this file except in compliance with the Elastic License.
+#
+
+set -eu
+
+echo "--- :yarn:  Installing dependencies"
+yarn install
+
+echo "--- :alembic: Running tests"
+yarn test
+
+echo "--- :gear: Building"
+yarn build

package/.buildkite/pipeline.yml

@@ -0,0 +1,8 @@
+agents:
+  image: "docker.elastic.co/ci-agent-images/ems/buildkite-agent-node20:0.1"
+  cpu: "2"
+  memory: "2G"
+
+steps:
+  - label: ":hammer_and_wrench: Test and build"
+    command: ".buildkite/build.sh"

package/.buildkite/pull-requests.json

@@ -0,0 +1,30 @@
+{
+    "jobs": [
+        {
+            "repoOwner": "elastic",
+            "repoName": "ems-client",
+            "enabled": true,
+            "pipeline_slug": "ems-client",
+            "allow_org_users": true,
+            "allowed_repo_permissions": [
+                "admin",
+                "write"
+            ],
+            "allowed_list": [
+                "dependabot"
+            ],
+            "build_on_commit": true,
+            "build_on_comment": true,
+            "trigger_comment_regex": "^(?:(?:buildkite\\W+)?(?:build|test)\\W+(?:this|it))",
+            "always_trigger_comment_regex": "^(?:(?:buildkite\\W+)?(?:build|test)\\W+(?:this|it))",
+            "skip_ci_labels": [
+                "skip-ci"
+            ],
+            "skip_ci_on_only_changed": [
+                "\\.md$",
+                "^.ci/.+\\.yml$",
+                "^\\.buildkite/pull_requests\\.json$"
+            ]
+        }
+    ]
+}

package/.nvmrc

@@ -0,0 +1 @@
+lts/iron

package/CHANGELOG.md

@@ -3,6 +3,18 @@ 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.4.1] - 2023-11-09
+
+- Migration from Jenkins to Buildkite for automatic testing #145 #147 #199
+- Dependencies updates #165 #173 #176 #183 #181 #184 #191 #198 #205
+- Upgrade to Node 20 #208
+
+## [8.4.0] - 2023-01-11
+
+- Default EMS version is 8.4
+- Add types to colorOperationDefaults #123
+- Update dependencies #131 #133 #134 #138
+
 ## [8.3.3] - 2022-05-24
 
 - Make percentage an optional parameter #117

package/CONTRIBUTING.md

@@ -19,3 +19,21 @@ If you have access to make releases, the process is as follows:
 1. Update the latest major branch on upstream with `git push upstream <major_branch>`
 1. Build the targets with `yarn build`
 1. Publish to npm with `npm publish --access public`
+
+
+## Continuous Integration
+
+This repository is tracked by Elastic [Buildkite infrastructure](https://buildkite.com/elastic) to ensure the tests suite passes and a build is successfully generated. The pipeline is located at [`.buildkite/pipeline.yml`](.buildkite/pipeline.yml), and defines the execution of the `test` and `build` scripts from `package.json`.
+
+Builds are **triggered** on the following conditions:
+
+* Any push to `master`
+* Any Pull Request coming from a branch in the `elastic/ems-client` repository
+* It will run automatically on `master` on a weekly basis
+* Comments from Elastic team members on a Pull Request like: `buildkite test this`
+
+Builds will be **skipped** on:
+
+* Pull Requests from forks from users that don't have write/admin permissions on the upstream repository (`elastic/ems-client`) or are not part of the Elastic GitHub organization.
+* Pull Requests with the `skip-ci` label
+* Pull Requests with all files modified matching any of the regular expressions in `.buildkite/pull-requests.json => skip_ci_on_only_changed`

package/catalog-info.yaml

@@ -0,0 +1,68 @@
+---
+# yaml-language-server: $schema=https://json.schemastore.org/catalog-info.json
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: ems-client
+  description: JavaScript library to interact with the Elastic Maps Service
+
+  annotations:
+    backstage.io/source-location: url:https://github.com/elastic/ems-client/
+    github.com/project-slug: elastic/ems-client
+    github.com/team-slug: elastic/ems
+    buildkite.com/project-slug: elastic/ems-client
+
+  tags:
+    - nodejs
+    - ems
+    - kibana
+  
+  links:
+    - title: Releases (npm)
+      url: https://www.npmjs.com/@elastic/ems-client
+    - title: Documentation
+      url: https://github.com/elastic/ems-client/blob/master/README.md
+    - title: EMS License
+      url: https://www.elastic.co/elastic-maps-service-terms
+
+spec:
+  type: library
+  owner: group:ems
+  lifecycle: production
+---
+# yaml-language-server: $schema=https://gist.githubusercontent.com/elasticmachine/988b80dae436cafea07d9a4a460a011d/raw/e57ee3bed7a6f73077a3f55a38e76e40ec87a7cf/rre.schema.json
+apiVersion: backstage.io/v1alpha1
+kind: Resource
+metadata:
+  name: buildkite-pipeline-ems-client
+  description: Buildkite Pipeline for ems-client
+  links:
+    - title: Pipeline
+      url: https://buildkite.com/elastic/ems-client
+
+spec:
+  type: buildkite-pipeline
+  owner: group:ems
+  system: buildkite
+  implementation:
+    apiVersion: buildkite.elastic.dev/v1
+    kind: Pipeline
+    metadata:
+      name: EMS Client
+      description: Pipeline to run the EMS Client tests suite on
+    spec:
+      repository: elastic/ems-client
+      pipeline_file: ".buildkite/pipeline.yml"
+      default_branch: master
+      env:
+        ELASTIC_PR_COMMENTS_ENABLED: 'true'
+      teams: # Who has access to the pipeline.
+        ems: {}
+        everyone:
+          access_level: READ_ONLY
+      provider_settings:
+        publish_commit_status: true
+      schedules:
+        Weekly build on master branch:
+          cronline: "@weekly"
+          message: "Weekly tests and build"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/ems-client",
-  "version": "8.3.3",
+  "version": "8.4.1",
   "description": "JavaScript client library for the Elastic Maps Service",
   "main": "target/node/index.js",
   "browser": "target/web/index.js",
@@ -35,14 +35,14 @@
     }
   },
   "dependencies": {
-    "@types/geojson": "^7946.0.7",
+    "@types/geojson": "^7946.0.10",
     "@types/lru-cache": "^5.1.0",
-    "@types/topojson-client": "^3.0.0",
+    "@types/topojson-client": "^3.1.1",
     "@types/topojson-specification": "^1.0.1",
     "chroma-js": "^2.1.0",
     "lodash": "^4.17.15",
     "lru-cache": "^6.0.0",
-    "semver": "^7.3.2",
+    "semver": "7.5.4",
     "topojson-client": "^3.1.0"
   },
   "devDependencies": {
@@ -70,5 +70,8 @@
     "prettier": "^2.0.5",
     "ts-jest": "^26.2.0",
     "typescript": "4.6.3"
+  },
+  "engines": {
+    "node": ">=18 <=20"
   }
 }

package/src/ems_client.ts

@@ -4,7 +4,6 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
-
 import _ from 'lodash';
 import { TMSService } from './tms_service';
 import { EMSFormatType, FileLayer } from './file_layer';
@@ -16,7 +15,7 @@ import { toAbsoluteUrl } from './utils';
 import { ParsedUrlQueryInput } from 'querystring';
 import LRUCache from 'lru-cache';
 
-const DEFAULT_EMS_VERSION = '8.3';
+const DEFAULT_EMS_VERSION = '8.4';
 
 type URLMeaningfulParts = {
   auth?: string | null;

package/src/tms_service.ts

@@ -124,7 +124,11 @@ export class TMSService extends AbstractEmsService {
   /*
   Suggested default operations for the different EMS styles
   */
-  public static colorOperationDefaults = [
+  public static colorOperationDefaults: {
+    style: string;
+    operation: blendMode;
+    percentage: number;
+  }[] = [
     { style: 'road_map', operation: 'mix', percentage: 0.25 },
     { style: 'road_map_desaturated', operation: 'screen', percentage: 0.25 },
     { style: 'dark_map', operation: 'dodge', percentage: 0.25 },

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 = '8.3';
-
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /*
+                                                                                                                                                                                                                                                                                                                                                                                           * 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 = '8.4';
 /**
  * plugins cannot have upstream dependencies on core/*-kibana.
  * Work-around by copy-pasting modifyUrl routine here.
@@ -32,13 +28,14 @@ const DEFAULT_EMS_VERSION = '8.3';
  * @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;