@servicetitan/anvil2 3.15.0 → 3.15.2

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

@@ -1,31 +1,22 @@
 import { CalendarProps as StableCalendarProps } from '../../../components';
 export interface CalendarBetaProps {
+    /**
+     * Adds a pip and accessible context to matching `YYYY-MM-DD` dates.
+     */
     dateMetadata?: {
+        /** Date to annotate, formatted as `YYYY-MM-DD`. */
         date: string;
+        /** Text appended to the date's accessible label. */
         context: string;
     }[];
+    /** Runs on initial display and when the visible month or year changes. Month is 1-based. */
     onMonthView?: ({ month, year }: {
         month: number;
         year: number;
     }) => void;
 }
 /**
- * Beta Calendar component — wraps the stable Calendar with per-date
- * annotations and month-view tracking, on top of its single/range date
- * selection.
- *
- * Features:
- * - All stable Calendar props and behavior (see `Calendar` in `components`)
- * - `dateMetadata` to annotate specific dates with contextual text (e.g.
- *   "3 available time slots"), surfaced via `Calendar.Month`'s day pips
- * - `onMonthView` callback fired whenever the visible month/year changes
- *
- * @example
- * <Calendar
- *   value="2024-01-15"
- *   onSelection={({ value }) => console.log('Selected:', value)}
- *   dateMetadata={[{ date: "2024-01-20", context: "3 available slots" }]}
- *   onMonthView={({ month, year }) => console.log('Viewing:', month, year)}
- * />
+ * Extends the stable Calendar with per-date annotations and visible-month
+ * notifications.
  */
 export declare const Calendar: (props: CalendarBetaProps & StableCalendarProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,2 +1,3 @@
 import { CalendarBetaProps } from './Calendar';
+/** Carries beta-only props into the stable Calendar implementation. */
 export declare const CalendarBetaPropsContext: import('react').Context<CalendarBetaProps>;

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

@@ -1 +1,2 @@
+/** Reads beta-only props from the nearest Calendar provider. */
 export declare const useCalendarBetaProps: () => import('./Calendar').CalendarBetaProps;

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

@@ -3,24 +3,19 @@ import { Filter } from './internal/types';
 import { DataAttributes, LayoutUtilProps } from '../../../types';
 import { ToolbarSize } from '../Toolbar/types';
 /**
- * Props for the FilterBar component
- *
  * @extends ComponentPropsWithoutRef<"div">
  * @extends LayoutUtilProps
  */
 export type FilterBarProps = ComponentPropsWithoutRef<"div"> & LayoutUtilProps & DataAttributes & {
-    /** Array of filter objects */
+    /** Filter configs to render. Search filters are always first among inline filters. */
     filters: Filter[];
-    /** Description of the content this filter bar is associated with, used for accessibility */
+    /** Names the content being filtered in the toolbar's accessible label. */
     associatedContent: string;
-    /** Callback function when filters change */
+    /** Receives the full filter list after a filter commit. */
     onFilterChange: (filters: Filter[]) => void;
-    /** Whether the filters submission is controlled via an apply button */
+    /** Delays inline filter commits until Apply. The drawer always batches changes. Defaults to `false`. */
     controlledFiltering?: boolean;
-    /**
-     * Size of filter controls
-     * @default xsmall
-     */
+    /** Toolbar size for filter controls. Defaults to `xsmall`. */
     size?: ToolbarSize;
     /**
      * When true, filters stay inline at every container width instead of
@@ -30,55 +25,19 @@ export type FilterBarProps = ComponentPropsWithoutRef<"div"> & LayoutUtilProps &
     disableCollapse?: boolean;
 };
 /**
- * FilterBar component for displaying a standalone group of filters with toggles and a clear button.
- *
- * Features:
- * - Standalone component with `role="toolbar"` and keyboard navigation
- * - Renders filter toggles and popovers for all filter types
- * - Supports controlled and uncontrolled filtering
- * - Integrates with FilterDrawer for batch filter editing of drawer-only filters
- * - Provides a clear all filters button
- * - Shares filter state via context for child components
- * - Supports boolean, custom, single-select, multi-select, date, and date range filter types
- * - Preserves filter state when filter configuration changes
- * - Responsive: collapses to drawer-only mode below 640px; opt out via `disableCollapse`
- * - Always wraps; never collapses items into an overflow menu
- * - Can be composed alongside Toolbar as a sibling using Flex layout
- *
- * @example
- * <FilterBar
- *   associatedContent="invoices"
- *   filters={filters}
- *   onFilterChange={handleFilter}
- *   controlledFiltering={true}
- * />
- *
- * @example
- * // With Toolbar as sibling
- * <Flex alignItems="center" justifyContent="space-between">
- *   <Toolbar associatedContent="invoice actions">
- *     <Toolbar.Button icon={SaveIcon} aria-label="Save" />
- *   </Toolbar>
- *   <FilterBar
- *     associatedContent="invoices"
- *     filters={filters}
- *     onFilterChange={handleFilter}
- *   />
- * </Flex>
+ * Standalone filter toolbar with wrapping inline controls and a drawer for
+ * narrow containers or drawer-only filters.
  */
 export declare const FilterBar: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & LayoutUtilProps & DataAttributes & {
-    /** Array of filter objects */
+    /** Filter configs to render. Search filters are always first among inline filters. */
     filters: Filter[];
-    /** Description of the content this filter bar is associated with, used for accessibility */
+    /** Names the content being filtered in the toolbar's accessible label. */
     associatedContent: string;
-    /** Callback function when filters change */
+    /** Receives the full filter list after a filter commit. */
     onFilterChange: (filters: Filter[]) => void;
-    /** Whether the filters submission is controlled via an apply button */
+    /** Delays inline filter commits until Apply. The drawer always batches changes. Defaults to `false`. */
     controlledFiltering?: boolean;
-    /**
-     * Size of filter controls
-     * @default xsmall
-     */
+    /** Toolbar size for filter controls. Defaults to `xsmall`. */
     size?: ToolbarSize;
     /**
      * When true, filters stay inline at every container width instead of

package/dist/src/beta/components/FilterBar/FilterDateList.d.ts

@@ -11,12 +11,15 @@ interface DateListDialogProps {
         startDate: string;
         endDate: string;
     };
+    /** Date format forwarded to the inline picker. */
     mode?: DateFieldSingleProps["mode"];
     /** Constraints applied only when the Custom Range picker is open. */
     customRange?: DateListCustomRangeConfig;
     /** Primary CTA label. "Apply" in popover, "Save" in drawer. */
     dialogCtaLabel: "Apply" | "Save";
+    /** Receives the completed library option. */
     onCommit: (option: DateListOption) => void;
+    /** Dismisses the dialog without committing its draft. */
     onCancel: () => void;
 }
 /**
@@ -26,10 +29,15 @@ interface DateListDialogProps {
  */
 export declare const DateListDialog: ({ libraryId, parentFilterId, initialValue, mode, customRange, dialogCtaLabel, onCommit, onCancel, }: DateListDialogProps) => import("react/jsx-runtime").JSX.Element;
 interface FilterDateListProps {
+    /** Date-list options and picker configuration. */
     filter: DateListFilter;
+    /** Selection used to derive the menu value and dialog seed. */
     committedValue: DateListOption | undefined;
+    /** Receives consumer options immediately or a completed library selection. */
     onCommit: (value: DateListOption | undefined) => void;
+    /** Content shown in the filter trigger. */
     label: ReactNode;
+    /** Applies selected styling to the trigger. */
     isSelected: boolean;
     /** Primary CTA label for the library-option dialog. */
     dialogCtaLabel: "Apply" | "Save";

package/dist/src/beta/components/FilterBar/FilterDateRange.d.ts

@@ -4,18 +4,29 @@ type Value = {
     endDate: string | null;
 } | null;
 type InlineProps = {
+    /** Renders only the picker body with parent-owned draft state. */
     variant: "inline";
+    /** Date-range filter configuration, including format and constraints. */
     filter: DateRangeFilter;
+    /** In-progress range shown by the picker. */
     draftValue: Value;
+    /** Updates the parent-owned draft. */
     onDraftChange: (value: Value) => void;
 };
 type PopoverProps = {
+    /** Renders the toolbar trigger and popover. Defaults to `popover`. */
     variant?: "popover";
+    /** Date-range filter configuration, including format and constraints. */
     filter: DateRangeFilter;
+    /** Value used to seed or resync the popover draft. */
     committedValue: Value;
+    /** Receives the range when the popover commits. */
     onCommit: (value: Value) => void;
+    /** Adds Apply/Cancel when true; otherwise picker changes commit immediately. */
     controlledFiltering: boolean;
+    /** Content shown in the filter trigger. */
     label: React.ReactNode;
+    /** Applies selected styling to the trigger. */
     isSelected: boolean;
     /**
      * Configures a "Clear" button in the popover footer. Presence enables it.
@@ -27,16 +38,11 @@ type PopoverProps = {
         disabled?: boolean;
     };
 };
-export type FilterDateRangeProps = InlineProps | PopoverProps;
 /**
- * FilterDateRange renders a date-range picker for FilterBar.
- *
- * Two variants:
- * - `popover` (default) owns its trigger + OptionsPopover + (when controlled)
- *   Apply/Cancel footer, and commits via `onCommit`.
- * - `inline` renders just the masked input + calendar body, with draft state
- *   lifted to the parent via `draftValue` / `onDraftChange`. Used when the
- *   component is embedded inside another shell (e.g. DateListDialog).
+ * `popover` owns the trigger and commit flow; `inline` renders the picker body
+ * with parent-owned draft state.
  */
+export type FilterDateRangeProps = InlineProps | PopoverProps;
+/** Date-range FilterBar picker with popover and inline variants. */
 export declare const FilterDateRange: (props: FilterDateRangeProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/src/beta/components/FilterBar/FilterDateSingle.d.ts

@@ -1,18 +1,29 @@
 import { DateFilter } from './internal/types';
 type Value = string | null;
 type InlineProps = {
+    /** Renders only the picker body with parent-owned draft state. */
     variant: "inline";
+    /** Date filter configuration, including format and constraints. */
     filter: DateFilter;
+    /** In-progress value shown by the picker. */
     draftValue: Value;
+    /** Updates the parent-owned draft. */
     onDraftChange: (value: Value) => void;
 };
 type PopoverProps = {
+    /** Renders the toolbar trigger and popover. Defaults to `popover`. */
     variant?: "popover";
+    /** Date filter configuration, including format and constraints. */
     filter: DateFilter;
+    /** Value used to seed or resync the popover draft. */
     committedValue: Value;
+    /** Receives the value when the popover commits. */
     onCommit: (value: Value) => void;
+    /** Adds Apply/Cancel when true; otherwise picker changes commit immediately. */
     controlledFiltering: boolean;
+    /** Content shown in the filter trigger. */
     label: React.ReactNode;
+    /** Applies selected styling to the trigger. */
     isSelected: boolean;
     /**
      * Configures a "Clear" button in the popover footer. Presence enables it.
@@ -24,16 +35,11 @@ type PopoverProps = {
         disabled?: boolean;
     };
 };
-export type FilterDateSingleProps = InlineProps | PopoverProps;
 /**
- * FilterDateSingle renders a single-date picker for FilterBar.
- *
- * Two variants:
- * - `popover` (default) owns its trigger + OptionsPopover + (when controlled)
- *   Apply/Cancel footer, and commits via `onCommit`.
- * - `inline` renders just the masked input + calendar body, with draft state
- *   lifted to the parent via `draftValue` / `onDraftChange`. Used when the
- *   component is embedded inside another shell (e.g. DateListDialog).
+ * `popover` owns the trigger and commit flow; `inline` renders the picker body
+ * with parent-owned draft state.
  */
+export type FilterDateSingleProps = InlineProps | PopoverProps;
+/** Single-date FilterBar picker with popover and inline variants. */
 export declare const FilterDateSingle: (props: FilterDateSingleProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/src/beta/components/FilterBar/FilterDrawer.d.ts

@@ -1,15 +1,2 @@
-/**
- * FilterDrawer component provides a drawer interface for filter selection.
- * Always operates in controlled mode with batch updates.
- * Built into FilterGroup for batch editing of drawer-only and below-breakpoint filters.
- *
- * Features:
- * - Shows all available filters in a side panel
- * - Maintains separate draft state for all filters
- * - Updates filters only when Apply is clicked
- * - Provides Clear All functionality
- * - Supports boolean, custom, single-select, multi-select, date, and date range filter types
- * - Integrates with FilterGroup context for state management
- * - Handles date and date range filters with appropriate input components
- */
+/** Batch editor for filters not reachable from the toolbar. Drafts commit only on Apply. */
 export declare const FilterDrawer: () => import("react/jsx-runtime").JSX.Element;

package/dist/src/beta/components/FilterBar/FilterItemWrapper.d.ts

@@ -1,16 +1,9 @@
-/**
- * Props for the FilterItemWrapper component
- */
 type FilterItemWrapperProps = {
-    /** The content to render inside the wrapper */
     children: React.ReactNode;
 };
 /**
  * FilterItemWrapper wraps a filter control in ToolbarItemWrapper so it
  * registers with the surrounding toolbar context for keyboard navigation.
- *
- * Features:
- * - Registers the control with the surrounding toolbar context
  */
 export declare const FilterItemWrapper: ({ children }: FilterItemWrapperProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/src/beta/components/FilterBar/FilterNumericRange.d.ts

@@ -1,13 +1,10 @@
 import { NumericRangeFilter, NumericRangeValue } from './internal/types';
-/**
- * Props for the FilterNumericRange component.
- */
 interface FilterNumericRangeProps {
     /** The numeric range filter — drives field labels, decorator props, and clamp bounds. */
     filter: NumericRangeFilter;
-    /** Current min/max value (or null when no bounds are set). */
+    /** `null` when empty; one-sided bounds are valid committed ranges. */
     value: NumericRangeValue;
-    /** Callback to update the value. Emits `null` when both bounds are cleared. */
+    /** Emits `null` when empty; otherwise emits clamped one- or two-sided bounds. */
     onChange: (value: NumericRangeValue) => void;
     /**
      * `compact` stacks the inputs vertically (toolbar popover); `grid` places
@@ -16,14 +13,8 @@ interface FilterNumericRangeProps {
     layout: "compact" | "grid";
 }
 /**
- * Min/Max NumberField inputs for the numericRange filter. Used as the popover
- * body in the toolbar (`layout="compact"`) and as the cell in the drawer
- * (`layout="grid"`).
- *
- * Value-driven: partial input (only one bound filled) flows straight to the
- * caller, so a consumer can keep half-ranges (e.g. `> 100`) without juggling
- * draft state here. Both bounds are clamped to `filter.minValue`/`maxValue`
- * before emitting.
+ * Min/max number fields that preserve half-ranges and clamp both bounds to the
+ * filter's configured limits before emitting.
  */
 export declare const FilterNumericRange: ({ filter, value, onChange, layout, }: FilterNumericRangeProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/src/beta/components/FilterBar/FilterPopoverButton.d.ts

@@ -1,5 +1,6 @@
 import { ReactNode } from 'react';
 import { Filter } from './internal/types';
+import { MenuFooterClearConfig } from '../../../internal/components/MenuFooter/MenuFooter';
 /**
  * Render-prop ctx passed to FilterPopoverButton's children. The `custom`
  * adapter (and any consumer using a `custom` filter) uses this to receive the
@@ -55,6 +56,11 @@ type DraftModeProps<V> = FilterPopoverButtonBaseProps<V> & {
      * @default false
      */
     keepOpenOnUncontrolledChange?: boolean;
+    /**
+     * Configures a "Clear" button in the popover footer. Presence enables it.
+     * Clear commits immediately regardless of `controlledFiltering`.
+     */
+    clear?: MenuFooterClearConfig;
 };
 /**
  * Commit-on-select props: no draft state exists, so `initialValue` and
@@ -73,14 +79,6 @@ type FilterPopoverButtonProps<V> = DraftModeProps<V> | CommitOnSelectProps<V>;
  * `asyncMultiSelect`, `date`, `dateRange`, `dateList`) compose menu primitives
  * (`SelectMenu`, `MultiSelectMenu`) or their own popover shells directly and
  * do not go through this component.
- *
- * It owns:
- * - The trigger button (label + icon + selected state)
- * - The OptionsPopover wrapper (open state, outside-press handling)
- * - When commitOnSelect is false: draft state + MenuFooter Apply/Cancel chrome
- *
- * The body is supplied via render-prop children, which receive the
- * appropriate value + onChange for the current commit mode.
  */
 export declare const FilterPopoverButton: <V>(props: FilterPopoverButtonProps<V>) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/src/beta/components/FilterBar/FilterSearchField.d.ts

@@ -1,13 +1,10 @@
 import { SearchFilter } from './internal/types';
-/**
- * Props for the FilterSearchField component
- */
 export type FilterSearchFieldProps = {
-    /** The search filter — drives the placeholder */
+    /** Supplies the placeholder and the input's accessible name. */
     filter: SearchFilter;
-    /** Current text value */
+    /** Committed query string; empty when cleared. */
     value: string;
-    /** Callback to update the value */
+    /** Forwards every native change; clearing emits `""`. */
     onChange: (value: string) => void;
 };
 /**

package/dist/src/beta/components/FilterBar/FilterTextInput.d.ts

@@ -1,13 +1,10 @@
 import { TextInputFilter } from './internal/types';
-/**
- * Props for the FilterTextInput component.
- */
 interface FilterTextInputProps {
     /** The text input filter — drives label, placeholder, and max length. */
     filter: TextInputFilter;
-    /** Current text value. */
+    /** Always a string; adapters map a missing filter value to `""`. */
     value: string;
-    /** Callback to update the value. Receives the truncated string. */
+    /** Fires after `maxLength` truncation when that bound is set. */
     onChange: (value: string) => void;
     /**
      * `compact` hides the field's own label (toolbar popover — the filter
@@ -16,14 +13,8 @@ interface FilterTextInputProps {
     layout: "compact" | "grid";
 }
 /**
- * Single-line TextField for the textInput filter. Used as the popover body in
- * the toolbar (`layout="compact"`) and as the cell in the drawer
- * (`layout="grid"`).
- *
- * Features:
- * - Truncates entered text to `filter.maxLength` before emitting
- * - Optional `current/max` character counter (`showCounter`)
- * - Hides its own label in `compact` (the filter button doubles as the label)
+ * Single-line text filter that truncates to `maxLength` before emitting.
+ * `showCounter` adds the current/max character count.
  */
 export declare const FilterTextInput: ({ filter, value, onChange, layout, }: FilterTextInputProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/src/beta/components/FilterBar/FilterToggleButton.d.ts

@@ -1,24 +1,13 @@
 import { ToolbarButtonToggleProps } from '../Toolbar/ToolbarButtonToggle';
 /**
- * Props for the FilterToggleButton component
- *
  * @extends Omit<ToolbarButtonToggleProps, "checked">
  */
 export type FilterToggleButtonProps = Omit<ToolbarButtonToggleProps, "checked"> & {
-    /** Unique identifier for the filter */
+    /** Filter id forwarded to the toolbar toggle. */
     id: string;
-    /** Whether the toggle is checked */
+    /** On-state for a boolean filter. */
     checked: boolean;
-    /** The content to display inside the toggle button */
     children: React.ReactNode;
 };
-/**
- * FilterToggleButton wraps ToolbarButtonToggle in a FilterItemWrapper for
- * consistent rendering with other filter types.
- * Built into FilterGroup for boolean filter rendering.
- *
- * Features:
- * - Renders a toggle button for boolean filters
- * - Supports accessibility and keyboard navigation
- */
+/** Boolean-filter trigger wrapped for FilterBar keyboard navigation. */
 export declare const FilterToggleButton: ({ id, checked, children, ...props }: FilterToggleButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/beta/components/FilterBar/FilterTriggerButton.d.ts

@@ -8,12 +8,12 @@ import { ButtonProps } from '../../../components/Button';
  * accepted via spread, which lets this component slot underneath any menu
  * primitive's trigger render-prop (`SelectMenu`, `MultiSelectMenu`,
  * `FilterDateSingle` / `FilterDateRange`'s popover shell) or, for `custom`,
- * `FilterPopoverButton`'s `Popover.Button`.
+ * `FilterPopoverButton`.
  */
 export type FilterTriggerButtonProps = Omit<ButtonProps, "children" | "icon"> & {
     /** Filter id — emitted as `data-id` for test selectors and analytics. */
     filterId: string;
-    /** Label content rendered inside the button. */
+    /** Visible trigger text; adapters typically pass `formatLabel(filter)`. */
     label: ReactNode;
     /** Whether the filter has a committed selection (drives the selected-state class). */
     isSelected: boolean;
@@ -36,7 +36,7 @@ export type FilterTriggerButtonProps = Omit<ButtonProps, "children" | "icon"> &
 export declare const FilterTriggerButton: import('react').ForwardRefExoticComponent<Omit<ButtonProps, "children" | "icon"> & {
     /** Filter id — emitted as `data-id` for test selectors and analytics. */
     filterId: string;
-    /** Label content rendered inside the button. */
+    /** Visible trigger text; adapters typically pass `formatLabel(filter)`. */
     label: ReactNode;
     /** Whether the filter has a committed selection (drives the selected-state class). */
     isSelected: boolean;

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

@@ -2,35 +2,21 @@ import { RefObject } from 'react';
 import { FilterBarProps } from '../FilterBar';
 import { Filter, FilterValue } from './types';
 /**
- * Context for sharing filter state and operations between FilterBar and its children
+ * FilterBar props plus state shared with the drawer and adapters.
  *
  * @extends FilterBarProps
  */
 type FilterGroupContextProps = FilterBarProps & {
-    /** Reference to the filter group DOM element
-     *  @default { current: null }
-     */
+    /** FilterBar root used for toolbar keyboard navigation. */
     filterGroupRef: RefObject<HTMLDivElement>;
-    /** Current filters array
-     *  @default []
-     */
     filters: Filter[];
-    /** Function to update a single filter and submit if needed
-     *  @default () => {}
-     */
+    /** Updates one filter and optionally submits the full list. */
     updateFilter: (filterId: string, value: FilterValue, submit: boolean) => void;
-    /** Filters configured as drawer-only — never rendered inline in the toolbar
-     *  @default []
-     */
+    /** Filters configured as drawer-only and never rendered inline. */
     drawerOnlyFilters: Filter[];
-    /** Whether the container is wide enough to render filters inline in the toolbar
-     *  @default false
-     */
+    /** Whether the container is wide enough to render filters inline. */
     showInlineFilters: boolean;
 };
-/**
- * Context provider for filter-related operations
- * Used to share filter state between FilterBar and FilterDrawer
- */
+/** Shared FilterBar state for the drawer and adapters. */
 export declare const FilterGroupContext: import('react').Context<FilterGroupContextProps>;
 export {};

package/dist/src/beta/components/FilterBar/internal/adapters/index.d.ts

@@ -1,15 +1,10 @@
 import { Filter } from '../types';
 import { FilterAdapters, FilterTypeAdapter } from './types';
-/**
- * Per-type adapters keyed by Filter["type"]. Exhaustive: adding a new Filter
- * variant forces a compile error here until an adapter is provided.
- */
+/** Runtime registry keyed by Filter["type"]. */
 export declare const filterAdapters: FilterAdapters;
 /**
- * Looks up the adapter for a given filter. The returned adapter's F and V
- * are widened to Filter / unknown — callers that need narrow typing should pass
- * the filter directly through the adapter methods, which preserves variance.
- * Falls back to a no-op adapter for unknown filter types.
+ * Adapter for `filter.type`, widened to Filter / unknown so callers holding
+ * the Filter union can invoke adapter methods.
  */
 export declare const getAdapter: (filter: Filter) => FilterTypeAdapter<Filter, unknown>;
 export type { FilterTypeAdapter } from './types';

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

@@ -27,36 +27,24 @@ export type DrawerRenderCtx<F extends Filter> = {
     requestDateListDialog: (filterId: string, libraryId: DateListLibraryOptionId) => void;
 };
 /**
- * Per-filter-type adapter. Each filter variant contributes one adapter
- * implementing every operation FilterBar / FilterDrawer need.
- *
- * F = the specific Filter variant
- * V = the value type (what getValue / setValue traffic in)
- *
- * `renderBarControl` returns the complete inline UI for this filter type.
- * Most adapters compose `SelectMenu` / `MultiSelectMenu` (or one of the
- * filter-specific shells like `FilterDateSingle`) directly, supplying the
- * trigger via render-prop. The `custom` adapter composes `FilterPopoverButton`
- * for fully consumer-rendered popover bodies; `boolean` uses a toggle button
- * with no popover at all. The adapter type itself stays agnostic about UI
- * shape.
+ * Named operations FilterBar and FilterDrawer call per filter variant.
+ * UI shape is per adapter.
  */
 export type FilterTypeAdapter<F extends Filter, V> = {
     getValue: (filter: F) => V;
     setValue: (filter: F, value: V) => F;
     reset: (filter: F) => F;
     isActive: (filter: F) => boolean;
+    /** Keeps selection when configuration changes without a new selection reference. */
     preserveState: (newFilter: F, existingFilter: F) => F;
+    /** Copy used when the drawer snapshots committed filters into a draft. */
     cloneWithItemRefs: (filter: F) => F;
     renderBarControl: (ctx: BarControlRenderCtx<F>) => ReactNode;
     renderDrawer: (ctx: DrawerRenderCtx<F>) => ReactNode;
     formatLabel: (filter: F) => ReactNode;
     isSelected: (filter: F) => boolean;
 };
-/**
- * Map from a Filter's `type` discriminant to its specific variant.
- * Used to keep the adapter map exhaustive at the type level.
- */
+/** Filter `type` discriminant → concrete variant. */
 export type FilterVariantMap = {
     boolean: BooleanFilter;
     custom: CustomFilter<any>;
@@ -74,8 +62,8 @@ export type FilterVariantMap = {
     search: SearchFilter;
 };
 /**
- * Exhaustive map from Filter["type"] to its adapter. Forces compile-time
- * completeness when a new filter type is added.
+ * Exhaustive map from Filter["type"] to its adapter. Adding a variant
+ * without an adapter is a compile error.
  */
 export type FilterAdapters = {
     [K in keyof FilterVariantMap]: FilterTypeAdapter<FilterVariantMap[K], any>;