@checkdigit/time 1.1.0 → 2.0.0-PR.14-c36c

package/src/date-fns-tz/_lib/tzParseTimezone/index.ts

@@ -0,0 +1,146 @@
+import tzTokenizeDate from '../tzTokenizeDate';
+import newDateUTC from '../newDateUTC';
+
+const MILLISECONDS_IN_HOUR = 3600000;
+const MILLISECONDS_IN_MINUTE = 60000;
+
+const patterns = {
+  timezone: /([Z+-].*)$/,
+  timezoneZ: /^(Z)$/,
+  timezoneHH: /^([+-]\d{2})$/,
+  timezoneHHMM: /^([+-]\d{2}):?(\d{2})$/,
+};
+
+// Parse various time zone offset formats to an offset in milliseconds
+export default function tzParseTimezone(timezoneString: string, date?: Date, isUtcDate?: boolean) {
+  let token: RegExpExecArray | null;
+  let absoluteOffset;
+
+  // Empty string
+  if (timezoneString === '') {
+    return 0;
+  }
+
+  // Z
+  token = patterns.timezoneZ.exec(timezoneString);
+  if (token) {
+    return 0;
+  }
+
+  let hours;
+
+  // ±hh
+  token = patterns.timezoneHH.exec(timezoneString);
+  if (token) {
+    hours = parseInt(token[1] as string, 10);
+
+    if (!validateTimezone(hours)) {
+      return NaN;
+    }
+
+    return -(hours * MILLISECONDS_IN_HOUR);
+  }
+
+  // ±hh:mm or ±hhmm
+  token = patterns.timezoneHHMM.exec(timezoneString);
+  if (token) {
+    hours = parseInt(token[1] as string, 10);
+    let minutes = parseInt(token[2] as string, 10);
+
+    if (!validateTimezone(hours, minutes)) {
+      return NaN;
+    }
+
+    absoluteOffset = Math.abs(hours) * MILLISECONDS_IN_HOUR + minutes * MILLISECONDS_IN_MINUTE;
+    return hours > 0 ? -absoluteOffset : absoluteOffset;
+  }
+
+  // IANA time zone
+  if (isValidTimezoneIANAString(timezoneString)) {
+    date = new Date(date || Date.now());
+    let utcDate = isUtcDate ? date : toUtcDate(date);
+
+    let offset = calcOffset(utcDate, timezoneString);
+
+    let fixedOffset = isUtcDate ? offset : fixOffset(date, offset, timezoneString);
+
+    return -fixedOffset;
+  }
+
+  return NaN;
+}
+
+function toUtcDate(date: Date) {
+  return newDateUTC(
+    date.getFullYear(),
+    date.getMonth(),
+    date.getDate(),
+    date.getHours(),
+    date.getMinutes(),
+    date.getSeconds(),
+    date.getMilliseconds(),
+  );
+}
+
+function calcOffset(date: Date, timezoneString: string) {
+  let tokens = tzTokenizeDate(date, timezoneString);
+
+  // ms dropped because it's not provided by tzTokenizeDate
+  let asUTC = newDateUTC(
+    tokens[0] as number,
+    (tokens[1] as number) - 1,
+    tokens[2] as number,
+    (tokens[3] as number) % 24,
+    tokens[4] as number,
+    tokens[5] as number,
+    0,
+  ).getTime();
+
+  let asTS = date.getTime();
+  let over = asTS % 1000;
+  asTS -= over >= 0 ? over : 1000 + over;
+  return asUTC - asTS;
+}
+
+function fixOffset(date: Date, offset: number, timezoneString: string): number {
+  let localTS = date.getTime();
+
+  // Our UTC time is just a guess because our offset is just a guess
+  let utcGuess = localTS - offset;
+
+  // Test whether the zone matches the offset for this ts
+  let o2 = calcOffset(new Date(utcGuess), timezoneString);
+
+  // If so, offset didn't change, and we're done
+  if (offset === o2) {
+    return offset;
+  }
+
+  // If not, change the ts by the difference in the offset
+  utcGuess -= o2 - offset;
+
+  // If that gives us the local time we want, we're done
+  let o3 = calcOffset(new Date(utcGuess), timezoneString);
+  if (o2 === o3) {
+    return o2;
+  }
+
+  // If it's different, we're in a hole time. The offset has changed, but we don't adjust the time
+  return Math.max(o2, o3);
+}
+
+function validateTimezone(hours: number, minutes?: number): boolean {
+  return -23 <= hours && hours <= 23 && (minutes == null || (0 <= minutes && minutes <= 59));
+}
+
+const validIANATimezoneCache = {} as Record<string, boolean>;
+function isValidTimezoneIANAString(timeZoneString: string): boolean {
+  if (validIANATimezoneCache[timeZoneString]) return true;
+  try {
+    new Intl.DateTimeFormat(undefined, { timeZone: timeZoneString });
+    validIANATimezoneCache[timeZoneString] = true;
+    return true;
+  } catch (error) {
+    return false;
+  }
+}

package/src/date-fns-tz/_lib/tzPattern/index.ts

@@ -0,0 +1,4 @@
+/** Regex to identify the presence of a time zone specifier in a date string */
+const tzPattern = /(Z|[+-]\d{2}(?::?\d{2})?| UTC| [a-zA-Z]+\/[a-zA-Z_]+(?:\/[a-zA-Z_]+)?)$/;
+
+export default tzPattern;

package/src/date-fns-tz/_lib/tzTokenizeDate/index.ts

@@ -0,0 +1,80 @@
+/**
+ * Returns the [year, month, day, hour, minute, seconds] tokens of the provided
+ * `date` as it will be rendered in the `timeZone`.
+ */
+export default function tzTokenizeDate(date: Date, timeZone: string) {
+  const dtf = getDateTimeFormat(timeZone);
+  return partsOffset(dtf, date);
+}
+
+const typeToPos = {
+  year: 0,
+  month: 1,
+  day: 2,
+  hour: 3,
+  minute: 4,
+  second: 5,
+};
+
+function partsOffset(dtf: Intl.DateTimeFormat, date: Date) {
+  try {
+    const formatted = dtf.formatToParts(date);
+    const filled = [];
+    for (let i = 0; i < formatted.length; i++) {
+      const pos = typeToPos[formatted[i]?.type as 'year'] as number;
+      if (pos >= 0) {
+        filled[pos] = parseInt(formatted[i]?.value as keyof typeof typeToPos, 10);
+      }
+    }
+    return filled;
+  } catch (error) {
+    if (error instanceof RangeError) {
+      return [NaN];
+    }
+    throw error;
+  }
+}
+
+// to get deterministic local date/time output according to the `en-US` locale which
+// can be used to extract local time parts as necessary.
+const dtfCache = {} as Record<string, Intl.DateTimeFormat>;
+function getDateTimeFormat(timeZone: string): Intl.DateTimeFormat {
+  if (!dtfCache[timeZone]) {
+    // New browsers use `hourCycle`, IE and Chrome <73 does not support it and uses `hour12`
+    const testDateFormatted = new Intl.DateTimeFormat('en-US', {
+      hour12: false,
+      timeZone: 'America/New_York',
+      year: 'numeric',
+      month: 'numeric',
+      day: '2-digit',
+      hour: '2-digit',
+      minute: '2-digit',
+      second: '2-digit',
+    }).format(new Date('2014-06-25T04:00:00.123Z'));
+    const hourCycleSupported =
+      testDateFormatted === '06/25/2014, 00:00:00' || testDateFormatted === '‎06‎/‎25‎/‎2014‎ ‎00‎:‎00‎:‎00';
+
+    dtfCache[timeZone] = hourCycleSupported
+      ? new Intl.DateTimeFormat('en-US', {
+          hour12: false,
+          timeZone: timeZone,
+          year: 'numeric',
+          month: 'numeric',
+          day: '2-digit',
+          hour: '2-digit',
+          minute: '2-digit',
+          second: '2-digit',
+        })
+      : new Intl.DateTimeFormat('en-US', {
+          hourCycle: 'h23',
+          timeZone: timeZone,
+          year: 'numeric',
+          month: 'numeric',
+          day: '2-digit',
+          hour: '2-digit',
+          minute: '2-digit',
+          second: '2-digit',
+        });
+  }
+  return dtfCache[timeZone] as Intl.DateTimeFormat;
+}

package/src/date-fns-tz/format/formatters/index.ts

@@ -0,0 +1,166 @@
+import tzIntlTimeZoneName from '../../_lib/tzIntlTimeZoneName';
+import tzParseTimezone from '../../_lib/tzParseTimezone';
+
+const MILLISECONDS_IN_MINUTE = 60 * 1000;
+
+const formatters = {
+  // Timezone (ISO-8601. If offset is 0, output is always `'Z'`)
+  X: function (
+    date: Date,
+    token: string,
+    _localize: boolean | null,
+    options: { timeZone: string; _originalDate?: Date },
+  ) {
+    const timezoneOffset = getTimeZoneOffset(options.timeZone, options._originalDate || date);
+
+    if (timezoneOffset === 0) {
+      return 'Z';
+    }
+
+    switch (token) {
+      // Hours and optional minutes
+      case 'X':
+        return formatTimezoneWithOptionalMinutes(timezoneOffset);
+
+      // Hours, minutes and optional seconds without `:` delimeter
+      // Note: neither ISO-8601 nor JavaScript supports seconds in timezone offsets
+      // so this token always has the same output as `XX`
+      case 'XXXX':
+      case 'XX': // Hours and minutes without `:` delimeter
+        return formatTimezone(timezoneOffset);
+
+      // Hours, minutes and optional seconds with `:` delimeter
+      // Note: neither ISO-8601 nor JavaScript supports seconds in timezone offsets
+      // so this token always has the same output as `XXX`
+      case 'XXXXX':
+      case 'XXX': // Hours and minutes with `:` delimeter
+      default:
+        return formatTimezone(timezoneOffset, ':');
+    }
+  },
+
+  // Timezone (ISO-8601. If offset is 0, output is `'+00:00'` or equivalent)
+  x: function (
+    date: Date,
+    token: string,
+    _localize: boolean | null,
+    options: { timeZone: string; _originalDate?: Date },
+  ) {
+    const timezoneOffset = getTimeZoneOffset(options.timeZone, options._originalDate || date);
+
+    switch (token) {
+      // Hours and optional minutes
+      case 'x':
+        return formatTimezoneWithOptionalMinutes(timezoneOffset);
+
+      // Hours, minutes and optional seconds without `:` delimeter
+      // Note: neither ISO-8601 nor JavaScript supports seconds in timezone offsets
+      // so this token always has the same output as `xx`
+      case 'xxxx':
+      case 'xx': // Hours and minutes without `:` delimeter
+        return formatTimezone(timezoneOffset);
+
+      // Hours, minutes and optional seconds with `:` delimeter
+      // Note: neither ISO-8601 nor JavaScript supports seconds in timezone offsets
+      // so this token always has the same output as `xxx`
+      case 'xxxxx':
+      case 'xxx': // Hours and minutes with `:` delimeter
+      default:
+        return formatTimezone(timezoneOffset, ':');
+    }
+  },
+
+  // Timezone (GMT)
+  O: function (
+    date: Date,
+    token: string,
+    _localize: boolean | null,
+    options: { timeZone: string; _originalDate?: Date },
+  ) {
+    const timezoneOffset = getTimeZoneOffset(options.timeZone, options._originalDate || date);
+
+    switch (token) {
+      // Short
+      case 'O':
+      case 'OO':
+      case 'OOO':
+        return 'GMT' + formatTimezoneShort(timezoneOffset, ':');
+      // Long
+      case 'OOOO':
+      default:
+        return 'GMT' + formatTimezone(timezoneOffset, ':');
+    }
+  },
+
+  // Timezone (specific non-location)
+  z: function (
+    date: Date,
+    token: string,
+    _localize: boolean | null,
+    options: { timeZone: string; _originalDate?: Date },
+  ) {
+    const originalDate = options._originalDate || date;
+
+    switch (token) {
+      // Short
+      case 'z':
+      case 'zz':
+      case 'zzz':
+        return tzIntlTimeZoneName('short', originalDate, options);
+      // Long
+      case 'zzzz':
+      default:
+        return tzIntlTimeZoneName('long', originalDate, options);
+    }
+  },
+};
+
+function getTimeZoneOffset(timeZone: string, originalDate: Date) {
+  const timeZoneOffset = timeZone
+    ? tzParseTimezone(timeZone, originalDate, true) / MILLISECONDS_IN_MINUTE
+    : originalDate.getTimezoneOffset();
+  if (Number.isNaN(timeZoneOffset)) {
+    throw new RangeError('Invalid time zone specified: ' + timeZone);
+  }
+  return timeZoneOffset;
+}
+
+function addLeadingZeros(num: number, targetLength: number) {
+  const sign = num < 0 ? '-' : '';
+  let output = Math.abs(num).toString();
+  while (output.length < targetLength) {
+    output = '0' + output;
+  }
+  return sign + output;
+}
+
+function formatTimezone(offset: number, dirtyDelimeter?: string) {
+  const delimeter = dirtyDelimeter || '';
+  const sign = offset > 0 ? '-' : '+';
+  const absOffset = Math.abs(offset);
+  const hours = addLeadingZeros(Math.floor(absOffset / 60), 2);
+  const minutes = addLeadingZeros(Math.floor(absOffset % 60), 2);
+  return sign + hours + delimeter + minutes;
+}
+
+function formatTimezoneWithOptionalMinutes(offset: number, dirtyDelimeter?: string) {
+  if (offset % 60 === 0) {
+    const sign = offset > 0 ? '-' : '+';
+    return sign + addLeadingZeros(Math.abs(offset) / 60, 2);
+  }
+  return formatTimezone(offset, dirtyDelimeter);
+}
+
+function formatTimezoneShort(offset: number, dirtyDelimeter: string) {
+  const sign = offset > 0 ? '-' : '+';
+  const absOffset = Math.abs(offset);
+  const hours = Math.floor(absOffset / 60);
+  const minutes = absOffset % 60;
+  if (minutes === 0) {
+    return sign + String(hours);
+  }
+  const delimeter = dirtyDelimeter || '';
+  return sign + String(hours) + delimeter + addLeadingZeros(minutes, 2);
+}
+
+export default formatters;