@findhotel/sapi 0.23.14 → 0.24.2

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

@@ -1,13 +1,6 @@
 import { ProfileKey, IndexVariation } from './types';
-/**
- * Fixed number of price bucket count
- */
-export declare const PRICE_BUCKET_COUNT = 31;
 export declare type Features = 'offers' | 'search' | 'suggests' | 'configs' | 'rooms' | 'get-hotel';
 export interface AppConfig {
-    daedalus: {
-        raaEndpoint: string | undefined;
-    };
     sapiBackend: {
         baseUrl: string;
         endpoints: {
@@ -25,6 +18,7 @@ export interface AppConfig {
         };
     };
     algolia: {
+        appId: string;
         apiKey: string;
         hotelIndex: string;
         autocompleteIndex: string;

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

@@ -1,4 +1,4 @@
-import { BaseWithConfig } from '.';
+import { Base } from '.';
 import { Language, HotelId, TranslatedString, GuestRating, GuestType, Location, TranslatedArray, Pricing, ContentHotel, LOVItem, Currency } from './types';
 export interface SafHotel {
     objectID: HotelId;
@@ -57,4 +57,4 @@ export declare function createRequestString(hotelId: HotelId, languages: Languag
  *
  * @returns function that asynchronously returns hotel's content by hotelId
  */
-export declare function hotel({ appConfig, options }: Pick<BaseWithConfig, 'options' | 'appConfig'>): HotelHandler;
+export declare function hotel({ appConfig, options }: Pick<Base, 'options' | 'appConfig'>): HotelHandler;

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

@@ -1,4 +1,4 @@
-import { BaseWithConfig } from '.';
+import { Base } from '.';
 import { GetOffersParameters } from './offers-client';
 import { HotelId, HotelOfferEntity, CugDeals } from './types';
 import { AppConfig } from './app-config';
@@ -22,7 +22,7 @@ interface Callbacks {
     onComplete?: (response: HotelOfferEntity | undefined) => void;
 }
 export declare type OffersHandler = (parameters: OffersParameters, callbacks: Callbacks) => Promise<HotelOfferEntity | undefined>;
-export declare function getOffersParameters(parameters: OffersParameters, options: BaseWithConfig['options'], appConfig: AppConfig): GetOffersParameters;
+export declare function getOffersParameters(parameters: OffersParameters, options: Base['options'], appConfig: AppConfig): GetOffersParameters;
 /**
  * Creates offers function with configuration object
  *
@@ -30,5 +30,5 @@ export declare function getOffersParameters(parameters: OffersParameters, option
  *
  * @returns function for fetching offers
  */
-export declare function offers({ offersClient, options, appConfig }: Pick<BaseWithConfig, 'offersClient' | 'options' | 'appConfig'>): OffersHandler;
+export declare function offers({ offersClient, options, appConfig }: Pick<Base, 'offersClient' | 'options' | 'appConfig'>): OffersHandler;
 export {};

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

@@ -0,0 +1,4 @@
+/**
+ * Get sapi override parameter directly from the URL. Used only for debugging purposes.
+ */
+export declare function getSapiOverrideParameter(): string | null | undefined;

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

@@ -1,4 +1,4 @@
-import { BaseWithConfig } from '.';
+import { Base } from '.';
 import { RoomsRequestParameters, RoomsRequestOptions, RoomsResults } from './types';
 export declare type RoomsHandler = (parameters: RoomsRequestParameters) => Promise<RoomsResults>;
 /**
@@ -38,4 +38,4 @@ export declare function createRequestString(parameters: RoomsRequestParameters,
  *
  * @returns rooms search function
  */
-export declare function rooms({ appConfig, options }: Pick<BaseWithConfig, 'options' | 'appConfig'>): RoomsHandler;
+export declare function rooms({ appConfig, options }: Pick<Base, 'options' | 'appConfig'>): RoomsHandler;

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

@@ -1,17 +1,12 @@
-import { SearchClient } from 'algoliasearch';
 import { Except } from 'type-fest';
 import { OffersClient } from './offers-client';
-import { Configs } from './algolia';
 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: Features) => boolean;
-    /** Instance of Algolia Client */
-    algoliaClient: AlgoliaClient;
     /** Instance of Offers Client */
     offersClient?: OffersClient;
     /** Profile key of specific client */
@@ -23,12 +18,13 @@ export interface Base {
         pageSize: number;
         languages: Language[];
     };
-    configs?: unknown;
-}
-export interface BaseWithConfig extends Base {
-    /** Configs loaded from Algolia and local date configuration */
-    configs: Configs;
 }
+/**
+ * Converts map of A/B tests variations to array of string
+ *
+ * @param variations - variations map
+ */
+export declare function variationsToArray(variations?: Record<string, string>): string[];
 /**
  * SAPI constructor
  *

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

@@ -1,8 +1,8 @@
 import { Except } from 'type-fest';
-import { BaseWithConfig } from '.';
-import { AnchorObject, AnchorType, Facets } from './algolia';
+import { Base, ProfileKey } from '.';
 import { DealScores, DatesConfig } from './utils';
-import { Anchor, ApiSearchParameters, Hotel, HotelOfferEntity, AnonymousId, SearchParameters, HotelId } from './types';
+import { SearchParameters, HotelId, Hotel, Anchor, ApiSearchParameters, HotelOfferEntity, AnchorType, Facets } from './types';
+export declare type SearchFnParameters = Pick<Base, 'profileKey' | 'options' | 'appConfig' | 'offersClient' | 'getFeatureEnabled'>;
 export interface SearchResults {
     anchor: Anchor;
     anchorHotelId?: HotelId;
@@ -18,19 +18,13 @@ export interface SearchResults {
     resultsCountTotal: number;
     offset: number;
     dealScores: DealScores;
+    hasMoreResults: boolean;
 }
 declare type OnStart = (response: Pick<SearchResults, 'searchId' | 'searchParameters'>) => void;
 declare type OnAnchorReceived = (response: Pick<SearchResults, 'searchId' | 'searchParameters' | 'anchor' | 'anchorHotelId' | 'anchorType'>) => void;
 declare type OnHotelsReceived = (response: Except<SearchResults, 'hotelOfferEntities'>) => void;
 declare type OnOffersReceived = (response: SearchResults) => void;
 declare type OnComplete = (response: SearchResults) => void;
-interface Options {
-    anonymousId: AnonymousId;
-    language: string;
-    currency: string;
-    countryCode: string;
-    pageSize: number;
-}
 export declare type SearchHandler = (parameters: ApiSearchParameters, callbacks?: {
     onStart?: OnStart;
     onAnchorReceived?: OnAnchorReceived;
@@ -42,7 +36,23 @@ export declare type SearchHandler = (parameters: ApiSearchParameters, callbacks?
     loadMore: () => Promise<SearchResults>;
 }>;
 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): SearchHandler;
+declare type AttributesToRetrieve = keyof SearchResults;
+interface SearchRequestParameters {
+    searchId: string;
+    profileKey: ProfileKey;
+    searchParameters: SearchParameters;
+    options: Base['options'];
+    offset: number;
+    attributes?: AttributesToRetrieve[];
+}
+export declare function createSearchRequestString({ profileKey, searchId, searchParameters, options, offset, attributes }: SearchRequestParameters): string;
+interface AnchorRequestParameters {
+    searchId: string;
+    profileKey: ProfileKey;
+    searchParameters: SearchParameters;
+    options: Base['options'];
+    attributes?: AttributesToRetrieve[];
+}
+export declare function createAnchorRequestString({ profileKey, searchId, searchParameters, options, attributes }: AnchorRequestParameters): string;
+export declare function search({ getFeatureEnabled, profileKey, appConfig, offersClient, options }: SearchFnParameters): SearchHandler;
 export {};

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

@@ -0,0 +1,11 @@
+export declare type ExchangeRates = Record<string, number>;
+export interface ListOfValuesItem {
+    id: number;
+    categoryID?: number;
+    objectID: string;
+    value: Record<string, string | number>;
+}
+export declare type Configs = {
+    lov: ListOfValuesItem[];
+    exchangeRates: ExchangeRates;
+};

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

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

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

@@ -56,6 +56,8 @@ export interface RoomOffer {
     refundable: boolean;
     canPayLater: boolean;
     services: string[];
+    isClicked?: boolean;
+    matchType?: 'exact' | 'partial';
 }
 export interface RoomImage {
     url: string;
@@ -74,6 +76,7 @@ export interface Room {
     description: string;
     images: RoomImage[];
     offers: RoomOffer[];
+    hasClickedOffer?: boolean;
 }
 export interface RoomsResults {
     hotelId: HotelId;

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

@@ -1,11 +1,11 @@
 import { AlgoliaSearchOptions } from 'algoliasearch';
 import { AnonymousId, Language, Currency, Country, DeviceType, Brand } from './types';
+import { Configs } from './config';
 import { AppConfig } from '../app-config';
 import { SearchHandler } from '../search';
 import { RoomsHandler } from '../rooms';
 import { HotelHandler } from '../hotel';
 import { SuggestHandler } from '../suggest';
-import { Configs } from '../algolia';
 import { OffersHandler } from '../offers';
 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 {

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

@@ -74,6 +74,7 @@ export declare type SearchParameters = ApiSearchParameters & {
     checkOut: string;
     rooms: string;
 };
+export declare type Facets = Record<string, Record<string, number>>;
 /**
  * Algolia types
  */
@@ -106,6 +107,7 @@ interface BasicAnchorHit {
     priceBucketWidth?: number;
     _geoloc: Location;
 }
+export declare type AnchorType = 'hotel' | 'place';
 export interface HotelAnchorHit extends BasicAnchorHit {
     hotelName: TranslatedString;
     objectType: 'hotel';

package/dist/types/packages/core/src/{algolia/utils.d.ts → utils/algolia.d.ts}

@@ -1,18 +1,6 @@
-import { AnchorHit, HotelAnchorHit, PlaceAnchorHit, HotelAnchor, PlaceAnchor, Hit, Hotel, TranslatedString, TranslatedArray, TranslatedHighlightResult, Language, HotelSuggestHit, PlaceSuggestHit, SuggestHit, Suggestion, PlaceTypeName, IndexVariation } from '../types';
+import { AnchorHit, Hit, TranslatedString, TranslatedArray, TranslatedHighlightResult, Language, HotelSuggestHit, PlaceSuggestHit, SuggestHit, Suggestion, PlaceTypeName } from '../types';
 declare type AnchorSuggestOrHit = AnchorHit | Hit | SuggestHit;
 declare type TranslatedAttribute = TranslatedString | TranslatedArray;
-/**
- * Format checkIn + length of stay
- *
- * @returns a string `YYMMDD-lengthOfStay`
- */
-export declare function getCheckInNights(checkIn: string, checkOut: string): string;
-/**
- * Create tags' facet filter
- *
- * Array with single tags definition.
- */
-export declare function getTagsFilter(checkIn: string, checkOut: string): string[];
 /**
  * Returns whether input string is empty or consists of only whitespace
  *
@@ -42,10 +30,6 @@ export declare function validateHit(hit: AnchorSuggestOrHit | undefined, require
  * @param {number} placeType
  */
 export declare function placeTypeToPlaceTypeName(placeTypeId?: number): PlaceTypeName;
-export declare function hitToHotel(algoliaHit: Hit, languages: Language[]): Hotel;
-export declare function hitToHotelTypeAnchor(anchorHit: HotelAnchorHit, languages: Language[]): HotelAnchor;
-export declare function hitToPlaceTypeAnchor(anchorHit: PlaceAnchorHit, languages: Language[]): PlaceAnchor;
 export declare function hitToHotelSuggest(suggestHit: HotelSuggestHit, languages: Language[]): Suggestion;
 export declare function hitToPlaceSuggest(suggestHit: PlaceSuggestHit, languages: Language[]): Suggestion;
-export declare function pickIndexVariation(choices: IndexVariation[], variations: string[]): IndexVariation;
 export {};

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

@@ -2,7 +2,7 @@ export interface DatesConfig {
     daysFromNow: number;
     blockedDefaultDates: string[];
 }
-interface GetDatesParameters {
+export interface GetDatesParameters {
     checkIn?: string;
     checkOut?: string;
     dayDistance?: number;

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

@@ -9,3 +9,4 @@ export * from './regular-price';
 export * from './remove-empty';
 export * from './sorting-boosts';
 export * from './build-offers-response';
+export * from './algolia';

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

@@ -1,15 +1,4 @@
-import { AnonymousId, ApiSearchParameters, Country, Currency, Language } from '../types';
-interface SearchIdOptions {
-    anonymousId: AnonymousId;
-    language: Language;
-    currency: Currency;
-    countryCode: Country;
-}
 /**
- * Generates a deterministic hash of a combination of ApiSearchParameters and SAPI options.
- *
- * @param parameters all relevant search parameters to generate an id
- * @param options SAPI options used to generate an id
+ * Generates a random searchId string
  */
-export declare function generateSearchId(parameters: ApiSearchParameters, options: SearchIdOptions): string;
-export {};
+export declare function generateSearchId(): string;

package/package.json

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

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

@@ -1,70 +0,0 @@
-import { AlgoliaClient } from '..';
-import { IndexVariation } from '../types';
-declare type HsoConfigContext = Record<string, unknown>;
-export declare type HsoConfigType = 'place_search' | 'hotel_search';
-interface HsoConfig {
-    criteria: string;
-    description?: string;
-    value: string[];
-}
-export declare type HsoConfigs = Record<HsoConfigType, HsoConfig[]>;
-export interface HsoHit {
-    description: string;
-    hso: HsoConfigs;
-    objectID: string;
-}
-export declare type HsoFilter = string[];
-interface ExchangeRateHit {
-    objectID: string;
-    rate: number;
-}
-export declare type ExchangeRates = Record<string, number>;
-export interface ListOfValuesItem {
-    id: number;
-    categoryID?: number;
-    objectID: string;
-    value: Record<string, string | number>;
-}
-export declare type Configs = {
-    hso: HsoConfigs;
-    lov: ListOfValuesItem[];
-    exchangeRates: ExchangeRates;
-};
-export declare type LoadConfig = () => Promise<Configs>;
-interface PreloadedConfig {
-    hso: HsoConfigs;
-    lov: ListOfValuesItem[];
-    curr: ExchangeRateHit[];
-}
-interface LoadConfigOptions {
-    languages: string[];
-    currencies: string[];
-    preloadedConfig?: PreloadedConfig;
-    variations: string[];
-}
-/**
- * Evaluate hso config
- *
- * @param config
- * @param context
- */
-export declare function evaluateHsoConfigs(context: HsoConfigContext, configs?: HsoConfig[]): HsoFilter;
-/**
- * Generate exchange rates object from response
- *
- * @param hits
- */
-export declare function exchangeRatesFromResponse(hits: ExchangeRateHit[]): ExchangeRates;
-/**
- * Get LOV attributes to retrieve with Translated attributes
- *
- * @param languages
- */
-export declare function getLovAttributesToRetrieve(languages: string[]): string[];
-interface IndicesConfiguration {
-    hsoIndex: IndexVariation[];
-    lovIndex: string;
-    currencyIndex: string;
-}
-export declare function loadConfigs({ search }: AlgoliaClient, { hsoIndex, lovIndex, currencyIndex }: IndicesConfiguration, options: LoadConfigOptions): Promise<Configs>;
-export {};

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

@@ -1,27 +0,0 @@
-import { AlgoliaClient } from '..';
-import { HsoFilter } from './configs';
-import { OptionalSearchParameters, Hotel, Location } from '../types';
-interface Options {
-    languages: string[];
-    requestSize: number;
-    priceBucketWidth?: number;
-    exchangeRate: number;
-    hsoFilter: HsoFilter;
-}
-export declare type Facets = Record<string, Record<string, number>>;
-export interface GeoSearchParameters extends OptionalSearchParameters {
-    geolocation?: Location;
-    anchorHotelId?: string;
-}
-interface IndicesConfiguration {
-    hotelIndex: string;
-}
-export declare function geoSearch({ search }: AlgoliaClient, { hotelIndex }: IndicesConfiguration, options: Options): (parameters: GeoSearchParameters) => Promise<{
-    hotelIds: string[];
-    hotelEntities: Record<string, Hotel>;
-    resultsCount: number;
-    resultsCountTotal: number;
-    offset: number;
-    facets: Record<string, Record<string, number>>;
-}>;
-export {};

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

@@ -1,26 +0,0 @@
-import { AlgoliaClient } from '..';
-import { Anchor, Hotel, Location } from '../types';
-interface GetAnchorParameters {
-    hotelId?: string;
-    placeId?: string;
-    query?: string;
-    geolocation?: Location;
-}
-export declare type AnchorType = 'hotel' | 'place';
-export declare type AnchorObject = {
-    anchorType: AnchorType;
-    anchor: Anchor;
-    anchorHotel: Hotel | undefined;
-};
-interface IndicesConfiguration {
-    autocompleteIndex: string;
-    hotelIndex: string;
-}
-export declare function getAnchor({ search }: AlgoliaClient, { autocompleteIndex, hotelIndex }: IndicesConfiguration, { languages }: {
-    languages: string[];
-}): (parameters: GetAnchorParameters) => Promise<{
-    anchor: import("..").HotelAnchor | import("..").PlaceAnchor;
-    anchorHotel: Hotel | undefined;
-    anchorType: "hotel" | "place";
-}>;
-export {};

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

@@ -1,6 +0,0 @@
-export * from './get-anchor';
-export * from './geo-search';
-export * from './utils';
-export * from './pricing';
-export * from './load-suggests';
-export * from './configs';

package/dist/types/packages/core/src/algolia/load-suggests.d.ts

@@ -1,10 +0,0 @@
-import { AlgoliaClient } from '..';
-interface Options {
-    languages: string[];
-    suggestsCount?: number;
-}
-interface IndicesConfiguration {
-    autocompleteIndex: string;
-}
-export declare function loadSuggests({ search }: AlgoliaClient, { autocompleteIndex }: IndicesConfiguration, { languages, suggestsCount }: Options): (query: string) => Promise<import("..").Suggestion[]>;
-export {};

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

@@ -1,26 +0,0 @@
-interface PriceFilterParameters {
-    checkIn?: string;
-    checkOut?: string;
-    margin?: number;
-    priceBucketWidth?: number;
-    priceBucketsCount: number;
-    priceMax?: number;
-    priceMin?: number;
-}
-/**
- * Generates sort by price optional filter
- *
- * @param priceBucketsCount number of price buckets
- *
- * @returns array of strings
- */
-export declare function generateSortByPriceFilter(priceBucketsCount: number): string[];
-/**
- * Generates price filter based on Alglolia's optional filters
- *
- * @param PriceFilterParameters parameterd for generating the filter
- *
- * @returns array of strings
- */
-export declare function generatePriceFilter({ priceMin, priceMax, priceBucketWidth, priceBucketsCount, checkIn, checkOut, margin }: PriceFilterParameters): string[];
-export {};

package/dist/types/packages/core/src/algolia/utils.test.d.ts

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

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

@@ -1,23 +0,0 @@
-import { Base, ProfileKey } from '.';
-import { SearchResults, SearchHandler, SearchFnParameters } from './search';
-import { SearchParameters } from './types';
-declare type AttributesToRetrieve = keyof SearchResults;
-interface SearchRequestParameters {
-    searchId: string;
-    profileKey: ProfileKey;
-    searchParameters: SearchParameters;
-    options: Base['options'];
-    offset: number;
-    attributes?: AttributesToRetrieve[];
-}
-export declare function createSearchRequestString({ profileKey, searchId, searchParameters, options, offset, attributes }: SearchRequestParameters): string;
-interface AnchorRequestParameters {
-    searchId: string;
-    profileKey: ProfileKey;
-    searchParameters: SearchParameters;
-    options: Base['options'];
-    attributes?: AttributesToRetrieve[];
-}
-export declare function createAnchorRequestString({ profileKey, searchId, searchParameters, options, attributes }: AnchorRequestParameters): string;
-export declare function backendSearch({ getFeatureEnabled, profileKey, appConfig, offersClient, options }: SearchFnParameters): SearchHandler;
-export {};

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

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