@sisense/sdk-ui 1.16.0 → 1.17.0

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

@@ -20,13 +20,13 @@ export interface GetDashboardModelOptions {
 }
 /**
  * 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,6 +1,9 @@
 import { CommonFiltersOptions } from '../../common-filters/types';
 import { ColorPaletteTheme } from '../../types';
-/** @internal */
+export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules, } from '../../common-filters/types';
+/**
+ * Layout of a dashboard.
+ */
 export interface Layout {
     columns: {
         widthPercentage: number;
@@ -13,9 +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>;
-/** @internal */
+/**
+ * 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/widget/get-widget-model.d.ts

@@ -4,13 +4,13 @@ import { CompleteThemeSettings } from '../../types';
 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

@@ -5,6 +5,7 @@ import { WidgetModel } from './widget-model';
 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

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,7 +1,7 @@
 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.

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';
@@ -42,15 +42,19 @@ export interface SisenseContextProviderProps {
     /**
      * Token for [bearer authentication](https://sisense.dev/guides/restApi/using-rest-api.html).
      *
+     * 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).
      *
+     * 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.
      *
@@ -61,17 +65,32 @@ export interface SisenseContextProviderProps {
      * 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;
@@ -1271,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
      */
@@ -1293,6 +1314,12 @@ export interface DrilldownWidgetProps {
      * @category Widget
      */
     initialDimension: Attribute;
+    /**
+     * Initial drilldown selections
+     *
+     * @internal
+     */
+    drilldownSelections?: DrilldownSelection[];
     /**
      * An object that allows users to pass advanced configuration options as a prop for the `DrilldownWidget` component
      *

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

@@ -634,6 +634,25 @@ export interface ChartThemeSettings {
     backgroundColor?: string;
     /** Toolbar Background color, can be used as a secondary background color */
     panelBackgroundColor?: string;
+    /** Animation options */
+    animation?: {
+        /** Chart initialization animation options */
+        init?: {
+            /**
+             * Animation duration in milliseconds.
+             * If not specified, the default value, `auto`, will be used with a different default value applied per chart type.
+             */
+            duration?: number | 'auto';
+        };
+        /** Chart redraw animation options */
+        redraw?: {
+            /**
+             * Animation duration in milliseconds.
+             * If not specified, the default value, `auto`, will be used with a different default value applied per chart type.
+             */
+            duration?: number | 'auto';
+        };
+    };
 }
 /**
  * Theme settings specific to the AI Chatbot component
@@ -863,6 +882,19 @@ export type WidgetThemeSettings = {
         backgroundColor?: string;
     };
 };
+/**
+ * Dashboard theme settings
+ *
+ * @internal
+ */
+export type DashboardThemeSettings = {
+    /** Background color */
+    backgroundColor?: string;
+    /** Width of the divider line between widgets */
+    dividerLineWidth?: number;
+    /** Divider line color */
+    dividerLineColor?: string;
+};
 /** Theme settings defining the look and feel of components. */
 export interface ThemeSettings {
     /** Chart theme settings */
@@ -875,6 +907,12 @@ export interface ThemeSettings {
     general?: GeneralThemeSettings;
     /** Widget theme settings */
     widget?: WidgetThemeSettings;
+    /**
+     * Dashboard theme settings
+     *
+     * @internal
+     */
+    dashboard?: DashboardThemeSettings;
     /**
      * Theme settings specific to the AI Chatbot component
      */