@sisense/sdk-ui 2.20.0 → 2.22.0

package/dist/packages/sdk-ui/src/shared/components/menu/menu-button.d.ts

@@ -3,6 +3,7 @@ type MenuButtonProps = {
     color?: string;
     onClick?: MouseEventHandler<HTMLButtonElement>;
     ariaLabel?: string;
+    size?: number;
 };
-export declare const MenuButton: ({ color, onClick, ariaLabel, ...restProps }: MenuButtonProps) => import("react/jsx-runtime").JSX.Element;
+export declare const MenuButton: ({ color, onClick, ariaLabel, size, ...restProps }: MenuButtonProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/packages/sdk-ui/src/shared/components/quota-notification/quota-notification.d.ts

@@ -0,0 +1,32 @@
+import { type QuotaNotificationOptions } from '../../hooks/use-quota-notification.js';
+/**
+ * Props for QuotaNotification component
+ *
+ * @internal
+ */
+export interface QuotaNotificationProps extends QuotaNotificationOptions {
+    /**
+     * Additional CSS class name
+     */
+    className?: string;
+    /**
+     * Whether the warning banner has been dismissed (controlled from parent)
+     */
+    warningDismissed?: boolean;
+    /**
+     * Callback when warning is dismissed (for controlled usage)
+     */
+    onDismissWarning?: () => void;
+}
+/**
+ * Component that displays credit balance warnings/errors
+ *
+ * Shows an error banner when credit is exceeded (not dismissible).
+ * Shows a warning banner when credit usage >= warningThreshold (dismissible).
+ * Automatically updates via polling every 60 seconds.
+ *
+ * @param props - QuotaNotification props
+ * @returns QuotaNotification component or null
+ * @internal
+ */
+export declare function QuotaNotification({ className, warningDismissed: controlledWarningDismissed, onDismissWarning, enabled, warningThreshold, exceededThreshold, }?: QuotaNotificationProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/packages/sdk-ui/src/shared/hooks/use-app-settings.d.ts

@@ -0,0 +1,11 @@
+import type { AppSettings } from '../../infra/app/settings/settings';
+/**
+ * Hook that returns the full application settings from SisenseContext.
+ *
+ * Use this to access app settings (language, user role, LLM quota settings, etc.)
+ * when customizing components wrapped inside SisenseContextProvider.
+ *
+ * @returns AppSettings when app is initialized, undefined otherwise
+ * @internal
+ */
+export declare const useAppSettings: () => AppSettings | undefined;

package/dist/packages/sdk-ui/src/shared/hooks/use-quota-notification.d.ts

@@ -0,0 +1,54 @@
+export declare const DEFAULT_WARNING_THRESHOLD = 85;
+export declare const DEFAULT_EXCEEDED_THRESHOLD = 100;
+/**
+ * Response from the quota/credit balance API
+ *
+ * @internal
+ */
+export interface QuotaApiResponse {
+    balance: number;
+    initialBalance: number;
+    sequenceNumber: string;
+    date: string;
+}
+/**
+ * Calculated quota state from API response
+ *
+ * @internal
+ */
+export interface QuotaState {
+    initialBalance: number;
+    currentBalance: number;
+    usagePercentage: number;
+    isWarning: boolean;
+    isExceeded: boolean;
+}
+/**
+ * Options for useQuotaNotification
+ *
+ * @internal
+ */
+export interface QuotaNotificationOptions {
+    /** Whether to fetch. When false, skips API calls and polling. Defaults to feature-flag value. */
+    enabled?: boolean;
+    /** Warning threshold percentage. Defaults to 85. */
+    warningThreshold?: number;
+    /** Exceeded threshold percentage. Defaults to 100. */
+    exceededThreshold?: number;
+}
+/**
+ * Hook that fetches and calculates quota notification state with automatic polling.
+ * Respects aiAssistant feature flags (quotaNotification + featureModelType) when enabled is not passed.
+ *
+ * Polls every 60 seconds to keep quota state up-to-date.
+ *
+ * @param options - Quota notification options. When enabled is false, skips fetching and polling.
+ * @returns Quota state, enabled flag, loading status, and error
+ * @internal
+ */
+export declare const useQuotaNotification: (options?: QuotaNotificationOptions) => {
+    enabled: boolean;
+    quotaState: QuotaState | null;
+    isLoading: boolean;
+    error: unknown;
+};

package/dist/packages/sdk-ui/src/shared/hooks/use-quota-warning-dismissed.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Hook that manages quota warning dismissed state with sessionStorage persistence.
+ * State survives navigation within the same tab but resets when the tab is closed.
+ *
+ * @returns Tuple of [dismissed, setDismissed]
+ * @internal
+ */
+export declare function useQuotaWarningDismissed(): [boolean, (dismissed: boolean) => void];

package/dist/packages/sdk-ui/src/shared/icons/warning-icon.d.ts

@@ -0,0 +1,6 @@
+import { SVGProps } from 'react';
+/**
+ * Quota warning icon - circle with exclamation mark, used for quota warning banner
+ * From Figma design; fill #FFCB05
+ */
+export declare const WarningIcon: (props: SVGProps<SVGSVGElement>) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/shared/icons/x-circle-icon.d.ts

@@ -0,0 +1,6 @@
+import { SVGProps } from 'react';
+/**
+ * X circle icon - circle with X inside, used for quota error banner
+ * From Figma design; uses currentColor for fill
+ */
+export declare const XCircleIcon: (props: SVGProps<SVGSVGElement>) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/shared/types/menu-item.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Menu item
+ */
+export type MenuItem = {
+    /**
+     * Unique identifier for the menu item
+     */
+    id: string;
+    /**
+     * Caption of the menu item
+     */
+    caption: string;
+    /**
+     * Handler function to be called when the menu item is clicked
+     */
+    onClick: () => void;
+};

package/dist/packages/sdk-ui/src/types.d.ts

@@ -1,6 +1,7 @@
 import { CSSProperties, ReactNode } from 'react';
 import type { Attribute, CalculatedMeasureColumn, Column, Measure, MeasureColumn, MembersFilter } from '@sisense/sdk-data';
 import { DeepRequired } from 'ts-essentials';
+import { AbstractDataPointWithEntries } from './domains/dashboarding/common-filters/types';
 import { Coordinates } from './domains/visualizations/components/chart/components/scattermap/types';
 import { Hierarchy, HierarchyId, StyledColumn, StyledMeasureColumn } from '.';
 import { GeoDataElement } from './domains/visualizations/components/chart/restructured-charts/areamap-chart/types';
@@ -2012,12 +2013,14 @@ export interface WidgetContainerStyleOptions {
          * Custom toolbar to render to the right of the title
          *
          * @internal
+         * @deprecated - should be moved out from StyleOptions
          */
         renderToolbar?: RenderToolbarHandler;
         /**
          * Custom title to render in widget header
          *
          * @internal
+         * @deprecated - should be moved out from StyleOptions
          */
         renderTitle?: RenderTitleHandler;
     };
@@ -2246,7 +2249,11 @@ export type DataPoint = {
 /**
  * A data point entry that represents a single dimension within a multi-dimensional data point.
  */
-export type DataPointEntry = {
+export type DataPointEntry = BasicDataPointEntry | AttributeDataPointEntry | MeasureDataPointEntry;
+/**
+ * A basic data point entry that represents a single dimension within a multi-dimensional data point.
+ */
+export interface BasicDataPointEntry {
     /** The data option associated with this entry */
     dataOption: Column | StyledColumn | MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn;
     /**
@@ -2254,15 +2261,25 @@ export type DataPointEntry = {
      * @internal
      */
     dataOptionLocation?: DataOptionLocation;
-    /** The attribute associated with this data point entry */
-    attribute?: Attribute;
-    /** The measure associated with this data point entry */
-    measure?: Measure;
     /** The raw value of the data point */
     value: string | number;
     /** The formatted value of the data point */
     displayValue?: string;
-};
+}
+/**
+ * A data point entry that represents a single attribute within a multi-dimensional data point.
+ */
+export interface AttributeDataPointEntry extends BasicDataPointEntry {
+    /** The attribute associated with this data point entry */
+    attribute: Attribute;
+}
+/**
+ * A data point entry that represents a single measure within a multi-dimensional data point.
+ */
+export interface MeasureDataPointEntry extends BasicDataPointEntry {
+    /** The measure associated with this data point entry */
+    measure: Measure;
+}
 /** Data point in a Scatter chart. */
 export type ScatterDataPoint = {
     /** Value of the x axis */
@@ -2426,6 +2443,96 @@ export type ScattermapDataPoint = {
         details?: DataPointEntry;
     };
 };
+/**
+ * Represents a single data point in a custom widget.
+ *
+ * This type is used to define the structure of a data point that is passed to event handlers
+ * like `onDataPointClick`. It typically extends `AbstractDataPointWithEntries` to include
+ * specific entries for categories, values, or other dimensions used in the widget.
+ *
+ * @example
+ * ```typescript
+ * interface MyWidgetDataPoint extends CustomWidgetDataPoint {
+ *   entries: {
+ *     category: DataPointEntry[];
+ *     value: DataPointEntry[];
+ *   };
+ * }
+ *
+ * const onDataPointClick = (point: MyWidgetDataPoint) => {
+ *   console.log('Clicked category:', point.entries.category[0].value);
+ * };
+ * ```
+ */
+export type CustomWidgetDataPoint<T extends AbstractDataPointWithEntries = AbstractDataPointWithEntries> = T;
+/**
+ * Generic event handler for custom widget data point click.
+ *
+ * @typeParam T - The shape of the data point
+ * @example
+ * ```tsx
+ * const handleClick: CustomWidgetDataPointEventHandler<MyDataPoint> = (point, event) => {
+ *   console.log('Clicked:', point.label, point.value);
+ * };
+ * ```
+ */
+export type CustomWidgetDataPointEventHandler<T extends AbstractDataPointWithEntries = AbstractDataPointWithEntries> = (
+/** Data point that was clicked */
+point: CustomWidgetDataPoint<T>, 
+/** Native browser event */
+nativeEvent: PointerEvent | MouseEvent) => void;
+/**
+ * Generic event handler for custom widget data point context menu.
+ *
+ * @typeParam T - The shape of the data point
+ */
+export type CustomWidgetDataPointContextMenuHandler<T extends AbstractDataPointWithEntries = AbstractDataPointWithEntries> = (
+/** Data point that triggered the context menu */
+point: CustomWidgetDataPoint<T>, 
+/** Native browser event */
+nativeEvent: MouseEvent) => void;
+/**
+ * Generic event handler for custom widget data points selection.
+ *
+ * @typeParam T - The shape of the data point
+ * @example
+ * ```tsx
+ * const handleSelect: CustomWidgetDataPointsEventHandler<MyDataPoint> = (points, event) => {
+ *   console.log('Selected:', points.length, 'points');
+ * };
+ * ```
+ */
+export type CustomWidgetDataPointsEventHandler<T extends AbstractDataPointWithEntries = AbstractDataPointWithEntries> = (
+/** Data points that were selected */
+points: CustomWidgetDataPoint<T>[], 
+/** Native browser event */
+nativeEvent: MouseEvent) => void;
+/**
+ * Event props for custom widgets with generic data point type.
+ *
+ * @typeParam DataPoint - The shape of data points for this custom widget
+ */
+export interface CustomWidgetEventProps<DataPoint extends AbstractDataPointWithEntries = AbstractDataPointWithEntries> {
+    /**
+     * Click handler callback for a data point
+     *
+     * @category Callbacks
+     */
+    onDataPointClick?: CustomWidgetDataPointEventHandler<DataPoint>;
+    /**
+     * Context menu handler callback for a data point
+     *
+     * @category Callbacks
+     */
+    onDataPointContextMenu?: CustomWidgetDataPointContextMenuHandler<DataPoint>;
+    /**
+     * Handler callback for selection of multiple data points
+     *
+     * @category Callbacks
+     */
+    onDataPointsSelected?: CustomWidgetDataPointsEventHandler<DataPoint>;
+}
+export type { AbstractDataPointWithEntries } from './domains/dashboarding/common-filters/types';
 /**
  * This is the minimum definition of Highcharts
  * events, Series, and Point that we require. As