everymap-providers-here 0.2.2

HERE Technologies provider for EveryMap — geocoding, routing, traffic, isolines, and more
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
use crate::domain::geo::HereLatLng;
use everymap_core::domains::search::{SearchResponse, SearchResult, SearchResultType};
use everymap_core::types::Coordinate;
use serde::{Deserialize, Serialize};

// --- Shared enums used across multiple search endpoints ---

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum SearchType {
    Address,
    Area,
    City,
    HouseNumber,
    Place,
    PostalCode,
    Street,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum AddressNamesMode {
    #[default]
    Matched,
    Normalized,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum PostalCodeMode {
    #[default]
    CityLookup,
    DistrictLookup,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum WithFeature {
    Mpa,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum ShowFeature {
    AddressUsage,
    CountryInfo,
    Parsing,
    PostalCodeDetails,
    SecondaryUnitInfo,
    StreetInfo,
    Tz,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum ShowMapReference {
    AdminIds,
    CmVersion,
    Links,
    MicroPointAddress,
    PointAddress,
    Segments,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum ShowNavAttribute {
    Access,
    FunctionalClass,
    Physical,
    SpeedLimits,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum ShowRelated {
    Mpa,
    Intersections,
    #[serde(rename = "parentPa")]
    ParentPa,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ShowTranslation {
    City,
    County,
    District,
    State,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum DiscoverWithFeature {
    RecommendPlaces,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum MobilityMode {
    Car,
    Motorbike,
    Truck,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum RankingMode {
    ExcursionDistance,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum HereEvSupplyType {
    Ac,
    Dc,
}

// --- Rich response types ---

/// Full response from the HERE Geocoding & Search API v7.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereSearchResponse {
    #[serde(default)]
    pub items: Vec<HereSearchItem>,
}

impl From<HereSearchResponse> for SearchResponse {
    fn from(response: HereSearchResponse) -> Self {
        SearchResponse {
            items: response.items.into_iter().map(SearchResult::from).collect(),
        }
    }
}

/// A single search result item from the HERE Search API.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereSearchItem {
    #[serde(default)]
    pub title: Option<String>,
    #[serde(default)]
    pub id: Option<String>,
    #[serde(default, rename = "resultType")]
    pub result_type: Option<String>,
    #[serde(default)]
    pub address: Option<HereAddress>,
    #[serde(default)]
    pub position: Option<HereLatLng>,
    #[serde(default)]
    pub access: Vec<HereLatLng>,
    #[serde(default)]
    pub distance: Option<f64>,
    #[serde(default)]
    pub categories: Vec<HereCategory>,
    #[serde(default)]
    pub references: Vec<HereReference>,
    #[serde(default)]
    pub contacts: Vec<HereContact>,
    #[serde(default)]
    pub food: Option<HereFood>,
    #[serde(default, rename = "mapView")]
    pub map_view: Option<HereMapView>,
    #[serde(default, rename = "ontologyId")]
    pub ontology_id: Option<String>,
    #[serde(default)]
    pub chains: Vec<HereChain>,
    #[serde(default, rename = "addressBlock")]
    pub address_block: Option<HereAddressBlock>,
    #[serde(default)]
    pub highlights: Option<HereHighlights>,
    #[serde(default)]
    pub types: Vec<String>,
    #[serde(default)]
    pub geojson: Option<serde_json::Value>,
}

impl From<HereSearchItem> for SearchResult {
    fn from(item: HereSearchItem) -> Self {
        let coordinate = item
            .position
            .map(Coordinate::from)
            .unwrap_or(Coordinate::ORIGIN);
        let address = item
            .address
            .map(everymap_core::types::Address::from)
            .unwrap_or_default();
        let result_type = match item.result_type.as_deref() {
            Some("place") | Some("exactMatch") => SearchResultType::ExactMatch,
            Some("approximate") => SearchResultType::Approximate,
            Some("interpolated") => SearchResultType::Interpolated,
            _ => SearchResultType::Unknown,
        };
        let bounding_box =
            item.map_view
                .and_then(|mv| match (mv.west, mv.south, mv.east, mv.north) {
                    (Some(w), Some(s), Some(e), Some(n)) => everymap_core::types::BoundingBox::new(
                        Coordinate::new(n, e).ok()?,
                        Coordinate::new(s, w).ok()?,
                    )
                    .into(),
                    _ => None,
                });
        SearchResult {
            id: item.id,
            coordinate,
            address,
            title: item.title,
            result_type,
            distance: item.distance,
            confidence: None,
            categories: item.categories.into_iter().filter_map(|c| c.name).collect(),
            bounding_box,
            raw: None,
        }
    }
}

/// Full address from the HERE Search API.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereAddress {
    #[serde(default)]
    pub label: Option<String>,
    #[serde(default, rename = "countryCode")]
    pub country_code: Option<String>,
    #[serde(default, rename = "countryName")]
    pub country_name: Option<String>,
    #[serde(default, rename = "stateCode")]
    pub state_code: Option<String>,
    #[serde(default)]
    pub state: Option<String>,
    #[serde(default, rename = "countyCode")]
    pub county_code: Option<String>,
    #[serde(default)]
    pub county: Option<String>,
    #[serde(default)]
    pub city: Option<String>,
    #[serde(default)]
    pub district: Option<String>,
    #[serde(default)]
    pub street: Option<String>,
    #[serde(default, rename = "houseNumber")]
    pub house_number: Option<String>,
    #[serde(default, rename = "postalCode")]
    pub postal_code: Option<String>,
    #[serde(default)]
    pub building: Option<String>,
    #[serde(default, rename = "subDistrict")]
    pub sub_district: Option<String>,
    #[serde(default)]
    pub block: Option<String>,
    #[serde(default)]
    pub unit: Option<String>,
}

impl From<HereAddress> for everymap_core::types::Address {
    fn from(addr: HereAddress) -> Self {
        everymap_core::types::Address {
            label: addr.label,
            street: addr.street,
            house_number: addr.house_number,
            city: addr.city,
            district: addr.district,
            sub_district: addr.sub_district,
            state: addr.state,
            state_code: addr.state_code,
            postal_code: addr.postal_code,
            country: addr.country_name,
            country_code: addr.country_code,
            county: addr.county,
            building: addr.building,
            block: addr.block,
            unit: addr.unit,
        }
    }
}

/// A category for a search result.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereCategory {
    #[serde(default)]
    pub id: Option<String>,
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub primary: Option<bool>,
}

/// A reference to an external system.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereReference {
    #[serde(default, rename = "type")]
    pub ref_type: Option<String>,
    #[serde(default)]
    pub id: Option<String>,
    #[serde(default)]
    pub href: Option<String>,
}

/// Contact information for a place.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereContact {
    #[serde(default)]
    pub phone: Vec<HerePhone>,
    #[serde(default)]
    pub fax: Vec<HereFax>,
    #[serde(default)]
    pub www: Vec<HereWebLink>,
    #[serde(default)]
    pub email: Vec<HereEmail>,
}

/// Phone number.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HerePhone {
    #[serde(default)]
    pub value: Option<String>,
    #[serde(default)]
    pub categories: Vec<String>,
}

/// Fax number.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereFax {
    #[serde(default)]
    pub value: Option<String>,
    #[serde(default)]
    pub categories: Vec<String>,
}

/// Web link.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereWebLink {
    #[serde(default)]
    pub href: Option<String>,
    #[serde(default)]
    pub value: Option<String>,
    #[serde(default)]
    pub categories: Vec<String>,
}

/// Email address.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereEmail {
    #[serde(default)]
    pub value: Option<String>,
    #[serde(default)]
    pub categories: Vec<String>,
}

/// Food/restaurant information.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereFood {
    #[serde(default)]
    pub cuisines: Vec<String>,
    #[serde(default, rename = "mealTypes")]
    pub meal_types: Vec<String>,
    #[serde(default)]
    pub ratings: Vec<HereRating>,
}

/// Rating information.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereRating {
    #[serde(default)]
    pub value: Option<f64>,
    #[serde(default)]
    pub count: Option<u32>,
    #[serde(default)]
    pub provider: Option<String>,
}

/// Bounding box view for a map.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereMapView {
    #[serde(default, rename = "west")]
    pub west: Option<f64>,
    #[serde(default, rename = "south")]
    pub south: Option<f64>,
    #[serde(default, rename = "east")]
    pub east: Option<f64>,
    #[serde(default, rename = "north")]
    pub north: Option<f64>,
}

/// Chain information.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereChain {
    #[serde(default)]
    pub id: Option<String>,
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub href: Option<String>,
}

/// Address block information.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereAddressBlock {
    #[serde(default)]
    pub title: Option<String>,
    #[serde(default)]
    pub address: Option<HereAddress>,
}

/// Highlight information for search results.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereHighlights {
    #[serde(default)]
    pub title: Option<Vec<HereHighlightSection>>,
    #[serde(default)]
    pub address: Option<Vec<HereHighlightSection>>,
}

/// A section of highlighted text.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereHighlightSection {
    #[serde(default)]
    pub start: Option<u32>,
    #[serde(default)]
    pub end: Option<u32>,
}

/// Full response from the HERE Discover API.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereDiscoverResponse {
    #[serde(default)]
    pub items: Vec<HereSearchItem>,
}

/// Full response from the HERE Autosuggest API.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereAutosuggestResponse {
    #[serde(default)]
    pub items: Vec<HereAutosuggestItem>,
    #[serde(default, rename = "queryTerms")]
    pub query_terms: Vec<HereQueryTerm>,
}

/// A single autosuggest result item.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereAutosuggestItem {
    #[serde(default)]
    pub title: Option<String>,
    #[serde(default)]
    pub id: Option<String>,
    #[serde(default, rename = "resultType")]
    pub result_type: Option<String>,
    #[serde(default)]
    pub address: Option<HereAddress>,
    #[serde(default)]
    pub position: Option<HereLatLng>,
    #[serde(default)]
    pub distance: Option<f64>,
    #[serde(default)]
    pub categories: Vec<HereCategory>,
    #[serde(default)]
    pub href: Option<String>,
    #[serde(default)]
    pub highlights: Option<HereHighlights>,
}

/// A query term from autosuggest.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HereQueryTerm {
    #[serde(default)]
    pub term: Option<String>,
    #[serde(default, rename = "displayText")]
    pub display_text: Option<String>,
}

// --- Request option types ---

/// Fuel station filter.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct HereFuelStationFilter {
    #[serde(default)]
    pub current: Option<Vec<String>>,
}

/// EV station filter.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct HereEvStationFilter {
    #[serde(default)]
    pub current: Option<Vec<HereEvSupplyType>>,
}

/// Route filter for search.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct HereRouteFilter {
    #[serde(default)]
    pub waypoints: Option<String>,
}

/// Options for the HERE Discover endpoint.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct HereDiscoverOptions {
    pub at: Option<Coordinate>,
    pub in_filter: Option<String>,
    pub lang: Option<String>,
    pub limit: Option<u32>,
    pub political_view: Option<String>,
    pub types: Option<Vec<SearchType>>,
    pub with: Option<Vec<DiscoverWithFeature>>,
    pub show: Option<Vec<ShowFeature>>,
    pub fuel_station: Option<HereFuelStationFilter>,
    pub ev_station: Option<HereEvStationFilter>,
    pub mobility_mode: Option<MobilityMode>,
    pub ranking: Option<RankingMode>,
    pub route: Option<HereRouteFilter>,
    pub offset: Option<u32>,
}

/// Options for the HERE Autosuggest endpoint.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct HereAutosuggestOptions {
    pub at: Option<Coordinate>,
    pub in_filter: Option<String>,
    pub lang: Option<String>,
    pub limit: Option<u32>,
    pub political_view: Option<String>,
    pub types: Option<Vec<SearchType>>,
    pub with: Option<Vec<DiscoverWithFeature>>,
    pub show: Option<Vec<ShowFeature>>,
    pub show_map_references: Option<Vec<ShowMapReference>>,
    pub fuel_station: Option<HereFuelStationFilter>,
    pub ev_station: Option<HereEvStationFilter>,
    pub mobility_mode: Option<MobilityMode>,
    pub ranking: Option<RankingMode>,
    pub route: Option<HereRouteFilter>,
    pub terms_limit: Option<u32>,
    pub offset: Option<u32>,
}