All files / app/utils date.ts

93.24% Statements 138/148
90.38% Branches 94/104
94.73% Functions 18/19
95.1% Lines 136/143

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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405      36x     36x             296x 296x 14x 14x   296x   296x 296x     36x   36x                   891x 9x   891x 891x     36x                                               105x       164x 164x 164x           59x               59x                   359x         359x 359x 359x           36x               523x 2306x   523x 523x   37x 37x 37x             37x 37x 31x 31x 31x 27x   31x 10x     37x 27x 27x 27x 1x     37x 37x       9x             9x 27x   9x 9x 2x 2x 2x 2x   9x 9x         36x     768x 768x 1x       767x           767x             767x 767x     36x     72x 72x 1x     71x               71x     71x     71x 71x       71x 71x 8x   63x   71x 71x 71x 63x   71x       323x           1672x   1672x               727x           727x       727x                       36x               960x       960x 960x 960x 14x 14x   960x 960x 1x 960x       31x               961x 923x 38x 6x 32x 10x 22x 5x     17x         7x   7x       10x         6x 1x 5x     4x       930x                 930x 622x     930x         930x   928x 928x   928x         928x 919x       9x 2x       7x 6x           928x   930x        
// format a date
import { Timestamp } from "google-protobuf/google/protobuf/timestamp_pb";
import { TFunction } from "i18next";
import { Temporal } from "temporal-polyfill";
 
// Creating Intl.Segmenter every time is slow, so cache one per locale.
const segmenterCache = new Map<string, Intl.Segmenter>();
 
/// Uppercases the first grapheme cluster of a string, leaving the rest untouched.
/// Non-capitalizable first clusters (digits, CJK, etc.) are returned unchanged.
/// Only for dates that stand alone (their own "sentence") — never for dates
/// interpolated into a larger translated string.
function capitalizeFirstLetter(value: string, locale: string): string {
  let segmenter = segmenterCache.get(locale);
  if (!segmenter) {
    segmenter = new Intl.Segmenter(locale, { granularity: "grapheme" });
    segmenterCache.set(locale, segmenter);
  }
  const first = segmenter.segment(value)[Symbol.iterator]().next()
    .value?.segment;
  Iif (!first) return value;
  return first.toLocaleUpperCase(locale) + value.slice(first.length);
}
 
const dayMillis = Temporal.Duration.from({ hours: 24 }).total("milliseconds");
 
const numNights = (date1: string, date2: string) => {
  const diffTime = Date.parse(date1) - Date.parse(date2);
  const diffDays = Math.ceil(diffTime / dayMillis);
  return diffDays;
};
 
/// Converts a Temporal.PlainDate[Time] to a Date, interpreting it in UTC timezone.
function toUTCDate(
  temporal: Temporal.PlainDate | Temporal.PlainDateTime,
): Date {
  if (temporal instanceof Temporal.PlainDate) {
    temporal = temporal.toPlainDateTime();
  }
  const zoned = temporal.toZonedDateTime("Etc/UTC");
  return new Date(zoned.epochMilliseconds);
}
 
export const UTC_TIMEZONE: string = "Etc/UTC";
 
interface LocalizeDateTimeParams {
  /// The locale to localize in.
  locale: string;
  /// 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;
  /// Whether to uppercase the first letter (defaults to false). Set this only when
  /// the date stands alone (not interpolated into a larger sentence) so it reads
  /// like the start of a sentence. Day/month names are never otherwise capitalized.
  capitalize?: boolean;
}
 
/// Localizes a date and time, optionally with the day of the week.
export function localizeDateTime(
  date: Temporal.PlainDateTime,
  args: LocalizeDateTimeParams,
): string {
  const format = getIntlDateTimeFormatUTC(args);
  const formatted = format.format(toUTCDate(date));
  return args.capitalize
    ? capitalizeFirstLetter(formatted, args.locale)
    : formatted;
}
 
/// Localizes only the year and month of a date.
export function localizeYearMonth(
  date: Temporal.PlainDate,
  args: {
    locale: string;
    abbreviate?: boolean;
    capitalize?: boolean;
  },
): string {
  return localizeDateTime(date.toPlainDateTime(), {
    locale: args.locale,
    abbreviate: args.abbreviate,
    capitalize: args.capitalize,
    includeDay: false,
    includeTime: false,
  });
}
 
/// Localizes a range of date and times as a string.
export function localizeDateTimeRange(
  start: Temporal.PlainDateTime,
  end: Temporal.PlainDateTime,
  args: LocalizeDateTimeParams,
): string {
  const format = getIntlDateTimeFormatUTC(args);
  const formatted = format.formatRange(toUTCDate(start), toUTCDate(end));
  return args.capitalize
    ? capitalizeFirstLetter(formatted, args.locale)
    : formatted;
}
 
// Creating Intl.DateTimeFormat every time is 40x slower.
const intlDateTimeFormatCache = new Map<string, Intl.DateTimeFormat>();
 
/// Gets an Intl.DateTimeFormat based on params.
function getIntlDateTimeFormatUTC(
  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 = createIntlDateTimeFormatUTC(args);
  intlDateTimeFormatCache.set(cacheKey, format);
  return format;
}
 
/// Creates a new Intl.DateTimeFormat object based on params.
function createIntlDateTimeFormatUTC(
  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";
    }
  }
  options.timeZone = "Etc/UTC";
  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: Temporal.PlainDate,
  args: {
    locale: string;
    capitalize?: boolean;
  },
): string {
  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" };
    options.timeZone = "Etc/UTC";
    format = Intl.DateTimeFormat(args.locale, options);
    intlDateTimeFormatCache.set(cacheKey, format);
  }
  const formatted = format.format(toUTCDate(date));
  return args.capitalize
    ? capitalizeFirstLetter(formatted, args.locale)
    : formatted;
}
 
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;
}
 
/// Converts a protobuf Timestamp to a Temporal.Instant value (timezone-agnostic).
export function timestampToInstant(
  timestamp: Timestamp.AsObject,
): Temporal.Instant {
  // By protobuf, seconds and nanos should be integers.
  // Just in case, drop decimals otherwise BigInt will blow up.
  const nanos =
    BigInt(Math.floor(timestamp.nanos)) +
    BigInt(Math.floor(timestamp.seconds)) * 1_000_000_000n;
  return new Temporal.Instant(nanos);
}
 
/// Converts a Temporal Instant to a PlainDateTime in the browser's timezone.
export function instantToPlainDateTime(
  instant: Temporal.Instant,
  timezone?: string,
): Temporal.PlainDateTime {
  return instant
    .toZonedDateTimeISO(timezone ?? Temporal.Now.timeZoneId())
    .toPlainDateTime();
}
 
/// Converts a protobuf Timestamp to a PlainDateTime in the browser's timezone.
export function timestampToPlainDateTime(
  timestamp: Timestamp.AsObject,
  timezone?: string,
): Temporal.PlainDateTime {
  return instantToPlainDateTime(timestampToInstant(timestamp), timezone);
}
 
export interface LocalizeRelativeTimeOptions {
  style?: Intl.RelativeTimeFormatStyle;
  /// We override the default to "auto"
  numeric?: Intl.RelativeTimeFormatNumeric;
  /// If true, capitalize if the script supports it. By default uses running text capitalization.
  capitalize?: boolean;
}
 
// Creating Intl objects every time is slow, so cache them.
const relativeTimeFormatCache = new Map<string, Intl.RelativeTimeFormat>();
 
export function localizeRelativeTimeUnit(
  value: number,
  unit: Intl.RelativeTimeFormatUnit,
  locale: string,
  options?: LocalizeRelativeTimeOptions,
): string {
  const intlOptions = {
    style: options?.style ?? "long",
    numeric: options?.numeric ?? "auto",
  };
  const cacheKey = JSON.stringify({ locale, ...intlOptions });
  let formatter = relativeTimeFormatCache.get(cacheKey);
  if (!formatter) {
    formatter = new Intl.RelativeTimeFormat(locale, intlOptions);
    relativeTimeFormatCache.set(cacheKey, formatter);
  }
  let result = formatter.format(value, unit);
  if (options?.capitalize === true)
    result = capitalizeFirstLetter(result, locale);
  return result;
}
 
/// Localizes a duration (positive or negative)'s largest unit (e.g. "4 days" ignoring minutes).
export function localizeDurationLargestUnit(
  delta: Temporal.Duration,
  locale: string,
  options?: LocalizeRelativeTimeOptions & {
    smallestUnit?: Temporal.PluralizeUnit<Temporal.TimeUnit>;
    t?: TFunction<"global", undefined>;
  },
) {
  if (delta.years != 0)
    return localizeRelativeTimeUnit(delta.years, "years", locale, options);
  if (delta.months != 0)
    return localizeRelativeTimeUnit(delta.months, "months", locale, options);
  if (delta.weeks != 0)
    return localizeRelativeTimeUnit(delta.weeks, "weeks", locale, options);
  if (delta.days != 0)
    return localizeRelativeTimeUnit(delta.days, "days", locale, options);
 
  // Support "less than one hour ago"
  if (
    delta.hours != 0 ||
    options?.smallestUnit == "hour" ||
    options?.smallestUnit == "hours"
  ) {
    Iif (delta.hours == 0 && delta.sign <= 0 && options?.t)
      return options.t("global:relative_time.less_than_one_hour_ago");
    return localizeRelativeTimeUnit(delta.hours, "hours", locale, options);
  }
 
  // Support "less than one minute ago"
  if (
    delta.minutes != 0 ||
    options?.smallestUnit == "minute" ||
    options?.smallestUnit == "minutes"
  ) {
    if (delta.minutes == 0 && delta.sign <= 0 && options?.t)
      return options.t("global:relative_time.less_than_a_minute_ago");
    return localizeRelativeTimeUnit(delta.minutes, "minutes", locale, options);
  }
 
  return localizeRelativeTimeUnit(delta.seconds, "seconds", locale, options);
}
 
/// Localizes a point in time as a duration relative to some other point in time (by default, now).
export function localizeRelativeTime(
  instant: Temporal.Instant | Timestamp.AsObject,
  locale: string,
  options?: LocalizeRelativeTimeOptions & {
    relativeTo?: Temporal.Instant;
    smallestUnit?: Temporal.PluralizeUnit<Temporal.TimeUnit>;
    t?: TFunction<"global", undefined>;
  },
) {
  if (!(instant instanceof Temporal.Instant)) {
    instant = timestampToInstant(instant);
  }
 
  let duration = instant.since(options?.relativeTo ?? Temporal.Now.instant(), {
    largestUnit: "hours", // Only supports time units, no date units.
  });
 
  // Approximate date units above 24 hours.
  if (duration.hours >= 24 || duration.hours <= -24) {
    // Manipulate the absolute value for modulo operations
    const isPositive = duration.sign >= 0;
    duration = duration.abs();
 
    duration = duration.with({
      days: Math.floor(duration.hours / 24),
      hours: duration.hours % 24,
    });
 
    if (duration.days >= 365) {
      duration = duration.with({
        years: Math.floor(duration.days / 365),
        days: duration.days % 365,
      });
    } else if (duration.days >= 30) {
      duration = duration.with({
        months: Math.floor(duration.days / 30),
        days: duration.days % 30,
      });
    } else if (duration.days >= 7) {
      duration = duration.with({
        weeks: Math.floor(duration.days / 7),
        days: duration.days % 7,
      });
    }
 
    if (!isPositive) duration = duration.negated();
  }
  return localizeDurationLargestUnit(duration, locale, options);
}
 
export { numNights };