@texturehq/edges 1.1.1 → 1.2.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { I as Icon, B as BaseDataPoint, Y as YFormatType, T as TooltipData, a as IconName$2 } from './server-DkP8PI1p.js';
-export { A as ActionItem, c as ActionMenu, b as ActionMenuProps, e as AppShell, d as AppShellProps, g as Avatar, f as AvatarProps, i as Badge, h as BadgeProps, k as Card, C as CardProps, j as CardVariant, V as ChartContext, X as ChartMargin, o as CodeEditor, l as CodeEditorProps, m as CodeLanguage, n as CodeTheme, p as DateField, D as DateFieldProps, q as FileUpload, F as FileUploadProps, H as Heading, t as InteractiveMap, s as InteractiveMapProps, L as Loader, r as Logo, u as MAPBOX_THEMES, M as MapPoint, x as Meter, w as MeterProps, y as RichTextEditor, R as RichTextEditorProps, E as SegmentOption, G as SegmentedControl, z as SegmentedControlProps, N as SideNav, J as SideNavItem, K as SideNavProps, v as StaticMap, S as StaticMapProps, O as TextLink, U as TooltipSeries, Q as TopNav, P as TopNavProps, a1 as YFormatSettings, a2 as clearColorCache, a3 as createCategoryColorMap, Z as createXScale, _ as createYScale, $ as defaultMargin, a4 as getContrastingTextColor, a5 as getDefaultChartColor, a6 as getDefaultColors, a7 as getResolvedColor, a8 as getThemeCategoricalColors, a0 as getYFormatSettings, a9 as isLightColor, W as useChartContext } from './server-DkP8PI1p.js';
+import { I as Icon, B as BaseDataPoint, Y as YFormatType, T as TooltipData, a as IconName$2 } from './server-C1hypeJ9.js';
+export { A as ActionItem, c as ActionMenu, b as ActionMenuProps, e as AppShell, d as AppShellProps, g as Avatar, f as AvatarProps, i as Badge, h as BadgeProps, k as Card, C as CardProps, j as CardVariant, V as ChartContext, X as ChartMargin, o as CodeEditor, l as CodeEditorProps, m as CodeLanguage, n as CodeTheme, p as DateField, D as DateFieldProps, q as FileUpload, F as FileUploadProps, H as Heading, t as InteractiveMap, s as InteractiveMapProps, L as Loader, r as Logo, u as MAPBOX_THEMES, M as MapPoint, x as Meter, w as MeterProps, y as RichTextEditor, R as RichTextEditorProps, E as SegmentOption, G as SegmentedControl, z as SegmentedControlProps, N as SideNav, J as SideNavItem, K as SideNavProps, v as StaticMap, S as StaticMapProps, O as TextLink, U as TooltipSeries, Q as TopNav, P as TopNavProps, a1 as YFormatSettings, a2 as clearColorCache, a3 as createCategoryColorMap, Z as createXScale, _ as createYScale, $ as defaultMargin, a4 as getContrastingTextColor, a5 as getDefaultChartColor, a6 as getDefaultColors, a7 as getResolvedColor, a8 as getThemeCategoricalColors, a0 as getYFormatSettings, a9 as isLightColor, W as useChartContext } from './server-C1hypeJ9.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React$1 from 'react';
 import React__default, { ComponentProps, ReactNode, ComponentType, Component, ErrorInfo } from 'react';
@@ -264,11 +264,34 @@ declare const toKA: (value: number | null | undefined, decimals?: number) => str
  */
 
 /**
- * Format date to string with various options
+ * Format date to a localized string with optional time and timezone.
+ *
+ * @param value - Date value (string, Date object, or timestamp)
+ * @param showTime - Whether to include time in the output (default: false)
+ * @param timezone - Optional timezone for display (e.g., "America/New_York")
+ * @returns Formatted date string or null
+ *
+ * @example
+ * ```typescript
+ * toDateString(new Date()); // "12/25/2023"
+ * toDateString(new Date(), true); // "12/25/2023, 3:30 PM"
+ * toDateString("2023-12-25T15:30:00Z", true, "America/New_York"); // "12/25/2023, 10:30 AM"
+ * ```
  */
 declare const toDateString: (value: string | Date | number | null | undefined, showTime?: boolean, timezone?: string) => string | null;
 /**
- * Format date to relative time (e.g., "2 hours ago")
+ * Format date to relative time (e.g., "2 hours ago", "in 3 days").
+ * Automatically chooses the most appropriate unit.
+ *
+ * @param value - Date value (string, Date object, or timestamp)
+ * @returns Relative time string or null
+ *
+ * @example
+ * ```typescript
+ * toRelativeTime(new Date(Date.now() - 3600000)); // "1 hour ago"
+ * toRelativeTime(new Date(Date.now() + 86400000)); // "in 1 day"
+ * toRelativeTime(new Date()); // "now"
+ * ```
  */
 declare const toRelativeTime: (value: string | Date | number | null | undefined) => string | null;
 /**
@@ -638,11 +661,32 @@ declare const toUpperCase: (text: string | null | undefined) => string;
  */
 declare const toLowerCase: (text: string | null | undefined) => string;
 /**
- * Convert text to sentence case
+ * Convert text to sentence case (first letter capitalized, rest lowercase).
+ *
+ * @param text - Text to convert
+ * @returns Sentence-cased text
+ *
+ * @example
+ * ```typescript
+ * toSentenceCase("HELLO WORLD"); // "Hello world"
+ * toSentenceCase("hello world"); // "Hello world"
+ * ```
  */
 declare const toSentenceCase: (text: string | null | undefined) => string;
 /**
- * Convert text to title case
+ * Convert text to title case with proper handling of articles and prepositions.
+ * Capitalizes the first letter of each word except common articles/prepositions
+ * (unless they're the first word).
+ *
+ * @param text - Text to convert
+ * @returns Title-cased text
+ *
+ * @example
+ * ```typescript
+ * toTitleCase("the quick brown fox"); // "The Quick Brown Fox"
+ * toTitleCase("war and peace"); // "War and Peace"
+ * toTitleCase("to be or not to be"); // "To Be or Not to Be"
+ * ```
  */
 declare const toTitleCase: (text: string | null | undefined) => string;
 /**
@@ -983,6 +1027,12 @@ interface AreaSeriesProps {
     label?: string;
     categoryColors?: Record<string, string>;
 }
+/**
+ * AreaSeries
+ *
+ * Chart component for rendering area charts with gradient fill.
+ * Displays data as a filled area with optional line path, supporting animations and custom colors.
+ */
 declare const AreaSeries: React__default.FC<AreaSeriesProps>;
 
 interface BarSeriesProps {
@@ -992,6 +1042,12 @@ interface BarSeriesProps {
     opacity?: number;
     categoryColors?: Record<string, string>;
 }
+/**
+ * BarSeries
+ *
+ * Chart component for rendering bar/column charts.
+ * Displays data as vertical bars with customizable colors, opacity, and category-based coloring.
+ */
 declare const BarSeries: React__default.FC<BarSeriesProps>;
 
 interface AxisBottomProps {
@@ -1004,6 +1060,12 @@ interface AxisLeftProps {
     scale: ScaleLinear<number, number>;
     yFormatType: YFormatType;
 }
+/**
+ * ChartAxis
+ *
+ * Chart axis components for rendering X and Y axes.
+ * Provides formatted bottom (time) and left (numeric) axes with customizable tick formatting.
+ */
 declare const ChartAxis: {
     Bottom: React__default.FC<AxisBottomProps>;
     Left: React__default.FC<AxisLeftProps>;
@@ -1023,7 +1085,30 @@ interface ChartExportMetadata {
     timestamp?: boolean;
 }
 /**
- * Main export function that handles all export types
+ * Main export function that handles all chart export types.
+ * Supports CSV, SVG, and PNG formats with automatic filename generation.
+ *
+ * @param type - Export format: "csv", "svg", or "png"
+ * @param datasets - Chart data as single array or array of arrays for multi-series
+ * @param metadata - Export metadata including labels and filename options
+ * @param svgRef - Reference to the chart's SVG element
+ * @returns Promise that resolves when export is complete
+ *
+ * @example
+ * ```typescript
+ * // Export single series as CSV
+ * await exportChart("csv", data, {
+ *   xLabel: "Date",
+ *   yLabel: "Value",
+ *   filename: "sales-data"
+ * }, svgRef);
+ *
+ * // Export multi-series chart as PNG
+ * await exportChart("png", [series1, series2], {
+ *   seriesLabels: ["Revenue", "Profit"],
+ *   timestamp: false
+ * }, svgRef);
+ * ```
  */
 declare function exportChart(type: ExportType, datasets: BaseDataPoint[][] | BaseDataPoint[], metadata: ChartExportMetadata | undefined, svgRef: React__default.RefObject<SVGSVGElement>): Promise<void>;
 /**
@@ -1043,6 +1128,12 @@ interface ChartBottomBarProps {
     items: LegendItem[];
     onExport: (type: ExportType) => void | Promise<void>;
 }
+/**
+ * ChartBottomBar
+ *
+ * Chart footer component with legend and export functionality.
+ * Displays color-coded legend items and provides export options for CSV, SVG, and PNG formats.
+ */
 declare const ChartBottomBar: React__default.FC<ChartBottomBarProps>;
 
 interface ChartContainerProps {
@@ -1052,12 +1143,24 @@ interface ChartContainerProps {
     yFormatType?: YFormatType;
     isLoading?: boolean;
 }
+/**
+ * ChartContainer
+ *
+ * Main chart wrapper component that provides context and layout for chart visualizations.
+ * Handles scaling, tooltips, axes, and data management for area, line, and bar charts.
+ */
 declare const ChartContainer: React__default.FC<Omit<ChartContainerProps, "parentWidth" | "parentHeight">>;
 
 interface ChartTooltipProps {
     data: TooltipData | null;
     formatType: YFormatType;
 }
+/**
+ * ChartTooltip
+ *
+ * Interactive tooltip component for charts.
+ * Displays formatted data values at hover position with automatic positioning and animations.
+ */
 declare const ChartTooltip: React__default.FC<ChartTooltipProps>;
 
 interface LineSeriesProps {
@@ -1069,6 +1172,12 @@ interface LineSeriesProps {
     strokeDasharray?: string;
     categoryColors?: Record<string, string>;
 }
+/**
+ * LineSeries
+ *
+ * Chart component for rendering line charts.
+ * Displays data as a continuous line with customizable stroke width, color, and dash patterns.
+ */
 declare const LineSeries: React__default.FC<LineSeriesProps>;
 
 type SortDirection = "asc" | "desc";
@@ -1142,6 +1251,9 @@ interface DataTableProps<T> {
     "aria-label"?: string;
 }
 
+/**
+ * Action configuration for ActionCell
+ */
 interface Action<T = any> {
     id: string;
     label?: string;
@@ -1156,6 +1268,12 @@ interface ActionCellProps<T = any> extends CellComponentProps<T> {
     align?: "left" | "center" | "right";
     size?: "sm" | "md" | "lg";
 }
+/**
+ * ActionCell
+ *
+ * DataTable cell component for rendering action buttons within table rows.
+ * Supports multiple actions with icons, labels, and conditional visibility/disabled states.
+ */
 declare function ActionCell<T = any>({ row, context, actions, align, size, }: ActionCellProps<T>): react_jsx_runtime.JSX.Element | null;
 
 interface BooleanCellProps<T = any> extends CellComponentProps<T> {
@@ -1168,6 +1286,12 @@ interface BooleanCellProps<T = any> extends CellComponentProps<T> {
     align?: "left" | "center" | "right";
     emphasis?: CellEmphasis;
 }
+/**
+ * BooleanCell
+ *
+ * DataTable cell component for displaying boolean values.
+ * Supports multiple display formats including icons, text, or badges with customizable true/false representations.
+ */
 declare function BooleanCell<T = any>({ value, context, format, trueText, falseText, trueIcon, falseIcon, showFalse, align, emphasis, }: BooleanCellProps<T>): react_jsx_runtime.JSX.Element | null;
 
 /**
@@ -1226,6 +1350,12 @@ interface DateCellProps<T = any> extends CellComponentProps<T> {
     href?: string | ((row: T) => string);
     linkBehavior?: LinkBehavior;
 }
+/**
+ * DateCell
+ *
+ * DataTable cell component for displaying date and time values.
+ * Supports multiple formats including relative time, with optional linking capabilities.
+ */
 declare function DateCell<T = any>({ value, row, context, format, customFormat, emptyText, align, emphasis, href, linkBehavior, }: DateCellProps<T>): react_jsx_runtime.JSX.Element;
 
 interface NumberCellProps<T = any> extends CellComponentProps<T> {
@@ -1241,6 +1371,12 @@ interface NumberCellProps<T = any> extends CellComponentProps<T> {
     showPositiveSign?: boolean;
     colorCode?: boolean;
 }
+/**
+ * NumberCell
+ *
+ * DataTable cell component for displaying numeric values.
+ * Supports currency, percentage, and compact formatting with optional color coding for positive/negative values.
+ */
 declare function NumberCell<T = any>({ value, row, context, format, decimals, prefix, suffix, emptyText, align, emphasis, href, linkBehavior, showPositiveSign, colorCode, }: NumberCellProps<T>): react_jsx_runtime.JSX.Element;
 
 interface SelectCellProps<T = any> extends CellComponentProps<T> {
@@ -1249,6 +1385,12 @@ interface SelectCellProps<T = any> extends CellComponentProps<T> {
     isDisabled?: boolean | ((row: T) => boolean);
     align?: "left" | "center" | "right";
 }
+/**
+ * SelectCell
+ *
+ * DataTable cell component for row selection.
+ * Renders a checkbox that allows users to select individual rows in the table.
+ */
 declare function SelectCell<T = any>({ row, context, isSelected, onSelect, isDisabled, align, }: SelectCellProps<T>): react_jsx_runtime.JSX.Element;
 
 interface TextCellProps<T = any> extends CellComponentProps<T> {
@@ -1261,8 +1403,20 @@ interface TextCellProps<T = any> extends CellComponentProps<T> {
     truncate?: boolean;
     align?: "left" | "center" | "right";
 }
+/**
+ * TextCell
+ *
+ * DataTable cell component for displaying text content.
+ * Supports prefixes, suffixes, truncation, and optional linking with customizable emphasis levels.
+ */
 declare function TextCell<T = any>({ value, row, context, prefix, suffix, emptyText, href, linkBehavior, emphasis, truncate, align, }: TextCellProps<T>): react_jsx_runtime.JSX.Element;
 
+/**
+ * DataTable
+ *
+ * Advanced table component with sorting, filtering, pagination, and mobile-responsive views.
+ * Supports custom cell renderers, column configurations, and multiple display densities.
+ */
 declare function DataTable<T extends Record<string, unknown>>({ columns, data, className, density, width, height, maxHeight, layout, mobileRenderer, customMobileRowRender, mobileBreakpoint, isLoading, loadingRowCount, stickyHeader, onRowClick, getRowId, hideHeader, onSort, "aria-label": ariaLabel, }: DataTableProps<T>): react_jsx_runtime.JSX.Element;
 
 interface MobileRowProps<T> {
@@ -1365,6 +1519,12 @@ interface State {
     hasError: boolean;
     error?: Error;
 }
+/**
+ * ErrorBoundary
+ *
+ * React error boundary component for graceful error handling.
+ * Catches JavaScript errors in child components and displays a fallback UI with retry option.
+ */
 declare class ErrorBoundary extends Component<Props, State> {
     state: State;
     static getDerivedStateFromError(error: Error): State;
@@ -2228,6 +2388,12 @@ interface SkeletonProps {
     className?: string;
     "data-testid"?: string;
 }
+/**
+ * Skeleton
+ *
+ * Loading placeholder component that mimics content structure.
+ * Supports various shapes, animations, and responsive configurations for skeleton screens.
+ */
 declare const Skeleton: React__default.FC<SkeletonProps>;
 
 interface SliderProps {
@@ -2369,6 +2535,12 @@ declare function StatList({ items, layout, dense, valueAlign, showDividers, skel
 interface SwitchProps extends Omit<SwitchProps$1, "children"> {
     children: React__default.ReactNode;
 }
+/**
+ * Switch
+ *
+ * Toggle switch component for binary on/off states.
+ * Provides an accessible alternative to checkboxes for settings and preferences.
+ */
 declare function Switch({ children, ...props }: SwitchProps): react_jsx_runtime.JSX.Element;
 
 type TabVariant = "default" | "accent";
@@ -2449,6 +2621,12 @@ interface TextAreaWithChipsProps extends Omit<React__default.TextareaHTMLAttribu
     chipVariant?: "default" | "primary" | "secondary";
     chipSize?: Size;
 }
+/**
+ * TextAreaWithChips
+ *
+ * Enhanced textarea component with chip/tag support.
+ * Enables rich text input with embedded chips for mentions, tags, or structured data entry.
+ */
 declare function TextAreaWithChips({ label, description, errorMessage, size, tooltip, required, transparent, isInvalid, isDisabled, className, validationResult, value, onChange, chips, onChipsChange, triggerPattern, onTriggerDetected, onTriggerDismissed, renderChip, chipVariant, chipSize, ...props }: TextAreaWithChipsProps): react_jsx_runtime.JSX.Element;
 
 /**