@servicetitan/anvil2 3.14.0 → 3.15.0

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

@@ -1,10 +1,8 @@
 import { MaskitoPreprocessor } from '@maskito/core';
 /**
- * This is a custom-written preprocessor to handle the zero shortcut on slash.
- * e.g: 1/ -> 01/ and 01/1/ -> 01/01/
+ * Pads a one-digit date segment when the user types its separator, such as
+ * `1/` to `01/`.
  *
- * @param templateString - A string representing the mask. e.g. "dd/mm/yyyy" or "__/__/____"
- * @param separator - The separator to use for segments of the date. Must match the separator in the template string.
- * @returns A MaskitoPreprocessor function.
+ * @param separator Must match the separator in `templateString`.
  */
 export declare const makeZeroShortcutPreprocessor: (templateString: string, separator: string) => MaskitoPreprocessor;

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

@@ -1,45 +1,19 @@
 import { DateFieldSingleChange, DateFieldSingleProps } from '../DateFieldSingle';
 import { DateTime, WeekdayNumbers } from 'luxon';
+/** UTC-normalized values used by DateFieldSingle internals. */
 export type DateFieldSingleConversion = {
-    /**
-     * The current value of the date field.
-     */
     value?: DateTime | null;
-    /**
-     * The default (uncontrolled) value of the date field.
-     */
     defaultValue?: DateTime | null;
-    /**
-     * The minimum date of the date field.
-     */
     minDate?: DateTime | null;
-    /**
-     * The maximum date of the date field.
-     */
     maxDate?: DateTime | null;
-    /**
-     * The unavailable dates of the date field.
-     */
     unavailable: {
-        /**
-         * The unavailable dates of the date field.
-         */
         dates?: DateTime[];
-        /**
-         * The unavailable days of the week of the date field.
-         */
         daysOfWeek?: WeekdayNumbers[];
     };
-    /**
-     * The callback for when the date changes.
-     */
+    /** Converts the internal UTC date back to an ISO calendar date. */
     onChange: (change: Omit<DateFieldSingleChange, "date"> & {
         date: DateTime | null;
     }) => void;
 };
-/**
- * Converts the props of the DateFieldSingle component to Luxon DateTime objects for easier internal use.
- * @param props - The props of the DateFieldSingle component using ISO 8601 strings.
- * @returns The converted props using Luxon DateTime objects.
- */
+/** Normalizes DateFieldSingle's ISO props and callback to UTC Luxon values. */
 export declare function useDateFieldSingleConversion({ value, defaultValue, minDate, maxDate, unavailable, onChange, }: DateFieldSingleProps): DateFieldSingleConversion;

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

@@ -1,44 +1,35 @@
 import { DateTime } from 'luxon';
 import { MaskedDateInputChange } from './MaskedDateInput';
 export type DateFieldSingleStateChange = {
+    /** Last valid date, or `null` when cleared. */
     date: DateTime | null;
+    /** Whether the input text forms a complete date. */
     isInputValid: boolean;
+    /** Whether the input contains no date digits. */
     isInputEmpty: boolean;
 };
+/** Receives synchronized input or calendar changes. */
 export type DateFieldSingleStateChangeHandler = (change: DateFieldSingleStateChange) => void;
 export type DateFieldSingleStateParam = {
-    /**
-     * The controlled value of the date field.
-     */
+    /** Controlled date selection. */
     valueProp?: DateTime | null;
-    /**
-     * The default (uncontrolled) value of the date field.
-     */
+    /** Initial uncontrolled date selection. */
     defaultValueProp?: DateTime | null;
-    /**
-     * Callback for when the date changes.
-     */
+    /** Called for changes from either the input or calendar. */
     onChange: DateFieldSingleStateChangeHandler;
 };
 export type DateFieldSingleState = {
-    /**
-     * The current value (DateTime) of the date field.
-     */
+    /** Current valid selection shared by the input and calendar. */
     value: DateTime | null;
-    /**
-     * Sets the value of the date field.
-     */
+    /** Updates the shared selection. */
     setValue: (value: DateTime | null) => void;
     /**
-     * Handles the change of the input field.
+     * Reports partial edits while retaining the last valid selection, and clears
+     * the selection when the input becomes empty.
      */
     handleInputChange: (change: MaskedDateInputChange) => void;
-    /**
-     * Handles the selection of a date in the calendar.
-     */
+    /** Applies a complete calendar selection to the input state. */
     handleCalendarSelection: (date: DateTime) => void;
 };
-/**
- * This is a hook for keeping state in sync between a date input and calendar.
- */
+/** Synchronizes controlled or uncontrolled state between the input and calendar. */
 export declare function useDateFieldSingleState({ valueProp, defaultValueProp, onChange, }: DateFieldSingleStateParam): DateFieldSingleState;

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

@@ -1,27 +1,17 @@
 import { DateTime } from 'luxon';
 /**
- * Converts a JS Date (created with local timezone midnight) to a UTC Luxon DateTime
- * preserving the local date components (year, month, day).
- *
- * This is necessary because maskitoParseDate creates Date objects using
- * `new Date(year, month, day)` which produces midnight in the local timezone.
- * Directly using DateTime.fromJSDate with zone: "utc" can shift the *calendar day*
- * for timezones where local midnight falls on a different UTC date (typically
- * positive-offset zones), which would change the intended date.
+ * Converts Maskito's local-midnight `Date` to UTC while preserving its calendar
+ * fields. A direct zone conversion can shift the intended day.
  */
 export declare function jsDateToUtcDateTime(jsDate: Date): DateTime;
 /**
- * Converts an ISO 8601 string (potentially with a timezone offset, e.g.
- * "2024-01-12T00:00:00.000+04:00") to a UTC Luxon DateTime preserving the
- * local date components (year, month, day).
- *
- * This is necessary because the Calendar component emits ISO strings with the
- * configured timezone offset. Parsing with zone: "utc" would shift the
- * calendar day for positive-offset zones, while parsing with the original
- * timezone produces a non-UTC DateTime that mismatches internal validation.
+ * Converts Calendar's zoned ISO value to UTC while preserving its calendar
+ * fields, avoiding day shifts across positive offsets.
  */
 export declare function isoToUtcDate(isoString: string): DateTime;
+/** Parses an ISO value at start of day, preserving absent values and rejecting invalid ones. */
 export declare function convertStringToDate(v: string | null | undefined): DateTime | null | undefined;
+/** Checks a date against required, availability, and min/max constraints. */
 export declare function validateDate({ date, constraints, }: {
     date: DateTime | null;
     constraints: {

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

@@ -1,13 +1,8 @@
 /**
  * `data-anv-part` names for DateFieldSingle'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/types.d.ts

@@ -1,2 +1,3 @@
 import { MaskitoDateMode } from '@maskito/kit';
+/** Date-segment orders supported by the shared full-date masks. */
 export type DateMode = Extract<MaskitoDateMode, "dd/mm/yyyy" | "mm/dd/yyyy" | "yyyy/mm/dd">;

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

@@ -4,148 +4,83 @@ import { ReactElement, ReactNode, ComponentPropsWithoutRef } from 'react';
 import { FieldLabelProps } from '../FieldLabel';
 import { HelperProps } from '../../internal/components';
 export type DateFieldYearlessProps = Omit<ComponentPropsWithoutRef<"input">, "onChange" | "value" | "defaultValue" | "ref" | "size" | "type" | "onFocus" | "onBlur"> & LayoutUtilProps & {
-    /**
-     * The controlled value of the date field
-     */
+    /** Controlled month/day. Pass `null` to clear the field. */
     value?: YearlessDate | null;
-    /**
-     * The default value for uncontrolled usage
-     */
+    /** Initial month/day for uncontrolled use. */
     defaultValue?: YearlessDate | null;
-    /**
-     * The function to call when the date value changes
-     */
+    /** Reports the date plus separate input-format and constraint validity. */
     onChange?: DateFieldYearlessChangeHandler;
-    /**
-     * The date format mode (mm/dd or dd/mm)
-     */
+    /** Order of the month and day segments. Defaults to `mm/dd`. */
     mode?: YearlessDateMode;
-    /**
-     * Whether the field is required
-     */
+    /** Makes an empty date fail constraint validation. */
     required?: boolean;
-    /**
-     * The minimum allowed date
-     */
+    /** Earliest valid month/day. */
     minDate?: YearlessDate | null;
-    /**
-     * The maximum allowed date
-     */
+    /** Latest valid month/day. */
     maxDate?: YearlessDate | null;
-    /**
-     * Configuration for unavailable dates
-     */
+    /** Dates that fail constraint validation. */
     unavailable?: {
-        /**
-         * Array of dates that are not selectable
-         */
+        /** 1-based month/day objects, not ISO strings. */
         dates?: YearlessDate[];
     };
-    /**
-     * Whether the picker is disabled
-     */
+    /** Renders only the masked input without its month/day picker. */
     disablePicker?: boolean;
     /**
-     * Error state for the field. Pass `true` to indicate error styling without a message.
-     * Pass a string, string[], or ReactElement (deprecated) for error messages.
+     * Applies error styling. A message value also renders below the field;
+     * React elements are deprecated.
      */
     error?: boolean | string | ReactElement | string[];
     /**
-     * Label for the field.
-     * Omitting `label` is deprecated — it will be required in v4.0.0. Use `hideLabel` to visually hide it.
-     * Passing `ReactNode` is deprecated — use a plain string with inline markdown instead.
+     * Accessible field label. Omitting it or passing non-string content is
+     * deprecated; use a string with inline markdown and `hideLabel` when needed.
      */
     label?: FieldLabelProps["children"];
-    /**
-     * Props for the label component
-     */
+    /** Props for the visible {@link FieldLabel}. */
     labelProps?: FieldLabelProps;
-    /**
-     * Description text for the field
-     */
+    /** Secondary copy rendered below the field. */
     description?: HelperProps["description"];
     /**
      * @deprecated No longer used. Error messages always use `aria-live="assertive"`.
      */
     errorAriaLive?: HelperProps["errorAriaLive"];
-    /**
-     * Warning message(s) to display. Supports a single string or an array of strings.
-     */
+    /** Warning copy rendered below the field. */
     warning?: string | string[];
-    /**
-     * Size of the input
-     */
+    /** Field height. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large">;
-    /**
-     * Whether the field is disabled
-     */
     disabled?: boolean;
-    /**
-     * Whether the field is in loading state
-     */
+    /** Shows a spinner after the input. Defaults to `false`. */
     loading?: boolean;
-    /**
-     * Additional info content
-     */
+    /** Tooltip content for the info button after the label. */
     moreInfo?: ReactNode;
-    /**
-     * Whether to disable the format hint
-     */
+    /** Hides the expected-format hint below the input. */
     disableHint?: boolean;
     /**
      * When `true`, hides the visible label and moves it to `aria-label` on the input.
-     * @default false
+     * Requires `label` to be set — the label is always needed for accessibility.
+     * Defaults to `false`.
      */
     hideLabel?: boolean;
-    /**
-     * Function to call when the field is focused
-     */
     onFocus?: (event: React.FocusEvent) => void;
-    /**
-     * Function to call when the field is blurred
-     */
     onBlur?: (event: React.FocusEvent) => void;
 } & DataTrackingId & DataAttributes;
-/**
- * Represents a change event for the DateFieldYearless component
- */
 export type DateFieldYearlessChange = {
-    /**
-     * The current date value
-     */
+    /** Parsed month/day, with `null` segments while incomplete or empty. */
     value: YearlessDate | null;
-    /**
-     * Whether the input is valid
-     */
+    /** Whether both segments are complete; 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 overall value is valid
+     * Whether the reported date satisfies required, availability, and min/max
+     * constraints; independent of input completeness.
      */
     isValid: boolean;
 };
-/**
- * Handler function for DateFieldYearless change events
- */
+/** Receives the current date and both layers of validity. */
 export type DateFieldYearlessChangeHandler = (change: DateFieldYearlessChange) => void;
 /**
- * DateFieldYearless component for inputting dates without year information.
- *
- * Features:
- * - Supports both controlled and uncontrolled usage
- * - Supports different date formats (mm/dd or dd/mm)
- * - Supports layout utilities for positioning and spacing
- *
- * @example
- * <DateFieldYearless
- *   label="Birthday"
- *   mode="mm/dd"
- *   required
- *   onChange={(change) => console.log('Date changed:', change.value)}
- * />
+ * Masked month/day field with an optional picker. Reports input completeness
+ * separately from date-constraint validity.
  */
 export declare const DateFieldYearless: {
     (props: DateFieldYearlessProps): import("react/jsx-runtime").JSX.Element;

package/dist/src/components/DateFieldYearless/internal/PickerList.d.ts

@@ -1,61 +1,33 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../../types';
-/**
- * Represents an item in the picker list with a label and optional disabled state.
- */
 export type PickerListItem = {
-    /** The display label for the item */
+    /** Visible option label. */
     label: string;
-    /** The value of the item */
+    /** Numeric value used for selection and scroll-to. */
     value: number;
-    /** Whether the item is disabled and cannot be selected */
+    /** Prevents selecting this option. */
     disabled?: boolean;
 };
-/**
- * Props for the PickerList component
- * @extends ComponentPropsWithoutRef<"ul">
- * @extends LayoutUtilProps
- */
 export type PickerListProps = Omit<ComponentPropsWithoutRef<"ul">, "children"> & LayoutUtilProps & {
-    /** Array of items to render */
+    /** Options rendered as listbox items. */
     items: PickerListItem[];
-    /** Currently selected item (controlled) */
+    /** Controlled selected option. */
     selected?: PickerListItem;
-    /** Callback when selection changes */
+    /** Called after click or keyboard selection; `undefined` when toggling off. */
     onSelectionChange?: (selected: PickerListItem | undefined) => void;
 };
-/**
- * Ref methods exposed by PickerList
- */
 export type PickerListRef = {
-    /** Scroll to a specific item by label */
+    /** Scrolls the matching label to the vertical center of the list. */
     scrollToItem: (label: string, behavior?: ScrollBehavior) => void;
-    /** Scroll to a specific item by value */
+    /** Scrolls the matching value to the vertical center of the list. */
     scrollToValue: (value: number, behavior?: ScrollBehavior) => void;
 };
-/**
- * PickerList component for selecting items from a list.
- *
- * Features:
- * - Single selection mode only
- * - Mouse click selection
- * - Programmatic scrolling to specific items
- * - Support for disabled items
- * - Accessible with proper ARIA attributes
- * - Visual consistency with Listbox component
- *
- * @example
- * <PickerList
- *   items={months}
- *   selected={selectedMonth}
- *   onSelectionChange={handleMonthChange}
- * />
- */
+/** Single-select list used by the yearless month/day pickers. */
 export declare const PickerList: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLUListElement>, HTMLUListElement>, "ref">, "children"> & LayoutUtilProps & {
-    /** Array of items to render */
+    /** Options rendered as listbox items. */
     items: PickerListItem[];
-    /** Currently selected item (controlled) */
+    /** Controlled selected option. */
     selected?: PickerListItem;
-    /** Callback when selection changes */
+    /** Called after click or keyboard selection; `undefined` when toggling off. */
     onSelectionChange?: (selected: PickerListItem | undefined) => void;
 } & import('react').RefAttributes<PickerListRef>>;

package/dist/src/components/DateFieldYearless/internal/PickerListOption.d.ts

@@ -1,61 +1,44 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { FlexProps } from '../../Flex';
 import { DataTrackingId } from '../../../types';
-/**
- * Props for the PickerListOption component
- * @extends ComponentPropsWithoutRef<"li">
- */
 export type PickerListOptionProps = ComponentPropsWithoutRef<"li"> & {
-    /** The item object containing label, value, and optional disabled state */
+    /** Option label, numeric value, and whether it cannot be chosen. */
     item: {
         label: string;
         value: number;
         disabled?: boolean;
     };
-    /** Whether this option is currently selected */
     isSelected: boolean;
-    /** Callback when this option is selected */
+    /** Called with the item, or `undefined` when a selected option is clicked again. */
     onSelectionChange: (selected: {
         label: string;
         value: number;
     } | undefined) => void;
-    /** Flex alignment for items */
     alignItems?: FlexProps["alignItems"];
-    /** Flex justification for items */
     justifyItems?: FlexProps["justifyItems"];
-    /** Flex alignment for content */
     alignContent?: FlexProps["alignContent"];
-    /** Flex justification for content */
     justifyContent?: FlexProps["justifyContent"];
-    /** Flex place-items property */
     placeItems?: FlexProps["placeItems"];
-    /** Flex place-content property */
     placeContent?: FlexProps["placeContent"];
 } & DataTrackingId;
+/** One month or day option in a {@link PickerList}. */
 export declare const PickerListOption: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & {
-    /** The item object containing label, value, and optional disabled state */
+    /** Option label, numeric value, and whether it cannot be chosen. */
     item: {
         label: string;
         value: number;
         disabled?: boolean;
     };
-    /** Whether this option is currently selected */
     isSelected: boolean;
-    /** Callback when this option is selected */
+    /** Called with the item, or `undefined` when a selected option is clicked again. */
     onSelectionChange: (selected: {
         label: string;
         value: number;
     } | undefined) => void;
-    /** Flex alignment for items */
     alignItems?: FlexProps["alignItems"];
-    /** Flex justification for items */
     justifyItems?: FlexProps["justifyItems"];
-    /** Flex alignment for content */
     alignContent?: FlexProps["alignContent"];
-    /** Flex justification for content */
     justifyContent?: FlexProps["justifyContent"];
-    /** Flex place-items property */
     placeItems?: FlexProps["placeItems"];
-    /** Flex place-content property */
     placeContent?: FlexProps["placeContent"];
 } & DataTrackingId & import('react').RefAttributes<HTMLLIElement>>;

package/dist/src/components/DateFieldYearless/internal/YearlessDateInput.d.ts

@@ -2,50 +2,65 @@ import { InputHTMLAttributes } from 'react';
 import { YearlessDateMode, YearlessDate } from '../types';
 import { PassThroughPropsWithRef, Size } from '../../../types';
 export type YearlessDateInputChange = {
+    /** Native change event, or `null` when the value was set programmatically. */
     event: React.ChangeEvent<HTMLInputElement> | null;
+    /** Parsed month/day, including `null` segments while incomplete. */
     value: YearlessDate | null;
+    /** Whether both segments are two digits. */
     isInputValid: boolean;
+    /** Whether no date digits remain after removing the placeholder. */
     isInputEmpty: boolean;
 };
+/** Receives parsed input changes, including incomplete segments. */
 export type YearlessDateInputChangeHandler = (change: YearlessDateInputChange) => void;
 export type YearlessDateInputProps = Omit<InputHTMLAttributes<HTMLInputElement>, "onChange" | "value" | "ref" | "size"> & {
+    /** Called when the parsed month/day changes. */
     onChange: YearlessDateInputChangeHandler;
+    /** Order of the month and day segments. Defaults to `mm/dd`. */
     mode?: YearlessDateMode;
+    /** Date displayed after an external update. */
     value?: YearlessDate | null;
+    /** Applies error styling on the input. */
     error?: boolean;
+    /** Field height. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large">;
     wrapperProps?: PassThroughPropsWithRef<"div">;
     rootProps?: PassThroughPropsWithRef<"div">;
+    /** Shows a spinner after the input. Defaults to `false`. */
     loading?: boolean;
+    /** Enables ArrowUp/ArrowDown stepping of the focused segment. Defaults to `false`. */
     enableStepping?: boolean;
 };
 export type YearlessDateInputRef = HTMLInputElement & {
+    /** Updates the displayed date without firing a native input event. */
     setValue: (value: YearlessDate | null) => {
         value: YearlessDate | null;
         isInputValid: boolean;
         isInputEmpty: boolean;
     };
+    /** Strips the mask placeholder so remaining digits can be parsed. */
     removePlaceholder: (value: string) => string;
 };
 /**
- * A masked date input component that allows for the input of a date in a specific format.
+ * Masked month/day input used by DateFieldYearless.
  *
- * 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 YearlessDateInput: import('react').ForwardRefExoticComponent<Omit<InputHTMLAttributes<HTMLInputElement>, "ref" | "onChange" | "size" | "value"> & {
+    /** Called when the parsed month/day changes. */
     onChange: YearlessDateInputChangeHandler;
+    /** Order of the month and day segments. Defaults to `mm/dd`. */
     mode?: YearlessDateMode;
+    /** Date displayed after an external update. */
     value?: YearlessDate | null;
+    /** Applies error styling on the input. */
     error?: boolean;
+    /** Field height. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large">;
     wrapperProps?: PassThroughPropsWithRef<"div">;
     rootProps?: PassThroughPropsWithRef<"div">;
+    /** Shows a spinner after the input. Defaults to `false`. */
     loading?: boolean;
+    /** Enables ArrowUp/ArrowDown stepping of the focused segment. Defaults to `false`. */
     enableStepping?: boolean;
 } & import('react').RefAttributes<YearlessDateInputRef>>;