@carto/ps-react-ui 4.3.0-widgets.0 → 5.0.0-widgets.2

package/dist/types/widgets/no-data/no-data.d.ts

@@ -0,0 +1,35 @@
+import { NoDataProps } from './types';
+/**
+ * NoData wrapper component that displays empty state UI when widget has no data
+ *
+ * Integrates with widget store to check loading/fetching state and data availability.
+ * Works in conjunction with SkeletonLoader for complete loading/empty state handling.
+ *
+ * @example Basic usage
+ * ```tsx
+ * <NoData id="my-widget">
+ *   <WidgetContent id="my-widget" />
+ * </NoData>
+ * ```
+ *
+ * @example With SkeletonLoader
+ * ```tsx
+ * <SkeletonLoader id="my-widget" Skeleton={MySkeleton}>
+ *   <NoData id="my-widget">
+ *     <WidgetContent id="my-widget" />
+ *   </NoData>
+ * </SkeletonLoader>
+ * ```
+ *
+ * @example With custom messages
+ * ```tsx
+ * <NoData
+ *   id="my-widget"
+ *   title="No results found"
+ *   description="Try adjusting your filters"
+ * >
+ *   <WidgetContent id="my-widget" />
+ * </NoData>
+ * ```
+ */
+export declare function NoData({ id, children, title, description, isEmpty, }: NoDataProps): string | number | bigint | boolean | Iterable<import('react').ReactNode> | Promise<string | number | bigint | boolean | import('react').ReactPortal | import('react').ReactElement<unknown, string | import('react').JSXElementConstructor<any>> | Iterable<import('react').ReactNode> | null | undefined> | import("react/jsx-runtime").JSX.Element | null | undefined;

package/dist/types/widgets/no-data/style.d.ts

@@ -0,0 +1,6 @@
+import { SxProps, Theme } from '@mui/material';
+/**
+ * Styles for NoData component matching Figma design specifications
+ * Design reference: node 5781-11028
+ */
+export declare const styles: Record<string, SxProps<Theme>>;

package/dist/types/widgets/no-data/types.d.ts

@@ -0,0 +1,67 @@
+import { ReactNode } from 'react';
+import { WidgetState } from '../stores/types';
+/**
+ * Props for the NoData wrapper component
+ *
+ * @example Basic usage
+ * ```tsx
+ * <NoData id="my-widget">
+ *   <WidgetContent id="my-widget" />
+ * </NoData>
+ * ```
+ *
+ * @example With custom messages
+ * ```tsx
+ * <NoData
+ *   id="my-widget"
+ *   title="No results found"
+ *   description="Try adjusting your filters"
+ * >
+ *   <WidgetContent id="my-widget" />
+ * </NoData>
+ * ```
+ *
+ * @example With custom isEmpty logic
+ * ```tsx
+ * <NoData
+ *   id="my-widget"
+ *   isEmpty={(data) => {
+ *     const d = data as CustomData
+ *     return !d?.items?.length
+ *   }}
+ * >
+ *   <WidgetContent id="my-widget" />
+ * </NoData>
+ * ```
+ */
+export interface NoDataProps {
+    /**
+     * Widget ID to fetch state from store
+     */
+    id: WidgetState['id'];
+    /**
+     * Children to render when data is available
+     */
+    children: ReactNode;
+    /**
+     * Optional custom title for empty state
+     * @default "No data available"
+     */
+    title?: string;
+    /**
+     * Optional custom description for empty state
+     * @default "There are no results for the combination of filters applied to your data. Try tweaking your filters, or zoom and pan the map to adjust filters"
+     */
+    description?: string;
+    /**
+     * Optional custom function to determine if data is empty
+     * If not provided, uses default isEmpty logic that handles:
+     * - null/undefined → empty
+     * - [] (empty array) → empty
+     * - [[]] (nested empty arrays) → empty
+     * - {} (empty object) → empty
+     * - Primitives → not empty
+     * - Arrays/objects with content → not empty
+     */
+    isEmpty?: (data: unknown) => boolean;
+}

package/dist/types/widgets/note/note.d.ts

@@ -1,2 +1,2 @@
 import { NoteProps } from './types';
-export declare function Note({ id, labels }: NoteProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function Note({ children, labels }: NoteProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/types/widgets/note/style.d.ts

@@ -2,8 +2,8 @@ import { Theme } from '@mui/material';
 export declare const styles: {
     root: {
         typography: string;
-        marginBlockStart: ({ spacing }: Theme) => string;
         color: (theme: Theme) => string;
+        marginBlockStart: ({ spacing }: Theme) => string;
     };
     clamped: {
         display: "-webkit-box";
@@ -14,4 +14,15 @@ export declare const styles: {
     expanded: {
         display: "block";
     };
+    linkButton: {
+        padding: number;
+        minWidth: string;
+        textTransform: "none";
+        typography: string;
+        fontWeight: number;
+        textDecoration: string;
+        '&:hover': {
+            backgroundColor: "transparent";
+        };
+    };
 };

package/dist/types/widgets/note/types.d.ts

@@ -1,7 +1,8 @@
-import { WidgetState } from '../stores/types';
-export type NoteProps = Pick<WidgetState, 'id'> & {
+import { MarkdownComponentProps } from '../markdown';
+export interface NoteProps {
+    children: MarkdownComponentProps['children'];
     labels?: {
         showMore?: string;
         showLess?: string;
     };
-};
+}

package/dist/types/widgets/pie/config.d.ts

@@ -1,4 +1,5 @@
-import { PieConfig } from './types';
-export declare const pieConfig: (config: PieConfig & {
-    refUI?: import('react').Ref<HTMLElement | null>;
-}) => import('../_shared/chart-config/config-factory').ChartWidgetConfigResult<import('../echart').EchartWidgetData, PieConfig, "pie">;
+import { PieConfig, PieWidgetConfig, PieWidgetData } from './types';
+import { DownloadItem } from '../actions';
+import { ConfigProps } from '../root/types';
+export declare function pieDownloadConfig({ refUI, }: ConfigProps): DownloadItem<PieWidgetData>[];
+export declare function pieConfig(props: PieConfig): PieWidgetConfig;

package/dist/types/widgets/pie/index.d.ts

@@ -1,3 +1,3 @@
-export type { PieProps, PieWidgetData, PieWidgetState, PieWidgetConfig, } from './types';
-export { pieConfig } from './config';
+export type { PieWidgetData, PieWidgetState, PieWidgetConfig, PieConfig, } from './types';
+export { pieConfig, pieDownloadConfig } from './config';
 export { PieSkeleton } from './skeleton';

package/dist/types/widgets/pie/types.d.ts

@@ -1,15 +1,9 @@
-import { BaseWidgetProps } from '../widget/types';
-import { BaseConfig } from '../config-loader';
-import { EchartWidgetConfig, EchartWidgetData, EchartWidgetState } from '../echart';
-export interface PieProps extends BaseWidgetProps<PieWidgetConfig> {
-    type: 'pie';
-    data: PieWidgetData | undefined;
-}
+import { EchartWidgetData, EchartWidgetState } from '../echart';
+import { EchartWidgetOptionProps, EchartWidgetProps } from '../echart/types';
+import { ConfigProps } from '../root';
 export type PieWidgetData = EchartWidgetData;
 export type PieWidgetState = EchartWidgetState;
-export type PieWidgetConfig = PieConfig & EchartWidgetConfig & {
-    type: PieProps['type'];
+export type PieWidgetConfig = EchartWidgetProps & {
+    type: 'pie';
 };
-export interface PieConfig extends Omit<BaseConfig, 'data'> {
-    data?: PieWidgetData;
-}
+export type PieConfig = ConfigProps & EchartWidgetOptionProps<PieWidgetData>;

package/dist/types/widgets/range/config.d.ts

@@ -1,2 +1,6 @@
-import { RangeConfig, RangeWidgetConfig } from './types';
-export declare function rangeConfig({ refUI, data, ...props }: RangeConfig): RangeWidgetConfig;
+import { RangeWidgetConfig } from './types';
+export interface RangeConfigProps {
+    formatter?: (value: number) => string;
+    onChange?: (value: number[], index: number) => void;
+}
+export declare function rangeConfig(): RangeWidgetConfig;

package/dist/types/widgets/range/index.d.ts

@@ -1,5 +1,6 @@
 export { RangeUI } from './range-ui';
 export { RangeSkeleton } from './skeleton';
+export { rangeConfig } from './config';
 export { RangeItem } from './components/range-item';
-export type { RangeWidgetState, RangeUIProps, RangeDataItem, RangeWidgetData, RangeItemProps, } from './types';
+export type { RangeWidgetState, RangeWidgetConfig, RangeDownloadConfig, RangeUIProps, RangeDataItem, RangeWidgetData, RangeItemProps, } from './types';
 export { sanitizeRangeDataItem, sanitizeRangeDataItems } from './serializer';

package/dist/types/widgets/range/types.d.ts

@@ -1,14 +1,7 @@
 import { ReactNode } from 'react';
 import { BaseWidgetState, WidgetsStoreProps } from '../stores/types';
-import { DownloadState } from '../actions';
-import { DownloadConfigProps } from '../actions/download/types';
 import { WrapperState } from '../wrapper/types';
-import { BaseWidgetProps } from '../widget/types';
-import { BaseConfig } from '../config-loader';
-export interface RangeProps extends BaseWidgetProps<RangeWidgetConfig> {
-    type: 'range';
-    data: RangeWidgetData | undefined;
-}
+import { DownloadItem } from '../actions/download/types';
 export interface RangeUIProps {
     id: WidgetsStoreProps['id'];
 }
@@ -30,15 +23,11 @@ export interface RangeItemProps {
     index: number;
 }
 export type RangeWidgetData = RangeDataItem[];
-export type RangeWidgetState = BaseWidgetState<WrapperState<DownloadState<RangeProps & {
+export type RangeWidgetState = BaseWidgetState<WrapperState<RangeWidgetConfig>> & {
+    data: RangeWidgetData;
+};
+export interface RangeWidgetConfig {
     formatter?: (value: number) => string;
     onChange?: (value: number[], index: number) => void;
-}, RangeWidgetData>>>;
-export type RangeWidgetConfig = BaseConfig & DownloadConfigProps<RangeWidgetData> & {
-    type: RangeProps['type'];
-    formatter?: RangeWidgetState['formatter'];
-    onChange?: RangeWidgetState['onChange'];
-};
-export interface RangeConfig extends Omit<BaseConfig, 'data'> {
-    data?: RangeWidgetData;
 }
+export type RangeDownloadConfig = DownloadItem<RangeWidgetData>[];

package/dist/types/widgets/root/index.d.ts

@@ -1,2 +1,3 @@
 export { Root } from './root';
-export type { RootProps } from './types';
+export { mergeWidgetConfig } from './utils';
+export type { RootProps, ConfigProps } from './types';

package/dist/types/widgets/root/root.d.ts

@@ -1,2 +1,2 @@
 import { RootProps } from './types';
-export declare function Root(props: RootProps): import("react/jsx-runtime").JSX.Element;
+export declare function Root<T>(props: RootProps<T>): import("react/jsx-runtime").JSX.Element;

package/dist/types/widgets/root/types.d.ts

@@ -1,15 +1,9 @@
 import { ReactNode } from 'react';
-import { WrapperUIProps } from '../wrapper';
-import { WidgetsStoreProps } from '../stores/types';
-export interface RootProps {
-    id: WidgetsStoreProps['id'];
-    type: WidgetsStoreProps['type'];
+import { WidgetsStoreProps, WidgetState } from '../stores/types';
+export interface RootProps<T> extends WidgetsStoreProps {
     children: ReactNode;
-    title: WrapperUIProps['title'];
-    data?: unknown;
-    isLoading?: WidgetsStoreProps['isLoading'];
-    isFetching?: WidgetsStoreProps['isFetching'];
-    collapsed?: WrapperUIProps['collapsed'];
-    collapsible?: WrapperUIProps['disabled'];
-    disabled?: WrapperUIProps['disabled'];
+    config?: T;
+}
+export interface ConfigProps {
+    refUI?: WidgetState['refUI'];
 }

package/dist/types/widgets/root/utils.d.ts

@@ -0,0 +1 @@
+export declare function mergeWidgetConfig<T>(...options: [T | undefined, T | undefined]): T;

package/dist/types/widgets/scatterplot/config.d.ts

@@ -1,4 +1,5 @@
-import { ScatterplotConfig, ScatterplotWidgetData } from './types';
-export declare const scatterplotConfig: (config: ScatterplotConfig & {
-    refUI?: import('react').Ref<HTMLElement | null>;
-}) => import('../_shared/chart-config/config-factory').ChartWidgetConfigResult<ScatterplotWidgetData, ScatterplotConfig, "scatterplot">;
+import { ScatterplotConfig, ScatterplotWidgetConfig, ScatterplotWidgetData } from './types';
+import { DownloadItem } from '../actions';
+import { ConfigProps } from '../root/types';
+export declare function scatterplotDownloadConfig({ refUI, }: ConfigProps): DownloadItem<ScatterplotWidgetData>[];
+export declare function scatterplotConfig(props: ScatterplotConfig): ScatterplotWidgetConfig;

package/dist/types/widgets/scatterplot/index.d.ts

@@ -1,3 +1,3 @@
-export type { ScatterplotProps, ScatterplotWidgetData, ScatterplotWidgetState, ScatterplotWidgetConfig, } from './types';
-export { scatterplotConfig } from './config';
+export type { ScatterplotWidgetData, ScatterplotWidgetState, ScatterplotWidgetConfig, ScatterplotConfig, } from './types';
+export { scatterplotConfig, scatterplotDownloadConfig } from './config';
 export { ScatterplotSkeleton } from './skeleton';

package/dist/types/widgets/scatterplot/types.d.ts

@@ -1,15 +1,9 @@
-import { BaseWidgetProps } from '../widget/types';
-import { BaseConfig } from '../config-loader';
-import { EchartWidgetConfig, EchartWidgetState } from '../echart';
-export interface ScatterplotProps extends BaseWidgetProps<ScatterplotWidgetConfig> {
-    type: 'scatterplot';
-    data: ScatterplotWidgetData | undefined;
-}
+import { EchartWidgetState } from '../echart';
+import { EchartWidgetOptionProps, EchartWidgetProps } from '../echart/types';
+import { ConfigProps } from '../root';
 export type ScatterplotWidgetData = [number, number][][];
 export type ScatterplotWidgetState = EchartWidgetState;
-export type ScatterplotWidgetConfig = ScatterplotConfig & EchartWidgetConfig<ScatterplotWidgetData> & {
-    type: ScatterplotProps['type'];
+export type ScatterplotWidgetConfig = EchartWidgetProps & {
+    type: 'scatterplot';
 };
-export interface ScatterplotConfig extends Omit<BaseConfig, 'data'> {
-    data?: ScatterplotWidgetData;
-}
+export type ScatterplotConfig = ConfigProps & EchartWidgetOptionProps<ScatterplotWidgetData>;

package/dist/types/widgets/selection-summary/index.d.ts

@@ -0,0 +1,2 @@
+export { SelectionSummary } from './selection-summary';
+export type { SelectedProps, SelectionSummaryLabels } from './types';

package/dist/types/widgets/selection-summary/selection-summary.d.ts

@@ -0,0 +1,2 @@
+import { SelectedProps } from './types';
+export declare function SelectionSummary({ selections, onClear, labels, }: SelectedProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/widgets/selection-summary/style.d.ts

@@ -0,0 +1,9 @@
+import { Theme } from '@mui/material';
+export declare const styles: {
+    root: {
+        display: "flex";
+        alignItems: "center";
+        flex: string;
+        gap: ({ spacing }: Theme) => string;
+    };
+};

package/dist/types/widgets/selection-summary/types.d.ts

@@ -0,0 +1,13 @@
+export interface SelectedProps {
+    selections: number;
+    onClear?: () => void;
+    labels?: Partial<SelectionSummaryLabels>;
+}
+export interface SelectionSummaryLabels {
+    /** Label for "All selected" state */
+    allSelected: string;
+    /** Label for number of selections */
+    selections: (count: number) => string;
+    /** Label for clear button */
+    clear: string;
+}

package/dist/types/widgets/spread/config.d.ts

@@ -1,2 +1,10 @@
-import { SpreadConfig, SpreadWidgetConfig } from './types';
-export declare function spreadConfig({ refUI, data, ...props }: SpreadConfig): SpreadWidgetConfig;
+import { DownloadItem } from '../actions';
+import { ConfigProps } from '../root/types';
+import { SpreadWidgetConfig, SpreadWidgetData } from './types';
+import { SeriesConfig } from '../formula/types';
+export interface SpreadConfigProps {
+    formatter?: (value: number) => string;
+    series?: SeriesConfig[];
+}
+export declare function spreadDownloadConfig({ refUI, }: ConfigProps): DownloadItem<SpreadWidgetData>[];
+export declare function spreadConfig(): SpreadWidgetConfig;

package/dist/types/widgets/spread/index.d.ts

@@ -1,8 +1,9 @@
 export { SpreadUI } from './spread-ui';
 export { SpreadSkeleton } from './skeleton';
+export { spreadConfig, spreadDownloadConfig } from './config';
 export { MinValue } from './components/min-value';
 export { MaxValue } from './components/max-value';
 export { Separator } from './components/separator';
 export { Item, Row, Prefix, Suffix, Series } from '../formula';
-export type { RowProps, ValueProps, SpreadWidgetState, ItemProps, SpreadDataItem, SpreadUIProps, } from './types';
+export type { RowProps, ValueProps, SpreadWidgetState, SpreadWidgetConfig, SpreadWidgetData, SpreadDownloadConfig, ItemProps, SpreadDataItem, SpreadUIProps, } from './types';
 export type { SeriesConfig } from '../formula/types';

package/dist/types/widgets/spread/types.d.ts

@@ -1,16 +1,9 @@
 import { TypographyProps } from '@mui/material';
 import { ReactNode } from 'react';
 import { BaseWidgetState, WidgetsStoreProps } from '../stores/types';
-import { DownloadState } from '../actions';
-import { DownloadConfigProps } from '../actions/download/types';
 import { WrapperState } from '../wrapper/types';
-import { BaseWidgetProps } from '../widget/types';
-import { BaseConfig } from '../config-loader';
+import { DownloadItem } from '../actions/download/types';
 import { SeriesConfig } from '../formula/types';
-export interface SpreadProps extends BaseWidgetProps<SpreadWidgetConfig> {
-    type: 'spread';
-    data: SpreadWidgetData | undefined;
-}
 export interface SpreadUIProps {
     id: WidgetsStoreProps['id'];
 }
@@ -37,16 +30,11 @@ export interface ItemProps {
     TypographyProps?: TypographyProps;
 }
 export type SpreadWidgetData = SpreadDataItem[];
-export type SpreadWidgetState = BaseWidgetState<WrapperState<DownloadState<SpreadProps & {
+export type SpreadWidgetState = BaseWidgetState<WrapperState<SpreadWidgetConfig> & {
+    data: SpreadWidgetData;
+}>;
+export interface SpreadWidgetConfig {
     formatter?: (value: number) => string;
     series?: SeriesConfig[];
-}, SpreadWidgetData>>>;
-export type SpreadWidgetConfig = BaseConfig & DownloadConfigProps<SpreadWidgetData> & {
-    type: SpreadProps['type'];
-    formatter?: SpreadWidgetState['formatter'];
-    series?: SeriesConfig[];
-};
-export interface SpreadConfig extends Omit<BaseConfig, 'data'> {
-    data?: SpreadWidgetData;
-    series?: SeriesConfig[];
 }
+export type SpreadDownloadConfig = DownloadItem<SpreadWidgetData>[];

package/dist/types/widgets/stores/index.d.ts

@@ -0,0 +1,2 @@
+export { useWidgetStore } from './widget-store';
+export type { BaseWidgetState, WidgetsStoreProps, WidgetState, WidgetStore, WidgetStoreActions, WidgetStoreState, } from './types';