@sisense/sdk-ui 1.18.1 → 1.20.0

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

@@ -0,0 +1,15 @@
+/**
+ * Returns a slice of the array starting from the first occurrence of the matched value.
+ *
+ * @template T - The type of elements in the array.
+ * @param {T[]} array - The array to search through.
+ * @param {T} matchValue - The value to match in the array.
+ * @returns {T[]} - A new array starting from the matched value. Returns an empty array if the matchValue is not found.
+ * @example
+ * ```
+ * const array = [1, 2, 3, 4, 5];
+ * const result = sliceFromMatched(array, 3);
+ * console.log(result); // Output: [3, 4, 5]
+ * ```
+ */
+export declare function sliceFromMatched<T>(array: T[], matchValue: T): T[];

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

@@ -1,5 +1,4 @@
-import { Attribute, CascadingFilter, Filter, MembersFilter } from '@sisense/sdk-data';
-export declare function isCascadingFilter(filter: Filter): filter is CascadingFilter;
+import { Attribute, Filter } from '@sisense/sdk-data';
 /**
  * Clones a filter with a toggled 'disabled' state.
  *
@@ -8,7 +7,6 @@ export declare function isCascadingFilter(filter: Filter): filter is CascadingFi
 export declare const cloneFilterAndToggleDisabled: <TFilter extends Filter>(filter: TFilter) => TFilter;
 export declare const cloneFilter: <TFilter extends Filter>(filter: TFilter) => TFilter;
 export declare function clearMembersFilter(filter: Filter): Filter;
-export declare function isMembersFilter(filter: Filter): filter is MembersFilter;
 export declare function isIncludeAllFilter(filter: Filter): boolean;
 export declare function haveSameAttribute(filterA: Filter, filterB: Filter): boolean;
 export declare function isSameAttribute(attributeA: Attribute, attributeB: Attribute): boolean;

package/dist/{utils → packages/sdk-ui/src/utils}/utility-types.d.ts

@@ -40,6 +40,10 @@ type PickTypeOf<T, K extends string | number | symbol> = K extends AllKeys<T> ?
  * Abstract object with any unknown values
  */
 export type AnyObject = Record<string, any>;
+/**
+ * Empty object with no properties
+ */
+export type EmptyObject = Record<string, never>;
 /**
  * Allows you to make a property of an object required.
  *

package/dist/{widgets → packages/sdk-ui/src/widgets}/chart-widget.d.ts

@@ -22,6 +22,6 @@ import { ChartWidgetProps } from '../props';
  * <img src="media://chart-widget-with-drilldown-example-1.png" width="800px" />
  * @param props - ChartWidget properties
  * @returns ChartWidget component representing a chart type as specified in `ChartWidgetProps.`{@link ChartWidgetProps.chartType | chartType}
- * @group Chart Utilities
+ * @group Dashboarding
  */
 export declare const ChartWidget: FunctionComponent<ChartWidgetProps>;

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

@@ -2,8 +2,8 @@ import { ChartType, ChartDataOptions } from '../../types';
 import { Attribute, type Filter } from '@sisense/sdk-data';
 import { ChartProps, CustomDrilldownResult } from '../..';
 export declare function getDrilldownInitialDimension(chartType: ChartType, dataOptions: ChartDataOptions): Attribute;
-export declare function isSupportedChartForDrilldown(chartType: ChartType): boolean;
-export declare function isValidChartConfigurationForDrilldown(chartType: ChartType, dataOptions: ChartDataOptions): boolean;
+export declare function isDrilldownApplicableToChart(chartType: ChartType, dataOptions: ChartDataOptions): boolean;
+export declare function applyDrilldownDimension(chartType: ChartType, dataOptions: ChartDataOptions, drilldownDimension: Attribute): ChartDataOptions;
 export declare function createDrilldownToChartConnector(drilldownConnectProps: CustomDrilldownResult): (chartProps: ChartProps) => {
     dataOptions: ChartDataOptions;
     filters: Filter[];

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

@@ -1,27 +1,32 @@
-import { StyledColumn, DrilldownSelection, DataPoint, ChartDataPoint } from '../../types.js';
+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 { Hierarchy } from '../../models';
 type UseDrilldownParams = {
-    drilldownDimensions: Attribute[];
+    drilldownPaths: (Attribute | Hierarchy)[];
     initialDimension: Column | StyledColumn;
     drilldownSelections?: DrilldownSelection[];
+    onDrilldownSelectionsChange?: (selections: DrilldownSelection[]) => void;
 };
 export declare const useDrilldown: (params: UseDrilldownParams) => {
     drilldownFilters: MembersFilter[];
     drilldownFiltersDisplayValues: string[][];
     drilldownDimension: Attribute;
-    selectDrilldown: (points: DataPoint[], nextDimension: Attribute) => void;
+    selectDrilldown: (points: DataPoint[], nextDimension: Attribute, hierarchy?: Hierarchy) => void;
     sliceDrilldownSelections: (i: number) => void;
     clearDrilldownSelections: () => void;
     drilldownSelections: DrilldownSelection[];
-    availableDrilldowns: Attribute[];
+    availableDrilldownPaths: (Attribute | Hierarchy)[];
 };
 /**
  * @internal
  */
-export declare const processDrilldownSelections: (drilldownSelections: DrilldownSelection[], initialDimension: Column | StyledColumn | null) => {
+export declare const processDrilldownSelections: (drilldownSelections: DrilldownSelection[], initialDimension: Column | StyledColumn, translate: TFunction) => {
     drilldownFilters: MembersFilter[];
     drilldownFiltersDisplayValues: string[][];
     drilldownDimension: Attribute;
 };
 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

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { CommonWidgetProps } from '../props';
+/**
+ * Facade component that renders a widget within a dashboard based on the widget type.
+ *
+ * @internal
+ */
+export declare const CommonWidget: React.FC<CommonWidgetProps>;

package/dist/{widgets → packages/sdk-ui/src/widgets/hooks}/use-highlight-selection.d.ts

@@ -1,4 +1,4 @@
-import { ChartDataOptions, ChartDataPoint, ChartDataPoints, ChartType, HighchartsOptions } from '..';
+import { ChartDataOptions, ChartDataPoint, ChartDataPoints, ChartType, HighchartsOptions } from '../..';
 export declare function useHighlightSelection({ chartType, dataOptions, enabled, }: {
     chartType: ChartType;
     dataOptions: ChartDataOptions;

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

@@ -0,0 +1,15 @@
+import { Attribute, DataSource } from '@sisense/sdk-data';
+import { Hierarchy, HierarchyId } from '../../models/hierarchy';
+/**
+ * Synchronizes drilldown paths with hierarchy data from a Fusion instance.
+ * It loads all hierarchies provided as hierarchy IDs, and also includes any hierarchies
+ * that are marked as `alwaysIncluded` in a Fusion instance.
+ *
+ * @internal
+ */
+export declare function useSyncedDrilldownPaths({ attribute, dataSource, drilldownPaths, enabled, }: {
+    attribute: Attribute;
+    dataSource?: DataSource;
+    drilldownPaths?: (Attribute | Hierarchy | HierarchyId)[];
+    enabled: boolean;
+}): (Attribute | Hierarchy)[];

package/dist/{widgets → packages/sdk-ui/src/widgets}/pivot-table-widget.d.ts

@@ -1,7 +1,7 @@
 import { type FunctionComponent } from 'react';
 import { PivotTableWidgetProps } from '../props';
 /**
- * The PivotTableWidget component extending the PivotTable component to support widget style options.
+ * React component extending `PivotTable` to support widget style options.
  *
  * @example
  * Example of using the `PivotTableWidget` component to
@@ -17,6 +17,7 @@ import { PivotTableWidgetProps } from '../props';
  * ```
  * @param props - Pivot Table Widget properties
  * @returns Widget component representing a pivot table
- * @internal
+ * @group Dashboarding
+ * @beta
  */
 export declare const PivotTableWidget: FunctionComponent<PivotTableWidgetProps>;

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

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { PluginWidgetProps } from '../props';
+/**
+ * Component that renders a plugin widget.
+ *
+ * @internal
+ */
+export declare const PluginWidget: React.FC<PluginWidgetProps>;

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

@@ -0,0 +1,9 @@
+import { FunctionComponent } from 'react';
+import { TextWidgetProps } from '../props';
+export declare function isTextWidgetProps(props: any): props is TextWidgetProps;
+/**
+ * A widget that displays HTML content.
+ *
+ * @internal
+ */
+export declare const TextWidget: FunctionComponent<TextWidgetProps>;