@sisense/sdk-ui 1.23.0 → 1.24.0

package/dist/packages/sdk-ui/src/models/hierarchy/use-get-hierarchy-models.d.ts

@@ -1,10 +1,10 @@
 import { HookEnableParam } from '../../common/hooks/types.js';
 import { HierarchyModel } from '../../models/hierarchy/hierarchy-model';
-import { GetHierarchiesOptions } from './types.js';
+import { GetHierarchyModelsOptions } from './get-hierarchy-models.js';
 /**
  * Parameters for {@link useGetHierarchyModels} hook.
  */
-export interface GetHierarchiesParams extends GetHierarchiesOptions, HookEnableParam {
+export interface GetHierarchyModelsParams extends GetHierarchyModelsOptions, HookEnableParam {
 }
 /**
  * States of hierarchy models load.
@@ -87,11 +87,11 @@ export type HierarchyModelsSuccessState = {
  * @group Fusion Assets
  * @fusionEmbed
  */
-export declare const useGetHierarchyModels: (params: GetHierarchiesParams) => HierarchyModelsState;
+export declare const useGetHierarchyModels: (params: GetHierarchyModelsParams) => HierarchyModelsState;
 /**
  * {@link useGetHierarchyModels} without tracking to be used inside other hooks or components in Compose SDK.
  *
  * @param params - Parameters of the hierarchies to be retrieved
  * @internal
  */
-export declare function useGetHierarchyModelsInternal(params: GetHierarchiesParams): HierarchyModelsState;
+export declare function useGetHierarchyModelsInternal(params: GetHierarchyModelsParams): HierarchyModelsState;

package/dist/packages/sdk-ui/src/models/widget/widget-model-translator.d.ts

@@ -152,6 +152,16 @@ export declare function fromWidgetDto(widgetDto: WidgetDto, themeSettings?: Comp
  * @internal
  */
 export declare function fromChartWidgetProps(chartWidgetProps: ChartWidgetProps): WidgetModel;
+/**
+ * Data source as specified in the jaql
+ * but with required filelds
+ *
+ * @internal
+ */
+export type JaqlDataSourceForWidgetDto = JaqlDataSource & {
+    id: string;
+    address: string;
+};
 /**
  * Translates a {@link WidgetModel} to {@link WidgetDto}.
  *
@@ -160,4 +170,4 @@ export declare function fromChartWidgetProps(chartWidgetProps: ChartWidgetProps)
  * @returns WidgetDto
  * @internal
  */
-export declare function toWidgetDto(widgetModel: WidgetModel, dataSource: JaqlDataSource): WidgetDto;
+export declare function toWidgetDto(widgetModel: WidgetModel, dataSource?: JaqlDataSourceForWidgetDto): WidgetDto;

package/dist/packages/sdk-ui/src/pivot-table/hooks/use-render-pivot.d.ts

@@ -16,9 +16,11 @@ type PivotRenderOptions = {
     themeSettings: CompleteThemeSettings;
     /** The size of the pivot table container. */
     size: ContainerSize | null;
+    /** Callback to handle total height change. */
+    onTotalHeightChange?: (totalHeight: number) => void;
 };
 /**
  * A hook that renders the pivot table.
  */
-export declare function useRenderPivot({ nodeRef, pivotBuilder, dataOptions, styleOptions, themeSettings, size, }: PivotRenderOptions): void;
+export declare function useRenderPivot({ nodeRef, pivotBuilder, dataOptions, styleOptions, themeSettings, size, onTotalHeightChange, }: PivotRenderOptions): void;
 export {};

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

@@ -88,10 +88,18 @@ export interface SisenseContextProviderProps {
      * This callback is useful for handling errors that happen during the initialization or runtime of the Sisense context,
      * such as incorrect configuration, invalid authentication, or network-related issues.
      *
-     * @param error - The error object containing details about the issue.
      * @category Sisense App Error Handling
      */
-    onError?: (error: Error) => void;
+    onError?: (
+    /** The error object containing details about the issue. */
+    error: Error, 
+    /** Additional details about the error, such as the component name and props that caused this error. */
+    errorDetails?: {
+        /** The name of the component that caused the error. */
+        componentName: string;
+        /** The props of the component that caused the error. */
+        componentProps: unknown;
+    }) => void;
     /**
      * Boolean flag to enable sending silent pre-authentication requests to the Sisense instance.
      * Used to check if user is already authenticated, check is performed in an ivisible iframe.
@@ -701,7 +709,7 @@ export interface IndicatorChartProps extends BaseChartProps {
 /**
  * Props of the {@link Table} component.
  */
-export interface TableProps {
+export interface TableProps extends BaseChartEventProps {
     /**
      * {@inheritDoc ChartProps.dataSet}
      *

package/dist/packages/sdk-ui/src/sisense-context/sisense-context.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="react" />
 import { ClientApplication } from '../app/client-application';
 import { TrackingEventDetails } from '@sisense/sdk-tracking';
+import { SisenseContextProviderProps } from '..';
 export type SisenseContextPayload = {
     isInitialized: boolean;
     app?: ClientApplication;
@@ -11,6 +12,7 @@ export type SisenseContextPayload = {
     };
     errorBoundary: {
         showErrorBox: boolean;
+        onError?: SisenseContextProviderProps['onError'];
     };
 };
 export declare const SisenseContext: import("react").Context<SisenseContextPayload>;

package/dist/packages/sdk-ui/src/table/table-component.d.ts

@@ -5,4 +5,4 @@ export declare const PAGES_BATCH_SIZE = 10;
 /**
  * Component that renders a table with aggregation and pagination.
  */
-export declare const TableComponent: ({ dataSet, dataOptions, styleOptions, filters, }: TableProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const TableComponent: ({ dataSet, dataOptions, styleOptions, filters, onDataReady, }: TableProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/packages/sdk-ui/src/translation/resources/en.d.ts

@@ -1,6 +1,7 @@
 export declare const translation: {
     errors: {
         noSisenseContext: string;
+        restApiNotReady: string;
         componentRenderError: string;
         sisenseContextNoAuthentication: string;
         chartNoSisenseContext: string;
@@ -28,6 +29,8 @@ export declare const translation: {
             failedToFetch: string;
         };
         widgetModel: {
+            incomleteWidget: string;
+            unsupportedWidgetTypeDto: string;
             pivotWidgetNotSupported: string;
             textWidgetNotSupported: string;
             onlyTableWidgetSupported: string;
@@ -60,6 +63,7 @@ export declare const translation: {
         cascadingFilterOriginalNotFound: string;
         dashboardLoadFailed: string;
         dashboardWithOidNotFound: string;
+        failedToAddWidget: string;
         widgetWithOidNotFound: string;
         widgetEmptyResponse: string;
         dateFilterIncorrectOperator: string;
@@ -132,6 +136,12 @@ export declare const translation: {
             max: string;
         };
     };
+    treemap: {
+        tooltip: {
+            ofTotal: string;
+            of: string;
+        };
+    };
     advanced: {
         tooltip: {
             min: string;

package/dist/packages/sdk-ui/src/translation/resources/index.d.ts

@@ -11,6 +11,7 @@ export declare const resources: {
     en: {
         errors: {
             noSisenseContext: string;
+            restApiNotReady: string;
             componentRenderError: string;
             sisenseContextNoAuthentication: string;
             chartNoSisenseContext: string;
@@ -38,6 +39,8 @@ export declare const resources: {
                 failedToFetch: string;
             };
             widgetModel: {
+                incomleteWidget: string;
+                unsupportedWidgetTypeDto: string;
                 pivotWidgetNotSupported: string;
                 textWidgetNotSupported: string;
                 onlyTableWidgetSupported: string;
@@ -70,6 +73,7 @@ export declare const resources: {
             cascadingFilterOriginalNotFound: string;
             dashboardLoadFailed: string;
             dashboardWithOidNotFound: string;
+            failedToAddWidget: string;
             widgetWithOidNotFound: string;
             widgetEmptyResponse: string;
             dateFilterIncorrectOperator: string;
@@ -142,6 +146,12 @@ export declare const resources: {
                 max: string;
             };
         };
+        treemap: {
+            tooltip: {
+                ofTotal: string;
+                of: string;
+            };
+        };
         advanced: {
             tooltip: {
                 min: string;
@@ -240,6 +250,7 @@ export declare const resources: {
     uk: {
         errors: {
             noSisenseContext: string;
+            restApiNotReady: string;
             componentRenderError: string;
             sisenseContextNoAuthentication: string;
             chartNoSisenseContext: string;
@@ -267,6 +278,8 @@ export declare const resources: {
                 failedToFetch: string;
             };
             widgetModel: {
+                incomleteWidget: string;
+                unsupportedWidgetTypeDto: string;
                 pivotWidgetNotSupported: string;
                 textWidgetNotSupported: string;
                 onlyTableWidgetSupported: string;
@@ -299,6 +312,7 @@ export declare const resources: {
             cascadingFilterOriginalNotFound: string;
             dashboardLoadFailed: string;
             dashboardWithOidNotFound: string;
+            failedToAddWidget: string;
             widgetWithOidNotFound: string;
             widgetEmptyResponse: string;
             dateFilterIncorrectOperator: string;
@@ -371,6 +385,12 @@ export declare const resources: {
                 max: string;
             };
         };
+        treemap: {
+            tooltip: {
+                ofTotal: string;
+                of: string;
+            };
+        };
         advanced: {
             tooltip: {
                 min: string;

package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-data-options.d.ts

@@ -1,8 +1,8 @@
-import { DimensionalBaseMeasure, DimensionalAttribute, DimensionalCalculatedMeasure, Jaql, JaqlDataSource, Filter } from '@sisense/sdk-data';
+import { DimensionalBaseMeasure, DimensionalAttribute, DimensionalCalculatedMeasure, Jaql, JaqlDataSource } from '@sisense/sdk-data';
 import { StyledMeasureColumn, StyledColumn, Color } from '../types.js';
 import { Panel, PanelItem, WidgetType, WidgetStyle, BoxplotWidgetStyle } from './types.js';
 import { WidgetDataOptions } from '../models/index.js';
-export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): Filter | DimensionalAttribute | DimensionalCalculatedMeasure | DimensionalBaseMeasure;
+export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): import("@sisense/sdk-data").Filter | DimensionalAttribute | DimensionalCalculatedMeasure | DimensionalBaseMeasure;
 /** @internal */
 export declare function applyStatisticalModels(dataOption: StyledMeasureColumn, statisticalModels?: {
     forecast?: {

package/dist/packages/sdk-ui/src/widget-by-id/utils.d.ts

@@ -4,6 +4,11 @@ import { ChartType } from '../types.js';
 import { FiltersMergeStrategy, Panel, PanelItem, TextWidgetDtoStyle, WidgetStyle, WidgetSubtype, WidgetType } from './types.js';
 import { ChartProps, ChartWidgetProps, PivotTableWidgetProps, PluginWidgetProps, RenderToolbarHandler, TextWidgetProps, CommonWidgetProps, WithWidgetType, WidgetProps } from '../index.js';
 import { WidgetTypeInternal } from '../models/widget/types';
+/**
+ * Returns the corresponding chart type for a given widget type
+ *
+ * @internal
+ */
 export declare function getChartType(widgetType: WidgetType): ChartType;
 export declare function getWidgetTypeFromChartType(chartType: ChartType): WidgetType;
 export declare function getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
@@ -20,6 +25,7 @@ export declare function isChartWidget(widgetType: WidgetTypeOrString): boolean;
  *
  * @param widgetProps - The widget props to check.
  * @returns whether the widget props is for a text widget
+ * @internal
  */
 export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<TextWidgetProps, 'text'>;
 /**
@@ -27,6 +33,7 @@ export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widge
  *
  * @param widgetProps - The widget props to check.
  * @returns whether the widget props is for a pivot table widget
+ * @internal
  */
 export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<PivotTableWidgetProps, 'pivot'>;
 /**
@@ -34,6 +41,7 @@ export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps):
  *
  * @param widgetProps - The widget props to check.
  * @returns whether the widget props is for a plugin widget
+ * @internal
  */
 export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<PluginWidgetProps, 'plugin'>;
 /**
@@ -41,6 +49,7 @@ export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): wid
  *
  * @param widgetProps - The widget props to check.
  * @returns whether the widget props is for a chart widget
+ * @internal
  */
 export declare function isChartWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<ChartWidgetProps, 'chart'>;
 export declare function translateWidgetTypeInternal(widgetProps: CommonWidgetProps): WidgetTypeInternal;

package/dist/packages/sdk-ui/src/widgets/common/widget-container.d.ts

@@ -12,4 +12,6 @@ interface WidgetContainerProps {
 }
 /** @internal */
 export declare const WidgetContainer: React.FC<WidgetContainerProps>;
+/** @internal */
+export declare const RawWidgetContainer: React.FC<WidgetContainerProps>;
 export {};

package/dist/packages/sdk-ui/src/widgets/common/widget-errors-and-warnings-context.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+interface WidgetErrorsAndWarnings {
+    errors: string[];
+    warnings: string[];
+    setErrors: React.Dispatch<React.SetStateAction<string[]>>;
+    setWarnings: React.Dispatch<React.SetStateAction<string[]>>;
+    clearError: () => void;
+    clearWarning: () => void;
+}
+export declare const WidgetErrorsAndWarningsProvider: React.FC<{
+    children: React.ReactNode;
+}>;
+export declare const useWidgetErrorsAndWarnings: () => WidgetErrorsAndWarnings;
+export {};

package/dist/packages/sdk-ui/src/widgets/common/widget-header-info-button.d.ts

@@ -1,7 +1,9 @@
 import { WidgetContainerStyleOptions } from '../../types';
-export default function WidgetHeaderInfoButton({ title, description, styleOptions, onRefresh, }: {
+export default function WidgetHeaderInfoButton({ title, description, errorMessages, styleOptions, onRefresh, }: {
     title?: string;
     description?: string;
     styleOptions?: WidgetContainerStyleOptions['header'];
+    errorMessages?: string[];
+    warningMessages?: string[];
     onRefresh: () => void;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/widgets/common/widget-header.d.ts

@@ -5,6 +5,8 @@ interface WidgetHeaderProps {
     title?: string;
     description?: string;
     dataSetName?: string;
+    errorMessages?: string[];
+    warningMessages?: string[];
     styleOptions?: WidgetContainerStyleOptions['header'];
 }
 export declare const WidgetHeader: React.FC<WidgetHeaderProps>;