@revolugo/common 7.0.1 → 7.1.0

package/src/types/elements/hotel-offer-request.ts

@@ -2,6 +2,11 @@ import type { EventMetadata } from './event-metadata.ts'
 import type { SourceMarket } from './source-market.ts'
 
 export interface HotelOfferRequest {
+  /**
+   * id of the **Hotel Offer Request**
+   * @type {string}
+   */
+  id: string
   /**
    * This endpoint allows to find the geo-coordinates of a known address, place or locality via this free-text address query field. This address will eventually be geocoded into a latitude/longitude pair.
    *
@@ -29,6 +34,12 @@ export interface HotelOfferRequest {
    * @type {string}
    */
   children?: string | null
+  /**
+   * Date of the **Hotel Room Offer Request** creation
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  createdAt: string
   /**
    *
    * @type {EventMetadata}
@@ -60,20 +71,15 @@ export interface HotelOfferRequest {
    * @type {SourceMarket}
    */
   sourceMarket: SourceMarket
-  /**
-   * Date of the **Hotel Room Offer Request** creation
-   * @type {string}
-   * @memberof HotelOfferRequestApiResponse
-   */
-  createdAt: string
+}
+
+export interface HotelOfferRequestResponse {
   /**
    * id of the **Hotel Offer Request**
    * @type {string}
+   * @memberof HotelOfferRequestApiResponse
    */
   id: string
-}
-
-export interface HotelOfferRequestResponse {
   /**
    * This endpoint allows to find the geo-coordinates of a known address, place or locality via this free-text address query field. This address will eventually be geocoded into a latitude/longitude pair.
    *
@@ -106,6 +112,12 @@ export interface HotelOfferRequestResponse {
    * @memberof HotelOfferRequestApiResponse
    */
   children?: string | null
+  /**
+   * Date of the **Hotel Offer Request** creation
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  createdAt: string
   /**
    *
    * @type {EventMetadataApi}
@@ -142,18 +154,6 @@ export interface HotelOfferRequestResponse {
    * @memberof HotelOfferRequestApiResponse
    */
   sourceMarket: SourceMarket
-  /**
-   * Date of the **Hotel Offer Request** creation
-   * @type {string}
-   * @memberof HotelOfferRequestApiResponse
-   */
-  createdAt: string
-  /**
-   * id of the **Hotel Offer Request**
-   * @type {string}
-   * @memberof HotelOfferRequestApiResponse
-   */
-  id: string
 }
 
 export interface HotelOfferRequestCreate {

package/src/types/elements/hotel-offer.ts

@@ -9,6 +9,12 @@ import type { TravelTimeItem } from './travel-times.ts'
 import type { CurrencyCode } from '../../currencies/constants.ts'
 
 export interface HotelOffer {
+  /**
+   * Hotel id.
+   * @type {string}
+   * @memberof HotelOffer
+   */
+  id: string
   /**
    * Hotel address.
    * @type {string}
@@ -102,11 +108,11 @@ export interface HotelOffer {
    */
   hotelReviewRatings?: HotelReviewRating[] | null
   /**
-   * Hotel id.
-   * @type {string}
+   *
+   * @type {Array<HotelRoomOffer>}
    * @memberof HotelOffer
    */
-  id: string
+  hotelRoomOffers: HotelRoomOffer[]
   /**
    *
    * @type {HotelImages}
@@ -162,6 +168,12 @@ export interface HotelOffer {
    * @memberof HotelOffer
    */
   state?: string | null
+  /**
+   *
+   * @type {Array<Tag>}
+   * @memberof HotelOffer
+   */
+  tags?: Tag[]
   /**
    * TripAdvisor property id. When applicable.
    * @type {string}
@@ -186,18 +198,6 @@ export interface HotelOffer {
    * @memberof HotelOffer
    */
   website?: string | null
-  /**
-   *
-   * @type {Array<HotelRoomOffer>}
-   * @memberof HotelOffer
-   */
-  hotelRoomOffers: HotelRoomOffer[]
-  /**
-   *
-   * @type {Array<Tag>}
-   * @memberof HotelOffer
-   */
-  tags?: Tag[]
 }
 
 export enum HotelOffersSortByEnum {

package/src/types/elements/hotel-offers-filters.ts

@@ -9,9 +9,9 @@ export enum FilterName {
 }
 
 export interface HotelOffersFilters {
+  [FilterName.Price]: [number, number]
   [FilterName.Rating]: string
   [FilterName.ReviewRating]?: number
-  [FilterName.Price]: [number, number]
   [FilterName.SortBy]: {
     direction: HotelOffersSortByOrderType
     value: HotelOffersSortByEnum

package/src/types/elements/hotel-room-offer-request.ts

@@ -2,6 +2,12 @@ import type { EventMetadata } from './event-metadata.ts'
 import type { SourceMarket } from './source-market.ts'
 
 export interface HotelRoomOfferRequest {
+  /**
+   * id of the **Hotel Room Offer Request**
+   * @type {string}
+   * @memberof HotelRoomOfferRequest
+   */
+  id: string
   /**
    * Requested number of adult(s) to be accommodated.
    * @type {number}
@@ -26,6 +32,12 @@ export interface HotelRoomOfferRequest {
    * @memberof HotelRoomOfferRequest
    */
   children?: string | null
+  /**
+   * Date of the **Hotel Room Offer Request** creation
+   * @type {string}
+   * @memberof HotelRoomOfferRequest
+   */
+  createdAt: string
   /**
    *
    * @type {EventMetadata}
@@ -50,21 +62,15 @@ export interface HotelRoomOfferRequest {
    * @memberof HotelRoomOfferRequest
    */
   sourceMarket: SourceMarket
-  /**
-   * Date of the **Hotel Room Offer Request** creation
-   * @type {string}
-   * @memberof HotelRoomOfferRequest
-   */
-  createdAt: string
+}
+
+export interface HotelRoomOfferRequestResponse {
   /**
    * id of the **Hotel Room Offer Request**
    * @type {string}
-   * @memberof HotelRoomOfferRequest
+   * @memberof HotelRoomOfferRequestApiResponse
    */
   id: string
-}
-
-export interface HotelRoomOfferRequestResponse {
   /**
    * Requested number of adult(s) to be accommodated.
    * @type {number}
@@ -89,6 +95,12 @@ export interface HotelRoomOfferRequestResponse {
    * @memberof HotelRoomOfferRequestApiResponse
    */
   children?: string | null
+  /**
+   * Date of the **Hotel Room Offer Request** creation
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  createdAt: string
   /**
    *
    * @type {EventMetadataApi}
@@ -113,18 +125,6 @@ export interface HotelRoomOfferRequestResponse {
    * @memberof HotelRoomOfferRequestApiResponse
    */
   sourceMarket: SourceMarket
-  /**
-   * Date of the **Hotel Room Offer Request** creation
-   * @type {string}
-   * @memberof HotelRoomOfferRequestApiResponse
-   */
-  createdAt: string
-  /**
-   * id of the **Hotel Room Offer Request**
-   * @type {string}
-   * @memberof HotelRoomOfferRequestApiResponse
-   */
-  id: string
 }
 
 export type HotelRoomOfferRequestCreate = Pick<

package/src/types/elements/hotel-room-offer.ts

@@ -70,6 +70,12 @@ export interface HotelRoomOffersDataResponse {
  * @interface HotelRoomOffer
  */
 export interface HotelRoomOffer {
+  /**
+   * Hotel Room Offer id.
+   * @type {string}
+   * @memberof HotelRoomOffer
+   */
+  id?: string
   /**
    * Quantity of breakfast per night included in the given **Hotel Room Offer**
    * @type {number}
@@ -138,12 +144,6 @@ export interface HotelRoomOffer {
    * @memberof HotelRoomOffer
    */
   hotelRooms: HotelRoom[]
-  /**
-   * Hotel Room Offer id.
-   * @type {string}
-   * @memberof HotelRoomOffer
-   */
-  id?: string
   /**
    * An **Hotel Room Offer** of type **PACKAGE** can be of **4 types**, described by **package_type** parameter:
    *
@@ -157,7 +157,7 @@ export interface HotelRoomOffer {
    * @type {string}
    * @memberof HotelRoomOffer
    */
-  packageType?: HotelRoomOfferPackageType
+  packageType?: HotelRoomOfferPackageType | null
   /**
    * Price with taxes NOT INCLUDED of the given **Hotel Room Offer** including breakfast(s) when applicable, expressed in the requested **currency**.
    * @type {number}
@@ -172,18 +172,16 @@ export interface HotelRoomOffer {
   sourceMarket: SourceMarket
   /**
    *
-   * @type {Array<Tag>}
+   * @type {StayTaxesInfo}
    * @memberof HotelRoomOffer
    */
-  tags?: Tag[]
+  stayTaxesInfo: StayTaxesInfo
   /**
-   * Price of the given **Hotel Room Offer** including breakfast(s) when applicable, and including all taxes from returned **taxes** list parameter expressed in the requested **currency**.
    *
-   * This data is not returned for a **Hotel Room Offer** of type **HOTEL_ROOM**, you'll need to compute and display the actual tax included price of the final **Hotel Room** package corresponding to the guest count and night count requested, or make a call to the **[Create Hotel Room Offer](/v1/documentation#operation/postV1Hotel_room_offers)** endpoint in order to get a valid and bookable **Hotel Room Offer** where **type = PACKAGE** based on a packaged list of **Hotel Room Offers** of type **HOTEL_ROOM**.
-   * @type {number}
+   * @type {Array<Tag>}
    * @memberof HotelRoomOffer
    */
-  taxIncludedPrice: number
+  tags?: Tag[]
   /**
    *
    * @type {Array<Tax>}
@@ -192,11 +190,13 @@ export interface HotelRoomOffer {
   taxes?: Tax[]
 
   /**
+   * Price of the given **Hotel Room Offer** including breakfast(s) when applicable, and including all taxes from returned **taxes** list parameter expressed in the requested **currency**.
    *
-   * @type {StayTaxesInfo}
+   * This data is not returned for a **Hotel Room Offer** of type **HOTEL_ROOM**, you'll need to compute and display the actual tax included price of the final **Hotel Room** package corresponding to the guest count and night count requested, or make a call to the **[Create Hotel Room Offer](/v1/documentation#operation/postV1Hotel_room_offers)** endpoint in order to get a valid and bookable **Hotel Room Offer** where **type = PACKAGE** based on a packaged list of **Hotel Room Offers** of type **HOTEL_ROOM**.
+   * @type {number}
    * @memberof HotelRoomOffer
    */
-  stayTaxesInfo: StayTaxesInfo
+  taxIncludedPrice: number
 
   /**
    * Hotel Room Offer type.

package/src/types/elements/hotel-room.ts

@@ -2,6 +2,12 @@ import type { Bed } from './bed.ts'
 import type { HotelImage } from './hotel-image.ts'
 
 export interface HotelRoom {
+  /**
+   * Hotel Room id, when applicable.
+   * @type {string}
+   * @memberof HotelRoom
+   */
+  id: string
   /**
    * List of amenities in the room. May be subject to changes at the Hotel.
    * @type {Array<string>}
@@ -52,12 +58,6 @@ export interface HotelRoom {
    * @memberof HotelRoom
    */
   highresImages?: boolean | null
-  /**
-   * Hotel Room id, when applicable.
-   * @type {string}
-   * @memberof HotelRoom
-   */
-  id: string
   /**
    * List of indexes corresponding to image names for the given Hotel Room among the related hotel images.
    * @type {Array<number>}

package/src/types/elements/hotel-rooming-list.ts

@@ -6,16 +6,22 @@ export interface HotelRoomingListGuest {
    * @type {string}
    * @memberof HotelRoomingListGuest
    */
-  fullname: string
+  id: string
   /**
    *
    * @type {string}
    * @memberof HotelRoomingListGuest
    */
-  id: string
+  fullname: string
 }
 
 export interface HotelRoomingList {
+  /**
+   *
+   * @type {string}
+   * @memberof HotelRoomingList
+   */
+  id: string
   /**
    *
    * @type {HotelRoom}
@@ -34,12 +40,6 @@ export interface HotelRoomingList {
    * @memberof HotelRoomingList
    */
   hotelRoomingListGuests: HotelRoomingListGuest[]
-  /**
-   *
-   * @type {string}
-   * @memberof HotelRoomingList
-   */
-  id: string
   /**
    *
    * @type {string}

package/src/types/elements/hotel.ts

@@ -6,6 +6,12 @@ import type { HotelReviewRating } from './hotel-review-rating.ts'
 import type { TravelTimeItem } from './travel-times.ts'
 
 export interface Hotel {
+  /**
+   * Hotel id.
+   * @type {string}
+   * @memberof HotelApi
+   */
+  id: string
   /**
    * Hotel address.
    * @type {string}
@@ -96,12 +102,6 @@ export interface Hotel {
    * @memberof HotelApi
    */
   hotelReviewRatings?: HotelReviewRating[] | null
-  /**
-   * Hotel id.
-   * @type {string}
-   * @memberof HotelApi
-   */
-  id: string
   /**
    *
    * @type {HotelImages}

package/src/types/elements/meta-polling.ts

@@ -22,16 +22,16 @@ export interface MetaPollingResponse {
    * @memberof MetaApiPollingResponse
    */
   startingAfter?: string | null
-  /**
-   *
-   * @type {number}
-   * @memberof HotelOffersApiResponseMeta
-   */
-  totalCount?: number | null
   /**
    *
    * @type {PollerType}
    * @memberof MetaApiPollingResponse
    */
   status: PollerType
+  /**
+   *
+   * @type {number}
+   * @memberof HotelOffersApiResponseMeta
+   */
+  totalCount?: number | null
 }

package/src/types/event.ts

@@ -1,7 +1,7 @@
 export interface IEvent {
+  id: string
   eventDateFrom?: Date
   eventDateTo?: Date
-  id: string
   name: string
   slug: string
 }

package/src/types/hotel-contract.ts

@@ -1,13 +1,13 @@
 import type { IHotelRoomStock } from './hotel-room-stock.ts'
 
 export interface IHotelContract {
+  id: string
   createdAt: string
   forcedTotalComissionsAmount: number
   forcedTotalPurchasedAmount: number
   forcedTotalVatComissionsAmount: number
   hotelId: string
   hotelRoomStocks?: IHotelRoomStock[]
-  id: string
   name: string
   status: string
   updatedAt: string

package/src/types/hotel-room-stock.ts

@@ -1,6 +1,7 @@
 import type { BreakfastOption } from '../constants/hotel.ts'
 
 export interface IHotelRoomStock {
+  id?: string
   breakfastOption: BreakfastOption
   breakfastRetrocommission?: number
   breakfastUnitPrice?: number
@@ -9,7 +10,6 @@ export interface IHotelRoomStock {
   eventScoped: boolean
   hotelContractId?: string
   hotelRoomId: string
-  id?: string
   marginRate: number
   minNightCount?: number
   rate: number

package/src/types/pagination.ts

@@ -17,10 +17,10 @@ export interface IPaginationOptions {
 }
 
 export interface IPaginationPageInfo {
+  endCursor: string | null
   hasNextPage: boolean
   hasPreviousPage: boolean
   startCursor: string | null
-  endCursor: string | null
   totalCount: number
 }
 
@@ -30,8 +30,8 @@ export interface IPaginationEdge<T> {
 }
 
 export interface IPaginationConnection<T> {
-  pageInfo: IPaginationPageInfo
   edges: IPaginationEdge<T>[]
+  pageInfo: IPaginationPageInfo
 }
 
 export enum PaginationException {

package/src/utils/create-composite-key.ts

@@ -1,7 +1,7 @@
 interface CompositeLeafAttributes {
   excludedTokens?: string[]
-  removeSplitCharacters?: boolean
   parentKey?: string
+  removeSplitCharacters?: boolean
 }
 
 export enum CompositeAttributesType {
@@ -17,7 +17,6 @@ type CompositeKeyOptions<T> =
     ? CompositeKeyOptions<U>
     : CompositeLeafAttributes & {
         attributes: CompositeOmitAttributes<T> | CompositeAttributesType
-        sort?: (keyof T)[]
         children?: {
           [K in keyof T]?: NonNullable<T[K]> extends object
             ? CompositeKeyOptions<NonNullable<T[K]>>
@@ -25,6 +24,7 @@ type CompositeKeyOptions<T> =
               ? CompositeKeyOptions<U>
               : CompositeLeafAttributes
         }
+        sort?: (keyof T)[]
       }
 
 export function createCompositeKey<T>(

package/src/utils/debounce.ts

@@ -17,8 +17,8 @@ export interface DebouncedFunction<
 }
 
 interface DebouncedPromise<FunctionReturn> {
-  resolve: (result: FunctionReturn) => void
   reject: (reason?: any) => void
+  resolve: (result: FunctionReturn) => void
 }
 
 export function debounce<Args extends any[], F extends (...args: Args) => any>(

package/src/utils/generate-dummy-hotel-images.ts

@@ -4,12 +4,14 @@ import { getRandomInt } from './get-random-int.ts'
 import type { HotelImage } from '../types/index.ts'
 
 export function generateDummyHotelImages(): HotelImage {
+  const bgColor = getRandomHexColor()
+  const fontColor = getRandomHexColor()
   return {
     isHeroImage: false,
-    l: `https://dummyimage.com/${getRandomInt(300, 900)}x${getRandomInt(300, 900)}/${getRandomHexColor()}/${getRandomHexColor()}`,
-    m: `https://dummyimage.com/${getRandomInt(300, 900)}x${getRandomInt(300, 900)}/${getRandomHexColor()}/${getRandomHexColor()}`,
-    s: `https://dummyimage.com/${getRandomInt(300, 900)}x${getRandomInt(300, 900)}/${getRandomHexColor()}/${getRandomHexColor()}`,
-    xl: `https://dummyimage.com/${getRandomInt(300, 900)}x${getRandomInt(300, 900)}/${getRandomHexColor()}/${getRandomHexColor()}`,
-    xs: `https://dummyimage.com/${getRandomInt(300, 900)}x${getRandomInt(300, 900)}/${getRandomHexColor()}/${getRandomHexColor()}`,
+    l: `https://dummyimage.com/${getRandomInt(300, 900)}x${getRandomInt(300, 900)}/${bgColor}/${fontColor}`,
+    m: `https://dummyimage.com/${getRandomInt(300, 900)}x${getRandomInt(300, 900)}/${bgColor}/${fontColor}`,
+    s: `https://dummyimage.com/${getRandomInt(300, 900)}x${getRandomInt(300, 900)}/${bgColor}/${fontColor}`,
+    xl: `https://dummyimage.com/${getRandomInt(300, 900)}x${getRandomInt(300, 900)}/${bgColor}/${fontColor}`,
+    xs: `https://dummyimage.com/${getRandomInt(300, 900)}x${getRandomInt(300, 900)}/${bgColor}/${fontColor}`,
   }
 }

package/src/utils/get-sanitized-room-count.ts

@@ -6,8 +6,8 @@ export function getSanitizedRoomCount({
   roomCount,
 }: {
   adultCount: number
-  roomCount: number
   maxAdultsPerRoom?: number
+  roomCount: number
 }): number {
   // Ensure at least enough rooms for each adult and at most MAX_ADULTS_PER_ROOM per room
   if (!Number.isFinite(roomCount) || roomCount < 1) {

package/src/utils/images.ts

@@ -56,3 +56,8 @@ export const mapImagesUrls = (
 
   return null
 }
+
+export const getImageUrls = (
+  hotelImages: HotelImage[],
+  size: ImageSize,
+): string[] => hotelImages.map(hotelImage => hotelImage[size])

package/src/utils/parse-children.ts

@@ -1,5 +1,5 @@
 export function parseChildren(children: string | null | undefined): number[] {
   return ((children && children.split(',')) || []).map(child =>
-    Number.parseInt(child),
+    Number.parseInt(child, 10),
   )
 }