@revolugo/common 6.9.3-beta.9 → 6.9.4-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revolugo/common",
-  "version": "6.9.3-beta.9",
+  "version": "6.9.4-rc.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",
     "./constants": "./src/constants/index.ts",

package/src/cancellation-policies.test.ts

@@ -15,17 +15,13 @@ import type {
 } from './cancellation-policies.ts'
 import type { ICancellationPolicy } from './types/index.ts'
 
-function getUTCLocalTime(date: string, timezone: string): Dayjs {
-  return dayjs.tz(date, timezone).utc()
-}
+const getUTCLocalTime = (date: string, timezone: string): Dayjs =>
+  dayjs.tz(date, timezone).utc()
 
-function getFormattedUTCLocalTime(date: string, timezone: string): string {
-  return getUTCLocalTime(date, timezone).format()
-}
+const getFormattedUTCLocalTime = (date: string, timezone: string): string =>
+  getUTCLocalTime(date, timezone).format()
 
-function nextDay(date: string) {
-  return dayjs(date).add(1, 'day').utc().format()
-}
+const nextDay = (date: string) => dayjs(date).add(1, 'day').utc().format()
 
 const timezone = 'America/Los_Angeles'
 
@@ -83,7 +79,7 @@ const CANCELLATION_POLICIES = [
 ]
 
 describe('sanitizeCancellationPolicies', () => {
-  function testCancellationPolicies({
+  const testCancellationPolicies = ({
     bookingDatetime,
     cancellationPolicies,
     checkInDate,
@@ -97,8 +93,8 @@ describe('sanitizeCancellationPolicies', () => {
     message: string
     releaseDate?: string
     results: ICancellationPolicy[]
-  }): void {
-    return test(message, () => {
+  }): void => {
+    test(message, () => {
       const sanitizedCancellationPolicies = sanitizeCancellationPolicies({
         bookingDatetime,
         cancellationPolicies,
@@ -1038,3 +1034,4 @@ describe('getCurrentPenaltyPercentage', () => {
     ).to.equal(PP_4)
   })
 })
+/* eslint-enable max-lines */

package/src/cancellation-policies.ts

@@ -6,9 +6,7 @@ import { isEmpty } from './utils/is-empty.ts'
 
 import type { ICancellationPolicy } from './types/cancellation-policy.ts'
 
-function nextDay(date: string) {
-  return dayjs(date).add(1, 'day').utc().format()
-}
+const nextDay = (date: string) => dayjs(date).add(1, 'day').utc().format()
 
 function isUTCDate(date: string) {
   return /\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])T(?:[01]\d|2[0-3])(?::[0-5]\d){2}(?:\.\d+|)(?:Z|[+-]\d{2}:?\d{2})/u.test(
@@ -16,17 +14,16 @@ function isUTCDate(date: string) {
   )
 }
 
-function filterMatchingCancellationPolicies({
+const filterMatchingCancellationPolicies = ({
   cancellationPolicies,
   date,
 }: {
   cancellationPolicies: ICancellationPolicy[]
   date: string
-}) {
-  return cancellationPolicies.filter(cp =>
+}) =>
+  cancellationPolicies.filter(cp =>
     dayjs(date).isBetween(cp.dateFrom, cp.dateTo, undefined, '[)'),
   )
-}
 
 export interface SanitizeCancellationPolicies {
   bookingDatetime?: string
@@ -37,13 +34,13 @@ export interface SanitizeCancellationPolicies {
 }
 
 // eslint-disable-next-line complexity, max-statements, max-lines-per-function
-export function sanitizeCancellationPolicies({
+export const sanitizeCancellationPolicies = ({
   bookingDatetime,
   cancellationPolicies,
   checkInDate,
   releaseDate,
   timezone,
-}: SanitizeCancellationPolicies): ICancellationPolicy[] {
+}: SanitizeCancellationPolicies): ICancellationPolicy[] => {
   if (!bookingDatetime) {
     throw new Error('Missing "bookingDatetime" option')
   }
@@ -132,9 +129,8 @@ export function sanitizeCancellationPolicies({
     cancellationPolicies?.map(cp => ({ ...cp })),
   )
 
-  function isValidCancellationPolicy(cp: ICancellationPolicy) {
-    return cp.dateFrom && cp.dateTo && dayjs(cp.dateFrom).isBefore(cp.dateTo)
-  }
+  const isValidCancellationPolicy = (cp: ICancellationPolicy) =>
+    cp.dateFrom && cp.dateTo && dayjs(cp.dateFrom).isBefore(cp.dateTo)
 
   const isValidCancellationPolicies = compactedCancellationPolicies.every(
     isValidCancellationPolicy,
@@ -288,14 +284,14 @@ export interface GetPenaltyPercentage {
   timezone?: string
 }
 
-export function getPenaltyPercentage({
+export const getPenaltyPercentage = ({
   bookingDatetime,
   cancellationPolicies,
   checkInDate,
   datetime,
   releaseDate,
   timezone,
-}: GetPenaltyPercentage): number {
+}: GetPenaltyPercentage): number => {
   if (!bookingDatetime) {
     throw new Error('Missing "bookingDatetime" option')
   }
@@ -348,7 +344,7 @@ export function getPenaltyPercentage({
   )
 }
 
-export function getCurrentPenaltyPercentage({
+export const getCurrentPenaltyPercentage = ({
   bookingDatetime,
   cancellationPolicies,
   checkInDate,
@@ -360,7 +356,7 @@ export function getCurrentPenaltyPercentage({
   checkInDate: string
   releaseDate?: string
   timezone: string
-}): number {
+}): number => {
   const datetimeUTC = dayjs().utc().format()
 
   return getPenaltyPercentage({
@@ -373,10 +369,10 @@ export function getCurrentPenaltyPercentage({
   })
 }
 
-export function isBetterCancellationPolicies(
+export const isBetterCancellationPolicies = (
   newVal: ICancellationPolicy[],
   oldVal: ICancellationPolicy[],
-): boolean {
+): boolean => {
   if (isEmpty(newVal)) {
     return true
   }
@@ -428,13 +424,13 @@ export function isBetterCancellationPolicies(
   })
 }
 
-export function parseCancellationPolicies(
+export const parseCancellationPolicies = (
   cancellationPolicies: {
     dateFrom: string
     dateTo: string
     penaltyPercentage: number
   }[],
-): ICancellationPolicy[] {
+): ICancellationPolicy[] => {
   if (typeof cancellationPolicies === 'string') {
     try {
       return JSON.parse(cancellationPolicies) as ICancellationPolicy[]
@@ -446,7 +442,7 @@ export function parseCancellationPolicies(
   return cancellationPolicies
 }
 
-export function getSanitizedCancellationPolicies({
+export const getSanitizedCancellationPolicies = ({
   cancellationPolicies,
   checkInDate,
   initialDate,
@@ -456,7 +452,7 @@ export function getSanitizedCancellationPolicies({
   cancellationPolicies: ICancellationPolicy[]
   timezone: string
   initialDate?: string
-}): ICancellationPolicy[] {
+}): ICancellationPolicy[] => {
   if (!cancellationPolicies.length) {
     return []
   }
@@ -469,15 +465,12 @@ export function getSanitizedCancellationPolicies({
   })
 }
 
-export function getCurrentCancellationPolicy(
+export const getCurrentCancellationPolicy = (
   sanitizedCancellationPolicies: ICancellationPolicy[],
-): ICancellationPolicy {
-  return (
-    sanitizedCancellationPolicies.find(policy =>
-      dayjs().isBetween(dayjs(policy.dateFrom), dayjs(policy.dateTo)),
-    ) || sanitizedCancellationPolicies[0]
-  )
-}
+): ICancellationPolicy =>
+  sanitizedCancellationPolicies.find(policy =>
+    dayjs().isBetween(dayjs(policy.dateFrom), dayjs(policy.dateTo)),
+  ) || sanitizedCancellationPolicies[0]
 
 function adjustIfFullHour(date: string): Dayjs {
   const parsed = dayjs(date)

package/src/constants/countries.ts

@@ -2754,6 +2754,7 @@ export const COUNTRIES: Record<string, Country> = {
     timezone: 'Africa/Harare',
   },
 }
+/* eslint-enable max-lines */
 
 export const ISO_COUNTRIES = Object.values(COUNTRIES).map(
   country => country.iso2,

package/src/constants/currencies.ts

@@ -1,4 +1,5 @@
 /* eslint-disable max-lines */
+
 import { pick } from '../utils/object-tools.ts'
 
 import type { ICurrency } from '../types/currency.ts'
@@ -1974,3 +1975,4 @@ export const STRIPE_ZERO_DECIMAL_CURRENCIES = Object.values(CURRENCIES_MAP)
     currency => currency.zeroDecimal && currency.code in STRIPE_CURRENCIES_MAP,
   )
   .map(currency => currency.code)
+/* eslint-enable max-lines */

package/src/types/index.ts

@@ -16,4 +16,3 @@ export * from './taxable.ts'
 export * from './severities.ts'
 export * from './http-exception/index.ts'
 export * from './hotel-rooming-list.ts'
-export * from './elements/index.ts'

package/src/utils/array-tools.ts

@@ -6,9 +6,8 @@ export function chunk<T>(array: T[], size: number): T[][] {
   return chunks
 }
 
-export function getRandomElementFromArray<T>(array: readonly T[]): T {
-  return array[Math.floor(Math.random() * array.length)]
-}
+export const getRandomElementFromArray = <T>(array: readonly T[]): T =>
+  array[Math.floor(Math.random() * array.length)]
 
 export function shuffleArray<T>(array: T[]): T[] {
   const shuffled = [...array]

package/src/utils/colors.ts

@@ -1,9 +1,9 @@
 import { generateNumbersFromStr } from './numbers.ts'
 
-export function generateRandomColorFromString(
+export const generateRandomColorFromString = (
   str: string,
   existingColors: string[],
-): string {
+): string => {
   const [num1, num2] = generateNumbersFromStr(str)
   // adjust this value to control how close the generated color is to the existing colors
   const hueRange = 5
@@ -20,7 +20,7 @@ export function generateRandomColorFromString(
   return newColor
 }
 
-export function hexToRgba(hex: string, opacity: number): string {
+export const hexToRgba = (hex: string, opacity: number): string => {
   // Copy the value of 'hex' into a local variable without modifying the original parameter
   let hexWithoutHash = hex
 
@@ -44,7 +44,7 @@ export function hexToRgba(hex: string, opacity: number): string {
 const barColors = ['#006EFF', '#FF9800', '#9C27B0', '#F44336', '#4CAF50']
 const contractIdToColors = new Map<string, string>()
 
-export function getRangeColor(id: string): string {
+export const getRangeColor = (id: string): string => {
   if (!contractIdToColors.has(id)) {
     contractIdToColors.set(id, generateRandomColorFromString(id, barColors))
   }

package/src/utils/countries.ts

@@ -1,5 +1,4 @@
 import { EU_COUNTRIES_ISO2_CODE } from '../constants/countries.ts'
 
-export function isInEu(countryCode: string): boolean {
-  return EU_COUNTRIES_ISO2_CODE.has(countryCode)
-}
+export const isInEu = (countryCode: string): boolean =>
+  EU_COUNTRIES_ISO2_CODE.has(countryCode)

package/src/utils/currency.ts

@@ -1,6 +1,6 @@
 import { CURRENCIES_MAP, type Currency } from '../constants/index.ts'
 
-export function getCurrencySymbol(currency: Currency): string {
+export const getCurrencySymbol = (currency: Currency): string => {
   const symbol = CURRENCIES_MAP[currency]?.symbol
 
   if (!symbol) {
@@ -10,19 +10,16 @@ export function getCurrencySymbol(currency: Currency): string {
   return symbol
 }
 
-export function isZeroDecimal(currency: Currency): boolean {
-  return (
-    (CURRENCIES_MAP[currency] && CURRENCIES_MAP[currency].zeroDecimal) || false
-  )
-}
+export const isZeroDecimal = (currency: Currency): boolean =>
+  (CURRENCIES_MAP[currency] && CURRENCIES_MAP[currency].zeroDecimal) || false
 
-export function normalizeAmount({
+export const normalizeAmount = ({
   amount,
   currency,
 }: {
   amount: number
   currency: Currency
-}): number {
+}): number => {
   if (isZeroDecimal(currency)) {
     return amount
   }
@@ -30,13 +27,13 @@ export function normalizeAmount({
   return amount * 100
 }
 
-export function denormalizeAmount({
+export const denormalizeAmount = ({
   amount,
   currency,
 }: {
   amount: number
   currency: Currency
-}): number {
+}): number => {
   if (isZeroDecimal(currency)) {
     return amount
   }
@@ -44,7 +41,7 @@ export function denormalizeAmount({
   return amount / 100
 }
 
-export function formatAmount({
+export const formatAmount = ({
   amount,
   currency,
   locale = 'en',
@@ -54,7 +51,7 @@ export function formatAmount({
   currency: string
   locale?: string
   space?: string
-}): string {
+}): string => {
   const fractionDigits = amount.toFixed(2).endsWith('.00') ? 0 : 2
 
   return (
@@ -169,16 +166,16 @@ export class MoneyCalculator {
       return this
     }
 
-    const startingIsNormalized = this.isNormalized
+    const { isNormalized } = this
 
-    if (startingIsNormalized) {
+    if (isNormalized) {
       this.denormalize()
     }
 
     this.amount *= exchangeRate
     this.currency = currency
 
-    if (startingIsNormalized) {
+    if (isNormalized) {
       this.normalize()
     }
 
@@ -186,13 +183,13 @@ export class MoneyCalculator {
   }
 }
 
-export function ceilNormalizedAmount({
+export const ceilNormalizedAmount = ({
   amount,
   currency,
 }: {
   amount: number
   currency: Currency
-}): number {
+}): number => {
   const denormalizedAmount = denormalizeAmount({
     amount,
     currency,
@@ -204,13 +201,13 @@ export function ceilNormalizedAmount({
   })
 }
 
-export function floorNormalizedAmount({
+export const floorNormalizedAmount = ({
   amount,
   currency,
 }: {
   amount: number
   currency: Currency
-}): number {
+}): number => {
   const denormalizedAmount = denormalizeAmount({
     amount,
     currency,

package/src/utils/dates.ts

@@ -20,11 +20,11 @@ export function sortDates(dates: string[]): string[] {
   return validDates.sort((a, b) => (dayjs(a).isAfter(dayjs(b), 'day') ? 1 : -1))
 }
 
-export function getDateRange(
+export const getDateRange = (
   start: Date | string,
   end: Date | string,
   format: string = DATE_STRING_FORMAT,
-): string[] {
+): string[] => {
   const dates: string[] = []
   let current = dayjs(start)
 
@@ -80,9 +80,11 @@ export function generateDates(
   }
 
   const totalDays = end.diff(start, 'day') + 1
-  const dates = Array.from({ length: totalDays }, (_, i) =>
-    start.add(i, 'day').toDate(),
-  )
+  const dates = new Array<Date>(totalDays)
+
+  for (let i = 0; i < totalDays; i++) {
+    dates[i] = start.add(i, 'day').toDate()
+  }
 
   return dates
 }

package/src/utils/debounce.ts

@@ -46,7 +46,7 @@ export function debounce<Args extends any[], F extends (...args: Args) => any>(
     return waitMilliseconds
   }
 
-  function debouncedFunction(
+  const debouncedFunction = function debouncedFunction(
     this: ThisParameterType<F>,
     ...args: Parameters<F>
   ) {
@@ -54,7 +54,7 @@ export function debounce<Args extends any[], F extends (...args: Args) => any>(
     const context = this
     // eslint-disable-next-line consistent-return
     return new Promise<Awaited<ReturnType<F>>>((resolve, reject) => {
-      function invokeFunction() {
+      const invokeFunction = function invokeFunction() {
         timeoutId = undefined
         lastInvokeTime = Date.now()
         if (!isImmediate) {

package/src/utils/find-unique-keys.ts

@@ -1,6 +1,6 @@
-export function findUniqueKeys(
+export const findUniqueKeys = (
   objects: { [key: string]: unknown }[],
-): string[] {
+): string[] => {
   const objectKeys = objects.flatMap(Object.keys)
   return [...new Set(objectKeys)]
 }

package/src/utils/index.ts

@@ -27,3 +27,4 @@ export * from './validators.ts'
 export * from './value-tools.ts'
 export * from './create-composite-key.ts'
 export * from './children-tools.ts'
+export * from './shake.ts'

package/src/utils/lang-default-fallbacks.ts

@@ -2,7 +2,7 @@ import { LOCALE_TO_LANG, Locale } from '../constants/locales.ts'
 
 import type { Lang } from '../constants/locales.ts'
 
-export function langDefaultFallbacks(lang?: Locale): Lang[] {
+export const langDefaultFallbacks = (lang?: Locale): Lang[] => {
   if (!lang || lang === Locale.en_US) {
     return [LOCALE_TO_LANG[Locale.en_US]]
   }

package/src/utils/math.ts

@@ -1,4 +1,4 @@
-export function weightedMean(values: number[], weights: number[]): number {
+export const weightedMean = (values: number[], weights: number[]): number => {
   const sum = values.reduce(
     (acc: number, val: number, i: number) => acc + val * weights[i],
     0,
@@ -8,11 +8,11 @@ export function weightedMean(values: number[], weights: number[]): number {
   return sum / sumWeights
 }
 
-export function amountFromPercentage(
+export const amountFromPercentage = (
   percentage: number,
   amount: number,
   roundingType: 'none' | 'round' | 'ceil' | 'floor' = 'none',
-): number {
+): number => {
   if (Number.isNaN(Number(percentage)) || Number.isNaN(Number(amount))) {
     throw new TypeError(`${percentage} || ${amount} is NaN`)
   }

package/src/utils/numbers.ts

@@ -1,4 +1,4 @@
-export function generateNumbersFromStr(str: string): [number, number] {
+export const generateNumbersFromStr = (str: string): [number, number] => {
   let hash = 5381
   for (let i = 0; i < str.length; i++) {
     // eslint-disable-next-line no-bitwise
@@ -14,14 +14,13 @@ export function generateNumbersFromStr(str: string): [number, number] {
   return [num1, num2]
 }
 
-export function randomInt(min: number, max: number): number {
-  return Math.floor(Math.random() * (max - min + 1) + min)
-}
+export const randomInt = (min: number, max: number): number =>
+  Math.floor(Math.random() * (max - min + 1) + min)
 
-export function computeSellingPrice(
+export const computeSellingPrice = (
   buyingPrice: number | string | null = 0,
   rate: number | string | null = 0,
-): number {
+): number => {
   if (Number.isNaN(Number(buyingPrice)) || Number.isNaN(Number(rate))) {
     throw new TypeError('price or rate is NaN')
   }
@@ -31,10 +30,10 @@ export function computeSellingPrice(
   return Math.ceil(Math.floor(sellingPrice * 100) / 100)
 }
 
-export function computeMarginRate(
+export const computeMarginRate = (
   buyingPrice: number | string,
   sellingPrice: number | string,
-): number {
+): number => {
   const buyingPriceNum = Number(buyingPrice)
   const sellingPriceNum = Number(sellingPrice)
 

package/src/utils/object-tools.ts

@@ -15,10 +15,10 @@ type Merge<T, S> = {
       : never
 }
 
-export function customMerge<T extends object, S extends object>(
+export const customMerge = <T extends object, S extends object>(
   target: T,
   source: S,
-): Merge<T, S> {
+): Merge<T, S> => {
   for (const key of Object.keys(source)) {
     const sourceValue = source[key as keyof S]
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/utils/shake.ts

@@ -0,0 +1,22 @@
+/**
+ * Removes (shakes out) undefined entries from an
+ * object. Optional second argument shakes out values
+ * by custom evaluation.
+ */
+export function shake<RemovedKeys extends string, T>(
+  obj: T,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  filter: (value: any) => boolean = x => x === undefined,
+): Omit<T, RemovedKeys> {
+  if (!obj) {
+    return {} as T
+  }
+  const keys = Object.keys(obj) as (keyof T)[]
+  return keys.reduce((acc, key) => {
+    if (filter(obj[key])) {
+      return acc
+    }
+    acc[key] = obj[key]
+    return acc
+  }, {} as T)
+}

package/src/utils/strings.ts

@@ -1,6 +1,5 @@
-export function generatePseudoRandomString(length: number): string {
-  return Array.from({ length }, () => Math.random().toString(36)[2]).join('')
-}
+export const generatePseudoRandomString = (length: number): string =>
+  Array.from({ length }, () => Math.random().toString(36)[2]).join('')
 
 const TS_QUERY_SPECIAL_CHARS = new Set([
   '&',