@elastic/ems-client 8.5.0 → 8.5.1

package/docs/openapi/ems_tile_service/bundled.json

@@ -0,0 +1,307 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "Elastic Maps Tile Service",
+    "description": "OpenAPI schema for the Elastic Maps Tile Service manifest endpoint",
+    "version": "0.1",
+    "contact": {
+      "name": "Presentation Team"
+    },
+    "license": {
+      "name": "Elastic License 2.0",
+      "url": "https://www.elastic.co/licensing/elastic-license"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://tiles.maps.elastic.co",
+      "description": "Production"
+    },
+    {
+      "url": "https://tiles.maps.elastic.dev",
+      "description": "Staging"
+    }
+  ],
+  "security": [],
+  "tags": [
+    {
+      "name": "ems",
+      "description": "Elastic Maps Service."
+    }
+  ],
+  "paths": {
+    "/latest/manifest": {
+      "get": {
+        "operationId": "getTileManifest",
+        "tags": [
+          "ems"
+        ],
+        "summary": "Manifest of the EMS Tile Service",
+        "description": "Describes the basemap styles available",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "Manifest is returned",
+            "content": {
+              "application/json": {
+                "example": {
+                  "version": "2023-10-31",
+                  "services": [
+                    {
+                      "id": "road_map",
+                      "name": {
+                        "en": "Classic"
+                      },
+                      "attribution": [
+                        {
+                          "label": {
+                            "en": "OpenStreetMap contributors"
+                          },
+                          "url": {
+                            "en": "https://www.openstreetmap.org/copyright"
+                          }
+                        },
+                        {
+                          "label": {
+                            "en": "OpenMapTiles"
+                          },
+                          "url": {
+                            "en": "https://openmaptiles.org"
+                          }
+                        },
+                        {
+                          "label": {
+                            "en": "Elastic Maps Service"
+                          },
+                          "url": {
+                            "en": "https://www.elastic.co/elastic-maps-service"
+                          }
+                        }
+                      ],
+                      "formats": [
+                        {
+                          "locale": "en",
+                          "format": "vector",
+                          "url": "/2023-10-31/styles/osm-bright/style.json"
+                        },
+                        {
+                          "locale": "en",
+                          "format": "raster",
+                          "url": "/2023-10-31/styles/osm-bright.json"
+                        }
+                      ]
+                    },
+                    {
+                      "id": "road_map_desaturated",
+                      "name": {
+                        "en": "Light"
+                      },
+                      "attribution": [
+                        {
+                          "label": {
+                            "en": "OpenStreetMap contributors"
+                          },
+                          "url": {
+                            "en": "https://www.openstreetmap.org/copyright"
+                          }
+                        },
+                        {
+                          "label": {
+                            "en": "OpenMapTiles"
+                          },
+                          "url": {
+                            "en": "https://openmaptiles.org"
+                          }
+                        },
+                        {
+                          "label": {
+                            "en": "Elastic Maps Service"
+                          },
+                          "url": {
+                            "en": "https://www.elastic.co/elastic-maps-service"
+                          }
+                        }
+                      ],
+                      "formats": [
+                        {
+                          "locale": "en",
+                          "format": "vector",
+                          "url": "/2023-10-31/styles/osm-bright-desaturated/style.json"
+                        },
+                        {
+                          "locale": "en",
+                          "format": "raster",
+                          "url": "/2023-10-31/styles/osm-bright-desaturated.json"
+                        }
+                      ]
+                    },
+                    {
+                      "id": "dark_map",
+                      "name": {
+                        "en": "Dark"
+                      },
+                      "attribution": [
+                        {
+                          "label": {
+                            "en": "OpenStreetMap contributors"
+                          },
+                          "url": {
+                            "en": "https://www.openstreetmap.org/copyright"
+                          }
+                        },
+                        {
+                          "label": {
+                            "en": "OpenMapTiles"
+                          },
+                          "url": {
+                            "en": "https://openmaptiles.org"
+                          }
+                        },
+                        {
+                          "label": {
+                            "en": "Elastic Maps Service"
+                          },
+                          "url": {
+                            "en": "https://www.elastic.co/elastic-maps-service"
+                          }
+                        }
+                      ],
+                      "formats": [
+                        {
+                          "locale": "en",
+                          "format": "vector",
+                          "url": "/2023-10-31/styles/dark-matter/style.json"
+                        },
+                        {
+                          "locale": "en",
+                          "format": "raster",
+                          "url": "/2023-10-31/styles/dark-matter.json"
+                        }
+                      ]
+                    }
+                  ]
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "version": {
+                      "type": "string",
+                      "description": "Version of the API as a date in YYYY-MM-DD format"
+                    },
+                    "services": {
+                      "type": "array",
+                      "minItems": 1,
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "id",
+                          "name",
+                          "attribution",
+                          "formats"
+                        ],
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Identifier of the style"
+                          },
+                          "name": {
+                            "type": "object",
+                            "description": "A human readable label for the style",
+                            "required": [
+                              "en"
+                            ],
+                            "properties": {
+                              "en": {
+                                "type": "string"
+                              }
+                            }
+                          },
+                          "attribution": {
+                            "$ref": "#/components/schemas/attribution"
+                          },
+                          "formats": {
+                            "type": "array",
+                            "description": "The different formats for this tile service",
+                            "items": {
+                              "type": "object",
+                              "required": [
+                                "locale",
+                                "format",
+                                "url"
+                              ],
+                              "properties": {
+                                "locale": {
+                                  "type": "string"
+                                },
+                                "format": {
+                                  "type": "string",
+                                  "description": "The service can offer vector or raster tiles",
+                                  "enum": [
+                                    "raster",
+                                    "vector"
+                                  ]
+                                },
+                                "url": {
+                                  "type": "string",
+                                  "description": "Relative path to the MapBox style specification"
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Manifest is not found",
+            "content": {
+              "text/html": {
+                "example": "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n<meta charset=\"utf-8\">\n<title>Error</title>\n</head>\n<body>\n<pre>Cannot GET /snthstn</pre>\n</body>\n</html>\n",
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "attribution": {
+        "type": "array",
+        "description": "The attribution of this data",
+        "minItems": 1,
+        "items": {
+          "type": "object",
+          "properties": {
+            "label": {
+              "type": "object",
+              "properties": {
+                "en": {
+                  "type": "string",
+                  "description": "English attribution label"
+                }
+              }
+            },
+            "url": {
+              "type": "object",
+              "properties": {
+                "en": {
+                  "type": "string",
+                  "description": "Attribution details URL",
+                  "format": "URL"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/docs/openapi/ems_tile_service/bundled.yaml

@@ -0,0 +1,195 @@
+openapi: 3.0.1
+info:
+  title: Elastic Maps Tile Service
+  description: OpenAPI schema for the Elastic Maps Tile Service manifest endpoint
+  version: '0.1'
+  contact:
+    name: Presentation Team
+  license:
+    name: Elastic License 2.0
+    url: https://www.elastic.co/licensing/elastic-license
+servers:
+  - url: https://tiles.maps.elastic.co
+    description: Production
+  - url: https://tiles.maps.elastic.dev
+    description: Staging
+security: []
+tags:
+  - name: ems
+    description: Elastic Maps Service.
+paths:
+  /latest/manifest:
+    get:
+      operationId: getTileManifest
+      tags:
+        - ems
+      summary: Manifest of the EMS Tile Service
+      description: Describes the basemap styles available
+      parameters: []
+      responses:
+        '200':
+          description: Manifest is returned
+          content:
+            application/json:
+              example:
+                version: '2023-10-31'
+                services:
+                  - id: road_map
+                    name:
+                      en: Classic
+                    attribution:
+                      - label:
+                          en: OpenStreetMap contributors
+                        url:
+                          en: https://www.openstreetmap.org/copyright
+                      - label:
+                          en: OpenMapTiles
+                        url:
+                          en: https://openmaptiles.org
+                      - label:
+                          en: Elastic Maps Service
+                        url:
+                          en: https://www.elastic.co/elastic-maps-service
+                    formats:
+                      - locale: en
+                        format: vector
+                        url: /2023-10-31/styles/osm-bright/style.json
+                      - locale: en
+                        format: raster
+                        url: /2023-10-31/styles/osm-bright.json
+                  - id: road_map_desaturated
+                    name:
+                      en: Light
+                    attribution:
+                      - label:
+                          en: OpenStreetMap contributors
+                        url:
+                          en: https://www.openstreetmap.org/copyright
+                      - label:
+                          en: OpenMapTiles
+                        url:
+                          en: https://openmaptiles.org
+                      - label:
+                          en: Elastic Maps Service
+                        url:
+                          en: https://www.elastic.co/elastic-maps-service
+                    formats:
+                      - locale: en
+                        format: vector
+                        url: /2023-10-31/styles/osm-bright-desaturated/style.json
+                      - locale: en
+                        format: raster
+                        url: /2023-10-31/styles/osm-bright-desaturated.json
+                  - id: dark_map
+                    name:
+                      en: Dark
+                    attribution:
+                      - label:
+                          en: OpenStreetMap contributors
+                        url:
+                          en: https://www.openstreetmap.org/copyright
+                      - label:
+                          en: OpenMapTiles
+                        url:
+                          en: https://openmaptiles.org
+                      - label:
+                          en: Elastic Maps Service
+                        url:
+                          en: https://www.elastic.co/elastic-maps-service
+                    formats:
+                      - locale: en
+                        format: vector
+                        url: /2023-10-31/styles/dark-matter/style.json
+                      - locale: en
+                        format: raster
+                        url: /2023-10-31/styles/dark-matter.json
+              schema:
+                type: object
+                properties:
+                  version:
+                    type: string
+                    description: Version of the API as a date in YYYY-MM-DD format
+                  services:
+                    type: array
+                    minItems: 1
+                    items:
+                      type: object
+                      required:
+                        - id
+                        - name
+                        - attribution
+                        - formats
+                      properties:
+                        id:
+                          type: string
+                          description: Identifier of the style
+                        name:
+                          type: object
+                          description: A human readable label for the style
+                          required:
+                            - en
+                          properties:
+                            en:
+                              type: string
+                        attribution:
+                          $ref: '#/components/schemas/attribution'
+                        formats:
+                          type: array
+                          description: The different formats for this tile service
+                          items:
+                            type: object
+                            required:
+                              - locale
+                              - format
+                              - url
+                            properties:
+                              locale:
+                                type: string
+                              format:
+                                type: string
+                                description: The service can offer vector or raster tiles
+                                enum:
+                                  - raster
+                                  - vector
+                              url:
+                                type: string
+                                description: Relative path to the MapBox style specification
+        '404':
+          description: Manifest is not found
+          content:
+            text/html:
+              example: |
+                <!DOCTYPE html>
+                <html lang="en">
+                <head>
+                <meta charset="utf-8">
+                <title>Error</title>
+                </head>
+                <body>
+                <pre>Cannot GET /snthstn</pre>
+                </body>
+                </html>
+              schema:
+                type: string
+components:
+  schemas:
+    attribution:
+      type: array
+      description: The attribution of this data
+      minItems: 1
+      items:
+        type: object
+        properties:
+          label:
+            type: object
+            properties:
+              en:
+                type: string
+                description: English attribution label
+          url:
+            type: object
+            properties:
+              en:
+                type: string
+                description: Attribution details URL
+                format: URL

package/docs/openapi/ems_tile_service/entrypoint.yaml

@@ -0,0 +1,92 @@
+openapi: 3.0.1
+info:
+  title: Elastic Maps Tile Service
+  description: OpenAPI schema for the Elastic Maps Tile Service manifest endpoint
+  version: '0.1'
+  contact:
+    name: Presentation Team
+  license:
+    name: Elastic License 2.0
+    url: https://www.elastic.co/licensing/elastic-license
+tags:
+  - name: ems
+    description: Elastic Maps Service.
+servers:
+  - url: 'https://tiles.maps.elastic.co'
+    description: Production
+  - url: 'https://tiles.maps.elastic.dev'
+    description: Staging
+security: []
+paths:
+   '/latest/manifest':
+     get:
+      operationId: getTileManifest
+      tags: ['ems']
+      summary: "Manifest of the EMS Tile Service"
+      description: "Describes the basemap styles available"
+      parameters: []
+      responses:
+        "404":
+          description: "Manifest is not found"
+          content:
+            text/html:
+              example:
+                $ref: ../components/examples/tile_service_404.html
+              schema:
+                type: string
+        "200":
+          description: "Manifest is returned"
+          content:
+            application/json:
+              example:
+                $ref: ../components/examples/tile_service_200.json
+              schema:
+                type: object
+                properties:
+                  version:
+                    type: string
+                    description: "Version of the API as a date in YYYY-MM-DD format"
+                  services:
+                    type: array
+                    minItems: 1
+                    items:
+                      type: object
+                      required:
+                        - id
+                        - name
+                        - attribution
+                        - formats
+                      properties:
+                        id:
+                          type: string
+                          description: Identifier of the style
+                        name:
+                          type: object
+                          description: A human readable label for the style
+                          required: [ 'en' ]
+                          properties:
+                            en:
+                              type: string
+                        attribution:
+                          $ref: ../components/attribution.yaml
+                        formats:
+                          type: array
+                          description: The different formats for this tile service
+                          items:
+                            type: object
+                            required:
+                              - locale
+                              - format
+                              - url
+                            properties:
+                              locale:
+                                type: string
+                              format:
+                                type: string
+                                description: The service can offer vector or raster tiles
+                                enum: ['raster', 'vector']
+                              url:
+                                type: string
+                                description: Relative path to the MapBox style specification
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elastic/ems-client",
-  "version": "8.5.0",
+  "version": "8.5.1",
   "description": "JavaScript client library for the Elastic Maps Service",
   "main": "target/node/index.js",
   "browser": "target/web/index.js",
@@ -72,6 +72,6 @@
     "typescript": "4.6.3"
   },
   "engines": {
-    "node": ">=16 <=18"
+    "node": ">=18 <=20"
   }
 }

package/src/ems_client.ts

@@ -347,6 +347,10 @@ export class EMSClient {
     return this._cache.get(layerId);
   }
 
+  getEmsVersion(): string {
+    return this._emsVersion;
+  }
+
   getTileApiUrl(): string {
     return this._tileApiUrl;
   }

package/target/ems_client.d.ts

@@ -137,6 +137,7 @@ export declare class EMSClient {
     getTMSServices(): Promise<TMSService[]>;
     cacheGeoJson(layerId: string, geoJson: FeatureCollection): void;
     getCachedGeoJson(layerId: string): FeatureCollection<import("geojson").Geometry, import("geojson").GeoJsonProperties> | undefined;
+    getEmsVersion(): string;
     getTileApiUrl(): string;
     getFileApiUrl(): string;
     getLandingPageUrl(): string;

package/target/node/ems_client.js

@@ -24,8 +24,7 @@ function _toPrimitive(input, hint) { if (typeof input !== "object" || input ===
                                                                                                                                                                                                                                                                                                                                                                                            * 2.0.
                                                                                                                                                                                                                                                                                                                                                                                            */
 const REST_API_REGEX = /\d{4}-\d{2}-\d{2}/;
-const LATEST_API_URL_PATH = 'latest';
-exports.LATEST_API_URL_PATH = LATEST_API_URL_PATH;
+const LATEST_API_URL_PATH = exports.LATEST_API_URL_PATH = 'latest';
 /**
  * plugins cannot have upstream dependencies on core/*-kibana.
  * Work-around by copy-pasting modifyUrl routine here.
@@ -204,6 +203,9 @@ class EMSClient {
   getCachedGeoJson(layerId) {
     return this._cache.get(layerId);
   }
+  getEmsVersion() {
+    return this._emsVersion;
+  }
   getTileApiUrl() {
     return this._tileApiUrl;
   }

package/target/node/file_layer.js

@@ -7,8 +7,8 @@ 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); }
@@ -18,12 +18,11 @@ function _toPrimitive(input, hint) { if (typeof input !== "object" || input ===
                                                                                                                                                                                                                                                                                                                                                                                            * 2.0; you may not use this file except in compliance with the Elastic License
                                                                                                                                                                                                                                                                                                                                                                                            * 2.0.
                                                                                                                                                                                                                                                                                                                                                                                            */
-let EMSFormatType = /*#__PURE__*/function (EMSFormatType) {
+let EMSFormatType = exports.EMSFormatType = /*#__PURE__*/function (EMSFormatType) {
   EMSFormatType["geojson"] = "geojson";
   EMSFormatType["topojson"] = "topojson";
   return EMSFormatType;
 }({});
-exports.EMSFormatType = EMSFormatType;
 class FileLayer extends _ems_service.AbstractEmsService {
   constructor(config, emsClient, proxyPath) {
     super(config, emsClient, proxyPath);