All files / app/utils date.ts

92.63% Statements 88/95
88.09% Branches 37/42
92.85% Functions 13/14
94.38% Lines 84/89

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238      33x 33x   33x             253x 33x                                           75x       134x 45x   134x 134x       59x               59x                   231x         231x 231x   231x 231x   231x 231x       33x               365x 1767x   365x 365x   30x 30x 30x             30x 30x 23x 23x 23x 19x   23x 8x     30x 24x 24x 24x 1x     30x 16x   30x       11x       11x     11x 33x   11x 11x 2x 2x     2x 2x   11x     33x     956x 956x 1x       955x           955x             955x 955x     33x     78x 78x 1x     77x               77x     77x     77x 77x       77x 77x 8x   69x   77x 77x 77x 69x   77x       1260x       128x                 128x     1260x  
// format a date
import { Timestamp } from "google-protobuf/google/protobuf/timestamp_pb";
 
import daysjs, { Dayjs } from "./dayjs";
import { dayMillis } from "./timeAgo";
 
const numNights = (date1: string, date2: string) => {
  const diffTime = Date.parse(date1) - Date.parse(date2);
  const diffDays = Math.ceil(diffTime / dayMillis);
  return diffDays;
};
 
/// Allow call sites to explicitly reference the browser's timezone (clearer than "undefined").
export const BROWSER_TIMEZONE: unique symbol = Symbol("browser-timezone");
export const UTC_TIMEZONE: string = "Etc/UTC";
 
interface LocalizeDateTimeParams {
  /// The locale to localize in.
  locale: string;
  /// The timezone to be used to figure the date components (defaults to the browser's).
  timezone?: string | typeof BROWSER_TIMEZONE;
  /// Whether to include the date (defaults to true).
  includeDate?: boolean;
  /// If including the date, whether to include the day (defaults to true).
  includeDay?: boolean;
  /// If including the date, whether to include the day of week (defaults to false).
  includeDayOfWeek?: boolean;
  /// Whether to include the time (defaults to true).
  includeTime?: boolean;
  /// If including the time, whether to include seconds (defaults to false).
  includeSeconds?: boolean;
  /// Whether to abbreviate days of the week and month names (defaults to false).
  abbreviate?: boolean;
}
 
/// Localizes a date and time, optionally with the day of the week.
export function localizeDateTime(
  date: Date | Dayjs,
  args: LocalizeDateTimeParams,
): string {
  if (daysjs.isDayjs(date)) {
    date = date.toDate();
  }
  const format = getIntlDateTimeFormat(args);
  return format.format(date);
}
 
/// Localizes only the year and month of a date.
export function localizeYearMonth(
  date: Date | Dayjs,
  args: {
    timezone?: string | typeof BROWSER_TIMEZONE;
    locale: string;
    abbreviate?: boolean;
  },
): string {
  return localizeDateTime(date, {
    timezone: args.timezone,
    locale: args.locale,
    abbreviate: args.abbreviate,
    includeDay: false,
    includeTime: false,
  });
}
 
/// Localizes a range of date and times as a string.
export function localizeDateTimeRange(
  start: Date | Dayjs,
  end: Date | Dayjs,
  args: LocalizeDateTimeParams,
): string {
  if (daysjs.isDayjs(start)) {
    start = start.toDate();
  }
  if (daysjs.isDayjs(end)) {
    end = end.toDate();
  }
  const format = getIntlDateTimeFormat(args);
  return format.formatRange(start, end);
}
 
// Creating Intl.DateTimeFormat every time is 40x slower.
const intlDateTimeFormatCache = new Map<string, Intl.DateTimeFormat>();
 
/// Gets an Intl.DateTimeFormat based on params.
function getIntlDateTimeFormat(
  args: LocalizeDateTimeParams,
): Intl.DateTimeFormat {
  // We can't use args as the Map key as it uses reference equality.
  // Convert it to a json string. The Symbol type requires special handling.
  const cacheKey = JSON.stringify(args, (_, v) =>
    typeof v === "symbol" ? v.toString() : v,
  );
  const cached = intlDateTimeFormatCache.get(cacheKey);
  if (cached) return cached;
 
  const format = createIntlDateTimeFormat(args);
  intlDateTimeFormatCache.set(cacheKey, format);
  return format;
}
 
/// Creates a new Intl.DateTimeFormat object based on params.
function createIntlDateTimeFormat(
  args: LocalizeDateTimeParams,
): Intl.DateTimeFormat {
  const options: Intl.DateTimeFormatOptions = {};
  if (args.includeDate !== false) {
    options.year = "numeric";
    options.month = args.abbreviate ? "short" : "long";
    if (args.includeDay !== false) {
      options.day = "numeric";
    }
    if (args.includeDayOfWeek) {
      options.weekday = args.abbreviate ? "short" : "long";
    }
  }
  if (args.includeTime !== false) {
    options.hour = "numeric";
    options.minute = "numeric";
    if (args.includeSeconds) {
      options.second = "numeric";
    }
  }
  if (args.timezone && args.timezone !== BROWSER_TIMEZONE) {
    options.timeZone = args.timezone;
  }
  return Intl.DateTimeFormat(args.locale, options);
}
 
/// Localizes just the abbreviated month name of a date (e.g. "Jan", "Mai" in German).
export function localizeMonthAbbreviation(
  date: Date | Dayjs,
  args: { locale: string; timezone?: string | typeof BROWSER_TIMEZONE },
): string {
  Iif (daysjs.isDayjs(date)) {
    date = date.toDate();
  }
  const cacheKey = JSON.stringify(args, (_, v) =>
    typeof v === "symbol" ? v.toString() : v,
  );
  let format = intlDateTimeFormatCache.get(cacheKey);
  if (!format) {
    const options: Intl.DateTimeFormatOptions = { month: "short" };
    Iif (args.timezone && args.timezone !== BROWSER_TIMEZONE) {
      options.timeZone = args.timezone;
    }
    format = Intl.DateTimeFormat(args.locale, options);
    intlDateTimeFormatCache.set(cacheKey, format);
  }
  return format.format(date);
}
 
const isoMuiDateFormat = "YYYY-MM-DD";
 
/// Gets the date format for a locale using Material UI placeholders.
export function getMuiDateFormat(locale: string): string {
  if (Intl.DateTimeFormat.supportedLocalesOf(locale).length === 0) {
    return isoMuiDateFormat;
  }
 
  // Format dummy 3333-11-22 date to figure out how it gets laid out.
  const referenceDate = new Intl.DateTimeFormat(locale, {
    day: "numeric",
    month: "numeric",
    year: "numeric",
  }).format(new Date(3333, 10, 22));
 
  const format = referenceDate
    .replace("3333", "YYYY")
    .replace("33", "YY")
    .replace("11", "MM")
    .replace("22", "DD");
 
  // Sanity check: There should be no digits left
  Iif (/[0-9]/.test(format)) return isoMuiDateFormat;
  return format;
}
 
const defaultMuiTimeFormat = "HH:mm";
 
/// Gets a localized time format string compatible with Material UI time pickers.
export function getMuiTimeFormat(locale: string): string {
  if (Intl.DateTimeFormat.supportedLocalesOf(locale).length === 0) {
    return defaultMuiTimeFormat;
  }
 
  const intlFormat = new Intl.DateTimeFormat(locale, {
    hour: "numeric",
    minute: "numeric",
    hour12: undefined,
  });
 
  // Sniff the format using example dates.
  // Assume formats only vary by hour-minute separator, 12h vs 24h, and leading zeroes.
  const hourMinuteSeparatorMatch = /10(\W+)10/.exec(
    intlFormat.format(new Date(1970, 0, 1, 10, 10)),
  );
  const hourMinuteSeparator = hourMinuteSeparatorMatch
    ? hourMinuteSeparatorMatch[1]
    : ":";
  const uses24h = intlFormat.format(new Date(1970, 0, 1, 23, 0)).includes("23");
  const usesLeadingZeroes = intlFormat
    .format(new Date(1970, 0, 1, 3, 0))
    .includes("03");
 
  let format = "";
  if (uses24h) {
    format += usesLeadingZeroes ? "HH" : "H";
  } else {
    format += usesLeadingZeroes ? "hh" : "h";
  }
  format += hourMinuteSeparator;
  format += "mm";
  if (!uses24h) {
    format += " a";
  }
  return format;
}
 
function timestamp2Date(timestamp: Timestamp.AsObject): Date {
  return new Date(Math.floor(timestamp.seconds * 1e3 + timestamp.nanos / 1e6));
}
 
function isSameDate(date1: Dayjs, date2: Dayjs): boolean {
  return (
    date1.month() === date2.month() &&
    date1.year() === date2.year() &&
    date1.date() === date2.date()
  );
}
 
/** Compares whether date1 is equal to or in the future of date2 */
function isSameOrFutureDate(date1: Dayjs, date2: Dayjs): boolean {
  return isSameDate(date1, date2) || date1.isAfter(date2);
}
 
export { isSameOrFutureDate, numNights, timestamp2Date };