@mui/x-date-pickers 7.0.0-alpha.6 → 7.0.0-alpha.8

package/AdapterDateFns/AdapterDateFns.d.ts

@@ -1,5 +1,7 @@
+/// <reference types="date-fns" />
 import defaultLocale from 'date-fns/locale/en-US';
-import { AdapterFormats, AdapterOptions, DateBuilderReturnType, FieldFormatTokenMap, MuiPickersAdapter } from '../models';
+import { AdapterFormats, AdapterOptions, MuiPickersAdapter } from '../models';
+import { AdapterDateFnsBase } from '../AdapterDateFnsBase';
 type DateFnsLocale = typeof defaultLocale;
 /**
  * Based on `@date-io/date-fns`
@@ -26,31 +28,12 @@ type DateFnsLocale = typeof defaultLocale;
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-export declare class AdapterDateFns implements MuiPickersAdapter<Date, DateFnsLocale> {
-    isMUIAdapter: boolean;
-    isTimezoneCompatible: boolean;
-    lib: string;
-    locale?: DateFnsLocale;
-    formats: AdapterFormats;
-    formatTokenMap: FieldFormatTokenMap;
-    escapedCharacters: {
-        start: string;
-        end: string;
-    };
+export declare class AdapterDateFns extends AdapterDateFnsBase<DateFnsLocale> implements MuiPickersAdapter<Date, DateFnsLocale> {
     constructor({ locale, formats }?: AdapterOptions<DateFnsLocale, never>);
-    date: <T extends string | null | undefined>(value?: T | undefined) => DateBuilderReturnType<T, Date>;
-    getInvalidDate: () => Date;
-    getTimezone: () => string;
-    setTimezone: (value: Date) => Date;
-    toJsDate: (value: Date) => Date;
     parse: (value: string, format: string) => Date | null;
-    getCurrentLocaleCode: () => string;
-    is12HourCycleInCurrentLocale: () => boolean;
-    expandFormat: (format: string) => string;
     isValid: (value: Date | null) => boolean;
     format: (value: Date, formatKey: keyof AdapterFormats) => string;
     formatByString: (value: Date, formatString: string) => string;
-    formatNumber: (numberToFormat: string) => string;
     isEqual: (value: Date | null, comparing: Date | null) => boolean;
     isSameYear: (value: Date, comparing: Date) => boolean;
     isSameMonth: (value: Date, comparing: Date) => boolean;

package/AdapterDateFns/AdapterDateFns.js

@@ -1,4 +1,3 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
 /* eslint-disable class-methods-use-this */
 import addDays from 'date-fns/addDays';
 import addSeconds from 'date-fns/addSeconds';
@@ -45,196 +44,7 @@ import isWithinInterval from 'date-fns/isWithinInterval';
 import defaultLocale from 'date-fns/locale/en-US';
 // @ts-ignore
 import longFormatters from 'date-fns/_lib/format/longFormatters';
-const formatTokenMap = {
-  // Year
-  y: {
-    sectionType: 'year',
-    contentType: 'digit',
-    maxLength: 4
-  },
-  yy: 'year',
-  yyy: {
-    sectionType: 'year',
-    contentType: 'digit',
-    maxLength: 4
-  },
-  yyyy: 'year',
-  // Month
-  M: {
-    sectionType: 'month',
-    contentType: 'digit',
-    maxLength: 2
-  },
-  MM: 'month',
-  MMMM: {
-    sectionType: 'month',
-    contentType: 'letter'
-  },
-  MMM: {
-    sectionType: 'month',
-    contentType: 'letter'
-  },
-  L: {
-    sectionType: 'month',
-    contentType: 'digit',
-    maxLength: 2
-  },
-  LL: 'month',
-  LLL: {
-    sectionType: 'month',
-    contentType: 'letter'
-  },
-  LLLL: {
-    sectionType: 'month',
-    contentType: 'letter'
-  },
-  // Day of the month
-  d: {
-    sectionType: 'day',
-    contentType: 'digit',
-    maxLength: 2
-  },
-  dd: 'day',
-  do: {
-    sectionType: 'day',
-    contentType: 'digit-with-letter'
-  },
-  // Day of the week
-  E: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  EE: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  EEE: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  EEEE: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  EEEEE: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  i: {
-    sectionType: 'weekDay',
-    contentType: 'digit',
-    maxLength: 1
-  },
-  ii: 'weekDay',
-  iii: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  iiii: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  e: {
-    sectionType: 'weekDay',
-    contentType: 'digit',
-    maxLength: 1
-  },
-  ee: 'weekDay',
-  eee: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  eeee: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  eeeee: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  eeeeee: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  c: {
-    sectionType: 'weekDay',
-    contentType: 'digit',
-    maxLength: 1
-  },
-  cc: 'weekDay',
-  ccc: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  cccc: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  ccccc: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  cccccc: {
-    sectionType: 'weekDay',
-    contentType: 'letter'
-  },
-  // Meridiem
-  a: 'meridiem',
-  aa: 'meridiem',
-  aaa: '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',
-  weekday: 'EEEE',
-  weekdayShort: 'EEEEEE',
-  hours24h: 'HH',
-  hours12h: 'hh',
-  meridiem: 'aa',
-  minutes: 'mm',
-  seconds: 'ss',
-  fullDate: 'PP',
-  keyboardDate: 'P',
-  shortDate: 'MMM d',
-  normalDate: 'd MMMM',
-  normalDateWithWeekday: 'EEE, MMM d',
-  fullTime: 'p',
-  fullTime12h: 'hh:mm aa',
-  fullTime24h: 'HH:mm',
-  keyboardDateTime: 'P p',
-  keyboardDateTime12h: 'P hh:mm aa',
-  keyboardDateTime24h: 'P HH:mm'
-};
-
+import { AdapterDateFnsBase } from '../AdapterDateFnsBase';
 /**
  * Based on `@date-io/date-fns`
  *
@@ -260,40 +70,19 @@ const defaultFormats = {
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-export class AdapterDateFns {
+export class AdapterDateFns extends AdapterDateFnsBase {
   constructor({
-    locale: _locale,
+    locale,
     formats
   } = {}) {
-    this.isMUIAdapter = true;
-    this.isTimezoneCompatible = false;
-    this.lib = 'date-fns';
-    this.locale = void 0;
-    this.formats = void 0;
-    this.formatTokenMap = formatTokenMap;
-    this.escapedCharacters = {
-      start: "'",
-      end: "'"
-    };
-    this.date = value => {
-      if (typeof value === 'undefined') {
-        return new Date();
-      }
-      if (value === null) {
-        return null;
-      }
-      return new Date(value);
-    };
-    this.getInvalidDate = () => new Date('Invalid Date');
-    this.getTimezone = () => {
-      return 'default';
-    };
-    this.setTimezone = value => {
-      return value;
-    };
-    this.toJsDate = value => {
-      return value;
-    };
+    if (typeof addDays !== 'function') {
+      throw new Error(['MUI: The `date-fns` package v3.x is not compatible with this adapter.', 'Please, install v2.x of the package or use the `AdapterDateFnsV3` instead.'].join('\n'));
+    }
+    super({
+      locale: locale != null ? locale : defaultLocale,
+      formats,
+      longFormatters
+    });
     this.parse = (value, format) => {
       if (value === '') {
         return null;
@@ -302,34 +91,6 @@ export class AdapterDateFns {
         locale: this.locale
       });
     };
-    this.getCurrentLocaleCode = () => {
-      var _this$locale;
-      return ((_this$locale = this.locale) == null ? void 0 : _this$locale.code) || 'en-US';
-    };
-    // Note: date-fns input types are more lenient than this adapter, so we need to expose our more
-    // strict signature and delegate to the more lenient signature. Otherwise, we have downstream type errors upon usage.
-    this.is12HourCycleInCurrentLocale = () => {
-      if (this.locale) {
-        return /a/.test(this.locale.formatLong.time());
-      }
-
-      // By default, date-fns is using en-US locale with am/pm enabled
-      return true;
-    };
-    this.expandFormat = format => {
-      const longFormatRegexp = /P+p+|P+|p+|''|'(''|[^'])+('|$)|./g;
-
-      // @see https://github.com/date-fns/date-fns/blob/master/src/format/index.js#L31
-      return format.match(longFormatRegexp).map(token => {
-        const firstCharacter = token[0];
-        if (firstCharacter === 'p' || firstCharacter === 'P') {
-          const longFormatter = longFormatters[firstCharacter];
-          const locale = this.locale || defaultLocale;
-          return longFormatter(token, locale.formatLong, {});
-        }
-        return token;
-      }).join('');
-    };
     this.isValid = value => {
       if (value == null) {
         return false;
@@ -344,9 +105,6 @@ export class AdapterDateFns {
         locale: this.locale
       });
     };
-    this.formatNumber = numberToFormat => {
-      return numberToFormat;
-    };
     this.isEqual = (value, comparing) => {
       if (value === null && comparing === null) {
         return true;
@@ -517,7 +275,5 @@ export class AdapterDateFns {
       }
       return years;
     };
-    this.locale = _locale;
-    this.formats = _extends({}, defaultFormats, formats);
   }
 }

package/AdapterDateFnsBase/AdapterDateFnsBase.d.ts

@@ -0,0 +1,62 @@
+import { AdapterFormats, AdapterOptions, DateBuilderReturnType, FieldFormatTokenMap, MuiPickersAdapter } from '../models';
+import { MakeRequired } from '../internals/models/helpers';
+type DateFnsLocaleBase = {
+    formatLong?: {
+        date?: any;
+        time?: any;
+        dateTime?: any;
+    };
+    code?: string;
+};
+type DateFnsAdapterBaseOptions<DateFnsLocale extends DateFnsLocaleBase> = MakeRequired<AdapterOptions<DateFnsLocale, never>, 'locale'> & {
+    longFormatters: Record<'p' | 'P', (token: string, formatLong: any) => string>;
+};
+/**
+ * Based on `@date-io/date-fns`
+ *
+ * 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 AdapterDateFnsBase<DateFnsLocale extends DateFnsLocaleBase> implements Pick<MuiPickersAdapter<Date, DateFnsLocale>, 'date' | 'getInvalidDate' | 'getTimezone' | 'setTimezone' | 'toJsDate' | 'getCurrentLocaleCode' | 'is12HourCycleInCurrentLocale' | 'expandFormat' | 'formatNumber'> {
+    isMUIAdapter: boolean;
+    isTimezoneCompatible: boolean;
+    lib: string;
+    locale: DateFnsLocale;
+    formats: AdapterFormats;
+    formatTokenMap: FieldFormatTokenMap;
+    escapedCharacters: {
+        start: string;
+        end: string;
+    };
+    longFormatters: DateFnsAdapterBaseOptions<DateFnsLocale>['longFormatters'];
+    constructor(props: DateFnsAdapterBaseOptions<DateFnsLocale>);
+    date: <T extends string | null | undefined>(value?: T | undefined) => DateBuilderReturnType<T, Date>;
+    getInvalidDate: () => Date;
+    getTimezone: () => string;
+    setTimezone: (value: Date) => Date;
+    toJsDate: (value: Date) => Date;
+    getCurrentLocaleCode: () => string;
+    is12HourCycleInCurrentLocale: () => boolean;
+    expandFormat: (format: string) => string;
+    formatNumber: (numberToFormat: string) => string;
+}
+export {};

package/AdapterDateFnsBase/AdapterDateFnsBase.js

@@ -0,0 +1,291 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+/* eslint-disable class-methods-use-this */
+
+const formatTokenMap = {
+  // Year
+  y: {
+    sectionType: 'year',
+    contentType: 'digit',
+    maxLength: 4
+  },
+  yy: 'year',
+  yyy: {
+    sectionType: 'year',
+    contentType: 'digit',
+    maxLength: 4
+  },
+  yyyy: 'year',
+  // Month
+  M: {
+    sectionType: 'month',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  MM: 'month',
+  MMMM: {
+    sectionType: 'month',
+    contentType: 'letter'
+  },
+  MMM: {
+    sectionType: 'month',
+    contentType: 'letter'
+  },
+  L: {
+    sectionType: 'month',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  LL: 'month',
+  LLL: {
+    sectionType: 'month',
+    contentType: 'letter'
+  },
+  LLLL: {
+    sectionType: 'month',
+    contentType: 'letter'
+  },
+  // Day of the month
+  d: {
+    sectionType: 'day',
+    contentType: 'digit',
+    maxLength: 2
+  },
+  dd: 'day',
+  do: {
+    sectionType: 'day',
+    contentType: 'digit-with-letter'
+  },
+  // Day of the week
+  E: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  EE: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  EEE: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  EEEE: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  EEEEE: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  i: {
+    sectionType: 'weekDay',
+    contentType: 'digit',
+    maxLength: 1
+  },
+  ii: 'weekDay',
+  iii: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  iiii: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  e: {
+    sectionType: 'weekDay',
+    contentType: 'digit',
+    maxLength: 1
+  },
+  ee: 'weekDay',
+  eee: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  eeee: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  eeeee: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  eeeeee: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  c: {
+    sectionType: 'weekDay',
+    contentType: 'digit',
+    maxLength: 1
+  },
+  cc: 'weekDay',
+  ccc: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  cccc: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  ccccc: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  cccccc: {
+    sectionType: 'weekDay',
+    contentType: 'letter'
+  },
+  // Meridiem
+  a: 'meridiem',
+  aa: 'meridiem',
+  aaa: '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',
+  weekday: 'EEEE',
+  weekdayShort: 'EEEEEE',
+  hours24h: 'HH',
+  hours12h: 'hh',
+  meridiem: 'aa',
+  minutes: 'mm',
+  seconds: 'ss',
+  fullDate: 'PP',
+  keyboardDate: 'P',
+  shortDate: 'MMM d',
+  normalDate: 'd MMMM',
+  normalDateWithWeekday: 'EEE, MMM d',
+  fullTime: 'p',
+  fullTime12h: 'hh:mm aa',
+  fullTime24h: 'HH:mm',
+  keyboardDateTime: 'P p',
+  keyboardDateTime12h: 'P hh:mm aa',
+  keyboardDateTime24h: 'P HH:mm'
+};
+/**
+ * Based on `@date-io/date-fns`
+ *
+ * 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 AdapterDateFnsBase {
+  constructor(props) {
+    this.isMUIAdapter = true;
+    this.isTimezoneCompatible = false;
+    this.lib = 'date-fns';
+    this.locale = void 0;
+    this.formats = void 0;
+    this.formatTokenMap = formatTokenMap;
+    this.escapedCharacters = {
+      start: "'",
+      end: "'"
+    };
+    this.longFormatters = void 0;
+    this.date = value => {
+      if (typeof value === 'undefined') {
+        return new Date();
+      }
+      if (value === null) {
+        return null;
+      }
+      return new Date(value);
+    };
+    this.getInvalidDate = () => new Date('Invalid Date');
+    this.getTimezone = () => {
+      return 'default';
+    };
+    this.setTimezone = value => {
+      return value;
+    };
+    this.toJsDate = value => {
+      return value;
+    };
+    this.getCurrentLocaleCode = () => {
+      var _this$locale;
+      return ((_this$locale = this.locale) == null ? void 0 : _this$locale.code) || 'en-US';
+    };
+    // Note: date-fns input types are more lenient than this adapter, so we need to expose our more
+    // strict signature and delegate to the more lenient signature. Otherwise, we have downstream type errors upon usage.
+    this.is12HourCycleInCurrentLocale = () => {
+      if (this.locale) {
+        return /a/.test(this.locale.formatLong.time({
+          width: 'short'
+        }));
+      }
+
+      // By default, date-fns is using en-US locale with am/pm enabled
+      return true;
+    };
+    this.expandFormat = format => {
+      const longFormatRegexp = /P+p+|P+|p+|''|'(''|[^'])+('|$)|./g;
+
+      // @see https://github.com/date-fns/date-fns/blob/master/src/format/index.js#L31
+      return format.match(longFormatRegexp).map(token => {
+        const firstCharacter = token[0];
+        if (firstCharacter === 'p' || firstCharacter === 'P') {
+          const longFormatter = this.longFormatters[firstCharacter];
+          return longFormatter(token, this.locale.formatLong);
+        }
+        return token;
+      }).join('');
+    };
+    this.formatNumber = numberToFormat => {
+      return numberToFormat;
+    };
+    const {
+      locale,
+      formats,
+      longFormatters
+    } = props;
+    this.locale = locale;
+    this.formats = _extends({}, defaultFormats, formats);
+    this.longFormatters = longFormatters;
+  }
+}

package/AdapterDateFnsBase/index.d.ts

@@ -0,0 +1 @@
+export { AdapterDateFnsBase } from './AdapterDateFnsBase';

package/AdapterDateFnsBase/index.js

@@ -0,0 +1 @@
+export { AdapterDateFnsBase } from './AdapterDateFnsBase';