@findhotel/sapi 1.0.0-beta.0 → 1.0.0

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

@@ -15,14 +15,6 @@ export interface RateBreakdown {
  * 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.
  */
@@ -48,7 +40,7 @@ export interface Offer {
     providerCode: string;
     rate: RateBreakdown;
     roomName?: string;
-    tags: OfferTags[] | null;
+    tags: string[] | null;
     url: string;
 }
 export interface Discount {

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

@@ -5,7 +5,7 @@ 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;
+export declare type GetTotalRate = (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 */
@@ -39,18 +39,18 @@ export interface ClientOptions {
     /** Websoket implementation */
     WebSocket?: WebSocket;
     /**
-     * Formula to calculate total display rate based on tax display logic.
+     * Function 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;
+    getTotalRate?: GetTotalRate;
 }
 /**
  * Adjusted options
  */
-export declare type Options = Except<ClientOptions, 'variations' | 'logger' | 'totalRateFormula'> & {
+export declare type Options = Except<ClientOptions, 'variations' | 'logger' | 'getTotalRate'> & {
     logger: Logger;
-    totalRateFormula: TotalRateFormula;
+    getTotalRate: GetTotalRate;
     variations: string[];
     pageSize: number;
     languages: Language[];

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

@@ -164,7 +164,10 @@ export interface HotelSuggestHit extends BasicSuggestHit {
     };
 }
 export declare type SuggestHit = HotelSuggestHit | PlaceSuggestHit;
-/** Search Hit */
+export interface DatelessProviderLink {
+    provider: string;
+    url: string;
+}
 export interface Hit {
     address: TranslatedString;
     checkInTime: string;
@@ -175,6 +178,7 @@ export interface Hit {
     guestType: GuestType;
     hotelName: TranslatedString;
     imageURIs: string[];
+    urls?: DatelessProviderLink[];
     isDeleted: boolean;
     lastBooked: number;
     objectID: string;

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

@@ -1,5 +1,5 @@
 import { OffersResponse } from '../offers-client';
-import { HotelOfferEntity, TotalRateFormula } from '../types';
+import { HotelOfferEntity, GetTotalRate } from '../types';
 interface Parameters {
     checkIn: string;
     checkOut: string;
@@ -12,7 +12,7 @@ interface Parameters {
     priceBucketWidth?: number;
     priceBucketsCount: number;
     exchangeRate: number;
-    totalRateFormula: TotalRateFormula;
+    getTotalRate: GetTotalRate;
 }
 export declare function isRateInPriceRange(rate: number, upperBound: number, priceMin?: number, priceMax?: number): boolean;
 export declare function applyPriceFilter(parameters: Parameters, hotelOfferEntity: HotelOfferEntity): HotelOfferEntity;

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

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

package/dist/types/packages/core/src/utils/{total-rate-formula.d.ts → get-total-rate.d.ts}

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

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

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

package/package.json

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