@sisense/sdk-ui 0.16.0 → 1.1.0

package/dist/indicator-canvas.d.ts

@@ -1,4 +1,4 @@
-import { ChartDataOptionsInternal, IndicatorDataOptionsInternal } from './chart-data-options/types';
+import { ChartDataOptionsInternal, IndicatorChartDataOptionsInternal } from './chart-data-options/types';
 import { type FunctionComponent } from 'react';
 import { IndicatorChartData } from './chart-data/types';
 import { IndicatorChartDesignOptions } from './chart-options-processor/translations/design-options';
@@ -7,7 +7,7 @@ import { ChartDesignOptions } from './chart-options-processor/translations/types
 import { ThemeSettings } from './types';
 interface Props {
     chartData: IndicatorChartData;
-    dataOptions: IndicatorDataOptionsInternal;
+    dataOptions: IndicatorChartDataOptionsInternal;
     designOptions: IndicatorChartDesignOptions;
     themeSettings?: ThemeSettings;
 }
@@ -16,6 +16,6 @@ interface Props {
  */
 export declare const IndicatorCanvas: FunctionComponent<Props>;
 export declare const isIndicatorChartData: (chartData: ChartData) => chartData is IndicatorChartData;
-export declare const isIndicatorDataOptionsInternal: (dataOptions: ChartDataOptionsInternal) => dataOptions is IndicatorDataOptionsInternal;
+export declare const isIndicatorChartDataOptionsInternal: (dataOptions: ChartDataOptionsInternal) => dataOptions is IndicatorChartDataOptionsInternal;
 export declare const isIndicatorDesignOptions: (designOptions: ChartDesignOptions) => designOptions is IndicatorChartDesignOptions;
 export {};

package/dist/indicator-chart.d.ts

@@ -12,7 +12,7 @@ import { IndicatorChartProps } from './props';
  *   dataOptions={{
  *     value: [
  *       {
- *         column: measures.sum(DM.Commerce.Revenue),
+ *         column: measureFactory.sum(DM.Commerce.Revenue),
  *         numberFormatConfig: {
  *           name: 'Numbers',
  *           decimalScale: 2,
@@ -27,10 +27,10 @@ import { IndicatorChartProps } from './props';
  *       },
  *     ],
  *     secondary: [],
- *     min: [measures.constant(0)],
- *     max: [measures.constant(125000000)],
+ *     min: [measureFactory.constant(0)],
+ *     max: [measureFactory.constant(125000000)],
  *   }}
- *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
+ *   filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
  *   styleOptions={{
  *     indicatorComponents: {
  *       title: {

package/dist/line-chart.d.ts

@@ -11,10 +11,10 @@ import { LineChartProps } from './props';
  *   dataSet={DM.DataSource}
  *   dataOptions={{
  *     category: [DM.Commerce.Date.Years],
- *     value: [measures.sum(DM.Commerce.Revenue)],
+ *     value: [measureFactory.sum(DM.Commerce.Revenue)],
  *     breakBy: [DM.Commerce.Gender],
  *   }}
- *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
+ *   filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
  *   onDataPointClick= {(point, nativeEvent) => {
  *     console.log('clicked', point, nativeEvent);
  *   }}

package/dist/models/dashboard/use-get-dashboard-model.d.ts

@@ -99,6 +99,7 @@ export type DashboardModelSuccessState = {
 export declare const useGetDashboardModel: (params: GetDashboardModelParams) => DashboardModelState;
 /**
  * {@link useGetDashboardModel} without tracking to be used inside other hooks or components in Compose SDK.
+ *
  * @internal
  */
 export declare function useGetDashboardModelInternal(params: GetDashboardModelParams): DashboardModelState;

package/dist/models/dashboard/use-get-dashboard-models.d.ts

@@ -62,7 +62,7 @@ export type DashboardModelsSuccessState = {
     status: 'success';
 };
 /**
-  * React hook that retrieves existing dashboards that the user can access to from the Sisense instance.
+ * React hook that retrieves existing dashboards that the user can access to from the Sisense instance.
  *
  * @example
  ```tsx
@@ -84,6 +84,7 @@ export type DashboardModelsSuccessState = {
 export declare const useGetDashboardModels: (params?: GetDashboardModelsParams | undefined) => DashboardModelsState;
 /**
  * {@link useGetDashboardModels} without tracking to be used inside other hooks or components in Compose SDK.
+ *
  * @internal
  */
 export declare function useGetDashboardModelsInternal(params?: GetDashboardModelsParams): DashboardModelsState;

package/dist/models/widget/use-get-widget-model.d.ts

@@ -97,6 +97,7 @@ export type WidgetModelSuccessState = {
 export declare const useGetWidgetModel: (params: GetWidgetModelParams) => WidgetModelState;
 /**
  * {@link useGetWidgetModel} without tracking to be used inside other hooks or components in Compose SDK.
+ *
  * @internal
  */
 export declare function useGetWidgetModelInternal(params: GetWidgetModelParams): WidgetModelState;

package/dist/models/widget/widget-model.d.ts

@@ -3,7 +3,7 @@ import { ChartDataOptions, TableDataOptions } from '../../chart-data-options/typ
 import { WidgetDto, WidgetType } from '../../dashboard-widget/types';
 import { ChartProps, ChartWidgetProps, TableProps, TableWidgetProps } from '../../props';
 import { ExecuteQueryParams } from '../../query-execution';
-import { ChartType, DrilldownOptions, StyleOptions, TableStyleOptions } from '../../types';
+import { ChartType, DrilldownOptions, ChartStyleOptions, TableStyleOptions } from '../../types';
 /**
  * Widget data options.
  */
@@ -39,7 +39,7 @@ export declare class WidgetModel {
     /**
      * Widget style options.
      */
-    styleOptions: StyleOptions | TableStyleOptions;
+    styleOptions: ChartStyleOptions | TableStyleOptions;
     /**
      * Widget filters.
      */
@@ -60,7 +60,6 @@ export declare class WidgetModel {
      * Creates a new widget model.
      *
      * @param widgetDto - The widget DTO to be converted to a widget model
-     *
      * @internal
      */
     constructor(widgetDto: WidgetDto);
@@ -87,6 +86,7 @@ export declare class WidgetModel {
     getChartProps(): ChartProps;
     /**
      * Returns the props to be used for rendering a table.
+     *
      * @example
      * ```tsx
      * <Table {...widget.getTableProps()} />
@@ -98,6 +98,7 @@ export declare class WidgetModel {
     getTableProps(): TableProps;
     /**
      * Returns the props to be used for rendering a chart widget.
+     *
      * @example
      * ```tsx
      * <ChartWidget {...widget.getChartWidgetProps()} />
@@ -108,6 +109,7 @@ export declare class WidgetModel {
     getChartWidgetProps(): ChartWidgetProps;
     /**
      * Returns the props to be used for rendering a table widget.
+     *
      * @example
      * ```tsx
      * <TableWidget {...widget.getTableWidgetProps()} />
@@ -115,7 +117,6 @@ export declare class WidgetModel {
      *
      * Note: this method is not supported for chart widgets.
      * Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
-     *
      * @internal
      */
     getTableWidgetProps(): TableWidgetProps;

package/dist/pie-chart.d.ts

@@ -12,9 +12,9 @@ import { PieChartProps } from './props';
  *   dataSet={DM.DataSource}
  *   dataOptions={{
  *     category: [DM.Commerce.AgeRange],
- *     value: [measures.sum(DM.Commerce.Revenue)],
+ *     value: [measureFactory.sum(DM.Commerce.Revenue)],
  *   }}
- *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
+ *   filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
  *   onDataPointClick= {(point, nativeEvent) => {
  *     console.log('clicked', point, nativeEvent);
  *   }}

package/dist/polar-chart.d.ts

@@ -11,10 +11,10 @@ import { PolarChartProps } from './props';
  *   dataSet={DM.DataSource}
  *   dataOptions={{
  *     category: [DM.Commerce.AgeRange],
- *     value: [measures.sum(DM.Commerce.Revenue)],
+ *     value: [measureFactory.sum(DM.Commerce.Revenue)],
  *     breakBy: [DM.Commerce.Gender],
  *   }}
- *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
+ *   filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
  *   onDataPointClick= {(point, nativeEvent) => {
  *     console.log('clicked', point, nativeEvent);
  *   }}

package/dist/props.d.ts

@@ -1,11 +1,11 @@
-import { Attribute, Filter, Measure, DataSource, Data, QueryResultData } from '@sisense/sdk-data';
-import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, StyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, TableStyleOptions, ThemeOid, WidgetStyleOptions, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions } from './types';
+import { Attribute, Filter, Measure, DataSource, Data, QueryResultData, FilterRelation } from '@sisense/sdk-data';
+import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, TableStyleOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions } from './types';
 import { HighchartsOptions } from './chart-options-processor/chart-options-service';
 import { ComponentType, PropsWithChildren, ReactNode } from 'react';
-import { IndicatorDataOptions, ScatterChartDataOptions, TableDataOptions } from './chart-data-options/types';
+import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions } from './chart-data-options/types';
 import { DataPointEventHandler, DataPointsEventHandler, ScatterDataPointEventHandler, ScatterDataPointsEventHandler } from './chart-options-processor/apply-event-handlers';
 import { AppConfig } from './app/client-application';
-import { ExecuteQueryParams } from './query-execution';
+import { ExecuteQueryParams, QueryByWidgetIdState, QueryState } from './query-execution';
 import { FiltersMergeStrategy } from './dashboard-widget/types';
 import { HookEnableParam } from './common/hooks/types';
 export type { ScatterDataPointEventHandler, ScatterDataPointsEventHandler, DataPointEventHandler, DataPointsEventHandler, MenuItemSection, HighchartsOptions, };
@@ -82,7 +82,7 @@ export interface ExecuteQueryProps {
     /** Measures of the query */
     measures?: Measure[];
     /** Filters that will slice query results */
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelation;
     /** Highlight filters that will highlight results that pass filter criteria */
     highlights?: Filter[];
     /**
@@ -98,7 +98,7 @@ export interface ExecuteQueryProps {
      */
     offset?: number;
     /** Function as child component that is called to render the query results */
-    children?: (queryResult: QueryResultData) => ReactNode;
+    children?: (queryState: QueryState) => ReactNode;
     /** Callback function that is evaluated when query results are ready */
     onDataChanged?: (data: QueryResultData) => void;
     /**
@@ -253,7 +253,7 @@ export interface BaseChartProps {
      *
      * @category Data
      */
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelation;
     /**
      * Highlight filters that will highlight results that pass filter criteria
      *
@@ -282,7 +282,7 @@ export interface ChartProps extends BaseChartProps, BaseChartEventProps {
      *
      * @category Chart
      */
-    styleOptions?: StyleOptions;
+    styleOptions?: ChartStyleOptions;
     /**
      * Used to force a refresh of the chart from outside the chart component
      * Since added to dependencies of useEffect, will trigger a query execution
@@ -319,7 +319,7 @@ export interface BarChartProps extends BaseChartProps, ChartEventProps {
      */
     dataOptions: CartesianChartDataOptions;
     /**
-     * Configuration that define functional style of the various chart elements
+     * Configuration that defines functional style of the various chart elements
      *
      * @category Chart
      */
@@ -336,7 +336,7 @@ export interface ColumnChartProps extends BaseChartProps, ChartEventProps {
      */
     dataOptions: CartesianChartDataOptions;
     /**
-     * Configuration that define functional style of the various chart elements
+     * Configuration that defines functional style of the various chart elements
      *
      * @category Chart
      */
@@ -353,7 +353,7 @@ export interface FunnelChartProps extends BaseChartProps, ChartEventProps {
      */
     dataOptions: CategoricalChartDataOptions;
     /**
-     * Configuration that define functional style of the various chart elements
+     * Configuration that defines functional style of the various chart elements
      *
      * @category Chart
      */
@@ -387,7 +387,7 @@ export interface PieChartProps extends BaseChartProps, ChartEventProps {
      */
     dataOptions: CategoricalChartDataOptions;
     /**
-     * Configuration that define functional style of the various chart elements
+     * Configuration that defines functional style of the various chart elements
      *
      * @category Chart
      */
@@ -399,7 +399,7 @@ export interface PieChartProps extends BaseChartProps, ChartEventProps {
 export interface PolarChartProps extends BaseChartProps, ChartEventProps {
     /** Configurations for how to interpret and present the data passed to the chart */
     dataOptions: CartesianChartDataOptions;
-    /** Configuration that define functional style of the various chart elements */
+    /** Configuration that defines functional style of the various chart elements */
     styleOptions?: PolarStyleOptions;
 }
 /**
@@ -407,8 +407,8 @@ export interface PolarChartProps extends BaseChartProps, ChartEventProps {
  */
 export interface IndicatorChartProps extends BaseChartProps {
     /** Configurations for how to interpret and present the data passed to the chart */
-    dataOptions: IndicatorDataOptions;
-    /** Configuration that define functional style of the various chart elements */
+    dataOptions: IndicatorChartDataOptions;
+    /** Configuration that defines functional style of the various chart elements */
     styleOptions?: IndicatorStyleOptions;
 }
 /**
@@ -433,7 +433,7 @@ export interface TableProps {
      *
      * @category Data
      */
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelation;
     /**
      * Configurations that define functional style of the various table elements
      *
@@ -459,7 +459,7 @@ export interface ScatterChartProps extends BaseChartProps, ScatterChartEventProp
      */
     dataOptions: ScatterChartDataOptions;
     /**
-     * Configuration that define functional style of the various chart elements
+     * Configuration that defines functional style of the various chart elements
      *
      * @category Chart
      */
@@ -525,35 +525,12 @@ export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource
      */
     description?: string;
     /**
-     * Style options for the widget container including the widget header
+     * Style options for the the widget including the widget container and the chart or table inside.
      *
-     * @category Widget
-     */
-    widgetStyleOptions?: WidgetStyleOptions;
-    /**
-     * General style options for the visual component of the widget – for example, chart or table.
      *
      * @category Widget
      */
-    styleOptions?: {
-        /**
-         * Total width of the component, which is considered in the following order of priority:
-         *
-         * 1. Value passed to this property (in pixels)
-         * 2. Width of the container wrapping this component
-         * 3. Default value as specified per chart type
-         *
-         */
-        width?: number;
-        /**
-         * Total height of the component, which is considered in the following order of priority:
-         *
-         * 1. Value passed to this property (in pixels).
-         * 2. Height of the container wrapping this component
-         * 3. Default value as specified per chart type
-         */
-        height?: number;
-    };
+    styleOptions?: DashboardWidgetStyleOptions;
     /**
      * {@inheritDoc ChartWidgetProps.drilldownOptions}
      *
@@ -581,6 +558,12 @@ export interface ChartWidgetProps extends BaseChartEventProps {
      * @category Data
      */
     filters?: Filter[];
+    /**
+     * Specifies the logical relationship between multiple filters (AND, OR)
+     *
+     * @category Data
+     */
+    filterRelations?: FilterRelation;
     /**
      * Highlight filters that will highlight results that pass filter criteria
      *
@@ -600,17 +583,11 @@ export interface ChartWidgetProps extends BaseChartEventProps {
      */
     dataOptions: ChartDataOptions;
     /**
-     * Style options for both the widget as a whole and specifically for the widget header
+     * Style options for both the chart and widget including the widget header
      *
      * @category Widget
      */
-    widgetStyleOptions?: WidgetStyleOptions;
-    /**
-     * Style options union across chart types
-     *
-     * @category Chart
-     */
-    styleOptions?: StyleOptions;
+    styleOptions?: ChartWidgetStyleOptions;
     /**
      * List of categories to allow drilldowns on
      *
@@ -687,7 +664,7 @@ export interface TableWidgetProps {
      *
      * @category Data
      */
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelation;
     /**
      * Configurations for how to interpret and present the data passed to the table
      *
@@ -695,17 +672,11 @@ export interface TableWidgetProps {
      */
     dataOptions: TableDataOptions;
     /**
-     * Style options for both the widget as a whole and specifically for the widget header
+     * Style options for both the table and widget including the widget header
      *
      * @category Widget
      */
-    widgetStyleOptions?: WidgetStyleOptions;
-    /**
-     * Style options for table
-     *
-     * @category Chart
-     */
-    styleOptions?: TableStyleOptions;
+    styleOptions?: TableWidgetStyleOptions;
     /**
      * React nodes to be rendered at the top of component, before the table
      *
@@ -768,7 +739,7 @@ export interface ExecuteQueryByWidgetIdProps {
      */
     includeDashboardFilters?: boolean;
     /** Function as child component that is called to render the query results */
-    children?: (queryResult: QueryResultData, queryParams: ExecuteQueryParams) => ReactNode;
+    children?: (queryState: QueryByWidgetIdState) => ReactNode;
     /** Callback function that is evaluated when query results are ready */
     onDataChanged?: (data: QueryResultData, queryParams: ExecuteQueryParams) => void;
     /**
@@ -795,7 +766,7 @@ export interface TreemapChartProps extends BaseChartProps, ChartEventProps {
      */
     dataOptions: CategoricalChartDataOptions;
     /**
-     * Configuration that define functional style of the various chart elements
+     * Configuration that defines functional style of the various chart elements
      *
      * @category Chart
      */
@@ -812,12 +783,63 @@ export interface SunburstChartProps extends BaseChartProps, ChartEventProps {
      */
     dataOptions: CategoricalChartDataOptions;
     /**
-     * Configuration that define functional style of the various chart elements
+     * Configuration that defines functional style of the various chart elements
      *
      * @category Chart
      */
     styleOptions?: SunburstStyleOptions;
 }
+/**
+ * Props of the {@link BoxplotChart} component.
+ */
+export interface BoxplotChartProps extends BaseChartProps, ChartEventProps {
+    /**
+     * Configurations for how to interpret and present the data passed to the chart
+     *
+     * @category Chart
+     */
+    dataOptions: BoxplotChartDataOptions | BoxplotChartCustomDataOptions;
+    /**
+     * Configuration that defines functional style of the various chart elements
+     *
+     * @category Chart
+     */
+    styleOptions?: BoxplotStyleOptions;
+}
+/**
+ * Props of the {@link ScattermapChart} component.
+ */
+export interface ScattermapChartProps extends BaseChartProps, ChartEventProps {
+    /**
+     * Configurations for how to interpret and present the data passed to the chart
+     *
+     * @category Chart
+     */
+    dataOptions: ScattermapChartDataOptions;
+    /**
+     * Configuration that defines functional style of the various chart elements
+     *
+     * @category Chart
+     */
+    styleOptions?: ScattermapStyleOptions;
+}
+/**
+ * Props of the {@link AreamapChart} component.
+ */
+export interface AreamapChartProps extends BaseChartProps, ChartEventProps {
+    /**
+     * Configurations for how to interpret and present the data passed to the chart
+     *
+     * @category Chart
+     */
+    dataOptions: AreamapChartDataOptions;
+    /**
+     * Configuration that defines functional style of the various chart elements
+     *
+     * @category Chart
+     */
+    styleOptions?: AreamapStyleOptions;
+}
 /**
  * Props for {@link ContextMenu} component.
  */

package/dist/query/execute-query.d.ts

@@ -4,7 +4,7 @@ import { ClientApplication } from '../app/client-application';
 /**
  * All the properties that fully describe a query you want to send.
  *
- * We use "dimensions" it public interface because the term is closer to the query and charting
+ * We use "dimensions" in public interface because the term is closer to the query and charting
  * as used in the industry (Sisense included).
  * internally, "dimensions" are represented by attributes as the latter is closer to the data model.
  */

package/dist/query-execution/execute-query-by-widget-id.d.ts

@@ -2,7 +2,7 @@ import { type FunctionComponent } from 'react';
 import { ExecuteQueryByWidgetIdProps } from '../props';
 /**
  * Executes a query over the existing widget and renders a function as child component.
- * The child component is passed the results of the query.
+ * The child component is passed the state of the query as defined in {@link QueryByWidgetIdState}.
  *
  * This component takes the Children Prop Pattern and
  * offers an alternative approach to the {@link useExecuteQueryByWidgetId} hook.
@@ -15,10 +15,18 @@ import { ExecuteQueryByWidgetIdProps } from '../props';
  *   dashboardOid={'6441e728dac1920034bce737'}
  * >
  * {
- *   (data, query) => {
+ *   ({data, isLoading, isError}) => {
+ *     if (isLoading) {
+ *       return <div>Loading...</div>;
+ *     }
+ *     if (isError) {
+ *       return <div>Error</div>;
+ *     }
  *     if (data) {
+ *       console.log(data);
  *       return <div>{`Total Rows: ${data.rows.length}`}</div>;
  *     }
+ *     return null;
  *   }
  * }
  * </ExecuteQueryByWidgetId>

package/dist/query-execution/execute-query.d.ts

@@ -2,7 +2,7 @@ import { type FunctionComponent } from 'react';
 import { ExecuteQueryProps } from '../props';
 /**
  * Executes a query and renders a function as child component. The child
- * component is passed the results of the query.
+ * component is passed the state of the query as defined in {@link QueryState}.
  *
  * This component takes the Children Prop Pattern and
  * offers an alternative approach to the {@link useExecuteQuery} hook.
@@ -13,15 +13,22 @@ import { ExecuteQueryProps } from '../props';
  * <ExecuteQuery
  *   dataSource={DM.DataSource}
  *   dimensions={[DM.Commerce.AgeRange]}
- *   measures={[measures.sum(DM.Commerce.Revenue)]}
- *   filters={[filters.greaterThan(DM.Commerce.Revenue, 1000)]}
+ *   measures={[measureFactory.sum(DM.Commerce.Revenue)]}
+ *   filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
  * >
  * {
- *   (data) => {
+ *   ({data, isLoading, isError}) => {
+ *     if (isLoading) {
+ *       return <div>Loading...</div>;
+ *     }
+ *     if (isError) {
+ *       return <div>Error</div>;
+ *     }
  *     if (data) {
  *       console.log(data);
  *       return <div>{`Total Rows: ${data.rows.length}`}</div>;
  *     }
+ *     return null;
  *   }
  * }
  * </ExecuteQuery>

package/dist/query-execution/index.d.ts

@@ -3,4 +3,4 @@ export { useExecuteQuery } from './use-execute-query';
 export { useExecuteCsvQuery } from './use-execute-csv-query';
 export { ExecuteQueryByWidgetId } from './execute-query-by-widget-id';
 export { useExecuteQueryByWidgetId, executeQueryByWidgetId, } from './use-execute-query-by-widget-id';
-export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, ExecuteQueryParams, ExecuteCsvQueryParams, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, } from './types';
+export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, ExecuteQueryParams, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, } from './types';

package/dist/query-execution/types.d.ts

@@ -1,4 +1,4 @@
-import { Attribute, DataSource, Filter, Measure, QueryResultData } from '@sisense/sdk-data';
+import { Attribute, DataSource, Filter, FilterRelation, Measure, QueryResultData } from '@sisense/sdk-data';
 import { DataLoadAction } from '../common/hooks/data-load-state-reducer';
 import { FiltersMergeStrategy } from '../dashboard-widget/types';
 /**
@@ -161,7 +161,7 @@ export interface ExecuteQueryParams {
     /** Measures of the query */
     measures?: Measure[];
     /** Filters that will slice query results */
-    filters?: Filter[];
+    filters?: Filter[] | FilterRelation;
     /** Highlight filters that will highlight results that pass filter criteria */
     highlights?: Filter[];
     /** {@inheritDoc ExecuteQueryProps.count} */
@@ -177,14 +177,16 @@ export interface ExecuteQueryParams {
     /** {@inheritDoc ExecuteQueryProps.onBeforeQuery} */
     onBeforeQuery?: (jaql: any) => any | Promise<any>;
 }
+/** Configuration for {@link useExecuteCsvQuery} hook. */
+export type ExecuteCSVQueryConfig = {
+    /**
+     * If set to true, the data will be returned as a Blob.
+     */
+    asDataStream?: boolean;
+};
 /**
  * Parameters for {@link useExecuteCsvQuery} hook.
  */
 export interface ExecuteCsvQueryParams extends ExecuteQueryParams {
-    config?: {
-        /**
-         * If set to true, the data will be returned as a Blob.
-         */
-        asDataStream?: boolean;
-    };
+    config?: ExecuteCSVQueryConfig;
 }

package/dist/query-execution/use-execute-csv-query.d.ts

@@ -9,8 +9,8 @@ import { CsvQueryState, ExecuteCsvQueryParams } from './types.js';
  const { data, isLoading, isError } = useExecuteCsvQuery({
    dataSource: DM.DataSource,
    dimensions: [DM.Commerce.AgeRange],
-   measures: [measures.sum(DM.Commerce.Revenue)],
-   filters: [filters.greaterThan(DM.Commerce.Revenue, 1000)],
+   measures: [measureFactory.sum(DM.Commerce.Revenue)],
+   filters: [filterFactory.greaterThan(DM.Commerce.Revenue, 1000)],
  });
  if (isLoading) {
    return <div>Loading...</div>;
@@ -28,8 +28,8 @@ import { CsvQueryState, ExecuteCsvQueryParams } from './types.js';
  const { data, isLoading, isError } = useExecuteCsvQuery({
    dataSource: DM.DataSource,
    dimensions: [DM.Commerce.AgeRange],
-   measures: [measures.sum(DM.Commerce.Revenue)],
-   filters: [filters.greaterThan(DM.Commerce.Revenue, 1000)],
+   measures: [measureFactory.sum(DM.Commerce.Revenue)],
+   filters: [filterFactory.greaterThan(DM.Commerce.Revenue, 1000)],
    config: { asDataStream: true },
  });
  if (isLoading) {
@@ -68,8 +68,6 @@ import { CsvQueryState, ExecuteCsvQueryParams } from './types.js';
  }
  return null;
  ```
-
- *
  * @param params - Parameters of the query
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
  */

package/dist/query-execution/use-execute-query-by-widget-id.d.ts

@@ -1,6 +1,7 @@
 import { ExecuteQueryParams } from './';
 import { ClientApplication } from '../app/client-application';
 import { ExecuteQueryByWidgetIdParams, QueryByWidgetIdState } from './types';
+import { Filter } from '@sisense/sdk-data';
 /**
  * React hook that executes a data query extracted from an existing widget in the Sisense instance.
  *
@@ -32,6 +33,7 @@ import { ExecuteQueryByWidgetIdParams, QueryByWidgetIdState } from './types';
 export declare const useExecuteQueryByWidgetId: (params: ExecuteQueryByWidgetIdParams) => QueryByWidgetIdState;
 /**
  * {@link useExecuteQueryByWidgetId} without tracking to be used inside other hooks or components in Compose SDK.
+ *
  * @internal
  */
 export declare function useExecuteQueryByWidgetIdInternal(params: ExecuteQueryByWidgetIdParams): QueryByWidgetIdState;
@@ -46,6 +48,8 @@ export declare function isParamsChanged(prevParams: ExecuteQueryByWidgetIdParams
 export declare function executeQueryByWidgetId({ widgetOid, dashboardOid, filters, highlights, filtersMergeStrategy, count, offset, includeDashboardFilters, app, onBeforeQuery, }: ExecuteQueryByWidgetIdParams & {
     app: ClientApplication;
 }): Promise<{
-    data: import("packages/sdk-data/dist").QueryResultData;
-    query: ExecuteQueryParams;
+    data: import("@sisense/sdk-data").QueryResultData;
+    query: Omit<ExecuteQueryParams, "filters"> & {
+        filters?: Filter[] | undefined;
+    };
 }>;