@revolugo/common 7.1.1 → 7.2.0-alpha.0

package/src/schemas/hotel.ts

@@ -4,159 +4,185 @@ import { z } from 'zod'
 import { CountryIso2Code } from '../constants/index.ts'
 
 import { CURRENCY_SCHEMA } from './currency.ts'
+import { IMAGES_SCHEMA } from './global.ts'
 
-export const AMENITIES_SCHEMA = z.object({
-  air_conditioning: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Air conditioning.' }),
-  airport_transportation: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Airport transportation service.' }),
-  business_center: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Business center.' }),
-  car_rent_desk: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Car rental desk service.' }),
-  children_allowed: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Children welcomed.' }),
-  clothing_iron: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Clothing iron.' }),
-  coffee_tea_maker: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Coffea/tea maker.' }),
-  combination: z.boolean().optional().openapi({ description: 'Combination.' }),
-  continental_breakfast: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Continental Breakfast.' }),
-  data_ports: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Data ports in room.' }),
-  dry_cleaning: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Dry cleaning.' }),
-  electronic_room_keys: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Electornic room keys.' }),
-  exterior_room_entrance: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Exterior room entrance.' }),
-  family_rooms: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Family rooms.' }),
-  fitness_facility: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Fitness facility.' }),
-  game_room: z.boolean().optional().openapi({ description: 'Game room.' }),
-  golf_course: z.boolean().optional().openapi({ description: 'Golf course.' }),
-  hair_dryer: z.boolean().optional().openapi({ description: 'Hair dryer.' }),
-  handicap_accessible: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Handicap Accessible.' }),
-  in_house_bar: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'In house bar.' }),
-  in_house_dining: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'In house dining.' }),
-  in_room_movies: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'In room movies.' }),
-  indoor_pool: z.boolean().optional().openapi({ description: 'Indoor pool.' }),
-  interior_room_entrance: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Interior room entrance.' }),
-  kitchen: z.boolean().optional().openapi({ description: 'Kitchen.' }),
-  map: z.boolean().optional().openapi({ description: 'Map.' }),
-  meeting_rooms: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Meeting rooms.' }),
-  mini_bar_in_room: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'mini bar in room.' }),
-  non_smoking_rooms: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Non smoking rooms.' }),
-  outdoor_pool: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Outdoor pool.' }),
-  parking_garage: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Parking garage.' }),
-  pets_allowed: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Pets allowed.' }),
-  restricted_access: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Restricted access.' }),
-  room_service: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Room service.' }),
-  safe: z.boolean().optional().openapi({ description: 'Safe in room.' }),
-  sauna: z.boolean().optional().openapi({ description: 'Sauna.' }),
-  t_v_in_room: z.boolean().optional().openapi({ description: 'TV in room.' }),
-  tennis_court: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Tennis court.' }),
-  twenty_four_hour_security: z
-    .boolean()
-    .optional()
-    .openapi({ description: ' 24/7 security.' }),
-  valet_parking: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Valet parking.' }),
-  video_check_out: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Video check out.' }),
-  voice_mail: z.boolean().optional().openapi({ description: 'Voice mail.' }),
-  wake_up_service: z
-    .boolean()
-    .optional()
-    .openapi({ description: 'Wake up service.' }),
-  whirpool: z.boolean().optional().openapi({ description: 'Whirpool.' }),
-})
+export const AMENITIES_SCHEMA = z
+  .object({
+    air_conditioning: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Air conditioning.' }),
+    airport_transportation: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Airport transportation service.' }),
+    business_center: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Business center.' }),
+    car_rent_desk: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Car rental desk service.' }),
+    children_allowed: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Children welcomed.' }),
+    clothing_iron: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Clothing iron.' }),
+    coffee_tea_maker: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Coffea/tea maker.' }),
+    combination: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Combination.' }),
+    continental_breakfast: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Continental Breakfast.' }),
+    data_ports: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Data ports in room.' }),
+    dry_cleaning: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Dry cleaning.' }),
+    electronic_room_keys: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Electornic room keys.' }),
+    exterior_room_entrance: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Exterior room entrance.' }),
+    family_rooms: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Family rooms.' }),
+    fitness_facility: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Fitness facility.' }),
+    game_room: z.boolean().optional().openapi({ description: 'Game room.' }),
+    golf_course: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Golf course.' }),
+    hair_dryer: z.boolean().optional().openapi({ description: 'Hair dryer.' }),
+    handicap_accessible: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Handicap Accessible.' }),
+    in_house_bar: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'In house bar.' }),
+    in_house_dining: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'In house dining.' }),
+    in_room_movies: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'In room movies.' }),
+    indoor_pool: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Indoor pool.' }),
+    interior_room_entrance: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Interior room entrance.' }),
+    kitchen: z.boolean().optional().openapi({ description: 'Kitchen.' }),
+    map: z.boolean().optional().openapi({ description: 'Map.' }),
+    meeting_rooms: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Meeting rooms.' }),
+    mini_bar_in_room: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'mini bar in room.' }),
+    non_smoking_rooms: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Non smoking rooms.' }),
+    outdoor_pool: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Outdoor pool.' }),
+    parking_garage: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Parking garage.' }),
+    pets_allowed: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Pets allowed.' }),
+    restricted_access: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Restricted access.' }),
+    room_service: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Room service.' }),
+    safe: z.boolean().optional().openapi({ description: 'Safe in room.' }),
+    sauna: z.boolean().optional().openapi({ description: 'Sauna.' }),
+    t_v_in_room: z.boolean().optional().openapi({ description: 'TV in room.' }),
+    tennis_court: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Tennis court.' }),
+    twenty_four_hour_security: z
+      .boolean()
+      .optional()
+      .openapi({ description: ' 24/7 security.' }),
+    valet_parking: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Valet parking.' }),
+    video_check_out: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Video check out.' }),
+    voice_mail: z.boolean().optional().openapi({ description: 'Voice mail.' }),
+    wake_up_service: z
+      .boolean()
+      .optional()
+      .openapi({ description: 'Wake up service.' }),
+    whirpool: z.boolean().optional().openapi({ description: 'Whirpool.' }),
+  })
+  .openapi('hotelAmenitiesApi', {
+    description: 'Amenities available at the hotel.',
+  })
 
-export const HOTEL_IMAGE = z.object({
-  caption: z.string().nullish(),
-  is_hero_image: z.boolean(),
-  l: z.string(),
-  m: z.string(),
-  s: z.string(),
-  xl: z.string(),
-  xs: z.string(),
-})
+export const HOTEL_IMAGE = z
+  .object({
+    caption: z
+      .string()
+      .nullish()
+      .openapi({ description: 'Caption of the hotel image.' }),
+    is_hero_image: z.boolean().openapi({
+      description:
+        'Whether this image is the primary (hero) image of the hotel.',
+    }),
+    l: z.string().openapi({ description: 'URL of the large-size image.' }),
+    m: z.string().openapi({ description: 'URL of the medium-size image.' }),
+    s: z.string().openapi({ description: 'URL of the small-size image.' }),
+    xl: z
+      .string()
+      .openapi({ description: 'URL of the extra-large-size image.' }),
+    xs: z
+      .string()
+      .openapi({ description: 'URL of the extra-small-size image.' }),
+  })
+  .openapi('hotelImageApi', { description: 'Hotel image in various sizes.' })
 
 export const HOTEL_IMAGES = z.array(HOTEL_IMAGE).openapi({
   description:
@@ -170,8 +196,7 @@ export const HOTEL_REVIEW_RATING_SCHEMA = z
       .openapi({
         description: 'Category of the collected reviews for the Hotel.',
       })
-      .nullish()
-      .optional(),
+      .nullish(),
     rating: z.number().openapi({
       description: 'Rating of the collected review for the Hotel.',
     }),
@@ -187,174 +212,116 @@ export const HOTEL_REVIEW_RATINGS_SCHEMA = z
       'List of meta reviews (category and rating) that are summary of verified reviews collected across the web on the Hotel to help choose the best option.',
   })
 
-export const IMAGES_SCHEMA = z
-  .object({
-    count: z
-      .number()
-      .openapi({ description: 'Number of images.' })
-      .optional()
-      .nullish(),
-    highres: z
-      .boolean()
-      .openapi({ description: 'Whether images exist in highres format.' })
-      .optional()
-      .nullish(),
-
-    lowres: z
-      .boolean()
-      .openapi({ description: 'Whether images exist in lowres format.' })
-      .optional()
-      .nullish(),
-    prefix: z
-      .string()
-      .openapi({ description: 'Base URL for the images.' })
-      .optional()
-      .nullish(),
-    suffix: z
-      .string()
-      .openapi({
-        description:
-          'This parameter usually represents the extension of the image (e.g.: .jpg, .png)',
+export const VENUES_SCHEMA = z
+  .array(
+    z
+      .object({
+        description: z.string().nullish().openapi({
+          description: 'Description of the venue or point of interest.',
+        }),
+        name: z
+          .string()
+          .openapi({ description: 'Name of the venue or point of interest.' }),
+        travel_times: z
+          .object({
+            driving: z.number().optional().openapi({
+              description: 'Driving travel time to the venue in minutes.',
+            }),
+            transit: z.number().optional().openapi({
+              description: 'Transit travel time to the venue in minutes.',
+            }),
+            walking: z.number().optional().openapi({
+              description: 'Walking travel time to the venue in minutes.',
+            }),
+          })
+          .nullish()
+          .openapi({
+            description:
+              'Estimated travel times to the venue by transport mode.',
+          }),
       })
-      .optional()
-      .nullish(),
-    thumb: z
-      .boolean()
       .openapi({
-        description:
-          'Whether images exist in thumb format (for thumbnails preview).',
-      })
-      .optional()
-      .nullish(),
-  })
+        description: 'A venue or point of interest near the hotel.',
+      }),
+  )
+  .optional()
   .openapi({
     description:
-      '🛑 DEPRECATED - Hotel images details.\n\nIn order to retrieve a specific image you need to construct the complete URL from the images parameters: **[images.prefix][highres|lowres|thumb]/[index]/[images.suffix]**. If **images.count = n**, then index is in [0...n-1] range.\n\ne.g.: https://s3.eu-west-3.amazonaws.com/revolugo/hotels/yhKY/images/highres/0.jpg',
+      'List of nearby venues or points of interest (e.g. airports, stadiums) with estimated travel times.',
   })
 
-export const VENUES_SCHEMA = z
-  .array(
-    z.object({
-      description: z.string().optional().nullish(),
-      name: z.string(),
-      travel_times: z
-        .object({
-          driving: z.number().optional(),
-          transit: z.number().optional(),
-          walking: z.number().optional(),
-        })
-        .optional()
-        .nullish(),
-    }),
-  )
-  .optional()
 export const HOTEL_SCHEMA = z
   .object({
-    address: z
-      .string()
-      .openapi({ description: 'Hotel address.' })
-      .optional()
-      .nullish(),
+    address: z.string().openapi({ description: 'Hotel address.' }).nullish(),
     address2: z
       .string()
       .openapi({ description: 'Second part of hotel address.' })
-      .optional()
       .nullish(),
-    amenities: AMENITIES_SCHEMA.nullish(),
+    amenities: AMENITIES_SCHEMA.nullish().openapi({
+      description: 'Hotel amenities.',
+    }),
     check_in_time: z
       .string()
       .openapi({ description: 'Check in time of the hotel.' })
-      .optional()
       .nullish(),
     check_out_time: z
       .string()
       .openapi({ description: 'Check out time of the hotel.' })
-      .optional()
-      .nullish(),
-    city: z.string().openapi({ description: 'City' }).optional().nullish(),
-    country: z
-      .string()
-      .openapi({ description: 'Country' })
-      .optional()
       .nullish(),
+    city: z.string().openapi({ description: 'City' }).nullish(),
+    country: z.string().openapi({ description: 'Country' }).nullish(),
     country_code: z
       .string()
       .refine(check =>
         Object.values(CountryIso2Code).includes(check as CountryIso2Code),
       )
       .openapi({ description: 'Hotel country code in ISO2.' })
-      .optional()
-      .nullish(),
-    currency: CURRENCY_SCHEMA.openapi({ description: 'Hotel currency.' })
-      .optional()
       .nullish(),
+    currency: CURRENCY_SCHEMA.openapi({
+      description: 'Hotel currency.',
+    }).nullish(),
     description: z
       .string()
       .openapi({ description: 'Hotel description.' })
-      .optional()
       .nullish(),
     distance: z
       .number()
-      .optional()
       .openapi({
         description: 'Distance from a requested location, expressed in meters',
       })
-      .optional()
-      .nullish(),
-    email: z
-      .string()
-      .openapi({ description: 'Hotel email.' })
-      .optional()
-      .nullish(),
-    fax: z
-      .string()
-      .openapi({ description: 'Hotel fax number.' })
-      .optional()
       .nullish(),
+    email: z.string().openapi({ description: 'Hotel email.' }).nullish(),
+    fax: z.string().openapi({ description: 'Hotel fax number.' }).nullish(),
     hotel_images: HOTEL_IMAGES.nullish(),
-    hotel_review_ratings: HOTEL_REVIEW_RATINGS_SCHEMA.optional().nullish(),
+    hotel_review_ratings: HOTEL_REVIEW_RATINGS_SCHEMA.nullish(),
     id: z.string().openapi({ description: 'Hotel id.' }),
     images: IMAGES_SCHEMA.nullish(),
     latitude: z.number().openapi({ description: 'Hotel latitude.' }),
     longitude: z.number().openapi({ description: 'Hotel longitude.' }),
     name: z.string().openapi({ description: 'Hotel name.' }),
-    phone: z
-      .string()
-      .openapi({ description: 'Hotel phone number.' })
-      .optional()
-      .nullish(),
+    phone: z.string().openapi({ description: 'Hotel phone number.' }).nullish(),
     policy: z
       .string()
       .openapi({ description: 'Internal policy of the hotel.' })
-      .optional()
       .nullish(),
     postal_code: z
       .string()
       .openapi({ description: 'Hotel address postal code.' })
-      .optional()
       .nullish(),
-    rating: z
-      .number()
-      .optional()
-      .nullish()
-      .openapi({ description: 'Hotel Star rating.' }),
+    rating: z.number().nullish().openapi({ description: 'Hotel Star rating.' }),
     state: z
       .string()
       .openapi({ description: 'Hotel address state.' })
-      .optional()
       .nullish(),
     ta_id: z
       .string()
-      .optional()
       .openapi({ description: 'TripAdvisor property id. When applicable.' })
-      .optional()
       .nullish(),
     timezone: z.string().openapi({ description: 'Hotel timezone.' }),
     venues: VENUES_SCHEMA,
     website: z
       .string()
       .openapi({ description: 'Hotel website url.' })
-      .optional()
       .nullish(),
   })
-  .openapi('hotelApi')
+  .openapi('hotelApi', { description: 'Hotel details.' })

package/src/schemas/index.ts

@@ -1,6 +1,8 @@
+export * from './breakfast.ts'
+export * from './booking-policy.ts'
 export * from './cancellation-policies.ts'
 export * from './currency.ts'
-export * from './hotel-offer-request.ts'
+export * from './global.ts'
 export * from './hotel-offer.ts'
 export * from './hotel-room-offer.ts'
 export * from './hotel-room.ts'

package/src/schemas/list-polling-meta.ts

@@ -29,7 +29,9 @@ export const LIST_META_SCHEMA = z
     ending_before: ENDING_BEFORE_SCHEMA,
     limit: LIMIT_SCHEMA,
     starting_after: STARTING_AFTER_SCHEMA,
-    total_count: z.number().nullish(),
+    total_count: z.number().nullish().openapi({
+      description: 'Total count of items in the list.',
+    }),
   })
   .openapi('metaApiResponse')
   .openapi({
@@ -43,5 +45,8 @@ export const LIST_POLLING_META_SCHEMA = LIST_META_SCHEMA.extend({
     .number()
     .optional()
     .openapi({ description: 'Total count of the response list.' }),
-}).openapi('metaApiPollingResponse')
+}).openapi('metaApiPollingResponse', {
+  description:
+    'Meta information about the polling response list, including pagination cursors and the current polling status.',
+})
 /* eslint-enable camelcase */

package/src/schemas/tag.ts

@@ -1,13 +1,27 @@
 /* eslint-disable camelcase */
 import { z } from 'zod'
 
-export const TAG_SCHEMA = z.object({
-  bg: z.string().optional().nullish(),
-  color: z.string().optional().nullish(),
-  description: z.string().optional().nullish(),
-  fa_icon: z.string().optional().nullish(),
-  name: z.string(),
-})
+export const TAG_SCHEMA = z
+  .object({
+    bg: z.string().optional().nullish().openapi({
+      description: 'Background color of the tag.',
+    }),
+    color: z.string().optional().nullish().openapi({
+      description: 'Text color of the tag.',
+    }),
+    description: z.string().optional().nullish().openapi({
+      description: 'Description of the tag.',
+    }),
+    fa_icon: z.string().optional().nullish().openapi({
+      description: 'Font Awesome icon identifier for the tag.',
+    }),
+    name: z.string().openapi({ description: 'Name of the tag.' }),
+  })
+  .openapi('tagApi', {
+    description: 'Tag associated with a Hotel or Hotel Room Offer.',
+  })
 
-export const TAGS_SCHEMA = z.array(TAG_SCHEMA).optional().default([])
+export const TAGS_SCHEMA = z.array(TAG_SCHEMA).optional().default([]).openapi({
+  description: 'List of tags associated with a Hotel or Hotel Room Offer.',
+})
 /* eslint-enable camelcase */

package/src/schemas/taxes.ts

@@ -28,7 +28,9 @@ export const TAX_SCHEMA = z
         'Tax mode. Specifies if the tax applies per occupant, per booking or per room',
     }),
   })
-  .openapi('taxApi')
+  .openapi('taxApi', { description: 'Tax applied to the Hotel Room Offer.' })
 
-export const TAXES_SCHEMA = z.array(TAX_SCHEMA).optional()
+export const TAXES_SCHEMA = z.array(TAX_SCHEMA).optional().openapi({
+  description: 'List of taxes applied to the Hotel Room Offer.',
+})
 /* eslint-enable camelcase */

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

@@ -41,7 +41,7 @@ export interface BookingPolicies {
   children?: string | null
   /**
    *
-   * @type {CurrencyBookingApiClient}
+   * @type {CurrencyClient}
    * @memberof BookingPolicies
    */
   currency: CurrencyType