@sisense/sdk-ui 2.10.0 → 2.11.0

package/dist/packages/sdk-ui/src/dashboard/hooks/use-dashboard-header-toolbar.d.ts

@@ -1,14 +1,21 @@
+/**
+ * @internal
+ */
 export interface DashboardHeaderToolbarMenuItem {
     title: string;
     icon?: JSX.Element;
     ariaLabel?: string;
     onClick: () => void;
 }
+/**
+ * @internal
+ */
 export interface UseDashboardHeaderToolbarProps {
     menuItems: DashboardHeaderToolbarMenuItem[];
 }
 /**
  * Hook that returns a toolbar element for dashboard header
+ * @internal
  */
 export declare const useDashboardHeaderToolbar: ({ menuItems }: UseDashboardHeaderToolbarProps) => {
     toolbar: () => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/dashboard/hooks/use-edit-mode-toolbar.d.ts

@@ -1,6 +1,7 @@
 import { WidgetsPanelLayout } from '../../models';
 /**
  * Props for the useEditModeToolbar hook
+ * @internal
  */
 export interface UseEditModeToolbarProps {
     /**
@@ -23,6 +24,7 @@ export interface UseEditModeToolbarProps {
 }
 /**
  * Return type for the useEditModeToolbar hook
+ * @internal
  */
 export interface UseEditModeToolbarResult {
     /**
@@ -47,5 +49,6 @@ export interface UseEditModeToolbarResult {
  *
  * @param props Configuration options for the toolbar
  * @returns Layout state and toolbar component
+ * @internal
  */
 export declare function useEditModeToolbar({ initialLayout, onApply, onCancel, historyCapacity, }: UseEditModeToolbarProps): UseEditModeToolbarResult;

package/dist/packages/sdk-ui/src/dashboard/hooks/use-jtd-widget.d.ts

@@ -0,0 +1,68 @@
+import { WidgetProps } from '../../props.js';
+import { JumpToDashboardConfig } from './jtd/jtd-types';
+import { JumpToDashboardConfigForPivot } from './use-jtd';
+/**
+ * Hook to add Jump To Dashboard (JTD) functionality to individual Widget components.
+ *
+ * Jump To Dashboard (JTD) allows users to navigate from one dashboard to another when interacting with widgets,
+ * such as clicking on chart data points or using context menus. This hook is particularly useful when rendering
+ * Widget components directly (not through a Dashboard component), but you still want JTD navigation functionality.
+ *
+ * For widgets that are part of a dashboard, consider using `applyJtdConfig` or `applyJtdConfigs` instead,
+ * as they apply JTD configuration at the dashboard level rather than individual widget level.
+ *
+ * Note: dashboard-only 'includeDashboardFilters' is not supported and would just be ignored, since we do not have a dashboard in the current context.
+ *
+ * This hook enhances the provided widget props with JTD navigation capabilities, including:
+ * - Click and right-click event handlers for navigation
+ * - Hyperlink styling for actionable pivot cells (when applicable)
+ * - JTD icon display in widget headers
+ *
+ * @example
+ * Basic JTD configuration with right-click navigation.
+ * ```typescript
+ * import { useJtdWidget } from '@sisense/sdk-ui';
+ *
+ * const jtdConfig: JumpToDashboardConfig = {
+ *   targets: [{ id: 'dashboard-1', caption: 'Sales Dashboard' }],
+ *   interaction: {
+ *     triggerMethod: 'rightclick',
+ *     captionPrefix: 'Jump to'
+ *   }
+ * };
+ *
+ * const MyComponent = () => {
+ *   const widgetWithJtd = useJtdWidget(myWidgetProps, jtdConfig);
+ *
+ *   return <Widget {...widgetWithJtd} />;
+ * };
+ * ```
+ *
+ * @example
+ * JTD configuration with multiple targets and custom styling.
+ * ```typescript
+ * const jtdConfig: JumpToDashboardConfig = {
+ *   enabled: true,
+ *   targets: [
+ *     { id: 'sales-dashboard', caption: 'Sales Analysis' },
+ *     { id: 'marketing-dashboard', caption: 'Marketing Insights' }
+ *   ],
+ *   interaction: {
+ *     triggerMethod: 'click',
+ *     captionPrefix: 'Navigate to',
+ *     showIcon: true
+ *   },
+ *   filtering: {
+ *     mergeWithTargetFilters: true,
+ *     includeWidgetFilters: true
+ *   }
+ * };
+ *
+ * const widgetWithJtd = useJtdWidget(chartProps, jtdConfig);
+ * ```
+ *
+ * @returns Enhanced widget props with JTD navigation capabilities, menu combination, and styling applied
+ *
+ * @group Dashboards
+ */
+export declare const useJtdWidget: (widgetProps: WidgetProps | null, config: JumpToDashboardConfig | JumpToDashboardConfigForPivot) => WidgetProps | null;

package/dist/packages/sdk-ui/src/dashboard/hooks/use-jtd.d.ts

@@ -1,22 +1,48 @@
 import { type Filter } from '@sisense/sdk-data';
 import { WidgetProps } from '../../props.js';
 import { OpenMenuFn } from '../../common/components/menu/types.js';
-import { WidgetsOptions } from '../../index-typedoc';
+import { CompleteThemeSettings, WidgetsOptions } from '../../index-typedoc';
+import { type JtdActions } from '../../dashboard/hooks/jtd/jtd-types';
+import { JtdConfig } from '../../dashboard/hooks/jtd/jtd-types';
 /**
- * Jump to Dashboard (JTD) hook.
+ * Shared function to apply JTD functionality to a widget.
+ * Extracted to avoid code duplication between use-jtd.ts and use-jtd-widget.ts
+ *
+ * @param widgetProps - The widget props to enhance
+ * @param config - JTD application configuration
+ * @returns Enhanced widget props with JTD functionality
+ * @internal
+ */
+export declare const applyJtdToWidget: (widgetProps: WidgetProps, config: {
+    normalizedJtdConfig: JtdConfig;
+    dashboardFilters: Filter[];
+    originalWidgetFilters: Filter[];
+    extraFilters?: Filter[];
+    actions: JtdActions;
+    themeSettings: CompleteThemeSettings;
+}) => WidgetProps;
+/**
+ * Internal Jump To Dashboard (JTD) hook.
  * Implements the JTD functionality for each widget with JTD config.
- * @param widgetOptions - The widget options of the dashboard
- * @param dashboardFilters - The dashboard filters to use
- * @param widgetFilters - The widget filters to use
- * @param openMenu - The open menu function to use
+ * Supports both legacy JtdConfig and new JumpToDashboardConfig formats.
+ *
+ * @param config - The configuration object
+ * @param config.widgetOptions - The widget options of the dashboard
+ * @param config.dashboardFilters - The dashboard filters to use
+ * @param config.widgetFilters - The widget filters to use
+ * @param config.extraFilters - Extra filters to apply with highest priority
+ * @param config.openMenu - The open menu function to use
  * @returns The connect to widget props function
+ * @internal
  */
-export declare const useJtd: ({ widgetOptions, dashboardFilters, widgetFilters, openMenu, }: {
+export declare const useJtdInternal: ({ widgetOptions, dashboardFilters, widgetFilters, openMenu, extraFilters, }: {
     widgetOptions: WidgetsOptions;
     dashboardFilters?: Filter[] | undefined;
     widgetFilters?: Map<string, Filter[]> | undefined;
+    extraFilters?: Filter[] | undefined;
     openMenu: OpenMenuFn;
 }) => {
     connectToWidgetProps: (widgetProps: WidgetProps) => WidgetProps;
 };
 export * from './jtd';
+export { useJtdWidget } from './use-jtd-widget';

package/dist/packages/sdk-ui/src/dashboard/hooks/use-tabber.d.ts

@@ -2,6 +2,9 @@ import { WidgetProps } from '../../props';
 import { WidgetPanelLayoutManager } from '../../dashboard/hooks/use-widgets-layout';
 import { TabberTab } from '../../types';
 import { TabbersOptions, WidgetsPanelColumnLayout } from '../../models';
+/**
+ * @internal
+ */
 export type UseTabber = ({ widgets, config, }: {
     widgets: WidgetProps[];
     config?: TabbersOptions | undefined;
@@ -9,10 +12,20 @@ export type UseTabber = ({ widgets, config, }: {
     layoutManager: WidgetPanelLayoutManager;
     widgets: WidgetProps[];
 };
+/**
+ * @internal
+ */
 export type SingleTabberConfig = {
     tabs: TabberTab[];
     activeTab: number;
 };
 export declare const isTabberWidget: (widget: WidgetProps) => boolean;
 export declare const modifyLayout: (tabbersOptions: TabbersOptions, tabberState: Record<string, number>) => (layout: WidgetsPanelColumnLayout) => WidgetsPanelColumnLayout;
+/**
+ * Hook that modifies widget properties so it became a tabber widget.
+ * Incapsulates logic for updating layout via navigating tabs
+ * @param widgets
+ * @param tabbersConfigs
+ * @internal
+ */
 export declare const useTabber: UseTabber;

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

@@ -2,4 +2,5 @@ export { DashboardById } from './dashboard-by-id';
 export { Dashboard } from './dashboard';
 export { useComposedDashboard, useComposedDashboardInternal, type ComposableDashboardProps, type UseComposedDashboardOptions, } from './use-composed-dashboard';
 export { useDashboardTheme, type DashboardThemeParams } from './use-dashboard-theme';
+export * from './hooks';
 export type { DashboardByIdProps, DashboardProps, DashboardLayoutOptions, DashboardStyleOptions, DashboardConfig, DashboardByIdConfig, WidgetsPanelConfig, EditModeConfig, DashboardFiltersPanelConfig, } from './types';

package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/utils.d.ts

@@ -1,5 +1,4 @@
-import { TFunction } from '@sisense/sdk-common';
-import { Filter, MembersFilter, DimensionalLevelAttribute, RelativeDateFilter } from '@sisense/sdk-data';
+import { Filter, MembersFilter, RelativeDateFilter } from '@sisense/sdk-data';
 export declare function isSupportedByFilterEditor(filter: Filter): boolean;
 export declare function isIncludeAllFilter(filter: Filter): filter is MembersFilter;
 export declare function isIncludeMembersFilter(filter: Filter): filter is MembersFilter;
@@ -8,7 +7,6 @@ export declare function isConditionalFilter(filter: Filter): boolean;
 export declare function isNumericBetweenFilter(filter: Filter): boolean;
 export declare function isRelativeDateFilterWithAnchor(filter: Filter): filter is RelativeDateFilter;
 export declare function isRelativeDateFilterWithoutAnchor(filter: Filter): filter is RelativeDateFilter;
-export declare function createLevelAttribute(baseLevelAttribute: DimensionalLevelAttribute, granularity: string, t: TFunction): DimensionalLevelAttribute;
 /**
  * Formats a given Date object into a string in the format "YYYY-MM-DDT00:00:00".
  *

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

@@ -46,7 +46,7 @@ export { useCustomWidgets } from './custom-widgets-provider';
 export { extractDimensionsAndMeasures, useExecuteCustomWidgetQuery, useExecuteCustomWidgetQueryInternal, type ExecuteCustomWidgetQueryParams, type CustomWidgetQueryState, } from './custom-widgets-provider';
 export { getThemeSettingsByOid } from './themes/theme-loader';
 export { getDefaultThemeSettings } from './theme-provider/default-theme-settings';
-export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, useDashboardPersistence, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, translateFiltersAndRelationsToDto, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, type WidgetsPanelColumnLayout, type WidgetsPanelLayout, type WidgetsPanelColumn, type WidgetsPanelRow, type WidgetsPanelCell, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchyModelsParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, UseDashboardModelActionType, } from './models';
+export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, useDashboardPersistence, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, translateFiltersAndRelationsToDto, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, type WidgetsPanelColumnLayout, type WidgetsPanelLayout, type WidgetsPanelColumn, type WidgetsPanelRow, type WidgetsPanelCell, type WidgetId, type DashboardId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchyModelsParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, UseDashboardModelActionType, } from './models';
 /**
  * Utility functions to translate a Fusion widget model from and to other widget data structures
  *
@@ -70,6 +70,13 @@ export * as dashboardModelTranslator from './models/dashboard/dashboard-model-tr
  * @shortDescription Utility functions to manipulate dashboard elements
  */
 export * as dashboardHelpers from './dashboard/dashboard-helpers';
+/**
+ * Jump To Dashboard (JTD) configuration types
+ *
+ * @group Dashboards
+ * @shortDescription Configuration types for Jump To Dashboard functionality
+ */
+export type { JumpToDashboardConfig } from './dashboard/hooks/jtd';
 export type { AutoZoomNavigatorScrollerLocation } from './widget-by-id/types';
 export { boxWhiskerProcessResult } from './boxplot-utils';
 export { queryStateReducer } from './query-execution/query-state-reducer';
@@ -90,6 +97,7 @@ export { LoadingIndicator } from './common/components/loading-indicator';
 export { LoadingOverlay } from './common/components/loading-overlay';
 export { useFetch, type RequestConfig, type UseQueryResult } from './common/hooks/use-fetch';
 export { useGetDataSourceFields } from './common/hooks/fusion-endpoints/use-get-data-source-fields';
+export { useJtdWidget } from './dashboard/hooks/use-jtd-widget';
 export type { EmptyObject } from './utils/utility-types';
 export { translateColumnToAttribute } from './chart-data-options/utils';
 export { isSameAttribute } from './utils/filters';

package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-utils.d.ts

@@ -1,11 +1,23 @@
 import { type LayoutDto, type FilterDto, type CascadingFilterDto, DashboardDto } from '../../api/types/dashboard-dto';
 import type { WidgetsPanelColumnLayout, WidgetsOptions, TabbersOptions } from './types';
-import { Filter, FilterRelations, FilterRelationsModel, FilterRelationsModelNode } from '@sisense/sdk-data';
-import { WidgetDto } from '../../widget-by-id/types';
+import { Filter, FilterRelations, FilterRelationsModel, FilterRelationsModelNode, Measure, Dimension } from '@sisense/sdk-data';
+import { Panel, WidgetDto } from '../../widget-by-id/types';
+import { TriggerMethod, JtdTarget } from '../../dashboard/hooks/jtd/jtd-types';
 import { RestApi } from '../../api/rest-api';
 export declare const translateLayout: (layout: LayoutDto) => WidgetsPanelColumnLayout;
 export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>, filterRelationsModel?: FilterRelationsModel | FilterRelationsModelNode): Filter[] | FilterRelations;
+export declare const getJtdNavigateType: (widget: WidgetDto) => TriggerMethod;
 export declare const convertDimensionsToDimIndexes: (widget: WidgetDto, dimensionIds: string[]) => string[];
+/**
+ * Extract pivot targets configuration from widget DTO and build Map-based targets
+ * @param widget - Widget DTO with drillToDashboardConfig
+ * @returns Map of dimensions/measures to their targets or undefined if no targets found
+ * @internal
+ */
+export declare function extractPivotTargetsConfigFromWidgetDto(widget: WidgetDto): Map<Dimension | {
+    dimension: Dimension;
+    location: 'row' | 'column' | 'value';
+} | Measure, JtdTarget[]> | undefined;
 export declare function translateWidgetsOptions(widgets?: WidgetDto[]): WidgetsOptions;
 export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersOptions;
 /**
@@ -17,3 +29,14 @@ export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersO
  * @internal
  */
 export declare function withSharedFormulas(dashboard: DashboardDto, api: RestApi): Promise<DashboardDto>;
+/**
+ * Find dimension or measure by instanceId in widget panels and convert to proper type
+ * @param panels - Widget metadata panels to search
+ * @param pivotDimension - Instance ID to find, this is not a PivotDimId, it is the instanceId of the dimension or measure
+ * @returns Dimension/Measure object with optional location info or undefined if not found
+ * @internal
+ */
+export declare function findDimensionByInstanceId(panels: Panel[], pivotDimension: string): Dimension | Measure | {
+    dimension: Dimension;
+    location: 'row' | 'column' | 'value';
+} | undefined;

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

@@ -1,6 +1,6 @@
 import { CommonFiltersOptions } from '../../common-filters/types';
 import { ColorPaletteTheme, TabberConfig } from '../../types';
-import { JtdConfig } from '../../widget-by-id/types';
+import type { JumpToDashboardConfig, JumpToDashboardConfigForPivot } from '../../dashboard/hooks/jtd/jtd-types';
 export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules, } from '../../common-filters/types';
 /**
  * Part of Dashboard layout, which describes how widgets are arranged in a cell
@@ -59,6 +59,11 @@ export type WidgetsPanelLayout = WidgetsPanelColumnLayout;
  * Widget ID
  */
 export type WidgetId = string;
+/**
+ * Dashboard ID
+ * @internal
+ */
+export type DashboardId = string;
 /**
  * Options for widgets in a dashboard
  *
@@ -67,10 +72,9 @@ export type WidgetId = string;
 export type WidgetsOptions = Record<WidgetId, {
     filtersOptions?: CommonFiltersOptions;
     /**
-     * Jump to dashboard config for widgets
-      @internal
+     * Jump To Dashboard config for widgets.
      */
-    jtdConfig?: JtdConfig;
+    jtdConfig?: JumpToDashboardConfig | JumpToDashboardConfigForPivot;
 }>;
 /**
  * Options for TabberWidets in a dashboard

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

@@ -299,8 +299,6 @@ point: IndicatorDataPoint,
 nativeEvent: MouseEvent) => void;
 /**
  * Click handler for when a calendar-heatmap data point is clicked
- *
- * @alpha
  */
 export type CalendarHeatmapDataPointEventHandler = (
 /** Data point that was clicked */
@@ -309,8 +307,6 @@ point: CalendarHeatmapDataPoint,
 nativeEvent: PointerEvent) => void;
 /**
  * Click handler for when multiple calendar-heatmap data points are selected.
- *
- * @alpha
  */
 export type CalendarHeatmapDataPointsEventHandler = (
 /** Data points that were selected */
@@ -1765,8 +1761,6 @@ export interface UseGetSharedFormulaParams extends HookEnableParam {
 }
 /**
  * Props of the {@link CalendarHeatmapChart} component.
- *
- * @internal
  */
 export interface CalendarHeatmapChartProps extends BaseChartProps, CalendarHeatmapChartEventProps {
     /**