@servicetitan/anvil2 3.14.0 → 3.15.0

package/dist/src/components/TimeField/internal/constants.d.ts

@@ -1,25 +1,15 @@
 import { TimeFormat } from './types';
 export declare const TIME_CONSTANTS: {
-    /** Minutes in a full day (24 hours * 60 minutes) */
     readonly MINUTES_IN_DAY: 1440;
-    /** Maximum hour in 24-hour format */
     readonly MAX_HOUR_24: 23;
-    /** Maximum minute value */
     readonly MAX_MINUTE: 59;
-    /** Timeout in milliseconds for input debouncing */
+    /** Delay before treating Maskito input as finished so an external `selectedTime` can apply. */
     readonly INPUT_DEBOUNCE_TIMEOUT: 100;
 };
 export declare const FORMAT_CONSTANTS: {
-    /** 12-hour time format */
     readonly TWELVE_HOUR: 12;
-    /** 24-hour time format */
     readonly TWENTY_FOUR_HOUR: 24;
 };
-/**
- * Placeholder strings for different time formats.
- */
+/** Mask placeholders keyed by {@link TimeFormat}. */
 export declare const TIME_FORMAT_PLACEHOLDERS: Record<TimeFormat, string>;
-/**
- * Clock icon used as prefix in the time input field.
- */
 export declare const CLOCK_ICON: import('react').FC<import('react').SVGProps<SVGSVGElement>>;

package/dist/src/components/TimeField/internal/maskito/timePlaceholderMask.d.ts

@@ -1,17 +1,5 @@
 import { TimeFormat } from '../types';
-/**
- * Creates Maskito options for time input with placeholder support.
- *
- * Features:
- * - Time-specific masking for 12/24 hour formats
- * - Placeholder character support
- * - Filtered preprocessors to avoid conflicts
- * - Combined plugins and postprocessors
- *
- * @param format - The time format (12 or 24 hour)
- * @param placeholder - The placeholder string to use
- * @returns Object containing Maskito options and removePlaceholder function
- */
+/** Builds Maskito time options with a persistent placeholder. Stepping stays off. */
 declare const timePlaceholderMask: ({ format, placeholder, }: {
     format: TimeFormat;
     placeholder: string;

package/dist/src/components/TimeField/internal/types.d.ts

@@ -1,27 +1,22 @@
-/**
- * Time format options for the TimeField component.
- */
+/** Clock display: 12-hour with AM/PM, or 24-hour. */
 export type TimeFormat = 12 | 24;
 /**
- * Change event data for TimeField onChange callback.
+ * `onChange` payload. Completeness and min/max share `isInputValid`;
+ * `step` / `autoround` are not part of that flag.
  */
 export interface TimeFieldChange {
     /**
-     * The time in HH:mm format (24-hour) or hh:mm a format (12-hour).
-     * @example "14:30" or "02:30 PM"
+     * Parsed time in the field's `format`, or `null` when empty or unparseable.
+     * 12-hour values look like `02:30 PM`; 24-hour like `14:30`.
      */
     time: string | null;
     /**
-     * Whether the input is valid. That is, it matches the format and is not empty.
-     * This does not mean that the time is valid according to the constraints.
+     * Whether the text is a complete time that also satisfies `min`/`max`.
+     * Independent of `step` / `autoround`.
      */
     isInputValid: boolean;
-    /**
-     * Whether the input is empty.
-     */
+    /** Whether no time digits remain after removing the mask placeholder. */
     isInputEmpty: boolean;
 }
-/**
- * Callback function type for TimeField onChange events.
- */
+/** Receives the current time and input completeness. */
 export type TimeFieldChangeHandler = (change: TimeFieldChange) => void;

package/dist/src/components/TimeField/internal/utils/timeFormatting.d.ts

@@ -1,10 +1,3 @@
 import { TimeFormat } from '../types';
-/**
- * Converts hours and minutes to a formatted time string.
- *
- * @param hours - Hours (0-23)
- * @param minutes - Minutes (0-59)
- * @param format - Target format (12 or 24 hour)
- * @returns Formatted time string
- */
+/** Formats 0–23 hours into 12-hour (`02:30 PM`) or 24-hour (`14:30`) text. `24:00` becomes midnight. */
 export declare function formatTimeString(hours: number, minutes: number, format: TimeFormat): string;

package/dist/src/components/TimeField/internal/utils/timeOptions.d.ts

@@ -1,24 +1,10 @@
 import { TimeFormat } from '../types';
-/**
- * Generates time options for the dropdown based on step, min/max constraints, and format.
- *
- * @param step - Time increment in minutes (default 30)
- * @param min - Minimum allowed time as string
- * @param max - Maximum allowed time as string
- * @param format - Time format (12 or 24 hour)
- * @returns Array of time options formatted as strings
- */
+/** Step-aligned times between `min` and `max`, formatted for the current clock. */
 export declare function generateTimeOptions({ step, min, max, format, }: {
     step?: number;
     min?: string;
     max?: string;
     format: TimeFormat;
 }): string[];
-/**
- * Filters time options based on user input.
- *
- * @param options - Array of available time options
- * @param userInput - The current user input (after Maskito processing)
- * @returns Filtered array of matching options
- */
+/** Prefix-matches options against typed text after stripping mask punctuation. */
 export declare function filterTimeOptions(options: string[], userInput: string): string[];

package/dist/src/components/TimeField/internal/utils/timeParsing.d.ts

@@ -1,37 +1,11 @@
 import { TimeFormat } from '../types';
-/**
- * Maximum hour value for 24-hour format.
- */
 export declare const MAX_HOUR: 23;
-/**
- * Maximum minute value.
- */
 export declare const MAX_MINUTE: 59;
-/**
- * Converts a time string to total minutes since midnight.
- *
- * @param timeStr - Time string in HH:mm format (24-hour)
- * @returns Total minutes since midnight
- */
+/** Minutes since midnight. Failed parses and midnight (`00:00` / `12:00 AM`) both return `0`. */
 export declare const timeToMinutes: (timeStr: string) => number;
-/**
- * Converts a time string between 12-hour and 24-hour formats.
- *
- * @param time - Time string to convert
- * @param targetFormat - Target format (12 or 24)
- * @returns Converted time string
- */
+/** Rewrites a time string into 12-hour or 24-hour display. Unparsed input is returned unchanged. */
 export declare function convertTimeFormat(time: string, targetFormat: TimeFormat): string;
-/**
- * Parses input value and converts it to a time string with validation.
- *
- * @param value - The raw input value (may contain placeholders)
- * @param format - The time format (12 or 24 hour)
- * @param removePlaceholder - Function to remove placeholder characters
- * @param min - Minimum allowed time constraint
- * @param max - Maximum allowed time constraint
- * @returns Object containing parsed time string, validation state, and empty state
- */
+/** Parses masked text into a complete time; min/max failures report as invalid, not a separate flag. */
 export declare function parseInputValue(value: string, format: TimeFormat, removePlaceholder: (value: string) => string, min?: string, max?: string): {
     time: null;
     isInputValid: boolean;

package/dist/src/components/TimeField/internal/utils/timeRounding.d.ts

@@ -1,58 +1,16 @@
 import { TimeFormat } from '../types';
-/**
- * Options for auto-rounding functionality.
- */
 export interface AutoRoundingOptions {
-    /** Whether auto-rounding is enabled. */
     autoround: boolean;
-    /** Time increment in minutes. */
     step?: number;
-    /** Time format (12 or 24 hour). */
     format: TimeFormat;
 }
-/**
- * Gets the next future step for a given time based on the step increment.
- *
- * @param time - The current time string
- * @param step - The step increment in minutes
- * @param format - The time format (12 or 24 hour)
- * @returns The next step time string
- */
+/** Next `step` at or after `time`. A missing or non-positive step returns `time`. */
 export declare function getNextFutureStep(time: string, step: number, format: TimeFormat): string;
-/**
- * Handles auto-rounding of time values based on step intervals.
- *
- * @param time - The time to potentially auto-round
- * @param options - Auto-rounding configuration options
- * @returns The rounded time or the original time if no rounding is needed
- */
+/** Snaps off-step times up to the next `step` when `autoround` is on. */
 export declare function handleAutoRounding(time: string | null, options: AutoRoundingOptions): string | null;
-/**
- * Generates AM/PM variants for 12-hour format auto-rounding when user hasn't specified AM/PM.
- *
- * @param currentTime - The current time string
- * @param step - Step increment in minutes
- * @param inputValue - Original user input to check for AM/PM specification
- * @returns Array of time options (AM only, PM only, or both)
- */
+/** Next-step suggestions for 12-hour input: both AM and PM unless the text already names one. */
 export declare function generateAmPmVariants(currentTime: string, step: number, inputValue: string): string[];
-/**
- * Tries to generate PM interpretation options for ambiguous input.
- *
- * @param currentTime - The current time string
- * @param step - Step increment in minutes
- * @param inputValue - Original user input
- * @returns Array of PM time options or empty array
- */
+/** PM next-step when 12-hour text has no period and the AM parse is not a valid time. */
 export declare function generatePmInterpretation(currentTime: string, step: number, inputValue: string): string[];
-/**
- * Gets auto-rounding options for dropdown suggestions when no matches are found.
- *
- * @param currentTime - The current parsed time
- * @param step - Step increment in minutes
- * @param format - Time format (12 or 24 hour)
- * @param inputValue - Original user input
- * @param min - Minimum time constraint
- * @returns Array of auto-rounded time options
- */
+/** Next-step suggestion rows, including 12-hour AM/PM variants when `min` is unset. */
 export declare function getAutoRoundingOptions(currentTime: string | null, step: number, format: TimeFormat, inputValue: string, min?: string): string[];

package/dist/src/components/TimeField/internal/utils/timeValidation.d.ts

@@ -1,28 +1,10 @@
 import { TimeFormat } from '../types';
-/**
- * Checks if a time aligns with a given step interval.
- *
- * @param time - The time to check
- * @param step - The step increment in minutes
- * @returns True if the time aligns with the step
- */
+/** Whether `time` falls on a `step` boundary. A missing or non-positive step always passes. */
 export declare function isTimeOnStep(time: string, step: number): boolean;
-/**
- * Checks if a time is valid (exists and can be parsed).
- *
- * @param time - The time to check
- * @returns True if the time is valid
- */
+/** True when `timeToMinutes` is positive, or the string is exactly `00:00`. */
 export declare function isValidTime(time: string | null): boolean;
 /**
- * Checks if a partial input might become valid as the user continues typing.
- * For example, "1" in a 10-11 AM range could become "10:00 AM" or "11:00 AM".
- * Or "2" in a 20:00-23:00 range could become "20:00", "21:00", etc.
- *
- * @param inputValue - The current input value (may include mask characters)
- * @param format - The time format (12 or 24 hour)
- * @param min - Minimum allowed time constraint
- * @param max - Maximum allowed time constraint
- * @returns True if the partial input could potentially become valid
+ * Whether a still-incomplete value could finish inside `min`/`max`.
+ * Only inspects a single typed digit, and only when both bounds are set.
  */
 export declare function isPartialInputPotentiallyValid(inputValue: string, format: TimeFormat, min?: string, max?: string): boolean;

package/dist/src/components/Toast/Toaster.d.ts

@@ -1,46 +1,8 @@
 import { ToasterProps as BaseToasterProps } from './internal/Toaster';
-/**
- * Props for the Toaster component
- * @property {number | false} [duration] - Timeout, in ms, before toasts auto-closes. If set to false, toasts will not auto-close
- * @property {string} id - Unique toaster id
- * @property {(toastEvent: ToastEventType) => void} [onToastEvent] - Callback function that is called when toasts are added, updated, or dismissed
- * @property {string} [focusKey] - How a screen-reader will announce the hotkey used to set focus on the first toast
- * @property {number} [toastsBeforeStack] - How many toasts to display before they start stacking
- * @extends Omit<BaseToasterProps, "disableEvents" | "onToastCountChange">
- */
 export type ToasterProps = Omit<BaseToasterProps, "disableEvents" | "onToastCountChange">;
 /**
- * Toaster component for managing and displaying toast notifications with anvil2-specific features.
- *
- * Features:
- * - Manages multiple toast notifications in a stack
- * - Handles toast positioning and stacking behavior
- * - Supports custom events for toast management
- * - Automatic toast dismissal with configurable duration
- * - Keyboard navigation and accessibility support
- * - Dialog-aware positioning for modal contexts
- * - Session storage for dialog toaster state
- * - Custom event system for toast lifecycle management
- * - Responsive design with mobile support
- * - Automatic tracking ID generation for analytics
- * - Monolith toaster integration and coordination
- * - Shadow DOM support for micro-frontend environments
- * - A1 toast group compatibility and positioning
- *
- * @example
- * <Toaster
- *   id="main-toaster"
- *   duration={5000}
- *   toastsBeforeStack={3}
- *   onToastEvent={(event) => console.log('Toast event:', event)}
- * />
- *
- * @example
- * <Toaster
- *   id="dialog-toaster"
- *   disableEvents={false}
- *   focusKey="t"
- * />
+ * Displays notifications dispatched through {@link toast}. The first toaster
+ * in each document or shadow root handles shared toast events.
  */
 export declare const Toaster: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & Omit<import('./internal/ToastStack').ToastStackProps, "toasts"> & {
     disableEvents?: boolean;

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

@@ -2,110 +2,49 @@ import { AlertProps } from '../../Alert';
 import { ButtonProps } from '../../Button';
 import { ProgressBarProps } from '../../ProgressBar';
 type ToastAction = Pick<ButtonProps, "appearance" | "onClick"> & {
+    /** Visible button text. */
     label: string;
 };
-/**
- * Props for the Toast component
- * @extends ComponentPropsWithoutRef<"div">
- */
 export type ToastProps = {
-    /**
-     * Action buttons to display in the toast
-     */
+    /** One required and one optional action; providing actions disables auto-dismiss. */
     actions?: {
         primary: ToastAction;
         secondary?: ToastAction;
     };
-    /**
-     * CSS class name for the toast container
-     */
+    /** Extra classes on the positioning wrapper, not the alert. */
     containerClassName?: string;
-    /**
-     * Duration in milliseconds before auto-dismiss. Set to false to disable auto-dismiss
-     */
+    /** Overrides the toaster timeout; `false` keeps the toast open. */
     duration?: number | false;
-    /**
-     * Additional message content to display below the title
-     */
+    /** Optional detail rendered below the title. */
     message?: string;
-    /**
-     * Callback function called when toast is dismissed, expired, or closed
-     */
+    /** Runs whenever the toast is removed, regardless of the dismissal path. */
     onDismiss?: () => void;
-    /**
-     * Progress bar value or indeterminate state
-     */
+    /** Shows determinate progress or an indeterminate loading bar. */
     progress?: ProgressBarProps["value"] | "indeterminate";
-    /**
-     * CSS class name for the toast element
-     */
+    /** Extra classes on the alert, not the positioning wrapper. */
     toastClassName?: string;
     /**
      * When set, displays the AI mark inline after the toast title.
      * Use `true` for the sparkle only, or pass tooltip/popover configuration.
      */
     aiMark?: AlertProps["aiMark"];
-    /**
-     * Unique identifier for the toast
-     */
+    /** Generated by status-specific toast methods and used for updates or dismissal. */
     id: string;
     /**
-     * This is only run when the "x" button is triggered on the toast.
-     * To run a callback when the toast is closed, expired, or dismissed,
-     * use the `onDismiss` parameter instead.
+     * Runs only from the close button. Use `onDismiss` to observe every removal
+     * path.
      */
     onClose?: AlertProps["onClose"];
-    /**
-     * Visual status of the toast (info, success, warning, danger)
-     */
+    /** Determines the alert treatment and status icon. */
     status: AlertProps["status"];
-    /**
-     * Title text displayed in the toast
-     */
+    /** Rendered as the notification heading. */
     title: string;
-    /**
-     * Timestamp when the toast was created (internal use)
-     */
     createdAt?: number;
-    /**
-     * Position index of the toast in the stack (internal use)
-     */
     index?: number;
-    /**
-     * Whether the toast is below the stack index (internal use)
-     */
     isBelowStackIndex?: boolean;
-    /**
-     * Whether the toast is currently stacked (internal use)
-     */
     isStacked?: boolean;
-    /**
-     * Pause status for hover interactions (internal use)
-     */
     pausedStatus?: number | "resumed";
 };
-/**
- * Toast component for displaying temporary notifications to users.
- *
- * Features:
- * - Supports different visual styles (info, success, warning, danger)
- * - Auto-dismiss with configurable duration
- * - Optional action buttons for user interaction
- * - Progress bar support for loading states
- * - Swipe gestures for dismissal
- * - Stacking behavior for multiple toasts
- * - Pause on hover functionality
- * - Accessible with proper ARIA roles
- * - Smooth animations and transitions
- *
- * @example
- * <Toast
- *   id="toast-1"
- *   status="success"
- *   title="Success!"
- *   message="Your changes have been saved."
- *   duration={5000}
- * />
- */
+/** Renders one alert within a toast stack. */
 export declare const Toast: import('react').ForwardRefExoticComponent<ToastProps & import('react').RefAttributes<HTMLDivElement>>;
 export {};

package/dist/src/components/Toast/internal/ToastProvider.d.ts

@@ -1,90 +1,28 @@
 import { Dispatch, FC, PropsWithChildren, SetStateAction } from 'react';
 import { ToastProps } from './Toast';
-/**
- * Props for the ToastProvider component
- * @extends PropsWithChildren
- */
 export type ToastProviderProps = PropsWithChildren<{
-    /**
-     * Whether this toaster is used within a dialog context
-     * @default false
-     */
+    /** Coordinates top-layer ordering for a toaster inside a dialog. Defaults to `false`. */
     isDialogToaster?: boolean;
 }>;
-/**
- * Context properties for the ToastProvider
- */
 export type ToastProviderContextProps = {
-    /**
-     * Array of active toast notifications
-     */
     toasts: ToastProps[];
-    /**
-     * Function to update the toast array
-     */
     setToasts: Dispatch<SetStateAction<ToastProps[]>>;
-    /**
-     * Array of toast height measurements
-     */
     toastHeights: {
         id: string;
         height: number;
     }[];
-    /**
-     * Function to update toast heights
-     */
     setToastHeights: Dispatch<SetStateAction<ToastProviderContextProps["toastHeights"]>>;
-    /**
-     * Function to calculate the total height of the toast stack
-     */
     getToastStackHeight: (index?: number) => number;
-    /**
-     * Number of toasts to display before stacking
-     */
     toastsBeforeStack: number;
-    /**
-     * Function to update the number of toasts before stacking
-     */
     setToastsBeforeStack: Dispatch<SetStateAction<number>>;
-    /**
-     * Whether extra toasts are currently visible
-     */
     extraToastsVisible: boolean;
-    /**
-     * Function to update the visibility of extra toasts
-     */
     setExtraToastsVisible: Dispatch<SetStateAction<boolean>>;
-    /**
-     * Whether this toaster is used within a dialog context
-     */
     isDialogToaster: boolean;
 };
-/**
- * Context for managing toast state and operations
- */
 export declare const ToastProviderContext: import('react').Context<ToastProviderContextProps>;
-/**
- * Global reference to toast state setters for external access
- */
 export declare const getSetToasts: {
     setToasts: ToastProviderContextProps["setToasts"];
     setToastHeights: ToastProviderContextProps["setToastHeights"];
 };
-/**
- * ToastProvider component for managing toast state and context.
- *
- * Features:
- * - Manages toast state and lifecycle
- * - Handles toast height tracking for positioning
- * - Provides stacking behavior configuration
- * - Supports dialog toaster mode
- * - Automatic duplicate toast detection and removal
- * - Context-based state management
- * - Height calculation utilities for positioning
- *
- * @example
- * <ToastProvider isDialogToaster={false}>
- *   <Toaster id="main-toaster" />
- * </ToastProvider>
- */
+/** Owns notification state and measurements for one toaster. */
 export declare const ToastProvider: FC<ToastProviderProps>;

package/dist/src/components/Toast/internal/ToastStack.d.ts

@@ -1,81 +1,35 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { ToastProps } from './Toast';
-/**
- * Props for the ToastStack component
- * @extends ComponentPropsWithoutRef<"div">
- */
 export type ToastStackProps = Omit<ComponentPropsWithoutRef<"div">, "children"> & {
     /**
-     * Duration of the toast in milliseconds. If set to `false`, the toast will not auto-dismiss.
-     * If `actions` are provided in the toast method, this prop will be ignored and treated as `false`.
-     * @default false
+     * Auto-dismiss timeout shared by the stack. Actionable toasts ignore it.
+     * Defaults to `false`.
      */
     duration?: number | false;
     /**
-     * How a screen-reader will announce the hotkey used to set focus on the first toast.
-     * @default "t"
+     * Shortcut that expands the stack, focuses its first toast, and is named in
+     * the live region. Defaults to `"t"`.
      */
     focusKey?: string;
-    /**
-     * How many toasts to display before they start stacking.
-     * @default 3
-     */
+    /** Number of newest toasts shown before older ones stack. Defaults to `3`. */
     toastsBeforeStack?: number;
-    /**
-     * The toasts to display in the stack.
-     * @default []
-     */
+    /** Ordered toast entries managed by the provider. */
     toasts: ToastProps[];
 };
-/**
- * ToastStack component for displaying a stack of toast notifications.
- *
- * Features:
- * - Displays multiple toasts in a vertical stack
- * - Automatic stacking behavior when toast count exceeds limit
- * - Show more button to expand stacked toasts
- * - Keyboard navigation with hotkey support
- * - Hover pause functionality for toast timers
- * - Smooth animations and transitions
- * - Accessibility features with screen reader support
- * - Responsive design with mobile touch support
- * - Focus management for keyboard users
- *
- * @example
- * <ToastStack
- *   toasts={toastList}
- *   duration={5000}
- *   toastsBeforeStack={3}
- *   focusKey="t"
- * />
- *
- * @example
- * <ToastStack
- *   toasts={[toast1, toast2]}
- *   duration={false}
- *   toastsBeforeStack={5}
- * />
- */
+/** Positions, collapses, and manages focus for the active notifications. */
 export declare const ToastStack: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "children"> & {
     /**
-     * Duration of the toast in milliseconds. If set to `false`, the toast will not auto-dismiss.
-     * If `actions` are provided in the toast method, this prop will be ignored and treated as `false`.
-     * @default false
+     * Auto-dismiss timeout shared by the stack. Actionable toasts ignore it.
+     * Defaults to `false`.
      */
     duration?: number | false;
     /**
-     * How a screen-reader will announce the hotkey used to set focus on the first toast.
-     * @default "t"
+     * Shortcut that expands the stack, focuses its first toast, and is named in
+     * the live region. Defaults to `"t"`.
      */
     focusKey?: string;
-    /**
-     * How many toasts to display before they start stacking.
-     * @default 3
-     */
+    /** Number of newest toasts shown before older ones stack. Defaults to `3`. */
     toastsBeforeStack?: number;
-    /**
-     * The toasts to display in the stack.
-     * @default []
-     */
+    /** Ordered toast entries managed by the provider. */
     toasts: ToastProps[];
 } & import('react').RefAttributes<HTMLDivElement>>;