@sisense/sdk-ui 1.8.0 → 1.9.0

package/dist/api/types/dashboard-dto.d.ts

@@ -1,6 +1,21 @@
 import { WidgetDto, Datasource } from '../../dashboard-widget/types';
 import { FilterJaql, FilterRelationsModel } from '@sisense/sdk-data';
 import { AnyObject } from '../../utils/utility-types';
+/** @internal */
+export type Layout = {
+    columns: {
+        width: number;
+        cells: {
+            subcells: {
+                width: number;
+                elements: {
+                    height: number | string;
+                    widgetid: string;
+                }[];
+            }[];
+        }[];
+    }[];
+};
 export type Filter = {
     isCascading?: false;
     jaql: FilterJaql & AnyObject;
@@ -22,4 +37,5 @@ export type DashboardDto = {
     filterRelations?: {
         filterRelations: FilterRelationsModel;
     }[];
+    layout?: Layout;
 } & AnyObject;

package/dist/app/client-application.d.ts

@@ -47,9 +47,13 @@ export type AppConfig = {
      */
     queryLimit?: number;
     /**
-     * Accessibility configuration
+     * Accessibility configuration. Set the `accessibilityConfig.enabled` property to `true` to enable accessibility features for charts built with Highcharts.
      *
-     * This feature is in alpha
+     * Once the accessibility configuration in enabled, you can use the default descriptions or choose to create custom configurations for the descriptions of a chart, its axes, its series, and values description formatting. To create custom configurations, use the `highchartsOptions` object that is passed to the {@link BeforeRenderHandler} of the chart's `onBeforeRender` callback. Modify the object using the accessibility options as described in the [Accessibility module documentation](https://www.highcharts.com/docs/accessibility/accessibility-module).
+     *
+     * Note that enabling accessibility also causes markers to appear in charts even if they are disabled using the chart's `styleOptions`.
+     *
+     * This feature is in alpha.
      */
     accessibilityConfig?: {
         /**

package/dist/area-chart.d.ts

@@ -9,7 +9,7 @@ import { AreaChartProps } from './props';
  * Area chart displaying total revenue per quarter from the Sample ECommerce data model.
  *
  * <iframe
- *  src='https://dhoavm6pu1cvg.cloudfront.net/?example=charts%2Farea-chart&mode=docs'
+ *  src='https://csdk-playground.sisense.com/?example=charts%2Farea-chart&mode=docs'
  *  width=800
  *  height=870
  *  style='border:none;'
@@ -17,8 +17,8 @@ import { AreaChartProps } from './props';
  *
  * Additional Area Chart examples:
  *
- * - [Stacked Area Chart](https://csdk-playground.sisense.com/?example=charts%2Farea-chart-stacked)
- * - [Stacked Percentage Area Chart](https://csdk-playground.sisense.com/?example=charts%2Farea-chart-stacked100)
+ * - [Stacked Area Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Farea-chart-stacked)
+ * - [Stacked Percentage Area Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Farea-chart-stacked100)
  *
  * @param props - Area chart properties
  * @returns Area Chart component

package/dist/bar-chart.d.ts

@@ -17,8 +17,8 @@ import { BarChartProps } from './props';
  *
  * Additional Bar Chart examples:
  *
- * - [Stacked Bar Chart](https://csdk-playground.sisense.com/?example=charts%2Fbar-chart-stacked)
- * - [Stacked Percentage Bar Chart](https://csdk-playground.sisense.com/?example=charts%2Fbar-chart-stacked100)
+ * - [Stacked Bar Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fbar-chart-stacked)
+ * - [Stacked Percentage Bar Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fbar-chart-stacked100)
  *
  * @param props - Bar chart properties
  * @returns Bar Chart component

package/dist/chart-data-options/utils.d.ts

@@ -1,5 +1,14 @@
 import { Attribute, CalculatedMeasureColumn, Column, Measure, MeasureColumn } from '@sisense/sdk-data';
 import { Category, Value, StyledColumn, StyledMeasureColumn, AnyColumn, CategoryStyle } from './types';
+type AnyObject = Record<string, any>;
+/**
+ * Combines two objects into a single one with saving prototype inheritance of "sourceWithInheritance" argument
+ *
+ * @param sourceWithInheritance - The object that has own and inherited properties.
+ * @param sourceToAbsorb - The object whose properties will be copied as own properties.
+ * @returns - A new object that combines the properties of the two input objects.
+ */
+export declare const safeCombine: <T extends AnyObject>(sourceWithInheritance: T, sourceToAbsorb: AnyObject) => T;
 export declare const splitColumn: (c: StyledColumn | Column) => {
     column: Column;
     style: CategoryStyle | undefined;
@@ -14,3 +23,4 @@ export declare const translateCategoryToAttribute: (category: Category) => Attri
 export declare const getDataOptionTitle: (option: Category | Value) => string;
 export declare const translateColumnToAttribure: (c: StyledColumn | Column) => Attribute;
 export declare const translateColumnToMeasure: (c: MeasureColumn | CalculatedMeasureColumn | StyledMeasureColumn) => Measure;
+export {};

package/dist/chart-options-processor/theme-option-service.d.ts

@@ -1,11 +1,3 @@
 import { CompleteThemeSettings } from '../types';
 import { HighchartsOptionsInternal } from './chart-options-service';
 export declare const applyThemeToChart: (chartOptions: HighchartsOptionsInternal, themeSettings?: CompleteThemeSettings) => HighchartsOptionsInternal;
-/**
- * Returns default theme settings, which can be used as base for custom theme options.
- *
- * @param isDarkMode - Boolean value whether to get theme settings for dark mode
- * @returns Theme settings object
- * @internal
- */
-export declare const getDefaultThemeSettings: (isDarkMode?: boolean) => CompleteThemeSettings;

package/dist/column-chart.d.ts

@@ -20,8 +20,8 @@ import { ColumnChartProps } from './props';
  *
  * Additional Column Chart examples:
  *
- * - [Stacked Column Chart](https://csdk-playground.sisense.com/?example=charts%2Fcolumn-chart-stacked)
- * - [Stacked Percentage Column Chart](https://csdk-playground.sisense.com/?example=charts%2Fcolumn-chart-stacked100)
+ * - [Stacked Column Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fcolumn-chart-stacked)
+ * - [Stacked Percentage Column Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fcolumn-chart-stacked100)
  *
  * @param props - Column chart properties
  * @returns Column Chart component

package/dist/common/components/loading-indicator.d.ts

@@ -30,6 +30,88 @@ export declare const LoadingIndicator: ({ themeSettings, onCancel, }: {
             primaryButtonTextColor: string;
             primaryButtonHoverColor: string;
         };
+        aiChat: {
+            backgroundColor: string;
+            primaryTextColor: string;
+            secondaryTextColor: string;
+            primaryFontSize: [fontSize: string, lineHeight: string];
+            border: string | false;
+            borderRadius: string | false;
+            body: {
+                paddingLeft: string;
+                paddingRight: string;
+                paddingTop: string;
+                paddingBottom: string;
+                gapBetweenMessages: string;
+            };
+            footer: {
+                paddingLeft: string;
+                paddingRight: string;
+                paddingTop: string;
+                paddingBottom: string;
+            };
+            userMessages: {
+                backgroundColor: string;
+            };
+            systemMessages: {
+                backgroundColor: string;
+            };
+            input: {
+                backgroundColor: string;
+                focus: {
+                    outlineColor: string;
+                };
+            };
+            header: {
+                backgroundColor: string;
+                textColor: string;
+            };
+            dropup: {
+                backgroundColor: string;
+                boxShadow: string;
+                borderRadius: string;
+                headers: {
+                    textColor: string;
+                    hover: {
+                        backgroundColor: string;
+                    };
+                };
+                items: {
+                    textColor: string;
+                    hover: {
+                        backgroundColor: string;
+                    };
+                };
+            };
+            suggestions: {
+                textColor: string;
+                backgroundColor: string;
+                border: string;
+                borderGradient: [string, string] | null;
+                borderRadius: string;
+                hover: {
+                    backgroundColor: string;
+                    textColor: string;
+                };
+                loadingGradient: [string, string];
+                gap: string;
+            };
+            clickableMessages: {
+                backgroundColor: string;
+                textColor: string;
+                border: string | false;
+                hover: {
+                    textColor: string;
+                    backgroundColor: string;
+                };
+            };
+            icons: {
+                color: string;
+                hover: {
+                    color: string;
+                };
+            };
+        };
     } | undefined;
     onCancel?: (() => void) | undefined;
 }) => JSX.Element;

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

@@ -1,5 +1,6 @@
-import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions } from '../types';
-import { Panel, WidgetStyle, WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle } from './types';
+import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions } from '../types';
+import { Panel, WidgetStyle, WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle } 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;

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

@@ -10,7 +10,7 @@ export type CategoricalWidgetType = 'chart/pie' | 'chart/funnel' | 'treemap' | '
 /**
  * The type of a widget on a dashboard that is a variant of tabular widget.
  */
-export type TabularWidgetType = 'tablewidget' | 'tablewidgetagg' | 'pivot2';
+export type TabularWidgetType = 'tablewidget' | 'tablewidgetagg' | 'pivot' | 'pivot2';
 /**
  * The type of a widget on a dashboard.
  */
@@ -102,6 +102,8 @@ export type PanelItem = {
         color?: PanelColorFormat;
         mask?: DatetimeMask | NumericMask;
         members?: PanelMembersFormat;
+        subtotal?: boolean;
+        databars?: boolean;
     };
     jaql: Jaql;
     disabled?: boolean;
@@ -112,6 +114,10 @@ export type PanelItem = {
     categoriesSorting?: JaqlSortDirection;
     isColored?: boolean;
     geoLevel?: 'country' | 'state' | 'city';
+    field?: {
+        id: string;
+        index: number;
+    };
 };
 export type PanelColorFormat = PanelColorFormatSingle | PanelColorFormatRange | PanelColorFormatConditional;
 export type PanelMembersFormat = Record<string, {
@@ -326,11 +332,25 @@ 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;
+export type WidgetStyle = CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle | BoxplotWidgetStyle | ScattermapWidgetStyle | AreamapWidgetStyle | PivotWidgetStyle;
 export declare enum FiltersMergeStrategyEnum {
     WIDGET_FIRST = "widgetFirst",
     CODE_FIRST = "codeFirst",
     CODE_ONLY = "codeOnly"
 }
 export type FiltersMergeStrategy = `${FiltersMergeStrategyEnum}`;
+export type PivotWidgetStyle = {
+    rowsGrandTotal?: boolean;
+    columnsGrandTotal?: boolean;
+    colors?: {
+        rows?: boolean;
+        columns?: boolean;
+        headers?: boolean;
+        members?: boolean;
+        totals?: boolean;
+    };
+    pageSize?: number | string;
+    rowHeight?: number;
+    automaticHeight?: boolean;
+};
 export {};

package/dist/dashboard-widget/use-fetch-widget-dto-model.d.ts

@@ -28,6 +28,7 @@ export declare const fetchWidgetDtoModel: ({ widgetOid, dashboardOid, includeDas
         filterRelations?: {
             filterRelations: import("@sisense/sdk-data").FilterRelationsModel;
         }[] | undefined;
+        layout?: import("../api/types/dashboard-dto").Layout | undefined;
     } & import("../utils/utility-types").AnyObject) | undefined;
 }>;
 /**

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

@@ -6,6 +6,8 @@ export declare function getChartType(widgetType: WidgetType): ChartType;
 export declare function getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
 type WidgetTypeOrString = string | WidgetType;
 export declare function isSupportedWidgetType(widgetType: WidgetTypeOrString): widgetType is WidgetType;
+export declare function isTableWidget(widgetType: WidgetTypeOrString): boolean;
+export declare function isPivotWidget(widgetType: WidgetTypeOrString): boolean;
 export declare function isTabularWidget(widgetType: WidgetTypeOrString): boolean;
 export declare function getEnabledPanelItems(panels: Panel[], panelName: string): PanelItem[];
 export declare function getRootPanelItem(item: PanelItem): PanelItem;