@servicetitan/anvil2 3.14.0 → 3.15.0

package/dist/src/components/Chip/internal/Chip.d.ts

@@ -1,115 +1,44 @@
 import { ComponentPropsWithoutRef, KeyboardEvent, MouseEvent, ReactNode } from 'react';
 import { AvatarProps } from '../../Avatar/internal/Avatar';
 import { LayoutUtilProps, Size } from '../../../types';
-/**
- * Props for the Chip component
- * @extends ComponentPropsWithoutRef<"span">
- * @extends Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink">
- */
 export type ChipBaseProps = Omit<ComponentPropsWithoutRef<"span">, "prefix"> & Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink"> & {
-    /**
-     * The text that displays in the chip.
-     */
+    /** Visible text. Also used as the avatar's accessible name. */
     label: string;
-    /**
-     * Color of the Chip
-     */
+    /** Optional surface color; contrast-safe foreground and border are derived. */
     color?: string;
-    /**
-     * Wraps text when it overflows
-     */
+    /** Allows the label to wrap. Defaults to a single truncated line. */
     textWrap?: boolean;
-    /**
-     * Content displayed in the chip, before the text.
-     */
+    /** Content before the label. Public Chip maps this from `icon`. */
     prefix?: ReactNode;
-    /**
-     * Image URL to display in an avatar before the chip text.
-     */
+    /** Image URL for an avatar before the label. */
     avatar?: AvatarProps["image"];
-    /**
-     * Content displayed in the chip, after the text.
-     */
+    /** Content after the label. Public Chip supplies this slot. */
     suffix?: ReactNode;
 };
 type ChipClickHandler = (e?: MouseEvent<HTMLSpanElement> | KeyboardEvent<HTMLSpanElement>) => void;
 type ChipCloseHandler = (e: MouseEvent<HTMLSpanElement> | KeyboardEvent<HTMLSpanElement>) => void;
 type SmallChipHandlers = {
-    /**
-     * Callback for when the Chip is clicked
-     *
-     * @remarks
-     * Adding this will make Chip focusable
-     */
+    /** Makes the chip a focusable button. Cannot be combined with `onClose` at `size="small"`. */
     onClick?: ChipClickHandler;
-    /**
-     * Called when the component is closed. If supplied, a close button will be rendered.
-     * @returns void
-     */
     onClose?: never;
 } | {
-    /**
-     * Called when the component is closed. If supplied, a close button will be rendered.
-     * @returns void
-     */
+    /** Renders a close control and announces removal. Cannot be combined with `onClick` at `size="small"`. */
     onClose?: ChipCloseHandler;
-    /**
-     * Callback for when the Chip is clicked
-     *
-     * @remarks
-     * Adding this will make Chip focusable
-     */
     onClick?: never;
 };
 type SmallChipProps = ChipBaseProps & {
-    /**
-     * The size of the chip
-     * @default medium
-     */
+    /** Compact scale. */
     size: Extract<Size, "small">;
 } & SmallChipHandlers;
 type MediumChipProps = ChipBaseProps & {
-    /**
-     * The size of the chip
-     * @default medium
-     */
+    /** Default scale. Defaults to `medium`. */
     size?: Extract<Size, "medium">;
-    /**
-     * Callback for when the Chip is clicked
-     *
-     * @remarks
-     * Adding this will make Chip focusable
-     */
+    /** Makes the chip a focusable button. */
     onClick?: ChipClickHandler;
-    /**
-     * Called when the component is closed. If supplied, a close button will be rendered.
-     * @returns void
-     */
+    /** Renders a close control. Delete/Backspace also call this. */
     onClose?: ChipCloseHandler;
 };
 export type ChipProps = SmallChipProps | MediumChipProps;
-/**
- * Chip component for displaying compact information or tags.
- *
- * Features:
- * - Configurable sizes (small, medium)
- * - Custom color support with automatic contrast calculation
- * - Optional click handler for interactive chips
- * - Optional close button for removable chips
- * - Text wrapping support for long labels
- * - Full accessibility support with ARIA attributes
- * - Keyboard navigation (Enter/Space to click, Delete/Backspace to close)
- * - Screen reader instructions for removal actions
- * - Theme-aware color adaptation
- * - Layout utility props for positioning and spacing
- *
- * @example
- * <Chip
- *   label="JavaScript"
- *   color="#f7df1e"
- *   onClose={(e) => console.log('Chip removed')}
- *   onClick={(e) => console.log('Chip clicked')}
- * />
- */
+/** Renders the chip surface, avatar/prefix/suffix slots, and close control. */
 export declare const Chip: import('react').ForwardRefExoticComponent<ChipProps & import('react').RefAttributes<HTMLSpanElement>>;
 export {};

package/dist/src/components/DateFieldRange/DateFieldRange.d.ts

@@ -3,85 +3,68 @@ import { MaskedDateRangeInputProps } from './internal/MaskedDateRangeInput';
 import { DateMode } from '../DateFieldSingle/types';
 export type DateFieldRangeChange = {
     /**
-     * The start date in ISO 8601 format.
-     * @example "2025-03-22"
+     * Last committed start as an ISO calendar date, or `null` when that end is
+     * empty or has never completed a date.
      */
     startDate: string | null;
-    /**
-     * The end date in ISO 8601 format.
-     * @example "2025-07-02"
-     */
+    /** Last committed end as an ISO calendar date, or `null` when that half is empty. */
     endDate: string | null;
-    /**
-     * Whether the input field contains two parsable dates.
-     * This is not the same as the date range being valid.
-     *
-     */
+    /** Whether both ends form complete dates; independent of date constraints. */
     isInputValid: boolean;
-    /**
-     * Whether the input field is empty.
-     */
+    /** Whether no date digits remain after removing the mask placeholder. */
     isInputEmpty: boolean;
     /**
-     * Whether the start and end dates are valid according to the constraints.
-     * Constraints include:
-     * - Required
-     * - Unavailable dates
-     * - Unavailable days of the week
-     * - Min date
-     * - Max date
+     * Whether both ends satisfy required, availability, and min/max constraints
+     * and start is not after end. Independent of input completeness. An empty
+     * range is valid unless `required`.
      */
     isDateRangeValid: boolean;
 };
+/** Receives the current range and both layers of validity. */
 export type DateFieldRangeChangeHandler = (change: DateFieldRangeChange) => void;
+/** Start and end ISO calendar dates, or `null` to clear both ends. */
 export type DateFieldRangeValue = {
     startDate: string | null;
     endDate: string | null;
 } | null;
 export type DateFieldRangeProps = Omit<MaskedDateRangeInputProps, "onChange" | "value" | "autoComplete" | "onClick" | "onKeyDown" | "ref" | "required" | "startDate" | "endDate" | "defaultValue" | "onFocus" | "onBlur"> & {
+    /** Controlled ISO 8601 date range. Pass `null` to clear both ends. */
     value?: DateFieldRangeValue;
+    /** Initial ISO 8601 date range for uncontrolled use. */
     defaultValue?: DateFieldRangeValue;
+    /** Reports the range plus separate input-format and constraint validity. */
     onChange?: DateFieldRangeChangeHandler;
+    /** Order of the date segments. Defaults to `mm/dd/yyyy`. */
     mode?: Extract<DateMode, "mm/dd/yyyy" | "dd/mm/yyyy">;
+    /** Hides the expected-format hint below the input. */
     disableHint?: boolean;
+    /** Renders only the masked input without its popover calendar. */
     disableCalendar?: boolean;
+    /** Dates and recurring weekdays excluded from selection and validation. */
     unavailable?: {
+        /** ISO 8601 dates excluded from selection. */
         dates?: string[];
+        /** Luxon weekday numbers excluded every week; Monday is 1 and Sunday is 7. */
         daysOfWeek?: (1 | 2 | 3 | 4 | 5 | 6 | 7)[];
     };
+    /** Earliest valid ISO 8601 date for either end. */
     minDate?: string;
+    /** Latest valid ISO 8601 date for either end. */
     maxDate?: string;
+    /** Makes an empty range fail constraint validation. */
     required?: boolean;
     onFocus?: (event: React.FocusEvent) => void;
     onBlur?: (event: React.FocusEvent) => void;
     /**
-     * The IANA timezone to use for the calendar. Controls the meaning of the "Today"
-     * button and which month/year is initially displayed. When the timezone differs
-     * from the user's locale timezone, a disambiguation message is shown below the calendar.
-     * @example "America/Los_Angeles"
+     * IANA zone for the calendar's Today action and, when the field has no value,
+     * its initially visible month. A message identifies a zone that differs from
+     * the browser's.
      */
     timezone?: IanaZone;
 } & DataTrackingId & DataAttributes;
 /**
- * DateFieldRange component for entering a start and end date via a masked
- * text input, with an optional popover calendar for picking the range
- * visually.
- *
- * Features:
- * - Masked start/end date input with configurable mm/dd/yyyy or dd/mm/yyyy mode
- * - Optional popover range calendar
- * - Min/max date and unavailable-date/day-of-week constraints applied to both ends
- * - Reports input validity and range validity separately via `onChange`
- * - Full keyboard support (arrow-down opens the calendar from the input)
- *
- * @example
- * <DateFieldRange
- *   label="Trip dates"
- *   value={{ startDate: "2025-07-02", endDate: "2025-07-10" }}
- *   onChange={({ startDate, endDate, isDateRangeValid }) =>
- *     console.log(startDate, endDate, isDateRangeValid)
- *   }
- * />
+ * Masked start/end date field with an optional popover calendar. Reports input
+ * completeness separately from range-constraint validity.
  */
 export declare const DateFieldRange: {
     (props: DateFieldRangeProps): import("react/jsx-runtime").JSX.Element;

package/dist/src/components/DateFieldRange/internal/DateFieldRangeCalendar.d.ts

@@ -1,9 +1,12 @@
 import { DateTime, WeekdayNumbers } from 'luxon';
 import { IanaZone } from '../../../types';
 export type DateFieldRangeCalendarProps = {
+    /** Current start, or `null` while unset. */
     startDate: DateTime | null;
+    /** Current end, or `null` while the range is incomplete. */
     endDate: DateTime | null;
     onKeyDown?: (event: React.KeyboardEvent<HTMLDivElement>) => void;
+    /** Called after either endpoint changes; `endDate` is `null` while incomplete. */
     onSelection: ({ startDate, endDate, }: {
         startDate: DateTime | null;
         endDate: DateTime | null;
@@ -16,4 +19,8 @@ export type DateFieldRangeCalendarProps = {
     };
     timezone?: IanaZone;
 };
+/**
+ * Adapts the field's UTC range to Calendar's zoned ISO contract. Remounts on
+ * value change and parks focus so host popovers do not close on end-pick.
+ */
 export declare const DateFieldRangeCalendar: ({ startDate, endDate, onKeyDown, onSelection, minDate, maxDate, unavailable, timezone: timezoneProp, }: DateFieldRangeCalendarProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/DateFieldRange/internal/MaskedDateRangeInput.d.ts

@@ -2,40 +2,47 @@ import { TextFieldProps } from '../../TextField/internal/TextField';
 import { DateTime } from 'luxon';
 import { DateMode } from '../../DateFieldSingle/types';
 export type MaskedDateRangeInputChange = {
+    /** Parsed start, or the last committed start while that half does not parse. */
     startDate: DateTime | null;
+    /** Parsed end, or the last committed end while that half does not parse. */
     endDate: DateTime | null;
+    /** Whether both ends form complete dates. */
     isInputValid: boolean;
+    /** Whether no date digits remain after removing the placeholder. */
     isInputEmpty: boolean;
 };
+/** Receives substantive changes to the parsed range or input state. */
 export type MaskedDateRangeInputChangeHandler = (change: MaskedDateRangeInputChange) => void;
 export type MaskedDateRangeInputProps = Omit<TextFieldProps, "onChange" | "value" | "ref" | "showCounter" | "hint" | "prefix"> & {
+    /** Called when either parsed end, completeness, or emptiness changes. */
     onChange: MaskedDateRangeInputChangeHandler;
+    /** Order of the date segments. Defaults to `mm/dd/yyyy`. */
     mode?: DateMode;
+    /** Start displayed after an external update and retained during partial edits. */
     startDate: DateTime | null;
+    /** End displayed after an external update and retained during partial edits. */
     endDate: DateTime | null;
+    /** Hides the expected-format hint. Defaults to `false`. */
     disableHint?: boolean;
 };
 export type MaskedDateRangeInputRef = HTMLInputElement & {
+    /** Updates the displayed range without firing `onChange`. */
     setDateRange: (startDate: DateTime | null, endDate: DateTime | null) => void;
 };
 /**
- * A masked date input component that allows for the input of a date in a specific format.
+ * Masked start/end date input shared by range fields.
  *
- * Provides a `setDates` method that can be used to set the date from outside the component (e.g from a calendar).
- *
- * @internal This component is not intended to be used directly in consumer code.
- *
- * @param props - The props for the MaskedDateRangeInput component.
- * @param props.onChange - The function to call when the date changes.
- * @param props.mode - The mode of the date input.
- * @param props.startDate - The start date.
- * @param props.endDate - The end date.
- * @param props.disableHint - Whether to disable the hint.
+ * @internal
  */
 export declare const MaskedDateRangeInput: import('react').ForwardRefExoticComponent<Omit<TextFieldProps, "ref" | "prefix" | "onChange" | "hint" | "showCounter" | "value"> & {
+    /** Called when either parsed end, completeness, or emptiness changes. */
     onChange: MaskedDateRangeInputChangeHandler;
+    /** Order of the date segments. Defaults to `mm/dd/yyyy`. */
     mode?: DateMode;
+    /** Start displayed after an external update and retained during partial edits. */
     startDate: DateTime | null;
+    /** End displayed after an external update and retained during partial edits. */
     endDate: DateTime | null;
+    /** Hides the expected-format hint. Defaults to `false`. */
     disableHint?: boolean;
 } & import('react').RefAttributes<MaskedDateRangeInputRef>>;

package/dist/src/components/DateFieldRange/internal/maskito/dateRangePlaceholderMask.d.ts

@@ -1,5 +1,7 @@
 import { MaskitoDateMode } from '@maskito/kit';
+/** Date-segment orders supported by the range mask. */
 export type DateMode = Extract<MaskitoDateMode, "dd/mm/yyyy" | "mm/dd/yyyy" | "yyyy/mm/dd">;
+/** Builds Maskito range options with a persistent placeholder and zero shortcut. */
 declare const datePlaceholderMask: ({ mode, dateSeparator, rangeSeparator, placeholder, }: {
     mode: DateMode;
     dateSeparator?: string;

package/dist/src/components/DateFieldRange/internal/useDateFieldRangeConversion.d.ts

@@ -1,12 +1,6 @@
 import { DateFieldRangeChange, DateFieldRangeProps } from '../DateFieldRange';
 import { DateTime } from 'luxon';
-/**
- * This hook is used to convert the string props of a DateFieldRange component to a DateTime format.
- *
- * @param props - The props of the DateFieldRange component.
- * @returns The normalized value, defaultValue, minDate, maxDate, and unavailable dates in DateTime format.
- * @internal This hook is not intended to be used directly in consumer code.
- */
+/** Normalizes DateFieldRange's ISO props and callback to UTC Luxon values. */
 export declare const useDateFieldRangeConversion: (props: DateFieldRangeProps) => {
     value: {
         startDate: DateTime<boolean> | null;

package/dist/src/components/DateFieldRange/internal/useDateFieldRangeState.d.ts

@@ -1,65 +1,43 @@
 import { DateTime } from 'luxon';
 import { MaskedDateRangeInputChange } from './MaskedDateRangeInput';
 export type DateFieldRangeStateChange = {
+    /** Last committed start, or `null` when that end is empty. */
     startDate: DateTime | null;
+    /** Last committed end, or `null` when that end is empty. */
     endDate: DateTime | null;
+    /** Whether both ends form complete dates. */
     isInputValid: boolean;
+    /** Whether the input contains no date digits. */
     isInputEmpty: boolean;
 };
+/** Receives synchronized input or calendar changes. */
 export type DateFieldRangeStateChangeHandler = (change: DateFieldRangeStateChange) => void;
 export type DateFieldRangeStateParam = {
-    /**
-     * The controlled value of the start date.
-     */
+    /** Controlled range selection. */
     valueProp?: {
         startDate: DateTime | null;
         endDate: DateTime | null;
     } | null;
-    /**
-     * The default value of the start date.
-     */
+    /** Initial uncontrolled range selection. */
     defaultValueProp?: {
         startDate: DateTime | null;
         endDate: DateTime | null;
     } | null;
-    /**
-     * The function to call when the state changes.
-     */
+    /** Called for changes from either the input or calendar. */
     onChange: DateFieldRangeStateChangeHandler;
 };
-/**
- * This hook is used to keep the state of a DateFieldRange component in sync with the input and calendar.
- */
 export type DateFieldRangeState = {
-    /**
-     * The start date.
-     */
     startDate: DateTime | null;
-    /**
-     * The end date.
-     */
     endDate: DateTime | null;
-    /**
-     * The function to set the start date.
-     */
     setStartDate: (date: DateTime | null) => void;
-    /**
-     * The function to set the end date.
-     */
     setEndDate: (date: DateTime | null) => void;
-    /**
-     * The function to handle the input change.
-     */
+    /** Applies parsed input ends, including a partial range, or clears when empty. */
     handleInputChange: (change: MaskedDateRangeInputChange) => void;
-    /**
-     * The function to handle the calendar selection.
-     */
+    /** Applies a calendar selection, including an incomplete range with no end. */
     handleCalendarSelection: ({ startDate, endDate, }: {
         startDate: DateTime | null;
         endDate: DateTime | null;
     }) => void;
 };
-/**
- * This is a hook for keeping state in sync between a date input and calendar.
- */
+/** Synchronizes controlled or uncontrolled start and end between the input and calendar. */
 export declare function useDateFieldRangeState({ valueProp, defaultValueProp, onChange, }: DateFieldRangeStateParam): DateFieldRangeState;

package/dist/src/components/DateFieldRange/internal/utils.d.ts

@@ -7,6 +7,10 @@ type DateConstraints = {
     minDate?: DateTime;
     maxDate?: DateTime;
 };
+/**
+ * Empty ranges pass unless `required`. Otherwise both ends must exist, satisfy
+ * availability and min/max, and start must not be after end.
+ */
 export declare function validateDateRange({ required, startDate, endDate, startDateConstraints, endDateConstraints, }: {
     required?: boolean;
     startDate: DateTime | null;

package/dist/src/components/DateFieldRange/parts.d.ts

@@ -1,13 +1,8 @@
 /**
  * `data-anv-part` names for DateFieldRange's interactive sub-elements.
  *
- * Consumer `data-*` (e.g. `data-cy`) is forwarded to the masked text input —
- * the one element present in every mode (including `disableCalendar`). The
- * calendar and its popover render in the top layer, outside the input's
- * subtree, so target them by part attribute directly or by the popover's
- * `data-testid="calendar-popover"`.
- *
- * Every role is a shared one, so values come from `COMMON_PART`.
+ * The calendar and popover render in the top layer outside the input subtree,
+ * so consumers must target their part attributes directly.
  */
 export declare const PARTS: {
     readonly input: "date-input";

package/dist/src/components/DateFieldSingle/DateFieldSingle.d.ts

@@ -2,83 +2,61 @@ import { DataAttributes, DataTrackingId, IanaZone } from '../../types';
 import { MaskedDateInputProps } from './internal/MaskedDateInput';
 import { DateMode } from './types';
 export type DateFieldSingleProps = Omit<MaskedDateInputProps, "onChange" | "value" | "autoComplete" | "onClick" | "onKeyDown" | "ref" | "lastValidDate" | "setLastValidDate" | "required" | "onFocus" | "onBlur"> & {
+    /** Controlled ISO 8601 date. Pass `null` to clear the field. */
     value?: string | null;
+    /** Initial ISO 8601 date for uncontrolled use. */
     defaultValue?: string | null;
+    /** Reports the date plus separate input-format and constraint validity. */
     onChange?: DateFieldSingleChangeHandler;
     onFocus?: (event: React.FocusEvent) => void;
     onBlur?: (event: React.FocusEvent) => void;
+    /** Order of the date segments. Defaults to `mm/dd/yyyy`. */
     mode?: Extract<DateMode, "mm/dd/yyyy" | "dd/mm/yyyy">;
+    /** Hides the expected-format hint below the input. */
     disableHint?: boolean;
+    /** Renders only the masked input without its popover calendar. */
     disableCalendar?: boolean;
+    /** Dates and recurring weekdays excluded from selection and validation. */
     unavailable?: {
-        /**
-         * The specific dates that are unavailable. ISO 8601 format.
-         * @example ["2025-07-02"]
-         */
+        /** ISO 8601 dates excluded from selection. */
         dates?: string[];
-        /**
-         * The days of the week that are unavailable.
-         * (1-7, where 1 is Monday and 7 is Sunday)
-         */
+        /** Luxon weekday numbers excluded every week; Monday is 1 and Sunday is 7. */
         daysOfWeek?: (1 | 2 | 3 | 4 | 5 | 6 | 7)[];
     };
+    /** Earliest valid ISO 8601 date. */
     minDate?: string;
+    /** Latest valid ISO 8601 date. */
     maxDate?: string;
+    /** Makes an empty date fail constraint validation. */
     required?: boolean;
     /**
-     * The IANA timezone to use for the calendar. Controls the meaning of the "Today"
-     * button and which month/year is initially displayed. When the timezone differs
-     * from the user's locale timezone, a disambiguation message is shown below the calendar.
-     * @example "America/Los_Angeles"
+     * IANA zone for the calendar's Today action and, when the field has no value,
+     * its initially visible month. A message identifies a zone that differs from
+     * the browser's.
      */
     timezone?: IanaZone;
 } & DataTrackingId & DataAttributes;
 export type DateFieldSingleChange = {
     /**
-     * The date in ISO 8601 format.
-     * @example "2025-07-02"
+     * Last valid date as an ISO calendar date, or `null` when the field is empty
+     * or has never completed a date.
      */
     date: string | null;
-    /**
-     * Whether the input is valid. That is, it matches the format and is not empty.
-     * This does not mean that the date is valid according to the constraints.
-     */
+    /** Whether the text forms a complete date; independent of date constraints. */
     isInputValid: boolean;
-    /**
-     * Whether the input is empty.
-     */
+    /** Whether no date digits remain after removing the mask placeholder. */
     isInputEmpty: boolean;
     /**
-     * Whether the date is valid according to the constraints.
-     * Constraints include:
-     * - Required
-     * - Unavailable dates
-     * - Unavailable days of the week
-     * - Min date
-     * - Max date
+     * Whether the reported date satisfies required, availability, and min/max
+     * constraints; independent of input completeness.
      */
     isDateValid: boolean;
 };
+/** Receives the current date and both layers of validity. */
 export type DateFieldSingleChangeHandler = (change: DateFieldSingleChange) => void;
 /**
- * DateFieldSingle component for entering a single date via a masked text
- * input, with an optional popover calendar for picking the date visually.
- *
- * Features:
- * - Masked date input with configurable mm/dd/yyyy or dd/mm/yyyy mode
- * - Optional popover calendar (disable with `disableCalendar`)
- * - Min/max date and unavailable-date/day-of-week constraints
- * - Timezone-aware "Today" navigation via `timezone`
- * - Reports input validity and constraint validity separately via `onChange`
- * - Full keyboard support (arrow-down opens the calendar from the input)
- *
- * @example
- * <DateFieldSingle
- *   label="Appointment date"
- *   value="2025-07-02"
- *   onChange={({ date, isDateValid }) => console.log(date, isDateValid)}
- *   minDate="2025-01-01"
- * />
+ * Masked single-date field with an optional popover calendar. Reports input
+ * completeness separately from date-constraint validity.
  */
 export declare const DateFieldSingle: {
     (props: DateFieldSingleProps): import("react/jsx-runtime").JSX.Element;

package/dist/src/components/DateFieldSingle/internal/DateFieldSingleCalendar.d.ts

@@ -13,5 +13,9 @@ type DateFieldSingleCalendarProps = Omit<CalendarProps, "onSelection" | "value"
     };
     timezone?: IanaZone;
 };
+/**
+ * Adapts the field's UTC values to Calendar's zoned ISO contract and identifies
+ * non-local calendar zones.
+ */
 export declare function DateFieldSingleCalendar({ onKeyDown, value, onSelection, minDate, maxDate, unavailable, timezone: timezoneProp, ...rest }: DateFieldSingleCalendarProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/src/components/DateFieldSingle/internal/MaskedDateInput.d.ts

@@ -2,34 +2,41 @@ import { TextFieldProps } from '../../TextField/internal/TextField';
 import { DateTime } from 'luxon';
 import { DateMode } from '../types';
 export type MaskedDateInputChange = {
+    /** Parsed date, or the last valid date while the current text does not parse. */
     date: DateTime | null;
+    /** Whether the text forms a complete date. */
     isInputValid: boolean;
+    /** Whether no date digits remain after removing the placeholder. */
     isInputEmpty: boolean;
 };
+/** Receives substantive changes to the parsed date or input state. */
 export type MaskedDateInputChangeHandler = (change: MaskedDateInputChange) => void;
 export type MaskedDateInputProps = Omit<TextFieldProps, "onChange" | "value" | "ref" | "showCounter" | "hint" | "prefix"> & {
+    /** Called when the parsed date, completeness, or emptiness changes. */
     onChange: MaskedDateInputChangeHandler;
+    /** Order of the date segments. Defaults to `mm/dd/yyyy`. */
     mode?: DateMode;
+    /** Date displayed after an external update and retained during partial edits. */
     lastValidDate: DateTime | null;
+    /** Hides the expected-format hint. Defaults to `false`. */
     disableHint?: boolean;
 };
 export type MaskedDateInputRef = HTMLInputElement & {
+    /** Updates the displayed date without firing `onChange`. */
     setDate: (date: DateTime | null) => void;
 };
 /**
- * A masked date input component that allows for the input of a date in a specific format.
+ * Masked date input shared by date fields.
  *
- * Provides a `setDate` method that can be used to set the date from outside the component (e.g from a calendar).
- *
- * @internal This component is not intended to be used directly in consumer code.
- *
- * @param props - The props for the MaskedDateInput component.
- * @param props.onChange - The function to call when the date changes.
- * @param props.mode - The mode of the date input.
+ * @internal
  */
 export declare const MaskedDateInput: import('react').ForwardRefExoticComponent<Omit<TextFieldProps, "ref" | "prefix" | "onChange" | "hint" | "showCounter" | "value"> & {
+    /** Called when the parsed date, completeness, or emptiness changes. */
     onChange: MaskedDateInputChangeHandler;
+    /** Order of the date segments. Defaults to `mm/dd/yyyy`. */
     mode?: DateMode;
+    /** Date displayed after an external update and retained during partial edits. */
     lastValidDate: DateTime | null;
+    /** Hides the expected-format hint. Defaults to `false`. */
     disableHint?: boolean;
 } & import('react').RefAttributes<MaskedDateInputRef>>;

package/dist/src/components/DateFieldSingle/internal/TimezoneMessage.d.ts

@@ -1,6 +1,8 @@
 import { IanaZone } from '../../../types';
 type TimezoneMessageProps = {
+    /** Calendar zone to identify when it differs from the browser's zone. */
     timezone?: IanaZone;
 };
+/** Identifies the calendar's non-local time zone by its current abbreviation. */
 export declare function TimezoneMessage({ timezone }: TimezoneMessageProps): import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/src/components/DateFieldSingle/internal/maskito/datePlaceholderMask.d.ts

@@ -1,4 +1,5 @@
 import { DateMode } from '../../types';
+/** Builds Maskito date options with a persistent placeholder and zero shortcut. */
 declare const datePlaceholderMask: ({ mode, separator, placeholder, }: {
     mode: DateMode;
     separator?: string;