@servicetitan/anvil2 3.14.1 → 3.15.0

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

@@ -3,132 +3,73 @@ import { YearlessDateMode, YearlessDate } from '../types';
 import { DateFieldYearlessChangeHandler } from '../DateFieldYearless';
 import { Size } from '../../../types';
 export type YearlessDateInputWithPickerProps = Omit<InputHTMLAttributes<HTMLInputElement>, "onChange" | "value" | "ref" | "size" | "defaultValue" | "onFocus" | "onBlur"> & {
-    /**
-     * 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;
-    /**
-     * The size of the input
-     */
+    /** Field height. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large">;
-    /**
-     * Whether the input has an error
-     */
+    /** Applies error styling on the input. */
     error?: boolean;
-    /**
-     * Whether the input is in loading state
-     */
+    /** Shows a spinner after the input. Defaults to `false`. */
     loading?: boolean;
-    /**
-     * Function to call when the input is focused
-     */
     onFocus?: (event: React.FocusEvent) => void;
-    /**
-     * Function to call when the input is blurred
-     */
     onBlur?: (event: React.FocusEvent) => void;
 };
 export type YearlessDateInputWithPickerRef = {
     focus: () => void;
+    /** Updates the displayed date without firing a native input event. */
     setValue: (value: YearlessDate | null) => void;
 };
+/**
+ * Masked month/day input with an optional picker. Commits a picker change once
+ * the first segment for the current `mode` is set.
+ */
 export declare const YearlessDateInputWithPicker: import('react').ForwardRefExoticComponent<Omit<InputHTMLAttributes<HTMLInputElement>, "ref" | "defaultValue" | "onFocus" | "onBlur" | "onChange" | "size" | "value"> & {
-    /**
-     * 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;
-    /**
-     * The size of the input
-     */
+    /** Field height. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large">;
-    /**
-     * Whether the input has an error
-     */
+    /** Applies error styling on the input. */
     error?: boolean;
-    /**
-     * Whether the input is in loading state
-     */
+    /** Shows a spinner after the input. Defaults to `false`. */
     loading?: boolean;
-    /**
-     * Function to call when the input is focused
-     */
     onFocus?: (event: React.FocusEvent) => void;
-    /**
-     * Function to call when the input is blurred
-     */
     onBlur?: (event: React.FocusEvent) => void;
 } & import('react').RefAttributes<YearlessDateInputWithPickerRef>>;

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

@@ -1,27 +1,25 @@
 import { Ref, RefObject } from 'react';
 import { YearlessDateMode } from '..';
 import { PopoverTriggerProps } from '../../../internal/components/Popover/PopoverTrigger';
-/**
- * Props for the YearlessDateSelectionPopover component
- */
 export type YearlessDateSelectionPopoverProps = {
     popoverRef: RefObject<{
         openPopover: () => void;
         closePopover: () => void;
     }>;
     popoverContentRef: Ref<HTMLDivElement>;
+    /** Currently selected month, or `null` while unset. */
     month: number | null;
+    /** Currently selected day, or `null` while unset. */
     day: number | null;
+    /** Called after a month is chosen; may clear an impossible day. */
     onMonthChange: (month: number | null) => void;
+    /** Called after a day is chosen; may clear an impossible month. */
     onDayChange: (day: number | null) => void;
     onClose: () => void;
+    /** Controls whether the day list or month list comes first. */
     mode: YearlessDateMode;
     onFocus?: (event: React.FocusEvent) => void;
     onBlur?: (event: React.FocusEvent) => void;
 } & PopoverTriggerProps;
-/**
- * A yearless date selection tool built into a popover.
- * @param param0
- * @returns
- */
+/** Month and day lists in a popover, ordered to match `mode`. */
 export declare function YearlessDateSelectionPopover({ children, popoverRef, popoverContentRef, month, day, onMonthChange, onDayChange, onClose, mode, onFocus, onBlur, }: YearlessDateSelectionPopoverProps): import("react/jsx-runtime").JSX.Element;

package/dist/src/components/DateFieldYearless/internal/maskito/yearlessDatePlaceholderMask.d.ts

@@ -1,4 +1,5 @@
 import { YearlessDateMode } from '../../types';
+/** Builds Maskito month/day options with a persistent placeholder, zero shortcut, and optional stepping. */
 declare const yearlessDatePlaceholderMask: ({ mode, separator, placeholder, enableStepping, }: {
     mode: YearlessDateMode;
     enableStepping: boolean;

package/dist/src/components/DateFieldYearless/internal/maskito/yearlessDateSegmentsStepping.d.ts

@@ -1,11 +1,9 @@
 import { MaskitoPlugin } from '@maskito/core';
 import { YearlessDateMode } from '../../types';
 /**
- * Creates a Maskito plugin for yearless date segment stepping
- * @param mode - The date format mode (mm/dd or dd/mm)
- * @returns MaskitoPlugin that handles arrow key navigation
- * @example
- * const plugin = createYearlessDateSegmentsSteppingPlugin({ mode: "mm/dd" });
+ * ArrowUp decreases and ArrowDown increases the focused month or day;
+ * ArrowRight inserts `/` after the first segment when the placeholder is
+ * still present. Changing the month clamps an impossible day.
  */
 export declare function createYearlessDateSegmentsSteppingPlugin({ mode, }: {
     mode: YearlessDateMode;

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

@@ -1,4 +1,5 @@
 import { YearlessDate, YearlessDateMode } from '../types';
+/** Empty dates pass unless `required`. Incomplete, unavailable, or out-of-range dates fail. */
 export declare function validateYearlessDate({ value, constraints, }: {
     value: YearlessDate | null;
     constraints: {
@@ -10,52 +11,22 @@ export declare function validateYearlessDate({ value, constraints, }: {
         maxDate?: YearlessDate | null;
     };
 }): boolean;
-/**
- * Return list of months
- * 🌍 localeName: name of local,
- *  ✅ monthFormat: short, numeric, long (Default)
- */
+/** Localized month names for the picker, using UTC so the calendar month does not shift. */
 export declare function getMonthNames({ locale, format, }: {
     locale: string;
     format: Intl.DateTimeFormatOptions["month"];
 }): string[];
-/**
- * Given a text value, parse it into a YearlessDate object and validate it.
- * @param value - The text value to parse.
- * @param mode - The mode of the date input.
- * @param removePlaceholder - The function to remove the placeholder from the text value.
- * @returns An object containing the parsed YearlessDate object, the input validity, and the input emptiness.
- */
+/** Parses masked text into month/day; incomplete segments become `null`. */
 export declare function parseInputValue(value: string, mode: YearlessDateMode, removePlaceholder: (value: string) => string): {
     value: YearlessDate | null;
     isInputValid: boolean;
     isInputEmpty: boolean;
 };
-/**
- * Swap the mode of a date input.
- * @param inputString - The text value to swap the mode of.
- * @param previousMode - The previous mode of the date input.
- * @param mode - The new mode of the date input.
- * @returns The text value with the new mode.
- */
+/** Reorders existing month/day digits when `mode` changes. */
 export declare function swapMode(inputString: string, previousMode: YearlessDateMode, mode: YearlessDateMode): string;
-/**
- * Convert a YearlessDate object into a text value.
- * @param day - The day of the date.
- * @param month - The month of the date.
- * @param mode - The mode of the date input.
- * @returns The stringified date.
- */
+/** Formats month/day into the masked string, using `__` for a missing segment. */
 export declare function stringifyYearlessDate(day: number | string | null, month: number | string | null, mode: YearlessDateMode): string;
-/**
- * Get the number of days in a given month.
- * @param month - The month number (1-12)
- * @returns The number of days in the month
- */
+/** Days in `month` (1–12), using a leap year so February is 29. */
 export declare function getDaysInMonth(month: number): number;
-/**
- * Get months that don't have enough days for the given day.
- * @param day - The day number (1-31)
- * @returns Array of month numbers that don't have enough days for the given day
- */
+/** Months that cannot contain `day` (for example 31 in April). */
 export declare function getInvalidMonthsForDay(day: number): number[];

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

@@ -1,10 +1,8 @@
 /**
  * `data-anv-part` names for DateFieldYearless interactive sub-elements.
  *
- * Consumer `data-*` (e.g. `data-cy`) is forwarded to the masked text input —
- * the one element present in every mode (including `disablePicker`). The
- * picker popover and month/day lists render in the top layer, outside the
- * input's subtree — target them by part attribute directly.
+ * The picker popover and month/day lists 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/DateFieldYearless/types.d.ts

@@ -1,6 +1,9 @@
 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">;
+/** Month/day segment order. */
 export type YearlessDateMode = Extract<MaskitoDateMode, "mm/dd" | "dd/mm">;
+/** 1-based month and day; either may be `null` while a segment is incomplete. */
 export type YearlessDate = {
     day: number | null;
     month: number | null;

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

@@ -3,94 +3,78 @@ import { HelperProps } from '../../internal/components';
 import { DataAttributes, LayoutUtilProps, Size } from '../../types';
 import { FieldLabelProps } from '../FieldLabel';
 import { YearlessDate, YearlessDateMode } from '../DateFieldYearless/types';
+/** Start and end month/day values without a year. */
 export type DateFieldYearlessRangeValue = {
+    /** Start month/day. Pass `null` to clear the start input. */
     startDate: YearlessDate | null;
+    /** End month/day. Pass `null` to clear the end input. */
     endDate: YearlessDate | null;
 };
+/** Month/day range reported after either input changes. */
 export type DateFieldYearlessRangeChange = {
+    /** Current start month/day; typed incomplete or empty segments are `null`. */
     startDate: YearlessDate | null;
+    /** Current end month/day; typed incomplete or empty segments are `null`. */
     endDate: YearlessDate | null;
 };
+/** Receives the current month/day range. */
 export type DateFieldYearlessRangeChangeHandler = (change: DateFieldYearlessRangeChange) => void;
 export type DateFieldYearlessRangeProps = {
-    /**
-     * The controlled value of the date field
-     */
+    /** Controlled month/day range. */
     value?: DateFieldYearlessRangeValue;
-    /**
-     * The default value for uncontrolled usage
-     */
+    /** Initial month/day range for uncontrolled use. */
     defaultValue?: DateFieldYearlessRangeValue;
-    /**
-     * The function to call when the date value changes
-     */
+    /** Reports the range after either input changes. */
     onChange?: DateFieldYearlessRangeChangeHandler;
-    /**
-     * 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 each empty input fail constraint validation. */
     required?: boolean;
-    /**
-     * Whether the picker is disabled
-     */
+    /** Renders both masked inputs without their month/day pickers. */
     disablePicker?: boolean;
-    /**
-     * Whether to disable the hint
-     */
+    /** Hides the expected-format hint below the range. */
     disableHint?: 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 to both inputs. A message value also renders below
+     * the range; React elements are deprecated.
      */
     error?: boolean | string | ReactElement | string[];
-    /**
-     * Label for the field group. Always required for accessibility.
-     */
+    /** Accessible legend for the fieldset. */
     label: string;
     /**
-     * When `true`, hides the visible legend while keeping it accessible to screen readers.
-     * @default false
+     * Hides the visible legend while preserving it for assistive technology.
+     * Defaults to `false`.
      */
     hideLabel?: boolean;
+    /** Height of both inputs. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large">;
+    /** Secondary copy rendered below the range. */
     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 range. */
     warning?: string | string[];
+    /** Disables both inputs and their picker buttons. */
     disabled?: boolean;
+    /** Called when either input receives focus. */
     onFocus?: (event: React.FocusEvent) => void;
+    /** Called when either input loses focus. */
     onBlur?: (event: React.FocusEvent) => void;
+    /** Base ID; the inputs append `-start` and `-end`. */
     id?: string;
+    /** Accessible name for the start input. Defaults to `Start date`. */
     startLabel?: string;
+    /** Accessible name for the end input. Defaults to `End date`. */
     endLabel?: string;
+    /** Props for the visible {@link FieldLabel}, except its root element. */
     legendProps?: Omit<FieldLabelProps, "el">;
+    /** Tooltip content for the info button after the legend. */
     moreInfo?: FieldLabelProps["moreInfo"];
 } & LayoutUtilProps & DataAttributes;
 /**
- * DateFieldYearlessRange component for entering a start and end month/day
- * pair — a date range with no year, e.g. recurring events or anniversaries.
- *
- * Features:
- * - Two masked month/day inputs (mm/dd or dd/mm mode) with a picker toggle
- * - Separate `startLabel`/`endLabel` under a shared field-group `label`
- * - Optional error, warning, hint, and description messaging
- * - `disablePicker` and `disableHint` to trim the UI down when not needed
- *
- * @example
- * <DateFieldYearlessRange
- *   label="Recurring event"
- *   startLabel="Start"
- *   endLabel="End"
- *   value={{ startDate: { month: 7, day: 2 }, endDate: { month: 7, day: 10 } }}
- *   onChange={(change) => console.log(change)}
- * />
+ * Paired masked month/day fields with optional pickers for ranges that do not
+ * include a year.
  */
 export declare const DateFieldYearlessRange: (props: DateFieldYearlessRangeProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,10 +1,8 @@
 /**
  * `data-anv-part` names for DateFieldYearlessRange interactive sub-elements.
  *
- * Consumer `data-*` is forwarded to the fieldset root. Scope start/end inputs
- * under it (`[data-cy="x"] [data-anv-part="start-input"]`). Picker popover /
- * month-list / day-list / option parts are stamped by the shared yearless
- * picker internals — see DateFieldYearless `PARTS`.
+ * Picker popover and list parts come from the shared yearless picker and
+ * render in the top layer outside the fieldset.
  */
 export declare const PARTS: {
     readonly startInput: "start-input";

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

@@ -1,47 +1,32 @@
 import { AriaAttributes, ReactElement } from 'react';
 import { DataTrackingId } from '../../types';
 import { FieldLabelProps } from '../FieldLabel';
-/**
- * Props for the DaysOfTheWeek component
- */
 export type DaysOfTheWeekProps = {
     /**
-     * The selected days (1-7, where 1 is Monday and 7 is Sunday)
+     * Selected weekdays as 1–7, where Monday is 1 and Sunday is 7. Defaults to
+     * an empty selection.
      */
     selectedDays?: number[];
-    /**
-     * Callback fired when the selection changes
-     */
+    /** Reports the selected weekday numbers after a toggle. */
     onChange?: (selectedDays: number[]) => void;
     /**
-     * Whether the component is disabled
-     * Can be a boolean to disable all days, or an array of day numbers (1-7) to disable specific days
+     * `true` disables every day; a number array disables those weekdays (1–7).
      */
     disabled?: boolean | number[];
     /**
-     * The first day of the week (1-7, where 1 is Monday and 7 is Sunday)
-     * @default 1
+     * Weekday that starts the visible row. Rotates display only; selected values
+     * stay 1–7. Defaults to `7` (Sunday).
      */
     firstDay?: number;
-    /**
-     * Hint text or element to display above the component
-     */
+    /** Always-visible hint rendered below the days. */
     hint?: ReactElement | string;
-    /**
-     * ID for the component
-     */
+    /** ID of the day-button row; generated when omitted. */
     id?: string;
-    /**
-     * Description text or element to display below the component
-     */
+    /** Secondary copy rendered below the days. */
     description?: ReactElement | string;
-    /**
-     * Error message(s) to display. Supports a single string or an array of strings.
-     */
+    /** Error copy rendered below the days. */
     error?: string | string[];
-    /**
-     * Warning message(s) to display. Supports a single string or an array of strings.
-     */
+    /** Warning copy rendered below the days. */
     warning?: string | string[];
     /**
      * @deprecated Use the `error` prop instead.
@@ -51,83 +36,45 @@ export type DaysOfTheWeekProps = {
      * @deprecated No longer used. Error messages always use `aria-live="assertive"`.
      */
     errorAriaLive?: AriaAttributes["aria-live"];
-    /**
-     * Label text or element
-     */
+    /** Accessible field label. String children go through inline markdown. */
     label?: FieldLabelProps["children"];
-    /**
-     * Whether the field is required
-     */
+    /** Shows the required indicator but does not validate selection. */
     required?: boolean;
-    /**
-     * Additional info to display in a tooltip next to the label
-     */
+    /** Tooltip content for the info button after the label. */
     moreInfo?: FieldLabelProps["moreInfo"];
-    /**
-     * Additional props to pass to the Label component
-     */
+    /** Props for the visible {@link FieldLabel}. */
     labelProps?: FieldLabelProps;
 } & DataTrackingId;
 /**
- * DaysOfTheWeek component for selecting multiple days of the week.
- *
- * Features:
- * - Displays days of the week as toggleable buttons
- * - Supports custom first day of the week (Monday-Sunday)
- * - Individual day selection and deselection
- * - Optional label, hint, description, and error messaging
- * - Full accessibility support with ARIA attributes
- * - Tooltips showing full day names on hover
- * - Responsive design with flexible layout
- * - Support for disabling specific days or the entire component
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <DaysOfTheWeek
- *   selectedDays={[2, 4, 6]}
- *   onChange={(days) => console.log('Selected days:', days)}
- *   label="Working Days"
- *   firstDay={1}
- * />
+ * Toggle buttons for selecting weekdays. Values are 1–7 (Monday–Sunday);
+ * `firstDay` only rotates the visible order.
  */
 export declare const DaysOfTheWeek: import('react').ForwardRefExoticComponent<{
     /**
-     * The selected days (1-7, where 1 is Monday and 7 is Sunday)
+     * Selected weekdays as 1–7, where Monday is 1 and Sunday is 7. Defaults to
+     * an empty selection.
      */
     selectedDays?: number[];
-    /**
-     * Callback fired when the selection changes
-     */
+    /** Reports the selected weekday numbers after a toggle. */
     onChange?: (selectedDays: number[]) => void;
     /**
-     * Whether the component is disabled
-     * Can be a boolean to disable all days, or an array of day numbers (1-7) to disable specific days
+     * `true` disables every day; a number array disables those weekdays (1–7).
      */
     disabled?: boolean | number[];
     /**
-     * The first day of the week (1-7, where 1 is Monday and 7 is Sunday)
-     * @default 1
+     * Weekday that starts the visible row. Rotates display only; selected values
+     * stay 1–7. Defaults to `7` (Sunday).
      */
     firstDay?: number;
-    /**
-     * Hint text or element to display above the component
-     */
+    /** Always-visible hint rendered below the days. */
     hint?: ReactElement | string;
-    /**
-     * ID for the component
-     */
+    /** ID of the day-button row; generated when omitted. */
     id?: string;
-    /**
-     * Description text or element to display below the component
-     */
+    /** Secondary copy rendered below the days. */
     description?: ReactElement | string;
-    /**
-     * Error message(s) to display. Supports a single string or an array of strings.
-     */
+    /** Error copy rendered below the days. */
     error?: string | string[];
-    /**
-     * Warning message(s) to display. Supports a single string or an array of strings.
-     */
+    /** Warning copy rendered below the days. */
     warning?: string | string[];
     /**
      * @deprecated Use the `error` prop instead.
@@ -137,20 +84,12 @@ export declare const DaysOfTheWeek: import('react').ForwardRefExoticComponent<{
      * @deprecated No longer used. Error messages always use `aria-live="assertive"`.
      */
     errorAriaLive?: AriaAttributes["aria-live"];
-    /**
-     * Label text or element
-     */
+    /** Accessible field label. String children go through inline markdown. */
     label?: FieldLabelProps["children"];
-    /**
-     * Whether the field is required
-     */
+    /** Shows the required indicator but does not validate selection. */
     required?: boolean;
-    /**
-     * Additional info to display in a tooltip next to the label
-     */
+    /** Tooltip content for the info button after the label. */
     moreInfo?: FieldLabelProps["moreInfo"];
-    /**
-     * Additional props to pass to the Label component
-     */
+    /** Props for the visible {@link FieldLabel}. */
     labelProps?: FieldLabelProps;
 } & DataTrackingId & import('react').RefAttributes<HTMLDivElement>>;