@sisense/sdk-ui 1.5.0 → 1.7.0

package/dist/alert-box/alert-box.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 interface Props {
-    alerts: string[];
+    alerts?: string[];
 }
 export declare const AlertBox: ({ alerts }: Props) => JSX.Element;
 export default AlertBox;

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

@@ -28,6 +28,24 @@ export type AppConfig = {
      * Loading Indicator Configurations
      */
     loadingIndicatorConfig?: LoadingIndicatorConfig;
+    /**
+     * Query Cache Configurations
+     *
+     * This feature is in alpha.
+     */
+    queryCacheConfig?: {
+        /**
+         * Whether to enable query caching
+         *
+         * If not specified, the default value is `false`
+         */
+        enabled?: boolean;
+    };
+    /**
+     * Query limit (max rows count that will be fetched in query)
+     * @default 20000
+     */
+    queryLimit?: number;
 };
 /**
  * Stands for a Sisense Client Application which connects to a Sisense Environment
@@ -55,6 +73,15 @@ export declare class ClientApplication {
      * Gets the application settings
      */
     settings: AppSettings;
+    /**
+     * Gets the module to control query cache
+     */
+    queryCache: {
+        /**
+         * Clears the query cache
+         */
+        clear: () => void;
+    };
     /**
      * Construct new Sisense Client Application
      *

package/dist/app/settings/settings.d.ts

@@ -21,5 +21,5 @@ type ServerSettings = {
  * @param isWat - Whether the application is running with WAT authentication
  * @returns - Application settings
  */
-export declare function getSettings(customConfig: ConfigurableAppSettings, httpClient: Pick<HttpClient, 'get'>, useDefaultPalette: boolean): Promise<AppSettings>;
+export declare function getSettings(customConfig: ConfigurableAppSettings, httpClient: Pick<HttpClient, 'get'>, useDefaultPalette?: boolean): Promise<AppSettings>;
 export {};

package/dist/area-chart.d.ts

@@ -26,5 +26,6 @@ import { AreaChartProps } from './props';
  * <img src="media://area-chart-example-1.png" width="800"/>
  * @param props - Area chart properties
  * @returns Area Chart component
+ * @group Charts
  */
 export declare const AreaChart: import("react").FunctionComponent<AreaChartProps>;

package/dist/areamap-chart.d.ts

@@ -20,6 +20,7 @@ import { AreamapChartProps } from './props';
  * ```
  * @param props - Areamap chart properties
  * @returns Areamap Chart component
+ * @group Charts
  * @beta
  */
 export declare const AreamapChart: import("react").FunctionComponent<AreamapChartProps>;

package/dist/bar-chart.d.ts

@@ -3,6 +3,8 @@ import { BarChartProps } from './props';
 /**
  * A React component representing categorical data with horizontal rectangular bars,
  * whose lengths are proportional to the values that they represent.
+ * You can also break up the values by another category or groups.
+ *
  * See [Bar Chart](https://docs.sisense.com/main/SisenseLinux/bar-chart.htm) for more information.
  *
  * @example
@@ -25,5 +27,6 @@ import { BarChartProps } from './props';
  * <img src="media://bar-chart-example-1.png" width="800"/>
  * @param props - Bar chart properties
  * @returns Bar Chart component
+ * @group Charts
  */
 export declare const BarChart: import("react").FunctionComponent<BarChartProps>;

package/dist/boxplot-chart.d.ts

@@ -31,6 +31,7 @@ import { BoxplotChartProps } from './props';
  * <img src="media://boxplot-chart-example-1.png" width="600px" />
  * @param props - Boxplot chart properties
  * @returns Boxplot Chart component
+ * @group Charts
  * @beta
  */
 export declare const BoxplotChart: import("react").FunctionComponent<BoxplotChartProps>;

package/dist/boxplot-utils.d.ts

@@ -1,5 +1,6 @@
 import { Attribute, Measure, Filter, QueryResultData, DataSource } from '@sisense/sdk-data';
 import { ClientApplication } from './app/client-application.js';
+import { executeQuery as executeQueryFunction } from './query/execute-query.js';
 import { BoxplotChartCustomDataOptions, BoxplotChartDataOptionsInternal } from './chart-data-options/types.js';
 /**
  * Processes box whisker data and outliers data to combine them into a single data set.
@@ -17,6 +18,7 @@ export declare const boxWhiskerProcessResultInternal: (boxWhiskerData: QueryResu
  * @param {QueryResultData} outliersData - The data for the outliers.
  * @param {BoxplotChartCustomDataOptions} [dataOptions] - Optional data options for customizing data processing.
  * @returns {QueryResultData} The combined data with outliers included in the box whisker plot.
+ * @group Chart Utilities
  */
 export declare function boxWhiskerProcessResult(boxWhiskerData: QueryResultData, outliersData: QueryResultData, dataOptions?: BoxplotChartCustomDataOptions): QueryResultData;
 export declare const executeBoxplotQuery: ({ app, chartDataOptions, dataSource, attributes, measures, filters, highlights, }: {
@@ -27,4 +29,4 @@ export declare const executeBoxplotQuery: ({ app, chartDataOptions, dataSource,
     measures: Measure[];
     filters?: Filter[] | undefined;
     highlights?: Filter[] | undefined;
-}) => Promise<QueryResultData>;
+}, executeQuery: typeof executeQueryFunction) => Promise<QueryResultData>;

package/dist/chart/chart.d.ts

@@ -76,5 +76,6 @@ export declare const shouldSkipSisenseContextWaiting: (props: ChartProps) => boo
  * <img src="media://chart-local-data-example-1.png" width="800px" />
  * @param props - Chart properties
  * @returns Chart component representing a chart type as specified in `ChartProps.`{@link ChartProps.chartType | chartType}
+ * @group Charts
  */
 export declare const Chart: import("react").FunctionComponent<ChartProps>;

package/dist/chart-options-processor/translations/base-design-options.d.ts

@@ -1,6 +1,7 @@
 import { DesignOptions } from './types';
 import { Merge } from '../../utils/utility-types';
 export declare const SERIES_CAPACITY = 50;
+export declare const PIE_SERIES_CAPACITY = 1000;
 export declare const SCATTER_CATEGORIES_CAPACITY = 500;
 export declare const CATEGORIES_CAPACITY = 100000;
 export declare const BaseDesignOptions: Merge<DesignOptions>;

package/dist/chart-options-processor/translations/tooltip-utils.d.ts

@@ -2,6 +2,7 @@ import { Category, Value } from '../../chart-data-options/types.js';
 export declare const isXValueNumeric: (dataOptionX: Value | Category | undefined) => boolean | "";
 export declare const formatTooltipValue: (dataOption: Value | Category | undefined, value: number | undefined, displayValue: string) => string;
 export declare const formatTooltipXValue: (dataOption: Value | Category | undefined, value: number | string | undefined, displayValue: string) => string;
+export declare function isTooltipPercentValueSupported(options: Value | undefined): boolean;
 export type TooltipSettings = {
     enabled?: boolean;
     animation?: boolean;

package/dist/charts/indicator/indicator-legacy-chart-options/legacy-chart-options-to-theme-settings-dictionary.d.ts

@@ -9,4 +9,6 @@ export declare const legacyOptionsToThemeSettingsDictionary: {
     backgroundColor: string;
     'label.color': string;
     'secondaryTitle.color': string;
+    'secondaryValue.color': string;
+    'value.color': string;
 };

package/dist/charts/indicator/indicator-legacy-chart-options/override-with-value-color.d.ts

@@ -1,6 +1,5 @@
 import { IndicatorChartDataOptions, ConditionalDataColorOptions, DataColorOptions, UniformDataColorOptions } from '../../../types';
 import { LegacyIndicatorChartOptions } from '../types';
-import { IndicatorTypeOptions } from './indicator-legacy-chart-options';
 /**
  * Type that represents allowed color options for an indicator.
  */
@@ -25,7 +24,7 @@ export declare function getValueColorOptions(dataOptions: IndicatorChartDataOpti
  * @param typeOptions - Describe indicator type and subtype.
  * @returns The modified legacy indicator chart options.
  */
-export declare function overrideWithValueColor(colorOptions: DataColorOptions, value: number, legacyChartOptions: LegacyIndicatorChartOptions, typeOptions: IndicatorTypeOptions): LegacyIndicatorChartOptions;
+export declare function overrideWithValueColor(colorOptions: DataColorOptions, value: number, legacyChartOptions: LegacyIndicatorChartOptions): LegacyIndicatorChartOptions;
 /**
  * Checks if the color options are allowed for an indicator.
  *

package/dist/column-chart.d.ts

@@ -3,6 +3,9 @@ import { ColumnChartProps } from './props';
 /**
  * A React component representing categorical data with vertical rectangular bars
  * whose heights are proportional to the values that they represent.
+ *
+ * The chart can include multiple values on both the X and Y-axis, as well as a break down by categories displayed on the Y-axis.
+ *
  * See [Column Chart](https://docs.sisense.com/main/SisenseLinux/column-chart.htm) for more information.
  *
  * @example
@@ -25,5 +28,6 @@ import { ColumnChartProps } from './props';
  * <img src="media://column-chart-example-1.png" width="800"/>
  * @param props - Column chart properties
  * @returns Column Chart component
+ * @group Charts
  */
 export declare const ColumnChart: import("react").FunctionComponent<ColumnChartProps>;

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

@@ -3,8 +3,10 @@ import { CompleteThemeSettings } from '../../types';
 /**
  * Component that displays a loading indicator.
  *
+ * @param themeSettings - Theme settings to use for the loading indicator.
  * @param onCancel - Function to call when cancel is clicked.
  * @returns A loading indicator with optional cancel.
+ * @internal
  */
 export declare const LoadingIndicator: ({ themeSettings, onCancel, }: {
     themeSettings?: {

package/dist/common/hooks/use-fetch.d.ts

@@ -0,0 +1,42 @@
+import { type UseQueryResult as TanstackUseQueryResult } from '@tanstack/react-query';
+/**
+ * Additional request configuration options for the `useFetch` hook.
+ */
+export type RequestConfig = {
+    /**
+     * Indicates that the request body is not a JSON object.
+     */
+    nonJSONBody?: boolean;
+    /**
+     * Indicates that the response should be treated as a Blob.
+     */
+    returnBlob?: boolean;
+};
+/**
+ * The result of the `useFetch` hook.
+ * Return value of the `useQuery` hook from `@tanstack/react-query`.
+ * @link https://tanstack.com/query/v4/docs/framework/react/reference/useQuery
+ *
+ * @template TData - The type of the data returned by the fetch request
+ * @template TError - The type of the error returned by the fetch request
+ */
+export type UseQueryResult<TData, TError> = TanstackUseQueryResult<TData, TError>;
+/**
+ * React hook that allows to make authorized fetch request to any Sisense API.
+ *
+ * @example
+ ```tsx
+  const { data, isLoading, error } = useFetch<unknown, Error>('api/v1/elasticubes/getElasticubes', {
+    method: 'POST',
+  });
+ ```
+ * @param path - The endpoint path to fetch data from. This should be a relative path like '/api/v1/endpoint'.
+ * @param init - The request init object
+ * @param options - The additional request options
+ * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
+ * @group Fusion Embed
+ */
+export declare const useFetch: <TData = unknown, TError = unknown>(path: string, init?: RequestInit | undefined, options?: {
+    requestConfig?: RequestConfig | undefined;
+    enabled?: boolean | undefined;
+} | undefined) => UseQueryResult<TData, TError>;

package/dist/const.d.ts

@@ -0,0 +1 @@
+export declare const QUERY_DEFAULT_LIMIT = 20000;

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

@@ -15,5 +15,7 @@ import { DashboardWidgetProps } from '../props';
  *   dashboardOid={'6441e728dac1920034bce737'}
  * />
  * ```
+ * @group Fusion Embed
+ * @fusionEmbed
  */
 export declare const DashboardWidget: FunctionComponent<DashboardWidgetProps>;

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

@@ -4,5 +4,10 @@ import { Panel, PanelItem, WidgetType, WidgetStyle, BoxplotWidgetStyle } from '.
 import { WidgetDataOptions } from '../models';
 export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): import("@sisense/sdk-data").Filter | DimensionalCalculatedMeasure | DimensionalBaseMeasure | DimensionalAttribute;
 export declare function createDataColumn(item: PanelItem, customPaletteColors?: Color[]): StyledMeasureColumn | StyledColumn;
+/** @internal */
+export declare const createDataOptionsFromPanels: (panels: Panel[], variantColors: Color[]) => {
+    [key: string]: any[];
+};
+export declare function createColumnsFromPanelItems(panels: Panel[], panelName: string, customPaletteColors?: Color[]): (StyledMeasureColumn | StyledColumn)[];
 export declare function extractBoxplotBoxType(style: BoxplotWidgetStyle): "iqr" | "extremums" | "standardDeviation";
 export declare function extractDataOptions(widgetType: WidgetType, panels: Panel[], style: WidgetStyle, customPaletteColors?: Color[]): WidgetDataOptions;

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

@@ -24,6 +24,7 @@ export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
  *
  * @param jaql - The filter JAQL object.
  * @returns - The created Filter object.
+ * @internal
  */
 export declare function createFilterFromJaql(jaql: FilterJaql, instanceid?: string): Filter;
 /**

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

@@ -10,11 +10,11 @@ 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';
+export type TabularWidgetType = 'tablewidget' | 'tablewidgetagg' | 'pivot2';
 /**
  * The type of a widget on a dashboard.
  */
-export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area';
+export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area' | 'plugin';
 export type WidgetSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'area/spline' | 'area/stackedspline' | 'area/stackedspline100' | 'bar/classic' | 'bar/stacked' | 'bar/stacked100' | 'column/classic' | 'column/stackedcolumn' | 'column/stackedcolumn100' | 'line/basic' | 'line/spline' | 'pie/classic' | 'pie/donut' | 'pie/ring' | 'column/polar' | 'area/polar' | 'line/polar' | 'indicator/numeric' | 'indicator/gauge' | 'bubble/scatter' | 'treemap' | 'sunburst' | 'boxplot/full' | 'boxplot/hollow' | 'map/scatter' | 'areamap/world' | 'areamap/usa';
 export declare enum WidgetDashboardFilterMode {
     FILTER = "filter",
@@ -220,6 +220,7 @@ export type FunnelWidgetStyle = BaseWidgetStyle & {
         decimals: boolean;
     };
 };
+export type PluginStyle = any;
 export type TableWidgetStyle = {
     'colors/columns': boolean;
     'colors/headers': boolean;

package/dist/dynamic-size-container/dynamic-size-container.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-type ContainerSize = {
+export type ContainerSize = {
     width: number;
     height: number;
 };
@@ -7,6 +7,8 @@ export type DynamicSizeContainerProps = {
     children: React.ReactNode | ((size: ContainerSize) => React.ReactNode);
     defaultSize: ContainerSize;
     size?: Partial<ContainerSize>;
+    rerenderOnResize?: boolean;
+    onSizeChange?: (size: ContainerSize) => void;
 };
 /**
  * A container component that adjusts its content size according to provided sizes
@@ -18,5 +20,4 @@ export type DynamicSizeContainerProps = {
  * @param {DynamicSizeContainerProps} props - DynamicSizeContainer properties.
  * @returns {JSX.Element} The DynamicSizeContainer component.
  */
-export declare const DynamicSizeContainer: ({ children, defaultSize, size, }: DynamicSizeContainerProps) => JSX.Element;
-export {};
+export declare const DynamicSizeContainer: ({ children, defaultSize, size, rerenderOnResize, onSizeChange, }: DynamicSizeContainerProps) => JSX.Element;

package/dist/filters/components/criteria-filter-tile/criteria-filter-tile.d.ts

@@ -40,5 +40,6 @@ export type CriteriaFilterType = NumericFilter | TextFilter | RankingFilter | Ex
  * <img src="media://criteria-filter-tile-example-1.png" width="300px" />
  * @param props - Criteria filter tile props
  * @returns Criteria filter tile component
+ * @group Filter Tiles
  */
 export declare const CriteriaFilterTile: import("react").FunctionComponent<CriteriaFilterTileProps>;

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

@@ -67,5 +67,6 @@ export interface DateRangeFilterTileProps {
  * <img src="media://date-filter-example-1.png" width="800px" />
  * @param props - Date Range Filter Tile Props
  * @returns Date Range Filter Tile component
+ * @group Filter Tiles
  */
 export declare const DateRangeFilterTile: import("react").FunctionComponent<DateRangeFilterTileProps>;

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

@@ -32,5 +32,6 @@ export interface RelativeDateFilterTileProps {
  *
  * @param props - Relative date filter tile props
  * @returns Relative date filter tile component
+ * @group Filter Tiles
  */
 export declare const RelativeDateFilterTile: import("react").FunctionComponent<RelativeDateFilterTileProps>;

package/dist/filters/components/member-filter-tile/member-filter-tile.d.ts

@@ -44,5 +44,6 @@ export interface MemberFilterTileProps {
  * <img src="media://member-filter-tile-example-1.png" width="300px" />
  * @param props - Member filter tile props
  * @returns Member filter tile component
+ * @group Filter Tiles
  */
 export declare const MemberFilterTile: FunctionComponent<MemberFilterTileProps>;

package/dist/formulas/use-get-shared-formula.d.ts

@@ -86,6 +86,8 @@ export type SharedFormulaSuccessState = {
  * @param params - {@link UseGetSharedFormulaParams}
  * @param dataSource - Data source in Sisense instance
  * @returns Formula load state that contains the status of the execution, the result formula, or the error if any
+ * @group Fusion Embed
+ * @fusionEmbed
  */
 export declare const useGetSharedFormula: (params: UseGetSharedFormulaParams) => SharedFormulaState;
 /**

package/dist/funnel-chart.d.ts

@@ -43,5 +43,6 @@ import { FunnelChartProps } from './props';
  * Note that the chart sorts the measure, `Unique Users`, in descending order by default.
  * @param props - Funnel chart properties
  * @returns Funnel Chart component
+ * @group Charts
  */
 export declare const FunnelChart: import("react").FunctionComponent<FunnelChartProps>;

package/dist/index.d.ts

@@ -42,3 +42,8 @@ export * from './filters';
 export * from './formulas';
 export { trackHook } from './decorators/hook-decorators';
 export * from './common/hooks/data-load-state-reducer';
+export { createDataOptionsFromPanels } from './dashboard-widget/translate-widget-data-options';
+export { createFilterFromJaql } from './dashboard-widget/translate-widget-filters';
+export { useThemeContext } from './theme-provider/theme-provider';
+export { LoadingIndicator } from './common/components/loading-indicator';
+export { useFetch, type RequestConfig, type UseQueryResult } from './common/hooks/use-fetch';