@servicetitan/anvil2 3.14.1 → 3.15.1

package/dist/src/beta/components/FilterBar/internal/types.d.ts

@@ -6,58 +6,50 @@ import { MultiSelectMenuOption, MultiSelectMenuProps, MultiSelectMenuSyncProps }
 import { TreeSelectMenuProps, TreeSelectMenuSyncProps, TreeSelectMenuValue } from '../../TreeSelectMenu';
 import { DistributiveOmit } from '../../../../types';
 /**
- * Base properties shared by all filter types
+ * Identity, label, and placement shared by every filter variant.
  */
 export type BaseFilter = {
-    /** Unique identifier for the filter */
+    /** Stable identity used to merge and update filter state. */
     id: string;
-    /** Display label for the filter */
+    /** Trigger text and drawer heading. */
     label: string;
-    /** When true, the filter is only reachable via the drawer and never rendered inline in the toolbar */
+    /** When true, the filter is only reachable via the drawer. */
     drawerOnly?: boolean;
 };
-/**
- * Built-in boolean filter type
- * Used for simple true/false filtering
- */
+/** On/off toggle filter. */
 export type BooleanFilter = BaseFilter & {
-    /** Identifies this as a boolean filter */
+    /** Uses toggle controls in both the toolbar and drawer. */
     type: "boolean";
-    /** Current state of the boolean filter */
+    /** Whether the toggle is on. */
     checked: boolean;
 };
-/**
- * Props passed to custom filter render functions
- */
+/** State supplied to a custom filter's render function. */
 export type FilterRenderProps<T = unknown> = {
-    /** Current value of the filter */
+    /** Value for the active popover or drawer surface. */
     value?: T;
-    /** Callback to update the filter value */
+    /** Updates the active surface's draft or committed value. */
     onChange: (value?: T) => void;
 };
 type CustomFilterShared<T> = BaseFilter & {
-    /** Identifies this as a custom filter */
+    /** Uses consumer render functions for both filter surfaces. */
     type: "custom";
-    /** Function to render the filter content in the drawer */
+    /** Drawer cell body. */
     drawerRender: (props: FilterRenderProps<T>) => ReactNode;
-    /** Current value of the custom filter */
+    /** Committed value; omit to leave the filter inactive. */
     value?: T;
-    /** Optional number to display in a label chip */
+    /** Count Chip after the trigger label. Omitted or `0` hides the chip. */
     labelChipCount?: number;
 };
 /**
- * Custom filter type allowing for complex filter implementations.
- *
- * `buttonRender` is required for filters that can appear inline in the
- * toolbar, and forbidden when `drawerOnly: true` since the filter never
- * renders inline.
+ * Consumer-rendered filter. `buttonRender` is required when the filter can
+ * appear inline, and forbidden when `drawerOnly: true`.
  */
 export type CustomFilter<T = unknown> = (CustomFilterShared<T> & {
     drawerOnly: true;
     buttonRender?: never;
 }) | (CustomFilterShared<T> & {
     drawerOnly?: false;
-    /** Function to render the filter content in the button/popover */
+    /** Popover body for the inline trigger. */
     buttonRender: (props: FilterRenderProps<T>) => ReactNode;
 });
 /**
@@ -73,9 +65,9 @@ export type CustomFilter<T = unknown> = (CustomFilterShared<T> & {
  * FilterBar and the singleSelect adapter — consumers don't pass them.
  */
 export type SingleSelectFilter = BaseFilter & {
-    /** Identifies this as a single select filter */
+    /** Uses the provided synchronous options on both filter surfaces. */
     type: "singleSelect";
-    /** Currently selected option */
+    /** Committed selection; omit to leave the filter inactive. */
     selectedOption?: SelectMenuOption;
     /**
      * When true, the drawer cell renders a Radio.Group over the full option set
@@ -91,9 +83,9 @@ export type SingleSelectFilter = BaseFilter & {
  * (boolean | { label }) — click handling and check state are managed automatically.
  */
 export type MultiSelectFilter = BaseFilter & {
-    /** Identifies this as a multi select filter */
+    /** Uses the provided synchronous options with multi-selection controls. */
     type: "multiSelect";
-    /** Currently selected options */
+    /** Committed selections; omit or pass an empty array when inactive. */
     selectedOptions?: MultiSelectMenuOption[];
     /**
      * When true, the drawer cell renders a Checkbox.Group over the full option
@@ -136,6 +128,7 @@ export type DateRangeFilterErrorContext = {
  * message on the field. Provide `getErrorMessage` to override the default copy.
  */
 export type DateFilter = BaseFilter & Pick<DateFieldSingleProps, "value" | "mode" | "minDate" | "maxDate" | "unavailable"> & {
+    /** Uses a single-date picker on both filter surfaces. */
     type: "date";
     /**
      * Override the error message shown when a typed value violates a
@@ -154,6 +147,7 @@ export type DateFilter = BaseFilter & Pick<DateFieldSingleProps, "value" | "mode
  * message on the field. Provide `getErrorMessage` to override the default copy.
  */
 export type DateRangeFilter = BaseFilter & Pick<DateFieldRangeProps, "value" | "mode" | "minDate" | "maxDate" | "unavailable"> & {
+    /** Uses a date-range picker on both filter surfaces. */
     type: "dateRange";
     /**
      * Override the error message shown when a typed value violates a
@@ -174,9 +168,9 @@ export type DateListLibraryOptionId = "on" | "before" | "after" | "customRange";
  * of the reserved `DateListLibraryOptionId` ids.
  */
 export type DateListOption = {
-    /** Unique identifier for the option */
+    /** Stable identity. Consumer options must not use a reserved library id. */
     id: string;
-    /** Display label for the option */
+    /** Text shown in the options menu. */
     label: string;
     /**
      * Concrete value the option resolves to: an ISO date string, a date range,
@@ -204,7 +198,7 @@ export type DateListCustomRangeConfig = Pick<DateFieldRangeProps, "minDate" | "m
  * allowed, but surfaces an error message on the field.
  */
 export type DateListFilter = BaseFilter & Pick<DateFieldSingleProps, "mode"> & {
-    /** Identifies this as a date list filter */
+    /** Adds the built-in date operations after the consumer's options. */
     type: "dateList";
     /** Consumer-supplied options. Library options are auto-rendered below. */
     options: DateListOption[];
@@ -237,9 +231,9 @@ export type DateListFilter = BaseFilter & Pick<DateFieldSingleProps, "mode"> & {
  * FilterBar and the asyncSelect adapter — consumers don't pass them.
  */
 export type AsyncSelectFilter = BaseFilter & {
-    /** Identifies this as an async select filter */
+    /** Loads single-select options as the menu opens or search changes. */
     type: "asyncSelect";
-    /** The currently selected option */
+    /** Committed selection; omit to leave the filter inactive. */
     selectedOption?: SelectMenuOption;
 } & DistributiveOmit<SelectMenuProps, "id" | "label" | "value" | "onSelectedOptionChange" | "trigger" | "onMenuKeyDown" | "onImplicitClose" | "onExplicitClose" | "clear">;
 /**
@@ -255,9 +249,9 @@ export type AsyncSelectFilter = BaseFilter & {
  * FilterBar and the asyncMultiSelect adapter — consumers don't pass them.
  */
 export type AsyncMultiSelectFilter = BaseFilter & {
-    /** Identifies this as an async multi-select filter */
+    /** Loads multi-select options as the menu opens or search changes. */
     type: "asyncMultiSelect";
-    /** The currently selected options */
+    /** Committed selections; omit or pass an empty array when inactive. */
     selectedOptions?: MultiSelectMenuOption[];
 } & DistributiveOmit<MultiSelectMenuProps, "id" | "label" | "value" | "onSelectedOptionsChange" | "trigger" | "onMenuKeyDown" | "onImplicitClose" | "onExplicitClose" | "clear">;
 /**
@@ -281,17 +275,17 @@ export type NumericRangeValue = {
  *   `>`/`<`.
  */
 export type NumericRangeFilter = BaseFilter & {
-    /** Identifies this as a numeric range filter */
+    /** Uses paired minimum and maximum number fields. */
     type: "numericRange";
-    /** Current min/max value (or null when inactive) */
+    /** Committed bounds; `null` or two omitted bounds are inactive. */
     value?: NumericRangeValue;
-    /** Optional decorator mode applied to both inputs and the formatted label */
+    /** Applies currency or percentage formatting to both inputs and the label. */
     mode?: "currency" | "percentage";
-    /** Clamps entered values from below */
+    /** Lowest accepted value for either bound. */
     minValue?: number;
-    /** Clamps entered values from above */
+    /** Highest accepted value for either bound. */
     maxValue?: number;
-    /** When true, label uses ≥/≤ and Min/Max; otherwise >/< and Above/Below */
+    /** Uses inclusive labels and symbols. Defaults to exclusive bounds. */
     inclusiveBounds?: boolean;
     /** Increment for arrow-key / scroll adjustments on the NumberFields. */
     step?: number;
@@ -314,11 +308,11 @@ export type NumericRangeFilter = BaseFilter & {
     hideControls?: boolean;
 };
 type TextInputFilterShared = BaseFilter & {
-    /** Identifies this as a text input filter */
+    /** Uses a text field on both filter surfaces. */
     type: "textInput";
-    /** Current text value (undefined or empty means inactive) */
+    /** Committed text; `undefined` or an empty string is inactive. */
     value?: string;
-    /** Placeholder shown when the field is empty */
+    /** Hint shown while the field is empty. */
     placeholder?: string;
 };
 /**
@@ -356,11 +350,11 @@ export type TextInputFilter = (TextInputFilterShared & {
  * makes spatial sense at that position.
  */
 export type SearchFilter = BaseFilter & {
-    /** Identifies this as a search filter */
+    /** Uses an always-visible search field instead of a filter trigger. */
     type: "search";
-    /** Current text value (undefined or empty means inactive) */
+    /** Committed search text; `undefined` or an empty string is inactive. */
     value?: string;
-    /** Placeholder shown when the field is empty */
+    /** Hint shown while the search field is empty. */
     placeholder?: string;
 };
 /**
@@ -381,9 +375,9 @@ export type SearchFilter = BaseFilter & {
  * they commit immediately.
  */
 export type TreeFilter = BaseFilter & {
-    /** Identifies this as a tree filter */
+    /** Uses the provided synchronous tree on both filter surfaces. */
     type: "tree";
-    /** Currently selected tree node values */
+    /** Committed node values; omit or pass an empty array when inactive. */
     selectedNodes?: TreeSelectMenuValue[];
 } & DistributiveOmit<TreeSelectMenuSyncProps, "id" | "label" | "value" | "onSelectedOptionsChange" | "trigger" | "onMenuKeyDown" | "onImplicitClose" | "onExplicitClose">;
 /**
@@ -402,16 +396,13 @@ export type TreeFilter = BaseFilter & {
  * commit immediately.
  */
 export type AsyncTreeFilter = BaseFilter & {
-    /** Identifies this as an async tree filter */
+    /** Loads root and child nodes as the tree opens or expands. */
     type: "asyncTree";
-    /** Currently selected tree node values */
+    /** Committed node values; omit or pass an empty array when inactive. */
     selectedNodes?: TreeSelectMenuValue[];
 } & DistributiveOmit<TreeSelectMenuProps, "id" | "label" | "value" | "onSelectedOptionsChange" | "trigger" | "onMenuKeyDown" | "onImplicitClose" | "onExplicitClose">;
-/**
- * Union type of all available filter types
- * Uses unknown instead of any for better type safety
- */
+/** All FilterBar filter variants. */
 export type Filter = BooleanFilter | CustomFilter<any> | SingleSelectFilter | MultiSelectFilter | DateFilter | DateRangeFilter | DateListFilter | AsyncSelectFilter | AsyncMultiSelectFilter | TreeFilter | AsyncTreeFilter | NumericRangeFilter | TextInputFilter | SearchFilter;
-/** Type representing all possible filter values */
+/** Committed value shape for any {@link Filter}. */
 export type FilterValue = boolean | CustomFilter["value"] | SingleSelectFilter["selectedOption"] | MultiSelectFilter["selectedOptions"] | DateFilter["value"] | DateRangeFilter["value"] | DateListFilter["selectedOption"] | AsyncSelectFilter["selectedOption"] | AsyncMultiSelectFilter["selectedOptions"] | TreeFilter["selectedNodes"] | AsyncTreeFilter["selectedNodes"] | NumericRangeFilter["value"] | TextInputFilter["value"] | SearchFilter["value"];
 export {};

package/dist/src/beta/components/FilterBar/internal/utils/dateConstraints.d.ts

@@ -5,9 +5,9 @@ type RangeValue = {
     endDate: string | null;
 } | null;
 /**
- * Returns the first constraint a single ISO date violates, or `null` when the
- * value is empty, unparseable, or within all constraints. Mirrors the order of
- * `validateDate` (unavailable, then min, then max).
+ * First constraint a single ISO date violates, or `null` when the value is
+ * empty, unparseable, or within all constraints. Checks unavailable, min,
+ * then max.
  */
 export declare const getDateConstraintReason: (value: string | null | undefined, { minDate, maxDate, unavailable }: DateConstraints) => DateFilterErrorReason | null;
 /**

package/dist/src/beta/components/FilterBar/internal/utils/dateListLibraryOptions.d.ts

@@ -1,15 +1,12 @@
 import { DateListFilter, DateListLibraryOptionId, DateListOption } from '../types';
 /** Type guard for the four reserved library option ids. */
 export declare const isDateListLibraryOptionId: (id: string) => id is DateListLibraryOptionId;
-/** Label for a given library option id. */
+/** Ellipsis-free dialog title and committed label for a library option. */
 export declare const getDateListLibraryOptionLabel: (id: DateListLibraryOptionId) => string;
 /**
- * Full set of built-in default options available to dateList filters. All four
- * are shown below the consumer's options unless omitted via
- * `excludeDefaultOptions`. Used by FilterDateList (popover) and FilterDrawer
- * (drawer). The "…" suffix signals that picking the option opens a dialog;
- * once a date is committed, the bare label (without "…") is what gets stored
- * and shown in the filter trigger.
+ * Built-in date-list rows in display order. The "…" suffix signals that
+ * selection opens a dialog; committed options use the ellipsis-free label
+ * from {@link getDateListLibraryOptionLabel}.
  */
 export declare const dateListLibraryOptions: ReadonlyArray<{
     id: DateListLibraryOptionId;

package/dist/src/beta/components/FilterBar/internal/utils/filter-state.d.ts

@@ -1,33 +1,12 @@
 import { Filter, FilterValue } from '../types';
 export { hasChangedFilter } from './value-compare';
-/**
- * Returns an array of filters that are currently active (i.e., have a value set).
- */
 export declare const getActiveFilters: (filters: Filter[]) => Filter[];
-/**
- * Checks if any filters in the array have active values
- */
 export declare const checkActiveFilters: (filters: Filter[]) => boolean;
-/**
- * Resets all filters to their default state
- */
 export declare const resetFilters: (filters: Filter[]) => Filter[];
-/**
- * Updates a single filter in an array of filters
- */
 export declare const updateSingleFilter: (filters: Filter[], filterId: string, value: FilterValue) => Filter[];
-/**
- * Checks if the selection value of a filter has changed by comparing references.
- * Uses reference equality (===) to detect if the parent has provided a new value.
- */
+/** Uses reference equality to detect a parent-provided selection change. */
 export declare const hasFilterSelectionChanged: (existingFilter: Filter, newFilter: Filter) => boolean;
-/**
- * Preserves the selection state from an existing filter into a new filter.
- * Used when filter configuration updates but the selection value reference hasn't changed.
- */
+/** Keeps selection state when configuration changes without a new selection reference. */
 export declare const preserveFilterState: (newFilter: Filter, existingFilter: Filter) => Filter;
-/**
- * Creates a deep clone of filters with updated item references.
- * Ensures that selected items reference the current items array for proper equality checks.
- */
+/** Rebinds selected items to the current items array for equality checks. */
 export declare const cloneFiltersWithItemRefs: (filters: Filter[]) => Filter[];

package/dist/src/beta/components/InteractiveCard/InteractiveCard.d.ts

@@ -1,51 +1,6 @@
 import { InteractiveCardProps } from './types';
 /**
- * InteractiveCard component for creating clickable cards with nested interactive elements.
- *
- * Features:
- * - Clickable card area that can be a button or link
- * - Supports nested interactive elements without accessibility violations
- * - Dead-space clicks are forwarded to the action element via event delegation,
- *   so any focusable child (button, link, input, switch, etc.) handles its own
- *   click without bubbling to the card action
- * - Box-shadow feedback on hover and focus of any interactive element
- * - Full keyboard accessibility with proper focus management
- * - Touch-friendly with mobile support
- * - Customizable padding and background variants via contentProps
- * - WCAG AA 2.2 compliant
- * - Required ARIA labels for screen reader support
- * - Supports all Card props for styling and layout via contentProps
- *
- * @example
- * // Button card with nested actions
- * <InteractiveCard
- *   wrapperProps={{ "aria-label": "Kitchen Measurement 2 card" }}
- *   actionProps={{
- *     "aria-label": "Expand Kitchen Measurement 2",
- *     onClick: handleExpand,
- *   }}
- *   contentProps={{ padding: "large" }}
- * >
- *   <Text variant="headline">Kitchen Measurement 2</Text>
- *   <Button>Exact Size</Button>
- *   <Button>Block Size</Button>
- * </InteractiveCard>
- *
- * @example
- * // Link card with nested actions
- * <InteractiveCard
- *   wrapperProps={{ "aria-label": "Tommy Lee's Project card" }}
- *   actionProps={{
- *     "aria-label": "Navigate to Tommy Lee's Project",
- *     href: "/project/123",
- *   }}
- *   contentProps={{ padding: "large" }}
- * >
- *   <Text variant="headline">Tommy Lee's Project</Text>
- *   <IconButton icon={Edit} onClick={(e) => {
- *     e.preventDefault();
- *     handleEdit();
- *   }} />
- * </InteractiveCard>
+ * Card whose non-control surface delegates to a button or link action while
+ * nested controls remain independently interactive.
  */
 export declare const InteractiveCard: import('react').ForwardRefExoticComponent<InteractiveCardProps & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/beta/components/InteractiveCard/types.d.ts

@@ -1,101 +1,43 @@
 import { MouseEvent } from 'react';
 import { CardProps } from '../../../components/Card';
 import { PassThroughProps, PassThroughPropsWithRef } from '../../../types/PassThroughProps';
-/**
- * Props for the wrapper div element.
- * Contains the group role and aria-label for screen readers.
- * Can also include className, style, data attributes, ref, and other div props.
- */
 export type WrapperProps = Omit<PassThroughPropsWithRef<"div">, "onClick" | "children" | "role"> & {
-    /**
-     * ARIA label for the group wrapper.
-     * Describes what the card contains.
-     * @example "Kitchen Measurement 2 card"
-     */
+    /** Accessible name for the group containing the card and nested controls. */
     "aria-label": string;
 };
-/**
- * Props for the action element when rendered as a button.
- * Includes standard button props (disabled, data attributes, etc.) via PassThroughProps.
- * Styling and layout are handled internally.
- */
 export type ActionButtonProps = Omit<PassThroughProps<"button">, "children" | "type" | "href" | "className" | "style"> & {
-    /**
-     * ARIA label for the interactive action.
-     * Describes the action that will be taken when clicked.
-     * @example "Expand Kitchen Measurement 2"
-     */
+    /** Accessible name for the action represented by the card surface. */
     "aria-label": string;
-    /**
-     * Click handler for the card button.
-     * Handles mouse clicks, keyboard activation (Enter/Space), and touch events.
-     */
+    /** Runs when the button is activated directly or through the card surface. */
     onClick: (e: MouseEvent<HTMLButtonElement>) => void;
 };
-/**
- * Props for the action element when rendered as a link.
- * Includes standard anchor props (target, rel, data attributes, etc.) via PassThroughProps.
- * Styling and layout are handled internally.
- */
 export type ActionLinkProps = Omit<PassThroughProps<"a">, "children" | "disabled" | "type" | "className" | "style"> & {
-    /**
-     * ARIA label for the interactive action.
-     * Describes the action that will be taken when clicked.
-     * @example "Navigate to Kitchen Measurement 2"
-     */
+    /** Accessible name for the navigation represented by the card surface. */
     "aria-label": string;
-    /**
-     * URL for the card to navigate to.
-     * When provided, the card renders as an anchor element.
-     */
+    /** Navigation target used by direct and delegated card clicks. */
     href: string;
 };
-/**
- * Props for the content layer (Card element).
- * Includes all Card props for styling and layout (padding, background, gap, etc.).
- */
+/** Card props applied to the visible content layer. */
 export type ContentProps = Omit<CardProps, "children">;
-/**
- * Base props shared by both button and link variants of InteractiveCard.
- */
 type InteractiveCardBaseProps = {
-    /**
-     * Props for the wrapper div element.
-     * Includes required aria-label and optional data attributes.
-     */
+    /** Configures and names the outer group. */
     wrapperProps: WrapperProps;
-    /**
-     * Props for the content layer (Card element).
-     * Controls padding, background, gap, and other Card styling.
-     */
+    /** Configures the visible Card layer. Padding defaults to `medium`. */
     contentProps?: ContentProps;
-    /**
-     * Content to render inside the card.
-     */
+    /** May include controls that remain independent of the card action. */
     children: CardProps["children"];
 };
-/**
- * Props for InteractiveCard with button action.
- */
 export type InteractiveCardWithButtonProps = InteractiveCardBaseProps & {
-    /**
-     * Props for the button action element.
-     */
+    /** Configures the delegated card action as a button. */
     actionProps: ActionButtonProps;
 };
-/**
- * Props for InteractiveCard with link action.
- */
 export type InteractiveCardWithLinkProps = InteractiveCardBaseProps & {
-    /**
-     * Props for the link action element.
-     */
+    /** Configures the delegated card action as a link. */
     actionProps: ActionLinkProps;
 };
 /**
- * Props for the InteractiveCard component.
- * Can be used as either a button or link variant based on actionProps.
- * @extends CardProps
+ * Uses `actionProps.href` to select the link variant; otherwise the card
+ * delegates to a button.
  */
 export type InteractiveCardProps = InteractiveCardWithButtonProps | InteractiveCardWithLinkProps;
 export {};