Review: Michel

Author: flaviendelangle

docs/data/migration/migration-pickers-v7/migration-pickers-v7.md

@@ -371,8 +371,8 @@ This change causes a few breaking changes:
 
    // This contains a small behavior change.
    // If the picker receives an invalid date,
-   // the old value would equal `null`.
-   // the new value would equal the invalid date received.
+   // the old value equals `null`.
+   // the new value equals the invalid date received.
   -const { value } = props;
   +const { value } = usePickerContext();
   ```

packages/x-date-pickers-pro/src/DateRangeCalendar/DateRangeCalendar.tsx

@@ -292,8 +292,8 @@ const DateRangeCalendar = React.forwardRef(function DateRangeCalendar(
   // This makes sure that `isWithinRange` works with any time in the start and end day.
   const valueDayRange = React.useMemo<PickerRangeValue>(
     () => [
-      value[0] == null || !utils.isValid(value[0]) ? value[0] : utils.startOfDay(value[0]),
-      value[1] == null || !utils.isValid(value[1]) ? value[1] : utils.endOfDay(value[1]),
+      !utils.isValid(value[0]) ? value[0] : utils.startOfDay(value[0]),
+      !utils.isValid(value[1]) ? value[1] : utils.endOfDay(value[1]),
     ],
     [value, utils],
   );
@@ -386,7 +386,7 @@ const DateRangeCalendar = React.forwardRef(function DateRangeCalendar(
   const prevValue = React.useRef<PickerRangeValue | null>(null);
   React.useEffect(() => {
     const date = rangePosition === 'start' ? value[0] : value[1];
-    if (!date || !utils.isValid(date)) {
+    if (!utils.isValid(date)) {
       return;
     }
 

packages/x-date-pickers-pro/src/DateRangePicker/DateRangePickerToolbar.tsx

@@ -99,7 +99,7 @@ const DateRangePickerToolbar = React.forwardRef(function DateRangePickerToolbar(
   const toolbarFormat = toolbarFormatProp ?? utils.formats.shortDate;
 
   const formatDate = (date: PickerValidDate | null, fallback: string) => {
-    if (date == null || !utils.isValid(date)) {
+    if (!utils.isValid(date)) {
       return fallback;
     }
 

packages/x-date-pickers-pro/src/internals/utils/date-range-manager.ts

@@ -31,8 +31,8 @@ export function calculateRangeChange({
   shouldMergeDateAndTime = false,
   referenceDate,
 }: CalculateRangeChangeOptions): CalculateRangeChangeResponse {
-  const start = range[0] == null || !utils.isValid(range[0]) ? null : range[0];
-  const end = range[1] == null || !utils.isValid(range[1]) ? null : range[1];
+  const start = !utils.isValid(range[0]) ? null : range[0];
+  const end = !utils.isValid(range[1]) ? null : range[1];
 
   if (shouldMergeDateAndTime && selectedDate) {
     // If there is a date already selected, then we want to keep its time

packages/x-date-pickers-pro/src/internals/utils/valueManagers.ts

@@ -34,8 +34,8 @@ export const rangeValueManager: RangePickerValueManager = {
     getTodayDate(utils, timezone, valueType),
   ],
   getInitialReferenceValue: ({ value, referenceDate: referenceDateProp, ...params }) => {
-    const shouldKeepStartDate = value[0] != null && params.utils.isValid(value[0]);
-    const shouldKeepEndDate = value[1] != null && params.utils.isValid(value[1]);
+    const shouldKeepStartDate = params.utils.isValid(value[0]);
+    const shouldKeepEndDate = params.utils.isValid(value[1]);
 
     if (shouldKeepStartDate && shouldKeepEndDate) {
       return value as PickerNonNullableRangeValue;
@@ -56,10 +56,8 @@ export const rangeValueManager: RangePickerValueManager = {
   hasError: (error) => error[0] != null || error[1] != null,
   defaultErrorState: [null, null],
   getTimezone: (utils, value) => {
-    const timezoneStart =
-      value[0] == null || !utils.isValid(value[0]) ? null : utils.getTimezone(value[0]);
-    const timezoneEnd =
-      value[1] == null || !utils.isValid(value[1]) ? null : utils.getTimezone(value[1]);
+    const timezoneStart = utils.isValid(value[0]) ? utils.getTimezone(value[0]) : null;
+    const timezoneEnd = utils.isValid(value[1]) ? utils.getTimezone(value[1]) : null;
 
     if (timezoneStart != null && timezoneEnd != null && timezoneStart !== timezoneEnd) {
       throw new Error('MUI X: The timezone of the start and the end date should be the same.');
@@ -79,8 +77,8 @@ export const getRangeFieldValueManager = ({
   dateSeparator: string | undefined;
 }): FieldValueManager<PickerRangeValue> => ({
   updateReferenceValue: (utils, value, prevReferenceValue) => {
-    const shouldKeepStartDate = value[0] != null && utils.isValid(value[0]);
-    const shouldKeepEndDate = value[1] != null && utils.isValid(value[1]);
+    const shouldKeepStartDate = utils.isValid(value[0]);
+    const shouldKeepEndDate = utils.isValid(value[1]);
 
     if (!shouldKeepStartDate && !shouldKeepEndDate) {
       return prevReferenceValue;
@@ -184,10 +182,9 @@ export const getRangeFieldValueManager = ({
       },
       getNewValuesFromNewActiveDate: (newActiveDate) => ({
         value: updateDateInRange(newActiveDate, state.value),
-        referenceValue:
-          newActiveDate == null || !utils.isValid(newActiveDate)
-            ? state.referenceValue
-            : updateDateInRange(newActiveDate, state.referenceValue),
+        referenceValue: !utils.isValid(newActiveDate)
+          ? state.referenceValue
+          : updateDateInRange(newActiveDate, state.referenceValue),
       }),
     };
   },

packages/x-date-pickers/src/AdapterDateFns/AdapterDateFns.ts

@@ -107,7 +107,7 @@ export class AdapterDateFns
     return dateFnsParse(value, format, new Date(), { locale: this.locale });
   };
 
-  public isValid = (value: Date | null): boolean => {
+  public isValid = (value: Date | null): value is Date => {
     if (value == null) {
       return false;
     }

packages/x-date-pickers/src/AdapterDateFnsJalali/AdapterDateFnsJalali.ts

@@ -155,7 +155,7 @@ export class AdapterDateFnsJalali
     return dateFnsParse(value, format, new Date(), { locale: this.locale });
   };
 
-  public isValid = (value: Date | null): boolean => {
+  public isValid = (value: Date | null): value is Date => {
     if (value == null) {
       return false;
     }

packages/x-date-pickers/src/AdapterDateFnsJalaliV3/AdapterDateFnsJalaliV3.ts

@@ -162,7 +162,7 @@ export class AdapterDateFnsJalali
     return dateFnsParse(value, format, new Date(), { locale: this.locale });
   };
 
-  public isValid = (value: Date | null): boolean => {
+  public isValid = (value: Date | null): value is Date => {
     if (value == null) {
       return false;
     }

packages/x-date-pickers/src/AdapterDateFnsV3/AdapterDateFnsV3.ts

@@ -115,7 +115,7 @@ export class AdapterDateFns
     return dateFnsParse(value, format, new Date(), { locale: this.locale });
   };
 
-  public isValid = (value: Date | null): boolean => {
+  public isValid = (value: Date | null): value is Date => {
     if (value == null) {
       return false;
     }

packages/x-date-pickers/src/AdapterDayjs/AdapterDayjs.ts

@@ -414,7 +414,7 @@ export class AdapterDayjs implements MuiPickersAdapter<string> {
     );
   };
 
-  public isValid = (value: Dayjs | null) => {
+  public isValid = (value: Dayjs | null): value is Dayjs => {
     if (value == null) {
       return false;
     }

packages/x-date-pickers/src/AdapterLuxon/AdapterLuxon.ts

@@ -247,7 +247,7 @@ export class AdapterLuxon implements MuiPickersAdapter<string> {
     );
   };
 
-  public isValid = (value: DateTime | null): boolean => {
+  public isValid = (value: DateTime | null): value is DateTime => {
     if (value === null) {
       return false;
     }

packages/x-date-pickers/src/AdapterMoment/AdapterMoment.ts

@@ -304,7 +304,7 @@ export class AdapterMoment implements MuiPickersAdapter<string> {
       .join('');
   };
 
-  public isValid = (value: Moment | null) => {
+  public isValid = (value: Moment | null): value is Moment => {
     if (value == null) {
       return false;
     }

packages/x-date-pickers/src/DateCalendar/DateCalendar.tsx

@@ -293,7 +293,7 @@ export const DateCalendar = React.forwardRef(function DateCalendar(
   });
 
   React.useEffect(() => {
-    if (value != null && utils.isValid(value)) {
+    if (utils.isValid(value)) {
       changeMonth(value);
     }
   }, [value]); // eslint-disable-line

packages/x-date-pickers/src/DatePicker/DatePickerToolbar.tsx

@@ -94,7 +94,7 @@ export const DatePickerToolbar = React.forwardRef(function DatePickerToolbar(
   const classes = useUtilityClasses(classesProp);
 
   const dateText = React.useMemo(() => {
-    if (value == null || !utils.isValid(value)) {
+    if (!utils.isValid(value)) {
       return toolbarPlaceholder;
     }
 

packages/x-date-pickers/src/DateTimePicker/DateTimePickerToolbar.tsx

@@ -303,7 +303,7 @@ function DateTimePickerToolbar(inProps: DateTimePickerToolbarProps) {
   const toolbarTitle = inToolbarTitle ?? translations.dateTimePickerToolbarTitle;
 
   const dateText = React.useMemo(() => {
-    if (value == null || !utils.isValid(value)) {
+    if (!utils.isValid(value)) {
       return toolbarPlaceholder;
     }
 
@@ -315,7 +315,7 @@ function DateTimePickerToolbar(inProps: DateTimePickerToolbarProps) {
   }, [value, toolbarFormat, toolbarPlaceholder, utils]);
 
   const formatSection = (format: keyof AdapterFormats, fallback: string) => {
-    if (value == null || !utils.isValid(value)) {
+    if (!utils.isValid(value)) {
       return fallback;
     }
 

packages/x-date-pickers/src/TimePicker/TimePickerToolbar.tsx

@@ -168,7 +168,7 @@ function TimePickerToolbar(inProps: TimePickerToolbarProps) {
   );
 
   const formatSection = (format: keyof AdapterFormats) => {
-    if (value == null || !utils.isValid(value)) {
+    if (!utils.isValid(value)) {
       return '--';
     }
 

packages/x-date-pickers/src/internals/hooks/date-helpers-hooks.tsx

@@ -57,10 +57,7 @@ export function useMeridiemMode(
   selectionState?: PickerSelectionState,
 ) {
   const utils = useUtils();
-  const cleanDate = React.useMemo(
-    () => (date == null || !utils.isValid(date) ? null : date),
-    [utils, date],
-  );
+  const cleanDate = React.useMemo(() => (!utils.isValid(date) ? null : date), [utils, date]);
 
   const meridiemMode = getMeridiem(cleanDate, utils);
 

packages/x-date-pickers/src/internals/hooks/useField/buildSectionsFromFormat.ts

@@ -143,7 +143,7 @@ const createSection = ({
     ? hasLeadingZerosInFormat
     : sectionConfig.contentType === 'digit';
 
-  const isValidDate = date != null && utils.isValid(date);
+  const isValidDate = utils.isValid(date);
   let sectionValue = isValidDate ? utils.formatByString(date, token) : '';
   let maxLength: number | null = null;
 

packages/x-date-pickers/src/internals/hooks/useField/useField.utils.ts

@@ -548,10 +548,7 @@ export const getSectionsBoundaries = (
     }),
     day: ({ currentDate }) => ({
       minimum: 1,
-      maximum:
-        currentDate != null && utils.isValid(currentDate)
-          ? utils.getDaysInMonth(currentDate)
-          : maxDaysInMonth,
+      maximum: utils.isValid(currentDate) ? utils.getDaysInMonth(currentDate) : maxDaysInMonth,
       longestMonth: longestMonth!,
     }),
     weekDay: ({ format, contentType }) => {

packages/x-date-pickers/src/internals/hooks/useField/useFieldState.ts

@@ -274,7 +274,7 @@ export const useFieldState = <
   const updateValueFromValueStr = (valueStr: string) => {
     const parseDateStr = (dateStr: string, referenceDate: PickerValidDate) => {
       const date = utils.parse(dateStr, format);
-      if (date == null || !utils.isValid(date)) {
+      if (!utils.isValid(date)) {
         return null;
       }
 
@@ -335,7 +335,7 @@ export const useFieldState = <
      * Then we merge the value of the modified sections into the reference date.
      * This makes sure that we don't lose some information of the initial date (like the time on a date field).
      */
-    if (newActiveDate != null && utils.isValid(newActiveDate)) {
+    if (utils.isValid(newActiveDate)) {
       const mergedDate = mergeDateIntoReferenceDate(
         utils,
         newActiveDate,

packages/x-date-pickers/src/internals/utils/date-utils.ts

@@ -96,7 +96,7 @@ export const findClosestEnabledDate = ({
 export const replaceInvalidDateByNull = (
   utils: MuiPickersAdapter,
   value: PickerValidDate | null,
-): PickerValidDate | null => (value == null || !utils.isValid(value) ? null : value);
+): PickerValidDate | null => (!utils.isValid(value) ? null : value);
 
 export const applyDefaultDate = (
   utils: MuiPickersAdapter,

packages/x-date-pickers/src/internals/utils/valueManagers.ts

@@ -17,7 +17,7 @@ export const singleItemValueManager: SingleItemPickerValueManager = {
   emptyValue: null,
   getTodayValue: getTodayDate,
   getInitialReferenceValue: ({ value, referenceDate, ...params }) => {
-    if (value != null && params.utils.isValid(value)) {
+    if (params.utils.isValid(value)) {
       return value;
     }
 
@@ -32,15 +32,14 @@ export const singleItemValueManager: SingleItemPickerValueManager = {
   isSameError: (a, b) => a === b,
   hasError: (error) => error != null,
   defaultErrorState: null,
-  getTimezone: (utils, value) =>
-    value == null || !utils.isValid(value) ? null : utils.getTimezone(value),
+  getTimezone: (utils, value) => (utils.isValid(value) ? utils.getTimezone(value) : null),
   setTimezone: (utils, timezone, value) =>
     value == null ? null : utils.setTimezone(value, timezone),
 };
 
 export const singleItemFieldValueManager: FieldValueManager<PickerValue> = {
   updateReferenceValue: (utils, value, prevReferenceValue) =>
-    value == null || !utils.isValid(value) ? prevReferenceValue : value,
+    !utils.isValid(value) ? prevReferenceValue : value,
   getSectionsFromValue: (utils, date, prevSections, getSectionsFromDate) => {
     const shouldReUsePrevDateSections = !utils.isValid(date) && !!prevSections;
 
@@ -58,10 +57,7 @@ export const singleItemFieldValueManager: FieldValueManager<PickerValue> = {
     getSections: (sections) => sections,
     getNewValuesFromNewActiveDate: (newActiveDate) => ({
       value: newActiveDate,
-      referenceValue:
-        newActiveDate == null || !utils.isValid(newActiveDate)
-          ? state.referenceValue
-          : newActiveDate,
+      referenceValue: utils.isValid(newActiveDate) ? newActiveDate : state.referenceValue,
     }),
   }),
   parseValueStr: (valueStr, referenceValue, parseDate) =>

packages/x-date-pickers/src/locales/utils/getPickersLocalization.ts

@@ -22,8 +22,7 @@ export const buildGetOpenDialogAriaText = (params: {
   const { utils, formatKey, contextTranslation, propsTranslation } = params;
 
   return (value: PickerValidDate | null) => {
-    const formattedValue =
-      value !== null && utils.isValid(value) ? utils.format(value, formatKey) : null;
+    const formattedValue = utils.isValid(value) ? utils.format(value, formatKey) : null;
     const translation = propsTranslation ?? contextTranslation;
     return translation(formattedValue);
   };

packages/x-date-pickers/src/models/adapters.ts

@@ -243,7 +243,7 @@ export interface MuiPickersAdapter<TLocale = any> {
    * @param {PickerValidDate | null} value The value to test.
    * @returns {boolean} `true` if the value is a valid date according to the date library.
    */
-  isValid(value: PickerValidDate | null): boolean;
+  isValid(value: PickerValidDate | null): value is PickerValidDate;
   /**
    * Format a date using an adapter format string (see the `AdapterFormats` interface)
    * @param {PickerValidDate} value The date to format.