@sisense/sdk-ui 1.23.0 → 1.25.0

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

@@ -1,5 +1,10 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
+import { HierarchyModel } from '../../models';
 import { DataSource } from '@sisense/sdk-data';
 import { GetHierarchiesOptions } from './types.js';
+/**
+ * Options for retrieving hierarchy models.
+ */
+export type GetHierarchyModelsOptions = GetHierarchiesOptions;
 /** @internal */
-export declare function getHierarchyModels(http: HttpClient, options: GetHierarchiesOptions, defaultDataSource?: DataSource): Promise<import('../../models').HierarchyModel[]>;
+export declare function getHierarchyModels(http: HttpClient, options: GetHierarchyModelsOptions, defaultDataSource?: DataSource): Promise<HierarchyModel[]>;

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

@@ -1,6 +1,9 @@
 import type { Attribute, DataSource } from '@sisense/sdk-data';
 /**
  * Options for retrieving hierarchies.
+ *
+ * @internal
+ *
  */
 export type GetHierarchiesOptions = {
     /**

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/query/date-formats/apply-date-format.d.ts

@@ -61,4 +61,5 @@ export declare const defaultDateConfig: DateConfig;
  * @param cfg -
  */
 export declare function applyDateFormat(date: Date, format: DateFormat, locale?: Locale, cfg?: DateConfig): string;
+export declare function getDefaultDateMask(granularity?: string): "HH:mm:ss" | "yyyy" | "MM/yyyy" | "ww yyyy" | "HH:mm" | "shortDate" | "fullDate" | "Q yyyy";
 export {};

package/dist/packages/sdk-ui/src/query-execution/utils.d.ts

@@ -0,0 +1,3 @@
+import { PivotQueryDescription, QueryDescription } from '../query/execute-query';
+import { ExecutePivotQueryParams, ExecuteQueryParams } from './types';
+export declare function convertToQueryDescription<T extends ExecuteQueryParams | ExecutePivotQueryParams>(params: T): T extends ExecutePivotQueryParams ? PivotQueryDescription : QueryDescription;

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/utils/extract-widget-ids.d.ts

@@ -0,0 +1,2 @@
+import type { DashboardDto } from '../api/types/dashboard-dto';
+export declare const getWidgetIdsFromDashboard: (dashboard: DashboardDto) => string[];

package/dist/packages/sdk-ui/src/utils/filter-relations.d.ts

@@ -0,0 +1,64 @@
+import { Filter, FilterRelations, FilterRelationsModel, FilterRelationsModelNode } from '@sisense/sdk-data';
+/**
+ * Rules of filter relations - logical operators of how filters are related to each other.
+ */
+export type FilterRelationsRules = FilterRelationsRule | FilterRelationsRuleNode | null;
+type FilterRelationsRule = {
+    left: FilterRelationsRuleNode;
+    right: FilterRelationsRuleNode;
+    operator: 'AND' | 'OR';
+};
+type FilterRelationsRuleIdNode = {
+    instanceid: string;
+};
+type FilterRelationsRuleNode = FilterRelationsRule | FilterRelationsRuleIdNode;
+/**
+ * Merges source filters with target filters and recalculates relations.
+ *
+ * @param sourceFilters - The source filters or filter relations to merge.
+ * @param targetFilters - The target filters or filter relations to merge with.
+ * @returns Updated source filters merged with target filters. If the source filters are FilterRelations, the relations are recalculated.
+ */
+export declare function mergeFiltersOrFilterRelations(sourceFilters: Filter[] | FilterRelations | undefined, targetFilters: Filter[] | FilterRelations | undefined): Filter[] | FilterRelations;
+/**
+ * Splits filters or filter relations into filters and relations rules.
+ */
+export declare function splitFiltersAndRelations(filtersOrFilterRelations: Filter[] | FilterRelations | undefined): {
+    filters: Filter[];
+    relations: FilterRelationsRules;
+};
+/**
+ * Returns pure filters array from the given filters or filter relations.
+ */
+export declare function getFiltersArray(filtersOrFilterRelations: Filter[] | FilterRelations | undefined): Filter[];
+/**
+ * Combines filters and relations into a single FilterRelations object.
+ * If the relations are empty or relations are trivial (single node), the filters are returned as is.
+ */
+export declare function combineFiltersAndRelations(filters: Filter[], relations: FilterRelationsRules): Filter[] | FilterRelations;
+/** Type guard for checking if a node is a single relations node (trivial case when relations are needless). */
+export declare function isTrivialSingleNodeRelations(relations: FilterRelationsRules): relations is FilterRelationsRuleIdNode;
+/**
+ * Calculates new relations based on the changes in filters.
+ */
+export declare function calculateNewRelations(prevFilters: Filter[], prevRelations: FilterRelationsRules, newFilters: Filter[]): FilterRelationsRules;
+/**
+ * Replaces a filter in the relations tree with a new filter.
+ */
+export declare function getRelationsWithReplacedFilter(relations: FilterRelationsRules, filterToReplace: Filter, newFilter: Filter): FilterRelationsRules;
+/**
+ * Converts filter relations model from Fusion to internal CSDK filter relations rules.
+ */
+export declare function convertFilterRelationsModelToRelationRules(filterRelationsModel: FilterRelationsModel | FilterRelationsModelNode | undefined, filters: Filter[]): FilterRelationsRules;
+/**
+ * Converts internal CSDK filter relations rules to filter relations model for Fusion.
+ */
+export declare function filterRelationRulesToFilterRelationsModel(filterRelationRules: FilterRelationsRules, filters: Filter[]): FilterRelationsModel | FilterRelationsModelNode | undefined;
+/**
+ * Textual representation of filter relations for debugging purposes.
+ * Returns string like "(([Gender] AND [Country]) OR [Condition])".
+ *
+ * @internal
+ */
+export declare function getRelationsAsText(relations: FilterRelationsRules, filters: Filter[]): string | null;
+export {};

package/dist/packages/sdk-ui/src/utils/filters-comparator.d.ts

@@ -9,6 +9,11 @@ import { Filter, FilterRelations, FilterRelationsJaql } from '@sisense/sdk-data'
  * The function ignores randomly generated names of the filters.
  */
 export declare function isFiltersChanged(prevFilters: Filter[] | undefined, newFilters: Filter[] | undefined): boolean;
+export declare function haveSameAttribute(filterA: Filter, filterB: Filter): boolean;
+/**
+ * Compare filters with ignoring randomly generated names
+ */
+export declare function areFiltersEqual(filterA: Filter, filterB: Filter): boolean;
 /**
  * Checks if filter relations have changed by deep comparison.
  *

package/dist/packages/sdk-ui/src/utils/filters.d.ts

@@ -8,6 +8,5 @@ export declare const cloneFilterAndToggleDisabled: <TFilter extends Filter>(filt
 export declare const cloneFilter: <TFilter extends Filter>(filter: TFilter) => TFilter;
 export declare function clearMembersFilter(filter: Filter): Filter;
 export declare function isIncludeAllFilter(filter: Filter): boolean;
-export declare function haveSameAttribute(filterA: Filter, filterB: Filter): boolean;
 /** @internal */
 export declare function isSameAttribute(attributeA: Attribute, attributeB: Attribute): boolean;