@internationalized/date 3.0.0-alpha.0 → 3.0.0-alpha.1

package/src/string.ts

@@ -0,0 +1,180 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import {AnyDateTime, Disambiguation} from './types';
+import {CalendarDate, CalendarDateTime, Time, ZonedDateTime} from './CalendarDate';
+import {epochFromDate, fromAbsolute, possibleAbsolutes, toAbsolute, toCalendar, toCalendarDateTime, toTimeZone} from './conversion';
+import {getLocalTimeZone} from './queries';
+import {GregorianCalendar} from './calendars/GregorianCalendar';
+import {Mutable} from './utils';
+
+const TIME_RE = /^(\d{2})(?::(\d{2}))?(?::(\d{2}))?(\.\d+)?$/;
+const DATE_RE = /^(\d{4})-(\d{2})-(\d{2})$/;
+const DATE_TIME_RE = /^(\d{4})-(\d{2})-(\d{2})(?:T(\d{2}))?(?::(\d{2}))?(?::(\d{2}))?(\.\d+)?$/;
+const ZONED_DATE_TIME_RE = /^(\d{4})-(\d{2})-(\d{2})(?:T(\d{2}))?(?::(\d{2}))?(?::(\d{2}))?(\.\d+)?(?:([+-]\d{2})(?::(\d{2}))?)?\[(.*?)\]$/;
+const ABSOLUTE_RE = /^(\d{4})-(\d{2})-(\d{2})(?:T(\d{2}))?(?::(\d{2}))?(?::(\d{2}))?(\.\d+)?(?:(?:([+-]\d{2})(?::(\d{2}))?)|Z)$/;
+
+export function parseTime(value: string): Time {
+  let m = value.match(TIME_RE);
+  if (!m) {
+    throw new Error('Invalid ISO 8601 time string: ' + value);
+  }
+
+  return new Time(
+    parseNumber(m[1], 0, 23),
+    m[2] ? parseNumber(m[2], 0, 59) : 0,
+    m[3] ? parseNumber(m[3], 0, 59) : 0,
+    m[4] ? parseNumber(m[4], 0, Infinity) * 1000 : 0
+  );
+}
+
+export function parseDate(value: string): CalendarDate {
+  let m = value.match(DATE_RE);
+  if (!m) {
+    throw new Error('Invalid ISO 8601 date string: ' + value);
+  }
+
+  let date: Mutable<CalendarDate> = new CalendarDate(
+    parseNumber(m[1], 0, 9999),
+    parseNumber(m[2], 1, 12),
+    1
+  );
+
+  date.day = parseNumber(m[3], 0, date.calendar.getDaysInMonth(date));
+  return date as CalendarDate;
+}
+
+export function parseDateTime(value: string): CalendarDateTime {
+  let m = value.match(DATE_TIME_RE);
+  if (!m) {
+    throw new Error('Invalid ISO 8601 date time string: ' + value);
+  }
+
+  let date: Mutable<CalendarDateTime> = new CalendarDateTime(
+    parseNumber(m[1], 1, 9999),
+    parseNumber(m[2], 1, 12),
+    1,
+    m[4] ? parseNumber(m[4], 0, 23) : 0,
+    m[5] ? parseNumber(m[5], 0, 59) : 0,
+    m[6] ? parseNumber(m[6], 0, 59) : 0,
+    m[7] ? parseNumber(m[7], 0, Infinity) * 1000 : 0
+  );
+
+  date.day = parseNumber(m[3], 0, date.calendar.getDaysInMonth(date));
+  return date as CalendarDateTime;
+}
+
+export function parseZonedDateTime(value: string, disambiguation?: Disambiguation): ZonedDateTime {
+  let m = value.match(ZONED_DATE_TIME_RE);
+  if (!m) {
+    throw new Error('Invalid ISO 8601 date time string: ' + value);
+  }
+
+  let date: Mutable<ZonedDateTime> = new ZonedDateTime(
+    parseNumber(m[1], 1, 9999),
+    parseNumber(m[2], 1, 12),
+    1,
+    m[10],
+    0,
+    m[4] ? parseNumber(m[4], 0, 23) : 0,
+    m[5] ? parseNumber(m[5], 0, 59) : 0,
+    m[6] ? parseNumber(m[6], 0, 59) : 0,
+    m[7] ? parseNumber(m[7], 0, Infinity) * 1000 : 0
+  );
+
+  date.day = parseNumber(m[3], 0, date.calendar.getDaysInMonth(date));
+
+  let plainDateTime = toCalendarDateTime(date as ZonedDateTime);
+
+  let ms: number;
+  if (m[8]) {
+    date.offset = parseNumber(m[8], -23, 23) * 60 * 60 * 1000 + parseNumber(m[9] ?? '0', 0, 59) * 60 * 1000;
+    ms = epochFromDate(date as ZonedDateTime) - date.offset;
+
+    // Validate offset against parsed date.
+    let absolutes = possibleAbsolutes(plainDateTime, date.timeZone);
+    if (!absolutes.includes(ms)) {
+      throw new Error(`Offset ${offsetToString(date.offset)} is invalid for ${dateTimeToString(date)} in ${date.timeZone}`);
+    }
+  } else {
+    // Convert to absolute and back to fix invalid times due to DST.
+    ms = toAbsolute(toCalendarDateTime(plainDateTime), date.timeZone, disambiguation);
+  }
+
+  return fromAbsolute(ms, date.timeZone);
+}
+
+export function parseAbsolute(value: string, timeZone: string): ZonedDateTime {
+  let m = value.match(ABSOLUTE_RE);
+  if (!m) {
+    throw new Error('Invalid ISO 8601 date time string: ' + value);
+  }
+
+  let date: Mutable<ZonedDateTime> = new ZonedDateTime(
+    parseNumber(m[1], 1, 9999),
+    parseNumber(m[2], 1, 12),
+    1,
+    timeZone,
+    0,
+    m[4] ? parseNumber(m[4], 0, 23) : 0,
+    m[5] ? parseNumber(m[5], 0, 59) : 0,
+    m[6] ? parseNumber(m[6], 0, 59) : 0,
+    m[7] ? parseNumber(m[7], 0, Infinity) * 1000 : 0
+  );
+
+  date.day = parseNumber(m[3], 0, date.calendar.getDaysInMonth(date));
+
+  if (m[8]) {
+    date.offset = parseNumber(m[8], -23, 23) * 60 * 60 * 1000 + parseNumber(m[9] ?? '0', 0, 59) * 60 * 1000;
+  }
+
+  return toTimeZone(date as ZonedDateTime, timeZone);
+}
+
+export function parseAbsoluteToLocal(value: string): ZonedDateTime {
+  return parseAbsolute(value, getLocalTimeZone());
+}
+
+function parseNumber(value: string, min: number, max: number) {
+  let val = Number(value);
+  if (val < min || val > max) {
+    throw new RangeError(`Value out of range: ${min} <= ${val} <= ${max}`);
+  }
+
+  return val;
+}
+
+export function timeToString(time: Time): string {
+  return `${String(time.hour).padStart(2, '0')}:${String(time.minute).padStart(2, '0')}:${String(time.second).padStart(2, '0')}${time.millisecond ? String(time.millisecond / 1000).slice(1) : ''}`;
+}
+
+export function dateToString(date: CalendarDate): string {
+  let gregorianDate = toCalendar(date, new GregorianCalendar());
+  return `${String(gregorianDate.year).padStart(4, '0')}-${String(gregorianDate.month).padStart(2, '0')}-${String(gregorianDate.day).padStart(2, '0')}`;
+}
+
+export function dateTimeToString(date: AnyDateTime): string {
+  // @ts-ignore
+  return `${dateToString(date)}T${timeToString(date)}`;
+}
+
+function offsetToString(offset: number) {
+  let sign = Math.sign(offset) < 0 ? '-' : '+';
+  offset = Math.abs(offset);
+  let offsetHours = Math.floor(offset / (60 * 60 * 1000));
+  let offsetMinutes = (offset % (60 * 60 * 1000)) / (60 * 1000);
+  return `${sign}${String(offsetHours).padStart(2, '0')}:${String(offsetMinutes).padStart(2, '0')}`;
+}
+
+export function zonedDateTimeToString(date: ZonedDateTime): string {
+  return `${dateTimeToString(date)}${offsetToString(date.offset)}[${date.timeZone}]`;
+}

package/src/types.ts

@@ -0,0 +1,97 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import {CalendarDate} from './CalendarDate';
+
+export interface AnyCalendarDate {
+  readonly calendar: Calendar,
+  readonly era: string,
+  readonly year: number,
+  readonly month: number,
+  readonly day: number,
+  copy(): this
+}
+
+export interface AnyTime {
+  readonly hour: number,
+  readonly minute: number,
+  readonly second: number,
+  readonly millisecond: number,
+  copy(): this
+}
+
+export interface AnyDateTime extends AnyCalendarDate, AnyTime {}
+
+export interface Calendar {
+  identifier: string,
+
+  fromJulianDay(jd: number): CalendarDate,
+  toJulianDay(date: AnyCalendarDate): number,
+
+  getDaysInMonth(date: AnyCalendarDate): number,
+  getMonthsInYear(date: AnyCalendarDate): number,
+  getYearsInEra(date: AnyCalendarDate): number,
+  getEras(): string[],
+
+  getMinimumMonthInYear?(date: AnyCalendarDate): number,
+  getMinimumDayInMonth?(date: AnyCalendarDate): number,
+
+  balanceDate?(date: AnyCalendarDate): void,
+  balanceYearMonth?(date: AnyCalendarDate, previousDate: AnyCalendarDate): void,
+  getYearsToAdd?(date: AnyCalendarDate, years: number): number,
+  constrainDate?(date: AnyCalendarDate): void
+}
+
+export interface Duration {
+  years?: number,
+  months?: number,
+  weeks?: number,
+  days?: number,
+  hours?: number,
+  minutes?: number,
+  seconds?: number,
+  milliseconds?: number
+}
+
+export interface DateFields {
+  era?: string,
+  year?: number,
+  month?: number,
+  day?: number
+}
+
+export interface TimeFields {
+  hour?: number,
+  minute?: number,
+  second?: number,
+  millisecond?: number
+}
+
+export type DateField = keyof DateFields;
+export type TimeField = keyof TimeFields;
+
+export type Disambiguation = 'compatible' | 'earlier' | 'later' | 'reject';
+
+export interface CycleOptions {
+  /** Whether to round the field value to the nearest interval of the amount. */
+  round?: boolean
+}
+
+export interface CycleTimeOptions extends CycleOptions {
+  /**
+   * Whether to use 12 or 24 hour time. If 12 hour time is chosen, the resulting value
+   * will remain in the same day period as the original value (e.g. if the value is AM,
+   * the resulting value also be AM).
+   * @default 24
+   */
+  hourCycle?: 12 | 24
+}

package/src/utils.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import {CalendarDate, CalendarDateTime} from './CalendarDate';
+
+export type Mutable<T> = {
+  -readonly[P in keyof T]: T[P]
+};
+
+export function mod(amount: number, numerator: number): number {
+  return amount - numerator * Math.floor(amount / numerator);
+}
+
+export function copy(date: CalendarDate): Mutable<CalendarDate> {
+  if (date.era) {
+    return new CalendarDate(date.calendar, date.era, date.year, date.month, date.day);
+  } else {
+    return new CalendarDate(date.calendar, date.year, date.month, date.day);
+  }
+}
+
+export function copyDateTime(date: CalendarDateTime): Mutable<CalendarDateTime> {
+  if (date.era) {
+    return new CalendarDateTime(date.calendar, date.era, date.year, date.month, date.day, date.hour, date.minute, date.second, date.millisecond);
+  } else {
+    return new CalendarDateTime(date.calendar, date.year, date.month, date.day, date.hour, date.minute, date.second);
+  }
+}

package/src/weekStartData.ts

@@ -0,0 +1,108 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+// Data from https://github.com/unicode-cldr/cldr-core/blob/master/supplemental/weekData.json
+// Locales starting on Sunday have been removed for compression.
+export const weekStartData = {
+  '001': 1,
+  AD: 1,
+  AE: 6,
+  AF: 6,
+  AI: 1,
+  AL: 1,
+  AM: 1,
+  AN: 1,
+  AT: 1,
+  AX: 1,
+  AZ: 1,
+  BA: 1,
+  BE: 1,
+  BG: 1,
+  BH: 6,
+  BM: 1,
+  BN: 1,
+  BY: 1,
+  CH: 1,
+  CL: 1,
+  CM: 1,
+  CR: 1,
+  CY: 1,
+  CZ: 1,
+  DE: 1,
+  DJ: 6,
+  DK: 1,
+  DZ: 6,
+  EC: 1,
+  EE: 1,
+  EG: 6,
+  ES: 1,
+  FI: 1,
+  FJ: 1,
+  FO: 1,
+  FR: 1,
+  GB: 1,
+  GE: 1,
+  GF: 1,
+  GP: 1,
+  GR: 1,
+  HR: 1,
+  HU: 1,
+  IE: 1,
+  IQ: 6,
+  IR: 6,
+  IS: 1,
+  IT: 1,
+  JO: 6,
+  KG: 1,
+  KW: 6,
+  KZ: 1,
+  LB: 1,
+  LI: 1,
+  LK: 1,
+  LT: 1,
+  LU: 1,
+  LV: 1,
+  LY: 6,
+  MC: 1,
+  MD: 1,
+  ME: 1,
+  MK: 1,
+  MN: 1,
+  MQ: 1,
+  MV: 5,
+  MY: 1,
+  NL: 1,
+  NO: 1,
+  NZ: 1,
+  OM: 6,
+  PL: 1,
+  QA: 6,
+  RE: 1,
+  RO: 1,
+  RS: 1,
+  RU: 1,
+  SD: 6,
+  SE: 1,
+  SI: 1,
+  SK: 1,
+  SM: 1,
+  SY: 6,
+  TJ: 1,
+  TM: 1,
+  TR: 1,
+  UA: 1,
+  UY: 1,
+  UZ: 1,
+  VA: 1,
+  VN: 1,
+  XK: 1
+};