@findhotel/sapi 0.23.11 → 0.23.14

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

@@ -33,6 +33,7 @@ export interface AppConfig {
         hsoIndex: IndexVariation[];
     };
     client: {
+        defaultRooms: string;
         features: Features[];
         blockedDefaultDates: string[];
         daysFromNow: number;

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

@@ -0,0 +1,108 @@
+import { CugDeals, HotelId, HotelOfferEntity, Brand, Currency, DeviceType, RoomId, Meals, Logger } from './types';
+interface V3RateBreakdown {
+    base: number;
+    hotelFees: number;
+    taxes: number;
+}
+interface CancellationPenalty {
+    amount: number;
+    percent?: number;
+    nights?: number;
+    currency: string;
+    end: string;
+    start: string;
+}
+declare type Amenities = Meals & 'internetIncluded';
+declare type OfferTag = 'top_offer' | 'anchor_price' | 'exclusive_cheapest_offer';
+interface SapiResponseOffer {
+    accessTier: string;
+    availableRooms: number;
+    cancellationPenalties: CancellationPenalty[];
+    currency: Currency;
+    id: string;
+    intermediaryProvider: string;
+    metadata: {
+        feedID: string;
+        providerRateType?: string;
+    };
+    occupancy: string | number | null;
+    package: {
+        amenities: Amenities[];
+        canPayLater: boolean;
+        refundable: boolean;
+    };
+    providerCode: string;
+    rate: V3RateBreakdown;
+    roomID: RoomId;
+    tags: OfferTag[] | null;
+    url: string;
+}
+declare type Rooms = Record<RoomId, {
+    name: string;
+}>;
+export interface SapiResponseOfferEntity {
+    anchorRate: V3RateBreakdown;
+    availableOffersCount: number;
+    fetchedAllOffers: boolean;
+    hasMoreOffers: boolean;
+    id: HotelId;
+    offers: SapiResponseOffer[];
+    rooms: Rooms;
+}
+interface Options {
+    brand?: Brand;
+    anonymousId: string;
+    currency: string;
+    countryCode: string;
+    language: string;
+    includeLocalTaxes?: boolean;
+    includeTaxes?: boolean;
+    skipBackendAugmentation?: boolean;
+    facetsEnabled?: boolean;
+    WebSocket?: any;
+    sapiCliKey?: string;
+    deviceType: DeviceType;
+    variations: string[];
+    logger: Logger;
+}
+export interface GetOffersParameters {
+    anchorHotelId?: HotelId;
+    hotelIds?: HotelId[];
+    cugDeals?: CugDeals;
+    getAllOffers?: boolean;
+    originId?: string;
+    checkIn: string;
+    checkOut: string;
+    rooms: string;
+    searchId: string;
+    filters?: {
+        freeCancellation?: boolean;
+    };
+    preferredRate?: number;
+    trafficSource?: string;
+}
+export interface OffersResponse {
+    anchorHotelOfferEntity?: HotelOfferEntity;
+    hotelOfferEntities?: HotelOfferEntity[];
+}
+export interface OffersClient {
+    getOffers: (parameters: GetOffersParameters, onOffersReceived?: (response: OffersResponse) => void) => Promise<OffersResponse>;
+}
+export declare function hasAnchorPrice(price: number, anchorPrice: number): boolean;
+interface MappingContext {
+    checkIn: string;
+    checkOut: string;
+    includeTaxes?: boolean;
+    includeLocalTaxes?: boolean;
+}
+export declare function sapiResponseToHotelOfferEntity(offerEntity: SapiResponseOfferEntity, context: MappingContext): HotelOfferEntity;
+interface ApiConfig {
+    baseUrl: string;
+    endpoints: {
+        offers: string;
+    };
+}
+export declare function offersClient(config: ApiConfig, options: Options): {
+    getOffers: (parameters: GetOffersParameters, onOffersReceived?: ((response: OffersResponse) => void) | undefined) => Promise<OffersResponse>;
+};
+export {};

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

@@ -1,107 +1,34 @@
-import { CugDeals, HotelId, HotelOfferEntity, Brand, Currency, DeviceType, RoomId, Meals, Logger } from './types';
-interface V3RateBreakdown {
-    base: number;
-    hotelFees: number;
-    taxes: number;
-}
-interface CancellationPenalty {
-    amount: number;
-    percent?: number;
-    nights?: number;
-    currency: string;
-    end: string;
-    start: string;
-}
-declare type Amenities = Meals & 'internetIncluded';
-declare type OfferTag = 'top_offer' | 'anchor_price' | 'exclusive_cheapest_offer';
-interface SapiResponseOffer {
-    accessTier: string;
-    availableRooms: number;
-    cancellationPenalties: CancellationPenalty[];
-    currency: Currency;
-    id: string;
-    intermediaryProvider: string;
-    metadata: {
-        feedID: string;
-        providerRateType?: string;
-    };
-    occupancy: string | number | null;
-    package: {
-        amenities: Amenities[];
-        canPayLater: boolean;
-        refundable: boolean;
-    };
-    providerCode: string;
-    rate: V3RateBreakdown;
-    roomID: RoomId;
-    tags: OfferTag[] | null;
-    url: string;
-}
-declare type Rooms = Record<RoomId, {
-    name: string;
-}>;
-export interface SapiResponseOfferEntity {
-    anchorRate: V3RateBreakdown;
-    availableOffersCount: number;
-    fetchedAllOffers: boolean;
-    hasMoreOffers: boolean;
-    id: HotelId;
-    offers: SapiResponseOffer[];
-    rooms: Rooms;
-}
-interface Options {
-    brand?: Brand;
-    anonymousId: string;
-    currency: string;
-    countryCode: string;
-    language: string;
-    includeLocalTaxes?: boolean;
-    includeTaxes?: boolean;
-    skipBackendAugmentation?: boolean;
-    facetsEnabled?: boolean;
-    WebSocket?: any;
-    sapiCliKey?: string;
-    deviceType: DeviceType;
-    variations: string[];
-    logger: Logger;
-}
-export interface GetOffersParameters {
-    anchorHotelId?: HotelId;
-    hotelIds?: HotelId[];
-    cugDeals?: CugDeals;
-    getAllOffers?: boolean;
-    originId?: string;
+import { BaseWithConfig } from '.';
+import { GetOffersParameters } from './offers-client';
+import { HotelId, HotelOfferEntity, CugDeals } from './types';
+import { AppConfig } from './app-config';
+interface OffersParameters {
+    hotelId: HotelId;
     checkIn: string;
     checkOut: string;
     rooms: string;
-    searchId: string;
-    filters?: {
-        freeCancellation?: boolean;
-    };
+    searchId?: string;
+    cugDeals?: CugDeals;
+    isAnchor?: boolean;
+    getAllOffers?: boolean;
+    originId?: string;
+    freeCancellation?: boolean;
     preferredRate?: number;
     trafficSource?: string;
 }
-export interface OffersResponse {
-    anchorHotelOfferEntity?: HotelOfferEntity;
-    hotelOfferEntities?: HotelOfferEntity[];
-}
-export interface OffersClient {
-    getOffers: (parameters: GetOffersParameters, onOffersReceived?: (response: OffersResponse) => void) => Promise<OffersResponse>;
-}
-interface MappingContext {
-    checkIn: string;
-    checkOut: string;
-    includeTaxes?: boolean;
-    includeLocalTaxes?: boolean;
-}
-export declare function sapiResponseToHotelOfferEntity(offerEntity: SapiResponseOfferEntity, context: MappingContext): HotelOfferEntity;
-interface ApiConfig {
-    baseUrl: string;
-    endpoints: {
-        offers: string;
-    };
-}
-export declare function offers(config: ApiConfig, options: Options): {
-    getOffers: (parameters: GetOffersParameters, onOffersReceived?: ((response: OffersResponse) => void) | undefined) => Promise<OffersResponse>;
-};
+interface Callbacks {
+    onStart?: (parameters: GetOffersParameters) => void;
+    onOffersReceived?: (response: HotelOfferEntity | undefined) => void;
+    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;
+/**
+ * Creates offers function with configuration object
+ *
+ * @param configuration - Configuration for offers initialisation
+ *
+ * @returns function for fetching offers
+ */
+export declare function offers({ offersClient, options, appConfig }: Pick<BaseWithConfig, 'offersClient' | 'options' | 'appConfig'>): OffersHandler;
 export {};

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

@@ -1,6 +1,6 @@
 import { SearchClient } from 'algoliasearch';
 import { Except } from 'type-fest';
-import { OffersClient } from './offers';
+import { OffersClient } from './offers-client';
 import { Configs } from './algolia';
 import { AppConfig, Features } from './app-config';
 import { ProfileKey, ClientOptions, SapiClient, Language, Logger } from './types';

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

@@ -6,6 +6,7 @@ export interface RoomsRequestParameters {
     rooms: string;
     providerCode?: string;
     cugDeals?: string;
+    clickedOfferId?: string;
 }
 export interface RoomsRequestOptions {
     deviceType: DeviceType;

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

@@ -6,6 +6,7 @@ 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 {
     name: string;
@@ -19,6 +20,7 @@ export interface SapiClient {
     search: SearchHandler;
     suggest: SuggestHandler;
     hotel: HotelHandler;
+    offers: OffersHandler;
 }
 /** 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

@@ -52,7 +52,6 @@ export interface OptionalSearchParameters {
     cugDeals?: CugDeals;
     originId?: string;
     searchId?: string;
-    useAlternativeRaaKeys?: boolean;
     skipGeoSearch?: boolean;
     preferredRate?: number;
     trafficSource?: string;

package/dist/types/packages/core/src/utils/build-offers-response.d.ts

@@ -0,0 +1,21 @@
+import { OffersResponse } from '../offers-client';
+import { HotelOfferEntity, Offer } from '../types';
+interface Parameters {
+    sortField?: string;
+    sortOrder?: string;
+    filters?: {
+        priceMin?: number;
+        priceMax?: number;
+    };
+    priceBucketWidth?: number;
+    priceBucketsCount: number;
+    exchangeRate: number;
+    variations?: string[];
+}
+export declare function isOfferInPriceRange(offer: Offer, upperBound: number, priceMin?: number, priceMax?: number): boolean;
+export declare function applyPriceFilter(parameters: Parameters, hotelOfferEntity: HotelOfferEntity): HotelOfferEntity;
+export declare function buildOffersResponse(offersResults: OffersResponse, parameters: Parameters): {
+    hotelIds: string[];
+    hotelOfferEntities: Record<string, HotelOfferEntity>;
+};
+export {};

package/dist/types/packages/core/src/utils/build-offers-response.test.d.ts

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

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

@@ -7,3 +7,5 @@ export * from './state';
 export * from './search-id';
 export * from './regular-price';
 export * from './remove-empty';
+export * from './sorting-boosts';
+export * from './build-offers-response';

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

@@ -1,9 +1,9 @@
-import { AnonymousId, ApiSearchParameters } from '../types';
+import { AnonymousId, ApiSearchParameters, Country, Currency, Language } from '../types';
 interface SearchIdOptions {
     anonymousId: AnonymousId;
-    language: string;
-    currency: string;
-    countryCode: string;
+    language: Language;
+    currency: Currency;
+    countryCode: Country;
 }
 /**
  * Generates a deterministic hash of a combination of ApiSearchParameters and SAPI options.

package/dist/types/packages/core/src/utils/sorting-boosts.d.ts

@@ -0,0 +1,11 @@
+export interface SortingBoostParameters {
+    filters?: {
+        freeCancellation?: boolean;
+    };
+}
+/**
+ * Generates sorting boost for offers request
+ *
+ * @param parameters - SortingBoostParameters
+ */
+export declare function generateSortingBoost(parameters: SortingBoostParameters): "freeCancellation=true:100" | undefined;

package/dist/types/packages/core/src/utils/sorting-boosts.test.d.ts

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

package/package.json

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

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

@@ -1,2 +0,0 @@
-export * from './raa';
-export * from './utils';

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

@@ -1,45 +0,0 @@
-import { CugDeals, HotelId, HotelOfferEntity, Logger } from '../types';
-export interface OffersClient {
-    getOffers: GetOffers;
-}
-interface RaaOptions {
-    anonymousId: string;
-    currency: string;
-    countryCode: string;
-    language: string;
-    includeLocalTaxes?: boolean;
-    includeTaxes?: boolean;
-    skipBackendAugmentation?: boolean;
-    facetsEnabled?: boolean;
-    WebSocket?: any;
-    sapiCliKey?: string;
-    deviceType: string;
-    variations: string[];
-    logger: Logger;
-}
-export interface GetOffersParameters {
-    anchorHotelId?: HotelId;
-    hotelIds?: HotelId[];
-    cugDeals?: CugDeals;
-    getAllOffers?: boolean;
-    originId?: string;
-    useAlternativeRaaKeys?: boolean;
-    checkIn: string;
-    checkOut: string;
-    rooms: string;
-    searchId: string;
-    filters?: {
-        freeCancellation?: boolean;
-    };
-    preferredRate?: number;
-    trafficSource?: string;
-}
-export interface OffersResponse {
-    anchorHotelOfferEntity?: HotelOfferEntity;
-    hotelOfferEntities?: HotelOfferEntity[];
-}
-declare type GetOffers = (parameters: GetOffersParameters, onOffersReceived?: (response: OffersResponse) => void) => Promise<OffersResponse>;
-export declare function raa(raaEndpoint: string, options: RaaOptions): {
-    getOffers: (parameters: GetOffersParameters, onOffersReceived?: ((response: OffersResponse) => void) | undefined) => Promise<OffersResponse>;
-};
-export {};

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

@@ -1,36 +0,0 @@
-import { OffersResponse } from './raa';
-import { HotelOfferEntity, Offer, TopOfferData, AnchorPriceRateBreakdown } from '../types';
-interface Parameters {
-    sortField?: string;
-    sortOrder?: string;
-    filters?: {
-        priceMin?: number;
-        priceMax?: number;
-    };
-    priceBucketWidth?: number;
-    priceBucketsCount: number;
-    exchangeRate: number;
-    variations?: string[];
-}
-interface SortingBoostParameters {
-    filters?: {
-        freeCancellation?: boolean;
-    };
-}
-export declare function generateSortingBoost(parameters: SortingBoostParameters): "freeCancellation=true:100" | undefined;
-export declare function isOfferInPriceRange(offer: Offer, upperBound: number, priceMin?: number, priceMax?: number): boolean;
-export declare function applyPriceFilter(parameters: Parameters, hotelOfferEntity: HotelOfferEntity): HotelOfferEntity;
-interface TopOfferDataWithAnchorPriceParameters {
-    topOfferData: TopOfferData;
-    anchorPriceRateBreakdown: AnchorPriceRateBreakdown;
-}
-export declare function augmentTopOfferDataWithAnchorPrice({ topOfferData, anchorPriceRateBreakdown }: TopOfferDataWithAnchorPriceParameters): TopOfferData;
-export declare function augmentOffersWithAnchorPrice({ offers }: {
-    offers: Offer[];
-}, topOfferData: TopOfferData): Offer[];
-export declare function augmentHotelOffersWithAnchorPrice(hotelOfferEntity: HotelOfferEntity): HotelOfferEntity;
-export declare function augmentRaaResponse(offersResults: OffersResponse, parameters: Parameters): {
-    hotelIds: string[];
-    hotelOfferEntities: Record<string, HotelOfferEntity>;
-};
-export {};