All files / lib/packages/shared-utils seatool-date-helper.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
 
 
 
 
 
 
 
 
 
 
 
284x
13x
13x
 
 
 
 
 
 
 
 
 
 
284x
4x
2x
 
 
 
 
 
 
 
 
 
 
 
284x
 
14x
 
 
 
14x
8x
 
 
6x
 
 
 
 
import { isAHoliday } from "@18f/us-federal-holidays";
import { TZDate } from "@date-fns/tz";
import { UTCDate } from "@date-fns/utc";
import { addDays, format, isWeekend, startOfDay } from "date-fns";
 
/**
 * Returns the epoch timestamp for midnight UTC time for the date provided.
 * If no date is provided, it returns the timestamp of midnight UTC time today.
 *
 * @param date the date object or date string to return the timestamp for
 * @returns epoch timestamp for midnight UTC of the date or today, if none provided
 */
export const seaToolFriendlyTimestamp = (date?: Date | string): number => {
  const utcDate = date ? new UTCDate(date) : new UTCDate();
  return startOfDay(utcDate).getTime();
};
 
/**
 * Returns the formatted date string of the UTC timezone for the date provided.
 * If no date is provided, it returns an empty string.
 *
 * @param date the date object or date string to return the formatted time of
 * @returns the `MM/dd/yyyy` formatted date string for the UTC time of the date provided
 * or an empty string if no date was provided
 */
export const formatSeatoolDate = (date?: Date | string): string => {
  if (!date) return "";
  return format(new UTCDate(date), "MM/dd/yyyy");
};
 
/**
 * Returns the timestamp for UTC midnight of the current business day.
 * If no date is provided, it returns the current business day relative to today.
 * If the date is after 5pm Eastern time, it returns the next business day.
 * If the date is on a federal holiday or weekend, it returns the next business day.
 *
 * @param date the date object to return the timestamp for
 * @returns the timestamp of midnight UTC of the current business day relative to the date or today, if none provided
 */
export const getBusinessDayTimestamp = (date: Date = new Date()): number => {
  // Get the date in Eastern time
  const nyDateTime = new TZDate(date.toISOString(), "America/New_York");
 
  // Check if the time is after 5pm Eastern time or if the day is not a business day.
  // If any of those are true, check again for the next day.
  if (nyDateTime.getHours() >= 17 || isAHoliday(nyDateTime) || isWeekend(nyDateTime)) {
    return getBusinessDayTimestamp(startOfDay(addDays(nyDateTime, 1)));
  }
 
  return startOfDay(
    new UTCDate(nyDateTime.getFullYear(), nyDateTime.getMonth(), nyDateTime.getDate()),
  ).getTime();
};