@revolugo/common 6.10.10-rc.2 → 6.11.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revolugo/common",
-  "version": "6.10.10-rc.2",
+  "version": "6.11.0-beta.0",
   "private": false,
   "description": "Revolugo common",
   "author": "Revolugo",
@@ -8,9 +8,6 @@
   "files": [
     "src"
   ],
-  "imports": {
-    "#constants": "./src/constants/index.ts"
-  },
   "exports": {
     "./cancellation-policies": "./src/cancellation-policies.ts",
     "./countries": "./src/countries/index.ts",
@@ -25,8 +22,7 @@
   "dependencies": {
     "change-case": "5.4.4",
     "dayjs": "1.11.18",
-    "ky": "1.10.0",
-    "lodash-es": "4.17.21",
+    "ky": "1.12.0",
     "slugify": "1.6.6",
     "uuid": "13.0.0"
   },

package/src/cancellation-policies.ts

@@ -1,4 +1,4 @@
-import { compact } from './utils/array-tools.ts'
+import { compact } from './utils/compact.ts'
 import { type Dayjs, dayjs } from './utils/dayjs.ts'
 import { isEmpty } from './utils/is-empty.ts'
 
@@ -169,6 +169,7 @@ export function sanitizeCancellationPolicies({
 
   if (
     releaseDatetimeUTC &&
+    compactedCancellationPolicies[0] &&
     dayjs(releaseDatetimeUTC).isBetween(
       dayjs(bookingDatetimeUTC),
       dayjs(compactedCancellationPolicies[0].dateFrom),
@@ -176,6 +177,7 @@ export function sanitizeCancellationPolicies({
       '[)',
     )
   ) {
+    const firstPolicyDateFrom = compactedCancellationPolicies[0].dateFrom
     compactedCancellationPolicies.push(
       {
         dateFrom: bookingDatetimeUTC,
@@ -184,7 +186,7 @@ export function sanitizeCancellationPolicies({
       },
       {
         dateFrom: releaseDatetimeUTC,
-        dateTo: compactedCancellationPolicies[0].dateFrom,
+        dateTo: firstPolicyDateFrom,
         penaltyPercentage: 100,
       },
     )
@@ -268,11 +270,14 @@ export function sanitizeCancellationPolicies({
       !dayjs(cp.dateFrom).isSameOrAfter(nextDayCheckInDateUTC),
   )
 
-  sanitizedCancellationPolicies[0].dateFrom = bookingDatetimeUTC
+  if (sanitizedCancellationPolicies[0]) {
+    sanitizedCancellationPolicies[0].dateFrom = bookingDatetimeUTC
+  }
 
-  sanitizedCancellationPolicies[
-    sanitizedCancellationPolicies.length - 1
-  ]!.dateTo = nextDayCheckInDateUTC
+  const lastIndex = sanitizedCancellationPolicies.length - 1
+  if (sanitizedCancellationPolicies[lastIndex]) {
+    sanitizedCancellationPolicies[lastIndex].dateTo = nextDayCheckInDateUTC
+  }
 
   return sanitizedCancellationPolicies
 }
@@ -340,10 +345,7 @@ export function getPenaltyPercentage({
     date: datetime,
   })
 
-  return (
-    matchingCancellationPolicies[0] &&
-    matchingCancellationPolicies[0].penaltyPercentage
-  )
+  return matchingCancellationPolicies[0]?.penaltyPercentage ?? 0
 }
 
 export function getCurrentPenaltyPercentage({
@@ -383,7 +385,7 @@ export function isBetterCancellationPolicies(
     return false
   }
 
-  if (!newVal[0].dateTo) {
+  if (!newVal[0]?.dateTo) {
     return oldVal.every(oldCancellationPolicy => {
       const relatedNewCancellationPolicy = newVal.find(newCancellationPolicy =>
         dayjs(oldCancellationPolicy.dateTo).isBetween(
@@ -399,8 +401,8 @@ export function isBetterCancellationPolicies(
       }
 
       return (
-        oldCancellationPolicy.penaltyPercentage! >=
-        relatedNewCancellationPolicy.penaltyPercentage!
+        oldCancellationPolicy.penaltyPercentage >=
+        relatedNewCancellationPolicy.penaltyPercentage
       )
     })
   }
@@ -420,8 +422,8 @@ export function isBetterCancellationPolicies(
     }
 
     return (
-      oldCancellationPolicy.penaltyPercentage! >=
-      relatedNewCancellationPolicy.penaltyPercentage!
+      oldCancellationPolicy.penaltyPercentage >=
+      relatedNewCancellationPolicy.penaltyPercentage
     )
   })
 }
@@ -470,11 +472,17 @@ export function getSanitizedCancellationPolicies({
 export function getCurrentCancellationPolicy(
   sanitizedCancellationPolicies: ICancellationPolicy[],
 ): ICancellationPolicy {
-  return (
-    sanitizedCancellationPolicies.find(policy =>
-      dayjs().isBetween(dayjs(policy.dateFrom), dayjs(policy.dateTo)),
-    ) || sanitizedCancellationPolicies[0]
+  const found = sanitizedCancellationPolicies.find(policy =>
+    dayjs().isBetween(dayjs(policy.dateFrom), dayjs(policy.dateTo)),
   )
+  if (found) {
+    return found
+  }
+  const first = sanitizedCancellationPolicies[0]
+  if (!first) {
+    throw new Error('No cancellation policies available')
+  }
+  return first
 }
 
 function adjustIfFullHour(date: string): Dayjs {

package/src/constants/index.ts

@@ -1,4 +1,3 @@
-export * from './countries.ts'
 export * from './currencies.ts'
 export * from './environment.ts'
 export * from './hotel.ts'

package/src/countries/{constants.ts → countries.ts}

@@ -1,41 +1,8 @@
-// oxlint-disable max-lines
-import { CountryIso2Code } from '../constants/countries.ts'
+/* eslint-disable max-lines */
 import { Currency } from '../constants/currencies.ts'
 
-import type { Country } from '../types/country.ts'
+import type { Country } from './types.ts'
 
-/* @__PURE__ */
-export const EU_COUNTRIES_ISO2_CODE = new Set<string>([
-  CountryIso2Code.AT,
-  CountryIso2Code.BE,
-  CountryIso2Code.BG,
-  CountryIso2Code.CY,
-  CountryIso2Code.CZ,
-  CountryIso2Code.DE,
-  CountryIso2Code.DK,
-  CountryIso2Code.EE,
-  CountryIso2Code.ES,
-  CountryIso2Code.FI,
-  CountryIso2Code.FR,
-  CountryIso2Code.GR,
-  CountryIso2Code.HR,
-  CountryIso2Code.HU,
-  CountryIso2Code.IE,
-  CountryIso2Code.IT,
-  CountryIso2Code.LT,
-  CountryIso2Code.LU,
-  CountryIso2Code.LV,
-  CountryIso2Code.MT,
-  CountryIso2Code.NL,
-  CountryIso2Code.PL,
-  CountryIso2Code.PT,
-  CountryIso2Code.RO,
-  CountryIso2Code.SE,
-  CountryIso2Code.SI,
-  CountryIso2Code.SK,
-])
-
-/* @__PURE__ */
 export const COUNTRIES: Record<string, Country> = {
   AD: {
     areaCodes: null,
@@ -2512,7 +2479,6 @@ export const COUNTRIES: Record<string, Country> = {
   },
 }
 
-/* @__PURE__ */
 export const ISO_COUNTRIES = Object.values(COUNTRIES).map(
   country => country.iso2,
 )

package/src/{constants/countries.ts → countries/country.ts}

@@ -1,4 +1,3 @@
-/* eslint-disable max-lines */
 export enum CountryIso2Code {
   AD = 'AD',
   AE = 'AE',

package/src/countries/europe.ts

@@ -0,0 +1,35 @@
+import { CountryIso2Code } from './country.ts'
+
+export const EU_COUNTRIES_ISO2_CODE = new Set<string>([
+  CountryIso2Code.AT,
+  CountryIso2Code.BE,
+  CountryIso2Code.BG,
+  CountryIso2Code.CY,
+  CountryIso2Code.CZ,
+  CountryIso2Code.DE,
+  CountryIso2Code.DK,
+  CountryIso2Code.EE,
+  CountryIso2Code.ES,
+  CountryIso2Code.FI,
+  CountryIso2Code.FR,
+  CountryIso2Code.GR,
+  CountryIso2Code.HR,
+  CountryIso2Code.HU,
+  CountryIso2Code.IE,
+  CountryIso2Code.IT,
+  CountryIso2Code.LT,
+  CountryIso2Code.LU,
+  CountryIso2Code.LV,
+  CountryIso2Code.MT,
+  CountryIso2Code.NL,
+  CountryIso2Code.PL,
+  CountryIso2Code.PT,
+  CountryIso2Code.RO,
+  CountryIso2Code.SE,
+  CountryIso2Code.SI,
+  CountryIso2Code.SK,
+])
+
+export function isInEu(countryCode: string): boolean {
+  return EU_COUNTRIES_ISO2_CODE.has(countryCode)
+}

package/src/countries/index.ts

@@ -1,7 +1,4 @@
-import { EU_COUNTRIES_ISO2_CODE } from './constants.ts'
-
-export * from './constants.ts'
-
-export function isInEu(countryCode: string): boolean {
-  return EU_COUNTRIES_ISO2_CODE.has(countryCode)
-}
+export * from './countries.ts'
+export * from './country.ts'
+export * from './europe.ts'
+export type * from './types.ts'

package/src/{types/country.ts → countries/types.ts}

@@ -1,5 +1,5 @@
+import type { ISO_COUNTRIES } from './index.ts'
 import type { Currency } from '../constants/currencies.ts'
-import type { ISO_COUNTRIES } from '../countries/constants.ts'
 
 export type CountryIsoCode = (typeof ISO_COUNTRIES)[number]
 

package/src/currencies/index.ts

@@ -1,6 +1,6 @@
 /* eslint-disable max-lines */
 import { Currency } from '../constants/currencies.ts'
-import { pick } from '../utils/object-tools.ts'
+import { pick } from '../utils/pick.ts'
 
 import type { ICurrency } from '../types/currency.ts'
 

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

@@ -1,4 +1,5 @@
-import type { CountryIso2Code } from '#constants'
+// eslint-disable-next-line no-restricted-imports
+import type { CountryIso2Code } from '../../countries/index.ts'
 
 type CountryIso2CodeType = `${CountryIso2Code}`
 

package/src/types/elements/currency.ts

@@ -1,3 +1,4 @@
-import type { Currency } from '#constants'
+// eslint-disable-next-line no-restricted-imports
+import type { Currency } from '../../currencies/index.ts'
 
 export type CurrencyType = `${Currency}`

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

@@ -0,0 +1,29 @@
+import type { CurrencyType } from './currency.ts'
+import type { HotelOffersSortByType } from './hotel-offer.ts'
+// eslint-disable-next-line no-restricted-imports
+import type { Locale } from '../../constants/index.ts'
+
+export enum HotelOffersSortByOrderEnum {
+  Asc = 'asc',
+  Desc = 'desc',
+}
+
+export type HotelOffersSortByOrderType = `${HotelOffersSortByOrderEnum}`
+
+export interface HotelOffersListPayload {
+  currency: CurrencyType
+  hotelOfferRequestId: string
+  endingBefore?: string | null
+  filterByPrice?: string
+  filterByReviewRating?: number
+  filterByStar?: string
+  hotelRoomOffersLimit?: number
+  includeHotelContentDetails?: boolean | null
+  lang?: Locale
+  limit?: number
+  onlyRecommendedHotelOffers?: boolean | null
+  priceHistogramStepCount?: number
+  sortBy?: HotelOffersSortByType
+  sortByOrder?: HotelOffersSortByOrderType
+  startingAfter?: string | null
+}

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

@@ -60,9 +60,98 @@ export interface HotelOfferRequest {
    * @type {SourceMarket}
    */
   sourceMarket: SourceMarket
+  /**
+   * Date of the **Hotel Room Offer Request** creation
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  createdAt: string
+  /**
+   * id of the **Hotel Offer Request**
+   * @type {string}
+   */
+  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.
+   *
+   * <b style="color: red;">If address cannot be geocoded (transformed into a latitude/longitude pair) provided **latitude** and **longitude** parameters will be used as fallback.</b>
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  address?: string | null
+  /**
+   * The total number of adults who will be staying in the property.
+   * @type {number}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  adultCount: number
+  /**
+   * Date of check-in formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  checkInDate: string
+  /**
+   * Date of check-out formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  checkOutDate: string
+  /**
+   * A comma-separated list of child ages (0 up to 17). e.g.: "3,7" represents 2 children respectively 3 and 7 years old.
+   * @type {string}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  children?: string | null
+  /**
+   *
+   * @type {EventMetadataApi}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  eventMetadata?: EventMetadata | null
+  /**
+   * Search location latitude.
+   *
+   * <b style="color: red;"> when no address parameter passed.</b>
+   * @type {number}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  latitude?: number | null
+  /**
+   * Search location longitude.
+   *
+   * <b style="color: red;"> when no address parameter passed.</b>
+   * @type {number}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  longitude?: number | null
+  /**
+   * The total number of rooms requested for the stay. Results may display offers matching a different room count than the requested one, however those results will always provide enough occupancy for the total guest count needed.
+   *
+   * Constraint: The **room_count** cannot be greater than the requested guest count (adult and children guests) and the minimum **room_count** cannot be less than the total guest count (adult and children guests) divided by 4, meaning that the maximum number of guest in a single room cannot be greeater than 4.
+   * @type {number}
+   * @memberof HotelOfferRequestApiResponse
+   */
+  roomCount: number
+  /**
+   *
+   * @type {SourceMarket}
+   * @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
 }

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

@@ -1,4 +1,3 @@
-import type { Currency } from '#constants'
 import type { Amenities } from './amenity.ts'
 import type { HotelImage } from './hotel-image.ts'
 import type { HotelImages } from './hotel-images.ts'
@@ -6,6 +5,8 @@ import type { HotelReviewRating } from './hotel-review-rating.ts'
 import type { HotelRoomOffer } from './hotel-room-offer.ts'
 import type { Tag } from './tag.ts'
 import type { TravelTimeItem } from './travel-times.ts'
+// eslint-disable-next-line no-restricted-imports
+import type { Currency } from '../../currencies/index.ts'
 
 export interface HotelOffer {
   /**
@@ -206,3 +207,5 @@ export enum HotelOffersSortByEnum {
   ReviewRating = 'review_rating',
   TopPicks = 'top_picks',
 }
+
+export type HotelOffersSortByType = `${HotelOffersSortByEnum}`

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

@@ -64,6 +64,69 @@ export interface HotelRoomOfferRequest {
   id: string
 }
 
+export interface HotelRoomOfferRequestResponse {
+  /**
+   * Requested number of adult(s) to be accommodated.
+   * @type {number}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  adultCount: number
+  /**
+   * Check-in date formatted as `YYYY-MM-DD`.
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  checkInDate: string
+  /**
+   * Check-out date formatted as `YYYY-MM-DD`.
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  checkOutDate: string
+  /**
+   * A comma-separated list of child ages (0 up to 17). e.g.: "3,7" represents 2 children respectively 3 and 7 years old.
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  children?: string | null
+  /**
+   *
+   * @type {EventMetadataApi}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  eventMetadata?: EventMetadata | null
+  /**
+   * id of requested hotel
+   * @type {string}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  hotelId: string
+  /**
+   * Number of room(s) requested. Results may display offers matching a different room count than the requested one, however those results will always provide enough occupancy for the total guest count needed.
+   * @type {number}
+   * @memberof HotelRoomOfferRequestApiResponse
+   */
+  roomCount: number
+  /**
+   *
+   * @type {SourceMarket}
+   * @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<
   HotelRoomOfferRequest,
   | 'adultCount'

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

@@ -1,12 +1,65 @@
-import type { BreakfastOptionType } from '#constants'
 import type { CancellationPolicy } from './cancellation-policy.ts'
 import type { CurrencyType } from './currency.ts'
 import type { HotelRoomOfferPackageType } from './hotel-room-offer-package-type.ts'
 import type { HotelRoomOfferType } from './hotel-room-offer-type.ts'
 import type { HotelRoom } from './hotel-room.ts'
+import type { MetaPollingResponse } from './meta-polling.ts'
 import type { SourceMarket } from './source-market.ts'
 import type { Tag } from './tag.ts'
 import type { Tax } from './tax.ts'
+// eslint-disable-next-line no-restricted-imports
+import type { BreakfastOptionType } from '../../constants/index.ts'
+
+export interface HotelRoomOffersDataResponse {
+  /**
+   * The total number of adults who will be staying in the property.
+   * @type {number}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  adultCount: number
+  /**
+   * Date of check-in formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  checkInDate: string
+  /**
+   * Date of check-out formatted as YYYY-MM-DD.
+   * @type {string}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  checkOutDate: string
+  /**
+   * A comma-separated list of child ages (0 up to 17). e.g.: "3,7" represents 2 children respectively 3 and 7 years old.
+   * @type {string}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  children?: string | null
+  /**
+   *
+   * @type {CurrencyType}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  currency: CurrencyType
+  /**
+   * Hotel id
+   * @type {string}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  hotelId: string
+  /**
+   * List of **Hotel Room Offers** sorted by price ascending.
+   * @type {HotelRoomOffer[]}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  hotelRoomOffers: HotelRoomOffer[]
+  /**
+   * Hotel timezone
+   * @type {string}
+   * @memberof HotelRoomOffersDataApiResponse
+   */
+  hotelTimezone: string
+}
 
 /**
  * Description of the Hotel Room Offer.
@@ -146,6 +199,28 @@ export interface HotelRoomOffer {
   type?: HotelRoomOfferType
 }
 
+export interface HotelRoomOffersResponse {
+  /**
+   *
+   * @type {HotelRoomOffersDataResponse}
+   * @memberof HotelRoomOffersApiResponse
+   */
+  data: HotelRoomOffersDataResponse
+  /**
+   *
+   * @type {any}
+   * @memberof HotelRoomOffersApiResponse
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  event?: any | null
+  /**
+   *
+   * @type {MetaApiPollingResponse}
+   * @memberof HotelRoomOffersApiResponse
+   */
+  meta: MetaPollingResponse
+}
+
 export interface HotelRoomOfferResponse {
   /**
    * The total number of adults who will be staying in the property.

package/src/types/elements/index.ts

@@ -20,3 +20,5 @@ export type * from './hotel.ts'
 export * from './hotel-offer.ts'
 export * from './contact-person.ts'
 export type * from './hotel-review-rating.ts'
+export type * from './travel-times.ts'
+export * from './hotel-offer-list.ts'

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

@@ -0,0 +1,31 @@
+// eslint-disable-next-line no-restricted-imports
+import type { PollerStatus } from '../../constants/poller.ts'
+
+type PollerType = `${PollerStatus}`
+
+export interface MetaPollingResponse {
+  /**
+   * A cursor to use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+   * @type {string}
+   * @memberof MetaApiPollingResponse
+   */
+  endingBefore?: string | null
+  /**
+   * A limit on the number of object to be returned.
+   * @type {number}
+   * @memberof MetaApiPollingResponse
+   */
+  limit?: number
+  /**
+   * A cursor to use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+   * @type {string}
+   * @memberof MetaApiPollingResponse
+   */
+  startingAfter?: string | null
+  /**
+   *
+   * @type {PollerType}
+   * @memberof MetaApiPollingResponse
+   */
+  status: PollerType
+}

package/src/types/geo-coordinates.ts

@@ -0,0 +1,4 @@
+export interface GeoCoordinates {
+  latitude: number
+  longitude: number
+}

package/src/types/index.ts

@@ -2,10 +2,10 @@ export type * from './api.ts'
 export * from './booking.ts'
 export type * from './calendar.ts'
 export type * from './cancellation-policy.ts'
-export type * from './country.ts'
 export type * from './currency.ts'
 export type * from './date.ts'
 export type * from './event.ts'
+export type * from './geo-coordinates.ts'
 export type * from './hotel-contract.ts'
 export type * from './hotel-room-stock.ts'
 export type * from './money-object.ts'

package/src/utils/{math.ts → amount-from-percentage.ts}

@@ -1,13 +1,3 @@
-export function weightedMean(values: number[], weights: number[]): number {
-  const sum = values.reduce(
-    (acc: number, val: number, i: number) => acc + val * weights[i],
-    0,
-  )
-  const sumWeights = weights.reduce((acc: number, val: number) => acc + val, 0)
-
-  return sum / sumWeights
-}
-
 export function amountFromPercentage(
   percentage: number,
   amount: number,

package/src/utils/case-transformers.ts

@@ -23,7 +23,6 @@ export enum CaseTransformer {
   Snake = 'snakeCase',
 }
 
-/* @__PURE__ */
 const CASE_TRANSORMERS_MAPPING = {
   [CaseTransformer.Camel]: camelCase,
   [CaseTransformer.Capital]: capitalCase,