@sisense/sdk-ui 1.21.0 → 1.23.0

package/dist/packages/sdk-ui/src/{dashboard-widget → widget-by-id}/types.d.ts

@@ -1,5 +1,5 @@
 import { WidgetContainerStyleOptions } from '../types';
-import { LEGACY_DESIGN_TYPES } from './../themes/legacy-design-settings';
+import { LEGACY_DESIGN_TYPES } from '../themes/legacy-design-settings';
 import { BaseJaql, Jaql, JaqlDataSource, JaqlSortDirection } from '@sisense/sdk-data';
 import { HierarchyId } from '../models/hierarchy';
 /**

package/dist/packages/sdk-ui/src/{dashboard-widget → widget-by-id}/use-fetch-widget-dto-model.d.ts

@@ -1,6 +1,6 @@
-import { RestApi } from '../api/rest-api';
-import { DashboardDto } from '../api/types/dashboard-dto';
-import { WidgetDto } from './types';
+import { RestApi } from '../api/rest-api.js';
+import { DashboardDto } from '../api/types/dashboard-dto.js';
+import { WidgetDto } from './types.js';
 /**
  * Fetches a Widget DTO model and, optionally, a Dashboard DTO model.
  *

package/dist/packages/sdk-ui/src/{dashboard-widget → widget-by-id}/utils.d.ts

@@ -1,10 +1,11 @@
-import { type Filter, JaqlSortDirection, FilterRelations, FilterRelationsModel, FilterRelationsJaql } from '@sisense/sdk-data';
-import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options';
-import { ChartType, type SortDirection } from '../types';
-import { FiltersMergeStrategy, Panel, PanelItem, TextWidgetDtoStyle, WidgetStyle, WidgetSubtype, WidgetType } from './types';
-import { ChartProps, ChartWidgetProps, PivotTableWidgetProps, PluginWidgetProps, RenderToolbarHandler, TextWidgetProps, CommonWidgetProps, WithWidgetType, WidgetProps } from '..';
+import { type Filter, FilterRelations, FilterRelationsModel, FilterRelationsJaql } from '@sisense/sdk-data';
+import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options.js';
+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';
 export declare function getChartType(widgetType: WidgetType): ChartType;
+export declare function getWidgetTypeFromChartType(chartType: ChartType): WidgetType;
 export declare function getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
 type WidgetTypeOrString = string | WidgetType;
 export declare function isSupportedWidgetType(widgetType: WidgetTypeOrString): widgetType is WidgetType;
@@ -69,14 +70,6 @@ export declare function registerDataPointsSelectedHandler(widgetProps: WidgetPro
 export declare function registerRenderToolbarHandler(widgetProps: WidgetProps, handler: RenderToolbarHandler): void;
 export declare function getEnabledPanelItems(panels: Panel[], panelName: string): PanelItem[];
 export declare function getRootPanelItem(item: PanelItem): PanelItem;
-/**
- * Gets the sort type based on the jaql sort direction.
- *
- * @param jaqlSort - The jaql sort direction.
- * @returns  The sort direction.
- * @internal
- */
-export declare function getSortType(jaqlSort: `${JaqlSortDirection}` | undefined): SortDirection;
 /**
  * Gets a unique identifier for a filter, combining its attribute expression and granularity if available.
  *

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

@@ -0,0 +1,26 @@
+import { type FunctionComponent } from 'react';
+import { WidgetByIdProps } from '../props.js';
+/**
+ * The WidgetById component, which is a thin wrapper on the {@link ChartWidget} component,
+ * is used to render a widget created in a Sisense Fusion instance.
+ *
+ * To learn more about using Sisense Fusion Widgets in Compose SDK,
+ * see [Sisense Fusion Widgets](/guides/sdk/guides/charts/guide-fusion-widgets.html).
+ *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
+ * ## Example
+ *
+ * Display two dashboard widgets from a Fusion instance.
+ *
+ * <iframe
+ *  src='https://csdk-playground.sisense.com/?example=fusion-assets%2Ffusion-widgets&mode=docs'
+ *  width=800
+ *  height=870
+ *  style='border:none;'
+ * />
+ *
+ * @group Fusion Assets
+ * @fusionEmbed
+ */
+export declare const WidgetById: FunctionComponent<WidgetByIdProps>;

package/dist/packages/sdk-ui/src/widgets/common/drilldown-utils.d.ts

@@ -0,0 +1,7 @@
+import { DataPoint, ChartType, ChartDataOptions } from '../../types';
+import { Attribute } from '@sisense/sdk-data';
+import { ScatterDataPoint } from '../..';
+export declare function getDrilldownInitialDimension(chartType: ChartType, dataOptions: ChartDataOptions): Attribute | undefined;
+export declare function isDrilldownApplicableToChart(chartType: ChartType, dataOptions: ChartDataOptions): boolean;
+export declare function applyDrilldownDimension(chartType: ChartType, dataOptions: ChartDataOptions, drilldownDimension: Attribute): ChartDataOptions;
+export declare function prepareDrilldownSelectionPoints(points: (DataPoint | ScatterDataPoint)[], nativeEvent: MouseEvent, dataOptions: ChartDataOptions): DataPoint[];

package/dist/packages/sdk-ui/src/widgets/common/{use-drilldown.d.ts → use-drilldown-core.d.ts}

@@ -1,23 +1,30 @@
 import { type TFunction } from '@sisense/sdk-common';
 import { Attribute, Column, MembersFilter } from '@sisense/sdk-data';
-import { StyledColumn, DrilldownSelection, DataPoint, ChartDataPoint, MenuItemSection } from '../../types.js';
+import { StyledColumn, DrilldownSelection, DataPoint, ChartDataPoint } from '../../types.js';
 import { Hierarchy } from '../../models';
-type UseDrilldownParams = {
-    drilldownPaths: (Attribute | Hierarchy)[];
+type UseDrilldownCoreParams = {
+    drilldownPaths?: (Attribute | Hierarchy)[];
     initialDimension: Column | StyledColumn;
     drilldownSelections?: DrilldownSelection[];
     onDrilldownSelectionsChange?: (selections: DrilldownSelection[]) => void;
 };
-export declare const useDrilldown: (params: UseDrilldownParams) => {
+export declare const useDrilldownCore: (params: UseDrilldownCoreParams) => {
+    drilldownSelections: DrilldownSelection[];
+    availableDrilldownPaths: (Attribute | Hierarchy)[];
     drilldownFilters: MembersFilter[];
     drilldownFiltersDisplayValues: string[][];
     drilldownDimension: Attribute;
     selectDrilldown: (points: DataPoint[], nextDimension: Attribute, hierarchy?: Hierarchy) => void;
     sliceDrilldownSelections: (i: number) => void;
     clearDrilldownSelections: () => void;
-    drilldownSelections: DrilldownSelection[];
-    availableDrilldownPaths: (Attribute | Hierarchy)[];
 };
+/**
+ * Updates the drilldown selections based on the current selections, the next data points,
+ * and the specified hierarchy level.
+ *
+ * @internal
+ */
+export declare const updateDrilldownSelections: (currentSelections: DrilldownSelection[], points: DataPoint[], nextDimension: Attribute, hierarchy?: Hierarchy) => DrilldownSelection[];
 /**
  * @internal
  */
@@ -26,7 +33,6 @@ export declare const processDrilldownSelections: (drilldownSelections: Drilldown
     drilldownFiltersDisplayValues: string[][];
     drilldownDimension: Attribute;
 };
+export declare function getDisplayMemberNameFromDataPoint(point: ChartDataPoint): string;
 export declare function getMemberNameFromDataPoint(point: ChartDataPoint): string;
-export declare function getSelectionTitleMenuItem(points: DataPoint[], drilldownDimension: Attribute): MenuItemSection;
-export declare function getDrilldownMenuItems(availableDrilldownPaths: (Attribute | Hierarchy)[], drilldownDimension: Attribute, selectFn: (nextDimension: Attribute, hierarchy?: Hierarchy) => void, translate: TFunction): MenuItemSection;
 export {};

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

@@ -3,6 +3,7 @@ import { CommonWidgetProps } from '../props';
 /**
  * Facade component that renders a widget within a dashboard based on the widget type.
  *
+ * @group Dashboards
  * @internal
  */
 export declare const CommonWidget: React.FC<CommonWidgetProps>;

package/dist/packages/sdk-ui/src/widgets/hooks/use-drilldown.d.ts

@@ -0,0 +1,27 @@
+import { Attribute, Column } from '@sisense/sdk-data';
+import { type TFunction } from '@sisense/sdk-common';
+import { StyledColumn, DrilldownSelection, DataPoint, MenuPosition, MenuItemSection } from '../../types.js';
+import { Hierarchy } from '../../models';
+import { OpenMenuFn } from '../../common/components/menu/types.js';
+type UseDrilldownParams = {
+    initialDimension: Column | StyledColumn;
+    drilldownPaths?: (Attribute | Hierarchy)[];
+    drilldownSelections?: DrilldownSelection[];
+    /**
+     * todo: make it optional when we will have a public `MenuProvider`.
+     * Without provided function, it should open internal menu with the help of `useMenu` hook
+     */
+    openMenu: OpenMenuFn;
+    onDrilldownSelectionsChange?: (selections: DrilldownSelection[]) => void;
+};
+export declare const useDrilldown: ({ initialDimension, drilldownPaths, drilldownSelections, openMenu, onDrilldownSelectionsChange, }: UseDrilldownParams) => {
+    drilldownDimension: Attribute;
+    drilldownFilters: import("@sisense/sdk-data").MembersFilter[];
+    breadcrumbs: import("react/jsx-runtime").JSX.Element;
+    openDrilldownMenu: (position: MenuPosition, points: DataPoint[]) => void;
+};
+/** @internal */
+export declare function getSelectionTitleMenuItem(points: DataPoint[], drilldownDimension: Attribute): MenuItemSection;
+/** @internal */
+export declare function getDrilldownMenuItems(availableDrilldownPaths: (Attribute | Hierarchy)[], drilldownDimension: Attribute, selectFn: (nextDimension: Attribute, hierarchy?: Hierarchy) => void, translate: TFunction): MenuItemSection;
+export {};

package/dist/packages/sdk-ui/src/widgets/hooks/use-with-drilldown.d.ts

@@ -0,0 +1,12 @@
+import { DrilldownSelection } from '../../types.js';
+import { ChartWidgetProps } from '../../props.js';
+type UseWithDrilldownParams = {
+    propsToExtend: ChartWidgetProps;
+    onDrilldownSelectionsChange?: (selections: DrilldownSelection[]) => void;
+};
+export declare const useWithDrilldown: ({ propsToExtend, onDrilldownSelectionsChange, }: UseWithDrilldownParams) => {
+    propsWithDrilldown: ChartWidgetProps;
+    isDrilldownEnabled: boolean | 0;
+    breadcrumbs: import("react/jsx-runtime").JSX.Element;
+};
+export {};

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

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { WidgetProps } from '..';
+/**
+ * Facade component that renders a widget within a dashboard based on the widget type.
+ *
+ * @group Dashboards
+ * @alpha
+ */
+export declare const Widget: React.FC<WidgetProps>;