@elastic/ems-client 8.4.1 → 8.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/CODEOWNERS +2 -0
- package/CHANGELOG.md +18 -5
- package/CONTRIBUTING.md +4 -5
- package/docs/openapi/Makefile +35 -0
- package/docs/openapi/README.md +41 -0
- package/docs/openapi/components/attribution.yaml +19 -0
- package/docs/openapi/components/examples/file_service_200.json +1 -0
- package/docs/openapi/components/examples/file_service_404.xml +1 -0
- package/docs/openapi/components/examples/tile_service_200.json +1 -0
- package/docs/openapi/components/examples/tile_service_404.html +10 -0
- package/docs/openapi/ems_file_service/bundled.json +533 -0
- package/docs/openapi/ems_file_service/bundled.yaml +347 -0
- package/docs/openapi/ems_file_service/entrypoint.yaml +152 -0
- package/docs/openapi/ems_tile_service/bundled.json +307 -0
- package/docs/openapi/ems_tile_service/bundled.yaml +195 -0
- package/docs/openapi/ems_tile_service/entrypoint.yaml +92 -0
- package/package.json +1 -1
- package/src/ems_client.ts +37 -32
- package/src/index.ts +1 -1
- package/target/ems_client.d.ts +3 -2
- package/target/index.d.ts +1 -1
- package/target/node/ems_client.js +34 -34
- package/target/node/index.js +6 -0
- package/target/web/ems_client.js +68 -89
- package/target/web/index.js +1 -1
- package/test/ems_client.test.ts +33 -0
|
@@ -0,0 +1,347 @@
|
|
|
1
|
+
openapi: 3.0.1
|
|
2
|
+
info:
|
|
3
|
+
title: Elastic Maps File Service
|
|
4
|
+
description: OpenAPI schema for the Elastic Maps File Service manifest endpoint
|
|
5
|
+
version: '0.1'
|
|
6
|
+
contact:
|
|
7
|
+
name: Presentation Team
|
|
8
|
+
license:
|
|
9
|
+
name: Elastic License 2.0
|
|
10
|
+
url: https://www.elastic.co/licensing/elastic-license
|
|
11
|
+
servers:
|
|
12
|
+
- url: https://vector.maps.elastic.co
|
|
13
|
+
description: Production
|
|
14
|
+
- url: https://storage.googleapis.com/elastic-bekitzur-emsfiles-vector-dev
|
|
15
|
+
description: Staging
|
|
16
|
+
security: []
|
|
17
|
+
tags:
|
|
18
|
+
- name: ems
|
|
19
|
+
description: Elastic Maps Service.
|
|
20
|
+
paths:
|
|
21
|
+
/latest/manifest:
|
|
22
|
+
get:
|
|
23
|
+
operationId: getFileManifest
|
|
24
|
+
tags:
|
|
25
|
+
- ems
|
|
26
|
+
summary: Manifest of the EMS File Service
|
|
27
|
+
description: Describes the layers available with formats and other metadata
|
|
28
|
+
parameters: []
|
|
29
|
+
responses:
|
|
30
|
+
'200':
|
|
31
|
+
description: Manifest is returned
|
|
32
|
+
content:
|
|
33
|
+
application/json:
|
|
34
|
+
example:
|
|
35
|
+
version: '2023-10-31'
|
|
36
|
+
layers:
|
|
37
|
+
- layer_id: world_countries
|
|
38
|
+
created_at: '2020-10-28T16:16:08.720286'
|
|
39
|
+
attribution:
|
|
40
|
+
- label:
|
|
41
|
+
en: Made with NaturalEarth
|
|
42
|
+
url:
|
|
43
|
+
en: http://www.naturalearthdata.com/about/terms-of-use
|
|
44
|
+
- label:
|
|
45
|
+
en: OpenStreetMap contributors
|
|
46
|
+
url:
|
|
47
|
+
en: https://www.openstreetmap.org/copyright
|
|
48
|
+
- label:
|
|
49
|
+
en: Elastic Maps Service
|
|
50
|
+
url:
|
|
51
|
+
en: https://www.elastic.co/elastic-maps-service
|
|
52
|
+
formats:
|
|
53
|
+
- type: topojson
|
|
54
|
+
url: /files/world_countries_v7.topo.json
|
|
55
|
+
legacy_default: true
|
|
56
|
+
meta:
|
|
57
|
+
feature_collection_path: data
|
|
58
|
+
- type: geojson
|
|
59
|
+
url: /files/world_countries_v7.geo.json
|
|
60
|
+
legacy_default: false
|
|
61
|
+
fields:
|
|
62
|
+
- type: id
|
|
63
|
+
id: iso2
|
|
64
|
+
label:
|
|
65
|
+
en: ISO 3166-1 alpha-2 code
|
|
66
|
+
af: landkode (ISO 3166-1 alpha-2)
|
|
67
|
+
ar: أيزو 3166-1 حرفي-2
|
|
68
|
+
regex: ^[A-Z]{2}$
|
|
69
|
+
alias:
|
|
70
|
+
- (geo\.){0,}country_iso_code$
|
|
71
|
+
- (country|countries)
|
|
72
|
+
values:
|
|
73
|
+
- AD
|
|
74
|
+
- AE
|
|
75
|
+
- ZW
|
|
76
|
+
- type: id
|
|
77
|
+
id: iso3
|
|
78
|
+
label:
|
|
79
|
+
en: ISO 3166-1 alpha-3 code
|
|
80
|
+
af: landkode (ISO 3166-1 alpha-3)
|
|
81
|
+
ar: أيزو 3166-1 حرفي-3
|
|
82
|
+
regex: ^[A-Z]{3}$
|
|
83
|
+
values:
|
|
84
|
+
- AND
|
|
85
|
+
- ARE
|
|
86
|
+
- ZWE
|
|
87
|
+
- type: id
|
|
88
|
+
id: iso_numeric
|
|
89
|
+
label:
|
|
90
|
+
en: ISO 3166-1 numeric code
|
|
91
|
+
af: landkode (ISO 3166-1 numeries)
|
|
92
|
+
ar: رمز إيزو الرقمي 3166-1
|
|
93
|
+
- type: property
|
|
94
|
+
id: name
|
|
95
|
+
label:
|
|
96
|
+
en: name
|
|
97
|
+
am: ስም
|
|
98
|
+
alias:
|
|
99
|
+
- (country|countries)
|
|
100
|
+
legacy_ids:
|
|
101
|
+
- World Countries
|
|
102
|
+
layer_name:
|
|
103
|
+
en: World Countries
|
|
104
|
+
zh-tw: 國家
|
|
105
|
+
- layer_id: administrative_regions_lvl2
|
|
106
|
+
created_at: '2020-07-06T22:19:49.290894'
|
|
107
|
+
attribution:
|
|
108
|
+
- label:
|
|
109
|
+
en: Made with NaturalEarth
|
|
110
|
+
url:
|
|
111
|
+
en: http://www.naturalearthdata.com/about/terms-of-use
|
|
112
|
+
- label:
|
|
113
|
+
en: OpenStreetMap contributors
|
|
114
|
+
url:
|
|
115
|
+
en: https://www.openstreetmap.org/copyright
|
|
116
|
+
- label:
|
|
117
|
+
en: Elastic Maps Service
|
|
118
|
+
url:
|
|
119
|
+
en: https://www.elastic.co/elastic-maps-service
|
|
120
|
+
formats:
|
|
121
|
+
- type: topojson
|
|
122
|
+
url: /files/admin_regions_lvl2_v2.topo.json
|
|
123
|
+
legacy_default: true
|
|
124
|
+
meta:
|
|
125
|
+
feature_collection_path: data
|
|
126
|
+
- type: geojson
|
|
127
|
+
url: /files/admin_regions_lvl2_v2.geo.json
|
|
128
|
+
legacy_default: false
|
|
129
|
+
fields:
|
|
130
|
+
- type: id
|
|
131
|
+
id: region_iso_code
|
|
132
|
+
label:
|
|
133
|
+
en: Region ISO code
|
|
134
|
+
regex: ^[A-Z]{2}-[A-Z0-9]{1,3}~?$
|
|
135
|
+
alias:
|
|
136
|
+
- (geo\.){0,}region_iso_code
|
|
137
|
+
values:
|
|
138
|
+
- AD-02
|
|
139
|
+
- AD-03
|
|
140
|
+
- AD-04
|
|
141
|
+
- type: property
|
|
142
|
+
id: region_name
|
|
143
|
+
label:
|
|
144
|
+
en: Region name
|
|
145
|
+
- type: property
|
|
146
|
+
id: country_iso2_code
|
|
147
|
+
label:
|
|
148
|
+
en: Country ISO2 code
|
|
149
|
+
- type: property
|
|
150
|
+
id: country_iso3_code
|
|
151
|
+
label:
|
|
152
|
+
en: Country ISO3 code
|
|
153
|
+
- type: property
|
|
154
|
+
id: country_name
|
|
155
|
+
label:
|
|
156
|
+
en: Country name
|
|
157
|
+
legacy_ids:
|
|
158
|
+
- Administrative regions
|
|
159
|
+
layer_name:
|
|
160
|
+
en: Administrative regions
|
|
161
|
+
zh-sg: 行政领土实体
|
|
162
|
+
zh-tw: 行政領土實體
|
|
163
|
+
- layer_id: albania_counties
|
|
164
|
+
created_at: '2019-08-06T22:16:16.377Z'
|
|
165
|
+
attribution:
|
|
166
|
+
- label:
|
|
167
|
+
en: OpenStreetMap contributors
|
|
168
|
+
url:
|
|
169
|
+
en: https://www.openstreetmap.org/copyright
|
|
170
|
+
- label:
|
|
171
|
+
en: Elastic Maps Service
|
|
172
|
+
url:
|
|
173
|
+
en: https://www.elastic.co/elastic-maps-service
|
|
174
|
+
formats:
|
|
175
|
+
- type: geojson
|
|
176
|
+
url: /files/albania_counties_v1.geo.json
|
|
177
|
+
legacy_default: true
|
|
178
|
+
fields:
|
|
179
|
+
- type: id
|
|
180
|
+
id: iso_3166_2
|
|
181
|
+
label:
|
|
182
|
+
en: ISO 3166-2 code
|
|
183
|
+
af: ISO 3166-2
|
|
184
|
+
ar: أيزو 3166-2
|
|
185
|
+
values:
|
|
186
|
+
- AL-05
|
|
187
|
+
- AL-01
|
|
188
|
+
- AL-12
|
|
189
|
+
- type: property
|
|
190
|
+
id: label_en
|
|
191
|
+
label:
|
|
192
|
+
en: name (en)
|
|
193
|
+
am: ስም (en)
|
|
194
|
+
ar: الاسم (en)
|
|
195
|
+
- type: property
|
|
196
|
+
id: label_sq
|
|
197
|
+
label:
|
|
198
|
+
en: name (sq)
|
|
199
|
+
am: ስም (sq)
|
|
200
|
+
ar: الاسم (sq)
|
|
201
|
+
legacy_ids:
|
|
202
|
+
- Albania Counties
|
|
203
|
+
layer_name:
|
|
204
|
+
en: Albania Counties
|
|
205
|
+
zh-sg: 阿尔巴尼亚行政区划
|
|
206
|
+
zh-tw: 阿爾巴尼亞行政區劃
|
|
207
|
+
schema:
|
|
208
|
+
type: object
|
|
209
|
+
properties:
|
|
210
|
+
version:
|
|
211
|
+
type: string
|
|
212
|
+
description: Version of the API as a date in YYYY-MM-DD format
|
|
213
|
+
layers:
|
|
214
|
+
type: array
|
|
215
|
+
description: An array of layer descriptions offered by the service
|
|
216
|
+
minItems: 1
|
|
217
|
+
items:
|
|
218
|
+
type: object
|
|
219
|
+
required:
|
|
220
|
+
- layer_id
|
|
221
|
+
- created_at
|
|
222
|
+
- attribution
|
|
223
|
+
- formats
|
|
224
|
+
- fields
|
|
225
|
+
- legacy_ids
|
|
226
|
+
- layer_name
|
|
227
|
+
properties:
|
|
228
|
+
layer_id:
|
|
229
|
+
type: string
|
|
230
|
+
description: Identifier of the layers
|
|
231
|
+
created_at:
|
|
232
|
+
type: string
|
|
233
|
+
description: Date of the creation of the layer
|
|
234
|
+
attribution:
|
|
235
|
+
$ref: '#/components/schemas/attribution'
|
|
236
|
+
formats:
|
|
237
|
+
type: array
|
|
238
|
+
description: The dataset can be offered in one or more different formats
|
|
239
|
+
minItems: 1
|
|
240
|
+
items:
|
|
241
|
+
type: object
|
|
242
|
+
required:
|
|
243
|
+
- type
|
|
244
|
+
- url
|
|
245
|
+
properties:
|
|
246
|
+
type:
|
|
247
|
+
type: string
|
|
248
|
+
description: Data layers can be stored in the `topojson` or `geojson` format
|
|
249
|
+
enum:
|
|
250
|
+
- topojson
|
|
251
|
+
- geojson
|
|
252
|
+
url:
|
|
253
|
+
type: string
|
|
254
|
+
description: The relative path to the data
|
|
255
|
+
legacy_default:
|
|
256
|
+
type: boolean
|
|
257
|
+
description: Is this the default format to offer?
|
|
258
|
+
meta:
|
|
259
|
+
type: object
|
|
260
|
+
description: Additional metadata needed to parse the file
|
|
261
|
+
additionalProperties: true
|
|
262
|
+
fields:
|
|
263
|
+
type: array
|
|
264
|
+
description: Metadata of the fields available on the dataset
|
|
265
|
+
minItems: 1
|
|
266
|
+
items:
|
|
267
|
+
type: object
|
|
268
|
+
required:
|
|
269
|
+
- type
|
|
270
|
+
- id
|
|
271
|
+
- label
|
|
272
|
+
properties:
|
|
273
|
+
type:
|
|
274
|
+
type: string
|
|
275
|
+
description: Fields can be identifiers to join with other datasets or data properties
|
|
276
|
+
enum:
|
|
277
|
+
- id
|
|
278
|
+
- property
|
|
279
|
+
id:
|
|
280
|
+
type: string
|
|
281
|
+
description: A unique identifier for the dataset
|
|
282
|
+
label:
|
|
283
|
+
type: object
|
|
284
|
+
description: A name for the dataset in different languages
|
|
285
|
+
additionalProperties: true
|
|
286
|
+
required:
|
|
287
|
+
- en
|
|
288
|
+
properties:
|
|
289
|
+
en:
|
|
290
|
+
type: string
|
|
291
|
+
regex:
|
|
292
|
+
type: string
|
|
293
|
+
description: A regex that matches the values of the property
|
|
294
|
+
values:
|
|
295
|
+
type: array
|
|
296
|
+
description: The actual values of this property
|
|
297
|
+
items:
|
|
298
|
+
type: string
|
|
299
|
+
alias:
|
|
300
|
+
type: array
|
|
301
|
+
description: Alternative names for this property
|
|
302
|
+
items:
|
|
303
|
+
type: string
|
|
304
|
+
legacy_ids:
|
|
305
|
+
type: array
|
|
306
|
+
description: Identifier used by older versions of the spec
|
|
307
|
+
items:
|
|
308
|
+
type: string
|
|
309
|
+
layer_name:
|
|
310
|
+
type: object
|
|
311
|
+
description: A human-readable descriptor of the dataset in different languages
|
|
312
|
+
additionalProperties: true
|
|
313
|
+
required:
|
|
314
|
+
- en
|
|
315
|
+
properties:
|
|
316
|
+
en:
|
|
317
|
+
type: string
|
|
318
|
+
'404':
|
|
319
|
+
description: Manifest not found
|
|
320
|
+
content:
|
|
321
|
+
application/xml:
|
|
322
|
+
example: |
|
|
323
|
+
<?xml version='1.0' encoding='UTF-8'?><Error><Code>NoSuchKey</Code><Message>The specified key does not exist.</Message></Error>
|
|
324
|
+
schema:
|
|
325
|
+
type: string
|
|
326
|
+
components:
|
|
327
|
+
schemas:
|
|
328
|
+
attribution:
|
|
329
|
+
type: array
|
|
330
|
+
description: The attribution of this data
|
|
331
|
+
minItems: 1
|
|
332
|
+
items:
|
|
333
|
+
type: object
|
|
334
|
+
properties:
|
|
335
|
+
label:
|
|
336
|
+
type: object
|
|
337
|
+
properties:
|
|
338
|
+
en:
|
|
339
|
+
type: string
|
|
340
|
+
description: English attribution label
|
|
341
|
+
url:
|
|
342
|
+
type: object
|
|
343
|
+
properties:
|
|
344
|
+
en:
|
|
345
|
+
type: string
|
|
346
|
+
description: Attribution details URL
|
|
347
|
+
format: URL
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
openapi: 3.0.1
|
|
2
|
+
info:
|
|
3
|
+
title: Elastic Maps File Service
|
|
4
|
+
description: OpenAPI schema for the Elastic Maps File Service manifest endpoint
|
|
5
|
+
version: '0.1'
|
|
6
|
+
contact:
|
|
7
|
+
name: Presentation Team
|
|
8
|
+
license:
|
|
9
|
+
name: Elastic License 2.0
|
|
10
|
+
url: https://www.elastic.co/licensing/elastic-license
|
|
11
|
+
tags:
|
|
12
|
+
- name: ems
|
|
13
|
+
description: Elastic Maps Service.
|
|
14
|
+
servers:
|
|
15
|
+
- url: 'https://vector.maps.elastic.co'
|
|
16
|
+
description: Production
|
|
17
|
+
- url: 'https://storage.googleapis.com/elastic-bekitzur-emsfiles-vector-dev'
|
|
18
|
+
description: Staging
|
|
19
|
+
security: []
|
|
20
|
+
paths:
|
|
21
|
+
'/latest/manifest':
|
|
22
|
+
get:
|
|
23
|
+
operationId: getFileManifest
|
|
24
|
+
tags: ['ems']
|
|
25
|
+
summary: "Manifest of the EMS File Service"
|
|
26
|
+
description: "Describes the layers available with formats and other metadata"
|
|
27
|
+
parameters: []
|
|
28
|
+
responses:
|
|
29
|
+
"404":
|
|
30
|
+
description: "Manifest not found"
|
|
31
|
+
content:
|
|
32
|
+
application/xml:
|
|
33
|
+
example:
|
|
34
|
+
$ref: ../components/examples/file_service_404.xml
|
|
35
|
+
schema:
|
|
36
|
+
type: string
|
|
37
|
+
"200":
|
|
38
|
+
description: "Manifest is returned"
|
|
39
|
+
content:
|
|
40
|
+
application/json:
|
|
41
|
+
example:
|
|
42
|
+
$ref: ../components/examples/file_service_200.json
|
|
43
|
+
schema:
|
|
44
|
+
type: object
|
|
45
|
+
properties:
|
|
46
|
+
version:
|
|
47
|
+
type: string
|
|
48
|
+
description: "Version of the API as a date in YYYY-MM-DD format"
|
|
49
|
+
layers:
|
|
50
|
+
type: array
|
|
51
|
+
description: An array of layer descriptions offered by the service
|
|
52
|
+
minItems: 1
|
|
53
|
+
items:
|
|
54
|
+
type: object
|
|
55
|
+
required:
|
|
56
|
+
- layer_id
|
|
57
|
+
- created_at
|
|
58
|
+
- attribution
|
|
59
|
+
- formats
|
|
60
|
+
- fields
|
|
61
|
+
- legacy_ids
|
|
62
|
+
- layer_name
|
|
63
|
+
properties:
|
|
64
|
+
layer_id:
|
|
65
|
+
type: string
|
|
66
|
+
description: Identifier of the layers
|
|
67
|
+
created_at:
|
|
68
|
+
type: string
|
|
69
|
+
description: Date of the creation of the layer
|
|
70
|
+
attribution:
|
|
71
|
+
$ref: ../components/attribution.yaml
|
|
72
|
+
formats:
|
|
73
|
+
type: array
|
|
74
|
+
description: The dataset can be offered in one or more different formats
|
|
75
|
+
minItems: 1
|
|
76
|
+
items:
|
|
77
|
+
type: object
|
|
78
|
+
required:
|
|
79
|
+
- type
|
|
80
|
+
- url
|
|
81
|
+
properties:
|
|
82
|
+
type:
|
|
83
|
+
type: string
|
|
84
|
+
description: Data layers can be stored in the `topojson` or `geojson` format
|
|
85
|
+
enum: [ 'topojson', 'geojson']
|
|
86
|
+
url:
|
|
87
|
+
type: string
|
|
88
|
+
description: The relative path to the data
|
|
89
|
+
legacy_default:
|
|
90
|
+
type: boolean
|
|
91
|
+
description: Is this the default format to offer?
|
|
92
|
+
meta:
|
|
93
|
+
type: object
|
|
94
|
+
description: Additional metadata needed to parse the file
|
|
95
|
+
additionalProperties: true
|
|
96
|
+
fields:
|
|
97
|
+
type: array
|
|
98
|
+
description: Metadata of the fields available on the dataset
|
|
99
|
+
minItems: 1
|
|
100
|
+
items:
|
|
101
|
+
type: object
|
|
102
|
+
required:
|
|
103
|
+
- type
|
|
104
|
+
- id
|
|
105
|
+
- label
|
|
106
|
+
properties:
|
|
107
|
+
type:
|
|
108
|
+
type: string
|
|
109
|
+
description: Fields can be identifiers to join with other datasets or data properties
|
|
110
|
+
enum: ['id', 'property']
|
|
111
|
+
id:
|
|
112
|
+
type: string
|
|
113
|
+
description: A unique identifier for the dataset
|
|
114
|
+
label:
|
|
115
|
+
type: object
|
|
116
|
+
description: A name for the dataset in different languages
|
|
117
|
+
additionalProperties: true
|
|
118
|
+
required:
|
|
119
|
+
- en
|
|
120
|
+
properties:
|
|
121
|
+
en:
|
|
122
|
+
type: string
|
|
123
|
+
regex:
|
|
124
|
+
type: string
|
|
125
|
+
description: A regex that matches the values of the property
|
|
126
|
+
values:
|
|
127
|
+
type: array
|
|
128
|
+
description: The actual values of this property
|
|
129
|
+
items:
|
|
130
|
+
type: string
|
|
131
|
+
alias:
|
|
132
|
+
type: array
|
|
133
|
+
description: Alternative names for this property
|
|
134
|
+
items:
|
|
135
|
+
type: string
|
|
136
|
+
legacy_ids:
|
|
137
|
+
type: array
|
|
138
|
+
description: Identifier used by older versions of the spec
|
|
139
|
+
items:
|
|
140
|
+
type: string
|
|
141
|
+
layer_name:
|
|
142
|
+
type: object
|
|
143
|
+
description: A human-readable descriptor of the dataset in different languages
|
|
144
|
+
additionalProperties: true
|
|
145
|
+
required:
|
|
146
|
+
- en
|
|
147
|
+
properties:
|
|
148
|
+
en:
|
|
149
|
+
type: string
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|