@findhotel/sapi 0.23.5 → 0.23.8

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

@@ -54,7 +54,7 @@ export declare function evaluateHsoConfigs(context: HsoConfigContext, configs?:
  *
  * @param hits
  */
-export declare function exchangeRatesFromResponse(hits: ExchangeRateHit[]): Record<string, number>;
+export declare function exchangeRatesFromResponse(hits: ExchangeRateHit[]): ExchangeRates;
 /**
  * Get LOV attributes to retrieve with Translated attributes
  *

package/dist/types/packages/core/src/algolia/get-anchor.d.ts

@@ -19,8 +19,8 @@ interface IndicesConfiguration {
 export declare function getAnchor({ search }: AlgoliaClient, { autocompleteIndex, hotelIndex }: IndicesConfiguration, { languages }: {
     languages: string[];
 }): (parameters: GetAnchorParameters) => Promise<{
-    anchor: Anchor;
+    anchor: import("..").HotelAnchor | import("..").PlaceAnchor;
     anchorHotel: Hotel | undefined;
-    anchorType: AnchorType;
+    anchorType: "hotel" | "place";
 }>;
 export {};

package/dist/types/packages/core/src/app-config.d.ts

@@ -3,7 +3,7 @@ import { ProfileKey, IndexVariation } from './types';
  * Fixed number of price bucket count
  */
 export declare const PRICE_BUCKET_COUNT = 31;
-declare type Features = 'offers' | 'search' | 'suggests' | 'configs' | 'rooms';
+export declare type Features = 'offers' | 'search' | 'suggests' | 'configs' | 'rooms' | 'get-hotel';
 export interface AppConfig {
     daedalus: {
         raaEndpoint: string | undefined;
@@ -20,6 +20,7 @@ export interface AppConfig {
         endpoints: {
             offersRooms: string;
             search: string;
+            hotel: string;
         };
     };
     algolia: {
@@ -38,4 +39,3 @@ export interface AppConfig {
     };
 }
 export declare function getAppConfig(profileKey: ProfileKey, initWithAppConfig?: Partial<AppConfig>): AppConfig;
-export {};

package/dist/types/packages/core/src/backend-search.d.ts

@@ -1,5 +1,5 @@
 import { Base, ProfileKey } from '.';
-import { SearchResults, SearchFn, SearchFnParameters } from './search';
+import { SearchResults, SearchHandler, SearchFnParameters } from './search';
 import { SearchParameters } from './types';
 declare type AttributesToRetrieve = keyof SearchResults;
 interface RequestParameters {
@@ -10,5 +10,5 @@ interface RequestParameters {
     attributes?: AttributesToRetrieve[];
 }
 export declare function createRequestString({ profileKey, searchParameters, options, offset, attributes }: RequestParameters): string;
-export declare function backendSearch({ getFeatureEnabled, profileKey, appConfig, offersClient, options }: SearchFnParameters): SearchFn;
+export declare function backendSearch({ getFeatureEnabled, profileKey, appConfig, offersClient, options }: SearchFnParameters): SearchHandler;
 export {};

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

@@ -0,0 +1,57 @@
+import { BaseWithConfig } from '.';
+import { Language, HotelId, TranslatedString, GuestRating, GuestType, Location, TranslatedArray, Pricing, ContentHotel, LOVItem } from './types';
+export interface SafHotel {
+    objectID: HotelId;
+    _geoloc: Location;
+    hotelName: TranslatedString;
+    imageURIs: string[];
+    guestType: GuestType;
+    guestRating: GuestRating;
+    address?: TranslatedString;
+    isDeleted?: boolean;
+    updatedAt?: number;
+    propertyTypeId?: number;
+    starRating?: number;
+    feesOpt?: TranslatedString;
+    placeADName?: TranslatedArray;
+    checkInSpInst?: TranslatedString;
+    policies?: TranslatedString;
+    phone?: string;
+    checkInTime?: string;
+    placeDN?: TranslatedArray;
+    checkInInst?: TranslatedString;
+    checkInMinAge?: number;
+    reviewCount?: number;
+    chainID?: string;
+    checkInEnd?: string;
+    lastBooked?: number;
+    checkOutTime?: string;
+    themeIds?: number[];
+    feesMnd?: TranslatedString;
+    reviewCountBkt?: number;
+    placeID?: string;
+    pricing?: Pricing;
+    facilities?: LOVItem[];
+    themes?: LOVItem[];
+    propertyType?: LOVItem;
+    sentiments?: LOVItem[];
+}
+export declare type HotelHandler = (hotelId: HotelId) => Promise<ContentHotel>;
+export declare function safToSapiHotel(safHotel: SafHotel, languages: Language[]): ContentHotel;
+/**
+ * Creates hotel request string
+ *
+ * @param hotelId - Requested hotel id
+ * @param languages - list of languages with fallback
+ *
+ * @returns request string
+ */
+export declare function createRequestString(hotelId: HotelId, languages: Language[]): string;
+/**
+ * Creates hotel function with binded in configuration object
+ *
+ * @param configuration - Configuration for hotel function initialisation
+ *
+ * @returns function that asynchronously returns hotel's content by hotelId
+ */
+export declare function hotel({ appConfig, options }: Pick<BaseWithConfig, 'options' | 'appConfig'>): HotelHandler;

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

@@ -0,0 +1 @@
+export {};

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

@@ -23,6 +23,7 @@ interface SapiResponseOffer {
     intermediaryProvider: string;
     metadata: {
         feedID: string;
+        providerRateType?: string;
     };
     occupancy: string | number | null;
     package: {

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

@@ -1,11 +1,11 @@
 import { BaseWithConfig } from '.';
 import { RoomsRequestParameters, RoomsRequestOptions, RoomsResults } from './types';
-export declare type RoomsFn = (parameters: RoomsRequestParameters) => Promise<RoomsResults>;
+export declare type RoomsHandler = (parameters: RoomsRequestParameters) => Promise<RoomsResults>;
 /**
  * Creates rooms request string.
  *
  * @param parameters - Rooms request parameters - dynamic parameters that change search
- * @param options - Rooms request options -  persistent within single SAPI instance
+ * @param options - Rooms request options - persistent within single SAPI instance
  *
  * @returns request string
  *
@@ -38,4 +38,4 @@ export declare function createRequestString(parameters: RoomsRequestParameters,
  *
  * @returns rooms search function
  */
-export declare function rooms({ appConfig, options }: Pick<BaseWithConfig, 'options' | 'appConfig'>): RoomsFn;
+export declare function rooms({ appConfig, options }: Pick<BaseWithConfig, 'options' | 'appConfig'>): RoomsHandler;

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

@@ -2,14 +2,14 @@ import { SearchClient } from 'algoliasearch';
 import { Except } from 'type-fest';
 import { OffersClient } from './raa';
 import { Configs } from './algolia';
-import { AppConfig } from './app-config';
-import { ProfileKey, ClientOptions, SapiClient, SapiFeature, Language, Logger } from './types';
+import { AppConfig, Features } from './app-config';
+import { ProfileKey, ClientOptions, SapiClient, Language, Logger } from './types';
 export declare type AlgoliaClient = Pick<SearchClient, 'search'>;
 export interface Base {
     /** SAPI client application config */
     appConfig: AppConfig;
     /** Check if SAPI feature is enabled */
-    getFeatureEnabled: (feature: SapiFeature) => boolean;
+    getFeatureEnabled: (feature: Features) => boolean;
     /** Instance of Algolia Client */
     algoliaClient: AlgoliaClient;
     /** Instance of Offers Client */

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

@@ -31,7 +31,7 @@ interface Options {
     countryCode: string;
     pageSize: number;
 }
-export declare type SearchFn = (parameters: ApiSearchParameters, callbacks?: {
+export declare type SearchHandler = (parameters: ApiSearchParameters, callbacks?: {
     onStart?: OnStart;
     onAnchorReceived?: OnAnchorReceived;
     onHotelsReceived?: OnHotelsReceived;
@@ -44,5 +44,5 @@ export declare type SearchFn = (parameters: ApiSearchParameters, callbacks?: {
 export declare function prepareSearchParameters(parameters: ApiSearchParameters, dates: DatesConfig): SearchParameters;
 export declare function getRequestSize(anchorObject: AnchorObject, parameters: SearchParameters, options: Options): number;
 export declare type SearchFnParameters = Pick<BaseWithConfig, 'profileKey' | 'options' | 'appConfig' | 'algoliaClient' | 'offersClient' | 'configs' | 'getFeatureEnabled'>;
-export declare function search({ getFeatureEnabled, appConfig, algoliaClient, offersClient, options, configs }: SearchFnParameters): SearchFn;
+export declare function search({ getFeatureEnabled, appConfig, algoliaClient, offersClient, options, configs }: SearchFnParameters): SearchHandler;
 export {};

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

@@ -1,4 +1,4 @@
 import { Base } from '.';
 import { Suggestion } from './types';
-export declare type SuggestFn = (query: string, suggestsCount?: number) => Promise<Suggestion[]>;
-export declare function suggest(base: Base): SuggestFn;
+export declare type SuggestHandler = (query: string, suggestsCount?: number) => Promise<Suggestion[]>;
+export declare function suggest(base: Base): SuggestHandler;

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

@@ -1,4 +1,3 @@
 export * from './types';
 export * from './rooms';
 export * from './sapi-client';
-export * from './sapi-configs';

package/dist/types/packages/core/src/types/sapi-client.d.ts

@@ -1,9 +1,10 @@
 import { AlgoliaSearchOptions } from 'algoliasearch';
 import { AnonymousId, Language, Currency, Country, DeviceType, Brand } from './types';
 import { AppConfig } from '../app-config';
-import { SearchFn } from '../search';
-import { RoomsFn } from '../rooms';
-import { SuggestFn } from '../suggest';
+import { SearchHandler } from '../search';
+import { RoomsHandler } from '../rooms';
+import { HotelHandler } from '../hotel';
+import { SuggestHandler } from '../suggest';
 import { Configs } from '../algolia';
 export declare type ProfileKey = 'findhotel-website' | 'findhotel-website-e2e' | 'findhotel-website-stg' | 'findhotel-website-ci' | 'findhotel-website-dev' | 'findhotel-checkout' | 'findhotel-checkout-e2e' | 'findhotel-checkout-stg';
 interface Event {
@@ -14,9 +15,10 @@ export interface Logger {
     log: (event: Event) => void;
 }
 export interface SapiClient {
-    rooms: RoomsFn;
-    search: SearchFn;
-    suggest: SuggestFn;
+    rooms: RoomsHandler;
+    search: SearchHandler;
+    suggest: SuggestHandler;
+    hotel: HotelHandler;
 }
 /** Options for initializing the Search API client. Persistent within single SAPI instance but may vary for different users */
 export interface ClientOptions {

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

@@ -1,3 +1,8 @@
+export interface IndexVariation {
+    name: string;
+    objectID?: string;
+    variationID?: string;
+}
 /**
  * Unique ID identifying users
  *
@@ -136,7 +141,7 @@ export interface HotelSuggestHit extends BasicSuggestHit {
     };
 }
 export declare type SuggestHit = HotelSuggestHit | PlaceSuggestHit;
-/** Hit */
+/** Search Hit */
 export interface Hit {
     address: TranslatedString;
     checkInTime: string;
@@ -163,12 +168,57 @@ export interface Hit {
 /**
  * Product
  */
+export interface LOVItem {
+    importance?: number;
+    categoryID?: number;
+    id: number;
+    value: TranslatedString;
+}
+export interface TranslatedLOVItem {
+    importance?: number;
+    categoryID?: number;
+    id: number;
+    value: string;
+}
 export interface Hotel extends Omit<Hit, 'hotelName' | 'address' | 'placeDN' | 'placeADName'> {
     displayAddress: string;
     hotelName: string;
     placeDisplayName: string;
     regularPriceRange?: [number, number];
 }
+export interface ContentHotel {
+    objectID: HotelId;
+    _geoloc: Location;
+    hotelName: string;
+    imageURIs: string[];
+    guestType: GuestType;
+    guestRating: GuestRating;
+    isDeleted?: boolean;
+    propertyTypeId?: number;
+    starRating?: number;
+    feesOpt?: string;
+    checkInSpInst?: string;
+    policies?: string;
+    phone?: string;
+    checkInTime?: string;
+    checkInInst?: string;
+    checkInMinAge?: number;
+    reviewCount?: number;
+    chainID?: string;
+    checkInEnd?: string;
+    lastBooked?: number;
+    checkOutTime?: string;
+    feesMnd?: string;
+    reviewCountBkt?: number;
+    placeID?: string;
+    pricing?: Pricing;
+    placeDisplayName?: string;
+    displayAddress?: string;
+    facilities?: TranslatedLOVItem[];
+    themes?: TranslatedLOVItem[];
+    propertyType?: TranslatedLOVItem;
+    sentiments?: TranslatedLOVItem[];
+}
 export interface HotelAnchor extends Omit<HotelAnchorHit, 'hotelName' | 'placeADN' | 'placeDN'> {
     placeDisplayName: string;
     hotelName: string;
@@ -214,6 +264,7 @@ export declare type Meals = 'allInclusive' | 'breakfast' | 'partialBreakfast' |
 export interface Offer {
     additionalProviderParams: {
         feedId: string;
+        rateType?: string;
     };
     id: string;
     bookURI: string;

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

@@ -1,3 +1,4 @@
+import { Except } from 'type-fest';
 /**
  * Removes specified `keys` from `object`
  *
@@ -6,4 +7,4 @@
  * @param keys keys of the properties to remove from `object`
  * @param object target object to emit `properties` from
  */
-export declare function omit<O, K extends keyof O>(keys: readonly K[], object: O): Pick<O, Exclude<keyof O, K>>;
+export declare function omit<O, K extends keyof O>(keys: readonly K[], object: O): Except<O, K>;

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@findhotel/sapi",
-  "version": "0.23.5",
+  "version": "0.23.8",
   "description": "FindHotel Search API",
   "main": "dist/index.js",
   "types": "dist/types/packages/core/src",
   "files": [
     "dist"
   ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.10.0"
+  },
   "scripts": {
     "clean:dist": "rm -rf dist",
     "build": "rollup -c && tsc --outDir dist/lib --declarationDir dist/types --declaration true --emitDeclarationOnly",
@@ -47,17 +51,17 @@
     "eslint-plugin-react-hooks": "^4.2.0",
     "husky": "^5.0.6",
     "jest": "^26.6.3",
-    "lerna": "^3.15.0",
+    "lerna": "^4.0.0",
     "rollup": "^2.33.3",
     "rollup-plugin-cleanup": "^3.2.1",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-visualizer": "^5.5.0",
-    "shipjs": "0.23.3",
+    "shipjs": "^0.24.3",
     "ts-jest": "^26.4.4",
-    "tslib": "^2.0.3",
+    "tslib": "^2.3.1",
     "type-fest": "^0.20.2",
-    "typedoc": "^0.19.2",
+    "typedoc": "^0.22.13",
     "typescript": "^4.1.2",
-    "xo": "^0.35.0"
+    "xo": "^0.48.0"
   }
 }

package/CHANGELOG.md

@@ -1,212 +0,0 @@
-## [0.23.5](https://github.com/FindHotel/sapi/compare/v0.23.4...v0.23.5) (2022-03-04)
-### Added
-- SAF domain for STG environment
-
-
-## [0.23.4](https://github.com/FindHotel/sapi/compare/v0.23.3...v0.23.4) (2022-02-28)
-### Changed
-- SAF domain for E2E environment
-
-
-## [0.23.3](https://github.com/FindHotel/sapi/compare/v0.23.2...v0.23.3) (2022-02-22)
-### Added
-- Log WS errors and re-connects
-
-
-## [0.23.2](https://github.com/FindHotel/sapi/compare/v0.23.1...v0.23.2) (2022-02-16)
-### Changed
-- Change logic of free cancelation calculation
-- Empty daedalus raa endpoint for e2e profile
-
-
-## [0.23.1](https://github.com/FindHotel/sapi/compare/v0.23.0...v0.23.1) (2022-02-09)
-### Added
-- SAPI backend offers support.
-- RAA V3 migration
-
-
-## [0.23.0](https://github.com/FindHotel/sapi/compare/v0.22.16...v0.23.0) (2022-02-09)
-### Changed
-- Skipped
-
-
-## [0.22.16](https://github.com/FindHotel/sapi/compare/v0.22.15...v0.22.16) (2022-01-04)
-### Added
-- Added missing fields to Offer type
-### Changed
-- Clean-up of room-limit test
-
-## [0.22.15](https://github.com/FindHotel/sapi/compare/v0.22.14...v0.22.15) (2021-12-27)
-### Added
-- Forward `anonymousId` to SAPI/search() backend endpoint 
-
-
-## [0.22.14](https://github.com/FindHotel/sapi/compare/v0.22.13...v0.22.14) (2021-12-17)
-### Added
-- `isDeleted` filter for autosuggest module
-
-
-## [0.22.13](https://github.com/FindHotel/sapi/compare/v0.22.12...v0.22.13) (2021-12-15)
-### Added
-- Send A/B test variations to SAF/offers-rooms endpoint
-
-## [0.22.12](https://github.com/FindHotel/sapi/compare/v0.22.11...v0.22.12) (2021-12-13)
-### Changed
-- `roomLimit` for anchor hotel has been set to 2 and for similar hotels to 1
-
-
-## [0.22.11](https://github.com/FindHotel/sapi/compare/v0.22.10...v0.22.11) (2021-12-09)
-### Changed
-- SAF search replaced with SAPI backend search
-
-
-## [0.22.10](https://github.com/FindHotel/sapi/compare/v0.22.9...v0.22.10) (2021-11-30)
-### Added
-- `boundingBox` parameter to SAF-search request
-
-## [0.22.9](https://github.com/FindHotel/sapi/compare/v0.22.8...v0.22.9) (2021-11-24)
-### Added
-- Added missing field to suggest method
-
-
-## [0.22.8](https://github.com/FindHotel/sapi/compare/v0.22.7...v0.22.8) (2021-11-16)
-### Added
-- `roomLimit` parameter for RAA requests
-
-
-## [0.22.7](https://github.com/FindHotel/sapi/compare/v0.22.6...v0.22.7) (2021-11-09)
-### Added
-- clientRequestId for each individual WS request to RAA
-
-
-## [0.22.6](https://github.com/FindHotel/sapi/compare/v0.22.5...v0.22.6) (2021-10-26)
-### Fixed
-- Rooms being undefined in SAPI.rooms() method
-### Changed
-- Bumped Immer to v9.0.6
-
-
-## [0.22.5](https://github.com/FindHotel/sapi/compare/v0.22.4...v0.22.5) (2021-10-25)
-### Added
-- Forward `cugDeals` parameter to SAF/offers-rooms endpoint
-
-
-## [0.22.4](https://github.com/FindHotel/sapi/compare/v0.22.3...v0.22.4) (2021-10-22)
-### Added
-- Forward `providerCode` parameter to SAF/offers-rooms endpoint
-
-
-## [0.22.3](https://github.com/FindHotel/sapi/compare/v0.22.2...v0.22.3) (2021-10-11)
-- Fetch missing anchorHotelId attribute for subsequent searches
-
-
-## [0.22.2](https://github.com/FindHotel/sapi/compare/v0.22.1...v0.22.2) (2021-10-11)
-### Fixed
-- Fetch missing anchorHotelId attribute for subsequent searches
-
-
-## [0.22.1](https://github.com/FindHotel/sapi/compare/v0.22.0...v0.22.1) (2021-10-06)
-### Fixed
-- Fetch missing attributes onload more hotels
-
-
-## [0.22.0](https://github.com/FindHotel/sapi/compare/v0.21.2...v0.22.0) (2021-10-04)
-### Added
-- Support for SAF/search endpoint
-### Changed
-- sapi.getConfig() method replaced with onConfigReceived callback in SAPI client
-
-
-## [0.21.2](https://github.com/FindHotel/sapi/compare/v0.21.1...v0.21.2) (2021-09-03)
-### Changed
-- Cloudfront url instead of CloudFlare for sapi-init
-
-
-## [0.21.1](https://github.com/FindHotel/sapi/compare/v0.21.0...v0.21.1) (2021-08-31)
-### Changed
-- SAF custom domain
-
-
-## [0.21.0](https://github.com/FindHotel/sapi/compare/v0.20.4...v0.21.0) (2021-08-26)
-### Changed
-- Use new Algolia index with separate HSO records for A/B test instead of switching HSO indices
-
-
-## [0.20.4](https://github.com/FindHotel/sapi/compare/v0.20.3...v0.20.4) (2021-08-20)
-### Added
-- Basic logger implementation
-
-
-## [0.20.3](https://github.com/FindHotel/sapi/compare/v0.20.2...v0.20.3) (2021-08-17)
-### Changed
-- Better error handling for fetch requests
-
-
-## [0.20.2](https://github.com/FindHotel/sapi/compare/v0.20.1...v0.20.2) (2021-08-16)
-### Changed
-- Use first offer instead of cheapest to calculate deal score
-### Fixed
-- `regularPriceRange` being `[null, null]` changed to `undefined` in case of missing `priceBucketWidth`
-
-
-## [0.20.1](https://github.com/FindHotel/sapi/compare/v0.19.3...v0.20.1) (2021-08-10)
-### Changed
-- SAPI initialisation requires only `profileKey` from now
-
-### Added
-- Added fallback for RAA WS endpoint in case it's empty in e2e environment
-
-### Removed
-- `clientId` and `clientKey` from sapi initialisation
-
-
-## [0.19.3](https://github.com/FindHotel/sapi/compare/v0.19.1...v0.19.3) (2021-08-09)
-### Fixed
-- Docs generation
-
-
-## [0.19.2](https://github.com/FindHotel/sapi/compare/v0.19.1...v0.19.2) (2021-08-09)
-### Fixed
-- Docs generation has been fixed
-
-## [0.19.1](https://github.com/FindHotel/sapi/compare/v0.18.2...v0.19.1) (2021-08-05)
-### Changed
-- Disabled docs generation temporary
-
-
-## [0.19.0](https://github.com/FindHotel/sapi/compare/v0.18.2...v0.19.0) (2021-08-05)
-### Added
-- Support for SAF (Search Application Frontend) init
-
-### Changed
-- Use internal profiles instead of external dependency
-- `initWithConfig` renamed to `initWithProfile`
-- Removed support of `variationIds` option
-
-
-## [0.18.2](https://github.com/FindHotel/sapi/compare/v0.18.1...v0.18.2) (2021-06-29)
-
-### Changed
-- Change types path
-
-
-## [0.18.1](https://github.com/FindHotel/sapi/compare/v0.18.0...v0.18.1) (2021-06-29)
-
-### Changed
-- Move `dependencies` to `devDependencies`
-
-## [0.18.0](https://github.com/FindHotel/sapi/compare/v0.17.1...v0.18.0) (2021-06-29)
-
-### Changed
-- Rename `locale` to `language` when using SAF/offers-rooms
-- Replace `merchantOfRecord` with `canPayLater`
-- Stop sending `_rankingInfo`
-
-
-## [0.17.1](https://github.com/FindHotel/sapi/compare/v0.16.1...v0.17.1) (2021-06-29)
-
-### Added
-- Use ShipJs for releases
-
-
-

package/dist/types/packages/core/src/types/sapi-configs.d.ts

@@ -1,27 +0,0 @@
-import { DateString, Language } from './types';
-export declare type SapiFeature = 'offers' | 'search' | 'rooms' | 'suggests' | 'configs';
-export interface IndexVariation {
-    name: string;
-    objectID?: string;
-    variationID?: string;
-}
-export interface Profile {
-    features: SapiFeature[];
-    blockedDefaultDates: DateString[];
-    daysFromNow: number;
-    fallbackLanguages: Record<Language, Language[]>;
-    hotelIndex: string;
-    autocompleteIndex: string;
-    lovIndex: string;
-    currencyIndex: string;
-    hsoIndex: IndexVariation[];
-    raa: {
-        endpoint?: string;
-    };
-    offers: {
-        endpoint: string;
-    };
-    algolia: {
-        apiKey: string;
-    };
-}