@servicetitan/anvil2 3.15.0 → 3.15.1

package/dist/src/beta/components/Table/formatters/presets.d.ts

@@ -1,16 +1,8 @@
-/**
- * Date format preset options
- */
+/** Named date bags for {@link dateFormatter} / {@link dateTimeFormatter}. */
 export type DateFormatPreset = "short" | "medium" | "long" | "full";
-/**
- * Time format preset options
- */
+/** Named time bags for {@link timeFormatter} / {@link dateTimeFormatter}. */
 export type TimeFormatPreset = "short" | "medium";
-/**
- * Shared date format presets used by date formatters
- */
+/** `Intl.DateTimeFormatOptions` for each {@link DateFormatPreset}. */
 export declare const dateFormatPresets: Record<DateFormatPreset, Intl.DateTimeFormatOptions>;
-/**
- * Shared time format presets used by time formatters
- */
+/** `Intl.DateTimeFormatOptions` for each {@link TimeFormatPreset}. */
 export declare const timeFormatPresets: Record<TimeFormatPreset, Intl.DateTimeFormatOptions>;

package/dist/src/beta/components/Table/formatters/timeFormatter.d.ts

@@ -1,28 +1,18 @@
 import { TimeFormatPreset } from './presets';
 export type { TimeFormatPreset };
-/**
- * Options type for the time formatter function
- */
 export type TimeFormatterOptions = {
-    /**
-     * The locale to use for the time formatter
-     * @default "en-US"
-     */
+    /** `Intl` locale. Defaults to `"en-US"`. */
     locale?: Intl.LocalesArgument;
     /**
-     * The format preset or Intl.DateTimeFormatOptions object
-     * - "short": 08:30 AM
-     * - "medium": 08:30:00 AM
-     * - Intl.DateTimeFormatOptions: Custom format (e.g., { hour: "2-digit", minute: "2-digit", hour12: false })
-     * @default "short"
+     * Preset name or a custom `Intl.DateTimeFormatOptions` bag. Preset samples
+     * below are `en-US`. Defaults to `"short"`.
+     * - `"short"`: 08:30 AM
+     * - `"medium"`: 08:30:00 AM
      */
     format?: TimeFormatPreset | Intl.DateTimeFormatOptions;
 };
 /**
- * Helper function for formatting table cells with times, including i18n support.
- * Treats time strings as "plain times" without timezone conversion.
- * @param value - The time value to format (ISO time string "HH:mm:ss" or "HH:mm")
- * @param options - The options for the time formatter
- * @returns The formatted time string or null for undefined/null values
+ * Formats a time-of-day string (`HH:mm` or `HH:mm:ss`) as a plain time with no
+ * timezone conversion. Invalid or missing values return `null`.
  */
 export declare const timeFormatter: (value?: string | null, { locale, format }?: TimeFormatterOptions) => string | null;

package/dist/src/beta/components/Table/formatters/yearlessDateFormatter.d.ts

@@ -1,32 +1,20 @@
 import { YearlessDate } from '../../../../components/DateFieldYearless/types';
-/**
- * Yearless date format preset options
- */
+/** Named month-day bags used when `format` is a string. */
 export type YearlessDateFormatPreset = "short" | "long";
-/**
- * Options type for the yearless date formatter function
- */
 export type YearlessDateFormatterOptions = {
-    /**
-     * The locale to use for the yearless date formatter
-     * @default "en-US"
-     */
+    /** `Intl` locale. Defaults to `"en-US"`. */
     locale?: Intl.LocalesArgument;
     /**
-     * The format preset or Intl.DateTimeFormatOptions object
-     * - "short": Jan 05
-     * - "long": January 05
-     * - Intl.DateTimeFormatOptions: Custom format (e.g., { month: "long", day: "numeric" })
-     * @default "short"
+     * Preset name or a custom `Intl.DateTimeFormatOptions` bag. Preset samples
+     * below are `en-US`. Defaults to `"short"`.
+     * - `"short"`: Jan 05
+     * - `"long"`: January 05
      */
     format?: YearlessDateFormatPreset | Intl.DateTimeFormatOptions;
 };
 /**
- * Helper function for formatting table cells with month and day (no year), including i18n support
- * @param value - The yearless date value to format. Accepts:
- *   - Temporal PlainMonthDay string format: "--MM-DD" (e.g., "--01-15")
- *   - YearlessDate object: { month: number, day: number }
- * @param options - The options for the yearless date formatter
- * @returns The formatted month-day string or null for undefined/null values
+ * Formats a month and day with no year. Accepts Temporal PlainMonthDay
+ * (`"--MM-DD"`) or a {@link YearlessDate} object. Invalid or missing values
+ * return `null`.
  */
 export declare const yearlessDateFormatter: (value?: string | YearlessDate | null, { locale, format }?: YearlessDateFormatterOptions) => string | null;

package/dist/src/beta/components/Table/internal/ResizeHandle.d.ts

@@ -1,19 +1,15 @@
 import { Header } from '@tanstack/react-table';
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the ResizeHandle component
- * @property {Header<T, unknown>} header - The header instance from TanStack Table
- * @property {() => void} [onResizeStart] - Callback fired before resize begins, useful for initializing state
- */
 export type ResizeHandleProps<T> = {
+    /** Header whose column width the pointer gesture controls. */
     header: Header<T, unknown>;
+    /** Runs before TanStack's resize handler starts the gesture. */
     onResizeStart?: () => void;
+    /** Runs when mouse or touch input ends. */
     onResizeEnd?: () => void;
 } & Omit<ComponentPropsWithoutRef<"div">, "role" | "children" | "onMouseDown" | "onTouchStart" | "onMouseUp" | "onTouchEnd" | "onDoubleClick">;
 /**
- * Resize handle component resizing table columns
- * @param props - The props for the ResizeHandle component
- * @param props.header - The header of the ResizeHandle component
- * @param props.onResizeStart - Optional callback fired before resize begins
+ * Pointer resize handle for a table column. Double-click restores the
+ * column's configured size (`defaultWidth`, else `minWidth`).
  */
 export declare function ResizeHandle<T>({ header, onResizeStart, onResizeEnd, className, ...rest }: ResizeHandleProps<T>): import("react/jsx-runtime").JSX.Element;

package/dist/src/beta/components/Table/internal/TruncateChips.d.ts

@@ -1,20 +1,11 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { ChipProps } from '../../../../components/Chip';
-/**
- * Props for the TruncateChips component
- */
 export type TruncateChipsProps = ComponentPropsWithoutRef<"div"> & {
-    /**
-     * Array of chip items to display
-     */
+    /** Chips measured in order; trailing items collapse into the overflow chip. */
     items: ChipProps[];
 };
 /**
- * TruncateChips renders a single row of chips and collapses any that don't
+ * Renders a single row of chips and collapses any that do not
  * fit into a `+N` overflow chip with a tooltip listing the hidden labels.
- *
- * Layout calculation runs in an absolutely-positioned measurement layer
- * inside the component, so the visible flex row only paints the final,
- * fully-truncated state — no flicker while widths are being computed.
  */
 export declare const TruncateChips: ({ items, className, ...rest }: TruncateChipsProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/beta/components/Table/internal/getCommonPinningClasses.d.ts

@@ -1,5 +1,6 @@
 import { Column } from '@tanstack/react-table';
 /**
- * Get the pinning-related classes for a column (overflow gradient + padding-strip bg extension).
+ * Returns first/last edge classes for a pinned column so CSS can draw the
+ * pinned region's overflow affordance.
  */
 export declare const getCommonPinningClasses: <T>(column: Column<T>) => string | undefined;

package/dist/src/beta/components/Table/internal/getCommonPinningStyles.d.ts

@@ -1,8 +1,12 @@
 import { CSSProperties } from 'react';
 import { Column } from '@tanstack/react-table';
 /**
- * Get the common styles for sticky positioning of pinned columns
- * Width is handled by CSS Grid, so only positioning is needed
+ * Positions a pinned column at TanStack's accumulated edge offset. Column
+ * width remains owned by the table's CSS grid.
  */
 export declare const getCommonPinningStyles: <T>(column: Column<T>) => CSSProperties;
+/**
+ * Sticky edge offsets for pinned columns; unpinned cells share one frozen
+ * style object.
+ */
 export declare const useCommonPinningStyles: <T>(column: Column<T>) => CSSProperties;

package/dist/src/beta/components/Table/internal/scrollCellIntoView.d.ts

@@ -1,11 +1,7 @@
 /**
- * Scrolls a table cell into view, accounting for sticky headers/footers and pinned columns.
- * Used for keyboard navigation to ensure focused cells are visible.
- *
- * @param element - The cell element to scroll into view
- * @param stickyDimensions - The dimensions of pinned columns
- * @param stickyDimensions.leftWidth - Width of left-pinned columns
- * @param stickyDimensions.rightWidth - Width of right-pinned columns
+ * Smoothly reveals a keyboard-targeted cell without placing it beneath sticky
+ * row groups or pinned columns. Header and footer cells scroll only
+ * horizontally.
  */
 export declare function scrollCellIntoView(element: HTMLElement, stickyDimensions: {
     leftWidth: number;

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

@@ -1,13 +1,8 @@
 /**
- * The position of a cell in the table
+ * Zero-based coordinates in the rendered table grid. `rowIndex` counts header
+ * rows, then body rows, then footer rows in one sequence.
  */
 export type CellPosition = {
-    /**
-     * The row index of the cell
-     */
     rowIndex: number;
-    /**
-     * The column index of the cell
-     */
     columnIndex: number;
 };