@sisense/sdk-ui 2.21.0 → 2.23.0

package/dist/packages/sdk-ui/src/public-api/sisense-internal.d.ts

@@ -5,11 +5,24 @@
  * These APIs may change for in-company needs and are not part of the public contract.
  */
 export { useDashboardPersistence } from '../domains/dashboarding/dashboard-model';
-export * from '../infra/decorators/component-decorators/with-tracking';
-/** List of unclear exports which should be verified */
+export { translateFiltersAndRelationsToDto } from '../domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/utils.js';
+export { UseDashboardModelActionType } from '../domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/types.js';
+export { type DashboardDto } from '../infra/api/types/dashboard-dto';
+export { type WidgetDto } from '../domains/widgets/components/widget-by-id/types';
+export { getDashboardModel } from '../domains/dashboarding/dashboard-model/get-dashboard-model.js';
+export { withTracking } from '../infra/decorators/component-decorators/with-tracking';
 export { createDataOptionsFromPanels } from '../domains/widgets/components/widget-by-id/translate-widget-data-options';
 export { extractCombinedFilters } from '../domains/widgets/components/widget-by-id/translate-dashboard-filters';
-export { trackHook } from '../infra/decorators/hook-decorators';
 export { useThemeContext } from '../infra/contexts/theme-provider';
-export { type DashboardDto } from '../infra/api/types/dashboard-dto';
-export { type WidgetDto } from '../domains/widgets/components/widget-by-id/types';
+export { useAppSettings } from '../shared/hooks/use-app-settings';
+export type { AppSettings } from '../infra/app/settings/settings';
+export { QuotaNotification } from '../shared/components/quota-notification/quota-notification.js';
+export type { QuotaNotificationProps } from '../shared/components/quota-notification/quota-notification.js';
+export { useQuotaNotification } from '../shared/hooks/use-quota-notification.js';
+export type { QuotaNotificationOptions, QuotaApiResponse, QuotaState, } from '../shared/hooks/use-quota-notification.js';
+export { LoadingIndicator } from '../shared/components/loading-indicator.js';
+export { DataSchemaBrowser } from '../domains/data-browser/data-schema-browser/data-schema-browser.js';
+export type { NlqChartWidgetStyleOptions } from '../types';
+export type { RenderTitleHandler } from '../types';
+export { isChartWidgetProps } from '../domains/widgets/components/widget-by-id/utils.js';
+export { isPivotTableWidgetProps } from '../domains/widgets/components/widget-by-id/utils.js';

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

@@ -0,0 +1,91 @@
+import { ReactNode } from 'react';
+/**
+ * Props for Alert component
+ */
+export interface AlertProps {
+    /**
+     * Variant of the alert
+     */
+    variant?: 'error' | 'warning' | 'info';
+    /**
+     * Title text displayed in the alert
+     */
+    title?: string;
+    /**
+     * Description text displayed in the alert
+     */
+    description?: string;
+    /**
+     * Custom icon to display. If not provided, AlertIcon is used
+     */
+    icon?: ReactNode;
+    /**
+     * Whether the alert can be dismissed
+     */
+    dismissible?: boolean;
+    /**
+     * Callback when alert is dismissed
+     */
+    onDismiss?: () => void;
+    /**
+     * When true and dismissible, clicking anywhere on the alert (not just the close button)
+     * triggers onDismiss. Useful for banner-style alerts.
+     *
+     * @default false
+     */
+    dismissOnClick?: boolean;
+    /**
+     * Additional CSS class name
+     */
+    className?: string;
+}
+/**
+ * Alert component for displaying warnings, errors, and informational messages
+ *
+ * @param props - Alert component props
+ * @returns Alert component
+ * @internal
+ */
+export declare const Alert: ({ variant, title, description, icon, dismissible, onDismiss, dismissOnClick, className, }: AlertProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Props for AlertTitle component
+ */
+export interface AlertTitleProps {
+    /**
+     * Content of the title
+     */
+    children: ReactNode;
+    /**
+     * Additional CSS class name
+     */
+    className?: string;
+}
+/**
+ * Alert title subcomponent
+ *
+ * @param props - AlertTitle props
+ * @returns AlertTitle component
+ * @internal
+ */
+export declare const AlertTitle: ({ children, className }: AlertTitleProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * Props for AlertDescription component
+ */
+export interface AlertDescriptionProps {
+    /**
+     * Content of the description
+     */
+    children: ReactNode;
+    /**
+     * Additional CSS class name
+     */
+    className?: string;
+}
+/**
+ * Alert description subcomponent
+ *
+ * @param props - AlertDescription props
+ * @returns AlertDescription component
+ * @internal
+ */
+export declare const AlertDescription: ({ children, className }: AlertDescriptionProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/shared/components/alert/index.d.ts

@@ -0,0 +1,2 @@
+export { Alert, AlertTitle, AlertDescription } from './alert';
+export type { AlertProps, AlertTitleProps, AlertDescriptionProps } from './alert';

package/dist/packages/sdk-ui/src/shared/components/grouped-items-browser/types.d.ts

@@ -36,10 +36,16 @@ export type GroupSecondaryActionConfig = {
 };
 export type ItemActionConfig = {
     onClick(this: void, item: Item): void;
+    getLabel?: (this: void, item: Item) => string;
 };
 export type ItemSecondaryActionConfig = {
     SecondaryActionButtonIcon: React.ComponentType<{
         item: Item;
     }>;
-    onClick(this: void, item: Item): void;
+    /**
+     * When true, the row keeps hover/focus style after the secondary action is clicked (e.g. while a menu is open).
+     * The row is cleared when the consumer calls the `onSubmit` callback passed to `onClick`.
+     */
+    keepFocusedOnClick?: boolean;
+    onClick(this: void, item: Item, event: React.MouseEvent, onSubmit: () => void): void;
 };

package/dist/packages/sdk-ui/src/shared/components/inline-text-editor/inline-text-editor.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="react" />
+/**
+ * Props for the InlineTextEditor component.
+ */
+export interface InlineTextEditorProps {
+    /** Current text value */
+    value: string;
+    /** Whether the editor is in editing mode */
+    isEditing: boolean;
+    /** Called when text is committed (on blur / Enter) */
+    onCommit: (newValue: string) => void;
+    /** Called to request entering/leaving edit mode */
+    onEditingChange: (editing: boolean) => void;
+    /** Called when editing is cancelled (on Escape). May be undefined if onEditingChange handles it. */
+    onCancel?: () => void;
+    /** Placeholder text when value is empty */
+    placeholder?: string;
+}
+/**
+ * Inline text editor for editable titles.
+ * Renders as plain text when not editing; switches to an input when in edit mode.
+ * Supports double-click to enter edit mode, Enter/blur to commit, Escape to cancel.
+ *
+ * @internal
+ */
+export declare function InlineTextEditor({ value, isEditing, onCommit, onEditingChange, onCancel, placeholder, }: InlineTextEditorProps): React.ReactElement;

package/dist/packages/sdk-ui/src/shared/components/inline-text-editor/use-blur-on-pointer-down-outside.d.ts

@@ -0,0 +1,11 @@
+import { type RefObject } from 'react';
+/**
+ * Blurs the given element when a pointerdown occurs outside it.
+ * Used to commit inline editors when the user clicks on elements that call
+ * preventDefault() on mousedown (e.g. chart libraries), so the browser never fires blur.
+ *
+ * @param elementRef - Ref to the element that should lose focus on outside pointerdown
+ * @param isActive - When true, the document listener is attached; when false, it is removed
+ * @internal
+ */
+export declare function useBlurOnPointerDownOutside(elementRef: RefObject<HTMLElement | null>, isActive: boolean): void;

package/dist/packages/sdk-ui/src/shared/components/loading-indicator.d.ts

@@ -8,7 +8,8 @@ import { CompleteThemeSettings } from '../../types.js';
  * @returns A loading indicator with optional cancel.
  *
  * @deprecated Use LoadingOverlay instead.
- * @internal
+ *
+ * @sisenseInternal
  */
 export declare const LoadingIndicator: ({ themeSettings, onCancel, }: {
     themeSettings?: CompleteThemeSettings | undefined;

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
+ *
+ * @sisenseInternal
+ */
+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
+ * @sisenseInternal
+ */
+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,12 @@
+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
+ *
+ * @sisenseInternal
+ */
+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
+ *
+ * @sisenseInternal
+ */
+export interface QuotaApiResponse {
+    balance: number;
+    initialBalance: number;
+    sequenceNumber: string;
+    date: string;
+}
+/**
+ * Calculated quota state from API response
+ *
+ * @sisenseInternal
+ */
+export interface QuotaState {
+    initialBalance: number;
+    currentBalance: number;
+    usagePercentage: number;
+    isWarning: boolean;
+    isExceeded: boolean;
+}
+/**
+ * Options for useQuotaNotification
+ *
+ * @sisenseInternal
+ */
+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
+ * @sisenseInternal
+ */
+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/hooks/use-should-load.d.ts

@@ -1,4 +1,4 @@
-import { ClientApplication } from '../../infra/app/client-application.js';
+import { ClientApplication } from '../../infra/app/types.js';
 /**
  * Hook that generates a function for testing whether or not load
  *  should be performed for this render

package/dist/packages/sdk-ui/src/shared/hooks/use-with-change-detection.d.ts

@@ -1,8 +1,8 @@
 import { AnyObject } from '../../shared/utils/utility-types';
 export declare const defaultMerger: <P extends AnyObject>(existingValue: P, delta: Partial<P>) => P & Partial<P>;
-type UseWithChangeDetectionParams<P extends AnyObject> = {
+type UseWithChangeDetectionParams<P extends AnyObject, E extends object = Partial<P>> = {
     target: P | P[];
-    onChange: (delta: Partial<P>, index?: number) => void;
+    onChange: (event: E, index?: number) => void;
 };
 /**
  * A hook that extends a target object (or array of objects) with change detection functionality.
@@ -12,9 +12,9 @@ type UseWithChangeDetectionParams<P extends AnyObject> = {
  *
  * @internal
  */
-export declare function useWithChangeDetection<P extends AnyObject>(params: UseWithChangeDetectionParams<P>): (P & {
-    onChange: (delta: Partial<P>) => void;
+export declare function useWithChangeDetection<P extends AnyObject, E extends object = Partial<P>>(params: UseWithChangeDetectionParams<P, E>): (P & {
+    onChange: (event: E) => void;
 }) | (P & {
-    onChange: (delta: Partial<P>) => void;
+    onChange: (event: E) => void;
 })[];
 export {};

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

@@ -17,7 +17,7 @@ import { DataPointsEventHandler } from './props';
 import { GradientColor } from './shared/utils/gradient';
 import { SoftUnion } from './shared/utils/utility-types';
 export type { SortDirection, PivotRowsSort } from '@sisense/sdk-data';
-export type { AppConfig } from './infra/app/client-application';
+export type { AppConfig } from './infra/app/types';
 export type { DateConfig } from './domains/query-execution/core/date-formats';
 export type { CalendarDayOfWeek } from './domains/visualizations/components/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/utils';
 export type { CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, CalendarHeatmapChartDataOptions, StyledColumn, StyledMeasureColumn, } from './domains/visualizations/core/chart-data-options/types';
@@ -2028,7 +2028,7 @@ export interface WidgetContainerStyleOptions {
 /**
  * Configuration options that define functional style of the various elements of the Nlq Chart Widget
  *
- * @internal
+ * @sisenseInternal
  */
 export type NlqChartWidgetStyleOptions = {
     header?: {
@@ -2037,7 +2037,7 @@ export type NlqChartWidgetStyleOptions = {
 };
 /** @internal */
 export type RenderToolbarHandler = (onRefresh: () => void, defaultToolbar: JSX.Element) => JSX.Element | null;
-/** @internal */
+/** @sisenseInternal */
 export type RenderTitleHandler = (defaultHeaderTitle: ReactNode) => ReactNode;
 /** @internal */
 export type TextWidgetRenderToolbarHandler = (defaultToolbar: ReactNode) => ReactNode;