@sisense/sdk-ui 1.20.0 → 1.21.0

package/dist/packages/sdk-ui/src/dashboard/dashboard-helpers.d.ts

@@ -0,0 +1,14 @@
+import { Filter } from '@sisense/sdk-data';
+import { DashboardProps } from './types';
+/**
+ * Utility functions to manipulate DashboardProps.
+ *
+ * @group Dashboards
+ */
+export declare const DashboardHelpers: {
+    replaceFilters: (dashboard: DashboardProps, newFilters: Filter[]) => DashboardProps;
+    modifyFilter: (dashboard: DashboardProps, filterToModify: Filter, newFilter: Filter) => DashboardProps;
+    removeFilter: (dashboard: DashboardProps, filter: Filter) => DashboardProps;
+    addFilter: (dashboard: DashboardProps, newFilter: Filter) => DashboardProps;
+    addFilters: (dashboard: DashboardProps, newFilters: Filter[]) => DashboardProps;
+};

package/dist/packages/sdk-ui/src/dashboard/dashboard.d.ts

@@ -30,7 +30,11 @@ const CodeExample = () => {
 
 export default CodeExample;
  * ```
- * @group Dashboarding
+ *
+ * To learn more about this and related dashboard components,
+ * see [Embedded Dashboards](/guides/sdk/guides/dashboards/index.html).
+ *
+ * @group Dashboards
  * @beta
  */
 export declare const Dashboard: import("react").FunctionComponent<DashboardProps>;

package/dist/packages/sdk-ui/src/dashboard/index.d.ts

@@ -1,3 +1,4 @@
 export { DashboardById } from './dashboard-by-id';
 export { Dashboard } from './dashboard';
 export type { DashboardByIdProps, DashboardProps, DashboardLayoutOptions, DashboardStyleOptions, DashboardConfig, } from './types';
+export { DashboardHelpers } from './dashboard-helpers';

package/dist/packages/sdk-ui/src/dashboard-widget/translate-widget-data-options.d.ts

@@ -17,7 +17,7 @@ export declare function applyStatisticalModels(dataOption: StyledMeasureColumn,
         trendType: string;
     };
 }): StyledMeasureColumn;
-export declare function createDataColumn(item: PanelItem, customPaletteColors?: Color[]): StyledMeasureColumn | StyledColumn;
+export declare function createDataColumn(item: PanelItem, customPaletteColors?: Color[]): StyledColumn | StyledMeasureColumn;
 /** @internal */
 export declare const createDataOptionsFromPanels: (panels: Panel[], variantColors: Color[]) => {
     [key: string]: any[];

package/dist/packages/sdk-ui/src/dashboard-widget/types.d.ts

@@ -95,7 +95,7 @@ export interface HierarchyDto {
     levels: BaseJaql[];
 }
 /**
- * @description the scroll location of the navigator scroller / auto zoom feature
+ * The scroll location of the navigator scroller / auto zoom feature
  */
 export type AutoZoomNavigatorScrollerLocation = {
     min: number;

package/dist/packages/sdk-ui/src/decorators/hook-decorators/with-tracking.d.ts

@@ -1,12 +1,12 @@
 import { ClientApplication } from '../../app/client-application';
 export type HookDecorator<DecoratorConfig> = (decoratorConfig: DecoratorConfig) => <HookArgs extends any[], HookResult>(hook: (...args: HookArgs) => HookResult) => (...args: HookArgs) => HookResult;
 /**
- * @internal
- * @description This is a function that tracks the hook event and sends it to the server.
+ * Tracks the hook event and sends it to the server.
  * @param hookName - The name of the hook
  * @param packageName - The name of the package
  * @param app - The client application
  * @param onFinally - The function to call after the tracking is done
+ * @internal
  */
 export declare const trackHook: (hookName: string, packageName: string, app: ClientApplication, onFinally: () => void) => void;
 export declare const withTracking: HookDecorator<string>;

package/dist/packages/sdk-ui/src/filters/components/criteria-filter-tile/criteria-filter-tile.d.ts

@@ -26,7 +26,7 @@ export interface CriteriaFilterTileProps {
 export type CriteriaFilterType = NumericFilter | TextFilter | RankingFilter | ExcludeFilter;
 /**
  * UI component that allows the user to filter numeric or text attributes according to
- * a number of built-in operations defined in the {@link NumericFilter}, {@link TextFilter}, or {@link RankingFilter}.
+ * a number of built-in operations defined in the numeric filter, text filter, or ranking filter.
  *
  * The arrangement prop determines whether the filter is rendered vertically or horizontally, with the latter intended for toolbar use and omitting title, enable/disable, and collapse/expand functionality.
  *

package/dist/packages/sdk-ui/src/filters/components/unsupported-filter-tile.d.ts

@@ -0,0 +1,12 @@
+import { FilterTileDesignOptions } from '../../filters/components/filter-tile';
+import { Filter } from '@sisense/sdk-data';
+export type UnsupportedFilterTileProps = {
+    filter: Filter;
+    design?: FilterTileDesignOptions;
+};
+/**
+ * Filter tile component that renders an unsupported filter (which is not recognized by the JAQL to Filter translation)
+ *
+ * @internal
+ */
+export declare const UnsupportedFilterTile: ({ filter, design }: UnsupportedFilterTileProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/formulas/use-get-shared-formula.d.ts

@@ -83,8 +83,6 @@ export type SharedFormulaSuccessState = {
     ```tsx
     const { formula, isLoading, isError } = useGetSharedFormula({ name: 'My Shared Formula', datasource: DM.DataSource })
     ```
- * @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
@@ -93,6 +91,7 @@ export declare const useGetSharedFormula: (params: UseGetSharedFormulaParams) =>
 /**
  * {@link useGetSharedFormula} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - {@link UseGetSharedFormulaParams}
  * @internal
  */
 export declare function useGetSharedFormulaInternal(params: UseGetSharedFormulaParams): SharedFormulaState;

package/dist/packages/sdk-ui/src/models/dashboard/get-dashboard-model.d.ts

@@ -12,8 +12,6 @@ export interface GetDashboardModelOptions {
      * Boolean flag whether to include filters in the dashboard model
      *
      * If not specified, the default value is `false`
-     *
-     * @internal
      */
     includeFilters?: boolean;
 }

package/dist/packages/sdk-ui/src/models/dashboard/use-get-dashboard-model.d.ts

@@ -96,7 +96,6 @@ export type DashboardModelSuccessState = {
   }
   return null;
  ```
- * @param params - Parameters of the dashboard to be retrieved
  * @returns Dashboard load state that contains the status of the execution, the result dashboard model, or the error if any
  * @group Fusion Embed
  * @fusionEmbed
@@ -105,6 +104,8 @@ export declare const useGetDashboardModel: (params: GetDashboardModelParams) =>
 /**
  * {@link useGetDashboardModel} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the dashboard to be retrieved
+ *
  * @internal
  */
 export declare function useGetDashboardModelInternal(params: GetDashboardModelParams): DashboardModelState;

package/dist/packages/sdk-ui/src/models/dashboard/use-get-dashboard-models.d.ts

@@ -81,7 +81,6 @@ export type DashboardModelsSuccessState = {
   }
   return null;
  ```
- * @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
  * @group Fusion Embed
  * @fusionEmbed
@@ -90,6 +89,7 @@ export declare const useGetDashboardModels: (params?: GetDashboardModelsParams |
 /**
  * {@link useGetDashboardModels} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the dashboards to be retrieved
  * @internal
  */
 export declare function useGetDashboardModelsInternal(params?: GetDashboardModelsParams): DashboardModelsState;

package/dist/packages/sdk-ui/src/models/hierarchy/use-get-hierarchy-models.d.ts

@@ -83,7 +83,6 @@ export type HierarchyModelsSuccessState = {
   }
   return null;
  ```
- * @param params - Parameters of the hierarchies to be retrieved
  * @returns Load state that contains the status of the execution, the result hierarchy models, or the error if one has occurred
  * @group Fusion Embed
  * @fusionEmbed
@@ -92,6 +91,7 @@ export declare const useGetHierarchyModels: (params: GetHierarchiesParams) => Hi
 /**
  * {@link useGetHierarchyModels} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the hierarchies to be retrieved
  * @internal
  */
 export declare function useGetHierarchyModelsInternal(params: GetHierarchiesParams): HierarchyModelsState;

package/dist/packages/sdk-ui/src/models/widget/use-get-widget-model.d.ts

@@ -88,7 +88,6 @@ export type WidgetModelSuccessState = {
  *
  * - [Modify Chart Type](https://www.sisense.com/platform/compose-sdk/playground/?example=fusion-assets%2Fuse-get-widget-model-change-chart-type)
  *
- * @param params - Parameters of the widget to be retrieved
  * @returns Widget load state that contains the status of the execution, the result widget model, or the error if one has occurred
  * @group Fusion Embed
  * @fusionEmbed
@@ -97,6 +96,7 @@ export declare const useGetWidgetModel: (params: GetWidgetModelParams) => Widget
 /**
  * {@link useGetWidgetModel} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the widget to be retrieved
  * @internal
  */
 export declare function useGetWidgetModelInternal(params: GetWidgetModelParams): WidgetModelState;

package/dist/packages/sdk-ui/src/models/widget/widget-model-translator.d.ts

@@ -100,7 +100,6 @@ export declare function toTableWidgetProps(widgetModel: WidgetModel): TableWidge
 
  * Note: this method is not supported for chart or table widgets.
  * Use {@link toChartWidgetProps} instead for getting props for the <ChartWidget> component.
- * Use {@link toTableWidgetProps} instead for getting props for the <TableWidget> component.
  */
 export declare function toPivotTableWidgetProps(widgetModel: WidgetModel): PivotTableWidgetProps;
 /**

package/dist/packages/sdk-ui/src/models/widget/widget-model.d.ts

@@ -171,9 +171,7 @@ export interface WidgetModel {
   
      * Note: this method is not supported for chart or table widgets.
      * Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
-     * Use {@link getTableWidgetProps} instead for getting props for the <TableWidget> component.
      * @deprecated Use {@link widgetModelTranslator.toPivotTableWidgetProps} instead
-     * @internal
      */
     getPivotTableWidgetProps(): PivotTableWidgetProps;
     /**

package/dist/packages/sdk-ui/src/plugins-provider/types.d.ts

@@ -6,10 +6,10 @@ import { GenericDataOptions } from '../types';
  *
  * @alpha
  */
-export interface PluginComponentProps {
+export interface PluginComponentProps<DataOptions = GenericDataOptions, StyleOptions = any> {
     dataSource?: DataSource;
-    dataOptions: GenericDataOptions;
-    styleOptions: any;
+    dataOptions: DataOptions;
+    styleOptions: StyleOptions;
     filters?: Filter[];
     highlights?: Filter[];
 }
@@ -19,4 +19,4 @@ export interface PluginComponentProps {
  *
  * @alpha
  */
-export type PluginComponent = (props: PluginComponentProps) => ReactNode;
+export type PluginComponent<DataOptions = GenericDataOptions, StyleOptions = any> = (props: PluginComponentProps<DataOptions, StyleOptions>) => ReactNode;

package/dist/packages/sdk-ui/src/plugins-provider/use-execute-plugin-query.d.ts

@@ -4,7 +4,7 @@ import { PluginComponentProps } from './types';
 /**
  * Utility function for converting data options to parameters for executing a query.
  *
- * @group Dashboarding
+ * @group Dashboards
  * @alpha
  */
 export declare function extractDimensionsAndMeasures(dataOptions: GenericDataOptions): {
@@ -14,7 +14,7 @@ export declare function extractDimensionsAndMeasures(dataOptions: GenericDataOpt
 /**
  * React hook that takes a plugin component's props and executes a data query.
  *
- * @group Dashboarding
+ * @group Dashboards
  * @alpha
  */
 export declare function useExecutePluginQuery({ dataSource, dataOptions, filters, highlights, }: PluginComponentProps): {

package/dist/packages/sdk-ui/src/props.d.ts

@@ -378,7 +378,7 @@ interface BoxplotChartEventProps extends HighchartsBasedChartEventProps {
 export interface BaseChartProps {
     /**
      * Data set for a chart using one of the following options. If neither option is specified, the chart
-     * will use the `defaultDataSource` specified in the parent {@link SisenseContextProvider}
+     * will use the `defaultDataSource` specified in the parent `SisenseContextProvider`
      * component.
      *
      *
@@ -386,7 +386,7 @@ export interface BaseChartProps {
      * retrieve the data source name from a data model you create using the `get-data-model`
      * {@link https://sisense.dev/guides/sdk/guides/cli.html | command} of the Compose SDK CLI. Under the hood, the chart
      * connects to the data source, executes a query, and loads the data as specified in
-     * {@link dataOptions}, {@link filters}, and {@link highlights}.
+     * `dataOptions`, `filters`, and `highlights`.
      *
      * To learn more about using data from a Sisense data source, see the
      * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#sisense-data).
@@ -446,7 +446,7 @@ export interface BaseChartProps {
      * Highlights based on filter criteria to apply to a chart using one of the following options.
      *
      * NOTE that the filter dimensions used in highlights must match those defined in the
-     * {@link dataOptions} of the chart. Otherwise, the filters will be applied as regular slice filters.
+     * `dataOptions` of the chart. Otherwise, the filters will be applied as regular slice filters.
      *
      * (1) Array of {@link Filter} returned from filter factory functions, such as
      * {@link @sisense/sdk-data!filterFactory.greaterThan | `greaterThan()`} and {@link @sisense/sdk-data!filterFactory.members | `members()`}.

package/dist/packages/sdk-ui/src/query-execution/use-execute-csv-query.d.ts

@@ -68,7 +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
  * @group Queries
  */
@@ -76,6 +75,7 @@ export declare const useExecuteCsvQuery: (params: ExecuteCsvQueryParams) => CsvQ
 /**
  * {@link useExecuteQuery} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the query
  * @internal
  */
 export declare function useExecuteCsvQueryInternal(params: ExecuteCsvQueryParams): CsvQueryState;

package/dist/packages/sdk-ui/src/query-execution/use-execute-pivot-query.d.ts

@@ -14,7 +14,6 @@ import { ExecutePivotQueryParams, PivotQueryState } from './types';
  *  style='border:none;'
  * />
  *
- * @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
  * @group Queries
  * @beta
@@ -23,6 +22,7 @@ export declare const useExecutePivotQuery: (params: ExecutePivotQueryParams) =>
 /**
  * {@link useExecutePivotQuery} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the query
  * @internal
  */
 export declare function useExecutePivotQueryInternal(params: ExecutePivotQueryParams): PivotQueryState;

package/dist/packages/sdk-ui/src/query-execution/use-execute-query-by-widget-id.d.ts

@@ -27,7 +27,6 @@ import { QueryResultData } from '@sisense/sdk-data';
   return null;
  ```
  * See also hook {@link useExecuteQuery}, which execute a query specified in code.
- * @param params - Parameters to identify the target widget
  * @returns Query state that contains the status of the query execution, the result data, the constructed query parameters, or the error if any occurred
  * @group Fusion Embed
  * @fusionEmbed
@@ -36,6 +35,7 @@ export declare const useExecuteQueryByWidgetId: (params: ExecuteQueryByWidgetIdP
 /**
  * {@link useExecuteQueryByWidgetId} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters to identify the target widget
  * @internal
  */
 export declare function useExecuteQueryByWidgetIdInternal(params: ExecuteQueryByWidgetIdParams): QueryByWidgetIdState;

package/dist/packages/sdk-ui/src/query-execution/use-execute-query.d.ts

@@ -20,7 +20,6 @@ import { ExecuteQueryParams, ExecuteQueryResult } from './types';
  * - [Query with Sorting](https://www.sisense.com/platform/compose-sdk/playground/?example=queries%2Fuse-execute-query-sorting)
  * - [Take Control of Your Data Visualizations]( https://www.sisense.com/blog/take-control-of-your-data-visualizations/) blog post with examples of using the hook to fetch data to display in third-party charts.
  *
- * @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
  * @group Queries
  */
@@ -28,6 +27,7 @@ export declare const useExecuteQuery: (params: ExecuteQueryParams) => ExecuteQue
 /**
  * {@link useExecuteQuery} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the query
  * @internal
  */
 export declare function useExecuteQueryInternal(params: ExecuteQueryParams): ExecuteQueryResult;

package/dist/packages/sdk-ui/src/translation/resources/en.d.ts

@@ -117,10 +117,7 @@ export declare const translation: {
             max: string;
         };
     };
-    unsupportedFilter: {
-        title: string;
-        message: string;
-    };
+    unsupportedFilterMessage: string;
     commonFilter: {
         clearSelectionButton: string;
         selectMenuItem: string;

package/dist/packages/sdk-ui/src/translation/resources/index.d.ts

@@ -121,10 +121,7 @@ export declare const resources: {
                 max: string;
             };
         };
-        unsupportedFilter: {
-            title: string;
-            message: string;
-        };
+        unsupportedFilterMessage: string;
         commonFilter: {
             clearSelectionButton: string;
             selectMenuItem: string;
@@ -255,10 +252,7 @@ export declare const resources: {
                 max: string;
             };
         };
-        unsupportedFilter: {
-            title: string;
-            message: string;
-        };
+        unsupportedFilterMessage: string;
         commonFilter: {
             clearSelectionButton: string;
             selectMenuItem: string;

package/dist/packages/sdk-ui/src/widgets/chart-widget.d.ts

@@ -22,6 +22,6 @@ import { ChartWidgetProps } from '../props';
  * <img src="media://chart-widget-with-drilldown-example-1.png" width="800px" />
  * @param props - ChartWidget properties
  * @returns ChartWidget component representing a chart type as specified in `ChartWidgetProps.`{@link ChartWidgetProps.chartType | chartType}
- * @group Dashboarding
+ * @group Dashboards
  */
 export declare const ChartWidget: FunctionComponent<ChartWidgetProps>;

package/dist/packages/sdk-ui/src/widgets/pivot-table-widget.d.ts

@@ -17,7 +17,7 @@ import { PivotTableWidgetProps } from '../props';
  * ```
  * @param props - Pivot Table Widget properties
  * @returns Widget component representing a pivot table
- * @group Dashboarding
+ * @group Dashboards
  * @beta
  */
 export declare const PivotTableWidget: FunctionComponent<PivotTableWidgetProps>;