@mui/x-date-pickers 7.15.0 → 7.17.0

package/validation/useValidation.js

@@ -0,0 +1,54 @@
+'use client';
+
+import * as React from 'react';
+import useEventCallback from '@mui/utils/useEventCallback';
+import { useLocalizationContext } from "../internals/hooks/useUtils.js";
+/**
+ * Utility hook to check if a given value is valid based on the provided validation props.
+ * @template TDate
+ * @template TValue The value type. It will be either the same type as `value` or `null`. It can be in `[start, end]` format in case of range value.
+ * @template TError The validation error type. It will be either `string` or a `null`. It can be in `[start, end]` format in case of range value.
+ * @param {UseValidationOptions<TValue, TDate, TError, TValidationProps>} options The options to configure the hook.
+ * @param {TValue} options.value The value to validate.
+ * @param {PickersTimezone} options.timezone The timezone to use for the validation.
+ * @param {Validator<TValue, TDate, TError, TValidationProps>} options.validator The validator function to use.
+ * @param {TValidationProps} options.props The validation props, they differ depending on the component.
+ * @param {(error: TError, value: TValue) => void} options.onError Callback fired when the error associated with the current value changes.
+ */
+export function useValidation(options) {
+  const {
+    props,
+    validator,
+    value,
+    timezone,
+    onError
+  } = options;
+  const adapter = useLocalizationContext();
+  const previousValidationErrorRef = React.useRef(validator.valueManager.defaultErrorState);
+  const validationError = validator({
+    adapter,
+    value,
+    timezone,
+    props
+  });
+  const hasValidationError = validator.valueManager.hasError(validationError);
+  React.useEffect(() => {
+    if (onError && !validator.valueManager.isSameError(validationError, previousValidationErrorRef.current)) {
+      onError(validationError, value);
+    }
+    previousValidationErrorRef.current = validationError;
+  }, [validator, onError, validationError, value]);
+  const getValidationErrorForNewValue = useEventCallback(newValue => {
+    return validator({
+      adapter,
+      value: newValue,
+      timezone,
+      props
+    });
+  });
+  return {
+    validationError,
+    hasValidationError,
+    getValidationErrorForNewValue
+  };
+}

package/validation/validateDate.d.ts

@@ -0,0 +1,6 @@
+import { Validator } from './useValidation';
+import { BaseDateValidationProps, DayValidationProps, MonthValidationProps, YearValidationProps } from '../internals/models/validation';
+import { DateValidationError, PickerValidDate } from '../models';
+export interface ValidateDateProps<TDate extends PickerValidDate> extends DayValidationProps<TDate>, MonthValidationProps<TDate>, YearValidationProps<TDate>, Required<BaseDateValidationProps<TDate>> {
+}
+export declare const validateDate: Validator<any | null, any, DateValidationError, ValidateDateProps<any>>;

package/{internals/utils/validation → validation}/validateDate.js

@@ -1,7 +1,9 @@
-import { applyDefaultDate } from '../date-utils';
+import { applyDefaultDate } from "../internals/utils/date-utils.js";
+import { singleItemValueManager } from "../internals/utils/valueManagers.js";
 export const validateDate = ({
   props,
   value,
+  timezone,
   adapter
 }) => {
   if (value === null) {
@@ -12,8 +14,7 @@ export const validateDate = ({
     shouldDisableMonth,
     shouldDisableYear,
     disablePast,
-    disableFuture,
-    timezone
+    disableFuture
   } = props;
   const now = adapter.utils.date(undefined, timezone);
   const minDate = applyDefaultDate(adapter.utils, props.minDate, adapter.defaultDates.minDate);
@@ -38,4 +39,5 @@ export const validateDate = ({
     default:
       return null;
   }
-};
+};
+validateDate.valueManager = singleItemValueManager;

package/validation/validateDateTime.d.ts

@@ -0,0 +1,7 @@
+import { Validator } from './useValidation';
+import { ValidateDateProps } from './validateDate';
+import { ValidateTimeProps } from './validateTime';
+import { DateTimeValidationError, PickerValidDate } from '../models';
+export interface ValidateDateTimeProps<TDate extends PickerValidDate> extends ValidateDateProps<TDate>, ValidateTimeProps<TDate> {
+}
+export declare const validateDateTime: Validator<any | null, any, DateTimeValidationError, ValidateDateTimeProps<any>>;

package/validation/validateDateTime.js

@@ -0,0 +1,26 @@
+import { validateDate } from "./validateDate.js";
+import { validateTime } from "./validateTime.js";
+import { singleItemValueManager } from "../internals/utils/valueManagers.js";
+export const validateDateTime = ({
+  adapter,
+  value,
+  timezone,
+  props
+}) => {
+  const dateValidationResult = validateDate({
+    adapter,
+    value,
+    timezone,
+    props
+  });
+  if (dateValidationResult !== null) {
+    return dateValidationResult;
+  }
+  return validateTime({
+    adapter,
+    value,
+    timezone,
+    props
+  });
+};
+validateDateTime.valueManager = singleItemValueManager;

package/validation/validateTime.d.ts

@@ -0,0 +1,6 @@
+import { Validator } from './useValidation';
+import { BaseTimeValidationProps, TimeValidationProps } from '../internals/models/validation';
+import { PickerValidDate, TimeValidationError } from '../models';
+export interface ValidateTimeProps<TDate extends PickerValidDate> extends Required<BaseTimeValidationProps>, TimeValidationProps<TDate> {
+}
+export declare const validateTime: Validator<any | null, any, TimeValidationError, ValidateTimeProps<any>>;

package/{modern/internals/utils/validation → validation}/validateTime.js

@@ -1,7 +1,9 @@
-import { createIsAfterIgnoreDatePart } from '../time-utils';
+import { createIsAfterIgnoreDatePart } from "../internals/utils/time-utils.js";
+import { singleItemValueManager } from "../internals/utils/valueManagers.js";
 export const validateTime = ({
   adapter,
   value,
+  timezone,
   props
 }) => {
   if (value === null) {
@@ -14,8 +16,7 @@ export const validateTime = ({
     shouldDisableTime,
     disableIgnoringDatePartForTimeValidation = false,
     disablePast,
-    disableFuture,
-    timezone
+    disableFuture
   } = props;
   const now = adapter.utils.date(undefined, timezone);
   const isAfter = createIsAfterIgnoreDatePart(disableIgnoringDatePartForTimeValidation, adapter.utils);
@@ -41,4 +42,5 @@ export const validateTime = ({
     default:
       return null;
   }
-};
+};
+validateTime.valueManager = singleItemValueManager;

package/internals/hooks/useValidation.d.ts

@@ -1,24 +0,0 @@
-import { MuiPickersAdapterContextValue } from '../../LocalizationProvider/LocalizationProvider';
-import { PickerValidDate } from '../../models';
-interface ValidationCommonProps<TError, TValue> {
-    /**
-     * Callback that fired when input value or new `value` prop validation returns **new** validation error (or value is valid after error).
-     * In case of validation error detected `reason` prop return non-null value and `TextField` must be displayed in `error` state.
-     * This can be used to render appropriate form error.
-     * @template TError The validation error type. Will be either `string` or a `null`. Can be in `[start, end]` format in case of range value.
-     * @template TValue The value type. Will be either the same type as `value` or `null`. Can be in `[start, end]` format in case of range value.
-     * @param {TError} reason The reason why the current value is not valid.
-     * @param {TValue} value The invalid value.
-     */
-    onError?: (reason: TError, value: TValue) => void;
-    value: TValue;
-}
-export type ValidationProps<TError, TValue, TValidationProps extends {}> = ValidationCommonProps<TError, TValue> & TValidationProps;
-export type InferError<TProps> = TProps extends Pick<ValidationCommonProps<any, any>, 'onError'> ? Parameters<Exclude<TProps['onError'], undefined>>[0] : never;
-export type Validator<TValue, TDate extends PickerValidDate, TError, TValidationProps> = (params: {
-    adapter: MuiPickersAdapterContextValue<TDate>;
-    value: TValue;
-    props: Omit<TValidationProps, 'value' | 'onError'>;
-}) => TError;
-export declare function useValidation<TValue, TDate extends PickerValidDate, TError, TValidationProps extends {}>(props: ValidationProps<TError, TValue, TValidationProps>, validate: Validator<TValue, TDate, TError, TValidationProps>, isSameError: (a: TError, b: TError | null) => boolean, defaultErrorState: TError): TError;
-export {};

package/internals/hooks/useValidation.js

@@ -1,22 +0,0 @@
-import * as React from 'react';
-import { useLocalizationContext } from './useUtils';
-export function useValidation(props, validate, isSameError, defaultErrorState) {
-  const {
-    value,
-    onError
-  } = props;
-  const adapter = useLocalizationContext();
-  const previousValidationErrorRef = React.useRef(defaultErrorState);
-  const validationError = validate({
-    adapter,
-    value,
-    props
-  });
-  React.useEffect(() => {
-    if (onError && !isSameError(validationError, previousValidationErrorRef.current)) {
-      onError(validationError, value);
-    }
-    previousValidationErrorRef.current = validationError;
-  }, [isSameError, onError, previousValidationErrorRef, validationError, value]);
-  return validationError;
-}

package/internals/utils/fields.d.ts

@@ -1,5 +0,0 @@
-import { FieldValueType } from '../../models';
-export declare const splitFieldInternalAndForwardedProps: <TProps extends {}, TInternalPropNames extends keyof TProps>(props: TProps, valueType: FieldValueType) => {
-    forwardedProps: Omit<TProps, TInternalPropNames>;
-    internalProps: Pick<TProps, TInternalPropNames>;
-};

package/internals/utils/fields.js

@@ -1,28 +0,0 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
-import { DATE_TIME_VALIDATION_PROP_NAMES, DATE_VALIDATION_PROP_NAMES, TIME_VALIDATION_PROP_NAMES } from './validation/extractValidationProps';
-const SHARED_FIELD_INTERNAL_PROP_NAMES = ['value', 'defaultValue', 'referenceDate', 'format', 'formatDensity', 'onChange', 'timezone', 'onError', 'shouldRespectLeadingZeros', 'selectedSections', 'onSelectedSectionsChange', 'unstableFieldRef', 'enableAccessibleFieldDOMStructure', 'disabled', 'readOnly', 'dateSeparator'];
-export const splitFieldInternalAndForwardedProps = (props, valueType) => {
-  const forwardedProps = _extends({}, props);
-  const internalProps = {};
-  const extractProp = propName => {
-    if (forwardedProps.hasOwnProperty(propName)) {
-      // @ts-ignore
-      internalProps[propName] = forwardedProps[propName];
-      delete forwardedProps[propName];
-    }
-  };
-  SHARED_FIELD_INTERNAL_PROP_NAMES.forEach(extractProp);
-  if (valueType === 'date') {
-    DATE_VALIDATION_PROP_NAMES.forEach(extractProp);
-  } else if (valueType === 'time') {
-    TIME_VALIDATION_PROP_NAMES.forEach(extractProp);
-  } else if (valueType === 'date-time') {
-    DATE_VALIDATION_PROP_NAMES.forEach(extractProp);
-    TIME_VALIDATION_PROP_NAMES.forEach(extractProp);
-    DATE_TIME_VALIDATION_PROP_NAMES.forEach(extractProp);
-  }
-  return {
-    forwardedProps,
-    internalProps
-  };
-};

package/internals/utils/validation/validateDate.d.ts

@@ -1,7 +0,0 @@
-import { Validator } from '../../hooks/useValidation';
-import { BaseDateValidationProps, DayValidationProps, MonthValidationProps, YearValidationProps } from '../../models/validation';
-import { DateValidationError, PickerValidDate, TimezoneProps } from '../../../models';
-import { DefaultizedProps } from '../../models/helpers';
-export interface DateComponentValidationProps<TDate extends PickerValidDate> extends DayValidationProps<TDate>, MonthValidationProps<TDate>, YearValidationProps<TDate>, Required<BaseDateValidationProps<TDate>>, DefaultizedProps<TimezoneProps, 'timezone'> {
-}
-export declare const validateDate: Validator<any | null, any, DateValidationError, DateComponentValidationProps<any>>;

package/internals/utils/validation/validateDateTime.d.ts

@@ -1,7 +0,0 @@
-import { Validator } from '../../hooks/useValidation';
-import { DateComponentValidationProps } from './validateDate';
-import { TimeComponentValidationProps } from './validateTime';
-import { DateTimeValidationError, PickerValidDate } from '../../../models';
-export interface DateTimeComponentValidationProps<TDate extends PickerValidDate> extends DateComponentValidationProps<TDate>, TimeComponentValidationProps<TDate> {
-}
-export declare const validateDateTime: Validator<any | null, any, DateTimeValidationError, DateTimeComponentValidationProps<any>>;

package/internals/utils/validation/validateDateTime.js

@@ -1,21 +0,0 @@
-import { validateDate } from './validateDate';
-import { validateTime } from './validateTime';
-export const validateDateTime = ({
-  props,
-  value,
-  adapter
-}) => {
-  const dateValidationResult = validateDate({
-    adapter,
-    value,
-    props
-  });
-  if (dateValidationResult !== null) {
-    return dateValidationResult;
-  }
-  return validateTime({
-    adapter,
-    value,
-    props
-  });
-};

package/internals/utils/validation/validateTime.d.ts

@@ -1,7 +0,0 @@
-import { Validator } from '../../hooks/useValidation';
-import { BaseTimeValidationProps, TimeValidationProps } from '../../models/validation';
-import { PickerValidDate, TimeValidationError, TimezoneProps } from '../../../models';
-import { DefaultizedProps } from '../../models/helpers';
-export interface TimeComponentValidationProps<TDate extends PickerValidDate> extends Required<BaseTimeValidationProps>, TimeValidationProps<TDate>, DefaultizedProps<TimezoneProps, 'timezone'> {
-}
-export declare const validateTime: Validator<any | null, any, TimeValidationError, TimeComponentValidationProps<any>>;

package/internals/utils/warning.d.ts

@@ -1,2 +0,0 @@
-export declare function warnOnce(message: string | string[], gravity?: 'warning' | 'error'): void;
-export declare function clearWarningsCache(): void;

package/internals/utils/warning.js

@@ -1,21 +0,0 @@
-const warnedOnceCache = new Set();
-
-// TODO move to @mui/x-internals
-// TODO eventually move to @base_ui/internals. Base UI, etc. too need this helper.
-export function warnOnce(message, gravity = 'warning') {
-  if (process.env.NODE_ENV === 'production') {
-    return;
-  }
-  const cleanMessage = Array.isArray(message) ? message.join('\n') : message;
-  if (!warnedOnceCache.has(cleanMessage)) {
-    warnedOnceCache.add(cleanMessage);
-    if (gravity === 'error') {
-      console.error(cleanMessage);
-    } else {
-      console.warn(cleanMessage);
-    }
-  }
-}
-export function clearWarningsCache() {
-  warnedOnceCache.clear();
-}

package/modern/internals/hooks/useValidation.js

@@ -1,22 +0,0 @@
-import * as React from 'react';
-import { useLocalizationContext } from './useUtils';
-export function useValidation(props, validate, isSameError, defaultErrorState) {
-  const {
-    value,
-    onError
-  } = props;
-  const adapter = useLocalizationContext();
-  const previousValidationErrorRef = React.useRef(defaultErrorState);
-  const validationError = validate({
-    adapter,
-    value,
-    props
-  });
-  React.useEffect(() => {
-    if (onError && !isSameError(validationError, previousValidationErrorRef.current)) {
-      onError(validationError, value);
-    }
-    previousValidationErrorRef.current = validationError;
-  }, [isSameError, onError, previousValidationErrorRef, validationError, value]);
-  return validationError;
-}

package/modern/internals/utils/fields.js

@@ -1,28 +0,0 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
-import { DATE_TIME_VALIDATION_PROP_NAMES, DATE_VALIDATION_PROP_NAMES, TIME_VALIDATION_PROP_NAMES } from './validation/extractValidationProps';
-const SHARED_FIELD_INTERNAL_PROP_NAMES = ['value', 'defaultValue', 'referenceDate', 'format', 'formatDensity', 'onChange', 'timezone', 'onError', 'shouldRespectLeadingZeros', 'selectedSections', 'onSelectedSectionsChange', 'unstableFieldRef', 'enableAccessibleFieldDOMStructure', 'disabled', 'readOnly', 'dateSeparator'];
-export const splitFieldInternalAndForwardedProps = (props, valueType) => {
-  const forwardedProps = _extends({}, props);
-  const internalProps = {};
-  const extractProp = propName => {
-    if (forwardedProps.hasOwnProperty(propName)) {
-      // @ts-ignore
-      internalProps[propName] = forwardedProps[propName];
-      delete forwardedProps[propName];
-    }
-  };
-  SHARED_FIELD_INTERNAL_PROP_NAMES.forEach(extractProp);
-  if (valueType === 'date') {
-    DATE_VALIDATION_PROP_NAMES.forEach(extractProp);
-  } else if (valueType === 'time') {
-    TIME_VALIDATION_PROP_NAMES.forEach(extractProp);
-  } else if (valueType === 'date-time') {
-    DATE_VALIDATION_PROP_NAMES.forEach(extractProp);
-    TIME_VALIDATION_PROP_NAMES.forEach(extractProp);
-    DATE_TIME_VALIDATION_PROP_NAMES.forEach(extractProp);
-  }
-  return {
-    forwardedProps,
-    internalProps
-  };
-};

package/modern/internals/utils/validation/validateDateTime.js

@@ -1,21 +0,0 @@
-import { validateDate } from './validateDate';
-import { validateTime } from './validateTime';
-export const validateDateTime = ({
-  props,
-  value,
-  adapter
-}) => {
-  const dateValidationResult = validateDate({
-    adapter,
-    value,
-    props
-  });
-  if (dateValidationResult !== null) {
-    return dateValidationResult;
-  }
-  return validateTime({
-    adapter,
-    value,
-    props
-  });
-};

package/modern/internals/utils/warning.js

@@ -1,21 +0,0 @@
-const warnedOnceCache = new Set();
-
-// TODO move to @mui/x-internals
-// TODO eventually move to @base_ui/internals. Base UI, etc. too need this helper.
-export function warnOnce(message, gravity = 'warning') {
-  if (process.env.NODE_ENV === 'production') {
-    return;
-  }
-  const cleanMessage = Array.isArray(message) ? message.join('\n') : message;
-  if (!warnedOnceCache.has(cleanMessage)) {
-    warnedOnceCache.add(cleanMessage);
-    if (gravity === 'error') {
-      console.error(cleanMessage);
-    } else {
-      console.warn(cleanMessage);
-    }
-  }
-}
-export function clearWarningsCache() {
-  warnedOnceCache.clear();
-}

package/node/internals/hooks/useValidation.js

@@ -1,30 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useValidation = useValidation;
-var React = _interopRequireWildcard(require("react"));
-var _useUtils = require("./useUtils");
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-function useValidation(props, validate, isSameError, defaultErrorState) {
-  const {
-    value,
-    onError
-  } = props;
-  const adapter = (0, _useUtils.useLocalizationContext)();
-  const previousValidationErrorRef = React.useRef(defaultErrorState);
-  const validationError = validate({
-    adapter,
-    value,
-    props
-  });
-  React.useEffect(() => {
-    if (onError && !isSameError(validationError, previousValidationErrorRef.current)) {
-      onError(validationError, value);
-    }
-    previousValidationErrorRef.current = validationError;
-  }, [isSameError, onError, previousValidationErrorRef, validationError, value]);
-  return validationError;
-}

package/node/internals/utils/fields.js

@@ -1,36 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.splitFieldInternalAndForwardedProps = void 0;
-var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-var _extractValidationProps = require("./validation/extractValidationProps");
-const SHARED_FIELD_INTERNAL_PROP_NAMES = ['value', 'defaultValue', 'referenceDate', 'format', 'formatDensity', 'onChange', 'timezone', 'onError', 'shouldRespectLeadingZeros', 'selectedSections', 'onSelectedSectionsChange', 'unstableFieldRef', 'enableAccessibleFieldDOMStructure', 'disabled', 'readOnly', 'dateSeparator'];
-const splitFieldInternalAndForwardedProps = (props, valueType) => {
-  const forwardedProps = (0, _extends2.default)({}, props);
-  const internalProps = {};
-  const extractProp = propName => {
-    if (forwardedProps.hasOwnProperty(propName)) {
-      // @ts-ignore
-      internalProps[propName] = forwardedProps[propName];
-      delete forwardedProps[propName];
-    }
-  };
-  SHARED_FIELD_INTERNAL_PROP_NAMES.forEach(extractProp);
-  if (valueType === 'date') {
-    _extractValidationProps.DATE_VALIDATION_PROP_NAMES.forEach(extractProp);
-  } else if (valueType === 'time') {
-    _extractValidationProps.TIME_VALIDATION_PROP_NAMES.forEach(extractProp);
-  } else if (valueType === 'date-time') {
-    _extractValidationProps.DATE_VALIDATION_PROP_NAMES.forEach(extractProp);
-    _extractValidationProps.TIME_VALIDATION_PROP_NAMES.forEach(extractProp);
-    _extractValidationProps.DATE_TIME_VALIDATION_PROP_NAMES.forEach(extractProp);
-  }
-  return {
-    forwardedProps,
-    internalProps
-  };
-};
-exports.splitFieldInternalAndForwardedProps = splitFieldInternalAndForwardedProps;

package/node/internals/utils/warning.js

@@ -1,28 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.clearWarningsCache = clearWarningsCache;
-exports.warnOnce = warnOnce;
-const warnedOnceCache = new Set();
-
-// TODO move to @mui/x-internals
-// TODO eventually move to @base_ui/internals. Base UI, etc. too need this helper.
-function warnOnce(message, gravity = 'warning') {
-  if (process.env.NODE_ENV === 'production') {
-    return;
-  }
-  const cleanMessage = Array.isArray(message) ? message.join('\n') : message;
-  if (!warnedOnceCache.has(cleanMessage)) {
-    warnedOnceCache.add(cleanMessage);
-    if (gravity === 'error') {
-      console.error(cleanMessage);
-    } else {
-      console.warn(cleanMessage);
-    }
-  }
-}
-function clearWarningsCache() {
-  warnedOnceCache.clear();
-}