@sisense/sdk-ui 1.15.1 → 1.17.0

package/dist/dashboard/dashboard.d.ts

@@ -1,8 +1,12 @@
+/// <reference types="react" />
 import { DashboardProps } from '../dashboard/types';
 /**
- * React component that renders a dashboard
- * Include inside logic of applying common filters to widgets
+ * React component that renders a dashboard whose elements are customizable. It includes internal logic of applying common filters to widgets.
  *
- * @internal
+ * **Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
+ * @group Fusion Embed
+ * @fusionEmbed
+ * @alpha
  */
-export declare const Dashboard: ({ title, layout, widgets, filters, defaultDataSource, widgetFilterOptions, }: DashboardProps) => import("react/jsx-runtime").JSX.Element;
+export declare const Dashboard: import("react").FunctionComponent<DashboardProps>;

package/dist/dashboard/index.d.ts

@@ -1,3 +1,3 @@
 export { DashboardById } from './dashboard-by-id';
 export { Dashboard } from './dashboard';
-export { type DashboardByIdProps, type DashboardProps } from './types';
+export type { DashboardByIdProps, DashboardProps, DashboardStyleOptions } from './types';

package/dist/dashboard/types.d.ts

@@ -1,17 +1,17 @@
-import { Layout, WidgetFilterOptions, WidgetModel } from '../models';
+import { DashboardStyleOptions, Layout, WidgetFilterOptions, WidgetModel } from '../models';
 import { DataSource, Filter } from '@sisense/sdk-data';
+export type { DashboardStyleOptions, Layout } from '../models';
 /**
  * Props for the DashboardById component
- *
- * @internal
  */
 export interface DashboardByIdProps {
+    /**
+     * The OID of the dashboard to render.
+     */
     dashboardOid: string;
 }
 /**
  * Props for the DashboardLayout component
- *
- * @internal
  */
 export interface DashboardLayoutProps {
     title: string;
@@ -23,16 +23,22 @@ export interface DashboardLayoutProps {
 }
 /**
  * Props for the Dashboard component
- *
- * @internal
  */
 export interface DashboardProps {
+    /** The title of the dashboard */
     title: string;
+    /** The layout of the dashboard */
     layout: Layout;
+    /** The widgets to render in the dashboard */
     widgets: WidgetModel[];
+    /** The dashboard filters to be applied to each of the widgets based on the widget filter options */
     filters: Filter[];
+    /** The default data source to use for the dashboard */
     defaultDataSource?: DataSource;
+    /** The filter options for each of the widgets */
     widgetFilterOptions?: WidgetFilterOptions;
+    /** The style options for the dashboard */
+    styleOptions: DashboardStyleOptions;
 }
 /**
  * Props for the Dashboard Header component

package/dist/dashboard-widget/dashboard-widget.d.ts

@@ -7,6 +7,8 @@ import { DashboardWidgetProps } from '../props';
  * 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 Embed instance.

package/dist/dashboard-widget/translate-widget-data-options.d.ts

@@ -2,7 +2,7 @@ import { DimensionalBaseMeasure, DimensionalAttribute, DimensionalCalculatedMeas
 import { StyledMeasureColumn, StyledColumn, Color } from '../types';
 import { Panel, PanelItem, WidgetType, WidgetStyle, BoxplotWidgetStyle } from './types';
 import { WidgetDataOptions } from '../models';
-export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): import("@sisense/sdk-data").Filter | DimensionalCalculatedMeasure | DimensionalAttribute | DimensionalBaseMeasure;
+export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): import("@sisense/sdk-data").Filter | DimensionalAttribute | DimensionalCalculatedMeasure | DimensionalBaseMeasure;
 export declare function createDataColumn(item: PanelItem, customPaletteColors?: Color[]): StyledMeasureColumn | StyledColumn;
 /** @internal */
 export declare const createDataOptionsFromPanels: (panels: Panel[], variantColors: Color[]) => {

package/dist/dashboard-widget/translate-widget-drilldown-options.d.ts

@@ -1,3 +1,3 @@
-import { Panel, WidgetType } from './types';
+import { Panel, PanelItem, WidgetType } from './types';
 import { DrilldownOptions } from '../types';
-export declare const extractDrilldownOptions: (widgetType: WidgetType, panels: Panel[]) => DrilldownOptions;
+export declare const extractDrilldownOptions: (widgetType: WidgetType, panels: Panel[], drillHistory?: PanelItem[], enableDrillToAnywhere?: boolean) => DrilldownOptions;

package/dist/dashboard-widget/translate-widget-style-options.d.ts

@@ -1,6 +1,15 @@
-import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions } from '../types';
-import { Panel, WidgetStyle, WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle } from './types';
+import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions, WidgetStyleOptions } from '../types';
+import { Panel, WidgetStyle, WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle, WidgetDesign } from './types';
 export declare function extractTableChartStyleOptions(widgetStyle: TableWidgetStyle): TableStyleOptions;
 export declare const getIndicatorTypeSpecificOptions: (widgetSubtype: WidgetSubtype, widgetStyle: IndicatorWidgetStyle) => NumericSimpleIndicatorStyleOptions | NumericBarIndicatorStyleOptions | GaugeIndicatorStyleOptions;
 export declare function extractPivotTableStyleOptions(widgetStyle: PivotWidgetStyle): PivotTableStyleOptions;
 export declare function extractStyleOptions<WType extends WidgetType>(widgetType: WType, widgetSubtype: WidgetSubtype, style: WidgetStyle, panels: Panel[]): ChartStyleOptions | TableStyleOptions;
+/**
+ * Merges the widget style with the widget design
+ *
+ * @param widgetStyle - The widget style
+ * @param widgetDesign - The widget design
+ * @param isWidgetDesignStyleEnabled - The flag to enable the widget design style
+ * @returns The merged widget style
+ */
+export declare function getStyleWithWigetDesign(widgetStyle: ChartStyleOptions | TableStyleOptions, widgetDesign?: WidgetDesign, isWidgetDesignStyleEnabled?: boolean): WidgetStyleOptions;

package/dist/dashboard-widget/types.d.ts

@@ -1,3 +1,5 @@
+import { WidgetContainerStyleOptions } from '../types';
+import { LEGACY_DESIGN_TYPES } from './../themes/legacy-design-settings';
 import { Jaql, JaqlSortDirection } from '@sisense/sdk-data';
 /**
  * The type of a widget on a dashboard that is a variant of Cartesian widget.
@@ -42,6 +44,7 @@ export interface WidgetDto {
     metadata: {
         ignore?: FiltersIgnoringRules;
         panels: Panel[];
+        drillHistory?: PanelItem[];
     };
     style: WidgetStyle;
     title: string;
@@ -49,8 +52,22 @@ export interface WidgetDto {
     options?: {
         dashboardFiltersMode: `${WidgetDashboardFilterMode}`;
         selector: boolean;
+        drillToAnywhere?: boolean;
     };
 }
+export type WidgetDesign = {
+    widgetBackgroundColor: string;
+    widgetSpacing: keyof typeof LEGACY_DESIGN_TYPES;
+    widgetCornerRadius: keyof typeof LEGACY_DESIGN_TYPES;
+    widgetShadow: keyof typeof LEGACY_DESIGN_TYPES;
+    widgetBorderEnabled: boolean;
+    widgetBorderColor: string;
+    widgetTitleColor: string;
+    widgetTitleAlignment: keyof typeof LEGACY_DESIGN_TYPES;
+    widgetTitleDividerEnabled: boolean;
+    widgetTitleDividerColor: string;
+    widgetTitleBackgroundColor: string;
+};
 export type FiltersIgnoringRules = {
     dimensions?: string[];
     ids: string[];
@@ -105,6 +122,8 @@ export type PanelItem = {
         members?: PanelMembersFormat;
         subtotal?: boolean;
         databars?: boolean;
+        width?: number;
+        colorIndex?: number;
     };
     jaql: Jaql;
     disabled?: boolean;
@@ -185,7 +204,7 @@ type BaseWidgetStyle = {
         enabled: boolean;
     };
 };
-export type CartesianWidgetStyle = BaseWidgetStyle & {
+export type CartesianWidgetStyle = BaseWidgetStyle & WidgetContainerStyleOptions & {
     seriesLabels: LabelsStyle;
     xAxis: AxisStyle & {
         x2Title?: AxisTitleStyle;
@@ -201,7 +220,7 @@ export type CartesianWidgetStyle = BaseWidgetStyle & {
         fill: string;
     };
 };
-export type PolarWidgetStyle = BaseWidgetStyle & {
+export type PolarWidgetStyle = BaseWidgetStyle & WidgetContainerStyleOptions & {
     categories?: AxisStyle;
     axis?: AxisStyle;
 };
@@ -210,12 +229,12 @@ type ScatterMarkerSize = {
     min: number;
     max: number;
 };
-export type ScatterWidgetStyle = BaseWidgetStyle & {
+export type ScatterWidgetStyle = BaseWidgetStyle & WidgetContainerStyleOptions & {
     xAxis: AxisStyle;
     yAxis: AxisStyle;
     markerSize?: ScatterMarkerSize;
 };
-export type FunnelWidgetStyle = BaseWidgetStyle & {
+export type FunnelWidgetStyle = BaseWidgetStyle & WidgetContainerStyleOptions & {
     size: string;
     type: string;
     direction: string;
@@ -233,7 +252,7 @@ export type TableWidgetStyle = {
     'colors/headers': boolean;
     'colors/rows': boolean;
 };
-export type IndicatorWidgetStyle = {
+export type IndicatorWidgetStyle = WidgetContainerStyleOptions & {
     'indicator/gauge': {
         subtype: string;
         skin: string;
@@ -309,7 +328,7 @@ export type SunburstWidgetStyle = {
     'tooltip/contribution': boolean;
     'tooltip/value': boolean;
 };
-export type BoxplotWidgetStyle = {
+export type BoxplotWidgetStyle = WidgetContainerStyleOptions & {
     xAxis: AxisStyle;
     yAxis: AxisStyle;
     whisker: {
@@ -321,7 +340,7 @@ export type BoxplotWidgetStyle = {
         enabled: boolean;
     };
 };
-export type ScattermapWidgetStyle = {
+export type ScattermapWidgetStyle = WidgetContainerStyleOptions & {
     markers: {
         fill: 'filled' | 'filled-light' | 'hollow' | 'hollow-bold';
         size: {
@@ -333,7 +352,9 @@ export type ScattermapWidgetStyle = {
 };
 /** Currently, WidgetStyle for areamap is an empty object */
 export type AreamapWidgetStyle = {};
-export type WidgetStyle = CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle | BoxplotWidgetStyle | ScattermapWidgetStyle | AreamapWidgetStyle | PivotWidgetStyle;
+export type WidgetStyle = {
+    widgetDesign?: WidgetDesign;
+} & (CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle | BoxplotWidgetStyle | ScattermapWidgetStyle | AreamapWidgetStyle | PivotWidgetStyle);
 export declare enum FiltersMergeStrategyEnum {
     WIDGET_FIRST = "widgetFirst",
     CODE_FIRST = "codeFirst",

package/dist/dashboard-widget/utils.d.ts

@@ -19,6 +19,14 @@ export declare function getRootPanelItem(item: PanelItem): PanelItem;
  * @internal
  */
 export declare function getSortType(jaqlSort: `${JaqlSortDirection}` | undefined): SortDirection;
+/**
+ * Gets a unique identifier for a filter, combining its attribute expression and granularity if available.
+ *
+ * @param {Filter} filter - The filter object to generate the unique identifier for.
+ * @returns {string} - The unique identifier for the filter.
+ * @internal
+ */
+export declare function getFilterCompareId(filter: Filter): string;
 /**
  * Merges two arrays of filter objects, prioritizing 'targetFilters' over 'sourceFilters',
  * and removes duplicates based on filter compare id.

package/dist/decorators/component-decorators/with-tracking/error-tracker.d.ts

@@ -1,8 +1,10 @@
+import { ErrorEventOptions } from '@sisense/sdk-tracking';
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { Component, ReactNode } from 'react';
 import { SisenseContextPayload } from '../../../sisense-context/sisense-context';
 type ErrorTrackerProps = {
     children: ReactNode;
+    handler: (options: ErrorEventOptions) => Promise<void>;
     componentName: string;
 };
 export declare class ErrorTracker extends Component<ErrorTrackerProps, {
@@ -10,6 +12,7 @@ export declare class ErrorTracker extends Component<ErrorTrackerProps, {
 }> {
     componentName: string;
     context: SisenseContextPayload;
+    handler: (options: ErrorEventOptions) => Promise<void>;
     httpClient?: HttpClient;
     postponedErrors: Error[];
     constructor(props: ErrorTrackerProps);

package/dist/filters/components/date-filter/date-filter/date-filter.d.ts

@@ -32,6 +32,7 @@ export type DateRangeFilterProps = {
      * To be compatible with the old DateRangeFilterTile.
      *
      * TODO: Remove this prop when the old DateRangeFilterTile is deprecated.
+     *
      * @internal
      * @default 'grey'
      */

package/dist/filters/components/filters-panel/filters-panel.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import { DataSource, Filter } from '@sisense/sdk-data';
 /**
  * Props of the {@link FiltersPanel} component
@@ -17,4 +18,4 @@ export type FiltersPanelProps = {
  *
  * @internal
  */
-export declare const FiltersPanel: ({ filters, onFiltersChange, defaultDataSource, }: FiltersPanelProps) => import("react/jsx-runtime").JSX.Element;
+export declare const FiltersPanel: import("react").FunctionComponent<FiltersPanelProps>;