@findhotel/sapi 1.20.2 → 1.20.3

package/README.md

@@ -671,134 +671,121 @@ the state can be repeated between different callbacks.
 The complete SAPI search response is too big to be displayed on the page
 so there is a simplified example:
 
+```json
 ```json
 {
-    "anchor": {
-        "_geoloc": {
-            "lat": -6.28067,
-            "lon": 39.53601,
-            "precision": 5000,
-            "radius": 20000
+  "anchor": {
+    "_geoloc": {
+      "lat": -6.28067,
+      "lon": 39.53601,
+      "precision": 5000,
+      "radius": 20000
+    },
+    "objectID": "hotel:9660485",
+    "objectType": "hotel",
+    "pageSize": 25,
+    "priceBucketWidth": 16,
+    "admDivisionLevel1": "Tanzania",
+    "navPath": [
+      "3429",
+      "300878",
+      "235186"
+    ],
+    "navPathNames": {
+      "country": "Tanzania"
+    },
+    "navPathInfo": {
+      "adminDivision": {
+        "id": "12598",
+        "name": "Hokkaido Prefecture"
+      },
+      "city": {
+        "id": "43727",
+        "name": "Otaru"
+      },
+      "country": {
+        "id": "125948",
+        "name": "Japan"
+      }
+    },
+    "hotelName": "Zanzibar White Sand Luxury Villas & Spa - Relais & Chateaux",
+    "placeDisplayName": "Zanzibar"
+  },
+  "anchorType": "hotel",
+  "anchorHotelId": "9660485",
+  "hotelEntities": {
+    "9660485": {
+      "_geoloc": {
+        "lat": -6.28067,
+        "lon": 39.53601
+      },
+      "checkInTime": "14:00",
+      "checkOutTime": "11:00",
+      "country": "TZ",
+      "facilities": [
+        2, 5, 6, 7, 9, 11, 13, 20, 21, 22, 23, 28, 29, 31, 34, 35, 66, 84, 85, 86, 98, 99, 100, 103, 104, 122, 127, 189, 191, 193, 195, 202, 222, 235, 238, 243, 244, 253, 255, 266, 270, 292, 299
+      ],
+      "guestRating": {
+        "cleanliness": 9.66,
+        "dining": 9.42,
+        "facilities": 9.9,
+        "location": 9.8,
+        "overall": 9.55,
+        "rooms": 9.72
+      },
+      "guestType": {
+        "business": 6,
+        "couples": 235,
+        "families": 110,
+        "groups": 68,
+        "solo": 13
+      },
+      "imageURIs": [
+        "https://img.fih.io/image/raw/regular/provider_partition=eps/3xWl0k2P0Ofb7vxD4dr1NhFjOtdQaHXLe2p1tYLaOmw=.webp"
+      ],
+      "navPath": [
+        "3429",
+        "300878",
+        "235186"
+      ],
+      "navPathInfo": {
+        "adminDivision": {
+          "id": "12598",
+          "name": "Hokkaido Prefecture"
         },
-        "objectID": "hotel:9660485",
-        "objectType": "hotel",
-        "pageSize": 25,
-        "priceBucketWidth": 16,
-        "admDivisionLevel1": "Tanzania",
-        "navPath": [
-            "3429",
-            "300878",
-            "235186"
-        ],
-        "navPathNames": {
-            "country": "Tanzania"
+        "city": {
+          "id": "43727",
+          "name": "Otaru"
         },
-        "navPathInfo": [
-          {"id": "1419", "name": "United Kingdom"}, // country
-          {"id": "126252", "name": "West Midlands"} // division/region
-          {"id": "135057", "name": "Birmingham"} // city/village
-        ],
-        "hotelName": "Zanzibar White Sand Luxury Villas & Spa - Relais & Chateaux",
-        "placeDisplayName": "Zanzibar"
-    },
-    "anchorType": "hotel",
-    "anchorHotelId": "9660485",
-    "hotelEntities": {
-        "9660485": {
-            "_geoloc": {
-                "lat": -6.28067,
-                "lon": 39.53601
-            },
-            "checkInTime": "14:00",
-            "checkOutTime": "11:00",
-            "country": "TZ",
-            "facilities": [
-                2,
-                5,
-                6,
-                7,
-                9,
-                11,
-                13,
-                20,
-                21,
-                22,
-                23,
-                28,
-                29,
-                31,
-                34,
-                35,
-                66,
-                84,
-                85,
-                86,
-                98,
-                99,
-                100,
-                103,
-                104,
-                122,
-                127,
-                189,
-                191,
-                193,
-                195,
-                202,
-                222,
-                235,
-                238,
-                243,
-                244,
-                253,
-                255,
-                266,
-                270,
-                292,
-                299
-            ],
-            "guestRating": {
-                "cleanliness": 9.66,
-                "dining": 9.42,
-                "facilities": 9.9,
-                "location": 9.8,
-                "overall": 9.55,
-                "rooms": 9.72
-            },
-            "guestType": {
-                "business": 6,
-                "couples": 235,
-                "families": 110,
-                "groups": 68,
-                "solo": 13
-            },
-            "imageURIs": [
-                "https://img.fih.io/image/raw/regular/provider_partition=eps/3xWl0k2P0Ofb7vxD4dr1NhFjOtdQaHXLe2p1tYLaOmw=.webp",   
-            ],
-            "navPath": [
-                "3429",
-                "300878",
-                "235186"
-            ],
-            "navPathInfo": [
-              {"id": "1419", "name": "United Kingdom"}, // country
-              {"id": "126252", "name": "West Midlands"} // division/region
-              {"id": "135057", "name": "Birmingham"} // city/village
-            ]
+        "country": {
+          "id": "125948",
+          "name": "Japan"
         }
+      }
     }
+  }
 }
+```
 
 ```
 #### navPathInfo 
-this holds all information about the hotel location(starting from country -> region -> city -> village), in case any of this information is missing (for example hotel is not in a city), the row for city will not be in the response
-
+this structure holds all information about the hotel location(starting from country -> region -> city -> village)
 example:
 ```json
-            "navPathInfo": [
-              {"id": "1419", "name": "United Kingdom"}, // country
-              {"id": "126252", "name": "West Midlands"} // division/region
-            ]
+  "navPathInfo": {
+    "adminDivision": {
+      "id": "12598",
+      "name": "Hokkaido Prefecture"
+    },
+    "city": {
+      "id": "43727",
+      "name": "Otaru"
+    },
+    "country": {
+      "id": "125948",
+      "name": "Japan"
+    }
+  }
 ```
 
 ### Load more results and load more offers for a hotel

package/dist/types/packages/core/src/types/types.d.ts

@@ -152,7 +152,7 @@ interface BasicAnchorHit {
     priceBucketWidth?: number;
     _geoloc: Location;
     navPathNames?: NavPathNames;
-    navPathInfo?: NavPathInfo[];
+    navPathInfo?: NavPathInfo;
 }
 export declare type AnchorType = 'hotel' | 'place';
 export interface HotelAnchorHit extends BasicAnchorHit {
@@ -237,7 +237,12 @@ export interface NavPathNames {
     country?: string;
 }
 export interface NavPathInfo {
-    id?: string;
+    country?: PlaceInfo;
+    city?: PlaceInfo;
+    adminDivision?: PlaceInfo;
+}
+export interface PlaceInfo {
+    id: string;
     name?: string;
 }
 export interface Hotel extends Omit<Hit, 'hotelName' | 'address' | 'placeDN' | 'placeADName'> {
@@ -249,7 +254,7 @@ export interface Hotel extends Omit<Hit, 'hotelName' | 'address' | 'placeDN' | '
     vrDetails?: VrDetails;
     isVr?: boolean;
     navPathNames?: NavPathNames;
-    navPathInfo?: NavPathInfo[];
+    navPathInfo?: NavPathInfo;
     partiallyMatched: boolean;
 }
 export interface ContentHotelDescriptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@findhotel/sapi",
-  "version": "1.20.2",
+  "version": "1.20.3",
   "description": "FindHotel Search API",
   "main": "dist/index.js",
   "types": "dist/types/packages/core/src",