@servicetitan/anvil2 3.14.1 → 3.15.0

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

@@ -1,39 +1,18 @@
 import { Active, DragEndEvent, DragOverEvent, DroppableContainer } from '@dnd-kit/core';
 /**
- * Because of the interplay between `getNextCoordinates` and `collisionDetection` when handling keyboard interactions,
- * we store the current position in a global variable.
- *
- * More specifically, the `collisionDetection` function doesn't have access to the same context as the `getNextCoordinates` function,
- * meaning that the collision detection function doesn't know which droppable container is currently being "hovered" by key presses.
+ * Shares the keyboard hover target with collision detection, which lacks
+ * sensor context.
  */
 export declare const WINDOW_PROPERTY_SORT_POSITION = "react-hammer_DndSort_position";
-/**
- * Resolves the zone (if any) where the item is being dropped.
- * Given that "over" can be a zone or an item, we have to dig into the event to determine the correct zone.
- * @param event - The drag event (either DragEndEvent or DragOverEvent)
- * @returns The resolved drop zone, which may be null if no valid zone is found
- */
+/** Resolves item collisions to their enclosing zone. */
 export declare function resolveDropZone(event: DragEndEvent | DragOverEvent): import('@dnd-kit/core').Over | DroppableContainer | null;
-/**
- * Calculates the validity of the drop event based on accepted types and custom validation.
- * @param params - An object containing the active drag item and the accepted types and validator function
- * @param params.active - The active drag item, which contains the current type and ID
- * @param params.acceptedTypes - An array of accepted types for the drop zone (optional)
- * @param params.validator - A custom validation function that takes the ID of the active item and returns a boolean
- * @returns boolean - true if valid, false otherwise
- */
+/** Combines type and custom validation for the active card. */
 export declare function calculateValidity({ active, acceptedTypes, validator, }: {
     active: Active | null;
     acceptedTypes?: string[];
     validator?: (id: string | number) => boolean;
 }): boolean;
-/**
- * Calculates the validity of the drop event based on accepted types and custom validation.
- * @param params - An object containing the active drag item and the drop zone information
- * @param params.active - The active drag item, which contains the current type and ID
- * @param params.zone - The drop zone information, which may include accepted types and a custom validator function
- * @returns boolean - true if valid, false otherwise
- */
+/** Applies card validity rules to a zone. */
 export declare function calculateZoneValidity({ active, zone, }: {
     active: Active | null;
     zone: {
@@ -46,10 +25,5 @@ export declare function calculateZoneValidity({ active, zone, }: {
         };
     } | null;
 }): boolean;
-/**
- * Determines whether the drop event is valid based on the accepted types and custom validation function.
- * Internally resolves the drop zone.
- * @param event - The drag event (either DragEndEvent or DragOverEvent)
- * @returns boolean - true if valid, false otherwise
- */
+/** Resolves an event target and reports its zone validity. */
 export declare function calculateEventValidity(event: DragEndEvent | DragOverEvent): boolean;

package/dist/src/components/DndSort/types.d.ts

@@ -1,55 +1,34 @@
 import { ReactNode } from 'react';
 /**
- * Event object emitted when a drag and drop operation is completed.
+ * Proposed placement and controlled ordering after a drag ends.
  */
 export type DndSortChangeEvent = {
-    /**
-     * The ID of the draggable item that was dropped.
-     */
+    /** Card that was dragged. */
     draggableId: string | number;
-    /**
-     * The ID of the drop zone where the item was dropped.
-     * This can be null if the item was not dropped in a zone.
-     */
+    /** Target zone, or `null` when no zone resolves. */
     zoneId: string | number | null;
-    /**
-     * The ID of the previous drop zone where the item was located before being dropped.
-     * This can be null if the item is coming from outside of any zone.
-     */
+    /** Source zone, or `null` when the card started outside a zone. */
     previousZoneId: string | number | null;
-    /**
-     * Indicates whether the drop was valid based on the accepted types and custom validation.
-     */
+    /** Zone acceptance result. `true` when no target zone resolves. */
     valid: boolean;
     /**
-     * An array representing the sort order of items in the drop zone after the drop.
-     * This can be used to update the order of items in the zone.
-     *
-     * This value is null if the target drop zone (if any) is not sortable.
+     * Proposed target-zone order, including invalid drops.
+     * `null` when the target is absent or not sortable.
      */
     zoneSort: (string | number)[] | null;
     /**
-     * An array representing the sort order of items in the previous drop zone before the drop.
-     * This can be used to update the order of items in the previous zone.
-     *
-     * This value is null if the previous drop zone (if any) was not sortable.
+     * Proposed source-zone order: the reordered target when moving within one
+     * zone, or the remaining cards when moving out.
+     * `null` when the source is absent or not sortable.
      */
     previousZoneSort: (string | number)[] | null;
 };
-/**
- * Function type for advanced zone rendering with state parameters.
- */
+/** Renders zone content from the current drag state. */
 export type DndSortZoneAdvancedRenderer = (params: {
-    /**
-     * Whether any item is currently being dragged.
-     */
+    /** `true` while any card is being dragged. */
     isDragging: boolean;
-    /**
-     * Whether a draggable item is currently over this zone.
-     */
+    /** `true` when the current collision target is this zone or one of its cards. */
     isOver: boolean;
-    /**
-     * Whether the current drag operation is valid for this zone.
-     */
+    /** Whether the active card passes this zone's type and custom validation. */
     isValid: boolean;
 }) => ReactNode;

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

@@ -3,194 +3,68 @@ import { OpenCloseTransitionStateEffects } from '../../internal/hooks';
 import { FocusableElement, DisableCloseOnEscapeOrClickProps, Size } from '../../types';
 import { DrillDownContextProps } from '../DrillDown/internal/DrillDownContext';
 /**
- * Props for the Drawer component
  * @extends ComponentPropsWithoutRef<"dialog">
- * @extends DialogTransitionStateEffects
+ * @extends OpenCloseTransitionStateEffects
  * @extends DisableCloseOnEscapeOrClickProps
  */
 export type DrawerProps = ComponentPropsWithoutRef<"dialog"> & OpenCloseTransitionStateEffects & DisableCloseOnEscapeOrClickProps & {
-    /**
-     * The size of the drawer.
-     * @default "medium"
-     */
+    /** Width preset. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large" | "xlarge">;
-    /**
-     * Controls whether the drawer is open or closed.
-     * @default false
-     */
+    /** Controls whether the drawer is shown. Defaults to `false`. */
     open?: boolean;
-    /**
-     * Callback function called after the drawer is animated closed.
-     */
+    /** Called by Escape, outside-click, and `Drawer.CancelButton` close actions. */
     onClose?: () => void;
-    /**
-     * Callback when clicking outside the drawer
-     */
+    /** Called on an outside click even when that click is not allowed to close the drawer. */
     onClickOutside?: (e: globalThis.MouseEvent) => void;
-    /**
-     * Enables scroll chaining behavior.
-     * @link https://developer.mozilla.org/en-US/docs/Glossary/Scroll_chaining
-     */
+    /** Allows scrolling to continue into the page instead of locking the shadow host. */
     enableScrollChaining?: boolean;
     /**
-     * Given an array of focusable elements, return the initial focus target.
-     * @param focusables - The focusable elements to pick from
-     * @returns The initial focus target
+     * Chooses initial focus from the drawer's tabbable elements. By default,
+     * header controls are skipped when another target is available.
      */
     initialFocusResolver?: (focusables: FocusableElement[]) => FocusableElement;
-    /**
-     * Sets the default DrillDown index when used in an uncontrolled way
-     */
+    /** DrillDown panel opened when navigation begins. Defaults to index `0`. */
     defaultDrillDownIndex?: DrillDownContextProps["index"];
-    /**
-     * Callback to pass context to useDrillDown hook
-     */
+    /** Receives the current DrillDown controls and whether the drawer is interactive. */
     onDrillDownContextChange?: (context: DrillDownContextProps) => void;
 };
 /**
- * A slide-out drawer component that provides a modal-like experience from the side of the screen.
- *
- * Features:
- * - Slide-in animation from the side of the screen
- * - Keyboard navigation with focus trapping
- * - Escape key and click outside to close
- * - Configurable size variants (medium, large)
- * - Built-in toast support for notifications
- * - Automatic scroll locking when open
- * - Accessible with proper ARIA attributes
- * - Compound component structure with Header, Footer, Content, and CancelButton
- * - Transition state callbacks for animation control
- * - Optional scroll chaining support
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <Drawer open={isOpen} onClose={handleClose} size="medium">
- *   <Drawer.Header>Settings</Drawer.Header>
- *   <Drawer.Content>Drawer content goes here</Drawer.Content>
- *   <Drawer.Footer>
- *     <Button onClick={handleSave}>Save</Button>
- *     <Drawer.CancelButton>Cancel</Drawer.CancelButton>
- *   </Drawer.Footer>
- * </Drawer>
+ * Controlled modal side panel with focus trapping, animated transitions, and
+ * compound header, content, footer, and cancel-button regions.
  */
 export declare const Drawer: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').DialogHTMLAttributes<HTMLDialogElement>, HTMLDialogElement>, "ref"> & OpenCloseTransitionStateEffects & DisableCloseOnEscapeOrClickProps & {
-    /**
-     * The size of the drawer.
-     * @default "medium"
-     */
+    /** Width preset. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large" | "xlarge">;
-    /**
-     * Controls whether the drawer is open or closed.
-     * @default false
-     */
+    /** Controls whether the drawer is shown. Defaults to `false`. */
     open?: boolean;
-    /**
-     * Callback function called after the drawer is animated closed.
-     */
+    /** Called by Escape, outside-click, and `Drawer.CancelButton` close actions. */
     onClose?: () => void;
-    /**
-     * Callback when clicking outside the drawer
-     */
+    /** Called on an outside click even when that click is not allowed to close the drawer. */
     onClickOutside?: (e: globalThis.MouseEvent) => void;
-    /**
-     * Enables scroll chaining behavior.
-     * @link https://developer.mozilla.org/en-US/docs/Glossary/Scroll_chaining
-     */
+    /** Allows scrolling to continue into the page instead of locking the shadow host. */
     enableScrollChaining?: boolean;
     /**
-     * Given an array of focusable elements, return the initial focus target.
-     * @param focusables - The focusable elements to pick from
-     * @returns The initial focus target
+     * Chooses initial focus from the drawer's tabbable elements. By default,
+     * header controls are skipped when another target is available.
      */
     initialFocusResolver?: (focusables: FocusableElement[]) => FocusableElement;
-    /**
-     * Sets the default DrillDown index when used in an uncontrolled way
-     */
+    /** DrillDown panel opened when navigation begins. Defaults to index `0`. */
     defaultDrillDownIndex?: DrillDownContextProps["index"];
-    /**
-     * Callback to pass context to useDrillDown hook
-     */
+    /** Receives the current DrillDown controls and whether the drawer is interactive. */
     onDrillDownContextChange?: (context: DrillDownContextProps) => void;
 } & import('react').RefAttributes<HTMLDialogElement>> & {
-    /**
-     * Header component for the drawer that displays a title and close button.
-     *
-     * Features:
-     * - Displays the drawer title as a headline
-     * - Includes an accessible close button
-     * - Sticky positioning at the top of the drawer
-     * - Proper semantic HTML structure
-     * - Accessible with proper ARIA attributes
-     * - Consistent styling with the design system
-     * - Automatic close functionality
-     * - Automatic tracking ID generation for analytics
-     *
-     * @example
-     * <Drawer.Header>Settings</Drawer.Header>
-     */
+    /** Renders the drawer title, optional actions, and close control. */
     Header: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & import('../..').DataTrackingId & {
         actions?: import('./DrawerHeader').DrawerHeaderAction[];
     } & import('react').RefAttributes<HTMLElement>>;
-    /**
-     * Footer component for the drawer that displays action buttons and controls.
-     *
-     * Features:
-     * - Flexible layout for action buttons and controls
-     * - Optional sticky positioning at the bottom
-     * - Proper semantic HTML structure
-     * - Accessible with proper ARIA attributes
-     * - Consistent styling with the design system
-     * - Supports all standard footer element props
-     * - Responsive design that adapts to content
-     *
-     * @example
-     * <Drawer.Footer sticky>
-     *   <Button onClick={handleSave}>Save</Button>
-     *   <Drawer.CancelButton>Cancel</Drawer.CancelButton>
-     * </Drawer.Footer>
-     */
+    /** Groups actions at the end of the drawer. */
     Footer: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & {
         sticky?: boolean;
     } & import('react').RefAttributes<HTMLElement>>;
-    /**
-     * Content container for the drawer that holds the main content area.
-     *
-     * Features:
-     * - Flexible content area with proper spacing
-     * - Scrollable content when needed
-     * - Proper semantic HTML structure
-     * - Accessible with proper ARIA attributes
-     * - Consistent styling with the design system
-     * - Supports all standard div element props
-     * - Responsive design that adapts to content
-     * - Proper focus management
-     *
-     * @example
-     * <Drawer.Content>
-     *   <p>This is the main content of the drawer.</p>
-     *   <p>It can contain any type of content.</p>
-     * </Drawer.Content>
-     */
+    /** Renders the drawer's main content region. */
     Content: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
         sticky?: boolean;
     } & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * A button component that automatically closes the drawer when clicked.
-     *
-     * Features:
-     * - Automatically closes the drawer when clicked
-     * - Extends Button component functionality
-     * - Accessible with proper ARIA attributes
-     * - Consistent styling with the design system
-     * - Supports all standard button props
-     * - Proper focus management
-     * - Can be used anywhere within the drawer context
-     * - Automatic tracking ID generation for analytics
-     *
-     * @example
-     * <Drawer.CancelButton appearance="ghost" size="small">
-     *   Cancel
-     * </Drawer.CancelButton>
-     */
+    /** Closes the drawer after running its own click handler. */
     CancelButton: import('react').ForwardRefExoticComponent<import('./DrawerCancelButton').DrawerCancelButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
 };

package/dist/src/components/Drawer/DrawerCancelButton.d.ts

@@ -1,25 +1,6 @@
 import { ButtonProps } from '../Button';
 import { DataTrackingId } from '../../types';
-/**
- * Props for the DrawerCancelButton component
- * @extends ButtonProps
- */
+/** @extends ButtonProps */
 export type DrawerCancelButtonProps = ButtonProps & DataTrackingId;
-/**
- * A button component that automatically closes the drawer when clicked.
- *
- * Features:
- * - Automatically closes the drawer when clicked
- * - Extends Button component functionality
- * - Accessible with proper ARIA attributes
- * - Consistent styling with the design system
- * - Supports all standard button props
- * - Proper focus management
- * - Can be used anywhere within the drawer context
- *
- * @example
- * <DrawerCancelButton appearance="ghost" size="small">
- *   Cancel
- * </DrawerCancelButton>
- */
+/** Button that runs its click handler before closing the enclosing drawer. */
 export declare const DrawerCancelButton: import('react').ForwardRefExoticComponent<DrawerCancelButtonProps & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Drawer/DrawerContent.d.ts

@@ -1,45 +1,11 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the DrawerContent component
- * @extends ComponentPropsWithoutRef<"div">
- */
+/** @extends ComponentPropsWithoutRef<"div"> */
 export type DrawerContentProps = ComponentPropsWithoutRef<"div"> & {
-    /**
-     * When true, the content will stick below the header during scroll.
-     * @default false
-     */
+    /** Pins the content below the changing header while the drawer scrolls. Defaults to `false`. */
     sticky?: boolean;
 };
-/**
- * Content container for the drawer that holds the main content area.
- *
- * Features:
- * - Flexible content area with proper spacing
- * - Scrollable content when needed
- * - Optional sticky positioning below header
- * - Proper semantic HTML structure
- * - Accessible with proper ARIA attributes
- * - Consistent styling with the design system
- * - Supports all standard div element props
- * - Responsive design that adapts to content
- * - Proper focus management
- *
- * @example
- * // Basic content
- * <Drawer.Content>
- *   <p>This is the main content of the drawer.</p>
- * </Drawer.Content>
- *
- * @example
- * // Sticky content (e.g., search field that remains visible while scrolling)
- * <Drawer.Content sticky>
- *   <TextField placeholder="Filter results..." />
- * </Drawer.Content>
- */
+/** Main content region of a `Drawer`. */
 export declare const DrawerContent: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
-    /**
-     * When true, the content will stick below the header during scroll.
-     * @default false
-     */
+    /** Pins the content below the changing header while the drawer scrolls. Defaults to `false`. */
     sticky?: boolean;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Drawer/DrawerFooter.d.ts

@@ -1,37 +1,11 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the DrawerFooter component
- * @extends ComponentPropsWithoutRef<"footer">
- */
+/** @extends ComponentPropsWithoutRef<"footer"> */
 export type DrawerFooterProps = ComponentPropsWithoutRef<"footer"> & {
-    /**
-     * When true, the footer will stick to the bottom of the drawer.
-     * @default false
-     */
+    /** Keeps the action row visible at the bottom of scrolling content. Defaults to `false`. */
     sticky?: boolean;
 };
-/**
- * Footer component for the drawer that displays action buttons and controls.
- *
- * Features:
- * - Flexible layout for action buttons and controls
- * - Optional sticky positioning at the bottom
- * - Proper semantic HTML structure
- * - Accessible with proper ARIA attributes
- * - Consistent styling with the design system
- * - Supports all standard footer element props
- * - Responsive design that adapts to content
- *
- * @example
- * <Drawer.Footer sticky>
- *   <Button onClick={handleSave}>Save</Button>
- *   <Button onClick={handleCancel}>Cancel</Button>
- * </Drawer.Footer>
- */
+/** Action row at the end of a drawer. */
 export declare const DrawerFooter: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & {
-    /**
-     * When true, the footer will stick to the bottom of the drawer.
-     * @default false
-     */
+    /** Keeps the action row visible at the bottom of scrolling content. Defaults to `false`. */
     sticky?: boolean;
 } & import('react').RefAttributes<HTMLElement>>;

package/dist/src/components/Drawer/DrawerHeader.d.ts

@@ -1,55 +1,23 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { DataTrackingId, Svg } from '../../types';
-/**
- * Action item for the DrawerHeader overflow menu.
- */
+/** Command shown in `Drawer.Header`'s overflow menu. */
 export type DrawerHeaderAction = {
-    /**
-     * Visible text for the menu item.
-     */
+    /** Visible and accessible menu-item text. */
     label: string;
-    /**
-     * Callback invoked when the menu item is selected.
-     */
+    /** Runs when the item is selected; does not close the drawer. */
     onClick: () => void;
-    /**
-     * Whether the menu item is disabled.
-     */
+    /** Prevents selection. Defaults to `false`. */
     disabled?: boolean;
-    /**
-     * Optional icon displayed before the label.
-     */
+    /** Leading icon shown before the label. */
     icon?: Svg;
 };
-/**
- * Props for the DrawerHeader component
- * @extends ComponentPropsWithoutRef<"header">
- */
+/** @extends ComponentPropsWithoutRef<"header"> */
 export type DrawerHeaderProps = ComponentPropsWithoutRef<"header"> & DataTrackingId & {
-    /**
-     * Overflow menu items rendered left of the close button.
-     */
+    /** Commands placed in an overflow menu before the close control. */
     actions?: DrawerHeaderAction[];
 };
-/**
- * Header component for the drawer that displays a title and close button.
- *
- * Features:
- * - Displays the drawer title as a headline
- * - Includes an accessible close button
- * - Optional overflow menu for secondary header actions
- * - Sticky positioning at the top of the drawer
- * - Proper semantic HTML structure
- * - Accessible with proper ARIA attributes
- * - Consistent styling with the design system
- * - Automatic close functionality
- *
- * @example
- * <Drawer.Header>Settings</Drawer.Header>
- */
+/** Drawer heading with optional overflow actions and a built-in close control. */
 export declare const DrawerHeader: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & DataTrackingId & {
-    /**
-     * Overflow menu items rendered left of the close button.
-     */
+    /** Commands placed in an overflow menu before the close control. */
     actions?: DrawerHeaderAction[];
 } & import('react').RefAttributes<HTMLElement>>;

package/dist/src/components/Drawer/index.d.ts

@@ -1,6 +1,6 @@
 export { Drawer as default, Drawer, type DrawerProps } from './Drawer';
 export type { DrawerCancelButtonProps } from './DrawerCancelButton';
 export type { DrawerFooterProps } from './DrawerFooter';
-export type { DrawerHeaderAction, DrawerHeaderProps, } from './DrawerHeader';
+export type { DrawerHeaderAction, DrawerHeaderProps } from './DrawerHeader';
 export type { DrawerContentProps } from './DrawerContent';
 export type { LayoutUtilProps } from '../../types';

package/dist/src/components/Drawer/internal/DrawerContext.d.ts

@@ -1,24 +1,9 @@
 import { MouseEvent, RefObject } from 'react';
 import { OpenCloseTransitionStates } from '../../../internal/hooks/useOpenCloseTransitionStates/useOpenCloseTransitionStates';
-/**
- * Context props for the Drawer component
- */
 export type DrawerContextProps = {
-    /**
-     * Function to close the drawer.
-     */
     close: (e?: MouseEvent<HTMLElement>) => void;
-    /**
-     * Reference to the drawer dialog element.
-     */
     ref?: RefObject<HTMLDialogElement>;
-    /**
-     * Reference to the drawer header element for sticky content positioning.
-     */
     headerRef?: RefObject<HTMLElement>;
-    /**
-     * The current transition state of the drawer.
-     */
     state?: OpenCloseTransitionStates;
 };
 export declare const DrawerContext: import('react').Context<DrawerContextProps | null>;

package/dist/src/components/Drawer/internal/useDrawerContext.d.ts

@@ -1,7 +1,2 @@
-/**
- * Hook to access the drawer context.
- *
- * @returns The drawer context containing close function and ref
- * @throws Error if used outside of a DrawerContextProvider
- */
+/** Returns the enclosing drawer context; throws when used outside a drawer. */
 export declare function useDrawerContext(): import('./DrawerContext').DrawerContextProps;