@sisense/sdk-ui 1.2.0 → 1.3.0

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, ChartStyleOptions, TableStyleOptions } from '../../types';
+import { ChartType, DrilldownOptions, ChartStyleOptions, TableStyleOptions, CompleteThemeSettings } from '../../types';
 /**
  * Widget data options.
  */
@@ -62,7 +62,7 @@ export declare class WidgetModel {
      * @param widgetDto - The widget DTO to be converted to a widget model
      * @internal
      */
-    constructor(widgetDto: WidgetDto);
+    constructor(widgetDto: WidgetDto, themeSettings?: CompleteThemeSettings);
     /**
      * Returns the parameters to be used for executing a query for the widget.
      *

package/dist/props.d.ts

@@ -1,14 +1,13 @@
-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 { Attribute, Filter, Measure, DataSource, Data, QueryResultData, FilterRelations } 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, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints } from './types';
 import { HighchartsOptions } from './chart-options-processor/chart-options-service';
 import { ComponentType, PropsWithChildren, ReactNode } from 'react';
 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, 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, };
+export type { MenuItemSection, HighchartsOptions };
 /**
  * Configurations for Sisense Context
  */
@@ -66,6 +65,15 @@ export interface SisenseContextProviderProps {
      * @internal
      */
     enableTracking?: boolean;
+    /**
+     * Boolean flag to enable sending silent pre-authentication requests to the Sisense instance.
+     * Used to check if user is already authenticated, check is performed in an ivisible iframe.
+     * Used only with SSO authentication.
+     * If not specified, the default value is `false`.
+     *
+     * @internal
+     */
+    enableSilentPreAuth?: boolean;
 }
 /**
  * Props for {@link ExecuteQuery} component.
@@ -82,7 +90,7 @@ export interface ExecuteQueryProps {
     /** Measures of the query */
     measures?: Measure[];
     /** Filters that will slice query results */
-    filters?: Filter[] | FilterRelation;
+    filters?: Filter[] | FilterRelations;
     /** Highlight filters that will highlight results that pass filter criteria */
     highlights?: Filter[];
     /**
@@ -151,74 +159,148 @@ export type ThemeProviderProps = PropsWithChildren<{
 export type BeforeRenderHandler = (
 /** Highcharts options */
 highchartsOptions: HighchartsOptions) => HighchartsOptions;
-interface BaseChartEventProps {
+/**
+ * Click handler for when an abstract data point (data point of any chart) is clicked
+ */
+export type ChartDataPointsEventHandler = (
+/** Abstract data points that were selected */
+points: ChartDataPoints, 
+/** Native MouseEvent */
+nativeEvent: MouseEvent | PointerEvent) => void;
+/** Click handler for when multiple data points are selected. */
+export type DataPointsEventHandler = (
+/** Data points that were selected */
+points: DataPoint[], 
+/** Native MouseEvent */
+nativeEvent: MouseEvent) => void;
+/** Click handler for when a data point is clicked. One parameter, `DataPoint`, is passed to the function. */
+export type DataPointEventHandler = (
+/** Data point that was clicked */
+point: DataPoint, 
+/** Native PointerEvent */
+nativeEvent: PointerEvent) => void;
+/** Click handler for when a scatter data point is clicked */
+export type ScatterDataPointEventHandler = (
+/** Data point that was clicked */
+point: ScatterDataPoint, 
+/** Native PointerEvent */
+nativeEvent: PointerEvent) => void;
+/** Click handler for when multiple scatter data points are selected. */
+export type ScatterDataPointsEventHandler = (
+/** Data points that were selected */
+points: ScatterDataPoint[], 
+/** Native MouseEvent */
+nativeEvent: MouseEvent) => void;
+/**
+ * Click handler for when a data point on Areamap is clicked.
+ */
+export type AreamapDataPointEventHandler = (
+/** Data point that was clicked */
+point: AreamapDataPoint, 
+/** Native MouseEvent */
+nativeEvent: MouseEvent) => void;
+/**
+ * Click handler for when a data point on Boxplot is clicked.
+ */
+export type BoxplotDataPointEventHandler = (
+/** Data point that was clicked */
+point: BoxplotDataPoint, 
+/** Native PointerEvent */
+nativeEvent: PointerEvent) => void;
+interface HighchartsBasedChartEventProps {
     /**
-     * Click handler callback for a data point
+     * Before render handler callback that allows adjusting
+     * detail chart options prior to render
+     *
+     * This callback is not supported for Indicator Chart, Areamap Chart, and Scattermap Chart.
      *
      * @category Callbacks
      */
-    onDataPointClick?: DataPointEventHandler | ScatterDataPointEventHandler;
+    onBeforeRender?: BeforeRenderHandler;
+}
+/**
+ * Event props for regular (non-specific) charts which uses DataPoint type
+ * to describe data points for events.
+ */
+interface RegularChartEventProps extends HighchartsBasedChartEventProps {
     /**
-     * Context menu handler callback for a data point
+     * Click handler callback for a data point
      *
      * @category Callbacks
      */
-    onDataPointContextMenu?: DataPointEventHandler | ScatterDataPointEventHandler;
+    onDataPointClick?: DataPointEventHandler;
     /**
-     * Handler callback for selection of multiple data points
+     * Context menu handler callback for a data point
      *
      * @category Callbacks
      */
-    onDataPointsSelected?: DataPointsEventHandler | ScatterDataPointsEventHandler;
+    onDataPointContextMenu?: DataPointEventHandler;
     /**
-     * Before render handler callback that allows adjusting
-     * detail chart options prior to render
-     *
-     * This callback is not yet supported for Indicator Chart
+     * Handler callback for selection of multiple data points
      *
      * @category Callbacks
      */
-    onBeforeRender?: BeforeRenderHandler;
+    onDataPointsSelected?: DataPointsEventHandler;
 }
-interface ChartEventProps extends BaseChartEventProps {
+/**
+ * Event props for Scatter chart which uses ScatterDataPoint type
+ * to describe data points for events.
+ */
+interface ScatterChartEventProps extends HighchartsBasedChartEventProps {
     /**
      * Click handler callback for a data point
      *
      * @category Callbacks
      */
-    onDataPointClick?: DataPointEventHandler;
+    onDataPointClick?: ScatterDataPointEventHandler;
     /**
      * Context menu handler callback for a data point
      *
      * @category Callbacks
      */
-    onDataPointContextMenu?: DataPointEventHandler;
+    onDataPointContextMenu?: ScatterDataPointEventHandler;
     /**
      * Handler callback for selection of multiple data points
      *
      * @category Callbacks
      */
-    onDataPointsSelected?: DataPointsEventHandler;
+    onDataPointsSelected?: ScatterDataPointsEventHandler;
 }
-interface ScatterChartEventProps extends BaseChartEventProps {
+/**
+ * Event props for Areamap chart which uses AreamapDataPoint type
+ * to describe data points for events.
+ */
+interface AreamapChartEventProps {
     /**
      * Click handler callback for a data point
      *
      * @category Callbacks
      */
-    onDataPointClick?: ScatterDataPointEventHandler;
+    onDataPointClick?: AreamapDataPointEventHandler;
+}
+/**
+ * Event props for Boxplot chart which uses BoxplotDataPoint type
+ * to describe data points for events.
+ */
+interface BoxplotChartEventProps extends HighchartsBasedChartEventProps {
+    /**
+     * Click handler callback for a data point
+     *
+     * @category Callbacks
+     */
+    onDataPointClick?: BoxplotDataPointEventHandler;
     /**
      * Context menu handler callback for a data point
      *
      * @category Callbacks
      */
-    onDataPointContextMenu?: ScatterDataPointEventHandler;
+    onDataPointContextMenu?: BoxplotDataPointEventHandler;
     /**
      * Handler callback for selection of multiple data points
      *
      * @category Callbacks
      */
-    onDataPointsSelected?: ScatterDataPointsEventHandler;
+    onDataPointsSelected?: DataPointsEventHandler;
 }
 /**
  * Base Chart Props to be extended by {@link ChartProps}
@@ -253,7 +335,7 @@ export interface BaseChartProps {
      *
      * @category Data
      */
-    filters?: Filter[] | FilterRelation;
+    filters?: Filter[] | FilterRelations;
     /**
      * Highlight filters that will highlight results that pass filter criteria
      *
@@ -261,10 +343,33 @@ export interface BaseChartProps {
      */
     highlights?: Filter[];
 }
+/**
+ * Chart props to be able to react on chart events.
+ */
+interface ChartEventProps extends HighchartsBasedChartEventProps {
+    /**
+     * Click handler callback for a data point
+     *
+     * @category Callbacks
+     */
+    onDataPointClick?: DataPointEventHandler | ScatterDataPointEventHandler | AreamapDataPointEventHandler | BoxplotDataPointEventHandler;
+    /**
+     * Context menu handler callback for a data point
+     *
+     * @category Callbacks
+     */
+    onDataPointContextMenu?: DataPointEventHandler | ScatterDataPointEventHandler | BoxplotDataPointEventHandler;
+    /**
+     * Handler callback for selection of multiple data points
+     *
+     * @category Callbacks
+     */
+    onDataPointsSelected?: DataPointsEventHandler | ScatterDataPointsEventHandler;
+}
 /**
  * Props shared across {@link Chart} components.
  */
-export interface ChartProps extends BaseChartProps, BaseChartEventProps {
+export interface ChartProps extends BaseChartProps, ChartEventProps {
     /**
      * Default chart type of each series.
      *
@@ -294,7 +399,7 @@ export interface ChartProps extends BaseChartProps, BaseChartEventProps {
 /**
  * Props of the {@link AreaChart} component.
  */
-export interface AreaChartProps extends BaseChartProps, ChartEventProps {
+export interface AreaChartProps extends BaseChartProps, RegularChartEventProps, HighchartsBasedChartEventProps {
     /**
      * Configurations for how to interpret and present data passed to the chart.
      *
@@ -311,7 +416,7 @@ export interface AreaChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link BarChart} component.
  */
-export interface BarChartProps extends BaseChartProps, ChartEventProps {
+export interface BarChartProps extends BaseChartProps, RegularChartEventProps, HighchartsBasedChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -328,7 +433,7 @@ export interface BarChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link ColumnChart} component.
  */
-export interface ColumnChartProps extends BaseChartProps, ChartEventProps {
+export interface ColumnChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -345,7 +450,7 @@ export interface ColumnChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link FunnelChart} component.
  */
-export interface FunnelChartProps extends BaseChartProps, ChartEventProps {
+export interface FunnelChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -362,7 +467,7 @@ export interface FunnelChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link LineChart} component.
  */
-export interface LineChartProps extends BaseChartProps, ChartEventProps {
+export interface LineChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
     /**
      * Configurations for how to interpret and present data passed to the chart.
      *
@@ -379,7 +484,7 @@ export interface LineChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link PieChart} component.
  */
-export interface PieChartProps extends BaseChartProps, ChartEventProps {
+export interface PieChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -396,7 +501,7 @@ export interface PieChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link PolarChart} component.
  */
-export interface PolarChartProps extends BaseChartProps, ChartEventProps {
+export interface PolarChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
     /** Configurations for how to interpret and present the data passed to the chart */
     dataOptions: CartesianChartDataOptions;
     /** Configuration that defines functional style of the various chart elements */
@@ -433,7 +538,7 @@ export interface TableProps {
      *
      * @category Data
      */
-    filters?: Filter[] | FilterRelation;
+    filters?: Filter[] | FilterRelations;
     /**
      * Configurations that define functional style of the various table elements
      *
@@ -451,7 +556,7 @@ export interface TableProps {
 /**
  * Props of the {@link ScatterChart} component.
  */
-export interface ScatterChartProps extends BaseChartProps, ScatterChartEventProps {
+export interface ScatterChartProps extends BaseChartProps, ScatterChartEventProps, HighchartsBasedChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -469,7 +574,7 @@ export interface ScatterChartProps extends BaseChartProps, ScatterChartEventProp
  * Props for the {@link DashboardWidget} component
  *
  */
-export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource' | 'dataOptions' | 'chartType' | 'styleOptions'>, BaseChartEventProps {
+export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource' | 'dataOptions' | 'chartType' | 'styleOptions'> {
     /**
      * Identifier of the widget
      *
@@ -543,7 +648,7 @@ export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource
  * Props for the {@link ChartWidget} component
  *
  */
-export interface ChartWidgetProps extends BaseChartEventProps {
+export interface ChartWidgetProps extends ChartEventProps {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
@@ -557,13 +662,7 @@ export interface ChartWidgetProps extends BaseChartEventProps {
      *
      * @category Data
      */
-    filters?: Filter[];
-    /**
-     * Specifies the logical relationship between multiple filters (AND, OR)
-     *
-     * @category Data
-     */
-    filterRelations?: FilterRelation;
+    filters?: Filter[] | FilterRelations;
     /**
      * Highlight filters that will highlight results that pass filter criteria
      *
@@ -664,7 +763,7 @@ export interface TableWidgetProps {
      *
      * @category Data
      */
-    filters?: Filter[] | FilterRelation;
+    filters?: Filter[] | FilterRelations;
     /**
      * Configurations for how to interpret and present the data passed to the table
      *
@@ -758,7 +857,7 @@ export interface ExecuteQueryByWidgetIdProps {
 /**
  * Props of the {@link TreemapChart} component.
  */
-export interface TreemapChartProps extends BaseChartProps, ChartEventProps {
+export interface TreemapChartProps extends BaseChartProps, HighchartsBasedChartEventProps, RegularChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -775,7 +874,7 @@ export interface TreemapChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link SunburstChart} component.
  */
-export interface SunburstChartProps extends BaseChartProps, ChartEventProps {
+export interface SunburstChartProps extends BaseChartProps, RegularChartEventProps, HighchartsBasedChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -792,7 +891,7 @@ export interface SunburstChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link BoxplotChart} component.
  */
-export interface BoxplotChartProps extends BaseChartProps, ChartEventProps {
+export interface BoxplotChartProps extends BaseChartProps, BoxplotChartEventProps, HighchartsBasedChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -809,7 +908,7 @@ export interface BoxplotChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link ScattermapChart} component.
  */
-export interface ScattermapChartProps extends BaseChartProps, ChartEventProps {
+export interface ScattermapChartProps extends BaseChartProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *
@@ -826,7 +925,7 @@ export interface ScattermapChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props of the {@link AreamapChart} component.
  */
-export interface AreamapChartProps extends BaseChartProps, ChartEventProps {
+export interface AreamapChartProps extends BaseChartProps, AreamapChartEventProps {
     /**
      * Configurations for how to interpret and present the data passed to the chart
      *

package/dist/query-execution/query-state-reducer.d.ts

@@ -1,2 +1,3 @@
 import { QueryAction, QueryState } from './types';
+/** @internal */
 export declare function queryStateReducer(state: QueryState, action: QueryAction): QueryState;

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

@@ -1,4 +1,4 @@
-import { Attribute, DataSource, Filter, FilterRelation, Measure, PivotAttribute, PivotGrandTotals, PivotMeasure, PivotQueryResultData, QueryResultData } from '@sisense/sdk-data';
+import { Attribute, DataSource, Filter, FilterRelations, Measure, PivotAttribute, PivotGrandTotals, PivotMeasure, PivotQueryResultData, 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[] | FilterRelation;
+    filters?: Filter[] | FilterRelations;
     /** Highlight filters that will highlight results that pass filter criteria */
     highlights?: Filter[];
     /** {@inheritDoc ExecuteQueryProps.count} */
@@ -287,7 +287,7 @@ export interface ExecutePivotQueryParams {
      *
      * @category Filtering
      */
-    filters?: Filter[] | FilterRelation;
+    filters?: Filter[] | FilterRelations;
     /**
      * Highlight filters that will highlight results that pass filter criteria
      *

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

@@ -1,7 +1,6 @@
-import { ExecuteQueryParams } from './';
+import { QueryDescription } from '../query/execute-query';
 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.
  *
@@ -49,7 +48,5 @@ export declare function executeQueryByWidgetId({ widgetOid, dashboardOid, filter
     app: ClientApplication;
 }): Promise<{
     data: import("@sisense/sdk-data").QueryResultData;
-    query: Omit<ExecuteQueryParams, "filters"> & {
-        filters?: Filter[] | undefined;
-    };
+    query: QueryDescription;
 }>;

package/dist/sisense-chart/index.d.ts

@@ -0,0 +1,2 @@
+export * from './sisense-chart';
+export * from './types';

package/dist/sisense-chart/sisense-chart.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="react" />
+import { ChartDataOptionsInternal } from '../chart-data-options/types';
+import { ChartData } from '../chart-data/types';
+import { BeforeRenderHandler } from '../props';
+import { ChartDesignOptions } from '../chart-options-processor/translations/types';
+import { ChartType, CompleteThemeSettings } from '../types';
+import { SisenseChartDataPointEventHandler, SisenseChartDataPointsEventHandler } from './types';
+interface Props {
+    chartType: ChartType;
+    chartData: ChartData;
+    chartDataOptions: ChartDataOptionsInternal;
+    designOptions: ChartDesignOptions;
+    themeSettings?: CompleteThemeSettings;
+    onDataPointClick?: SisenseChartDataPointEventHandler;
+    onDataPointContextMenu?: SisenseChartDataPointEventHandler;
+    onDataPointsSelected?: SisenseChartDataPointsEventHandler;
+    onBeforeRender?: BeforeRenderHandler;
+}
+/**
+ * @internal
+ */
+export declare const SisenseChart: ({ chartType, chartData, chartDataOptions, designOptions, themeSettings, onDataPointClick, onDataPointContextMenu, onDataPointsSelected, onBeforeRender, }: Props) => JSX.Element | null;
+export {};

package/dist/sisense-chart/types.d.ts

@@ -0,0 +1,5 @@
+import { DataPointsEventHandler, ScatterDataPointsEventHandler } from '../props.js';
+import { BoxplotDataPoint, DataPoint, ScatterDataPoint } from '../types.js';
+export type SisenseChartDataPointsEventHandler = DataPointsEventHandler | ScatterDataPointsEventHandler;
+export type SisenseChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint;
+export type SisenseChartDataPointEventHandler = (point: SisenseChartDataPoint, nativeEvent: PointerEvent) => void;

package/dist/table/hooks/use-table-data.d.ts

@@ -1,10 +1,10 @@
-import { Attribute, Data, DataSource, Filter, FilterRelation, Measure } from '@sisense/sdk-data';
+import { Attribute, Data, DataSource, Filter, FilterRelationsJaql, Measure } from '@sisense/sdk-data';
 import { TableDataOptionsInternal } from '../../chart-data-options/types';
 type UseDataProps = {
     dataSet: Data | DataSource | undefined;
     dataOptions: TableDataOptionsInternal | null;
     filters: Filter[] | undefined;
-    filterRelations: FilterRelation | undefined;
+    filterRelations: FilterRelationsJaql | undefined;
     count: number;
     offset: number;
 };