@tfehotels/tfe-gatsby-library 1.0.0

package/src/browser/utils/location.ts

@@ -0,0 +1,213 @@
+export const countryPrefixes = [
+  ["af", "93", "Afghanistan"],
+  ["al", "355", "Albania"],
+  ["dz", "213", "Algeria"],
+  ["ad", "376", "Andorra"],
+  ["ao", "244", "Angola"],
+  ["ag", "1268", "Antigua and Barbuda"],
+  ["ar", "54", "Argentina"],
+  ["am", "374", "Armenia"],
+  ["aw", "297", "Aruba"],
+  ["au", "61", "Australia"],
+  ["at", "43", "Austria"],
+  ["az", "994", "Azerbaijan"],
+  ["bs", "1242", "Bahamas"],
+  ["bh", "973", "Bahrain"],
+  ["bd", "880", "Bangladesh"],
+  ["bb", "1246", "Barbados"],
+  ["by", "375", "Belarus"],
+  ["be", "32", "Belgium"],
+  ["bz", "501", "Belize"],
+  ["bj", "229", "Benin"],
+  ["bt", "975", "Bhutan"],
+  ["bo", "591", "Bolivia"],
+  ["ba", "387", "Bosnia and Herzegovina"],
+  ["bw", "267", "Botswana"],
+  ["br", "55", "Brazil"],
+  ["io", "246", "British Indian Ocean Territory"],
+  ["bn", "673", "Brunei"],
+  ["bg", "359", "Bulgaria"],
+  ["bf", "226", "Burkina Faso"],
+  ["bi", "257", "Burundi"],
+  ["kh", "855", "Cambodia"],
+  ["cm", "237", "Cameroon"],
+  ["ca", "1", "Canada"],
+  ["cv", "238", "Cape Verde"],
+  ["bq", "599", "Caribbean Netherlands"],
+  ["cf", "236", "Central African Republic"],
+  ["td", "235", "Chad"],
+  ["cl", "56", "Chile"],
+  ["cn", "86", "China"],
+  ["co", "57", "Colombia"],
+  ["km", "269", "Comoros"],
+  ["cd", "243", "Congo"],
+  ["cg", "242", "Congo"],
+  ["cr", "506", "Costa Rica"],
+  ["ci", "225", "Côte d'Ivoire"],
+  ["hr", "385", "Croatia"],
+  ["cu", "53", "Cuba"],
+  ["cw", "599", "Curaçao"],
+  ["cy", "357", "Cyprus"],
+  ["cz", "420", "Czech Republic"],
+  ["dk", "45", "Denmark"],
+  ["dj", "253", "Djibouti"],
+  ["dm", "1767", "Dominica"],
+  ["do", "1", "Dominican Republic"],
+  ["ec", "593", "Ecuador"],
+  ["eg", "20", "Egypt"],
+  ["sv", "503", "El Salvador"],
+  ["gq", "240", "Equatorial Guinea"],
+  ["er", "291", "Eritrea"],
+  ["ee", "372", "Estonia"],
+  ["et", "251", "Ethiopia"],
+  ["fj", "679", "Fiji"],
+  ["fi", "358", "Finland"],
+  ["fr", "33", "France"],
+  ["gf", "594", "French Guiana"],
+  ["pf", "689", "French Polynesia"],
+  ["ga", "241", "Gabon"],
+  ["gm", "220", "Gambia"],
+  ["ge", "995", "Georgia"],
+  ["de", "49", "Germany"],
+  ["gh", "233", "Ghana"],
+  ["gr", "30", "Greece"],
+  ["gd", "1473", "Grenada"],
+  ["gp", "590", "Guadeloupe"],
+  ["gu", "1671", "Guam"],
+  ["gt", "502", "Guatemala"],
+  ["gn", "224", "Guinea"],
+  ["gw", "245", "Guinea-Bissau"],
+  ["gy", "592", "Guyana"],
+  ["ht", "509", "Haiti"],
+  ["hn", "504", "Honduras"],
+  ["hk", "852", "Hong Kong"],
+  ["hu", "36", "Hungary"],
+  ["is", "354", "Iceland"],
+  ["in", "91", "India"],
+  ["id", "62", "Indonesia"],
+  ["ir", "98", "Iran"],
+  ["iq", "964", "Iraq"],
+  ["ie", "353", "Ireland"],
+  ["il", "972", "Israel"],
+  ["it", "39", "Italy"],
+  ["jm", "1876", "Jamaica"],
+  ["jp", "81", "Japan"],
+  ["jo", "962", "Jordan"],
+  ["kz", "7", "Kazakhstan"],
+  ["ke", "254", "Kenya"],
+  ["ki", "686", "Kiribati"],
+  ["xk", "383", "Kosovo"],
+  ["kw", "965", "Kuwait"],
+  ["kg", "996", "Kyrgyzstan"],
+  ["la", "856", "Laos"],
+  ["lv", "371", "Latvia"],
+  ["lb", "961", "Lebanon"],
+  ["ls", "266", "Lesotho"],
+  ["lr", "231", "Liberia"],
+  ["ly", "218", "Libya"],
+  ["li", "423", "Liechtenstein"],
+  ["lt", "370", "Lithuania"],
+  ["lu", "352", "Luxembourg"],
+  ["mo", "853", "Macau"],
+  ["mk", "389", "Macedonia"],
+  ["mg", "261", "Madagascar"],
+  ["mw", "265", "Malawi"],
+  ["my", "60", "Malaysia"],
+  ["mv", "960", "Maldives"],
+  ["ml", "223", "Mali"],
+  ["mt", "356", "Malta"],
+  ["mh", "692", "Marshall Islands"],
+  ["mq", "596", "Martinique"],
+  ["mr", "222", "Mauritania"],
+  ["mu", "230", "Mauritius"],
+  ["mx", "52", "Mexico"],
+  ["fm", "691", "Micronesia"],
+  ["md", "373", "Moldova"],
+  ["mc", "377", "Monaco"],
+  ["mn", "976", "Mongolia"],
+  ["me", "382", "Montenegro"],
+  ["ma", "212", "Morocco"],
+  ["mz", "258", "Mozambique"],
+  ["mm", "95", "Myanmar"],
+  ["na", "264", "Namibia"],
+  ["nr", "674", "Nauru"],
+  ["np", "977", "Nepal"],
+  ["nl", "31", "Netherlands"],
+  ["nc", "687", "New Caledonia"],
+  ["nz", "64", "New Zealand"],
+  ["ni", "505", "Nicaragua"],
+  ["ne", "227", "Niger"],
+  ["ng", "234", "Nigeria"],
+  ["kp", "850", "North Korea"],
+  ["no", "47", "Norway"],
+  ["om", "968", "Oman"],
+  ["pk", "92", "Pakistan"],
+  ["pw", "680", "Palau"],
+  ["ps", "970", "Palestine"],
+  ["pa", "507", "Panama"],
+  ["pg", "675", "Papua New Guinea"],
+  ["py", "595", "Paraguay"],
+  ["pe", "51", "Peru"],
+  ["ph", "63", "Philippines"],
+  ["pl", "48", "Poland"],
+  ["pt", "351", "Portugal"],
+  ["pr", "1", "Puerto Rico"],
+  ["qa", "974", "Qatar"],
+  ["re", "262", "Réunion"],
+  ["ro", "40", "Romania"],
+  ["ru", "7", "Russia"],
+  ["rw", "250", "Rwanda"],
+  ["kn", "1869", "Saint Kitts and Nevis"],
+  ["lc", "1758", "Saint Lucia"],
+  ["vc", "1784", "Saint Vincent and the Grenadines"],
+  ["ws", "685", "Samoa"],
+  ["sm", "378", "San Marino"],
+  ["st", "239", "São Tomé and Príncipe"],
+  ["sa", "966", "Saudi Arabia"],
+  ["sn", "221", "Senegal"],
+  ["rs", "381", "Serbia"],
+  ["sc", "248", "Seychelles"],
+  ["sl", "232", "Sierra Leone"],
+  ["sg", "65", "Singapore"],
+  ["sk", "421", "Slovakia"],
+  ["si", "386", "Slovenia"],
+  ["sb", "677", "Solomon Islands"],
+  ["so", "252", "Somalia"],
+  ["za", "27", "South Africa"],
+  ["kr", "82", "South Korea"],
+  ["ss", "211", "South Sudan"],
+  ["es", "34", "Spain"],
+  ["lk", "94", "Sri Lanka"],
+  ["sd", "249", "Sudan"],
+  ["sr", "597", "Suriname"],
+  ["sz", "268", "Swaziland"],
+  ["se", "46", "Sweden"],
+  ["ch", "41", "Switzerland"],
+  ["sy", "963", "Syria"],
+  ["tw", "886", "Taiwan"],
+  ["tj", "992", "Tajikistan"],
+  ["tz", "255", "Tanzania"],
+  ["th", "66", "Thailand"],
+  ["tl", "670", "Timor-Leste"],
+  ["tg", "228", "Togo"],
+  ["to", "676", "Tonga"],
+  ["tt", "1868", "Trinidad and Tobago"],
+  ["tn", "216", "Tunisia"],
+  ["tr", "90", "Turkey"],
+  ["tm", "993", "Turkmenistan"],
+  ["tv", "688", "Tuvalu"],
+  ["ug", "256", "Uganda"],
+  ["ua", "380", "Ukraine"],
+  ["ae", "971", "United Arab Emirates"],
+  ["gb", "44", "United Kingdom"],
+  ["us", "1", "United States"],
+  ["uy", "598", "Uruguay"],
+  ["uz", "998", "Uzbekistan"],
+  ["vu", "678", "Vanuatu"],
+  ["va", "39", "Vatican City"],
+  ["ve", "58", "Venezuela"],
+  ["vn", "84", "Vietnam"],
+  ["ye", "967", "Yemen"],
+  ["zm", "260", "Zambia"],
+  ["zw", "263", "Zimbabwe"],
+];

package/src/browser/utils/notifications.tsx

@@ -0,0 +1,25 @@
+import toast from "react-hot-toast"
+import React, { ReactNode } from "react"
+import Toast from "../toast"
+
+export const toastMsg = (
+  msg: string | ReactNode,
+  variant: "error" | "info" | "success" = "error",
+  duration: number = 10000
+) => {
+  toast.custom(
+    (t:any) => (
+      <Toast
+        id={t.id}
+        visible={t.visible}
+        message={msg}
+        variant={variant}
+        height={t.height}
+        position={t.position}
+      />
+    ),
+    {
+      duration: duration,
+    }
+  )
+}

package/src/browser/utils/number.ts

@@ -0,0 +1,6 @@
+export function human_number(n: number, decimals: number = 2) {
+  return n.toLocaleString("en-US", {
+    useGrouping: false,
+    maximumFractionDigits: decimals,
+  })
+}

package/src/browser/utils/requests.ts

@@ -0,0 +1,2 @@
+export const ssoURL = (path: string) =>
+  `${process.env.SABRE_SSO_PROTOCOL}://${process.env.SABRE_SSO_HOST}${path}`

package/src/browser/utils/search.ts

@@ -0,0 +1,25 @@
+import addDays from "date-fns/addDays";
+import { CachedSearchParamsType } from "./types";
+
+export const cachedSearchParams = (): CachedSearchParamsType | null => {
+  if (typeof window === "undefined") return null;
+  let cached: any = localStorage.getItem("search-params");
+  if (cached) {
+    cached = JSON.parse(cached);
+    cached.rate_codes = []; // Bypass Rate
+    cached.promo_codes = []; // Bypass Promo codes
+    cached.check_in = cached.check_in ? new Date(cached.check_in) : new Date();
+    cached.check_out = cached.check_out
+      ? new Date(cached.check_out)
+      : addDays(new Date(), 1);
+
+    // Invalidate cache if dates are in the past
+    if (cached.check_in < new Date()) {
+      return null;
+    }
+  }
+  return cached;
+};
+
+export const cacheSearchParams = (searchParams: CachedSearchParamsType) =>
+  localStorage.setItem("search-params", JSON.stringify(searchParams));

package/src/browser/utils/string.ts

@@ -0,0 +1,9 @@
+export function randomString(length: number = 9): string {
+  const characters =
+    "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
+  let result = ""
+  for (let i = 0; i < length; i++) {
+    result += characters.charAt(Math.floor(Math.random() * characters.length))
+  }
+  return result
+}

package/src/browser/utils/types.ts

@@ -0,0 +1,106 @@
+import {
+  CheckboxType,
+  GoogleSitesType,
+  ImageType,
+  InputType,
+  LinkType,
+  RecaptchaType,
+  SelectType,
+  TextType,
+  TitleType,
+} from "../api/types";
+
+export interface SearchParamsType {
+  check_in: Date;
+  check_out: Date;
+  adult_count: number;
+  child_count: number;
+  promo_codes: string[];
+  rate_codes: string[];
+  hotel_codes: string[];
+  selected_hotel: string | null;
+}
+
+export interface HotelPagesType {
+  [hotel_code: string]: {
+    name: string;
+    city: string;
+    sort: number;
+    link: string;
+  };
+}
+
+export interface CachedSearchParamsType {
+  check_in: Date;
+  check_out: Date;
+  adult_count: number;
+  child_count: number;
+  rate_codes: string[];
+  promo_codes: string[];
+}
+
+export interface HotelOptionsByCityType {
+  label: string;
+  options: { value: string; label: string }[];
+}
+
+export interface FormFieldsType {
+  [field: string]:
+    | InputType
+    | TitleType
+    | TextType
+    | LinkType
+    | ImageType
+    | SelectType
+    | RecaptchaType
+    | CheckboxType
+    | GoogleSitesType;
+}
+
+export interface FormSettingsType {
+  pk: number;
+  name: string;
+  form_method: "get" | "post";
+  form_recipient?: number;
+  form_submit: string;
+  form_redirection?: string | null;
+  form_success_msg?: string | null;
+  form_ajax_request?: boolean | null;
+  recaptcha_v3: boolean;
+  recaptcha_action: string;
+}
+
+export type FormItemType = string | FormSectionFieldType;
+
+export interface FormSectionFieldType {
+  name: string;
+  children: FormItemType[];
+}
+
+export interface FormType {
+  settings: FormSettingsType;
+  fields: FormFieldsType;
+  items: FormItemType[];
+}
+
+export interface BookingURLType {
+  date_format: string;
+  locale: string;
+  mobile_url: string;
+  mobile_url_no_availability: string;
+  url: string;
+  url_no_availability: string;
+  variables: string;
+}
+export interface BookingURLsType {
+  name: string;
+  booking_urls: BookingURLType;
+}
+
+export interface HotelsOptions {
+  [hotelId: string]: string;
+}
+
+export interface BookingURLsTypes {
+  [hotelCode: string]: BookingURLsType;
+}

package/src/browser/utils/url.ts

@@ -0,0 +1,116 @@
+import parseISO from "date-fns/parseISO"
+import format from "date-fns/format"
+import slugify from "slugify"
+import { randomString } from "./string"
+
+export interface QueryParamsType {
+  [key: string]: string
+}
+
+export const siteUrl = (path: string = "") =>
+  `${process.env.PROTOCOL}://${process.env.HOST}${path}`
+
+const serializeDate = (date: string) => {
+  try {
+    return date ? parseISO(date) : undefined
+  } catch (e) {
+    return undefined
+  }
+}
+const serializeNumber = (n: string) => {
+  try {
+    return n ? parseInt(n) : undefined
+  } catch (e) {
+    return undefined
+  }
+}
+const serializeList = (str: string): string[] => (str ? [str] : [])
+
+const serializeParam: any = {
+  check_in: serializeDate,
+  check_out: serializeDate,
+  child_count: serializeNumber,
+  adult_count: serializeNumber,
+  rate_codes: serializeList,
+  promo_codes: serializeList,
+}
+
+/**
+ * Extracts query params from an URL
+ *
+ * @param queryString String with query params
+ * @param rename Object for renaming params, e.g: {"oldParam": "newParam"}
+ * @returns Object with the parsed params
+ */
+export function parseQueryParams(
+  queryString: string,
+  rename: { [k: string]: string } = {}
+): QueryParamsType {
+  if (!queryString) return {}
+  // Transform rate_code and promo_code into their corresponding plurals
+  rename = { rate_code: "rate_codes", promo_code: "promo_codes", ...rename }
+  return queryString
+    .slice(1)
+    .split("&")
+    .reduce((acc: QueryParamsType, param: string) => {
+      let [key, value] = param.split("=")
+      key = decodeURIComponent(key)
+      value = decodeURIComponent(value || "")
+      if (rename[key]) {
+        key = rename[key]
+      }
+      acc[key] = serializeParam.hasOwnProperty(key)
+        ? serializeParam[key](value)
+        : value
+      return acc
+    }, {})
+}
+
+export const join_paths = (path1: string, path2: string): string =>
+  `${path1.replace(new RegExp(`/$`), "")}/${path2.replace(
+    new RegExp(`^/`),
+    ""
+  )}`
+
+export const api_link = (
+  apiPath: string = "",
+  queryParams: QueryParamsType | null = null
+): string =>
+  `${join_paths(
+    `${process.env.API_PROTOCOL}://${process.env.API_HOST}`,
+    apiPath
+  )}${queryParams ? `?${new URLSearchParams(queryParams).toString()}` : ""}`
+
+export const hotel_page_link = (city: string, hotelName: string) =>
+  `/book-accommodation/${slugify(city, {
+    lower: true,
+  })}/${slugify(hotelName, {
+    lower: true,
+  }).slice(5)}`
+
+/**
+ *
+ * Transforms Search params into a query string
+ */
+export const sp_to_qs = (
+  check_in: Date,
+  check_out: Date,
+  adult_count: number,
+  child_count: number,
+  rate_codes: string[],
+  promo_codes: string[]
+) =>
+  `?check_in=${format(check_in, "yyyy-MM-dd")}&check_out=${format(
+    check_out,
+    "yyyy-MM-dd"
+  )}&adult_count=${adult_count}&child_count=${child_count}&promo_code=${
+    promo_codes?.length ? promo_codes[0] : ""
+  }&rate_code=${rate_codes?.length ? rate_codes[0] : ""}`
+
+export const opentableLink = (id: number): string =>
+  `https://www.opentable.com.au/restref/client?rid=${id}&restref=${id}&lang=en-AU&r3uid=${randomString(
+    9
+  )}&ot_source=Restaurant+website&color=1`
+
+export const decodeQuotePlus = (text: string) =>
+  decodeURIComponent(text.replace(/\+/g, "%20"))

package/src/browser/utils/viewport.ts

@@ -0,0 +1,59 @@
+import ClassNames from "classnames";
+
+export const IsMobile = () =>
+  typeof window !== "undefined" && window.innerWidth <= 1024; // Tablet and Mobile
+
+export const scrollToElement = async (elementId: string) => {
+  document.getElementById(elementId)?.scrollIntoView({ behavior: "smooth" });
+};
+
+export const scrollToChild = (parent: HTMLElement, child: HTMLElement) => {
+  const initialDisplayValue = parent.style.display;
+  // HACK: can't use getBoundingClientRect when display is 'none'
+  if (initialDisplayValue !== "block") {
+    parent.style.display = "block";
+  }
+
+  // can't use scrollIntoView because of scroll event bubbling
+  const parentPosition = parent.getBoundingClientRect();
+  const childPosition = child.getBoundingClientRect();
+
+  const topOffset = childPosition.top - parentPosition.top;
+  const bottomOffset = parentPosition.bottom - childPosition.bottom;
+
+  const isChildVisible = topOffset >= 0 && bottomOffset >= 0;
+
+  if (!isChildVisible) {
+    if (Math.abs(topOffset) < Math.abs(bottomOffset)) {
+      // element above the container
+      parent.scrollTop += topOffset;
+    } else {
+      // element below the container
+      parent.scrollTop -= bottomOffset;
+    }
+  }
+
+  parent.style.display = initialDisplayValue;
+};
+
+export const isIOS = () => /iPad|iPhone|iPod/.test(navigator.userAgent);
+
+// Returns the device ID depending on the viewport width (d: Desktop, t: Tablet, m: Mobile)
+export const deviceId = (width: number) =>
+  width > 1023 ? "d" : width > 768 ? "t" : "m";
+
+const HideOnDevice = (devices: Array<string>, device: string): boolean =>
+  device ? !!devices.length && !devices.includes(device) : !devices.length;
+
+export const classNames = (
+  classes: { [k: string]: boolean },
+  displayOn: Array<string> | null = null
+): any => {
+  if (displayOn) {
+    classes.hidden = HideOnDevice(displayOn, "");
+    classes.hidden_mobile = HideOnDevice(displayOn, "m");
+    classes.hidden_tablet = HideOnDevice(displayOn, "t");
+    classes.hidden_desktop = HideOnDevice(displayOn, "d");
+  }
+  return ClassNames(classes);
+};

package/src/index.browser.ts

@@ -0,0 +1,103 @@
+export { animateJSX } from "./browser/utils/animation";
+export {
+  SearchAvailability,
+  BookingUrl,
+  hotelOptionsByCity,
+  pricePerNight,
+} from "./browser/utils/booking_engine";
+export {
+  saveUserSession,
+  loadUserSession,
+  deleteUserSession,
+} from "./browser/utils/eclub";
+
+export {
+  json_request,
+  getInputHumanValue,
+  getInputEventValue,
+} from "./browser/utils/forms";
+export { tagExists, joinAddress } from "./browser/utils/hotel";
+export {
+  optimizedThumb,
+  getThumb,
+  toImageElement,
+  minimumSlides,
+  tripadvisorRatingURL,
+  preloadImages,
+} from "./browser/utils/image";
+export { countryPrefixes } from "./browser/utils/location";
+export { toastMsg } from "./browser/utils/notifications";
+export { human_number } from "./browser/utils/number";
+export { ssoURL } from "./browser/utils/requests";
+export { cacheSearchParams, cachedSearchParams } from "./browser/utils/search";
+export { randomString } from "./browser/utils/string";
+export {
+  siteUrl,
+  parseQueryParams,
+  join_paths,
+  api_link,
+  opentableLink,
+  hotel_page_link,
+  sp_to_qs,
+} from "./browser/utils/url";
+export {
+  classNames,
+  isIOS,
+  IsMobile,
+  deviceId,
+  scrollToChild,
+  scrollToElement,
+} from "./browser/utils/viewport";
+
+export { default as Checkbox } from "./browser/api/checkbox";
+export { default as CountryPrefix } from "./browser/api/country-prefix";
+export { default as Form } from "./browser/api/form";
+export { default as GooglePlaces } from "./browser/api/google-places";
+export { default as Icon } from "./browser/api/icon";
+export { default as Image } from "./browser/api/image";
+export { default as Input } from "./browser/api/input";
+export { default as Link } from "./browser/api/link";
+export { default as LinkList } from "./browser/api/linklist";
+export { default as Select } from "./browser/api/select";
+export { default as SVG } from "./browser/api/svg";
+export { default as Text } from "./browser/api/text";
+export { default as Textarea } from "./browser/api/textarea";
+export { default as Title } from "./browser/api/title";
+export { default as Button } from "./browser/api/button";
+export { default as Carousel } from "./browser/carousel";
+export { default as Markdown } from "./browser/markdown";
+export { default as Modal } from "./browser/modal";
+export { default as Spinner } from "./browser/spinner";
+export { default as useViewport } from "./browser/use_viewport";
+export { Toast } from "./browser/toast";
+
+export type {
+  HotelOptionsByCityType,
+  CachedSearchParamsType,
+  FormType,
+  BookingURLType,
+} from "./browser/utils/types";
+
+export type {
+  ImageMediaType,
+  ImageType,
+  FileType,
+  SectionType,
+  TitleType,
+  TextType,
+  VideoMediaType,
+  LinkListType,
+  ButtonType,
+  InputType,
+  SelectType,
+  FileMediaType,
+  AnyElementType,
+  LinkType,
+  UserType,
+  MediaType,
+  DefaultPropsType,
+  LocationType,
+  PageParamsType,
+  ElementDataType,
+} from "./browser/api/types";
+export type { ErrorsType } from "./browser/api/form/types";

package/src/index.node.ts

@@ -0,0 +1,16 @@
+export { join_paths, ssoURL } from "./node/url";
+export { nOptions } from "./node/form";
+export {
+  hotelOptionsByCity,
+  joinAddress,
+  hotel_page_link,
+} from "./node/property";
+export { createAPIPages, postBuild, buildElement } from "./node/build";
+export {
+  extractForm,
+  tagExists,
+  api_link,
+  buildImage,
+  getImageData,
+} from "./node/api";
+export { defaultGatsbyConfig } from "./node/config";