@sisense/sdk-ui 0.13.0 → 0.15.0

package/dist/indicator-chart.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { IndicatorChartProps } from './props';
 /**
- * A React component that displays a single value.
+ * A React component that provides various options for displaying one or two numeric values as a number, gauge or ticker.
  * See [Indicator](https://docs.sisense.com/main/SisenseLinux/indicator.htm) for more information.
  *
  * @example

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

@@ -3,7 +3,7 @@ export interface GetDashboardModelsOptions {
     /**
      * Dashboard title to search by
      *
-     * The dashboard title is not unique, therefore, the result may return multiple dashboards.
+     * Dashboard titles are not necessarily unique, so the result may contain multiple dashboards.
      */
     searchByTitle?: string;
     /**

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

@@ -6,7 +6,7 @@ import { HookEnableParam } from '../../common/hooks/types';
  */
 export interface GetDashboardModelParams extends GetDashboardModelOptions, HookEnableParam {
     /**
-     * Identifier of the dashboard that contains the widget
+     * Dashboard identifier
      */
     dashboardOid: string;
 }
@@ -97,3 +97,8 @@ export type DashboardModelSuccessState = {
  * @returns Dashboard load state that contains the status of the execution, the result dashboard model, or the error if any
  */
 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

@@ -81,4 +81,9 @@ export type DashboardModelsSuccessState = {
  * @param params - Parameters of the dashboards to be retrieved
  * @returns Load state that contains the status of the execution, the result dashboards, or the error if any
  */
-export declare const useGetDashboardModels: (params?: GetDashboardModelsParams) => DashboardModelsState;
+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/pie-chart.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { PieChartProps } from './props';
 /**
- * A React component representing data in circular graph with the data shown as slices of a whole,
+ * A React component representing data in a circular graph with the data shown as slices of a whole,
  * with each slice representing a proportion of the total.
  * See [Pie Chart](https://docs.sisense.com/main/SisenseLinux/pie-chart.htm) for more information.
  *

package/dist/props.d.ts

@@ -7,6 +7,7 @@ import { DataPointEventHandler, DataPointsEventHandler, ScatterDataPointEventHan
 import { AppConfig } from './app/client-application';
 import { ExecuteQueryParams } from './query-execution';
 import { FiltersMergeStrategy } from './dashboard-widget/types';
+import { HookEnableParam } from './common/hooks/types';
 export type { ScatterDataPointEventHandler, ScatterDataPointsEventHandler, DataPointEventHandler, DataPointsEventHandler, MenuItemSection, HighchartsOptions, };
 /**
  * Configurations for Sisense Context
@@ -73,7 +74,7 @@ export interface ExecuteQueryProps {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
      */
     dataSource?: DataSource;
     /** Dimensions of the query */
@@ -102,6 +103,14 @@ export interface ExecuteQueryProps {
     onDataChanged?: (data: QueryResultData) => void;
     /**
      * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
+     *
+     * **Note:** wrap this function in `useCallback` hook to avoid triggering query execution on each render.
+     * ```tsx
+     * const onBeforeQuery = useCallback((jaql) => {
+     *   // modify jaql here
+     *   return jaql;
+     * }, []);
+     * ```
      */
     onBeforeQuery?: (jaql: any) => any | Promise<any>;
 }
@@ -165,7 +174,7 @@ interface BaseChartEventProps {
      * Before render handler callback that allows adjusting
      * detail chart options prior to render
      *
-     * This callback is not yet supported for {@link IndicatorChart}
+     * This callback is not yet supported for Indicator Chart
      *
      * @category Callbacks
      */
@@ -221,7 +230,7 @@ export interface BaseChartProps {
      * Data set for this component, which supports two options:
      *
      * (1) Data source name (as a `string`) - e.g. `Sample ECommerce`. Under the hood,
-     * the chart will have an internal {@link ExecuteQuery} connect to the data source
+     * the chart will have an internal query connect to the data source
      * and load the data as specified in {@link dataOptions}, {@link filters}, and {@link highlights}.
      *
      * OR
@@ -233,7 +242,7 @@ export interface BaseChartProps {
      * with user-provided data.
      *
      * If neither option is specified,
-     * the chart will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * the chart will use the `defaultDataSource` specified in the parent Sisense Context.
      *
      *
      * @category Data
@@ -493,6 +502,12 @@ export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource
      * @category Data
      */
     filtersMergeStrategy?: FiltersMergeStrategy;
+    /**
+     * {@inheritDoc ExecuteQueryByWidgetIdProps.includeDashboardFilters}
+     *
+     * @category Data
+     */
+    includeDashboardFilters?: boolean;
     /**
      * Title of the widget
      *
@@ -555,7 +570,7 @@ export interface ChartWidgetProps extends BaseChartEventProps {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
      *
      * @category Data
      */
@@ -599,7 +614,6 @@ export interface ChartWidgetProps extends BaseChartEventProps {
     /**
      * List of categories to allow drilldowns on
      *
-     * @deprecated Use {@link DrilldownWidget} instead
      * @category Widget
      */
     drilldownOptions?: DrilldownOptions;
@@ -646,7 +660,7 @@ export interface ChartWidgetProps extends BaseChartEventProps {
     /**
      * Boolean flag whether selecting data points triggers highlight filter of the selected data
      *
-     * Recommended to turn on when the ChartWidget is enhanced with data drilldown by {@link DrilldownWidget}
+     * Recommended to turn on when the Chart Widget component is enhanced with data drilldown by the Drilldown Widget component
      *
      * If not specified, the default value is `false`
      *
@@ -663,7 +677,7 @@ export interface TableWidgetProps {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
      *
      * @category Data
      */
@@ -738,7 +752,7 @@ export interface ExecuteQueryByWidgetIdProps {
     /** {@inheritDoc ExecuteQueryProps.offset} */
     offset?: number;
     /**
-     * Strategy for merging the existing widget filters with the filters provided via the `filters` prop:
+     * Strategy for merging the existing widget filters (including highlights) with the filters provided via the `filters` and `highlights` props:
      *
      * - `widgetFirst` - prioritizes the widget filters over the provided filters in case of filter conflicts by certain attributes.
      * - `codeFirst` - prioritizes the provided filters over the widget filters in case of filter conflicts by certain attributes.
@@ -747,12 +761,26 @@ export interface ExecuteQueryByWidgetIdProps {
      * If not specified, the default strategy is `codeFirst`.
      */
     filtersMergeStrategy?: FiltersMergeStrategy;
+    /**
+     * Boolean flag whether to include dashboard filters in the widget's `filters` and `highlights`
+     *
+     * If not specified, the default value is `false`.
+     */
+    includeDashboardFilters?: boolean;
     /** Function as child component that is called to render the query results */
     children?: (queryResult: QueryResultData, queryParams: ExecuteQueryParams) => ReactNode;
     /** Callback function that is evaluated when query results are ready */
     onDataChanged?: (data: QueryResultData, queryParams: ExecuteQueryParams) => void;
     /**
      * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
+     *
+     * **Note:** wrap this function in `useCallback` hook to avoid triggering query execution on each render.
+     * ```tsx
+     * const onBeforeQuery = useCallback((jaql) => {
+     *   // modify jaql here
+     *   return jaql;
+     * }, []);
+     * ```
      */
     onBeforeQuery?: (jaql: any) => any | Promise<any>;
 }
@@ -793,21 +821,21 @@ export interface SunburstChartProps extends BaseChartProps, ChartEventProps {
 /**
  * Props for {@link ContextMenu} component.
  */
-export type ContextMenuProps = {
+export interface ContextMenuProps {
     /**
-     * Position of the context menu
+     * Context menu position
      *
      * @category Widget
      */
     position?: MenuPosition | null;
     /**
-     * Callback function that is evaluated when context menu is closed
+     * Callback function that is evaluated when the context menu is closed
      *
      * @category Widget
      */
     closeContextMenu: () => void;
     /**
-     * Sections of menu items
+     * Menu item sections
      *
      * @category Widget
      */
@@ -818,8 +846,8 @@ export type ContextMenuProps = {
      * @category Widget
      */
     children?: React.ReactNode;
-};
-export type DrilldownBreadcrumbsProps = {
+}
+export interface DrilldownBreadcrumbsProps {
     /**
      * List of drilldown filters formatted to be displayed as breadcrumbs
      *
@@ -833,7 +861,7 @@ export type DrilldownBreadcrumbsProps = {
      */
     currentDimension: Attribute;
     /**
-     * Callback function that is evaluated when X button is clicked
+     * Callback function that is evaluated when the close (X) button is clicked
      *
      * @category Widget
      */
@@ -844,7 +872,7 @@ export type DrilldownBreadcrumbsProps = {
      * @category Widget
      */
     sliceDrilldownSelections: (i: number) => void;
-};
+}
 /**
  * An object that allows users to pass advanced configuration options as a prop for the {@link DrilldownWidget} component
  */
@@ -873,7 +901,7 @@ export type DrilldownWidgetConfig = {
 /**
  * Props for the {@link DrilldownWidget} component
  */
-export type DrilldownWidgetProps = {
+export interface DrilldownWidgetProps {
     /**
      * List of dimensions to allow drilldowns on
      *
@@ -900,4 +928,23 @@ export type DrilldownWidgetProps = {
      * @category Widget
      */
     children: (customDrilldownResult: CustomDrilldownResult) => ReactNode;
-};
+}
+/**
+ * Params of the {@link useGetSharedFormula} hook
+ *
+ * Can consist either of an oid or a name/dataSource pair
+ */
+export interface UseGetSharedFormulaParams extends HookEnableParam {
+    /**
+     * Formula identifier
+     */
+    oid?: string;
+    /**
+     * Formula name
+     */
+    name?: string;
+    /**
+     * Data source - e.g. `Sample ECommerce`
+     */
+    dataSource?: DataSource;
+}

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

@@ -1,8 +1,8 @@
 import { type Filter } from '@sisense/sdk-data';
-import { ExecuteQueryParams } from './index.js';
-import { QueryState } from './query-state-reducer.js';
-import { FiltersMergeStrategy } from '../dashboard-widget/types.js';
-import { ClientApplication } from '../app/client-application.js';
+import { ExecuteQueryParams } from './';
+import { QueryState } from './query-state-reducer';
+import { FiltersMergeStrategy } from '../dashboard-widget/types';
+import { ClientApplication } from '../app/client-application';
 /**
  * Parameters for {@link useExecuteQueryByWidgetId} hook.
  */
@@ -21,8 +21,16 @@ export interface ExecuteQueryByWidgetIdParams {
     offset?: number;
     /** {@inheritDoc ExecuteQueryByWidgetIdProps.filtersMergeStrategy} */
     filtersMergeStrategy?: FiltersMergeStrategy;
+    /** {@inheritDoc ExecuteQueryByWidgetIdProps.includeDashboardFilters} */
+    includeDashboardFilters?: boolean;
     /** {@inheritDoc ExecuteQueryByWidgetIdProps.onBeforeQuery} */
     onBeforeQuery?: (jaql: any) => any | Promise<any>;
+    /**
+     * Boolean flag to control if query is executed
+     *
+     * If not specified, the default value is `true`
+     */
+    enabled?: boolean;
 }
 export type QueryByWidgetIdState = QueryState & {
     /** Query parameters constructed over the widget */
@@ -57,6 +65,11 @@ export type QueryByWidgetIdState = QueryState & {
  * @returns Query state that contains the status of the query execution, the result data, the constructed query parameters, or the error if any occurred
  */
 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;
 /**
  * Checks if the parameters have changed by deep comparison.
  *
@@ -65,7 +78,7 @@ export declare const useExecuteQueryByWidgetId: (params: ExecuteQueryByWidgetIdP
  */
 export declare function isParamsChanged(prevParams: ExecuteQueryByWidgetIdParams | undefined, newParams: ExecuteQueryByWidgetIdParams): boolean;
 /** @internal */
-export declare function executeQueryByWidgetId({ widgetOid, dashboardOid, filters, highlights, filtersMergeStrategy, count, offset, app, onBeforeQuery, }: ExecuteQueryByWidgetIdParams & {
+export declare function executeQueryByWidgetId({ widgetOid, dashboardOid, filters, highlights, filtersMergeStrategy, count, offset, includeDashboardFilters, app, onBeforeQuery, }: ExecuteQueryByWidgetIdParams & {
     app: ClientApplication;
 }): Promise<{
     data: import("@sisense/sdk-data").QueryResultData;

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

@@ -3,11 +3,11 @@ import { QueryState } from './query-state-reducer';
 /**
  * Parameters for {@link useExecuteQuery} hook.
  */
-export type ExecuteQueryParams = {
+export interface ExecuteQueryParams {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
-     * If not specified, the query will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider} component.
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
      */
     dataSource?: DataSource;
     /** Dimensions of the query */
@@ -28,11 +28,9 @@ export type ExecuteQueryParams = {
      * If not specified, the default value is `true`
      */
     enabled?: boolean;
-    /**
-     * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
-     */
+    /** {@inheritDoc ExecuteQueryProps.onBeforeQuery} */
     onBeforeQuery?: (jaql: any) => any | Promise<any>;
-};
+}
 /**
  * React hook that executes a data query.
  * This approach, which offers an alternative to {@link ExecuteQuery} component, is similar to React Query's `useQuery` hook.
@@ -65,3 +63,9 @@ export type ExecuteQueryParams = {
  * @returns Query state that contains the status of the query execution, the result data, or the error if any occurred
  */
 export declare const useExecuteQuery: (params: ExecuteQueryParams) => QueryState;
+/**
+ * {@link useExecuteQuery} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @internal
+ */
+export declare function useExecuteQueryInternal(params: ExecuteQueryParams): QueryState;

package/dist/scatter-chart.d.ts

@@ -7,7 +7,7 @@ import { ScatterChartProps } from './props';
  * **Point**: A field that for each of its members a scatter point is drawn. The maximum amount of data points is 500.
  *
  * **Size**: An optional field represented by the size of the circles.
- * If omitted, all scatter points are equal in size. If used, the circle size is relative to their value.
+ * If omitted, all scatter points are equal in size. If used, the circle sizes are relative to their values.
  *
  * See [Scatter Chart](https://docs.sisense.com/main/SisenseLinux/scatter-chart.htm) for more information.
  *