@findhotel/sapi 0.26.6 → 1.0.0-beta.0

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

@@ -1,47 +1,77 @@
-export declare const offer: {
+export declare const offer1: {
+    accessTier: null;
     availableRooms: number;
-    bookURI: string;
-    calculatedTotalRate: number;
-    canPayLater: boolean;
-    cug: null;
+    cancellationPenalties: never[];
     currency: string;
-    hasAnchorPrice: boolean;
-    hasFreeCancellation: boolean;
     id: string;
-    integrationType: string;
-    isAnchorPriceOffer: boolean;
-    isCheapest: boolean;
-    isSharedRoom: boolean;
-    isTopOffer: boolean;
-    meals: never[];
-    nightlyRate: number;
+    intermediaryProvider: string;
+    metadata: {
+        feedID: string;
+    };
+    package: {
+        amenities: string[];
+        canPayLater: boolean;
+    };
     providerCode: string;
-    providerHotelId: string;
-    proxyProviderCode: string;
-    rateBasedOnNumberOfRooms: null;
-    rateBreakdown: {
-        baseRate: number;
+    rate: {
+        base: number;
         taxes: number;
-        localTaxes: number;
+        hotelFees: number;
     };
+    roomName: string;
+    tags: string[];
+    url: string;
 };
-export declare const topOffersData: {
-    offerIndexes: number[];
-};
-export declare const topOffersDataWithAnchorPrice: {
-    anchorPrice: number;
-    anchorPriceNightly: number;
-    offerIndexes: number[];
+export declare const offer2: {
+    accessTier: null;
+    availableRooms: number;
+    cancellationPenalties: never[];
+    currency: string;
+    id: string;
+    intermediaryProvider: string;
+    metadata: {
+        feedID: string;
+    };
+    package: {
+        amenities: string[];
+        canPayLater: boolean;
+    };
+    providerCode: string;
+    rate: {
+        base: number;
+        taxes: number;
+        hotelFees: number;
+    };
+    roomName: string;
+    tags: string[];
+    url: string;
 };
-export declare const topOffersDataWithAnchorPriceNotMatchedRules: {
-    anchorPrice: number;
-    anchorPriceNightly: number;
-    offerIndexes: number[];
+export declare const offer3: {
+    accessTier: null;
+    availableRooms: number;
+    cancellationPenalties: never[];
+    currency: string;
+    id: string;
+    intermediaryProvider: string;
+    metadata: {
+        feedID: string;
+    };
+    package: {
+        amenities: string[];
+        canPayLater: boolean;
+    };
+    providerCode: string;
+    rate: {
+        base: number;
+        taxes: number;
+        hotelFees: number;
+    };
+    roomName: string;
+    tags: string[];
+    url: string;
 };
 export declare const anchorPriceRateBreakdown: {
-    baseRate: number;
-    calculatedTotalRate: number;
-    localTaxes: number;
-    nightlyRate: number;
+    base: number;
+    hotelFees: number;
     taxes: number;
 };

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

@@ -1,4 +1,4 @@
-import { CugDeals, HotelId, HotelOfferEntity, Currency, RoomId, Meals, Options as ClientOptions, UserTier, Discount } from './types';
+import { CugDeals, HotelId, HotelOfferEntity, Currency, RoomId, Amenities, Options as ClientOptions, UserTier, Discount } from './types';
 interface V3RateBreakdown {
     base: number;
     hotelFees: number;
@@ -10,7 +10,6 @@ interface CancellationPenalty {
     end: string;
     start: string;
 }
-declare type Amenities = Meals & 'internetIncluded';
 declare type OfferTag = 'top_offer' | 'anchor_price' | 'exclusive_cheapest_offer';
 interface SapiResponseOffer {
     accessTier: string;
@@ -40,8 +39,6 @@ declare type Rooms = Record<RoomId, {
 export interface SapiResponseOfferEntity {
     anchorRate: V3RateBreakdown;
     availableOffersCount: number;
-    fetchedAllOffers: boolean;
-    hasMoreOffers: boolean;
     id: HotelId;
     offers: SapiResponseOffer[];
     rooms: Rooms;
@@ -71,21 +68,14 @@ export interface OffersResponse {
 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 {
+export declare function sapiResponseToHotelOfferEntity(offerEntity: SapiResponseOfferEntity): HotelOfferEntity;
+interface Config {
     baseUrl: string;
     endpoints: {
         offers: string;
     };
 }
-export declare function offersClient(config: ApiConfig, options: ClientOptions): {
+export declare function offersClient(config: Config, options: ClientOptions): {
     getOffers: (parameters: GetOffersParameters, onOffersReceived?: ((response: OffersResponse) => void) | undefined) => Promise<OffersResponse>;
 };
 export {};

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

@@ -1,25 +1,8 @@
 import { Except } from 'type-fest';
-import { DealScores, DatesConfig } from './utils';
+import { DatesConfig } from './utils';
 import { OffersClient } from './offers-client';
 import { AppConfig, ProfileKey, Features } from './app-config';
-import { SearchParameters, HotelId, Hotel, Anchor, ApiSearchParameters, HotelOfferEntity, AnchorType, Facets, Options as ClientOptions } from './types';
-export interface SearchResults {
-    anchor: Anchor;
-    anchorHotelId?: HotelId;
-    anchorType: AnchorType;
-    hotelEntities: Record<HotelId, Hotel>;
-    hotelOfferEntities: Record<HotelId, HotelOfferEntity>;
-    hotelIds: HotelId[];
-    searchParameters: ApiSearchParameters | SearchParameters;
-    searchId: string;
-    hotelsHaveStaticPosition: boolean;
-    facets: Facets;
-    resultsCount: number;
-    resultsCountTotal: number;
-    offset: number;
-    dealScores: DealScores;
-    hasMoreResults: boolean;
-}
+import { SearchResults, HotelId, ApiSearchParameters, HotelOfferEntity, Options as ClientOptions } from './types';
 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;

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

@@ -1,6 +1,8 @@
 export * from './types';
 export * from './rooms';
+export * from './offers';
 export * from './options';
 export * from './config';
 export * from './logger';
 export * from './errors';
+export * from './search';

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

@@ -0,0 +1,74 @@
+import { CancellationPenalties, Currency } from './types';
+/**
+ * Object contains details about the price of the Offer, the rate is divided into 3 attributes:
+ *
+ * base: The rate charged by the hotel without considering extra taxes and other fees. \
+ * hotelFees: The sum of all other charges, like resort fee. \
+ * taxes: The sum of all taxes applied to the offer.
+ */
+export interface RateBreakdown {
+    base: number;
+    hotelFees: number;
+    taxes: number;
+}
+/**
+ * Available amenities within the offer
+ */
+export declare type Amenities = 'allInclusive' | 'breakfast' | 'partialBreakfast' | 'lunch' | 'dinner' | 'fullBoard' | 'halfBoard' | 'meals' | 'internetIncluded';
+/**
+ * Tag is an attribute that annotates the offer indicating a particular characteristic
+ *
+ * "top_offer" - is offer a top offer \
+ * "anchor_price" - offer is an anchor price offer \
+ * "exclusive_cheapest_offer" - offer is the cheapest offer amoun others
+ */
+export declare type OfferTags = 'top_offer' | 'anchor_price' | 'exclusive_cheapest_offer';
+/**
+ * Attribute indicating the minimum tier the user should be in order to be able to book this offer.
+ */
+export declare type AccessTier = string;
+/**
+ * Hotel's offer
+ */
+export interface Offer {
+    accessTier: AccessTier;
+    availableRooms: number;
+    cancellationPenalties: CancellationPenalties[];
+    currency: Currency;
+    id: string;
+    intermediaryProvider: string;
+    metadata: {
+        feedID: string;
+        providerRateType?: string;
+    };
+    package: {
+        amenities: Amenities[];
+        canPayLater: boolean;
+    };
+    providerCode: string;
+    rate: RateBreakdown;
+    roomName?: string;
+    tags: OfferTags[] | null;
+    url: string;
+}
+export interface Discount {
+    modifier: string;
+    hasParityProvider: boolean;
+    hasDiscountProvider: boolean;
+    discountProvider: string;
+}
+/**
+ * Hotel offer entity contains offers array as well as  meta information about offers and hotel
+ */
+export interface HotelOfferEntity {
+    /** Available offers count for the requested itinerary */
+    availableOffersCount: number;
+    /** The rate of the offer tagged as anchor price offer */
+    anchorRate: RateBreakdown;
+    /** Discount - meta information used in analytics */
+    discount?: Discount;
+    /** Id of the requested hotel */
+    id: string;
+    /** Hotel's offers */
+    offers: Offer[];
+}

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

@@ -4,6 +4,8 @@ import { AppConfig } from '../app-config';
 import { Configs } from './config';
 import { AnonymousId, Language, Currency, Country, DeviceType, Brand } from './types';
 import { Logger } from './logger';
+import { RateBreakdown } from './offers';
+export declare type TotalRateFormula = (rate: RateBreakdown) => number;
 /** Options for initializing the Search API client. Persistent within single SAPI instance but may vary for different users */
 export interface ClientOptions {
     /** Unique ID identifying users */
@@ -12,18 +14,10 @@ export interface ClientOptions {
     language: Language;
     /** Currency code for selected user currency */
     currency: Currency;
-    /** @deprecated since 0.23.0 use countryCode instead */
-    userCountry?: Country;
-    /** Country code for selected user origin userCountry */
+    /** Country code for selected user origin country */
     countryCode: Country;
     /** Displayed page size */
     pageSize?: number;
-    /** Include or not local taxes based on localisation logic */
-    includeLocalTaxes?: boolean;
-    /** Include or not taxes based on localisation logic */
-    includeTaxes?: boolean;
-    /** @deprecated since 0.23.0 use deviceType instead */
-    deviceCategory?: DeviceType;
     /** User's device type */
     deviceType: DeviceType;
     /** Used to identify SAPI Cli interface on the RAA backend */
@@ -44,12 +38,19 @@ export interface ClientOptions {
     };
     /** Websoket implementation */
     WebSocket?: WebSocket;
+    /**
+     * Formula to calculate total display rate based on tax display logic.
+     * If not provided SAPI will use rate including all taxes and fees.
+     * Used for price filter and sort by price functionalities.
+     */
+    totalRateFormula?: TotalRateFormula;
 }
 /**
  * Adjusted options
  */
-export declare type Options = Except<ClientOptions, 'variations' | 'logger'> & {
+export declare type Options = Except<ClientOptions, 'variations' | 'logger' | 'totalRateFormula'> & {
     logger: Logger;
+    totalRateFormula: TotalRateFormula;
     variations: string[];
     pageSize: number;
     languages: Language[];

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

@@ -1,4 +1,4 @@
-import { HotelId, AnonymousId, Currency, RoomId, UserTier } from './types';
+import { HotelId, AnonymousId, Currency, RoomId, UserTier, CancellationPenalties } from './types';
 export interface RoomsRequestParameters {
     hotelId: HotelId;
     checkIn: string;
@@ -15,12 +15,6 @@ export interface RoomsRequestParameters {
     trafficSource?: string;
 }
 export declare type RoomPackageId = string;
-export interface RoomCancellationPenalties {
-    start: string;
-    end: string;
-    amount: number;
-    currency: string;
-}
 export interface RoomLinks {
     href: string;
     method: 'GET' | 'POST';
@@ -54,7 +48,7 @@ export interface MatchedDim {
 export interface RoomOffer {
     id: string;
     availableRooms: number;
-    cancellationPenalties: RoomCancellationPenalties[];
+    cancellationPenalties: CancellationPenalties[];
     cug: string[];
     extraParams: unknown;
     links: RoomLinks[];

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

@@ -0,0 +1,18 @@
+import { HotelId, Anchor, AnchorType, Hotel, Facets, ApiSearchParameters, SearchParameters, DealScores } from './types';
+import { HotelOfferEntity } from './offers';
+export interface SearchResults {
+    anchor: Anchor;
+    anchorHotelId?: HotelId;
+    anchorType: AnchorType;
+    hotelEntities: Record<HotelId, Hotel>;
+    hotelOfferEntities: Record<HotelId, HotelOfferEntity>;
+    hotelIds: HotelId[];
+    searchParameters: ApiSearchParameters | SearchParameters;
+    searchId: string;
+    hotelsHaveStaticPosition: boolean;
+    facets: Facets;
+    resultsCount: number;
+    resultsCountTotal: number;
+    offset: number;
+    dealScores: DealScores;
+}

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

@@ -4,14 +4,36 @@
  * @default new UUID
  */
 export declare type AnonymousId = string;
+/**
+ * 3-char uppercased ISO currency code
+ */
 export declare type Currency = string;
+/**
+ * ISO language code
+ */
 export declare type Language = string;
+/**
+ * 2-char uppercased ISO country code
+ */
 export declare type Country = string;
 export declare type DateString = string;
 export declare type DeviceType = 'desktop' | 'mobile' | 'tablet';
 export declare type CugDeals = string[];
 export declare type UserTier = string;
 export declare type Brand = string;
+/**
+ * Cancellation penalties
+ * used to calculate the refund amount in case of a booking cancellation,
+ * reflecting the cancellation information that was informed to the customers when they made their reservation.
+ *
+ * https://engdocs.fih.io/engineering/cancellation_penalties/
+ */
+export interface CancellationPenalties {
+    amount: number;
+    currency: string;
+    end: string;
+    start: string;
+}
 /**
  * Search client types
  */
@@ -247,91 +269,5 @@ export interface Suggestion {
 }
 export declare type HotelId = Hotel['objectID'];
 export declare type RoomId = string;
-/**
- * RAA types
- */
-export interface RateBreakdown {
-    baseRate: number;
-    localTaxes: number;
-    taxes: number;
-}
-export interface AnchorPriceRateBreakdown extends RateBreakdown {
-    calculatedTotalRate: number;
-    nightlyRate: number;
-}
-export interface TopOfferData {
-    anchorPrice?: number;
-    anchorPriceNightly?: number;
-    offerIndexes: number[];
-}
-export declare type Meals = 'allInclusive' | 'breakfast' | 'partialBreakfast' | 'lunch' | 'dinner' | 'fullBoard' | 'halfBoard' | 'meals';
-export interface Offer {
-    additionalProviderParams: {
-        feedId: string;
-        rateType?: string;
-    };
-    id: string;
-    bookURI: string;
-    providerCode: string;
-    proxyProviderCode: string;
-    rateBreakdown: RateBreakdown;
-    nightlyRate: number;
-    calculatedTotalRate: number;
-    availableRooms: number;
-    cug: string[] | null;
-    currency: Currency;
-    meals: Meals[];
-    tags: string[];
-    canPayLater?: boolean;
-    hasAnchorPrice?: boolean;
-    hasFreeCancellation?: boolean;
-    integrationType?: string;
-    isAnchorPriceOffer?: boolean;
-    isCheapest?: boolean;
-    isSharedRoom?: boolean;
-    isTopOffer?: boolean;
-    packageID?: string;
-    providerHotelId?: string;
-    roomID?: string;
-    roomName?: string;
-    rateBasedOnNumberOfRooms?: number;
-    feedId?: string;
-    providerOfferId?: string;
-    rateType?: string;
-}
-export interface RaaResponseOffer {
-    availableOffersCount: number;
-    anchorPriceRateBreakdown?: AnchorPriceRateBreakdown;
-    cheapestPriceRateBreakdown?: RateBreakdown;
-    fetchedAllOffers: boolean;
-    hasMoreOffers: boolean;
-    id: string;
-    offers: Offer[];
-    topOfferData?: TopOfferData;
-    errors: Array<Record<string, number | string>>;
-}
-export interface HotelOfferEntity {
-    availableOffersCount: number;
-    anchorPriceRateBreakdown?: AnchorPriceRateBreakdown;
-    cheapestPriceRateBreakdown?: RateBreakdown;
-    fetchedAllOffers: boolean;
-    hasMoreOffers: boolean;
-    id: string;
-    offers: Offer[];
-    topOfferData?: TopOfferData;
-    discount?: Discount;
-}
-export interface Discount {
-    modifier: string;
-    hasParityProvider: boolean;
-    hasDiscountProvider: boolean;
-    discountProvider: string;
-}
-export interface RaaResponse {
-    errors: any[];
-    results: RaaResponseOffer[];
-    status: {
-        complete: boolean;
-    };
-}
+export declare type DealScores = Record<HotelId, number>;
 export {};

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

@@ -1,6 +1,8 @@
 import { OffersResponse } from '../offers-client';
-import { HotelOfferEntity, Offer } from '../types';
+import { HotelOfferEntity, TotalRateFormula } from '../types';
 interface Parameters {
+    checkIn: string;
+    checkOut: string;
     sortField?: string;
     sortOrder?: string;
     filters?: {
@@ -10,10 +12,11 @@ interface Parameters {
     priceBucketWidth?: number;
     priceBucketsCount: number;
     exchangeRate: number;
-    variations?: string[];
+    totalRateFormula: TotalRateFormula;
 }
-export declare function isOfferInPriceRange(offer: Offer, upperBound: number, priceMin?: number, priceMax?: number): boolean;
+export declare function isRateInPriceRange(rate: number, upperBound: number, priceMin?: number, priceMax?: number): boolean;
 export declare function applyPriceFilter(parameters: Parameters, hotelOfferEntity: HotelOfferEntity): HotelOfferEntity;
+export declare function applySort(hotelOfferEntity: HotelOfferEntity[], parameters: Parameters): HotelOfferEntity[];
 export declare function buildOffersResponse(offersResults: OffersResponse, parameters: Parameters): {
     hotelIds: string[];
     hotelOfferEntities: Record<string, HotelOfferEntity>;

package/dist/types/packages/core/src/utils/cheapest-rate.d.ts

@@ -1,7 +1,7 @@
-import { HotelOfferEntity } from '../types';
+import { HotelOfferEntity, TotalRateFormula } from '../types';
 /**
  * Returns cheapest display rate for provided hotel offer entity
  *
  * @param hotelOfferEntity
  */
-export declare function getCheapestRate(hotelOfferEntity: HotelOfferEntity): number | undefined;
+export declare function getCheapestRate(hotelOfferEntity: HotelOfferEntity, totalRateFormula: TotalRateFormula): number | undefined;

package/dist/types/packages/core/src/utils/deal-score.d.ts

@@ -1,5 +1,4 @@
-import { HotelId, HotelOfferEntity, Hotel } from '../types';
-export declare type DealScores = Record<HotelId, number>;
+import { HotelId, HotelOfferEntity, Hotel, DealScores, SearchParameters } from '../types';
 declare type DealScoreInput = [
     hotelId: HotelId,
     rate?: number,
@@ -20,6 +19,7 @@ export interface DealScoreParameters {
     hotelIds: HotelId[];
     hotelEntities: Record<HotelId, Hotel>;
     hotelOfferEntities: Record<HotelId, HotelOfferEntity>;
+    searchParameters: SearchParameters;
 }
 /**
  * Returns deal scores for provided hotels and offers
@@ -28,5 +28,5 @@ export interface DealScoreParameters {
  *
  * @returns DealScores - number in 0 to 1 range
  */
-export declare function getDealScores({ offset, anchorHotelId, hotelIds, hotelEntities, hotelOfferEntities, }: DealScoreParameters): DealScores;
+export declare function getDealScores({ offset, anchorHotelId, hotelIds, hotelEntities, hotelOfferEntities, searchParameters, }: DealScoreParameters): DealScores;
 export {};

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

@@ -11,3 +11,4 @@ export * from './sorting-boosts';
 export * from './build-offers-response';
 export * from './algolia';
 export * from './search-parameters';
+export * from './total-rate-formula';

package/dist/types/packages/core/src/utils/total-rate-formula.d.ts

@@ -0,0 +1,7 @@
+import { RateBreakdown } from '../types/offers';
+/**
+ * Deafault formula for calculating total rate
+ * @param rate - offer's rate breakdown
+ * @returns - total rate
+ */
+export declare function totalRateFormula(rate: RateBreakdown): number;

package/package.json

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