@apotech-os/ui-sdk 2.5.0 → 2.6.0

package/dist/index.d.cts

@@ -444,6 +444,12 @@ interface PeriodPreset {
 /** The rail, in the order it is offered. `custom` is reached by picking days. */
 declare const PERIOD_PRESETS: readonly PeriodPreset[];
 declare const COMPARE_LABELS: Record<PeriodCompareMode, string>;
+/**
+ * The comparison as the trigger says it, next to a range that already takes the
+ * width. `COMPARE_LABELS` is what the panel offers; this is what a button can
+ * afford to show.
+ */
+declare const COMPARE_SHORT_LABELS: Record<PeriodCompareMode, string>;
 /**
  * The window a comparison mode resolves to, or undefined when there is nothing
  * to compare against — `none`, an unbounded period, or `custom`, whose range the
@@ -472,11 +478,18 @@ interface DateRangeCompareProps {
     comparable?: boolean;
     /** Override the rail — a subset, or presets in another order. */
     presets?: readonly PeriodPreset[];
+    /**
+     * How many months the grid shows. `'auto'` widens to two whenever the range
+     * straddles them. One by default: two doubles the panel's width, which a
+     * dashboard header rarely has, and a range wider than the grid stays correctly
+     * highlighted on the part that is visible.
+     */
+    months?: 1 | 2 | 'auto';
     align?: 'start' | 'end';
     disabled?: boolean;
     className?: string;
 }
-declare function DateRangeCompare({ value, onChange, comparable, presets, align, disabled, className, }: DateRangeCompareProps): React.JSX.Element;
+declare function DateRangeCompare({ value, onChange, comparable, presets, months, align, disabled, className, }: DateRangeCompareProps): React.JSX.Element;
 /** A day range with both ends — what the pre-contract-2 picker spoke. */
 interface DateRange {
     from: string;
@@ -494,6 +507,9 @@ interface DateRangePickerProps {
  *
  * It stays because removing an export breaks the contract, and its signature is
  * unchanged: a caller that only ever wanted two days keeps passing two days.
+ * `months` is pinned to the old behaviour for the same reason — one month is the
+ * answer to a panel crowding a dashboard header, a problem a picker with no rail
+ * does not have.
  */
 declare function DateRangePicker({ value, onChange, className, disabled }: DateRangePickerProps): React.JSX.Element;
 
@@ -655,4 +671,4 @@ declare function toCsv(rows: string[][]): string;
  */
 declare function downloadCsv(rows: string[][], filename: string): void;
 
-export { type AppApiClient, AppApiProvider, AppContextProvider, type AppContextValue, AppInvokeError, AreaChart, Badge, type BadgeProps, BarChart, Button, type ButtonProps, COMPARE_LABELS, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, type CartesianChartProps, type ChartRow, type ChartSeries, Checkbox, type CheckboxProps, CopyButton, type CopyButtonProps, DataTable, type DataTableColumn, type DataTableFacet, type DataTableFilter, type DataTableFilterOperator, type DataTablePagination, type DataTableProps, type DataTableSort, type DataTableState, type DateRange, DateRangeCompare, type DateRangeCompareProps, DateRangePicker, type DateRangePickerProps, DropdownMenu, type DropdownMenuItem, type DropdownMenuProps, FunnelChart, type FunnelChartProps, type FunnelStep, Input, KpiCard, type KpiCardProps, LineChart, Link, type LinkProps, Modal, type ModalProps, PERIOD_PRESETS, type PeriodCompareMode, type PeriodPreset, type PeriodPresetKey, type PeriodRange, type PeriodValue, Popover, type PopoverProps, Select, type SelectOption, type SelectProps, SidePanel, type SidePanelProps, Spinner, type SpinnerProps, StackedBarChart, Switch, type SwitchProps, Table, TableBody, TableCell, TableHead, TableHeader, TableRow, Tabs, TabsContent, TabsList, type TabsProps, TabsTrigger, Textarea, type TextareaProps, type ToastInput, ToastProvider, Tooltip, type TooltipProps, type ValueFormatter, badgeVariants, buttonVariants, cn, comparisonRange, copyToClipboard, downloadBlob, downloadCsv, formatPeriod, formatRange, makePeriod, periodFromPreset, relativeDelta, toCsv, useAppApi, useAppContext, useAppRun, useAppRuns, useAppSettings, useToast };
+export { type AppApiClient, AppApiProvider, AppContextProvider, type AppContextValue, AppInvokeError, AreaChart, Badge, type BadgeProps, BarChart, Button, type ButtonProps, COMPARE_LABELS, COMPARE_SHORT_LABELS, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, type CartesianChartProps, type ChartRow, type ChartSeries, Checkbox, type CheckboxProps, CopyButton, type CopyButtonProps, DataTable, type DataTableColumn, type DataTableFacet, type DataTableFilter, type DataTableFilterOperator, type DataTablePagination, type DataTableProps, type DataTableSort, type DataTableState, type DateRange, DateRangeCompare, type DateRangeCompareProps, DateRangePicker, type DateRangePickerProps, DropdownMenu, type DropdownMenuItem, type DropdownMenuProps, FunnelChart, type FunnelChartProps, type FunnelStep, Input, KpiCard, type KpiCardProps, LineChart, Link, type LinkProps, Modal, type ModalProps, PERIOD_PRESETS, type PeriodCompareMode, type PeriodPreset, type PeriodPresetKey, type PeriodRange, type PeriodValue, Popover, type PopoverProps, Select, type SelectOption, type SelectProps, SidePanel, type SidePanelProps, Spinner, type SpinnerProps, StackedBarChart, Switch, type SwitchProps, Table, TableBody, TableCell, TableHead, TableHeader, TableRow, Tabs, TabsContent, TabsList, type TabsProps, TabsTrigger, Textarea, type TextareaProps, type ToastInput, ToastProvider, Tooltip, type TooltipProps, type ValueFormatter, badgeVariants, buttonVariants, cn, comparisonRange, copyToClipboard, downloadBlob, downloadCsv, formatPeriod, formatRange, makePeriod, periodFromPreset, relativeDelta, toCsv, useAppApi, useAppContext, useAppRun, useAppRuns, useAppSettings, useToast };

package/dist/index.d.ts

@@ -444,6 +444,12 @@ interface PeriodPreset {
 /** The rail, in the order it is offered. `custom` is reached by picking days. */
 declare const PERIOD_PRESETS: readonly PeriodPreset[];
 declare const COMPARE_LABELS: Record<PeriodCompareMode, string>;
+/**
+ * The comparison as the trigger says it, next to a range that already takes the
+ * width. `COMPARE_LABELS` is what the panel offers; this is what a button can
+ * afford to show.
+ */
+declare const COMPARE_SHORT_LABELS: Record<PeriodCompareMode, string>;
 /**
  * The window a comparison mode resolves to, or undefined when there is nothing
  * to compare against — `none`, an unbounded period, or `custom`, whose range the
@@ -472,11 +478,18 @@ interface DateRangeCompareProps {
     comparable?: boolean;
     /** Override the rail — a subset, or presets in another order. */
     presets?: readonly PeriodPreset[];
+    /**
+     * How many months the grid shows. `'auto'` widens to two whenever the range
+     * straddles them. One by default: two doubles the panel's width, which a
+     * dashboard header rarely has, and a range wider than the grid stays correctly
+     * highlighted on the part that is visible.
+     */
+    months?: 1 | 2 | 'auto';
     align?: 'start' | 'end';
     disabled?: boolean;
     className?: string;
 }
-declare function DateRangeCompare({ value, onChange, comparable, presets, align, disabled, className, }: DateRangeCompareProps): React.JSX.Element;
+declare function DateRangeCompare({ value, onChange, comparable, presets, months, align, disabled, className, }: DateRangeCompareProps): React.JSX.Element;
 /** A day range with both ends — what the pre-contract-2 picker spoke. */
 interface DateRange {
     from: string;
@@ -494,6 +507,9 @@ interface DateRangePickerProps {
  *
  * It stays because removing an export breaks the contract, and its signature is
  * unchanged: a caller that only ever wanted two days keeps passing two days.
+ * `months` is pinned to the old behaviour for the same reason — one month is the
+ * answer to a panel crowding a dashboard header, a problem a picker with no rail
+ * does not have.
  */
 declare function DateRangePicker({ value, onChange, className, disabled }: DateRangePickerProps): React.JSX.Element;
 
@@ -655,4 +671,4 @@ declare function toCsv(rows: string[][]): string;
  */
 declare function downloadCsv(rows: string[][], filename: string): void;
 
-export { type AppApiClient, AppApiProvider, AppContextProvider, type AppContextValue, AppInvokeError, AreaChart, Badge, type BadgeProps, BarChart, Button, type ButtonProps, COMPARE_LABELS, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, type CartesianChartProps, type ChartRow, type ChartSeries, Checkbox, type CheckboxProps, CopyButton, type CopyButtonProps, DataTable, type DataTableColumn, type DataTableFacet, type DataTableFilter, type DataTableFilterOperator, type DataTablePagination, type DataTableProps, type DataTableSort, type DataTableState, type DateRange, DateRangeCompare, type DateRangeCompareProps, DateRangePicker, type DateRangePickerProps, DropdownMenu, type DropdownMenuItem, type DropdownMenuProps, FunnelChart, type FunnelChartProps, type FunnelStep, Input, KpiCard, type KpiCardProps, LineChart, Link, type LinkProps, Modal, type ModalProps, PERIOD_PRESETS, type PeriodCompareMode, type PeriodPreset, type PeriodPresetKey, type PeriodRange, type PeriodValue, Popover, type PopoverProps, Select, type SelectOption, type SelectProps, SidePanel, type SidePanelProps, Spinner, type SpinnerProps, StackedBarChart, Switch, type SwitchProps, Table, TableBody, TableCell, TableHead, TableHeader, TableRow, Tabs, TabsContent, TabsList, type TabsProps, TabsTrigger, Textarea, type TextareaProps, type ToastInput, ToastProvider, Tooltip, type TooltipProps, type ValueFormatter, badgeVariants, buttonVariants, cn, comparisonRange, copyToClipboard, downloadBlob, downloadCsv, formatPeriod, formatRange, makePeriod, periodFromPreset, relativeDelta, toCsv, useAppApi, useAppContext, useAppRun, useAppRuns, useAppSettings, useToast };
+export { type AppApiClient, AppApiProvider, AppContextProvider, type AppContextValue, AppInvokeError, AreaChart, Badge, type BadgeProps, BarChart, Button, type ButtonProps, COMPARE_LABELS, COMPARE_SHORT_LABELS, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, type CartesianChartProps, type ChartRow, type ChartSeries, Checkbox, type CheckboxProps, CopyButton, type CopyButtonProps, DataTable, type DataTableColumn, type DataTableFacet, type DataTableFilter, type DataTableFilterOperator, type DataTablePagination, type DataTableProps, type DataTableSort, type DataTableState, type DateRange, DateRangeCompare, type DateRangeCompareProps, DateRangePicker, type DateRangePickerProps, DropdownMenu, type DropdownMenuItem, type DropdownMenuProps, FunnelChart, type FunnelChartProps, type FunnelStep, Input, KpiCard, type KpiCardProps, LineChart, Link, type LinkProps, Modal, type ModalProps, PERIOD_PRESETS, type PeriodCompareMode, type PeriodPreset, type PeriodPresetKey, type PeriodRange, type PeriodValue, Popover, type PopoverProps, Select, type SelectOption, type SelectProps, SidePanel, type SidePanelProps, Spinner, type SpinnerProps, StackedBarChart, Switch, type SwitchProps, Table, TableBody, TableCell, TableHead, TableHeader, TableRow, Tabs, TabsContent, TabsList, type TabsProps, TabsTrigger, Textarea, type TextareaProps, type ToastInput, ToastProvider, Tooltip, type TooltipProps, type ValueFormatter, badgeVariants, buttonVariants, cn, comparisonRange, copyToClipboard, downloadBlob, downloadCsv, formatPeriod, formatRange, makePeriod, periodFromPreset, relativeDelta, toCsv, useAppApi, useAppContext, useAppRun, useAppRuns, useAppSettings, useToast };