@findhotel/sapi 1.5.0 → 1.6.1

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

@@ -9,6 +9,7 @@ export interface AppConfig {
             offers: string;
             roomsOffers: string;
             addressSuggests: string;
+            availability: string;
         };
     };
     saf: {

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

@@ -0,0 +1,45 @@
+import { HotelId, Options, RateBreakdown, AvailabilitySearchParameters, AvailabilityResults, SapiResponseOffer, OffersRooms, AvailabilityDate } from './types';
+import { AppConfig } from './app-config';
+export declare type AvailabilityHandler = (parameters: AvailabilitySearchParameters, callbacks: {
+    onStart?: (result: AvailabilitySearchParameters) => void;
+    onAvailabilityReceived?: (result: AvailabilityResults) => void;
+    onComplete?: (result: AvailabilityResults) => void;
+}) => Promise<AvailabilityResults | undefined>;
+/**
+ * Sapi backend availability response
+ */
+export interface AvailabilityResponse {
+    availability: Record<HotelId, Record<AvailabilityDate, {
+        hotelID: HotelId;
+        cheapestRate: RateBreakdown;
+        offers: SapiResponseOffer[];
+        rooms: OffersRooms;
+    }>>;
+    status: {
+        complete: boolean;
+        nextToken: string;
+    };
+}
+/**
+ * Converts Sapi backend response to SDK result
+ *
+ * @param response - backend response
+ * @returns AvailabilityResults - SDK results
+ */
+export declare function responseToResults(response: AvailabilityResponse): AvailabilityResults;
+/**
+ * Creates availability request string
+ */
+export declare function createRequestString(parameters: AvailabilitySearchParameters, options: Options, nextToken?: string): string;
+export interface Parameters {
+    appConfig: AppConfig;
+    options: Options;
+}
+/**
+ * Creates hotel's availability function with configuration object
+ *
+ * @param configuration - Configuration for offers initialization
+ *
+ * @returns function for fetching hotel's availability
+ */
+export declare function hotelAvailability({ appConfig, options, }: Parameters): AvailabilityHandler;

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

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

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

@@ -1,61 +1,4 @@
-import { CugDeals, HotelId, HotelOfferEntity, Currency, RoomId, Amenities, Options as ClientOptions, UserTier, Discount, RateBreakdown } from './types';
-interface V3RateBreakdown {
-    base: number;
-    hotelFees: number;
-    taxes: number;
-}
-interface CancellationPenalty {
-    amount: number;
-    currency: string;
-    end: string;
-    start: string;
-}
-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;
-    };
-    providerCode: string;
-    rate: V3RateBreakdown;
-    roomID: RoomId;
-    tags: OfferTag[] | null;
-    url: string;
-}
-declare type Rooms = Record<RoomId, {
-    name: string;
-}>;
-interface SapiSplitBookingOffer {
-    offer: SapiResponseOffer;
-    checkIn: string;
-    checkOut: string;
-}
-interface SapiSplitBookingEntity {
-    offers: SapiSplitBookingOffer[];
-    tags?: string[];
-    totalRate: RateBreakdown;
-}
-export interface SapiResponseOfferEntity {
-    anchorRate: V3RateBreakdown;
-    availableOffersCount: number;
-    id: HotelId;
-    offers: SapiResponseOffer[];
-    rooms: Rooms;
-    discount?: Discount;
-    roomsConfig?: string;
-    splitBooking?: SapiSplitBookingEntity;
-}
+import { CugDeals, HotelId, HotelOfferEntity, Offer, Options as ClientOptions, UserTier, SapiResponseOffer, SapiResponseOfferEntity, OffersRooms } from './types';
 export interface GetOffersParameters {
     anchorHotelId?: HotelId;
     hotelIds?: HotelId[];
@@ -91,6 +34,7 @@ export interface OffersClient {
     getOffers: (parameters: GetOffersParameters, onOffersReceived?: (response: OffersResponse) => void) => Promise<OffersResponse>;
 }
 export declare function createRequest(parameters: GetOffersParameters, options: ClientOptions, clientRequestId: string): string | undefined;
+export declare function sapiResponseOfferToOffer(offer: SapiResponseOffer, rooms: OffersRooms): Offer;
 export declare function sapiResponseToHotelOfferEntity(offerEntity: SapiResponseOfferEntity): HotelOfferEntity;
 interface Config {
     baseUrl: string;

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

@@ -4,6 +4,7 @@ import { SuggestHandler } from './suggest';
 import { RoomsHandler } from './rooms';
 import { HotelHandler, HotelsHandler } from './hotel';
 import { OffersHandler } from './offers';
+import { AvailabilityHandler } from './hotel-availability';
 import { ClientOptions } from './types';
 /**
  * Converts map of A/B tests variations to array of string
@@ -22,6 +23,7 @@ export interface SapiClient {
     hotel: HotelHandler;
     hotels: HotelsHandler;
     offers: OffersHandler;
+    hotelAvailability: AvailabilityHandler;
 }
 /**
  * SAPI constructor

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

@@ -0,0 +1,31 @@
+import { HotelId, CugDeals, UserTier } from './types';
+import { Offer, RateBreakdown } from './offers';
+/**
+ * Availability search parameters
+ */
+export interface AvailabilitySearchParameters {
+    hotelIds: HotelId | HotelId[];
+    startDate: string;
+    endDate: string;
+    nights: number;
+    rooms: string;
+    cugDeals?: CugDeals;
+    tier?: UserTier;
+    originId?: string;
+}
+/**
+ * Availability entity
+ */
+export interface AvailabilityEntity {
+    hotelID: HotelId;
+    cheapestRate: RateBreakdown;
+    offers: Offer[];
+}
+/**
+ * The date of the availability calendar
+ */
+export declare type AvailabilityDate = string;
+/**
+ * Availability results
+ */
+export declare type AvailabilityResults = Record<HotelId, Record<AvailabilityDate, AvailabilityEntity>>;

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

@@ -6,3 +6,4 @@ export * from './config';
 export * from './logger';
 export * from './errors';
 export * from './search';
+export * from './availability';

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

@@ -1,4 +1,14 @@
-import { CancellationPenalties, Currency } from './types';
+import { CancellationPenalties, Currency, RoomId, HotelId } from './types';
+/**
+ * Offers rooms parameter
+ */
+export declare type OffersRooms = Record<RoomId, {
+    name: string;
+}>;
+/**
+ * Possible offer's tags
+ */
+export declare type OfferTag = 'top_offer' | 'anchor_price' | 'exclusive_cheapest_offer';
 /**
  * Object contains details about the price of the Offer, the rate is divided into 3 attributes:
  *
@@ -71,7 +81,7 @@ export interface HotelOfferEntity {
     /** Discount - meta information used in analytics */
     discount?: Discount;
     /** Id of the requested hotel */
-    id: string;
+    id: HotelId;
     /** Hotel's offers */
     offers: Offer[];
     /** Room configuration of the offers */
@@ -79,3 +89,52 @@ export interface HotelOfferEntity {
     /** Split booking offers */
     splitBooking?: SplitBookingEntity;
 }
+/**
+ * Sapi Backend offer type
+ */
+export interface SapiResponseOffer {
+    accessTier: string;
+    availableRooms: number;
+    cancellationPenalties: CancellationPenalties[];
+    currency: Currency;
+    id: string;
+    intermediaryProvider: string;
+    metadata: {
+        feedID: string;
+        providerRateType?: string;
+    };
+    occupancy: string | number | null;
+    package: {
+        amenities: Amenities[];
+        canPayLater: boolean;
+    };
+    providerCode: string;
+    rate: RateBreakdown;
+    roomID: RoomId;
+    tags: OfferTag[] | null;
+    url: string;
+}
+export interface SapiSplitBookingOffer {
+    offer: SapiResponseOffer;
+    checkIn: string;
+    checkOut: string;
+}
+interface SapiSplitBookingEntity {
+    offers: SapiSplitBookingOffer[];
+    tags?: string[];
+    totalRate: RateBreakdown;
+}
+/**
+ * Sapi Backend offer entity type
+ */
+export interface SapiResponseOfferEntity {
+    anchorRate: RateBreakdown;
+    availableOffersCount: number;
+    id: HotelId;
+    offers: SapiResponseOffer[];
+    rooms: OffersRooms;
+    discount?: Discount;
+    roomsConfig?: string;
+    splitBooking?: SapiSplitBookingEntity;
+}
+export {};

package/package.json

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