@revolugo/common 7.0.1 → 7.1.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revolugo/common",
-  "version": "7.0.1",
+  "version": "7.1.0-rc.0",
   "private": false,
   "description": "Revolugo common",
   "author": "Revolugo",
@@ -34,7 +34,7 @@
     "dayjs": "1.11.19",
     "ky": "1.14.3",
     "slugify": "1.6.6",
-    "type-fest": "5.4.3",
+    "type-fest": "5.4.4",
     "uuid": "13.0.0",
     "zod": "4.3.6"
   },

package/src/cancellation-policies.test.ts

@@ -238,7 +238,10 @@ describe('sanitizeCancellationPolicies', () => {
 
     describe('when Booking Date < Release Date < Check In Date', () => {
       const releaseDate = '2021-01-05'
-      const releaseDatetime = getFormattedUTCLocalTime(releaseDate, timezone)
+      const releaseDateCP = dayjs(releaseDate)
+        .add(1, 'day')
+        .format('YYYY-MM-DD')
+      const releaseDatetime = getFormattedUTCLocalTime(releaseDateCP, timezone)
       const bookingDatetime = getFormattedUTCLocalTime(
         '2021-01-01T10:00:00',
         timezone,
@@ -404,7 +407,10 @@ describe('sanitizeCancellationPolicies', () => {
 
     describe('when Booking Date < Release Date < DF_0', () => {
       const releaseDate = '2020-12-30'
-      const releaseDatetime = getFormattedUTCLocalTime(releaseDate, timezone)
+      const releaseDateCP = dayjs(releaseDate)
+        .add(1, 'day')
+        .format('YYYY-MM-DD')
+      const releaseDatetime = getFormattedUTCLocalTime(releaseDateCP, timezone)
       const bookingDatetime = getFormattedUTCLocalTime(
         '2020-12-20T10:00:00',
         timezone,

package/src/cancellation-policies.ts

@@ -34,6 +34,31 @@ export interface SanitizeCancellationPolicies {
   timezone?: string
 }
 
+function initReleaseDateUTC({
+  checkInDate,
+  releaseDate,
+  timezone,
+}: {
+  releaseDate?: string
+  timezone: string
+  checkInDate: string
+}): string | undefined {
+  if (!releaseDate) {
+    return undefined
+  }
+
+  if (dayjs(releaseDate).isSameOrAfter(dayjs(checkInDate))) {
+    return dayjs.tz(releaseDate, timezone).startOf('day').utc().format()
+  }
+
+  return dayjs
+    .tz(releaseDate, timezone)
+    .add(1, 'day')
+    .startOf('day')
+    .utc()
+    .format()
+}
+
 // eslint-disable-next-line complexity, max-statements, max-lines-per-function
 export function sanitizeCancellationPolicies({
   bookingDatetime,
@@ -62,8 +87,11 @@ export function sanitizeCancellationPolicies({
 
   const nextDayCheckInDateUTC = nextDay(checkInDatetimeUTC)
 
-  const releaseDatetimeUTC =
-    releaseDate && dayjs.tz(releaseDate, timezone).startOf('day').utc().format()
+  const releaseDatetimeUTC = initReleaseDateUTC({
+    checkInDate,
+    releaseDate,
+    timezone,
+  })
 
   if (dayjs(bookingDatetimeUTC).isAfter(nextDayCheckInDateUTC)) {
     return sanitizeCancellationPolicies({
@@ -452,10 +480,10 @@ export function getSanitizedCancellationPolicies({
   initialDate,
   timezone,
 }: {
-  checkInDate: string
   cancellationPolicies: ICancellationPolicy[]
-  timezone?: string
+  checkInDate: string
   initialDate?: string
+  timezone?: string
 }): ICancellationPolicy[] {
   if (!cancellationPolicies.length) {
     return []
@@ -511,3 +539,28 @@ export function isFreeCancellable(cps: ICancellationPolicy[]): boolean {
       dayjs().isBetween(dayjs(freeCp.dateFrom), dayjs(freeCp.dateTo)))
   )
 }
+
+export function filterForCustomers(
+  cps: ICancellationPolicy[],
+): ICancellationPolicy[] {
+  const now = dayjs()
+  const nowPlus2Hours = now.add(2, 'hours')
+
+  return cps.reduce<ICancellationPolicy[]>((result, cp) => {
+    if (
+      dayjs(cp.dateFrom).isSameOrBefore(nowPlus2Hours) &&
+      dayjs(cp.dateTo).isAfter(nowPlus2Hours)
+    ) {
+      result.push({
+        ...cp,
+        dateFrom: now.format(),
+      })
+    }
+
+    if (dayjs(cp.dateFrom).isAfter(nowPlus2Hours)) {
+      result.push(cp)
+    }
+
+    return result
+  }, [])
+}

package/src/currencies/types.ts

@@ -3,11 +3,11 @@ import type { CurrencyCode } from './constants.ts'
 export interface ICurrency {
   code: CurrencyCode
   decimalDigits: number
+  deprecated?: boolean
   name: string
   namePlural: string
   rounding: number
   symbol: string
   symbolNative: string
   zeroDecimal: boolean
-  deprecated?: boolean
 }

package/src/currencies/utils.ts

@@ -98,49 +98,50 @@ export class MoneyCalculator {
     this.isNormalized = isNormalized
   }
 
-  public denormalize(): this {
-    if (!this.isNormalized) {
+  public ceil(): this {
+    this.amount = Math.ceil(this.amount)
+
+    return this
+  }
+
+  public convert({
+    currency,
+    exchangeRate,
+  }: {
+    currency: CurrencyCode
+    exchangeRate: number
+  }): this {
+    if (this.currency === currency || this.amount === 0) {
       return this
     }
 
-    this.amount = denormalizeAmount({
-      amount: this.amount,
-      currency: this.currency,
-    })
+    const startingIsNormalized = this.isNormalized
 
-    this.isNormalized = false
+    if (startingIsNormalized) {
+      this.denormalize()
+    }
 
-    return this
-  }
+    this.amount *= exchangeRate
+    this.currency = currency
 
-  public markup(percentage: number): this {
-    this.amount /= 1 - percentage
+    if (startingIsNormalized) {
+      this.normalize()
+    }
 
     return this
   }
 
-  public normalize(): this {
-    if (this.isNormalized) {
+  public denormalize(): this {
+    if (!this.isNormalized) {
       return this
     }
 
-    this.amount = Number(
-      normalizeAmount({
-        // Making sure we only have 2 decimals after comma
-        amount: Number(this.amount.toFixed(2)),
-        currency: this.currency,
-        // Making sure Javascript doesnt give us back a float number
-        // 1172.64 * 100 = 117264.00000000001 💩
-      }).toFixed(0),
-    )
-
-    this.isNormalized = true
-
-    return this
-  }
+    this.amount = denormalizeAmount({
+      amount: this.amount,
+      currency: this.currency,
+    })
 
-  public ceil(): this {
-    this.amount = Math.ceil(this.amount)
+    this.isNormalized = false
 
     return this
   }
@@ -151,12 +152,6 @@ export class MoneyCalculator {
     return this
   }
 
-  public round(): this {
-    this.amount = Math.round(this.amount)
-
-    return this
-  }
-
   public format(locale?: string, space?: string): string {
     return formatAmount({
       amount: this.amount,
@@ -170,29 +165,34 @@ export class MoneyCalculator {
     return this.amount
   }
 
-  public convert({
-    currency,
-    exchangeRate,
-  }: {
-    exchangeRate: number
-    currency: CurrencyCode
-  }): this {
-    if (this.currency === currency || this.amount === 0) {
+  public markup(percentage: number): this {
+    this.amount /= 1 - percentage
+
+    return this
+  }
+
+  public normalize(): this {
+    if (this.isNormalized) {
       return this
     }
 
-    const startingIsNormalized = this.isNormalized
+    this.amount = Number(
+      normalizeAmount({
+        // Making sure we only have 2 decimals after comma
+        amount: Number(this.amount.toFixed(2)),
+        currency: this.currency,
+        // Making sure Javascript doesnt give us back a float number
+        // 1172.64 * 100 = 117264.00000000001 💩
+      }).toFixed(0),
+    )
 
-    if (startingIsNormalized) {
-      this.denormalize()
-    }
+    this.isNormalized = true
 
-    this.amount *= exchangeRate
-    this.currency = currency
+    return this
+  }
 
-    if (startingIsNormalized) {
-      this.normalize()
-    }
+  public round(): this {
+    this.amount = Math.round(this.amount)
 
     return this
   }

package/src/schemas/hotel-room-offer.ts

@@ -5,12 +5,14 @@ import {
   BreakfastOption,
   HotelRoomOfferType,
   PackageType,
+  StayTaxesInfoEnum,
 } from '../constants/index.ts'
 
 import { CANCELLATION_POLICY_SCHEMA } from './cancellation-policies.ts'
 import { CURRENCY_SCHEMA } from './currency.ts'
 import { SOURCE_MARKET_SCHEMA } from './hotel-offer-request.ts'
 import { HOTEL_ROOMS_SCHEMA } from './hotel-room.ts'
+import { LIST_POLLING_META_SCHEMA } from './list-polling-meta.ts'
 import { TAGS_SCHEMA } from './tag.ts'
 import { TAXES_SCHEMA } from './taxes.ts'
 
@@ -27,21 +29,17 @@ export const PACKAGE_TYPES_DESCRIPTION = `An **Hotel Room Offer** of type **${Ho
 
 export const HOTEL_ROOM_OFFER_SCHEMA = z
   .object({
-    breakfast_count: z.number().min(0).optional().nullish().openapi({
+    breakfast_count: z.number().min(0).nullish().openapi({
       description:
         'Quantity of breakfast per night included in the given **Hotel Room Offer**',
     }),
     breakfast_option: z.enum(BreakfastOption).openapi({
       description: BREAKFAST_OPTION_DESCRIPTION,
     }),
-    breakfast_price_per_guest_per_night: z
-      .number()
-      .optional()
-      .nullish()
-      .openapi({
-        description:
-          'Price of breakfast per guest per night for the given **Hotel Room Offer**, expressed in the requested **currency**, when applicable.\n\n <div style="background-color: #ffffef; padding: 20px; border: 1px solid lightgrey; border-radius: 5px;"><b style="color: red; margin-top: 10px;">🛑 DEPRECATED.</b>\n\n <b style="color: orange;">Field renamed to "breakfast_unit_price"</div>',
-      }),
+    breakfast_price_per_guest_per_night: z.number().nullish().openapi({
+      description:
+        'Price of breakfast per guest per night for the given **Hotel Room Offer**, expressed in the requested **currency**, when applicable.\n\n <div style="background-color: #ffffef; padding: 20px; border: 1px solid lightgrey; border-radius: 5px;"><b style="color: red; margin-top: 10px;">🛑 DEPRECATED.</b>\n\n <b style="color: orange;">Field renamed to "breakfast_unit_price"</div>',
+    }),
     breakfast_unit_price: z.number().optional().nullish().openapi({
       description:
         'Price of breakfast per guest per night for the given **Hotel Room Offer**, expressed in the requested **currency**, when applicable.',
@@ -54,7 +52,6 @@ export const HOTEL_ROOM_OFFER_SCHEMA = z
       }),
     count: z
       .number()
-      .optional()
       .nullish()
       .openapi({
         description: `When **type = ${HotelRoomOfferType.HotelRoom}**: this parameters represents the available quantity for the given **Hotel Room Offer**.
@@ -73,13 +70,15 @@ export const HOTEL_ROOM_OFFER_SCHEMA = z
       .openapi({
         description: PACKAGE_TYPES_DESCRIPTION,
       })
-      .nullish()
-      .optional(),
+      .nullish(),
     price: z.number().openapi({
       description:
         'Price with taxes NOT INCLUDED of the given **Hotel Room Offer** including breakfast(s) when applicable, expressed in the requested **currency**.',
     }),
     source_market: SOURCE_MARKET_SCHEMA,
+    stay_taxes_info: z
+      .enum(StayTaxesInfoEnum)
+      .openapi({ description: 'Either INCLUDED, NOT_INCLUDED or UNKNOWN' }),
     tags: TAGS_SCHEMA,
     tax_included_price: z.number().openapi({
       description: `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**.\n\nThis data is not returned for a **Hotel Room Offer** of type **${HotelRoomOfferType.HotelRoom}**, 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 = ${HotelRoomOfferType.Package}** based on a packaged list of **Hotel Room Offers** of type **${HotelRoomOfferType.HotelRoom}**.`,
@@ -90,10 +89,16 @@ export const HOTEL_ROOM_OFFER_SCHEMA = z
       .openapi({
         description: `Hotel Room Offer type.\n\n **Hotel Room Offers** with **type = "${HotelRoomOfferType.Package}"** are **Hotel Room Offers** that are already bookable and you'll be able to follow the next step of the **Booking Flow** calling **[Create Booking Policies endpoint](/v1/documentation#operation/postV1Booking_policies)**. \n\n Otherwise, you'll be able to create a new **Hotel Room Offer** with **type = "${HotelRoomOfferType.Package}"** from multiple **Hotel Room Offers** with **type = "${HotelRoomOfferType.HotelRoom}"**. See **[Create Hotel Room Offer endpoint](/v1/documentation#operation/postV1Hotel_room_offers)** for details.`,
       })
-      .nullish()
       .optional(),
   })
   .openapi('hotelRoomOfferApi', {
     description: 'Description of the Hotel Room Offer.',
   })
+
+export const HOTEL_ROOM_OFFERS_SCHEMA = z.array(HOTEL_ROOM_OFFER_SCHEMA)
+
+export const HOTEL_ROOM_OFFERS_RESPONSE_SCHEMA = z.object({
+  data: HOTEL_ROOM_OFFERS_SCHEMA,
+  meta: LIST_POLLING_META_SCHEMA,
+})
 /* eslint-enable camelcase */

package/src/schemas/hotel-room.ts

@@ -57,10 +57,7 @@ export const HOTEL_ROOM_SCHEMA = z
       .openapi({ description: 'Whether high resolution images are available.' })
       .optional()
       .nullish(),
-    id: z
-      .string()
-      .optional()
-      .openapi({ description: 'Hotel Room id, when applicable.' }),
+    id: z.string().openapi({ description: 'Hotel Room id, when applicable.' }),
     image_indexes: z.array(z.number()).optional().nullish().openapi({
       description:
         'List of indexes corresponding to image names for the given Hotel Room among the related hotel images.',

package/src/types/calendar.ts

@@ -6,11 +6,11 @@ export interface ICalendarRange<
   T extends ICalendarRangeDay = ICalendarRangeDay,
   U = Record<string, unknown> | undefined,
 > {
+  id: string
+  data: U
   dateFrom: string
   dateTo: string
   days: T[]
-  data: U
-  id: string
   name: string
   resourceId: string
 }

package/src/types/elements/amenity.ts

@@ -113,6 +113,12 @@ export interface Amenities {
    * @memberof Amenities
    */
   handicapAccessible?: boolean
+  /**
+   * Indoor pool.
+   * @type {boolean}
+   * @memberof Amenities
+   */
+  indoorPool?: boolean
   /**
    * In house bar.
    * @type {boolean}
@@ -131,12 +137,6 @@ export interface Amenities {
    * @memberof Amenities
    */
   inRoomMovies?: boolean
-  /**
-   * Indoor pool.
-   * @type {boolean}
-   * @memberof Amenities
-   */
-  indoorPool?: boolean
   /**
    * Interior room entrance.
    * @type {boolean}
@@ -216,17 +216,17 @@ export interface Amenities {
    */
   sauna?: boolean
   /**
-   * TV in room.
+   * Tennis court.
    * @type {boolean}
    * @memberof Amenities
    */
-  tVInRoom?: boolean
+  tennisCourt?: boolean
   /**
-   * Tennis court.
+   * TV in room.
    * @type {boolean}
    * @memberof Amenities
    */
-  tennisCourt?: boolean
+  tVInRoom?: boolean
   /**
    *  24/7 security.
    * @type {boolean}

package/src/types/elements/booking-policy.ts

@@ -3,6 +3,12 @@ import type { CurrencyType } from './currency.ts'
 import type { HotelRoomOffer } from './hotel-room-offer.ts'
 
 export interface BookingPolicies {
+  /**
+   * **Booking Policy** id
+   * @type {string}
+   * @memberof BookingPolicies
+   */
+  id: string
   /**
    * The total number of adults who will be staying in the property.
    * @type {number}
@@ -39,6 +45,7 @@ export interface BookingPolicies {
    * @memberof BookingPolicies
    */
   currency: CurrencyType
+
   /**
    * Expiration date for this **Booking Policy**.
    *
@@ -47,7 +54,6 @@ export interface BookingPolicies {
    * @memberof BookingPolicies
    */
   expiresAt: string | null
-
   hasRoomingLists: boolean
   /**
    * Hotel id
@@ -61,12 +67,6 @@ export interface BookingPolicies {
    * @memberof BookingPolicies
    */
   hotelRoomOffer: HotelRoomOffer
-  /**
-   * **Booking Policy** id
-   * @type {string}
-   * @memberof BookingPolicies
-   */
-  id: string
   /**
    * Indicates whether the price of the **Hotel Room Offer** (without breakfast included) has increased compared to the price returned by [Retrieve Hotel Room Offers endpoint](/v1/documentation#operation/getV1Hotel_room_offers).
    *

package/src/types/elements/booking.ts

@@ -10,6 +10,12 @@ import type { SourceMarket } from './source-market.ts'
 import type { Tax } from './tax.ts'
 
 export interface Booking {
+  /**
+   * Booking Id
+   * @type {string}
+   * @memberof Booking
+   */
+  id?: string | null
   /**
    * The total number of adults who will be staying in the property.
    * @type {number}
@@ -100,12 +106,6 @@ export interface Booking {
    * @memberof Booking
    */
   hotelId: string
-  /**
-   *
-   * @type {HotelRoomOffer}
-   * @memberof Booking
-   */
-  hotelRoomOffer: HotelRoomOffer
   /**
    * Hotel rooming lists of a hotel booking
    * @type {Array<HotelRoomingList>}
@@ -113,11 +113,11 @@ export interface Booking {
    */
   hotelRoomingLists?: HotelRoomingList[]
   /**
-   * Booking Id
-   * @type {string}
+   *
+   * @type {HotelRoomOffer}
    * @memberof Booking
    */
-  id?: string | null
+  hotelRoomOffer: HotelRoomOffer
   /**
    * The list of invoices and credit notes (when applicable) direct urls associated to the Booking.
    * @type {Array<InvoiceApi>}
@@ -184,18 +184,18 @@ export interface Booking {
    * @memberof Booking
    */
   taxAmount: number
-  /**
-   * Price of the booking including taxes expressed in the booking currency.
-   * @type {number}
-   * @memberof Booking
-   */
-  taxIncludedPrice: number
   /**
    *
    * @type {Array<Tax>}
    * @memberof Booking
    */
   taxes?: Tax[] | null
+  /**
+   * Price of the booking including taxes expressed in the booking currency.
+   * @type {number}
+   * @memberof Booking
+   */
+  taxIncludedPrice: number
   /**
    * Link to Revolugo terms and conditions under which the booking is made.
    * @type {string}

package/src/types/elements/contact-person.ts

@@ -167,4 +167,11 @@ export interface PrebookFormValues {
   phoneNumber: string
   salutation: ContactPerson['salutation']
   specialRequests: ContactPerson['remarks']
+  organizationAddress?: string
+  organizationCity?: string
+  organizationCountry?: string
+  organizationName?: string
+  organizationState?: string
+  organizationVatNumber?: string
+  organizationZipCode?: string
 }

package/src/types/elements/elements-events.ts

@@ -35,6 +35,7 @@ export enum ElementsEvent {
   HotelOffersPollingStarted = 'hotel-offers:polling:started',
   HotelOffersRetrieved = 'hotel-offers:retrieved',
   HotelRetrieved = 'hotel:retrieved',
+  HotelRoomOfferItemVisible = 'hotel-room-offer:item:visible',
   HotelRoomOfferRequestCreated = 'hotel-room-offer-request:created',
   HotelRoomOfferRequestRetrieved = 'hotel-room-offer-request:retrieved',
   HotelRoomOffersBtnClick = 'hotel-room-offers:click:btn',
@@ -68,6 +69,7 @@ export interface ElementsEventCallbacks {
   [ElementsEvent.HotelOffersPollingStarted]: any
   [ElementsEvent.HotelOffersRetrieved]: HotelOffer[]
   [ElementsEvent.HotelRetrieved]: Hotel
+  [ElementsEvent.HotelRoomOfferItemVisible]: [HotelRoomOffer, number]
   [ElementsEvent.HotelRoomOfferRequestCreated]: HotelRoomOfferRequestResponse
   [ElementsEvent.HotelRoomOfferRequestRetrieved]: HotelRoomOfferRequestResponse
   [ElementsEvent.HotelRoomOffersBtnClick]: HotelRoomOffer

package/src/types/elements/event-metadata.ts

@@ -1,22 +1,22 @@
 export interface EventMetadata {
   /**
-   * End date of the event formatted as YYYY-MM-DD.
+   * Unique id of the event
    * @type {string}
    * @memberof EventMetadata
    */
-  dateEnd?: string
+  id?: string
   /**
-   * Start date of the event formatted as YYYY-MM-DD.
+   * End date of the event formatted as YYYY-MM-DD.
    * @type {string}
    * @memberof EventMetadata
    */
-  dateStart?: string
+  dateEnd?: string
   /**
-   * Unique id of the event
+   * Start date of the event formatted as YYYY-MM-DD.
    * @type {string}
    * @memberof EventMetadata
    */
-  id?: string
+  dateStart?: string
   /**
    * Image URL of the event
    * @type {string}

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

@@ -12,11 +12,11 @@ export type HotelOffersSortByOrderType = `${HotelOffersSortByOrderEnum}`
 
 export interface HotelOffersListPayload {
   currency: CurrencyType
-  hotelOfferRequestId: string
   endingBefore?: string | null
   filterByPrice?: string
   filterByReviewRating?: number
   filterByStar?: string
+  hotelOfferRequestId: string
   hotelRoomOffersLimit?: number
   includeHotelContentDetails?: boolean | null
   lang?: Locale