@sisense/sdk-ui 1.15.1 → 1.17.0

package/dist/models/dashboard/dashboard-model.d.ts

@@ -1,9 +1,10 @@
 import { DataSource, Filter } from '@sisense/sdk-data';
-import { Layout, WidgetModel } from '../../models';
+import { DashboardStyleOptions, Layout, WidgetModel } from '../../models';
 import type { DashboardDto } from '../../api/types/dashboard-dto';
 import { DashboardProps } from '../../dashboard/types';
 import { type WidgetFilterOptions } from './types';
 import { CompleteThemeSettings } from '../../types';
+import { AppSettings } from '../../app/settings/settings';
 /**
  * Model of Sisense dashboard defined in the abstractions of Compose SDK.
  *
@@ -33,6 +34,12 @@ export declare class DashboardModel {
      * @internal
      */
     layout: Layout;
+    /**
+     * Dashboard style options.
+     *
+     * @internal
+     */
+    styleOptions: DashboardStyleOptions;
     /**
      * Dashboard filters.
      *
@@ -50,9 +57,10 @@ export declare class DashboardModel {
      *
      * @param dashboardDto - The widget DTO to be converted to a widget model
      * @param themeSettings - Optional theme settings
+     * @param appSettings - Optional application settings
      * @internal
      */
-    constructor(dashboardDto: DashboardDto, themeSettings?: CompleteThemeSettings);
+    constructor(dashboardDto: DashboardDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings);
     /**
      * Returns the props to be used for rendering a dashboard.
      *

package/dist/models/dashboard/get-dashboard-model.d.ts

@@ -1,6 +1,7 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { DashboardModel } from '../../models/dashboard/dashboard-model';
 import { CompleteThemeSettings } from '../../types';
+import { AppSettings } from '../../app/settings/settings';
 export interface GetDashboardModelOptions {
     /**
      * Boolean flag whether to include widgets in the dashboard model
@@ -17,5 +18,15 @@ export interface GetDashboardModelOptions {
      */
     includeFilters?: boolean;
 }
-/** @internal */
-export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings): Promise<DashboardModel>;
+/**
+ * Retrieves a dashboard model by its OID.
+ *
+ * @param http - The HTTP client
+ * @param dashboardOid - The OID of the dashboard
+ * @param options - The options to include widgets and filters in the dashboard model
+ * @param themeSettings - Optional theme settings
+ * @param appSettings - Optional application settings
+ * @returns The dashboard model
+ * @internal
+ */
+export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): Promise<DashboardModel>;

package/dist/models/dashboard/types.d.ts

@@ -1,5 +1,9 @@
 import { CommonFiltersOptions } from '../../common-filters/types';
-/** @internal */
+import { ColorPaletteTheme } from '../../types';
+export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules, } from '../../common-filters/types';
+/**
+ * Layout of a dashboard.
+ */
 export interface Layout {
     columns: {
         widthPercentage: number;
@@ -12,5 +16,20 @@ export interface Layout {
         }[];
     }[];
 }
-/** @internal */
+/**
+ * Options for how common filters defined at the dashboard level should be applied to widgets.
+ */
 export type WidgetFilterOptions = Record<string, CommonFiltersOptions>;
+/**
+ * Style options for the dashboard.
+ */
+export type DashboardStyleOptions = {
+    /** Collection of colors used to color various elements */
+    palette?: ColorPaletteTheme;
+    /** Background color */
+    backgroundColor?: string;
+    /** Width of the divider line between widgets */
+    dividerLineWidth?: number;
+    /** Divider line color */
+    dividerLineColor?: string;
+};

package/dist/models/dashboard/use-get-dashboard-model.d.ts

@@ -69,6 +69,8 @@ export type DashboardModelSuccessState = {
 /**
  * React hook that retrieves an existing dashboard model from the Sisense instance.
  *
+ * **Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @example
  * An example of retrieving an existing dashboard model from the Sisense instance and render its widgets with component `DashboardWidget`:
  ```tsx

package/dist/models/dashboard/use-get-dashboard-models.d.ts

@@ -65,6 +65,8 @@ export type DashboardModelsSuccessState = {
 /**
  * React hook that retrieves existing dashboards that the user can access to from the Sisense instance.
  *
+ * **Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @example
  ```tsx
   const { dashboards, isLoading, isError } = useGetDashboardModels();

package/dist/models/widget/get-widget-model.d.ts

@@ -1,5 +1,16 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { WidgetModel } from './widget-model';
 import { CompleteThemeSettings } from '../../types';
-/** @internal */
-export declare function getWidgetModel(httpClient: HttpClient, dashboardOid: string, widgetOid: string, themeSettings?: CompleteThemeSettings): Promise<WidgetModel>;
+import { AppSettings } from '../../app/settings/settings';
+/**
+ * Retrieves a widget model by its OID.
+ *
+ * @param httpClient - The HTTP client
+ * @param dashboardOid - The OID of the dashboard
+ * @param widgetOid - The OID of the widget
+ * @param themeSettings - Optional theme settings
+ * @param appSettings - Optional application settings
+ * @returns The widget model
+ * @internal
+ */
+export declare function getWidgetModel(httpClient: HttpClient, dashboardOid: string, widgetOid: string, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): Promise<WidgetModel>;

package/dist/models/widget/translate-widget.d.ts

@@ -2,5 +2,14 @@ import { CompleteThemeSettings } from '../../types';
 import { WidgetDto, WidgetType } from '../../dashboard-widget/types';
 import { WidgetTypeInternal } from './types';
 import { WidgetModel } from './widget-model';
-export declare function translateWidget(widget: WidgetDto, themeSettings?: CompleteThemeSettings): WidgetModel;
+import { AppSettings } from '../../app/settings/settings';
+/**
+ * Translates a widget DTO to a widget model.
+ *
+ * @param widget - The widget DTO to be converted to a widget model
+ * @param themeSettings - Optional theme settings
+ * @param appSettings - Optional application settings
+ * @returns The widget model
+ */
+export declare function translateWidget(widget: WidgetDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): WidgetModel;
 export declare function translateWidgetType(widgetType: WidgetType): WidgetTypeInternal;

package/dist/models/widget/use-get-widget-model.d.ts

@@ -71,6 +71,8 @@ export type WidgetModelSuccessState = {
 /**
  * React hook that retrieves an existing widget model from a Fusion Embed instance.
  *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * ## Example
  *
  * Retrieve a widget model and use it to populate a `Chart` component

package/dist/models/widget/widget-model.d.ts

@@ -3,7 +3,8 @@ import { ChartDataOptions, PivotTableDataOptions } from '../../chart-data-option
 import { Panel, WidgetDto, WidgetType } from '../../dashboard-widget/types';
 import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps } from '../../props';
 import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
-import { ChartType, DrilldownOptions, ChartStyleOptions, TableStyleOptions, CompleteThemeSettings, RenderToolbarHandler } from '../../types';
+import { ChartType, DrilldownOptions, CompleteThemeSettings, RenderToolbarHandler, WidgetStyleOptions } from '../../types';
+import { AppSettings } from '../../app/settings/settings';
 /**
  * Widget data options.
  */
@@ -48,7 +49,7 @@ export declare class WidgetModel {
     /**
      * Widget style options.
      */
-    styleOptions: ChartStyleOptions | TableStyleOptions;
+    styleOptions: WidgetStyleOptions;
     /**
      * Widget filters.
      */
@@ -82,9 +83,10 @@ export declare class WidgetModel {
      *
      * @param widgetDto - The widget DTO to be converted to a widget model
      * @param themeSettings - The theme settings to be used for the widget model
+     * @param appSettings - The application settings to be used for the widget model
      * @internal
      */
-    constructor(widgetDto: WidgetDto, themeSettings?: CompleteThemeSettings);
+    constructor(widgetDto: WidgetDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings);
     /**
      * Returns the parameters to be used for executing a query for the widget.
      *

package/dist/pivot-table/helpers/prepare-pivot-styling-props.d.ts

@@ -1,21 +1,22 @@
 import { CompleteThemeSettings, PivotTableStyleOptions } from '../../types';
-export declare function preparePivotStylingProps(styleOptions?: PivotTableStyleOptions, themeSettings?: CompleteThemeSettings): {
-    fontFamily: string | undefined;
-    textColor: string | undefined;
-    backgroundColor: string | undefined;
-    borderColor: string;
-    fillColor: string | undefined;
-    additionalFillColor: string | undefined;
+export type PivotStylingProps = {
+    fontFamily?: string;
+    textColor?: string;
+    backgroundColor?: string;
+    borderColor?: string;
+    fillColor?: string;
+    additionalFillColor?: string;
     fillOptions: {
-        alternatingRows: boolean | undefined;
-        alternatingColumns: boolean | undefined;
-        columnsHeaders: boolean | undefined;
-        rowMembers: boolean | undefined;
-        totals: boolean | undefined;
+        alternatingRows?: boolean;
+        alternatingColumns?: boolean;
+        columnsHeaders?: boolean;
+        rowMembers?: boolean;
+        totals?: boolean;
     };
-    rowHeight: number | undefined;
+    rowHeight?: number;
     isAutoHeight: boolean;
-    navigationPrimaryColor: string | undefined;
-    navigationSecondaryColor: string | undefined;
+    navigationPrimaryColor?: string;
+    navigationSecondaryColor?: string;
     selectionColor: string;
 };
+export declare function preparePivotStylingProps(styleOptions?: PivotTableStyleOptions, themeSettings?: CompleteThemeSettings): PivotStylingProps;

package/dist/pivot-table/{use-apply-pivot-table-formatting.d.ts → hooks/use-apply-pivot-table-formatting.d.ts}

@@ -1,5 +1,5 @@
 import { type DataService } from '@sisense/sdk-pivot-client';
-import { type PivotTableDataOptions } from '../chart-data-options/types';
+import { type PivotTableDataOptions } from '../../chart-data-options/types';
 /**
  * A hook that applies formatting over pivot table cells.
  *

package/dist/pivot-table/{use-get-pivot-table-query.d.ts → hooks/use-get-pivot-table-query.d.ts}

@@ -1,23 +1,19 @@
 import { type JaqlRequest } from '@sisense/sdk-pivot-client';
 import type { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
-import { ExecutePivotQueryParams } from '../query-execution';
-import { PivotTableDataOptionsInternal } from '../chart-data-options/types';
+import { ExecutePivotQueryParams } from '../../query-execution';
+import { PivotTableDataOptionsInternal } from '../../chart-data-options/types';
 export declare const getPivotQueryOptions: (dataOptions: PivotTableDataOptionsInternal) => Pick<ExecutePivotQueryParams, 'rows' | 'columns' | 'values' | 'grandTotals'>;
 /**
  * A hook that returns the JAQL request object from pivot table props.
  *
  * @internal
  */
-export declare const useGetPivotTableQuery: ({ dataSet, dataOptionsInternal, filters, highlights, refreshCounter, }: {
+export declare const usePivotTableQuery: ({ dataSet, dataOptionsInternal, filters, highlights, }: {
     dataSet?: DataSource | undefined;
     dataOptionsInternal: PivotTableDataOptionsInternal;
     filters?: Filter[] | FilterRelations | undefined;
     highlights?: Filter[] | undefined;
-    refreshCounter?: number | undefined;
 }) => {
-    isLoading: boolean;
-    isSuccess: boolean;
-    isError: boolean;
+    jaql: JaqlRequest | undefined;
     error: Error | undefined;
-    jaql: JaqlRequest | null;
 };

package/dist/pivot-table/hooks/use-pivot-data-loading.d.ts

@@ -0,0 +1,15 @@
+import { JaqlRequest, PivotBuilder } from '@sisense/sdk-pivot-client';
+interface LoadingState {
+    isLoading: boolean;
+    isNoResults: boolean;
+}
+/**
+ * Hook that initiates loading if jaql is changed or force reload is triggered.
+ * Listens to query lifecycle events to update loading state and no results state.
+ */
+export declare function usePivotDataLoading(options: {
+    jaql: JaqlRequest | undefined;
+    pivotBuilder: PivotBuilder;
+    isForceReload: boolean;
+}): LoadingState;
+export {};

package/dist/pivot-table/hooks/use-pivot-data-service.d.ts

@@ -0,0 +1,10 @@
+import { DataService, PivotBuilder, PivotClient } from '@sisense/sdk-pivot-client';
+/**
+ * Hook that recreates a new data service when new jaql request is needed to sent
+ * and updates the pivot builder with the new data service.
+ */
+export declare function usePivotDataService(options: {
+    pivotClient: PivotClient;
+    pivotBuilder: PivotBuilder;
+    shouldBeRecreated: boolean;
+}): DataService;

package/dist/pivot-table/{use-pivot-table-data-options-internal.d.ts → hooks/use-pivot-table-data-options-internal.d.ts}

@@ -1,5 +1,5 @@
-import { PivotTableDataOptions, PivotTableDataOptionsInternal } from '../chart-data-options/types.js';
-import { PivotSortCriteria } from './sorting-utils.js';
+import { PivotTableDataOptions, PivotTableDataOptionsInternal } from '../../chart-data-options/types.js';
+import { PivotSortCriteria } from '../sorting-utils.js';
 type UsePivotTableDataOptionsInternalResult = {
     dataOptionsInternal: PivotTableDataOptionsInternal;
     updateSort: (sortCriteria: PivotSortCriteria) => void;

package/dist/pivot-table/hooks/use-render-pivot.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="react" />
+import type { PivotBuilder } from '@sisense/sdk-pivot-client';
+import type { CompleteThemeSettings, PivotTableStyleOptions } from '../../types';
+import type { PivotTableDataOptions } from '../../chart-data-options/types';
+import type { ContainerSize } from '../../dynamic-size-container/dynamic-size-container';
+type PivotRenderOptions = {
+    /** Reference to the pivot table container. */
+    nodeRef: React.RefObject<HTMLDivElement>;
+    /** The pivot builder instance. */
+    pivotBuilder: PivotBuilder;
+    /** The pivot table data options. */
+    dataOptions: PivotTableDataOptions;
+    /** The pivot table style options. */
+    styleOptions: PivotTableStyleOptions;
+    /** The theme settings. */
+    themeSettings: CompleteThemeSettings;
+    /** The size of the pivot table container. */
+    size: ContainerSize | null;
+};
+/**
+ * A hook that renders the pivot table.
+ */
+export declare function useRenderPivot({ nodeRef, pivotBuilder, dataOptions, styleOptions, themeSettings, size, }: PivotRenderOptions): void;
+export {};

package/dist/pivot-table/pivot-table.d.ts

@@ -1,4 +1,4 @@
-import React from 'react';
+/// <reference types="react" />
 import { PivotTableProps } from '../props';
 /**
  * Pivot table with pagination.
@@ -80,4 +80,4 @@ import { PivotTableProps } from '../props';
  * @group Data Grids
  * @beta
  */
-export declare const PivotTable: React.FunctionComponent<PivotTableProps>;
+export declare const PivotTable: import("react").FunctionComponent<PivotTableProps>;

package/dist/props.d.ts

@@ -1,5 +1,5 @@
 import { Attribute, Filter, Measure, DataSource, Data, QueryResultData, FilterRelations } from '@sisense/sdk-data';
-import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions } from './types';
+import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection } from './types';
 import { HighchartsOptions } from './chart-options-processor/chart-options-service';
 import { ComponentType, PropsWithChildren, ReactNode } from 'react';
 import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions } from './chart-data-options/types';
@@ -21,49 +21,76 @@ export type { MenuItemSection, HighchartsOptions };
 export interface SisenseContextProviderProps {
     /**
      * Default data source explicitly set to be used by child components that are not defined with a data source.
+     *
+     * @category Sisense App
      */
     defaultDataSource?: DataSource;
-    /** URL of the Sisense environment the app connects to */
+    /**
+     * URL of the Sisense environment the app connects to
+     *
+     * @category Sisense App
+     */
     url: string;
     /**
      * [Single Sign-On](https://docs.sisense.com/main/SisenseLinux/using-single-sign-on-to-access-sisense.htm) toggle.
      *
      * Set to `true` to use SSO authentication. When `true`, this overrides any other authentication methods. Defaults to `false`.
      *
-     * @category Authentication
+     * @category Sisense Authentication
      */
     ssoEnabled?: boolean;
     /**
      * Token for [bearer authentication](https://sisense.dev/guides/restApi/using-rest-api.html).
      *
-     * @category Authentication
+     * To signify that the token is pending (e.g., being generated), set the value to `null`. This is supported for React and Vue only.
+     *
+     * @category Sisense Authentication
      */
-    token?: string;
+    token?: string | null;
     /**
      * [Web Access Token](https://docs.sisense.com/main/SisenseLinux/using-web-access-token.htm).
      *
-     * @category Authentication
+     * To signify that the token is pending (e.g., being generated), set the value to `null`. This is supported for React and Vue only.
+     *
+     * @category Sisense Authentication
      */
-    wat?: string;
+    wat?: string | null;
     /**
      * Application specific configurations such as locale and date formats.
+     *
+     * @category Sisense App
      */
     appConfig?: AppConfig;
     /**
      * Boolean flag to show or hide run-time errors that involve Sisense context in the UI.
      * Example errors include incorrect Sisense URL or invalid authentication.
      * Note that this flag does not hide run-time errors in the console.
+     * If disabled - it's recommended to specify an {@link onError} callback to handle errors.
      *
      * If not specified, the default value is `true`.
      *
-     * @internal
+     * @category Sisense App Error Handling
      */
     showRuntimeErrors?: boolean;
+    /**
+     * Callback function that is triggered when an error occurs within the Sisense context.
+     *
+     * 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;
     /**
      * Boolean flag to enable sending tracking events to the Sisense instance.
      *
      * If not specified, the default value is `true`.
      *
+     * Deprecated: Use {@link AppConfig.trackingConfig | trackingConfig.enabled }
+     *
+     * @deprecated Use {@link AppConfig.trackingConfig | trackingConfig.enabled }
      * @internal
      */
     enableTracking?: boolean;
@@ -1263,7 +1290,9 @@ export type DrilldownWidgetConfig = {
      */
     breadcrumbsComponent?: ComponentType<DrilldownBreadcrumbsProps>;
     /**
-     * Boolean to override default breadcrumbs location and instead only return them as a property of the 'children' function
+     * React component to be rendered as context menu
+     *
+     * {@link ContextMenu} will be used if not provided
      *
      * @category Widget
      */
@@ -1286,7 +1315,13 @@ export interface DrilldownWidgetProps {
      */
     initialDimension: Attribute;
     /**
-     * An object that allows users to pass advanced configuration options as a prop for the {@link DrilldownWidget} component
+     * Initial drilldown selections
+     *
+     * @internal
+     */
+    drilldownSelections?: DrilldownSelection[];
+    /**
+     * An object that allows users to pass advanced configuration options as a prop for the `DrilldownWidget` component
      *
      * @category Widget
      */

package/dist/query-execution/execute-query-by-widget-id.d.ts

@@ -7,6 +7,8 @@ import { ExecuteQueryByWidgetIdProps } from '../props';
  * This component takes the Children Prop Pattern and
  * offers an alternative approach to the {@link useExecuteQueryByWidgetId} hook.
  *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @example
  * The example below executes a query over the existing dashboard widget with the specified widget and dashboard OIDs.
  * ```tsx

package/dist/query-execution/index.d.ts

@@ -5,4 +5,4 @@ export { ExecuteQueryByWidgetId } from './execute-query-by-widget-id';
 export { useExecuteQueryByWidgetId, executeQueryByWidgetId, } from './use-execute-query-by-widget-id';
 export { useExecutePivotQuery } from './use-execute-pivot-query';
 export { useQueryCache } from './use-query-cache';
-export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, PivotQueryState, PivotQueryLoadingState, PivotQuerySuccessState, PivotQueryErrorState, ExecuteQueryParams, ExecuteQueryResult, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, ExecutePivotQueryParams, } from './types';
+export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, PivotQueryState, PivotQueryLoadingState, PivotQuerySuccessState, PivotQueryErrorState, ExecuteQueryParams, ExecuteQueryResult, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, QueryByWidgetIdQueryParams, ExecutePivotQueryParams, } from './types';

package/dist/query-execution/types.d.ts

@@ -154,10 +154,19 @@ export interface ExecuteQueryByWidgetIdParams {
     /** {@inheritDoc ExecuteQueryParams.enabled} */
     enabled?: boolean;
 }
-export type QueryByWidgetIdState = QueryState & {
-    /** Query parameters constructed over the widget */
+/**
+ * Query parameters constructed over either a chart widget or pivot table widget. This is returned as part of the query state {@link QueryByWidgetIdState}.
+ */
+export type QueryByWidgetIdQueryParams = {
+    /** Query parameters constructed over the chart widget */
     query: ExecuteQueryParams | undefined;
+    /** Query parameters constructed over the pivot table widget */
+    pivotQuery: ExecutePivotQueryParams | undefined;
 };
+/**
+ * State of a query execution retrieving data of Fusion widget.
+ */
+export type QueryByWidgetIdState = QueryState & QueryByWidgetIdQueryParams;
 /**
  * Parameters for {@link useExecuteQuery} hook.
  */

package/dist/query-execution/use-execute-query-by-widget-id.d.ts

@@ -1,11 +1,12 @@
-import { QueryDescription } from '../query/execute-query';
 import { ClientApplication } from '../app/client-application';
-import { ExecuteQueryByWidgetIdParams, QueryByWidgetIdState } from './types';
+import { ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, QueryByWidgetIdQueryParams } from './types';
+import { QueryResultData } from '@sisense/sdk-data';
 /**
  * React hook that executes a data query extracted from an existing widget in the Sisense instance.
  *
  * This approach, which offers an alternative to {@link ExecuteQueryByWidgetId} component, is similar to React Query's `useQuery` hook.
  *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
  *
  * @example
  * The example below executes a query over the existing dashboard widget with the specified widget and dashboard OIDs.
@@ -48,6 +49,5 @@ export declare function useParamsChanged(params: ExecuteQueryByWidgetIdParams):
 export declare function executeQueryByWidgetId({ widgetOid, dashboardOid, filters, highlights, filtersMergeStrategy, count, offset, includeDashboardFilters, app, onBeforeQuery, }: ExecuteQueryByWidgetIdParams & {
     app: ClientApplication;
 }): Promise<{
-    data: import("@sisense/sdk-data").QueryResultData;
-    query: QueryDescription;
-}>;
+    data: QueryResultData;
+} & QueryByWidgetIdQueryParams>;

package/dist/sisense-context/sisense-context.d.ts

@@ -1,11 +1,13 @@
 /// <reference types="react" />
 import { ClientApplication } from '../app/client-application';
+import { TrackingEventDetails } from '@sisense/sdk-tracking';
 export type SisenseContextPayload = {
     isInitialized: boolean;
     app?: ClientApplication;
     tracking: {
         enabled: boolean;
         packageName: string;
+        onTrackingEvent?: (payload: TrackingEventDetails) => void;
     };
 };
 export declare const SisenseContext: import("react").Context<SisenseContextPayload>;

package/dist/theme-provider/default-theme-settings.d.ts

@@ -1,4 +1,6 @@
 import { CompleteThemeSettings } from '../types';
+export declare const DEFAULT_DIVIDER_COLOR = "#F2F2F2";
+export declare const DEFAULT_DIVIDER_WIDTH = 4;
 /**
  * Returns default theme settings, which can be used as base for custom theme options.
  *

package/dist/themes/legacy-design-settings.d.ts

@@ -73,6 +73,20 @@ export type LegacyPaletteError = {
     message: string;
     status: 'error';
 };
+/**
+ * Mapping of legacy design properties types to theme setting types
+ */
+export declare const LEGACY_DESIGN_TYPES: {
+    none: string;
+    small: string;
+    medium: string;
+    large: string;
+    left: string;
+    center: string;
+    right: string;
+    light: string;
+    dark: string;
+};
 /**
  * Converts legacy (used in Sisense UI) design settings and it's palette object to CompleteThemeSettings.
  *

package/dist/translation/resources/en.d.ts

@@ -87,6 +87,15 @@ export declare const translation: {
             max: string;
         };
     };
+    advanced: {
+        tooltip: {
+            min: string;
+            max: string;
+            forecastValue: string;
+            forecast: string;
+            trend: string;
+        };
+    };
     arearange: {
         tooltip: {
             min: string;

package/dist/translation/resources/index.d.ts

@@ -91,6 +91,15 @@ export declare const resources: {
                 max: string;
             };
         };
+        advanced: {
+            tooltip: {
+                min: string;
+                max: string;
+                forecastValue: string;
+                forecast: string;
+                trend: string;
+            };
+        };
         arearange: {
             tooltip: {
                 min: string;
@@ -195,6 +204,15 @@ export declare const resources: {
                 max: string;
             };
         };
+        advanced: {
+            tooltip: {
+                min: string;
+                max: string;
+                forecastValue: string;
+                forecast: string;
+                trend: string;
+            };
+        };
         arearange: {
             tooltip: {
                 min: string;