@homeworksenergy/utility-service 1.0.8 → 1.0.9

package/index.js

@@ -1,10 +1,11 @@
 const {
-  getStartEndTimes,
-  formatStartEndTimes,
-  getFormattedStartEndTimes,
+  getDefaultStartEndTimes,
+  formatStartEndTimesAsDatabaseEventRow,
   formatSingleDayStartEndTimes,
   addStartEndTimesToEvents,
-} = require('./dataFormatting');
+  getStartEndTimesForEvent,
+  getDatabaseInsertSlots,
+} = require('./multiDayUtils');
 
 const STATES = {
   '00': 'MA',
@@ -98,9 +99,11 @@ module.exports = {
   decodeEventType,
   getDetailTableNameForEventType,
   getEventTypeForDepartment,
-  getStartEndTimes,
-  formatStartEndTimes,
-  getFormattedStartEndTimes,
+  // Multi day
+  getDefaultStartEndTimes,
+  formatStartEndTimesAsDatabaseEventRow,
   formatSingleDayStartEndTimes,
   addStartEndTimesToEvents,
+  getStartEndTimesForEvent,
+  getDatabaseInsertSlots,
 };

package/multiDayUtils.js

@@ -0,0 +1,157 @@
+const moment = require('moment');
+const { arrayOf1ToN } = require('./utils');
+
+/**
+ *
+ * @param {number} jobLength job length in # of days (can be decimal)
+ * @param {moment | date} startDate date the job should start
+ * @param {number} [slotLength=8] number of hours per day
+ * @param {number} [startTime=9] hour for event to start. Only integers right now
+ * @returns {Object[]} array of {start: moment(startDateTime), end: moment(endDateTime)} objects for each day
+ */
+const getDefaultStartEndTimes = (
+  jobLength,
+  startDate,
+  slotLength = 8,
+  startTime = 9
+) => {
+  // Fix invalid date error
+  if (!startDate) return [];
+  const startEndTimes = arrayOf1ToN(jobLength).map((dayNumber) => {
+    // Taken from the HVAC Install WorkForm file.
+    // If it's the last day, and the jobLength is fractional,
+    // slotLength = fraction * 8
+    if (jobLength % 1 && dayNumber === Math.ceil(jobLength))
+      slotLength = (jobLength % 1) * slotLength;
+    const start = moment(startDate)
+      .add(dayNumber - 1, 'days')
+      .set('hour', startTime)
+      .set('minutes', 0)
+      .set('seconds', 0);
+    const end = moment(start).add(slotLength, 'hours');
+    return { start, end };
+  });
+  return startEndTimes;
+};
+
+/**
+ *
+ * @param {Object[]} startEndTimes array of {start: moment(startDateTime), end: moment(endDateTime)} objects
+ * @param {moment | date} startEndTimes[].start date time that the day will start
+ * @param {moment | date} startEndTimes[].end date time that the day will end
+ * @returns {Object[]} array of {startTime: 'HH:mm:ss', endTime: 'HH:mm:ss', date: 'MM/DD/YYYY'} objects for each day
+ */
+const formatStartEndTimesAsDatabaseEventRow = (startEndTimes) => {
+  const formatTime = (timeMoment) => moment(timeMoment).format('HH:mm:ss');
+  const formatDate = (dateMoment) => moment(dateMoment).format('MM/DD/YYYY');
+  return startEndTimes.map(({ start, end }) => {
+    const [startTime, endTime] = [formatTime(start), formatTime(end)];
+    const date = formatDate(start);
+    return { startTime, endTime, date };
+  });
+};
+
+/**
+ *
+ * @param {Object} dateInfo date info in the shape of the database Event table { startTime: 'HH:mm:ss', endTime: 'HH:mm:ss', date: 'MM/DD/YYYY' }
+ * @returns {Object} object of shape {start: moment(dayStartDateTime), end: moment(dayEndDateTime)}
+ */
+const formatSingleDayStartEndTimes = (dateInfo) => {
+  const { startTime, endTime, date } = dateInfo;
+  const dateTimeFormat = 'MM/DD/YYYY HH:mm:ss';
+  return {
+    start: moment(`${date} ${startTime}`, dateTimeFormat),
+    end: moment(`${date} ${endTime}`, dateTimeFormat),
+  };
+};
+
+/**
+ * Refactored out. Not sure if we'll need this at some point in the future or not.
+ *
+ * Adds startEndTimes to all events. Requires a list of events, and a map to the same list.
+ * Each event will have their multiDay associated events. Calculates the multiday startEndTimes once for each associatedEventsId,
+ * and adds it to each event based on that associatedEventId
+ *
+ * @param {Object[]} events array of events [{...event1}, {...event2}, ...]
+ * @param {Object} eventsMap object map of events as {[id]: {...event}}
+ * @returns
+ */
+const addStartEndTimesToEvents = (events, eventsMap) => {
+  const startEndTimes = {};
+
+  return events.map((event) => {
+    const { associatedEventsId } = event;
+    if (!startEndTimes[associatedEventsId]) {
+      const eventStartEndTimes = getStartEndTimesForEvent(event, eventsMap);
+      startEndTimes[associatedEventsId] = eventStartEndTimes;
+    }
+  });
+};
+
+/**
+ *
+ * @param {Object} event - the database event holding all the information for the job
+ * @param {Object} eventsMap - an { [id]: { ...event } } shape map allowing us to access the other events in the series for their start end times
+ * @param {Date} [rescheduleDate] - Used for rescheduling, allows changing the start date without getting rid of the start and end times
+ * @returns
+ */
+const getStartEndTimesForEvent = (event, eventsMap) => {
+  const { associatedEventIds, date } = event;
+
+  const DATE_FORMAT = 'MM/DD/YYYY';
+
+  const startDate = moment(date, DATE_FORMAT);
+
+  const startEndTimes = associatedEventIds.map((singleDayId) => {
+    const singleDayStartDate = moment(startDate);
+    const singleDayEvent = {
+      ...eventsMap[singleDayId],
+      date: singleDayStartDate.format(DATE_FORMAT),
+    };
+
+    startDate.add(1, 'day');
+
+    return formatSingleDayStartEndTimes(singleDayEvent);
+  });
+
+  return startEndTimes;
+};
+
+/**
+ *
+ * @param {Object} commonData common data of all slots with database Event table shape
+ * @param {Object[]} startEndTimes array of startEndTimes with database Event table shape {date: 'MM/DD/YYYY', startTime: 'HH:mm:ss', endTime: 'HH:mm:ss'}
+ * @param {bigint[]} associatedEventIds array of ids for all events in series. When rescheduling or updating, first update these events for each slot before creating new events
+ * @returns
+ */
+const getDatabaseInsertSlots = (
+  commonData,
+  startEndTimes,
+  associatedEventIds = {}
+) => {
+  return formatStartEndTimesAsDatabaseEventRow(startEndTimes).map(
+    (day, index) => {
+      const { startTime, endTime, date } = day;
+
+      // Match up slots to their existing ids
+      // If creating an event or adding days to an event, this will be undefined for the new days
+      const id = associatedEventIds[index];
+
+      // Slot to be returned
+      const slot = { ...commonData, startTime, endTime, date };
+
+      // If the slot is not a new day, attach the old ID
+      if (id) slot.id = id;
+      return slot;
+    }
+  );
+};
+
+module.exports = {
+  getDefaultStartEndTimes,
+  formatStartEndTimesAsDatabaseEventRow,
+  formatSingleDayStartEndTimes,
+  addStartEndTimesToEvents,
+  getStartEndTimesForEvent,
+  getDatabaseInsertSlots,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homeworksenergy/utility-service",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Event type Transaction",
   "main": "index.js",
   "scripts": {

package/dataFormatting.js

@@ -1,87 +0,0 @@
-const moment = require('moment');
-const { arrayOf1ToN } = require('./utils');
-
-const getStartEndTimes = (
-  jobLength,
-  startDate,
-  slotLength = 8,
-  startTime = 9
-) => {
-  // Fix invalid date error
-  if (!startDate) return [];
-  const startEndTimes = arrayOf1ToN(jobLength).map((dayNumber) => {
-    // Taken from the HVAC Install WorkForm file.
-    // If it's the last day, and the jobLength is fractional,
-    // slotLength = fraction * 8
-    if (jobLength % 1 && dayNumber === Math.ceil(jobLength))
-      slotLength = (jobLength % 1) * 8;
-    const start = moment(startDate)
-      .add(dayNumber - 1, 'days')
-      .set('hour', startTime)
-      .set('minutes', 0)
-      .set('seconds', 0);
-    const end = moment(start).add(slotLength, 'hours');
-    return { start, end };
-  });
-  return startEndTimes;
-};
-
-// Can't pass a moment object through to the backend so we have to format first
-// TODO: Might be better just to pass as UTC in the future, but there are a lot of places we could make that change
-const formatStartEndTimes = (startEndTimes) => {
-  const formatTime = (timeMoment) => moment(timeMoment).format('HH:mm:ss');
-  const formatDate = (dateMoment) => moment(dateMoment).format('MM/DD/YYYY');
-  return startEndTimes.map(({ start, end }) => {
-    const [startTime, endTime] = [formatTime(start), formatTime(end)];
-    const date = formatDate(start);
-    return { startTime, endTime, date };
-  });
-};
-
-const formatSingleDayStartEndTimes = (dateInfo) => {
-  const { startTime, endTime, date } = dateInfo;
-  const dateTimeFormat = 'MM/DD/YYYY HH:mm:ss';
-  return {
-    start: moment(`${date} ${startTime}`, dateTimeFormat),
-    end: moment(`${date} ${endTime}`, dateTimeFormat),
-  };
-};
-
-const addStartEndTimesToEvents = (events, eventsMap) => {
-  const startEndTimes = {};
-
-  return events.map((event) => {
-    const { associatedEventsId, associatedEventIds } = event;
-
-    if (!startEndTimes[associatedEventsId]) {
-      const eventStartEndTimes = associatedEventIds.map((singleDayId) => {
-        const singleDayEvent = eventsMap[singleDayId];
-
-        return formatSingleDayStartEndTimes(singleDayEvent);
-      });
-
-      startEndTimes[associatedEventsId] = eventStartEndTimes;
-    }
-
-    event.startEndTimes = startEndTimes[associatedEventsId];
-    return event;
-  });
-};
-
-const getFormattedStartEndTimes = (
-  jobLength,
-  startDate,
-  slotLength,
-  startTime
-) =>
-  formatStartEndTimes(
-    getStartEndTimes(jobLength, startDate, slotLength, startTime)
-  );
-
-module.exports = {
-  getStartEndTimes,
-  formatStartEndTimes,
-  getFormattedStartEndTimes,
-  formatSingleDayStartEndTimes,
-  addStartEndTimesToEvents,
-};