@findhotel/sapi 0.23.3 → 0.23.6

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

@@ -3,7 +3,7 @@ import { ProfileKey, IndexVariation } from './types';
  * Fixed number of price bucket count
  */
 export declare const PRICE_BUCKET_COUNT = 31;
-declare type Features = 'offers' | 'search' | 'suggests' | 'configs' | 'rooms';
+export declare type Features = 'offers' | 'search' | 'suggests' | 'configs' | 'rooms' | 'get-hotel';
 export interface AppConfig {
     daedalus: {
         raaEndpoint: string | undefined;
@@ -20,6 +20,7 @@ export interface AppConfig {
         endpoints: {
             offersRooms: string;
             search: string;
+            hotel: string;
         };
     };
     algolia: {
@@ -38,4 +39,3 @@ export interface AppConfig {
     };
 }
 export declare function getAppConfig(profileKey: ProfileKey, initWithAppConfig?: Partial<AppConfig>): AppConfig;
-export {};

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

@@ -1,5 +1,5 @@
 import { Base, ProfileKey } from '.';
-import { SearchResults, SearchFn, SearchFnParameters } from './search';
+import { SearchResults, SearchHandler, SearchFnParameters } from './search';
 import { SearchParameters } from './types';
 declare type AttributesToRetrieve = keyof SearchResults;
 interface RequestParameters {
@@ -10,5 +10,5 @@ interface RequestParameters {
     attributes?: AttributesToRetrieve[];
 }
 export declare function createRequestString({ profileKey, searchParameters, options, offset, attributes }: RequestParameters): string;
-export declare function backendSearch({ getFeatureEnabled, profileKey, appConfig, offersClient, options }: SearchFnParameters): SearchFn;
+export declare function backendSearch({ getFeatureEnabled, profileKey, appConfig, offersClient, options }: SearchFnParameters): SearchHandler;
 export {};

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

@@ -0,0 +1,57 @@
+import { BaseWithConfig } from '.';
+import { Language, HotelId, TranslatedString, GuestRating, GuestType, Location, TranslatedArray, Pricing, ContentHotel, LOVItem } from './types';
+export interface SafHotel {
+    objectID: HotelId;
+    _geoloc: Location;
+    hotelName: TranslatedString;
+    imageURIs: string[];
+    guestType: GuestType;
+    guestRating: GuestRating;
+    address?: TranslatedString;
+    isDeleted?: boolean;
+    updatedAt?: number;
+    propertyTypeId?: number;
+    starRating?: number;
+    feesOpt?: TranslatedString;
+    placeADName?: TranslatedArray;
+    checkInSpInst?: TranslatedString;
+    policies?: TranslatedString;
+    phone?: string;
+    checkInTime?: string;
+    placeDN?: TranslatedArray;
+    checkInInst?: TranslatedString;
+    checkInMinAge?: number;
+    reviewCount?: number;
+    chainID?: string;
+    checkInEnd?: string;
+    lastBooked?: number;
+    checkOutTime?: string;
+    themeIds?: number[];
+    feesMnd?: TranslatedString;
+    reviewCountBkt?: number;
+    placeID?: string;
+    pricing?: Pricing;
+    facilities?: LOVItem[];
+    themes?: LOVItem[];
+    propertyType?: LOVItem;
+    sentiments?: LOVItem[];
+}
+export declare type HotelHandler = (hotelId: HotelId) => Promise<ContentHotel>;
+export declare function safToSapiHotel(safHotel: SafHotel, languages: Language[]): ContentHotel;
+/**
+ * Creates hotel request string
+ *
+ * @param hotelId - Requested hotel id
+ * @param languages - list of languages with fallback
+ *
+ * @returns request string
+ */
+export declare function createRequestString(hotelId: HotelId, languages: Language[]): string;
+/**
+ * Creates hotel function with binded in configuration object
+ *
+ * @param configuration - Configuration for hotel function initialisation
+ *
+ * @returns function that asynchronously returns hotel's content by hotelId
+ */
+export declare function hotel({ appConfig, options }: Pick<BaseWithConfig, 'options' | 'appConfig'>): HotelHandler;

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

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

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

@@ -1,11 +1,11 @@
 import { BaseWithConfig } from '.';
 import { RoomsRequestParameters, RoomsRequestOptions, RoomsResults } from './types';
-export declare type RoomsFn = (parameters: RoomsRequestParameters) => Promise<RoomsResults>;
+export declare type RoomsHandler = (parameters: RoomsRequestParameters) => Promise<RoomsResults>;
 /**
  * Creates rooms request string.
  *
  * @param parameters - Rooms request parameters - dynamic parameters that change search
- * @param options - Rooms request options -  persistent within single SAPI instance
+ * @param options - Rooms request options - persistent within single SAPI instance
  *
  * @returns request string
  *
@@ -38,4 +38,4 @@ export declare function createRequestString(parameters: RoomsRequestParameters,
  *
  * @returns rooms search function
  */
-export declare function rooms({ appConfig, options }: Pick<BaseWithConfig, 'options' | 'appConfig'>): RoomsFn;
+export declare function rooms({ appConfig, options }: Pick<BaseWithConfig, 'options' | 'appConfig'>): RoomsHandler;

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

@@ -2,14 +2,14 @@ import { SearchClient } from 'algoliasearch';
 import { Except } from 'type-fest';
 import { OffersClient } from './raa';
 import { Configs } from './algolia';
-import { AppConfig } from './app-config';
-import { ProfileKey, ClientOptions, SapiClient, SapiFeature, Language, Logger } from './types';
+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: SapiFeature) => boolean;
+    getFeatureEnabled: (feature: Features) => boolean;
     /** Instance of Algolia Client */
     algoliaClient: AlgoliaClient;
     /** Instance of Offers Client */

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

@@ -31,7 +31,7 @@ interface Options {
     countryCode: string;
     pageSize: number;
 }
-export declare type SearchFn = (parameters: ApiSearchParameters, callbacks?: {
+export declare type SearchHandler = (parameters: ApiSearchParameters, callbacks?: {
     onStart?: OnStart;
     onAnchorReceived?: OnAnchorReceived;
     onHotelsReceived?: OnHotelsReceived;
@@ -44,5 +44,5 @@ export declare type SearchFn = (parameters: ApiSearchParameters, callbacks?: {
 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): SearchFn;
+export declare function search({ getFeatureEnabled, appConfig, algoliaClient, offersClient, options, configs }: SearchFnParameters): SearchHandler;
 export {};

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

@@ -1,4 +1,4 @@
 import { Base } from '.';
 import { Suggestion } from './types';
-export declare type SuggestFn = (query: string, suggestsCount?: number) => Promise<Suggestion[]>;
-export declare function suggest(base: Base): SuggestFn;
+export declare type SuggestHandler = (query: string, suggestsCount?: number) => Promise<Suggestion[]>;
+export declare function suggest(base: Base): SuggestHandler;

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

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

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

@@ -1,11 +1,12 @@
 import { AlgoliaSearchOptions } from 'algoliasearch';
 import { AnonymousId, Language, Currency, Country, DeviceType, Brand } from './types';
 import { AppConfig } from '../app-config';
-import { SearchFn } from '../search';
-import { RoomsFn } from '../rooms';
-import { SuggestFn } from '../suggest';
+import { SearchHandler } from '../search';
+import { RoomsHandler } from '../rooms';
+import { HotelHandler } from '../hotel';
+import { SuggestHandler } from '../suggest';
 import { Configs } from '../algolia';
-export declare type ProfileKey = 'findhotel-website' | 'findhotel-website-e2e' | 'findhotel-website-stg' | 'findhotel-website-ci' | 'findhotel-website-dev' | 'findhotel-checkout' | 'findhotel-checkout-e2e';
+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;
     value: any;
@@ -14,9 +15,10 @@ export interface Logger {
     log: (event: Event) => void;
 }
 export interface SapiClient {
-    rooms: RoomsFn;
-    search: SearchFn;
-    suggest: SuggestFn;
+    rooms: RoomsHandler;
+    search: SearchHandler;
+    suggest: SuggestHandler;
+    hotel: HotelHandler;
 }
 /** 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

@@ -1,3 +1,8 @@
+export interface IndexVariation {
+    name: string;
+    objectID?: string;
+    variationID?: string;
+}
 /**
  * Unique ID identifying users
  *
@@ -136,7 +141,7 @@ export interface HotelSuggestHit extends BasicSuggestHit {
     };
 }
 export declare type SuggestHit = HotelSuggestHit | PlaceSuggestHit;
-/** Hit */
+/** Search Hit */
 export interface Hit {
     address: TranslatedString;
     checkInTime: string;
@@ -163,12 +168,57 @@ export interface Hit {
 /**
  * Product
  */
+export interface LOVItem {
+    importance?: number;
+    categoryID?: number;
+    id: number;
+    value: TranslatedString;
+}
+export interface TranslatedLOVItem {
+    importance?: number;
+    categoryID?: number;
+    id: number;
+    value: string;
+}
 export interface Hotel extends Omit<Hit, 'hotelName' | 'address' | 'placeDN' | 'placeADName'> {
     displayAddress: string;
     hotelName: string;
     placeDisplayName: string;
     regularPriceRange?: [number, number];
 }
+export interface ContentHotel {
+    objectID: HotelId;
+    _geoloc: Location;
+    hotelName: string;
+    imageURIs: string[];
+    guestType: GuestType;
+    guestRating: GuestRating;
+    isDeleted?: boolean;
+    propertyTypeId?: number;
+    starRating?: number;
+    feesOpt?: string;
+    checkInSpInst?: string;
+    policies?: string;
+    phone?: string;
+    checkInTime?: string;
+    checkInInst?: string;
+    checkInMinAge?: number;
+    reviewCount?: number;
+    chainID?: string;
+    checkInEnd?: string;
+    lastBooked?: number;
+    checkOutTime?: string;
+    feesMnd?: string;
+    reviewCountBkt?: number;
+    placeID?: string;
+    pricing?: Pricing;
+    placeDisplayName?: string;
+    displayAddress?: string;
+    facilities?: TranslatedLOVItem[];
+    themes?: TranslatedLOVItem[];
+    propertyType?: TranslatedLOVItem;
+    sentiments?: TranslatedLOVItem[];
+}
 export interface HotelAnchor extends Omit<HotelAnchorHit, 'hotelName' | 'placeADN' | 'placeDN'> {
     placeDisplayName: string;
     hotelName: string;

package/package.json

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

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

@@ -1,27 +0,0 @@
-import { DateString, Language } from './types';
-export declare type SapiFeature = 'offers' | 'search' | 'rooms' | 'suggests' | 'configs';
-export interface IndexVariation {
-    name: string;
-    objectID?: string;
-    variationID?: string;
-}
-export interface Profile {
-    features: SapiFeature[];
-    blockedDefaultDates: DateString[];
-    daysFromNow: number;
-    fallbackLanguages: Record<Language, Language[]>;
-    hotelIndex: string;
-    autocompleteIndex: string;
-    lovIndex: string;
-    currencyIndex: string;
-    hsoIndex: IndexVariation[];
-    raa: {
-        endpoint?: string;
-    };
-    offers: {
-        endpoint: string;
-    };
-    algolia: {
-        apiKey: string;
-    };
-}