@elastic/ems-client 8.3.3 → 8.5.0

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,6 @@
+agents:
+  image: "docker.elastic.co/ci-agent-images/ems/buildkite-agent-node18:0.1"
+
+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/hydrogen

package/CHANGELOG.md

@@ -3,6 +3,19 @@ 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.5.0] - TBD
+
+- Migration from Jenkins to Buildkite for automatic testing #145 #147
+- Detached the releases of EMS Client from the services consumed #185
+- Updated the client to support date based versions #185
+- Update dependencies #159 #165 #173 #176 #181 #184
+
+## [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.5.0",
   "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": ">=16 <=18"
   }
 }

package/src/ems_client.ts

@@ -4,19 +4,24 @@
  * 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';
 import { FeatureCollection } from 'geojson';
 import { Response } from 'node-fetch';
-import semver from 'semver';
+
+import semverCoerce from 'semver/functions/coerce';
+import semverValid from 'semver/functions/valid';
+import semverMajor from 'semver/functions/major';
+import semverMinor from 'semver/functions/minor';
+
 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 = '8.3';
+const REST_API_REGEX = /\d{4}-\d{2}-\d{2}/;
+export const LATEST_API_URL_PATH = 'latest';
 
 type URLMeaningfulParts = {
   auth?: string | null;
@@ -206,7 +211,6 @@ export class EMSClient {
   private readonly _appVersion: string;
   private readonly _fetchFunction: Function;
   private readonly _sanitizer: Function;
-  private readonly _manifestServiceUrl?: string;
   private readonly _fileApiUrl: string;
   private readonly _tileApiUrl: string;
   private readonly _emsVersion: string;
@@ -214,6 +218,7 @@ export class EMSClient {
   private readonly _language: string;
   private readonly _proxyPath: string;
   private readonly _cache: LRUCache<string, FeatureCollection>;
+  private readonly _isRestApi: boolean = false;
 
   /**
    * these methods are assigned outside the constructor
@@ -242,10 +247,12 @@ export class EMSClient {
     };
 
     this._sanitizer = config.htmlSanitizer ? config.htmlSanitizer : (x: string) => x;
-    this._manifestServiceUrl = config.manifestServiceUrl;
     this._tileApiUrl = config.tileApiUrl;
     this._fileApiUrl = config.fileApiUrl;
+
     this._emsVersion = this._getEmsVersion(config.emsVersion);
+    this._isRestApi = this._emsVersion == config.emsVersion;
+
     this._emsLandingPageUrl = config.landingPageUrl || '';
     this._language = config.language || DEFAULT_LANGUAGE;
 
@@ -383,10 +390,13 @@ export class EMSClient {
   }
 
   private _getEmsVersion(version: string | undefined): string {
-    const userVersion = semver.valid(semver.coerce(version));
-    const semverVersion = userVersion ? userVersion : semver.coerce(DEFAULT_EMS_VERSION);
+    if (version?.match(REST_API_REGEX)) {
+      return version;
+    }
+
+    const semverVersion = semverValid(semverCoerce(version));
     if (semverVersion) {
-      return `v${semver.major(semverVersion)}.${semver.minor(semverVersion)}`;
+      return `v${semverMajor(semverVersion)}.${semverMinor(semverVersion)}`;
     } else {
       throw new Error(`Invalid version: ${version}`);
     }
@@ -411,35 +421,25 @@ export class EMSClient {
     });
   }
 
-  private async _getManifestWithParams<T>(url: string): Promise<T> {
-    const extendedUrl = this.extendUrlWithParams(url);
-    return await this.getManifest(extendedUrl);
-  }
-
   private _invalidateSettings(): void {
     this._cache.reset();
     this._getMainCatalog = _.once(async (): Promise<EmsCatalogManifest> => {
-      // Preserve manifestServiceUrl parameter for backwards compatibility with EMS v7.2
-      if (this._manifestServiceUrl) {
-        console.warn(`The "manifestServiceUrl" parameter is deprecated in v7.6.0.
-        Consider using "tileApiUrl" and "fileApiUrl" instead.`);
-        return await this._getManifestWithParams(this._manifestServiceUrl);
-      } else {
-        const services = [];
-        if (this._tileApiUrl) {
-          services.push({
-            type: 'tms',
-            manifest: toAbsoluteUrl(this._tileApiUrl, `${this._emsVersion}/manifest`),
-          });
-        }
-        if (this._fileApiUrl) {
-          services.push({
-            type: 'file',
-            manifest: toAbsoluteUrl(this._fileApiUrl, `${this._emsVersion}/manifest`),
-          });
-        }
-        return { services: services };
+      const services = [];
+      if (this._tileApiUrl) {
+        const version = this._isRestApi ? LATEST_API_URL_PATH : this._emsVersion;
+        services.push({
+          type: 'tms',
+          manifest: toAbsoluteUrl(this._tileApiUrl, `${version}/manifest`),
+        });
+      }
+      if (this._fileApiUrl) {
+        const version = this._isRestApi ? LATEST_API_URL_PATH : this._emsVersion;
+        services.push({
+          type: 'file',
+          manifest: toAbsoluteUrl(this._fileApiUrl, `${version}/manifest`),
+        });
       }
+      return { services: services };
     });
 
     this._getDefaultTMSCatalog = _.once(async (): Promise<EmsTmsCatalog> => {

package/src/index.ts

@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-export { EMSClient, FileLayerField } from './ems_client';
+export { EMSClient, FileLayerField, LATEST_API_URL_PATH } from './ems_client';
 export { FileLayer } from './file_layer';
 export { TMSService, EmsSprite, EmsSpriteSheet } from './tms_service';
 export { blendMode } from './utils';

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/ems_client.d.ts

@@ -1,6 +1,7 @@
 import { TMSService } from './tms_service';
 import { EMSFormatType, FileLayer } from './file_layer';
 import { FeatureCollection } from 'geojson';
+export declare const LATEST_API_URL_PATH = "latest";
 declare type LocalizedStrings = {
     [key: string]: string;
 };
@@ -95,7 +96,6 @@ export declare class EMSClient {
     private readonly _appVersion;
     private readonly _fetchFunction;
     private readonly _sanitizer;
-    private readonly _manifestServiceUrl?;
     private readonly _fileApiUrl;
     private readonly _tileApiUrl;
     private readonly _emsVersion;
@@ -103,6 +103,7 @@ export declare class EMSClient {
     private readonly _language;
     private readonly _proxyPath;
     private readonly _cache;
+    private readonly _isRestApi;
     /**
      * these methods are assigned outside the constructor
      */
@@ -145,7 +146,6 @@ export declare class EMSClient {
     findTMSServiceById(id: string): Promise<TMSService | undefined>;
     private _getEmsVersion;
     private _fetchWithTimeout;
-    private _getManifestWithParams;
     private _invalidateSettings;
 }
 export {};

package/target/index.d.ts

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