@mui/x-date-pickers 8.0.0-alpha.11 → 8.0.0-alpha.12

package/esm/AdapterLuxon/AdapterLuxon.d.ts

@@ -0,0 +1,108 @@
+import { DateTime } from 'luxon';
+import { AdapterFormats, AdapterOptions, DateBuilderReturnType, FieldFormatTokenMap, MuiPickersAdapter, PickersTimezone } from "../models/index.js";
+declare module '@mui/x-date-pickers/models' {
+  interface PickerValidDateLookup {
+    luxon: DateTime;
+  }
+}
+/**
+ * Based on `@date-io/luxon`
+ *
+ * MIT License
+ *
+ * Copyright (c) 2017 Dmitriy Kovalenko
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+export declare class AdapterLuxon implements MuiPickersAdapter<string> {
+  isMUIAdapter: boolean;
+  isTimezoneCompatible: boolean;
+  lib: string;
+  locale: string;
+  formats: AdapterFormats;
+  escapedCharacters: {
+    start: string;
+    end: string;
+  };
+  formatTokenMap: FieldFormatTokenMap;
+  constructor({
+    locale,
+    formats
+  }?: AdapterOptions<string, never>);
+  private setLocaleToValue;
+  date: <T extends string | null | undefined>(value?: T, timezone?: PickersTimezone) => DateBuilderReturnType<T>;
+  getInvalidDate: () => DateTime<true> | DateTime<false>;
+  getTimezone: (value: DateTime) => string;
+  setTimezone: (value: DateTime, timezone: PickersTimezone) => DateTime;
+  toJsDate: (value: DateTime) => Date;
+  parse: (value: string, formatString: string) => DateTime<true> | DateTime<false> | null;
+  getCurrentLocaleCode: () => string;
+  is12HourCycleInCurrentLocale: () => boolean;
+  expandFormat: (format: string) => string;
+  isValid: (value: DateTime | null) => value is DateTime;
+  format: (value: DateTime, formatKey: keyof AdapterFormats) => string;
+  formatByString: (value: DateTime, format: string) => string;
+  formatNumber: (numberToFormat: string) => string;
+  isEqual: (value: DateTime | null, comparing: DateTime | null) => boolean;
+  isSameYear: (value: DateTime, comparing: DateTime) => boolean;
+  isSameMonth: (value: DateTime, comparing: DateTime) => boolean;
+  isSameDay: (value: DateTime, comparing: DateTime) => boolean;
+  isSameHour: (value: DateTime, comparing: DateTime) => boolean;
+  isAfter: (value: DateTime, comparing: DateTime) => boolean;
+  isAfterYear: (value: DateTime, comparing: DateTime) => boolean;
+  isAfterDay: (value: DateTime, comparing: DateTime) => boolean;
+  isBefore: (value: DateTime, comparing: DateTime) => boolean;
+  isBeforeYear: (value: DateTime, comparing: DateTime) => boolean;
+  isBeforeDay: (value: DateTime, comparing: DateTime) => boolean;
+  isWithinRange: (value: DateTime, [start, end]: [DateTime, DateTime]) => boolean;
+  startOfYear: (value: DateTime) => DateTime<boolean>;
+  startOfMonth: (value: DateTime) => DateTime<boolean>;
+  startOfWeek: (value: DateTime) => DateTime<boolean>;
+  startOfDay: (value: DateTime) => DateTime<boolean>;
+  endOfYear: (value: DateTime) => DateTime<boolean>;
+  endOfMonth: (value: DateTime) => DateTime<boolean>;
+  endOfWeek: (value: DateTime) => DateTime<boolean>;
+  endOfDay: (value: DateTime) => DateTime<boolean>;
+  addYears: (value: DateTime, amount: number) => DateTime<boolean>;
+  addMonths: (value: DateTime, amount: number) => DateTime<boolean>;
+  addWeeks: (value: DateTime, amount: number) => DateTime<boolean>;
+  addDays: (value: DateTime, amount: number) => DateTime<boolean>;
+  addHours: (value: DateTime, amount: number) => DateTime<boolean>;
+  addMinutes: (value: DateTime, amount: number) => DateTime<boolean>;
+  addSeconds: (value: DateTime, amount: number) => DateTime<boolean>;
+  getYear: (value: DateTime) => number;
+  getMonth: (value: DateTime) => number;
+  getDate: (value: DateTime) => number;
+  getHours: (value: DateTime) => number;
+  getMinutes: (value: DateTime) => number;
+  getSeconds: (value: DateTime) => number;
+  getMilliseconds: (value: DateTime) => number;
+  setYear: (value: DateTime, year: number) => DateTime<boolean>;
+  setMonth: (value: DateTime, month: number) => DateTime<boolean>;
+  setDate: (value: DateTime, date: number) => DateTime<boolean>;
+  setHours: (value: DateTime, hours: number) => DateTime<boolean>;
+  setMinutes: (value: DateTime, minutes: number) => DateTime<boolean>;
+  setSeconds: (value: DateTime, seconds: number) => DateTime<boolean>;
+  setMilliseconds: (value: DateTime, milliseconds: number) => DateTime<boolean>;
+  getDaysInMonth: (value: DateTime) => import("luxon").PossibleDaysInMonth;
+  getWeekArray: (value: DateTime) => DateTime<boolean>[][];
+  getWeekNumber: (value: DateTime) => number;
+  getDayOfWeek: (value: DateTime) => number;
+  getYearRange: ([start, end]: [DateTime, DateTime]) => DateTime<boolean>[];
+}

package/esm/AdapterLuxon/AdapterLuxon.js

@@ -0,0 +1,500 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+/* eslint-disable class-methods-use-this */
+import { DateTime, Info } from 'luxon';
+const formatTokenMap = {
+  // Year
+  y: {
+    sectionType: 'year',
+    contentType: 'digit',
+    maxLength: 4
+  },
+  yy: 'year',
+  yyyy: {
+    sectionType: 'year',
+    contentType: 'digit',
+    maxLength: 4
+  },
+  // Month
+  L: {
+    sectionType: 'month',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  LL: 'month',
+  LLL: {
+    sectionType: 'month',
+    contentType: 'letter'
+  },
+  LLLL: {
+    sectionType: 'month',
+    contentType: 'letter'
+  },
+  M: {
+    sectionType: 'month',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  MM: 'month',
+  MMM: {
+    sectionType: 'month',
+    contentType: 'letter'
+  },
+  MMMM: {
+    sectionType: 'month',
+    contentType: 'letter'
+  },
+  // Day of the month
+  d: {
+    sectionType: 'day',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  dd: 'day',
+  // Day of the week
+  c: {
+    sectionType: 'weekDay',
+    contentType: 'digit',
+    maxLength: 1
+  },
+  ccc: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  cccc: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  E: {
+    sectionType: 'weekDay',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  EEE: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  EEEE: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  // Meridiem
+  a: 'meridiem',
+  // Hours
+  H: {
+    sectionType: 'hours',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  HH: 'hours',
+  h: {
+    sectionType: 'hours',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  hh: 'hours',
+  // Minutes
+  m: {
+    sectionType: 'minutes',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  mm: 'minutes',
+  // Seconds
+  s: {
+    sectionType: 'seconds',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  ss: 'seconds'
+};
+const defaultFormats = {
+  year: 'yyyy',
+  month: 'LLLL',
+  monthShort: 'MMM',
+  dayOfMonth: 'd',
+  // Full day of the month format (i.e. 3rd) is not supported
+  // Falling back to regular format
+  dayOfMonthFull: 'd',
+  weekday: 'cccc',
+  weekdayShort: 'ccccc',
+  hours24h: 'HH',
+  hours12h: 'hh',
+  meridiem: 'a',
+  minutes: 'mm',
+  seconds: 'ss',
+  fullDate: 'DD',
+  keyboardDate: 'D',
+  shortDate: 'MMM d',
+  normalDate: 'd MMMM',
+  normalDateWithWeekday: 'EEE, MMM d',
+  fullTime12h: 'hh:mm a',
+  fullTime24h: 'HH:mm',
+  keyboardDateTime12h: 'D hh:mm a',
+  keyboardDateTime24h: 'D T'
+};
+/**
+ * Based on `@date-io/luxon`
+ *
+ * MIT License
+ *
+ * Copyright (c) 2017 Dmitriy Kovalenko
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+export class AdapterLuxon {
+  constructor({
+    locale,
+    formats
+  } = {}) {
+    this.isMUIAdapter = true;
+    this.isTimezoneCompatible = true;
+    this.lib = 'luxon';
+    this.locale = void 0;
+    this.formats = void 0;
+    this.escapedCharacters = {
+      start: "'",
+      end: "'"
+    };
+    this.formatTokenMap = formatTokenMap;
+    this.setLocaleToValue = value => {
+      const expectedLocale = this.getCurrentLocaleCode();
+      if (expectedLocale === value.locale) {
+        return value;
+      }
+      return value.setLocale(expectedLocale);
+    };
+    this.date = (value, timezone = 'default') => {
+      if (value === null) {
+        return null;
+      }
+      if (typeof value === 'undefined') {
+        // @ts-ignore
+        return DateTime.fromJSDate(new Date(), {
+          locale: this.locale,
+          zone: timezone
+        });
+      }
+
+      // @ts-ignore
+      return DateTime.fromISO(value, {
+        locale: this.locale,
+        zone: timezone
+      });
+    };
+    this.getInvalidDate = () => DateTime.fromJSDate(new Date('Invalid Date'));
+    this.getTimezone = value => {
+      // When using the system zone, we want to return "system", not something like "Europe/Paris"
+      if (value.zone.type === 'system') {
+        return 'system';
+      }
+      return value.zoneName;
+    };
+    this.setTimezone = (value, timezone) => {
+      if (!value.zone.equals(Info.normalizeZone(timezone))) {
+        return value.setZone(timezone);
+      }
+      return value;
+    };
+    this.toJsDate = value => {
+      return value.toJSDate();
+    };
+    this.parse = (value, formatString) => {
+      if (value === '') {
+        return null;
+      }
+      return DateTime.fromFormat(value, formatString, {
+        locale: this.locale
+      });
+    };
+    this.getCurrentLocaleCode = () => {
+      return this.locale;
+    };
+    /* istanbul ignore next */
+    this.is12HourCycleInCurrentLocale = () => {
+      if (typeof Intl === 'undefined' || typeof Intl.DateTimeFormat === 'undefined') {
+        return true; // Luxon defaults to en-US if Intl not found
+      }
+      return Boolean(new Intl.DateTimeFormat(this.locale, {
+        hour: 'numeric'
+      })?.resolvedOptions()?.hour12);
+    };
+    this.expandFormat = format => {
+      // Extract escaped section to avoid extending them
+      const catchEscapedSectionsRegexp = /''|'(''|[^'])+('|$)|[^']*/g;
+
+      // This RegExp tests if a string is only mad of supported tokens
+      const validTokens = [...Object.keys(this.formatTokenMap), 'yyyyy'];
+      const isWordComposedOfTokens = new RegExp(`^(${validTokens.join('|')})+$`);
+
+      // Extract words to test if they are a token or a word to escape.
+      const catchWordsRegexp = /(?:^|[^a-z])([a-z]+)(?:[^a-z]|$)|([a-z]+)/gi;
+      return format.match(catchEscapedSectionsRegexp).map(token => {
+        const firstCharacter = token[0];
+        if (firstCharacter === "'") {
+          return token;
+        }
+        const expandedToken = DateTime.expandFormat(token, {
+          locale: this.locale
+        });
+        return expandedToken.replace(catchWordsRegexp, (substring, g1, g2) => {
+          const word = g1 || g2; // words are either in group 1 or group 2
+
+          if (isWordComposedOfTokens.test(word)) {
+            return substring;
+          }
+          return `'${substring}'`;
+        });
+      }).join('')
+      // The returned format can contain `yyyyy` which means year between 4 and 6 digits.
+      // This value is supported by luxon parser but not luxon formatter.
+      // To avoid conflicts, we replace it by 4 digits which is enough for most use-cases.
+      .replace('yyyyy', 'yyyy');
+    };
+    this.isValid = value => {
+      if (value === null) {
+        return false;
+      }
+      return value.isValid;
+    };
+    this.format = (value, formatKey) => {
+      return this.formatByString(value, this.formats[formatKey]);
+    };
+    this.formatByString = (value, format) => {
+      return value.setLocale(this.locale).toFormat(format);
+    };
+    this.formatNumber = numberToFormat => {
+      return numberToFormat;
+    };
+    this.isEqual = (value, comparing) => {
+      if (value === null && comparing === null) {
+        return true;
+      }
+      if (value === null || comparing === null) {
+        return false;
+      }
+      return +value === +comparing;
+    };
+    this.isSameYear = (value, comparing) => {
+      const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+      return value.hasSame(comparingInValueTimezone, 'year');
+    };
+    this.isSameMonth = (value, comparing) => {
+      const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+      return value.hasSame(comparingInValueTimezone, 'month');
+    };
+    this.isSameDay = (value, comparing) => {
+      const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+      return value.hasSame(comparingInValueTimezone, 'day');
+    };
+    this.isSameHour = (value, comparing) => {
+      const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+      return value.hasSame(comparingInValueTimezone, 'hour');
+    };
+    this.isAfter = (value, comparing) => {
+      return value > comparing;
+    };
+    this.isAfterYear = (value, comparing) => {
+      const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+      const diff = value.diff(this.endOfYear(comparingInValueTimezone), 'years').toObject();
+      return diff.years > 0;
+    };
+    this.isAfterDay = (value, comparing) => {
+      const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+      const diff = value.diff(this.endOfDay(comparingInValueTimezone), 'days').toObject();
+      return diff.days > 0;
+    };
+    this.isBefore = (value, comparing) => {
+      return value < comparing;
+    };
+    this.isBeforeYear = (value, comparing) => {
+      const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+      const diff = value.diff(this.startOfYear(comparingInValueTimezone), 'years').toObject();
+      return diff.years < 0;
+    };
+    this.isBeforeDay = (value, comparing) => {
+      const comparingInValueTimezone = this.setTimezone(comparing, this.getTimezone(value));
+      const diff = value.diff(this.startOfDay(comparingInValueTimezone), 'days').toObject();
+      return diff.days < 0;
+    };
+    this.isWithinRange = (value, [start, end]) => {
+      return this.isEqual(value, start) || this.isEqual(value, end) || this.isAfter(value, start) && this.isBefore(value, end);
+    };
+    this.startOfYear = value => {
+      return value.startOf('year');
+    };
+    this.startOfMonth = value => {
+      return value.startOf('month');
+    };
+    this.startOfWeek = value => {
+      return this.setLocaleToValue(value).startOf('week', {
+        useLocaleWeeks: true
+      });
+    };
+    this.startOfDay = value => {
+      return value.startOf('day');
+    };
+    this.endOfYear = value => {
+      return value.endOf('year');
+    };
+    this.endOfMonth = value => {
+      return value.endOf('month');
+    };
+    this.endOfWeek = value => {
+      return this.setLocaleToValue(value).endOf('week', {
+        useLocaleWeeks: true
+      });
+    };
+    this.endOfDay = value => {
+      return value.endOf('day');
+    };
+    this.addYears = (value, amount) => {
+      return value.plus({
+        years: amount
+      });
+    };
+    this.addMonths = (value, amount) => {
+      return value.plus({
+        months: amount
+      });
+    };
+    this.addWeeks = (value, amount) => {
+      return value.plus({
+        weeks: amount
+      });
+    };
+    this.addDays = (value, amount) => {
+      return value.plus({
+        days: amount
+      });
+    };
+    this.addHours = (value, amount) => {
+      return value.plus({
+        hours: amount
+      });
+    };
+    this.addMinutes = (value, amount) => {
+      return value.plus({
+        minutes: amount
+      });
+    };
+    this.addSeconds = (value, amount) => {
+      return value.plus({
+        seconds: amount
+      });
+    };
+    this.getYear = value => {
+      return value.get('year');
+    };
+    this.getMonth = value => {
+      // See https://github.com/moment/luxon/blob/master/docs/moment.md#major-functional-differences
+      return value.get('month') - 1;
+    };
+    this.getDate = value => {
+      return value.get('day');
+    };
+    this.getHours = value => {
+      return value.get('hour');
+    };
+    this.getMinutes = value => {
+      return value.get('minute');
+    };
+    this.getSeconds = value => {
+      return value.get('second');
+    };
+    this.getMilliseconds = value => {
+      return value.get('millisecond');
+    };
+    this.setYear = (value, year) => {
+      return value.set({
+        year
+      });
+    };
+    this.setMonth = (value, month) => {
+      return value.set({
+        month: month + 1
+      });
+    };
+    this.setDate = (value, date) => {
+      return value.set({
+        day: date
+      });
+    };
+    this.setHours = (value, hours) => {
+      return value.set({
+        hour: hours
+      });
+    };
+    this.setMinutes = (value, minutes) => {
+      return value.set({
+        minute: minutes
+      });
+    };
+    this.setSeconds = (value, seconds) => {
+      return value.set({
+        second: seconds
+      });
+    };
+    this.setMilliseconds = (value, milliseconds) => {
+      return value.set({
+        millisecond: milliseconds
+      });
+    };
+    this.getDaysInMonth = value => {
+      return value.daysInMonth;
+    };
+    this.getWeekArray = value => {
+      const firstDay = this.startOfWeek(this.startOfMonth(value));
+      const lastDay = this.endOfWeek(this.endOfMonth(value));
+      const {
+        days
+      } = lastDay.diff(firstDay, 'days').toObject();
+      const weeks = [];
+      new Array(Math.round(days)).fill(0).map((_, i) => i).map(day => firstDay.plus({
+        days: day
+      })).forEach((v, i) => {
+        if (i === 0 || i % 7 === 0 && i > 6) {
+          weeks.push([v]);
+          return;
+        }
+        weeks[weeks.length - 1].push(v);
+      });
+      return weeks;
+    };
+    this.getWeekNumber = value => {
+      /* istanbul ignore next */
+      return value.localWeekNumber ?? value.weekNumber;
+    };
+    this.getDayOfWeek = value => {
+      return value.weekday;
+    };
+    this.getYearRange = ([start, end]) => {
+      const startDate = this.startOfYear(start);
+      const endDate = this.endOfYear(end);
+      const years = [];
+      let current = startDate;
+      while (this.isBefore(current, endDate)) {
+        years.push(current);
+        current = this.addYears(current, 1);
+      }
+      return years;
+    };
+    this.locale = locale || 'en-US';
+    this.formats = _extends({}, defaultFormats, formats);
+  }
+}

package/esm/AdapterLuxon/index.d.ts

@@ -0,0 +1 @@
+export { AdapterLuxon } from "./AdapterLuxon.js";

package/esm/AdapterLuxon/index.js

@@ -0,0 +1 @@
+export { AdapterLuxon } from "./AdapterLuxon.js";