@elastic/ems-client 8.4.0 → 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,12 @@ 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

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.4.0",
+  "version": "8.4.1",
   "description": "JavaScript client library for the Elastic Maps Service",
   "main": "target/node/index.js",
   "browser": "target/web/index.js",
@@ -42,7 +42,7 @@
     "chroma-js": "^2.1.0",
     "lodash": "^4.17.15",
     "lru-cache": "^6.0.0",
-    "semver": "^7.3.8",
+    "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/target/node/ems_client.js

@@ -14,7 +14,12 @@ var _lruCache = _interopRequireDefault(require("lru-cache"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 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); }
+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.
@@ -72,10 +77,6 @@ const unescapeTemplateVars = url => {
 //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);
@@ -90,6 +91,9 @@ class EMSClient {
     _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);

package/target/node/ems_service.js

@@ -7,12 +7,20 @@ exports.AbstractEmsService = void 0;
 var _utils = require("./utils");
 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); }
+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.
+                                                                                                                                                                                                                                                                                                                                                                                           */
 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;
@@ -42,9 +50,5 @@ class AbstractEmsService {
     });
     return attributions.join('|');
   }
-
-  /**
-   * Checks if url is absolute. If not, prepend the basePath.
-   */
 }
 exports.AbstractEmsService = AbstractEmsService;

package/target/node/file_layer.js

@@ -7,18 +7,22 @@ exports.FileLayer = exports.EMSFormatType = void 0;
 var _url = _interopRequireDefault(require("url"));
 var _ems_service = require("./ems_service");
 var topojson = _interopRequireWildcard(require("topojson-client"));
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 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); }
-let EMSFormatType;
-exports.EMSFormatType = EMSFormatType;
-(function (EMSFormatType) {
+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.
+                                                                                                                                                                                                                                                                                                                                                                                           */
+let EMSFormatType = exports.EMSFormatType = /*#__PURE__*/function (EMSFormatType) {
   EMSFormatType["geojson"] = "geojson";
   EMSFormatType["topojson"] = "topojson";
-})(EMSFormatType || (exports.EMSFormatType = EMSFormatType = {}));
+  return EMSFormatType;
+}({});
 class FileLayer extends _ems_service.AbstractEmsService {
   constructor(config, emsClient, proxyPath) {
     super(config, emsClient, proxyPath);

package/target/node/tms_service.js

@@ -10,19 +10,13 @@ var _utils = require("./utils");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 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); }
+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.
+                                                                                                                                                                                                                                                                                                                                                                                           */
 class TMSService extends _ems_service.AbstractEmsService {
-  /*
-  List of supported languages with labels and OMT codes extracted
-  from https://openmaptiles.org/languages
-   Keys are values for i18.locale from Kibana settings
-  and OMT codes for the rest. 
-  */
-
-  /*
-  Suggested default operations for the different EMS styles
-  */
-
   constructor(config, emsClient, proxyPath) {
     super(config, emsClient, proxyPath);
     _defineProperty(this, "_config", void 0);
@@ -299,6 +293,12 @@ class TMSService extends _ems_service.AbstractEmsService {
   }
 }
 exports.TMSService = TMSService;
+/*
+List of supported languages with labels and OMT codes extracted
+from https://openmaptiles.org/languages
+ Keys are values for i18.locale from Kibana settings
+and OMT codes for the rest. 
+*/
 _defineProperty(TMSService, "SupportedLanguages", [{
   key: 'ar',
   omt: 'ar'
@@ -477,6 +477,9 @@ _defineProperty(TMSService, "SupportedLanguages", [{
   key: 'zh-cn',
   omt: 'zh'
 }]);
+/*
+Suggested default operations for the different EMS styles
+*/
 _defineProperty(TMSService, "colorOperationDefaults", [{
   style: 'road_map',
   operation: 'mix',

package/target/node/utils.js

@@ -39,6 +39,11 @@ function toAbsoluteUrl(host, path) {
 Type with the possible ways to define a color in maplibre
 */
 
+/*
+A selection of the different maplibre-gl-js properties that refer to a color.
+Taken from maplibre https://github.com/maplibre/maplibre-gl-js/blob/main/src/style-spec/types.g.ts
+*/
+
 /*
 Function to transform a maplibre color definition by a given function.
 */