@sisense/sdk-ui 2.22.0 → 2.24.0

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

@@ -3,7 +3,7 @@ export declare const DEFAULT_EXCEEDED_THRESHOLD = 100;
 /**
  * Response from the quota/credit balance API
  *
- * @internal
+ * @sisenseInternal
  */
 export interface QuotaApiResponse {
     balance: number;
@@ -14,7 +14,7 @@ export interface QuotaApiResponse {
 /**
  * Calculated quota state from API response
  *
- * @internal
+ * @sisenseInternal
  */
 export interface QuotaState {
     initialBalance: number;
@@ -26,7 +26,7 @@ export interface QuotaState {
 /**
  * Options for useQuotaNotification
  *
- * @internal
+ * @sisenseInternal
  */
 export interface QuotaNotificationOptions {
     /** Whether to fetch. When false, skips API calls and polling. Defaults to feature-flag value. */
@@ -44,7 +44,7 @@ export interface QuotaNotificationOptions {
  *
  * @param options - Quota notification options. When enabled is false, skips fetching and polling.
  * @returns Quota state, enabled flag, loading status, and error
- * @internal
+ * @sisenseInternal
  */
 export declare const useQuotaNotification: (options?: QuotaNotificationOptions) => {
     enabled: boolean;

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/types/menu-item.d.ts

@@ -10,8 +10,12 @@ export type MenuItem = {
      * Caption of the menu item
      */
     caption: string;
+    /**
+     * Sub items of the menu item
+     */
+    items?: MenuItem[];
     /**
      * Handler function to be called when the menu item is clicked
      */
-    onClick: () => void;
+    onClick?: () => void;
 };

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

@@ -0,0 +1,12 @@
+import type { MenuItemSection } from '../../types';
+import type { MenuItem } from '../types/menu-item.js';
+type SectionItem = NonNullable<MenuItemSection['items']>[number];
+/**
+ * Recursively converts a {@link MenuItem} into
+ * the item within the `MenuItemSection` expected by the context-menu infrastructure.
+ *
+ * @param menuItem - The menu item to convert.
+ * @returns The equivalent context-menu section item.
+ */
+export declare function convertMenuItemToLegacySectionItem(menuItem: MenuItem): SectionItem;
+export {};

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;