@revolugo/common 7.10.0 → 7.11.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revolugo/common",
-  "version": "7.10.0",
+  "version": "7.11.0-rc.1",
   "private": false,
   "description": "Revolugo common",
   "author": "Revolugo",
@@ -30,10 +30,10 @@
     "slugify": "1.6.9",
     "type-fest": "5.6.0",
     "uuid": "14.0.0",
-    "zod": "4.3.6"
+    "zod": "4.4.3"
   },
   "engines": {
-    "node": ">=20.18.1 <25"
+    "node": ">=24.15.0 <25"
   },
   "volta": {
     "extends": "../../package.json"

package/src/currencies/stripe.ts

@@ -122,7 +122,6 @@ export const STRIPE_CURRENCY_CODES = [
   CurrencyCode.SZL,
   CurrencyCode.THB,
   CurrencyCode.TJS,
-  CurrencyCode.TND,
   CurrencyCode.TOP,
   CurrencyCode.TRY,
   CurrencyCode.TTD,

package/src/icons/index.ts

@@ -51,6 +51,7 @@ export const ICONS_NAME = Object.freeze({
   coinVertical: 'ph:coin-vertical',
   comment: 'ph:chat-teardrop',
   copy: 'ph:copy',
+  creditCard: 'ph:credit-card',
   cross: 'ph:cross',
   desktop: 'ph:desktop',
   deviceMobile: 'ph:device-mobile',

package/src/schemas/booking-policy.ts

@@ -13,9 +13,13 @@ import {
   IS_PRICE_INCREASED,
 } from './global.ts'
 import { HOTEL_ROOM_OFFER_SCHEMA } from './hotel-room-offer.ts'
+import { ADDON_SCHEMA } from './order-addon.ts'
 
 export const BOOKING_POLICY_SCHEMA = z
   .object({
+    addons: z.array(ADDON_SCHEMA).optional().openapi({
+      description: 'Available add-ons (e.g. insurance)',
+    }),
     adult_count: ADULT_COUNT_SCHEMA,
     cancellation_policies: z.array(CANCELLATION_POLICY_SCHEMA).openapi({
       description:

package/src/schemas/booking.ts

@@ -36,7 +36,7 @@ export const FILTER_BOOKING_STATUS_SCHEMA = z
 
 export const BOOKING_METADATA_SCHEMA = z
   .record(z.string(), z.string())
-  .openapi('bookingMetadataApi', {
+  .openapi({
     description:
       "You can use this parameter to attach key-value data to bookings. Metadata is useful for storing additional, structured information on a booking. As an example, you could store your user's full name and corresponding unique identifier from your system on a booking. Metadata is not used internally by the Booking Engine and won't be seen by your users unless you choose to show it to them.",
   })

package/src/schemas/extend-zod.ts

@@ -0,0 +1,9 @@
+import { extendZodWithOpenApi } from '@asteasolutions/zod-to-openapi'
+import { z } from 'zod'
+
+// Schemas in this package use `.openapi()` to attach OpenAPI metadata. The
+// method is added to Zod's prototype via this side effect so consumers don't
+// need to depend on `@hono/zod-openapi` (or remember to call this themselves).
+// Imported as a side effect before any schema module so the prototype is
+// patched before any `.openapi()` call evaluates.
+extendZodWithOpenApi(z)

package/src/schemas/hotel-offer.ts

@@ -2,6 +2,7 @@
 import { z } from 'zod'
 
 import { CURRENCY_SCHEMA } from './currency.ts'
+import { EVENT_SCHEMA } from './event.ts'
 import {
   ADULT_COUNT_SCHEMA,
   CHECK_IN_DATE_SCHEMA,
@@ -57,7 +58,7 @@ export const HOTEL_OFFERS_RESPONSE_SCHEMA = z
         description: 'Minimum price of available returned **Hotel Offers**',
       }),
     }),
-    event: z.any().optional().openapi({
+    event: EVENT_SCHEMA.optional().openapi({
       description:
         'Event associated with the Hotel Offers response, when applicable.',
     }),

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

@@ -62,7 +62,7 @@ export const HOTEL_ROOM_OFFER_SCHEMA = z
       .openapi({
         description: PACKAGE_TYPES_DESCRIPTION,
       })
-      .nullish(),
+      .optional(),
     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**.',

package/src/schemas/hotel-room.ts

@@ -13,8 +13,12 @@ export const BED_SCHEMA = z
   })
   .openapi('bedApi')
 
+export const BED_COMBINATION_SCHEMA = z
+  .array(BED_SCHEMA)
+  .openapi('bedCombinationApi')
+
 export const BEDS_SCHEMA = z
-  .array(z.array(BED_SCHEMA))
+  .array(BED_COMBINATION_SCHEMA)
   .openapi({
     description: `Beds list.
 Each nested array of beds represents a single combination of possible beds.

package/src/schemas/hotel.ts

@@ -277,9 +277,7 @@ export const HOTEL_SCHEMA = z
       )
       .openapi({ description: 'Hotel country code in ISO2.' })
       .nullish(),
-    currency: CURRENCY_SCHEMA.openapi({
-      description: 'Hotel currency.',
-    }).nullish(),
+    currency: CURRENCY_SCHEMA.optional(),
     description: z
       .string()
       .openapi({ description: 'Hotel description.' })

package/src/schemas/index.ts

@@ -1,3 +1,6 @@
+// oxlint-disable-next-line import/no-unassigned-import
+import './extend-zod.ts'
+
 export * from './booking-policy.ts'
 export * from './booking.ts'
 export * from './breakfast.ts'
@@ -10,6 +13,7 @@ export * from './hotel-room-offer.ts'
 export * from './hotel-room.ts'
 export * from './hotel.ts'
 export * from './list-polling-meta.ts'
+export * from './order-addon.ts'
 export * from './payment-methods.ts'
 export * from './tag.ts'
 export * from './taxes.ts'

package/src/schemas/order-addon.ts

@@ -0,0 +1,20 @@
+/* eslint-disable camelcase */
+import { z } from 'zod'
+
+import { AddonTypeEnum } from '../types/addon.ts'
+
+export const ADDON_SCHEMA = z
+  .object({
+    price: z.number(),
+    tax_included_price: z.number(),
+    type: z.enum(AddonTypeEnum),
+  })
+  .openapi('OrderAddon')
+
+export const ADDON_SELECTION_SCHEMA = z
+  .object({
+    type: z.enum(AddonTypeEnum),
+  })
+  .openapi('OrderAddonSelection')
+
+/* eslint-enable camelcase */

package/src/schemas/payment-methods.ts

@@ -63,39 +63,47 @@ export const PAYMENT_METHODS_REQUEST_SCHEMA = z
 
 export const PAYMENT_METHOD_RESPONSE_SCHEMA = z
   .discriminatedUnion('name', [
-    z.object({
-      name: z.literal(PaymentMethodNameEnum.CreditCard),
-      payload: z.object({
-        amount: z.number(),
-        couponId: z.string().nullish(),
-        token: z.string(),
-      }),
-    }),
-    z.object({
-      name: z.literal(PaymentMethodNameEnum.Coupon),
-      payload: z.object({
-        amount: z.number(),
-        couponId: z.string(),
-        token: z.string().nullish(),
-      }),
-    }),
-    z.object({
-      name: z.enum([PaymentMethodNameEnum.DepositAccount]),
-      payload: z.object({
-        amount: z.number(),
-        couponId: z.string().nullish(),
-        token: z.string().nullish(),
-      }),
-    }),
-    z.object({
-      name: z.literal(PaymentMethodNameEnum.PayLater),
-      payload: z.object({
-        amount: z.number(),
-        couponId: z.string().nullish(),
-        status: z.enum(PayLaterStatusEnum),
-        token: z.string().nullish(),
-      }),
-    }),
+    z
+      .object({
+        name: z.literal(PaymentMethodNameEnum.CreditCard),
+        payload: z.object({
+          amount: z.number(),
+          couponId: z.string().nullish(),
+          token: z.string(),
+        }),
+      })
+      .openapi('paymentMethodCreditCardApi'),
+    z
+      .object({
+        name: z.literal(PaymentMethodNameEnum.Coupon),
+        payload: z.object({
+          amount: z.number(),
+          couponId: z.string(),
+          token: z.string().nullish(),
+        }),
+      })
+      .openapi('paymentMethodCouponApi'),
+    z
+      .object({
+        name: z.literal(PaymentMethodNameEnum.DepositAccount),
+        payload: z.object({
+          amount: z.number(),
+          couponId: z.string().nullish(),
+          token: z.string().nullish(),
+        }),
+      })
+      .openapi('paymentMethodDepositAccountApi'),
+    z
+      .object({
+        name: z.literal(PaymentMethodNameEnum.PayLater),
+        payload: z.object({
+          amount: z.number(),
+          couponId: z.string().nullish(),
+          status: z.enum(PayLaterStatusEnum),
+          token: z.string().nullish(),
+        }),
+      })
+      .openapi('paymentMethodPayLaterApi'),
   ])
   .openapi('paymentMethodApi')
 
@@ -108,21 +116,29 @@ export const PAYMENT_METHODS_RESPONSE_SCHEMA = z
 
 export const ALLOWED_PAYMENT_METHOD_RESPONSE_SCHEMA = z
   .discriminatedUnion('name', [
-    z.object({
-      name: z.literal(PaymentMethodNameEnum.CreditCard),
-    }),
-    z.object({
-      name: z.literal(PaymentMethodNameEnum.Coupon),
-    }),
-    z.object({
-      name: z.enum([PaymentMethodNameEnum.DepositAccount]),
-    }),
-    z.object({
-      name: z.literal(PaymentMethodNameEnum.PayLater),
-      payload: z.object({
-        status: z.enum(PayLaterStatusEnum),
-      }),
-    }),
+    z
+      .object({
+        name: z.literal(PaymentMethodNameEnum.CreditCard),
+      })
+      .openapi('allowedPaymentMethodCreditCardApi'),
+    z
+      .object({
+        name: z.literal(PaymentMethodNameEnum.Coupon),
+      })
+      .openapi('allowedPaymentMethodCouponApi'),
+    z
+      .object({
+        name: z.literal(PaymentMethodNameEnum.DepositAccount),
+      })
+      .openapi('allowedPaymentMethodDepositAccountApi'),
+    z
+      .object({
+        name: z.literal(PaymentMethodNameEnum.PayLater),
+        payload: z.object({
+          status: z.enum(PayLaterStatusEnum),
+        }),
+      })
+      .openapi('allowedPaymentMethodPayLaterApi'),
   ])
   .openapi('allowedPaymentMethodApi')
 

package/src/types/addon.ts

@@ -7,5 +7,5 @@ export type AddonType = `${AddonTypeEnum}`
 export interface Addon {
   price: number
   taxIncludedPrice: number
-  type: AddonType
+  type: AddonTypeEnum
 }

package/src/types/elements/booking.ts

@@ -5,6 +5,7 @@ import type { Event } from './event.ts'
 import type { HotelRoomOffer } from './hotel-room-offer.ts'
 import type { HotelRoomingList } from './hotel-rooming-list.ts'
 import type { InvoiceApi } from './invoice.ts'
+import type { OrderAddon } from './order-addon.ts'
 import type { PaymentMethod } from './payment-method.ts'
 import type { SourceMarket } from './source-market.ts'
 import type { Tax } from './tax.ts'
@@ -34,6 +35,12 @@ export interface Booking {
    * @memberof Booking
    */
   additionalPolicies?: string | null
+  /**
+   * Add-ons attached to the order this booking belongs to (e.g. Revolugo Flex insurance). Empty or omitted when the booking has no order-level add-ons.
+   * @type {Array<OrderAddon>}
+   * @memberof Booking
+   */
+  addons?: OrderAddon[]
   /**
    * The total number of adults who will be staying in the property.
    * @type {number}

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

@@ -32,6 +32,7 @@ export enum ElementsEvent {
   HotelOffersFiltersUpdated = 'hotel-offers:filters:updated',
   HotelOffersItemClick = 'hotel-offer:item:click',
   HotelOffersMarkerClick = 'hotel-offers:marker:click',
+  HotelOffersOpenInNewTabClick = 'hotel-offers:open-in-new-tab:click',
   HotelOffersPollingStarted = 'hotel-offers:polling:started',
   HotelOffersRetrieved = 'hotel-offers:retrieved',
   HotelRetrieved = 'hotel:retrieved',
@@ -65,6 +66,7 @@ export interface ElementsEventCallbacks {
   [ElementsEvent.HotelOffersFiltersUpdated]: Partial<HotelOffersFilters>
   [ElementsEvent.HotelOffersItemClick]: HotelOffer | [HotelOffer, number]
   [ElementsEvent.HotelOffersMarkerClick]: HotelOffer | [HotelOffer, number]
+  [ElementsEvent.HotelOffersOpenInNewTabClick]: string
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [ElementsEvent.HotelOffersPollingStarted]: any
   [ElementsEvent.HotelOffersRetrieved]: HotelOffer[]

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

@@ -157,7 +157,7 @@ export interface HotelRoomOffer {
    * @type {string}
    * @memberof HotelRoomOffer
    */
-  packageType?: HotelRoomOfferPackageType | null
+  packageType?: HotelRoomOfferPackageType
   /**
    * Price with taxes NOT INCLUDED of the given **Hotel Room Offer** including breakfast(s) when applicable, expressed in the requested **currency**.
    * @type {number}

package/src/types/elements/hotel.ts

@@ -65,7 +65,7 @@ export interface Hotel {
    * @type {CurrencyClient}
    * @memberof HotelApi
    */
-  currency?: CurrencyType
+  currency?: CurrencyType | null
   /**
    * Hotel description.
    * @type {string}

package/src/types/elements/order-addon.ts

@@ -24,3 +24,13 @@ export interface OrderAddon {
    */
   type: OrderAddonType
 }
+
+/**
+ * Customer-side addon selection echoed back on the prebook request body.
+ *
+ * The booking-api expects `addons: [{ type: 'insurance' }]` when the customer
+ * opts into Flex; the field is omitted entirely when declined.
+ */
+export interface OrderAddonSelection {
+  type: OrderAddonType
+}

package/src/utils/case-transformers.ts

@@ -100,3 +100,7 @@ export function keysChangeCase<T>(
   return obj
 }
 /* eslint-enable @typescript-eslint/no-explicit-any */
+
+export function capitalize(value: string): string {
+  return value.replace(/^\w/u, c => c.toUpperCase())
+}

package/src/utils/dates.ts

@@ -68,6 +68,19 @@ export function sanitizeDateRange(
   ]
 }
 
+export function isValidDateRange(range: [string, string]): boolean {
+  const [start, end] = range
+
+  return (
+    isValidDate(start) &&
+    isValidDate(end) &&
+    dayjs(start, 'YYYY-MM-DD', true).isBefore(
+      dayjs(end, 'YYYY-MM-DD', true),
+      'day',
+    )
+  )
+}
+
 export function isDate(value: unknown): value is Date {
   return value instanceof Date && !isNaN(value.getTime())
 }