@servicetitan/anvil2 3.14.0 → 3.15.0

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

@@ -1,315 +1,119 @@
 import { WeekdayNumbers } from 'luxon';
 import { ComponentPropsWithoutRef } from 'react';
 import { IanaZone, LayoutUtilProps, Locale } from '../../types';
+/** Selected date as an ISO string, or `undefined` when cleared. */
 export type CalendarValue = string | undefined;
+/** Selected ISO date range; `end` is absent while the range is incomplete. */
 export type CalendarRangeValue = {
     start?: string;
     end?: string;
 } | undefined;
-/**
- * Props for the Calendar component
- * @extends Omit<ComponentPropsWithoutRef<"div">, "value" | "defaultValue">
- * @extends LayoutUtilProps
- */
 type CalendarCommonProps = Omit<ComponentPropsWithoutRef<"div">, "value" | "defaultValue"> & {
-    /**
-     * @deprecated children will be overridden internally
-     */
+    /** @deprecated Ignored because Calendar renders its own contents. */
     children?: ComponentPropsWithoutRef<"div">["children"];
     /**
-     * The default focused date. Used to determine what month and year is shown on initial render.
-     * Prefer this over `focusedDate`, which is deprecated.
+     * Establishes the visible month and year independently of the selection.
+     * Updates also move the visible view.
      */
     defaultFocusedDate?: string | null;
     /**
-     * The focused date. Used to determine what month and year is currently shown.
-     * @deprecated Use `defaultFocusedDate` instead. `focusedDate` does not reliably control the initial view and will be removed in a future major release.
+     * @deprecated Use `defaultFocusedDate`. This prop does not reliably control
+     * the initial view and will be removed in a future major release.
      */
     focusedDate?: string | null;
-    /**
-     * The minimum date allowed.
-     */
+    /** Earliest selectable date; navigation stops at its month. */
     minDate?: string;
-    /**
-     * The maximum date allowed.
-     */
+    /** Latest selectable date; navigation stops at its month. */
     maxDate?: string;
-    /**
-     * The days of the week and dates that are unavailable.
-     */
+    /** Recurring weekdays and individual dates excluded from selection. */
     unavailable?: {
-        /**
-         * The days of the week that are unavailable.
-         */
+        /** Luxon weekday numbers excluded every week. */
         daysOfWeek?: WeekdayNumbers[];
-        /**
-         * The specific dates that are unavailable.
-         */
+        /** ISO dates excluded in addition to recurring weekdays. */
         dates?: string[];
     };
-    /**
-     * The locale to use for the calendar.
-     */
+    /** Locale for month, weekday, and accessible date labels. Defaults to the browser locale. */
     locale?: Locale;
-    /**
-     * The time zone to use for the calendar.
-     */
+    /** Zone used to parse dates and determine today. Defaults to the browser time zone. */
     defaultTimeZone?: IanaZone;
-    /**
-     * The day of the week to start the calendar on.
-     */
+    /** First column in the month grid. Defaults to `Sunday`. */
     startDay?: "Sunday" | "Monday";
-    /**
-     * Whether the calendar should focus on the focused date.
-     * @internal - Do not use this prop directly.
-     */
+    /** When true, view changes move focus only while a day cell has focus. @internal */
     _disableAutofocus?: boolean;
-    /** Whether the calendar should set all tab indexes to -1.
-     * @internal - Do not use this prop directly.
-     */
+    /** Removes the navigation toolbar from the tab order. @internal */
     _disableFocus?: boolean;
 };
 type CalendarSingleProps = CalendarCommonProps & {
-    /**
-     * The function to call when the value changes.
-     *
-     * @param data - The data to pass to the function.
-     */
+    /** Called with the selected ISO date, or `undefined` when it is cleared. */
     onSelection?: (data: {
         value: CalendarValue;
     }) => void;
-    /**
-     * The default date value for uncontrolled mode.
-     */
+    /** Initial uncontrolled selection. Omit or pass `false` to initialize to today. */
     defaultValue?: string | false;
-    /**
-     * The value for controlled mode.
-     */
+    /** Controlled ISO date selection. */
     value?: string;
-    /**
-     * Whether the calendar is in range mode.
-     */
+    /** Uses single-date selection when omitted or `false`. */
     range?: false;
 };
 type CalendarRangeProps = CalendarCommonProps & {
-    /**
-     * The function to call when the value changes.
-     *
-     * @param data.value - The date value that is selected.
-     */
+    /** Called after either endpoint changes; `end` is absent until completed. */
     onSelection?: (data: {
         value: CalendarRangeValue;
     }) => void;
-    /**
-     * The default date value for uncontrolled mode.
-     */
+    /** Initial uncontrolled range; either endpoint may be omitted. */
     defaultValue?: {
         start?: string;
         end?: string;
     };
-    /**
-     * The date value for controlled mode.
-     */
+    /** Controlled ISO date range; either endpoint may be omitted. */
     value?: {
         start?: string;
         end?: string;
     };
-    /**
-     * Whether the calendar is in range mode.
-     */
+    /** Enables range values and range-selection behavior. */
     range: true;
 };
+/**
+ * Set `range` to `true` for range values and callbacks; otherwise Calendar
+ * uses single-date values.
+ */
 export type CalendarProps = LayoutUtilProps & (CalendarSingleProps | CalendarRangeProps);
 /**
- * Calendar component for viewing and selecting a date or range of dates.
- *
- * Features:
- * - Single date and date range selection modes
- * - Month and year navigation with header buttons
- * - Configurable start day (Sunday or Monday)
- * - Date range restrictions with min/max dates
- * - Unavailable dates and days of week support
- * - Locale and timezone customization
- * - Full accessibility support with ARIA attributes
- * - Keyboard navigation support
- * - Responsive design with automatic width detection
- * - Month and year selection views
- * - Today button for quick navigation
- *
- * @example
- * <Calendar
- *   value="2024-01-15"
- *   onSelection={({ value }) => console.log('Selected:', value)}
- *   minDate="2024-01-01"
- *   maxDate="2024-12-31"
- * />
+ * Calendar for selecting a single date or date range. Includes keyboard
+ * navigation and month, year, and today controls.
  */
 export declare const Calendar: import('react').ForwardRefExoticComponent<CalendarProps & import('react').RefAttributes<HTMLDivElement>> & {
-    /**
-     * Calendar.Now component for navigating to today's date.
-     *
-     * Features:
-     * - Quick navigation to current date
-     * - Accessible button with proper ARIA labels
-     * - Integrates with calendar context
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.Now />
-     */
+    /** Selects today and moves it into view. */
     Now: import('react').ForwardRefExoticComponent<{
         onClick?: (e: import('react').MouseEvent<HTMLButtonElement>, date: string | null) => void;
         onClickFixed?: import('react').MouseEventHandler<HTMLButtonElement> | undefined;
     } & Omit<import('..').ButtonProps, "onClick"> & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * Calendar.Month component for displaying the month grid.
-     *
-     * Features:
-     * - Displays calendar days in a table format
-     * - Handles day selection and navigation
-     * - Supports range selection mode
-     * - Accessible with proper ARIA attributes
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.Month />
-     */
+    /** Displays the current month grid. */
     Month: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').TableHTMLAttributes<HTMLTableElement>, HTMLTableElement>, "ref"> & import('react').RefAttributes<HTMLTableElement>>;
-    /**
-     * Calendar.Next component for navigating to the next month.
-     *
-     * Features:
-     * - Navigation to next month
-     * - Accessible button with proper ARIA labels
-     * - Integrates with calendar context
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.Next />
-     */
+    /** Moves the calendar to the next month. */
     Next: import('react').ForwardRefExoticComponent<import('..').ButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * Calendar.Prev component for navigating to the previous month.
-     *
-     * Features:
-     * - Navigation to previous month
-     * - Accessible button with proper ARIA labels
-     * - Integrates with calendar context
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.Prev />
-     */
+    /** Moves the calendar to the previous month. */
     Prev: import('react').ForwardRefExoticComponent<import('..').ButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * Calendar.MonthButton component for switching to month selection view.
-     *
-     * Features:
-     * - Switches calendar to month selection mode
-     * - Accessible button with proper ARIA labels
-     * - Integrates with calendar context
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.MonthButton />
-     */
+    /** Opens or closes month selection. */
     MonthButton: import('react').ForwardRefExoticComponent<import('./CalendarMonthButton').CalendarMonthButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * Calendar.YearButton component for switching to year selection view.
-     *
-     * Features:
-     * - Switches calendar to year selection mode
-     * - Accessible button with proper ARIA labels
-     * - Integrates with calendar context
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.YearButton />
-     */
+    /** Opens or closes year selection. */
     YearButton: import('react').ForwardRefExoticComponent<import('./CalendarYearButton').CalendarYearButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
 };
 export declare const CalendarElement: import('react').ForwardRefExoticComponent<CalendarProps & import('react').RefAttributes<HTMLDivElement>> & {
-    /**
-     * Calendar.Now component for navigating to today's date.
-     *
-     * Features:
-     * - Quick navigation to current date
-     * - Accessible button with proper ARIA labels
-     * - Integrates with calendar context
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.Now />
-     */
+    /** Selects today and moves it into view. */
     Now: import('react').ForwardRefExoticComponent<{
         onClick?: (e: import('react').MouseEvent<HTMLButtonElement>, date: string | null) => void;
         onClickFixed?: import('react').MouseEventHandler<HTMLButtonElement> | undefined;
     } & Omit<import('..').ButtonProps, "onClick"> & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * Calendar.Month component for displaying the month grid.
-     *
-     * Features:
-     * - Displays calendar days in a table format
-     * - Handles day selection and navigation
-     * - Supports range selection mode
-     * - Accessible with proper ARIA attributes
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.Month />
-     */
+    /** Displays the current month grid. */
     Month: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').TableHTMLAttributes<HTMLTableElement>, HTMLTableElement>, "ref"> & import('react').RefAttributes<HTMLTableElement>>;
-    /**
-     * Calendar.Next component for navigating to the next month.
-     *
-     * Features:
-     * - Navigation to next month
-     * - Accessible button with proper ARIA labels
-     * - Integrates with calendar context
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.Next />
-     */
+    /** Moves the calendar to the next month. */
     Next: import('react').ForwardRefExoticComponent<import('..').ButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * Calendar.Prev component for navigating to the previous month.
-     *
-     * Features:
-     * - Navigation to previous month
-     * - Accessible button with proper ARIA labels
-     * - Integrates with calendar context
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.Prev />
-     */
+    /** Moves the calendar to the previous month. */
     Prev: import('react').ForwardRefExoticComponent<import('..').ButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * Calendar.MonthButton component for switching to month selection view.
-     *
-     * Features:
-     * - Switches calendar to month selection mode
-     * - Accessible button with proper ARIA labels
-     * - Integrates with calendar context
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.MonthButton />
-     */
+    /** Opens or closes month selection. */
     MonthButton: import('react').ForwardRefExoticComponent<import('./CalendarMonthButton').CalendarMonthButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * Calendar.YearButton component for switching to year selection view.
-     *
-     * Features:
-     * - Switches calendar to year selection mode
-     * - Accessible button with proper ARIA labels
-     * - Integrates with calendar context
-     * - Data tracking integration for analytics
-     *
-     * @example
-     * <Calendar.YearButton />
-     */
+    /** Opens or closes year selection. */
     YearButton: import('react').ForwardRefExoticComponent<import('./CalendarYearButton').CalendarYearButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
 };
 export {};

package/dist/src/components/Calendar/CalendarContext.d.ts

@@ -3,151 +3,81 @@ import { CalendarProps, CalendarRangeValue, CalendarValue } from './Calendar';
 import { DateTime } from 'luxon';
 import { IanaZone } from '../../types';
 type CalendarContextCommonProps = {
-    /**
-     * Whether the calendar should focus on the focused date.
-     */
+    /** When true, view changes move focus only while a day cell has focus. */
     disableAutofocus: boolean;
-    /**
-     * The focused date. Used to determine what month and year is currently selected.
-     */
+    /** Active keyboard-navigation date and source of the visible month. */
     focusedDate: DateTime;
-    /**
-     * The function to call when the focused date changes.
-     *
-     * @param date - The date that is focused.
-     */
+    /** Updates the active keyboard-navigation date. */
     setFocusedDate: Dispatch<SetStateAction<CalendarContextCommonProps["focusedDate"]>>;
-    /**
-     * The selected month. Used to determine what month is currently selected in the month button.
-     */
+    /** Month shown by the month control. */
     selectedMonth: DateTime["month"];
-    /**
-     * The function to call when the selected month changes.
-     *
-     * @param month - The month that is selected.
-     */
+    /** Updates the month control and month-selection state. */
     setSelectedMonth: Dispatch<SetStateAction<CalendarContextCommonProps["selectedMonth"]>>;
-    /**
-     * The selected year. Used to determine what year is currently selected in the year button.
-     */
+    /** Year shown by the year control. */
     selectedYear: DateTime["year"];
-    /**
-     * The function to call when the selected year changes.
-     *
-     * @param year - The year that is selected.
-     */
+    /** Updates the year control and year-selection state. */
     setSelectedYear: Dispatch<SetStateAction<CalendarContextCommonProps["selectedYear"]>>;
-    /**
-     * The hovered date. Used to determine what date is currently hovered over.
-     */
+    /** Endpoint used to preview an incomplete range. */
     hoveredDate: DateTime;
+    /** Updates the pending range-preview endpoint. */
     setHoveredDate: Dispatch<SetStateAction<CalendarContextCommonProps["hoveredDate"] | undefined>>;
-    /**
-     * The default time zone to use for the calendar.
-     */
+    /** Zone used for parsing, comparison, and today. */
     defaultTimeZone: IanaZone;
-    /**
-     * The minimum date allowed.
-     */
+    /** Normalized earliest selectable date. */
     minDate: DateTime | null;
-    /**
-     * The maximum date allowed.
-     */
+    /** Normalized latest selectable date. */
     maxDate: DateTime | null;
-    /**
-     * The days of the week and dates that are unavailable.
-     */
+    /** Normalized recurring weekdays and individual dates excluded from selection. */
     unavailable: {
-        /**
-         * The specific dates that are unavailable.
-         */
+        /** Excluded ISO dates. */
         dates: Set<string>;
-        /**
-         * The days of the week that are unavailable.
-         */
+        /** Excluded Luxon weekday numbers. */
         daysOfWeek: Set<number>;
     };
-    /**
-     * The locale to use for the calendar.
-     */
+    /** Locale for visible and accessible date labels. */
     locale: Exclude<CalendarProps["locale"], undefined>;
-    /**
-     * The id of the calendar.
-     */
+    /** Prefix for day-cell IDs and focus lookup. */
     id: string;
-    /**
-     * The date format to use for the calendar.
-     */
+    /** Format shared by day labels and range announcements. */
     dateFormat: Intl.DateTimeFormatOptions;
-    /**
-     * The day of the week to start the calendar on.
-     */
+    /** First column in each rendered week. */
     startDay: "Sunday" | "Monday";
-    /**
-     * Whether the calendar is controlled.
-     */
+    /** Prevents internal selection updates when the value is controlled. */
     controlled?: boolean;
-    /**
-     * The date metadata to determine if a date has a pip associated with it.
-     */
+    /** Accessible metadata and pip content keyed by ISO date. */
     dateMetadata?: Map<string, string>;
 };
 export type CalendarSingleContextProps = CalendarContextCommonProps & {
-    /**
-     * The value of the calendar.
-     */
+    /** Normalized single-date selection. */
     value: DateTime | null;
-    /**
-     * The function to call when the value changes.
-     */
+    /** Updates the internal single-date selection. */
     setValue: Dispatch<SetStateAction<CalendarSingleContextProps["value"]>>;
-    /**
-     * The function to call when the selection changes.
-     *
-     * @param data - The data to pass to the function.
-     */
+    /** Notifies the consumer after a single-date selection changes. */
     onSelection?: (data: {
         value: CalendarValue;
     }) => void;
-    /**
-     * Whether the calendar is in range mode.
-     */
+    /** Identifies single-date context. */
     range?: false;
 };
 export type CalendarRangeContextProps = CalendarContextCommonProps & {
-    /**
-     * The value of the calendar.
-     */
+    /** Normalized range selection; `end` may be absent while incomplete. */
     value: {
         start?: DateTime | null;
         end?: DateTime | null;
     };
-    /**
-     * The function to call when the value changes.
-     */
+    /** Updates the internal range selection. */
     setValue: Dispatch<SetStateAction<CalendarRangeContextProps["value"]>>;
-    /**
-     * The function to call when the selection changes.
-     *
-     * @param data - The data to pass to the function.
-     */
+    /** Notifies the consumer after either endpoint changes. */
     onSelection?: (data: {
         value: CalendarRangeValue;
     }) => void;
-    /**
-     * Whether the calendar is in range mode.
-     */
+    /** Identifies range context. */
     range: true;
 };
+/** State shared by Calendar's single-date and range subcomponents. */
 export type CalendarContextProps = CalendarSingleContextProps | CalendarRangeContextProps;
-/**
- * The context for the calendar.
- */
+/** Context consumed by Calendar's compound subcomponents. */
 export declare const CalendarContext: import('react').Context<CalendarContextProps | null>;
-/**
- * A hook to access the calendar context.
- *
- * @returns The calendar context.
- */
+/** Returns Calendar state or throws when called outside a Calendar. */
 export declare function useCalendar(): CalendarContextProps;
 export {};

package/dist/src/components/Calendar/CalendarMonth.d.ts

@@ -1,9 +1,4 @@
 import { ComponentPropsWithoutRef } from 'react';
 export type CalendarMonthProps = ComponentPropsWithoutRef<"table">;
-/**
- * A component that displays a month in the calendar.
- *
- * @param props - The props for the table element.
- * @returns A component that displays a month in the calendar.
- */
+/** Month grid for the active Calendar view. */
 export declare const CalendarMonth: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').TableHTMLAttributes<HTMLTableElement>, HTMLTableElement>, "ref"> & import('react').RefAttributes<HTMLTableElement>>;

package/dist/src/components/Calendar/CalendarMonthButton.d.ts

@@ -1,16 +1,7 @@
 import { ButtonProps } from '../Button';
 export type CalendarMonthButtonProps = ButtonProps & {
-    /**
-     * The current selection state of the calendar.
-     */
+    /** Controls whether the chevron indicates that month selection is open. */
     calendarSelectionState: "day" | "month" | "year";
 };
-/**
- * A button that displays the current month and allows the user to select a different month.
- *
- * @param props.calendarSelectionState - The current selection state of the calendar.
- * @param props.onClick - The function to call when the button is clicked.
- * @param props - The rest of the props for the Button component.
- * @returns A button that displays the current month and allows the user to select a different month.
- */
+/** Displays the active month and toggles Calendar's month-selection view. */
 export declare const CalendarMonthButton: import('react').ForwardRefExoticComponent<CalendarMonthButtonProps & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Calendar/CalendarNextButton.d.ts

@@ -1,11 +1,4 @@
 import { ButtonProps } from '../Button';
 export type CalendarNextProps = ButtonProps;
-/**
- * A button that displays the next month and allows the user to select a different month.
- *
- * @param props.onClick - The function to call when the button is clicked.
- * @param props.className - The class name to apply to the button.
- * @param props - The rest of the props for the Button component.
- * @returns A button that displays the next month and allows the user to select a different month.
- */
+/** Moves Calendar to the next month while respecting `maxDate`. */
 export declare const CalendarNext: import('react').ForwardRefExoticComponent<ButtonProps & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Calendar/CalendarNowButton.d.ts

@@ -1,22 +1,15 @@
 import { ButtonProps } from '../Button';
 import { MouseEvent, MouseEventHandler } from 'react';
 export type CalendarNowProps = {
-    /**
-     * @deprecated This is overridden internally
-     */
+    /** @deprecated Ignored. Use `onClickFixed` instead. */
     onClick?: (e: MouseEvent<HTMLButtonElement>, date: string | null) => void;
+    /** Called before Calendar navigates to and selects today. */
     onClickFixed?: MouseEventHandler<HTMLButtonElement> | undefined;
 } & Omit<ButtonProps, "onClick">;
-/**
- * A button that displays the current date and allows the user to select it.
- *
- * @param props - The rest of the props for the Button component.
- * @returns A button that displays the current date and allows the user to select it.
- */
+/** Moves today into view and selects it or applies it as the next range endpoint. */
 export declare const CalendarNow: import('react').ForwardRefExoticComponent<{
-    /**
-     * @deprecated This is overridden internally
-     */
+    /** @deprecated Ignored. Use `onClickFixed` instead. */
     onClick?: (e: MouseEvent<HTMLButtonElement>, date: string | null) => void;
+    /** Called before Calendar navigates to and selects today. */
     onClickFixed?: MouseEventHandler<HTMLButtonElement> | undefined;
 } & Omit<ButtonProps, "onClick"> & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Calendar/CalendarPrevButton.d.ts

@@ -1,11 +1,4 @@
 import { ButtonProps } from '../Button';
 export type CalendarPrevProps = ButtonProps;
-/**
- * A button that displays the previous month and allows the user to select a different month.
- *
- * @param props.onClick - The function to call when the button is clicked.
- * @param props.className - The class name to apply to the button.
- * @param props - The rest of the props for the Button component.
- * @returns A button that displays the previous month and allows the user to select a different month.
- */
+/** Moves Calendar to the previous month while respecting `minDate`. */
 export declare const CalendarPrev: import('react').ForwardRefExoticComponent<ButtonProps & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Calendar/CalendarYearButton.d.ts

@@ -1,15 +1,7 @@
 import { ButtonProps } from '../Button';
 export type CalendarYearButtonProps = ButtonProps & {
-    /**
-     * The current selection state of the calendar.
-     */
+    /** Controls whether the chevron indicates that year selection is open. */
     calendarSelectionState: "day" | "month" | "year";
 };
-/**
- * A button that displays the current year and allows the user to select a different year.
- *
- * @param props.calendarSelectionState - The current selection state of the calendar.
- * @param props - The rest of the props for the Button component.
- * @returns A button that displays the current year and allows the user to select a different year.
- */
+/** Displays the active year and toggles Calendar's year-selection view. */
 export declare const CalendarYearButton: import('react').ForwardRefExoticComponent<CalendarYearButtonProps & import('react').RefAttributes<HTMLButtonElement>>;