@findhotel/sapi 0.24.0 → 0.24.3

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

@@ -1,4 +1,4 @@
-import { ProfileKey, IndexVariation } from './types';
+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';
 export declare type Features = 'offers' | 'search' | 'suggests' | 'configs' | 'rooms' | 'get-hotel';
 export interface AppConfig {
     sapiBackend: {
@@ -20,11 +20,7 @@ export interface AppConfig {
     algolia: {
         appId: string;
         apiKey: string;
-        hotelIndex: string;
         autocompleteIndex: string;
-        lovIndex: string;
-        currencyIndex: string;
-        hsoIndex: IndexVariation[];
     };
     client: {
         defaultRooms: string;

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

@@ -1,5 +1,5 @@
-import { Base } from '.';
-import { Language, HotelId, TranslatedString, GuestRating, GuestType, Location, TranslatedArray, Pricing, ContentHotel, LOVItem, Currency } from './types';
+import { Language, HotelId, TranslatedString, GuestRating, GuestType, Location, TranslatedArray, Pricing, ContentHotel, LOVItem, Currency, Options as ClientOptions } from './types';
+import { AppConfig } from './app-config';
 export interface SafHotel {
     objectID: HotelId;
     _geoloc: Location;
@@ -50,6 +50,10 @@ export declare function safToSapiHotel(safHotel: SafHotel, languages: Language[]
  * @returns request string
  */
 export declare function createRequestString(hotelId: HotelId, languages: Language[]): string;
+export interface Parameters {
+    appConfig: AppConfig;
+    options: ClientOptions;
+}
 /**
  * Creates hotel function with binded in configuration object
  *
@@ -57,4 +61,4 @@ export declare function createRequestString(hotelId: HotelId, languages: Languag
  *
  * @returns function that asynchronously returns hotel's content by hotelId
  */
-export declare function hotel({ appConfig, options }: Pick<Base, 'options' | 'appConfig'>): HotelHandler;
+export declare function hotel({ appConfig, options }: Parameters): HotelHandler;

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

@@ -1,4 +1,3 @@
-import { sapi } from './sapi';
 export * from './sapi';
 export * from './types';
-export default sapi;
+export { sapi as default } from './sapi';

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

@@ -1,4 +1,4 @@
-import { CugDeals, HotelId, HotelOfferEntity, Brand, Currency, DeviceType, RoomId, Meals, Logger } from './types';
+import { CugDeals, HotelId, HotelOfferEntity, Currency, RoomId, Meals, Options as ClientOptions, UserTier } from './types';
 interface V3RateBreakdown {
     base: number;
     hotelFees: number;
@@ -49,26 +49,11 @@ export interface SapiResponseOfferEntity {
     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;
+    tier?: UserTier;
     getAllOffers?: boolean;
     originId?: string;
     checkIn: string;
@@ -102,7 +87,7 @@ interface ApiConfig {
         offers: string;
     };
 }
-export declare function offersClient(config: ApiConfig, options: Options): {
+export declare function offersClient(config: ApiConfig, options: ClientOptions): {
     getOffers: (parameters: GetOffersParameters, onOffersReceived?: ((response: OffersResponse) => void) | undefined) => Promise<OffersResponse>;
 };
 export {};

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

@@ -1,6 +1,5 @@
-import { Base } from '.';
-import { GetOffersParameters } from './offers-client';
-import { HotelId, HotelOfferEntity, CugDeals } from './types';
+import { OffersClient, GetOffersParameters } from './offers-client';
+import { HotelId, HotelOfferEntity, CugDeals, UserTier } from './types';
 import { AppConfig } from './app-config';
 interface OffersParameters {
     hotelId: HotelId;
@@ -9,6 +8,7 @@ interface OffersParameters {
     rooms: string;
     searchId?: string;
     cugDeals?: CugDeals;
+    tier?: UserTier;
     isAnchor?: boolean;
     getAllOffers?: boolean;
     originId?: string;
@@ -22,7 +22,11 @@ interface Callbacks {
     onComplete?: (response: HotelOfferEntity | undefined) => void;
 }
 export declare type OffersHandler = (parameters: OffersParameters, callbacks: Callbacks) => Promise<HotelOfferEntity | undefined>;
-export declare function getOffersParameters(parameters: OffersParameters, options: Base['options'], appConfig: AppConfig): GetOffersParameters;
+export declare function getOffersParameters(parameters: OffersParameters, appConfig: AppConfig): GetOffersParameters;
+export interface Parameters {
+    appConfig: AppConfig;
+    offersClient?: OffersClient;
+}
 /**
  * Creates offers function with configuration object
  *
@@ -30,5 +34,5 @@ export declare function getOffersParameters(parameters: OffersParameters, option
  *
  * @returns function for fetching offers
  */
-export declare function offers({ offersClient, options, appConfig }: Pick<Base, 'offersClient' | 'options' | 'appConfig'>): OffersHandler;
+export declare function offers({ offersClient, appConfig }: Parameters): OffersHandler;
 export {};

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

@@ -0,0 +1,4 @@
+/**
+ * Get sapi override parameter directly from the URL. Used only for debugging purposes.
+ */
+export declare function getSapiOverrideParameter(): string | null | undefined;

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

@@ -1,5 +1,5 @@
-import { Base } from '.';
-import { RoomsRequestParameters, RoomsRequestOptions, RoomsResults } from './types';
+import { RoomsRequestParameters, RoomsResults, Options as ClientOptions } from './types';
+import { AppConfig } from './app-config';
 export declare type RoomsHandler = (parameters: RoomsRequestParameters) => Promise<RoomsResults>;
 /**
  * Creates rooms request string.
@@ -30,7 +30,11 @@ export declare type RoomsHandler = (parameters: RoomsRequestParameters) => Promi
  * ```
  *
  */
-export declare function createRequestString(parameters: RoomsRequestParameters, options: RoomsRequestOptions): string;
+export declare function createRequestString(parameters: RoomsRequestParameters, options: ClientOptions): string;
+export interface Parameters {
+    appConfig: AppConfig;
+    options: ClientOptions;
+}
 /**
  * Creates rooms search function with binded base configuration object
  *
@@ -38,4 +42,4 @@ export declare function createRequestString(parameters: RoomsRequestParameters,
  *
  * @returns rooms search function
  */
-export declare function rooms({ appConfig, options }: Pick<Base, 'options' | 'appConfig'>): RoomsHandler;
+export declare function rooms({ appConfig, options }: Parameters): RoomsHandler;

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

@@ -1,30 +1,23 @@
-import { Except } from 'type-fest';
-import { OffersClient } from './offers-client';
-import { AppConfig, Features } from './app-config';
-import { ProfileKey, ClientOptions, SapiClient, Language, Logger } from './types';
-export interface Base {
-    /** SAPI client application config */
-    appConfig: AppConfig;
-    /** Check if SAPI feature is enabled */
-    getFeatureEnabled: (feature: Features) => boolean;
-    /** Instance of Offers Client */
-    offersClient?: OffersClient;
-    /** Profile key of specific client */
-    profileKey: ProfileKey;
-    /** Options persistent within single SAPI instance */
-    options: Except<ClientOptions, 'variations' | 'logger'> & {
-        logger: Logger;
-        variations: string[];
-        pageSize: number;
-        languages: Language[];
-    };
-}
+import { ProfileKey } from './app-config';
+import { SearchHandler } from './search';
+import { SuggestHandler } from './suggest';
+import { RoomsHandler } from './rooms';
+import { HotelHandler } from './hotel';
+import { OffersHandler } from './offers';
+import { ClientOptions } from './types';
 /**
  * Converts map of A/B tests variations to array of string
  *
  * @param variations - variations map
  */
 export declare function variationsToArray(variations?: Record<string, string>): string[];
+export interface SapiClient {
+    rooms: RoomsHandler;
+    search: SearchHandler;
+    suggest: SuggestHandler;
+    hotel: HotelHandler;
+    offers: OffersHandler;
+}
 /**
  * SAPI constructor
  *

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

@@ -1,8 +1,8 @@
 import { Except } from 'type-fest';
-import { Base, ProfileKey } from '.';
 import { DealScores, DatesConfig } from './utils';
-import { SearchParameters, HotelId, Hotel, Anchor, ApiSearchParameters, HotelOfferEntity, AnchorType, Facets } from './types';
-export declare type SearchFnParameters = Pick<Base, 'profileKey' | 'options' | 'appConfig' | 'offersClient' | 'getFeatureEnabled'>;
+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;
@@ -36,23 +36,30 @@ export declare type SearchHandler = (parameters: ApiSearchParameters, callbacks?
     loadMore: () => Promise<SearchResults>;
 }>;
 export declare function prepareSearchParameters(parameters: ApiSearchParameters, dates: DatesConfig): SearchParameters;
-declare type AttributesToRetrieve = keyof SearchResults;
-interface SearchRequestParameters {
+export declare type AttributesToRetrieve = keyof SearchResults;
+export interface SearchRequestParameters {
     searchId: string;
     profileKey: ProfileKey;
     searchParameters: SearchParameters;
-    options: Base['options'];
+    options: ClientOptions;
     offset: number;
     attributes?: AttributesToRetrieve[];
 }
-export declare function createSearchRequestString({ profileKey, searchId, searchParameters, options, offset, attributes }: SearchRequestParameters): string;
+export declare function createSearchRequestString({ profileKey, searchId, searchParameters, options, offset, attributes, }: SearchRequestParameters): string;
 interface AnchorRequestParameters {
     searchId: string;
     profileKey: ProfileKey;
     searchParameters: SearchParameters;
-    options: Base['options'];
+    options: ClientOptions;
     attributes?: AttributesToRetrieve[];
 }
-export declare function createAnchorRequestString({ profileKey, searchId, searchParameters, options, attributes }: AnchorRequestParameters): string;
-export declare function search({ getFeatureEnabled, profileKey, appConfig, offersClient, options }: SearchFnParameters): SearchHandler;
+export declare function createAnchorRequestString({ profileKey, searchId, searchParameters, options, attributes, }: AnchorRequestParameters): string;
+export interface Parameters {
+    appConfig: AppConfig;
+    profileKey: ProfileKey;
+    offersClient?: OffersClient;
+    getFeatureEnabled: (feature: Features) => boolean;
+    options: ClientOptions;
+}
+export declare function search({ getFeatureEnabled, profileKey, appConfig, offersClient, options, }: Parameters): SearchHandler;
 export {};

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

@@ -1,4 +1,9 @@
-import { Base } from '.';
-import { Suggestion } from './types';
+import { Suggestion, Options as ClientOptions } from './types';
+import { AppConfig } from './app-config';
+interface Parameters {
+    appConfig: AppConfig;
+    options: ClientOptions;
+}
 export declare type SuggestHandler = (query: string, suggestsCount?: number) => Promise<Suggestion[]>;
-export declare function suggest(base: Base): SuggestHandler;
+export declare function suggest({ appConfig, options }: Parameters): SuggestHandler;
+export {};

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

@@ -1,4 +1,5 @@
 export * from './types';
 export * from './rooms';
-export * from './sapi-client';
+export * from './options';
 export * from './config';
+export * from './logger';

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

@@ -0,0 +1,8 @@
+interface Event {
+    name: string;
+    value: any;
+}
+export interface Logger {
+    log: (event: Event) => void;
+}
+export {};

package/dist/types/packages/core/src/types/{sapi-client.d.ts → options.d.ts}

@@ -1,27 +1,9 @@
+import { Except } from 'type-fest';
 import { AlgoliaSearchOptions } from 'algoliasearch';
-import { AnonymousId, Language, Currency, Country, DeviceType, Brand } from './types';
-import { Configs } from './config';
 import { AppConfig } from '../app-config';
-import { SearchHandler } from '../search';
-import { RoomsHandler } from '../rooms';
-import { HotelHandler } from '../hotel';
-import { SuggestHandler } from '../suggest';
-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;
-    value: any;
-}
-export interface Logger {
-    log: (event: Event) => void;
-}
-export interface SapiClient {
-    rooms: RoomsHandler;
-    search: SearchHandler;
-    suggest: SuggestHandler;
-    hotel: HotelHandler;
-    offers: OffersHandler;
-}
+import { Configs } from './config';
+import { AnonymousId, Language, Currency, Country, DeviceType, Brand } from './types';
+import { Logger } from './logger';
 /** 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 */
@@ -60,5 +42,15 @@ export interface ClientOptions {
     callbacks?: {
         onConfigReceived?: (config: Pick<Configs, 'lov' | 'exchangeRates'>) => void;
     };
+    /** Websoket implementation */
+    WebSocket?: WebSocket;
 }
-export {};
+/**
+ * Adjusted options
+ */
+export declare type Options = Except<ClientOptions, 'variations' | 'logger'> & {
+    logger: Logger;
+    variations: string[];
+    pageSize: number;
+    languages: Language[];
+};

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

@@ -1,4 +1,4 @@
-import { HotelId, AnonymousId, Currency, Language, DeviceType, RoomId } from './types';
+import { HotelId, AnonymousId, Currency, RoomId, UserTier } from './types';
 export interface RoomsRequestParameters {
     hotelId: HotelId;
     checkIn: string;
@@ -6,15 +6,9 @@ export interface RoomsRequestParameters {
     rooms: string;
     providerCode?: string;
     cugDeals?: string;
+    tier?: UserTier;
     clickedOfferId?: string;
 }
-export interface RoomsRequestOptions {
-    deviceType: DeviceType;
-    language: Language;
-    currency: Currency;
-    anonymousId: AnonymousId;
-    variations: string[];
-}
 export declare type RoomPackageId = string;
 export interface RoomCancellationPenalties {
     start: string;
@@ -57,6 +51,7 @@ export interface RoomOffer {
     canPayLater: boolean;
     services: string[];
     isClicked?: boolean;
+    matchType?: 'exact' | 'partial';
 }
 export interface RoomImage {
     url: string;

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

@@ -1,8 +1,3 @@
-export interface IndexVariation {
-    name: string;
-    objectID?: string;
-    variationID?: string;
-}
 /**
  * Unique ID identifying users
  *
@@ -15,6 +10,7 @@ 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;
 /**
  * Search client types
@@ -50,6 +46,7 @@ export interface OptionalSearchParameters {
     boundingBox?: BoundingBox;
     polygon?: Polygon;
     cugDeals?: CugDeals;
+    tier?: UserTier;
     originId?: string;
     searchId?: string;
     skipGeoSearch?: boolean;

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

@@ -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, }: DealScoreParameters): DealScores;
 export {};

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

@@ -1,15 +1,4 @@
-import { AnonymousId, ApiSearchParameters, Country, Currency, Language } from '../types';
-interface SearchIdOptions {
-    anonymousId: AnonymousId;
-    language: Language;
-    currency: Currency;
-    countryCode: Country;
-}
 /**
- * Generates a deterministic hash of a combination of ApiSearchParameters and SAPI options.
- *
- * @param parameters all relevant search parameters to generate an id
- * @param options SAPI options used to generate an id
+ * Generates a random searchId string
  */
-export declare function generateSearchId(parameters: ApiSearchParameters, options: SearchIdOptions): string;
-export {};
+export declare function generateSearchId(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@findhotel/sapi",
-  "version": "0.24.0",
+  "version": "0.24.3",
   "description": "FindHotel Search API",
   "main": "dist/index.js",
   "types": "dist/types/packages/core/src",
@@ -18,17 +18,19 @@
     "lerna:bootstrap": "lerna bootstrap",
     "lerna:publish": "lerna publish",
     "test": "lerna run test",
-    "test:watch": "lerna run test:watch",
     "rollup": "rollup -c",
-    "rollup:watch": "npm run clean:dist && tsc --outDir dist/lib --declarationDir dist/types --declaration true --emitDeclarationOnly && rollup -c --watch",
     "typedoc": "lerna run typedoc",
     "typedoc:publish": " aws s3 cp packages/core/docs/ s3://fh-search/metrics/sapi/typedoc --recursive",
     "typescript": "tsc",
     "typescript:watch": "tsc --watch",
-    "install:all": "cd packages/core && npm install && cd ../playground && npm install && cd ../cli && npm install && cd ../../ && npm install",
-    "playground": "cd packages/playground && npm run dev",
+    "install:all": "cd packages/core && npm install && cd ../playground && npm install && cd ../cli && npm install && cd ../webclient && npm install && cd ../../ && npm install",
     "webclient:start": "cd packages/webclient && npm start",
     "webclient:build": "cd packages/core && npm install && cd ../../ npm run build && cd packages/webclient && npm run build",
+    "playground:start": "cd packages/playground && npm run dev",
+    "core:dev": "npm run clean:dist && tsc --outDir dist/lib --declarationDir dist/types --declaration true --emitDeclarationOnly && rollup -c --watch",
+    "core:test": "cd packages/core && npm run test",
+    "core:xo:report": "xo packages/core/src/*.{ts,js,json}",
+    "core:xo:fix": "xo packages/core/src/*.{ts,js,json} --fix",
     "release": "shipjs prepare"
   },
   "repository": {
@@ -45,23 +47,24 @@
     "@rollup/plugin-commonjs": "^16.0.0",
     "@rollup/plugin-node-resolve": "^10.0.0",
     "@rollup/plugin-typescript": "^6.1.0",
+    "@types/jest": "^28.1.6",
     "eslint-config-xo-react": "^0.23.0",
-    "eslint-plugin-jest": "^24.1.3",
-    "eslint-plugin-react": "^7.28.0",
-    "eslint-plugin-react-hooks": "^4.2.0",
+    "eslint-plugin-jest": "^26.6.0",
+    "eslint-plugin-react": "^7.30.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
     "husky": "^5.0.6",
-    "jest": "^26.6.3",
+    "jest": "^28.1.3",
     "lerna": "^4.0.0",
     "rollup": "^2.33.3",
     "rollup-plugin-cleanup": "^3.2.1",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-visualizer": "^5.5.0",
     "shipjs": "^0.24.3",
-    "ts-jest": "^26.4.4",
+    "ts-jest": "^28.0.7",
     "tslib": "^2.3.1",
     "type-fest": "^0.20.2",
     "typedoc": "^0.22.13",
     "typescript": "^4.1.2",
-    "xo": "^0.39.1"
+    "xo": "^0.50.0"
   }
 }