@servicetitan/anvil2 3.14.0 → 3.15.0

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

@@ -1,95 +1,57 @@
 import { AriaAttributes, ReactElement, ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the FieldMessage component
- * @extends ComponentPropsWithoutRef<"div">
- */
+/** `error` wins over deprecated `errorMessage`. */
 export type FieldMessageProps = ComponentPropsWithoutRef<"div"> & {
-    /**
-     * Unique identifier for the field message container.
-     */
     id?: string;
     /**
-     * Hint text or element to display. Always visible regardless of error or warning state.
+     * Always rendered, including when errors or warnings are present.
      */
     hint?: ReactElement | string;
-    /**
-     * Description text or element to display below the hint.
-     */
+    /** Extra copy after `hint`. */
     description?: ReactElement | string;
     /**
-     * Error message(s) to display. Supports a single string, an array of strings,
-     * or a ReactElement (deprecated).
-     * All error messages use `aria-live="assertive"`.
+     * Error copy with an error icon. `aria-live="assertive"`. A ReactElement is
+     * deprecated.
      */
     error?: string | string[] | ReactElement;
     /**
-     * Warning message(s) to display. Supports a single string, an array of strings,
-     * or a ReactElement (deprecated).
-     * All warning messages use `aria-live="polite"`.
+     * Warning copy with a warning icon. `aria-live="polite"`. A ReactElement is
+     * deprecated.
      */
     warning?: string | string[] | ReactElement;
     /**
-     * Error message or element to display when there's an error.
-     * @deprecated Use the `error` prop instead.
+     * @deprecated Use `error`. Applied only when `error` is empty.
      */
     errorMessage?: ReactElement | string;
     /**
-     * @deprecated No longer used. Error messages always use `aria-live="assertive"`.
+     * @deprecated Unused. Errors always use `aria-live="assertive"`.
      */
     errorAriaLive?: AriaAttributes["aria-live"];
 };
-/**
- * FieldMessage component for displaying hints, descriptions, error messages, and warning messages for form fields.
- *
- * Features:
- * - Displays hint text that remains visible regardless of error or warning state
- * - Shows one or more error messages with error icon (aria-live="assertive")
- * - Shows one or more warning messages with warning icon (aria-live="polite")
- * - Supports both string and React element content
- * - Optional description text for additional context
- * - Accessible with proper ARIA attributes
- * - Visual error and warning indicators with status icons
- *
- * @example
- * <FieldMessage
- *   hint="Enter your email address"
- *   description="We'll use this to send you updates"
- *   error="Please enter a valid email address"
- *   warning="This email is associated with another account"
- * />
- */
+/** Stacked hint, description, errors, and warnings for a form field. */
 export declare const FieldMessage: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
-    /**
-     * Unique identifier for the field message container.
-     */
     id?: string;
     /**
-     * Hint text or element to display. Always visible regardless of error or warning state.
+     * Always rendered, including when errors or warnings are present.
      */
     hint?: ReactElement | string;
-    /**
-     * Description text or element to display below the hint.
-     */
+    /** Extra copy after `hint`. */
     description?: ReactElement | string;
     /**
-     * Error message(s) to display. Supports a single string, an array of strings,
-     * or a ReactElement (deprecated).
-     * All error messages use `aria-live="assertive"`.
+     * Error copy with an error icon. `aria-live="assertive"`. A ReactElement is
+     * deprecated.
      */
     error?: string | string[] | ReactElement;
     /**
-     * Warning message(s) to display. Supports a single string, an array of strings,
-     * or a ReactElement (deprecated).
-     * All warning messages use `aria-live="polite"`.
+     * Warning copy with a warning icon. `aria-live="polite"`. A ReactElement is
+     * deprecated.
      */
     warning?: string | string[] | ReactElement;
     /**
-     * Error message or element to display when there's an error.
-     * @deprecated Use the `error` prop instead.
+     * @deprecated Use `error`. Applied only when `error` is empty.
      */
     errorMessage?: ReactElement | string;
     /**
-     * @deprecated No longer used. Error messages always use `aria-live="assertive"`.
+     * @deprecated Unused. Errors always use `aria-live="assertive"`.
      */
     errorAriaLive?: AriaAttributes["aria-live"];
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/FieldMessage/utils.d.ts

@@ -1,7 +1,6 @@
 import { ReactElement } from 'react';
 /**
- * Logs a dev-only deprecation warning when `error` is passed as a `ReactElement`.
- * String values are the preferred type and are NOT deprecated.
- * Should be called in consumer components that accept the union `error` prop.
+ * Dev-only warning when `error` is a ReactElement. Strings and string arrays
+ * are the supported form. Call from components that expose the `error` union.
  */
 export declare function warnDeprecatedErrorUsage(componentName: string, error: ReactElement | string | boolean | string[] | undefined): void;

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

@@ -1,61 +1,20 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { FlexSpecificProps } from './internal/FlexSpecificProps';
-/**
- * Props for the Flex component
- * @extends ComponentPropsWithoutRef<"div">
- * @extends FlexSpecificProps
- */
 export type FlexProps = ComponentPropsWithoutRef<"div"> & FlexSpecificProps & {
-    /**
-     * Responsive props for small screens (sm breakpoint).
-     */
+    /** Overrides the base flex properties and layout utilities from `sm` up. */
     sm?: FlexSpecificProps;
-    /**
-     * Responsive props for medium screens (md breakpoint).
-     */
+    /** Overrides the base flex properties and layout utilities from `md` up. */
     md?: FlexSpecificProps;
-    /**
-     * Responsive props for large screens (lg breakpoint).
-     */
+    /** Overrides the base flex properties and layout utilities from `lg` up. */
     lg?: FlexSpecificProps;
-    /**
-     * Responsive props for extra large screens (xl breakpoint).
-     */
+    /** Overrides the base flex properties and layout utilities from `xl` up. */
     xl?: FlexSpecificProps;
-    /**
-     * Responsive props for extra extra large screens (xxl breakpoint).
-     */
+    /** Overrides the base flex properties and layout utilities from `xxl` up. */
     xxl?: FlexSpecificProps;
 };
 /**
- * Flex component for creating flexible layouts using CSS Flexbox.
- *
- * Features:
- * - CSS Flexbox layout with full control over flex properties
- * - Support for both flex and inline-flex display modes
- * - Responsive design with breakpoint-specific props (sm, md, lg, xl, xxl)
- * - Comprehensive layout utilities for spacing, alignment, and positioning
- * - Automatic style generation and class management
- * - Support for all standard div element props
- * - Flexible direction, grow, shrink, basis, and wrap controls
- *
- * @example
- * <Flex direction="row" gap="4" alignItems="center">
- *   <div>Item 1</div>
- *   <div>Item 2</div>
- *   <div>Item 3</div>
- * </Flex>
- *
- * @example
- * <Flex
- *   direction="column"
- *   gap="2"
- *   md={{ direction: "row", gap: "4" }}
- * >
- *   <div>Item 1</div>
- *   <div>Item 2</div>
- *   <div>Item 3</div>
- * </Flex>
+ * Flexbox container with breakpoint-specific overrides for its Flex and layout
+ * utilities.
  */
 export declare const Flex: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & Omit<import('..').LayoutUtilProps, "flexDirection" | "flexGrow" | "flexShrink" | "flexBasis" | "flexWrap"> & {
     inline?: boolean;
@@ -65,24 +24,14 @@ export declare const Flex: import('react').ForwardRefExoticComponent<Omit<import
     basis?: import('react').CSSProperties["flexBasis"];
     wrap?: import('react').CSSProperties["flexWrap"];
 } & {
-    /**
-     * Responsive props for small screens (sm breakpoint).
-     */
+    /** Overrides the base flex properties and layout utilities from `sm` up. */
     sm?: FlexSpecificProps;
-    /**
-     * Responsive props for medium screens (md breakpoint).
-     */
+    /** Overrides the base flex properties and layout utilities from `md` up. */
     md?: FlexSpecificProps;
-    /**
-     * Responsive props for large screens (lg breakpoint).
-     */
+    /** Overrides the base flex properties and layout utilities from `lg` up. */
     lg?: FlexSpecificProps;
-    /**
-     * Responsive props for extra large screens (xl breakpoint).
-     */
+    /** Overrides the base flex properties and layout utilities from `xl` up. */
     xl?: FlexSpecificProps;
-    /**
-     * Responsive props for extra extra large screens (xxl breakpoint).
-     */
+    /** Overrides the base flex properties and layout utilities from `xxl` up. */
     xxl?: FlexSpecificProps;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Flex/internal/FlexSpecificProps.d.ts

@@ -1,32 +1,16 @@
 import { CSSProperties } from 'react';
 import { LayoutUtilProps } from '../../../types';
-/**
- * Flex-specific props that extend layout utilities
- * @extends Omit<LayoutUtilProps, "flexBasis" | "flexGrow" | "flexDirection" | "flexWrap" | "flexShrink">
- */
 export type FlexSpecificProps = Omit<LayoutUtilProps, "flexBasis" | "flexGrow" | "flexDirection" | "flexWrap" | "flexShrink"> & {
-    /**
-     * Applies `display: inline-flex` instead of `flex`
-     */
+    /** Uses `inline-flex`; defaults to block-level `flex`. */
     inline?: boolean;
-    /**
-     * The flex direction of the container.
-     */
+    /** Sets the main axis and ordering of children. */
     direction?: CSSProperties["flexDirection"];
-    /**
-     * The flex grow value for the container.
-     */
+    /** Controls how this container grows when it is itself a flex item. */
     grow?: CSSProperties["flexGrow"];
-    /**
-     * The flex shrink value for the container.
-     */
+    /** Controls how this container shrinks when it is itself a flex item. */
     shrink?: CSSProperties["flexShrink"];
-    /**
-     * The flex basis value for the container.
-     */
+    /** Sets this container's initial main-axis size when it is a flex item. */
     basis?: CSSProperties["flexBasis"];
-    /**
-     * The flex wrap value for the container.
-     */
+    /** Controls whether and how children wrap onto additional lines. */
     wrap?: CSSProperties["flexWrap"];
 };

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

@@ -1,75 +1,26 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { GridSpecificProps } from './internal/GridSpecificProps';
-/**
- * Props for the Grid component
- * @extends ComponentPropsWithoutRef<"div">
- * @extends GridSpecificProps
- */
 export type GridProps = ComponentPropsWithoutRef<"div"> & {
-    /**
-     * Applies `display: inline-grid` instead of `grid`
-     */
+    /** Uses `inline-grid`; defaults to block-level `grid`. */
     inline?: boolean;
 } & GridSpecificProps & {
-    /**
-     * Responsive props for small screens (sm breakpoint).
-     */
+    /** Overrides the base Grid and layout utilities from the `sm` breakpoint up. */
     sm?: GridSpecificProps;
-    /**
-     * Responsive props for medium screens (md breakpoint).
-     */
+    /** Overrides the base Grid and layout utilities from the `md` breakpoint up. */
     md?: GridSpecificProps;
-    /**
-     * Responsive props for large screens (lg breakpoint).
-     */
+    /** Overrides the base Grid and layout utilities from the `lg` breakpoint up. */
     lg?: GridSpecificProps;
-    /**
-     * Responsive props for extra large screens (xl breakpoint).
-     */
+    /** Overrides the base Grid and layout utilities from the `xl` breakpoint up. */
     xl?: GridSpecificProps;
-    /**
-     * Responsive props for extra extra large screens (xxl breakpoint).
-     */
+    /** Overrides the base Grid and layout utilities from the `xxl` breakpoint up. */
     xxl?: GridSpecificProps;
 };
 /**
- * Grid component for creating responsive multi-column CSS Grid layouts that arrange content or tiles into evenly spaced columns and rows which reflow across breakpoints.
- *
- * Features:
- * - CSS Grid layout with full control over grid properties
- * - Support for both grid and inline-grid display modes
- * - Responsive design with breakpoint-specific props (sm, md, lg, xl, xxl)
- * - Comprehensive layout utilities for spacing, alignment, and positioning
- * - Template columns, rows, and areas configuration
- * - Auto columns and rows sizing
- * - Automatic style generation and class management
- * - Support for all standard div element props
- * - Flexible grid template and auto-sizing controls
- * - Automatic tracking ID generation for analytics
- * - Compound component structure with Item sub-component
- *
- * @example
- * <Grid templateColumns="repeat(3, 1fr)" gap="4">
- *   <Grid.Item>Grid Item 1</Grid.Item>
- *   <Grid.Item>Grid Item 2</Grid.Item>
- *   <Grid.Item>Grid Item 3</Grid.Item>
- * </Grid>
- *
- * @example
- * <Grid
- *   templateColumns="repeat(1, 1fr)"
- *   gap="2"
- *   md={{ templateColumns: "repeat(3, 1fr)", gap: "4" }}
- * >
- *   <Grid.Item>Grid Item 1</Grid.Item>
- *   <Grid.Item>Grid Item 2</Grid.Item>
- *   <Grid.Item>Grid Item 3</Grid.Item>
- * </Grid>
+ * CSS Grid container with breakpoint-specific overrides for its Grid and
+ * layout utilities.
  */
 export declare const Grid: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
-    /**
-     * Applies `display: inline-grid` instead of `grid`
-     */
+    /** Uses `inline-grid`; defaults to block-level `grid`. */
     inline?: boolean;
 } & import('..').LayoutUtilProps & {
     templateColumns?: import('react').CSSProperties["gridTemplateColumns"];
@@ -78,45 +29,17 @@ export declare const Grid: import('react').ForwardRefExoticComponent<Omit<import
     autoColumns?: import('react').CSSProperties["gridAutoColumns"];
     autoRows?: import('react').CSSProperties["gridAutoRows"];
 } & {
-    /**
-     * Responsive props for small screens (sm breakpoint).
-     */
+    /** Overrides the base Grid and layout utilities from the `sm` breakpoint up. */
     sm?: GridSpecificProps;
-    /**
-     * Responsive props for medium screens (md breakpoint).
-     */
+    /** Overrides the base Grid and layout utilities from the `md` breakpoint up. */
     md?: GridSpecificProps;
-    /**
-     * Responsive props for large screens (lg breakpoint).
-     */
+    /** Overrides the base Grid and layout utilities from the `lg` breakpoint up. */
     lg?: GridSpecificProps;
-    /**
-     * Responsive props for extra large screens (xl breakpoint).
-     */
+    /** Overrides the base Grid and layout utilities from the `xl` breakpoint up. */
     xl?: GridSpecificProps;
-    /**
-     * Responsive props for extra extra large screens (xxl breakpoint).
-     */
+    /** Overrides the base Grid and layout utilities from the `xxl` breakpoint up. */
     xxl?: GridSpecificProps;
 } & import('react').RefAttributes<HTMLDivElement>> & {
-    /**
-     * GridItem component for individual items within a CSS Grid layout.
-     *
-     * Features:
-     * - Individual grid item with full layout utility support
-     * - Automatic grid item styling and class management
-     * - Comprehensive layout utilities for positioning and sizing
-     * - Support for all standard div element props
-     * - Flexible grid positioning and sizing controls
-     * - Automatic style generation and class management
-     * - Works seamlessly with Grid component
-     * - Automatic tracking ID generation for analytics
-     *
-     * @example
-     * <Grid templateColumns="repeat(2, 1fr)" gap="4">
-     *   <Grid.Item>Grid Item 1</Grid.Item>
-     *   <Grid.Item>Grid Item 2</Grid.Item>
-     * </Grid>
-     */
+    /** Grid cell that accepts layout utilities for placement and sizing. */
     Item: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import('..').LayoutUtilProps & import('react').RefAttributes<HTMLDivElement>>;
 };

package/dist/src/components/Grid/internal/GridItem.d.ts

@@ -1,27 +1,4 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../../types';
-/**
- * Props for the GridItem component
- * @extends ComponentPropsWithoutRef<"div">
- * @extends LayoutUtilProps
- */
 export type GridItemProps = ComponentPropsWithoutRef<"div"> & LayoutUtilProps;
-/**
- * GridItem component for individual items within a CSS Grid layout.
- *
- * Features:
- * - Individual grid item with full layout utility support
- * - Automatic grid item styling and class management
- * - Comprehensive layout utilities for positioning and sizing
- * - Support for all standard div element props
- * - Flexible grid positioning and sizing controls
- * - Automatic style generation and class management
- * - Works seamlessly with Grid component
- *
- * @example
- * <Grid templateColumns="repeat(2, 1fr)" gap="4">
- *   <Grid.Item>Grid Item 1</Grid.Item>
- *   <Grid.Item>Grid Item 2</Grid.Item>
- * </Grid>
- */
 export declare const GridItem: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & LayoutUtilProps & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Grid/internal/GridSpecificProps.d.ts

@@ -1,28 +1,14 @@
 import { CSSProperties } from 'react';
 import { LayoutUtilProps } from '../../../types';
-/**
- * Grid-specific props that extend layout utilities
- * @extends LayoutUtilProps
- */
 export type GridSpecificProps = LayoutUtilProps & {
-    /**
-     * The grid template columns definition.
-     */
+    /** Defines explicit column tracks, including sizing and repeat patterns. */
     templateColumns?: CSSProperties["gridTemplateColumns"];
-    /**
-     * The grid template rows definition.
-     */
+    /** Defines explicit row tracks, including sizing and repeat patterns. */
     templateRows?: CSSProperties["gridTemplateRows"];
-    /**
-     * The grid template areas definition.
-     */
+    /** Names cells for placement through `grid-area`. */
     templateAreas?: CSSProperties["gridTemplateAreas"];
-    /**
-     * The grid auto columns definition.
-     */
+    /** Sizes implicitly created column tracks. */
     autoColumns?: CSSProperties["gridAutoColumns"];
-    /**
-     * The grid auto rows definition.
-     */
+    /** Sizes implicitly created row tracks. */
     autoRows?: CSSProperties["gridAutoRows"];
 };

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

@@ -1,74 +1,26 @@
 import { LayoutUtilProps, Size, Svg } from '../../types';
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the Icon component
- * @extends Omit<ComponentPropsWithoutRef<"span">, "children">
- * @extends Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink">
- */
 export type IconProps = Omit<ComponentPropsWithoutRef<"span">, "children"> & Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink"> & {
-    /**
-     * Apply a specific color to the icon.
-     */
+    /** Sets the wrapper color used by the SVG. */
     color?: string;
-    /**
-     * The size of the icon.
-     * @default medium
-     */
+    /** Icon scale. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large" | "xlarge">;
-    /**
-     * Assets passed in using svgr.
-     */
+    /** SVGR component rendered inside the wrapper. */
     svg: Svg;
-    /**
-     * Whether the icon should inherit the color from its parent element.
-     * @default false
-     */
+    /** Uses the parent text color when no explicit color is set. */
     inherit?: boolean;
 };
 /**
- * Icon component for displaying SVG icons with consistent styling and sizing.
- *
- * Features:
- * - SVG icon rendering with consistent styling
- * - Four predefined sizes: small, medium, large, xlarge
- * - Custom color support with optional inheritance
- * - Layout utilities for positioning and spacing
- * - Support for all standard span element props
- * - Flexible color inheritance and custom color options
- * - Consistent sizing across different icon sets
- *
- * @example
- * import Close from "@servicetitan/anvil2/assets/icons/material/round/close.svg";
- *
- * <Icon svg={Close} size="medium" />
- *
- * @example
- * import Info from "@servicetitan/anvil2/assets/icons/material/round/info.svg";
- *
- * <Icon
- *   svg={Info}
- *   size="large"
- *   color="#007bff"
- *   inherit={false}
- * />
+ * Renders an SVGR asset in a sized wrapper and makes SVG DOM IDs unique per
+ * instance.
  */
 export declare const Icon: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "ref">, "children"> & Omit<LayoutUtilProps, "flex" | "flexGrow" | "flexShrink" | "flexBasis"> & {
-    /**
-     * Apply a specific color to the icon.
-     */
+    /** Sets the wrapper color used by the SVG. */
     color?: string;
-    /**
-     * The size of the icon.
-     * @default medium
-     */
+    /** Icon scale. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large" | "xlarge">;
-    /**
-     * Assets passed in using svgr.
-     */
+    /** SVGR component rendered inside the wrapper. */
     svg: Svg;
-    /**
-     * Whether the icon should inherit the color from its parent element.
-     * @default false
-     */
+    /** Uses the parent text color when no explicit color is set. */
     inherit?: boolean;
 } & import('react').RefAttributes<HTMLSpanElement>>;