Merge pull request #42 from lux-group/calendar

feat(calendar): add methods for calendar
lux-group · Mar 15, 2022 · 45c3545 · 45c3545
2 parents b858592 + af6e2ff
commit 45c3545
Show file tree

Hide file tree

Showing 9 changed files with 389 additions and 2 deletions.
diff --git a/compiled/calendar/constants.js b/compiled/calendar/constants.js
@@ -0,0 +1,54 @@
+"use strict";
+
+var _OFFERS;
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var _require = require('../offer/constants'),
+    OFFER_TYPE_HOTEL = _require.OFFER_TYPE_HOTEL,
+    OFFER_TYPE_TOUR = _require.OFFER_TYPE_TOUR,
+    OFFER_TYPE_LAST_MINUTE_HOTEL = _require.OFFER_TYPE_LAST_MINUTE_HOTEL,
+    OFFER_TYPE_TACTICAL_AO_HOTEL = _require.OFFER_TYPE_TACTICAL_AO_HOTEL;
+
+var OFFERS = (_OFFERS = {}, _defineProperty(_OFFERS, OFFER_TYPE_TOUR, {
+  type: OFFER_TYPE_TOUR,
+  parentType: OFFER_TYPE_TOUR,
+  dateFloorOffset: 2,
+  hourOfDayThreshold: 0,
+  useDynamicRate: false,
+  useTimezoneOffset: false
+}), _defineProperty(_OFFERS, OFFER_TYPE_HOTEL, {
+  type: OFFER_TYPE_HOTEL,
+  parentType: OFFER_TYPE_HOTEL,
+  dateFloorOffset: 2,
+  hourOfDayThreshold: 0,
+  useDynamicRate: false,
+  useTimezoneOffset: false
+}), _defineProperty(_OFFERS, OFFER_TYPE_LAST_MINUTE_HOTEL, {
+  type: OFFER_TYPE_LAST_MINUTE_HOTEL,
+  parentType: OFFER_TYPE_HOTEL,
+  dateFloorOffset: 0,
+  hourOfDayThreshold: 15,
+  useDynamicRate: true,
+  useTimezoneOffset: true
+}), _defineProperty(_OFFERS, OFFER_TYPE_TACTICAL_AO_HOTEL, {
+  type: OFFER_TYPE_TACTICAL_AO_HOTEL,
+  parentType: OFFER_TYPE_HOTEL,
+  dateFloorOffset: 0,
+  hourOfDayThreshold: 15,
+  useDynamicRate: true,
+  useTimezoneOffset: true
+}), _OFFERS);
+var CEILING_YEARS = 3;
+var DEFAULT_MONTHS_FALLBACK = 18;
+var DATE_FORMAT = 'YYYY-MM-DD';
+module.exports = {
+  CEILING_YEARS: CEILING_YEARS,
+  DEFAULT_MONTHS_FALLBACK: DEFAULT_MONTHS_FALLBACK,
+  DATE_FORMAT: DATE_FORMAT,
+  OFFER_TYPE_HOTEL: OFFER_TYPE_HOTEL,
+  OFFER_TYPE_TOUR: OFFER_TYPE_TOUR,
+  OFFER_TYPE_LAST_MINUTE_HOTEL: OFFER_TYPE_LAST_MINUTE_HOTEL,
+  OFFER_TYPE_TACTICAL_AO_HOTEL: OFFER_TYPE_TACTICAL_AO_HOTEL,
+  OFFERS: OFFERS
+};
diff --git a/compiled/calendar/index.js b/compiled/calendar/index.js
@@ -0,0 +1,67 @@
+"use strict";
+
+var moment = require('moment');
+
+var constants = require('./constants');
+
+var getTimezoneOffset = function getTimezoneOffset(offerPackageTimezoneOffset, offerType, requestTimezoneOffset) {
+  if (!requestTimezoneOffset && constants.OFFERS[offerType].useTimezoneOffset) {
+    return parseInt(offerPackageTimezoneOffset || 0);
+  }
+
+  return requestTimezoneOffset;
+};
+
+var getMonthsToRequest = function getMonthsToRequest(timezoneOffset, maxDate) {
+  var now = moment().utcOffset(timezoneOffset);
+  return moment(maxDate).diff(now, 'months') + 2;
+};
+
+var getMaxCheckInCloseDate = function getMaxCheckInCloseDate(checkInCloses) {
+  var defaultMonths = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : constants.DEFAULT_MONTHS_FALLBACK;
+  return checkInCloses ? moment.min(moment(checkInCloses), moment().add(constants.CEILING_YEARS, 'years')).format(constants.DATE_FORMAT) : moment().add(defaultMonths, 'months').format(constants.DATE_FORMAT);
+};
+
+var getStartDate = function getStartDate(minDate, travelFromDate) {
+  if (minDate && travelFromDate) {
+    if (moment(travelFromDate).isAfter(moment(minDate))) {
+      return moment(travelFromDate).format(constants.DATE_FORMAT);
+    } else {
+      return moment(minDate).format(constants.DATE_FORMAT);
+    }
+  }
+
+  if (travelFromDate) {
+    return moment(travelFromDate).format(constants.DATE_FORMAT);
+  }
+
+  return moment(minDate).format(constants.DATE_FORMAT);
+};
+
+var getDateFloorOffset = function getDateFloorOffset(_ref) {
+  var timezoneOffset = _ref.timezoneOffset,
+      dateFloorOffset = _ref.dateFloorOffset,
+      hourOfDayThreshold = _ref.hourOfDayThreshold,
+      _ref$enquiryType = _ref.enquiryType,
+      enquiryType = _ref$enquiryType === void 0 ? 'customer' : _ref$enquiryType;
+  if (enquiryType === 'admin') return 0;
+
+  if (dateFloorOffset === 0) {
+    var nowHours = parseInt(moment().utcOffset(timezoneOffset).format('HH'));
+
+    if (nowHours >= hourOfDayThreshold) {
+      return 1;
+    }
+  }
+
+  return dateFloorOffset;
+};
+
+module.exports = {
+  constants: constants,
+  getTimezoneOffset: getTimezoneOffset,
+  getMonthsToRequest: getMonthsToRequest,
+  getMaxCheckInCloseDate: getMaxCheckInCloseDate,
+  getStartDate: getStartDate,
+  getDateFloorOffset: getDateFloorOffset
+};
diff --git a/compiled/index.js b/compiled/index.js
@@ -6,5 +6,6 @@ module.exports = {
   offer: require('./offer'),
   currency: require('./currency'),
   occupancy: require('./occupancy'),
-  date: require('./date')
+  date: require('./date'),
+  calendar: require('./calendar')
 };
diff --git a/index.d.ts b/index.d.ts
@@ -130,4 +130,49 @@ declare module "@luxuryescapes/lib-global" {
       including?: boolean
     ) => Date[];
   };
+  const calendar: {
+    constants: {
+      CEILING_YEARS: number;
+      DEFAULT_MONTHS_FALLBACK: number;
+      DATE_FORMAT: string;
+      OFFERS: {
+        [offerType: string]: {
+          type: string;
+          parentType: string;
+          dateFloorOffset: number;
+          hourOfDayThreshold: number;
+          useDynamicRate: boolean;
+          useTimezoneOffset: boolean;
+        };
+      };
+    };
+    getTimezoneOffset: (
+      offerPackageTimezoneOffset: number,
+      offerType: string, 
+      requestTimezoneOffset: number
+    ) => number;
+    getMonthsToRequest: (
+      timezoneOffset: number,
+      maxDate: string
+    ) => number;
+    getMaxCheckInCloseDate: (
+      checkInCloses?: string,
+      defaultMonths?: number
+    ) => string;
+    getStartDate: (
+      minDate?: string, 
+      travelFromDate?: string
+    ) => string;
+    getDateFloorOffset: ({
+      timezoneOffset,
+      dateFloorOffset,
+      hourOfDayThreshold,
+      enquiryType
+    }: {
+      timezoneOffset: number,
+      dateFloorOffset: number,
+      hourOfDayThreshold: number,
+      enquiryType: 'customer' | 'admin'
+    }) => string;
+  };
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@luxuryescapes/lib-global",
-  "version": "2.6.7",
+  "version": "2.6.8",
   "description": "Lib for expanding functionality and deduplicating code between services",
   "main": "compiled/index.js",
   "types": "index.d.ts",

diff --git a/src/calendar/constants.js b/src/calendar/constants.js
@@ -0,0 +1,51 @@
+const { OFFER_TYPE_HOTEL, OFFER_TYPE_TOUR, OFFER_TYPE_LAST_MINUTE_HOTEL, OFFER_TYPE_TACTICAL_AO_HOTEL } = require('../offer/constants')
+
+const OFFERS = {
+  [OFFER_TYPE_TOUR]: {
+    type: OFFER_TYPE_TOUR,
+    parentType: OFFER_TYPE_TOUR,
+    dateFloorOffset: 2,
+    hourOfDayThreshold: 0,
+    useDynamicRate: false,
+    useTimezoneOffset: false,
+  },
+  [OFFER_TYPE_HOTEL]: {
+    type: OFFER_TYPE_HOTEL,
+    parentType: OFFER_TYPE_HOTEL,
+    dateFloorOffset: 2,
+    hourOfDayThreshold: 0,
+    useDynamicRate: false,
+    useTimezoneOffset: false,
+  },
+  [OFFER_TYPE_LAST_MINUTE_HOTEL]: {
+    type: OFFER_TYPE_LAST_MINUTE_HOTEL,
+    parentType: OFFER_TYPE_HOTEL,
+    dateFloorOffset: 0,
+    hourOfDayThreshold: 15,
+    useDynamicRate: true,
+    useTimezoneOffset: true,
+  },
+  [OFFER_TYPE_TACTICAL_AO_HOTEL]: {
+    type: OFFER_TYPE_TACTICAL_AO_HOTEL,
+    parentType: OFFER_TYPE_HOTEL,
+    dateFloorOffset: 0,
+    hourOfDayThreshold: 15,
+    useDynamicRate: true,
+    useTimezoneOffset: true,
+  },
+}
+
+const CEILING_YEARS = 3
+const DEFAULT_MONTHS_FALLBACK = 18
+const DATE_FORMAT = 'YYYY-MM-DD'
+
+module.exports = {
+  CEILING_YEARS,
+  DEFAULT_MONTHS_FALLBACK,
+  DATE_FORMAT,
+  OFFER_TYPE_HOTEL,
+  OFFER_TYPE_TOUR,
+  OFFER_TYPE_LAST_MINUTE_HOTEL,
+  OFFER_TYPE_TACTICAL_AO_HOTEL,
+  OFFERS,
+}
diff --git a/src/calendar/index.js b/src/calendar/index.js
@@ -0,0 +1,68 @@
+const moment = require('moment')
+
+const constants = require('./constants')
+
+const getTimezoneOffset = (offerPackageTimezoneOffset, offerType, requestTimezoneOffset) => {
+  if (!requestTimezoneOffset && constants.OFFERS[offerType].useTimezoneOffset) {
+    return parseInt(offerPackageTimezoneOffset || 0)
+  }
+
+  return requestTimezoneOffset
+}
+
+const getMonthsToRequest = (timezoneOffset, maxDate) => {
+  const now = moment().utcOffset(timezoneOffset)
+  return moment(maxDate).diff(now, 'months') + 2
+}
+
+const getMaxCheckInCloseDate = (
+  checkInCloses,
+  defaultMonths = constants.DEFAULT_MONTHS_FALLBACK,
+) => {
+  return checkInCloses ?
+    moment
+      .min(moment(checkInCloses), moment().add(constants.CEILING_YEARS, 'years'))
+      .format(constants.DATE_FORMAT) :
+    moment().add(defaultMonths, 'months').format(constants.DATE_FORMAT)
+}
+
+const getStartDate = (minDate, travelFromDate) => {
+  if (minDate && travelFromDate) {
+    if (moment(travelFromDate).isAfter(moment(minDate))) {
+      return moment(travelFromDate).format(constants.DATE_FORMAT)
+    } else {
+      return moment(minDate).format(constants.DATE_FORMAT)
+    }
+  }
+  if (travelFromDate) {
+    return moment(travelFromDate).format(constants.DATE_FORMAT)
+  }
+  return moment(minDate).format(constants.DATE_FORMAT)
+}
+
+const getDateFloorOffset = ({
+  timezoneOffset,
+  dateFloorOffset,
+  hourOfDayThreshold,
+  enquiryType = 'customer',
+}) => {
+  if (enquiryType === 'admin') return 0
+
+  if (dateFloorOffset === 0) {
+    const nowHours = parseInt(moment().utcOffset(timezoneOffset).format('HH'))
+    if (nowHours >= hourOfDayThreshold) {
+      return 1
+    }
+  }
+
+  return dateFloorOffset
+}
+
+module.exports = {
+  constants,
+  getTimezoneOffset,
+  getMonthsToRequest,
+  getMaxCheckInCloseDate,
+  getStartDate,
+  getDateFloorOffset,
+}
diff --git a/src/index.js b/src/index.js
@@ -5,4 +5,5 @@ module.exports = {
   currency: require('./currency'),
   occupancy: require('./occupancy'),
   date: require('./date'),
+  calendar: require('./calendar'),
 }