@sisense/sdk-ui 1.7.2 → 1.9.0

package/dist/indicator-chart.d.ts

@@ -2,7 +2,6 @@
 import { IndicatorChartProps } from './props';
 /**
  * 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
  * An example of using the component to visualize the `Sample ECommerce` data source:

package/dist/line-chart.d.ts

@@ -2,26 +2,23 @@
 import { LineChartProps } from './props';
 /**
  * A React component displaying data as a series of points connected by a line. Used to show trends or changes over time.
- * See [Line Chart](https://docs.sisense.com/main/SisenseLinux/line-chart.htm) for more information.
  *
- * @example
- * An example of using the component to visualize the `Sample ECommerce` data source:
- * ```tsx
- * <LineChart
- *   dataSet={DM.DataSource}
- *   dataOptions={{
- *     category: [DM.Commerce.Date.Years],
- *     value: [measureFactory.sum(DM.Commerce.Revenue)],
- *     breakBy: [DM.Commerce.Gender],
- *   }}
- *   filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
- *   onDataPointClick= {(point, nativeEvent) => {
- *     console.log('clicked', point, nativeEvent);
- *   }}
+ * ## Example
+ *
+ * Line chart displaying total revenue per quarter from the Sample ECommerce data model.
+ *
+ * <iframe
+ *  src='https://csdk-playground.sisense.com/?example=charts%2Fline-chart&mode=docs'
+ *  width=800
+ *  height=870
+ *  style='border:none;'
  * />
- * ```
  *
- * <img src="media://line-chart-example-1.png" width="800px" />
+ * Additional Line Chart examples:
+ *
+ * - [Curved Line Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fline-chart-spline)
+ * - [Styled Line Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fline-chart-styled)
+ *
  * @param props - Line chart properties
  * @returns Line Chart component
  * @group Charts

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

@@ -1,3 +1,4 @@
-import { type DashboardDto } from '../../api/types/dashboard-dto';
-import { type DashboardModel } from './types';
+import type { DashboardDto, Layout as SisenseLayout } from '../../api/types/dashboard-dto';
+import type { Layout, DashboardModel } from './types';
+export declare const translateLayout: (layout: SisenseLayout) => Layout;
 export declare function translateDashboard({ oid, title, datasource, widgets, layout, }: DashboardDto): DashboardModel;

package/dist/models/dashboard/types.d.ts

@@ -1,20 +1,18 @@
 import { type DataSource } from '@sisense/sdk-data';
 import { WidgetModel } from '../widget/widget-model';
 /** @internal */
-export type Layout = {
+export interface Layout {
     columns: {
-        width: number;
+        widthPercentage: number;
         cells: {
             subcells: {
-                width: number;
-                elements: {
-                    height: number | string;
-                    widgetId: string;
-                }[];
+                widthPercentage: number;
+                height: number | string;
+                widgetId: string;
             }[];
         }[];
     }[];
-};
+}
 export type DashboardModel = {
     oid: string;
     title: string;

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

@@ -69,28 +69,23 @@ export type WidgetModelSuccessState = {
     status: 'success';
 };
 /**
- * React hook that retrieves an existing widget model from the Sisense instance.
+ * React hook that retrieves an existing widget model from a Fusion Embed instance.
+ *
+ * ## Example
+ *
+ * Retrieve a widget model and use it to populate a `Chart` component
+ *
+ * <iframe
+ *  src='https://csdk-playground.sisense.com/?example=fusion-assets%2Fuse-get-widget-model&mode=docs'
+ *  width=800
+ *  height=870
+ *  style='border:none;'
+ * />
+ *
+ * Additional `useGetWidgetModel` examples:
+ *
+ * - [Modify Chart Type](https://www.sisense.com/platform/compose-sdk/playground/?example=fusion-assets%2Fuse-get-widget-model-change-chart-type)
  *
- * @example
- * An example of retrieving an existing widget model from the Sisense instance:
- ```tsx
-  const { widget, isLoading, isError } = useGetWidgetModel({
-    dashboardOid: '6448665edac1920034bce7a8',
-    widgetOid: '6448665edac1920034bce7a8',
-  });
-  if (isLoading) {
-    return <div>Loading...</div>;
-  }
-  if (isError) {
-    return <div>Error</div>;
-  }
-  if (widget) {
-    return (
-      <Chart {...widget.getChartProps()} />
-    );
-  }
-  return null;
- ```
  * @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

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

@@ -1,13 +1,13 @@
 import { Filter } from '@sisense/sdk-data';
-import { ChartDataOptions, TableDataOptions } from '../../chart-data-options/types';
+import { ChartDataOptions, PivotTableDataOptions, TableDataOptions } from '../../chart-data-options/types';
 import { Panel, WidgetDto, WidgetType } from '../../dashboard-widget/types';
-import { ChartProps, ChartWidgetProps, TableProps, TableWidgetProps } from '../../props';
-import { ExecuteQueryParams } from '../../query-execution';
+import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps } from '../../props';
+import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
 import { ChartType, DrilldownOptions, ChartStyleOptions, TableStyleOptions, CompleteThemeSettings } from '../../types';
 /**
  * Widget data options.
  */
-export type WidgetDataOptions = ChartDataOptions | TableDataOptions;
+export type WidgetDataOptions = ChartDataOptions | TableDataOptions | PivotTableDataOptions;
 /**
  * Model of Sisense widget defined in the abstractions of Compose SDK.
  *
@@ -80,11 +80,26 @@ export declare class WidgetModel {
      * ```tsx
      * const {data, isLoading, isError} = useExecuteQuery(widget.getExecuteQueryParams());
      * ```
+     *
+     * Note: this method is not supported for getting pivot query.
+     * Use {@link getExecutePivotQueryParams} instead for getting query parameters for the pivot widget.
      */
     getExecuteQueryParams(): ExecuteQueryParams;
+    /**
+     * Returns the parameters to be used for executing a query for the pivot widget.
+     *
+     * @example
+     * ```tsx
+     * const {data, isLoading, isError} = useExecutePivotQuery(widget.getExecutePivotQueryParams());
+     * ```
+     *
+     * Note: this method is supported only for getting pivot query.
+     * Use {@link getExecuteQueryParams} instead for getting query parameters for non-pivot widgets.
+     */
+    getExecutePivotQueryParams(): ExecutePivotQueryParams;
     /**
      * Returns the props to be used for rendering a chart.
-  
+     *
      * @example
      * ```tsx
      * <Chart {...widget.getChartProps()} />
@@ -92,6 +107,7 @@ export declare class WidgetModel {
      *
      * Note: this method is not supported for tabular widgets.
      * Use {@link getTableProps} instead for getting props for the <Table> component.
+     * Use {@link getPivotTableProps} instead for getting props for the <PivotTable> component.
      */
     getChartProps(): ChartProps;
     /**
@@ -102,10 +118,24 @@ export declare class WidgetModel {
      * <Table {...widget.getTableProps()} />
      * ```
      *
-     * Note: this method is not supported for chart widgets.
+     * Note: this method is not supported for chart and pivot widgets.
      * Use {@link getChartProps} instead for getting props for the <Chart> component.
+     * Use {@link getPivotTableProps} instead for getting props for the <PivotTable> component.
      */
     getTableProps(): TableProps;
+    /**
+     * Returns the props to be used for rendering a pivot table.
+     *
+     * @example
+     * ```tsx
+     * <PivotTable {...widget.getPivotTableProps()} />
+     * ```
+     *
+     * Note: this method is not supported for chart or table widgets.
+     * Use {@link getChartProps} instead for getting props for the <Chart> component.
+     * Use {@link getTableProps} instead for getting props for the <Table> component.
+     */
+    getPivotTableProps(): PivotTableProps;
     /**
      * Returns the props to be used for rendering a chart widget.
      *
@@ -130,4 +160,18 @@ export declare class WidgetModel {
      * @internal
      */
     getTableWidgetProps(): TableWidgetProps;
+    /**
+     * Returns the props to be used for rendering a pivot table widget.
+     *
+     * @example
+     * ```tsx
+     * <PivotTableWidget {...widget.getPivotTableWidgetProps()} />
+     * ```
+  
+     * 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.
+     * @internal
+     */
+    getPivotTableWidgetProps(): PivotTableWidgetProps;
 }

package/dist/pie-chart.d.ts

@@ -3,25 +3,23 @@ import { PieChartProps } from './props';
 /**
  * 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.
  *
- * @example
- * An example of using the component to visualize the `Sample ECommerce` data source:
- * ```tsx
- * <PieChart
- *   dataSet={DM.DataSource}
- *   dataOptions={{
- *     category: [DM.Commerce.AgeRange],
- *     value: [measureFactory.sum(DM.Commerce.Revenue)],
- *   }}
- *   filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
- *   onDataPointClick= {(point, nativeEvent) => {
- *     console.log('clicked', point, nativeEvent);
- *   }}
+ * ## Example
+ *
+ * Pie chart displaying total revenue per age range from the Sample ECommerce data model.
+ *
+ * <iframe
+ *  src='https://csdk-playground.sisense.com/?example=charts%2Fpie-chart&mode=docs'
+ *  width=800
+ *  height=870
+ *  style='border:none;'
  * />
- * ```
  *
- * <img src="media://pie-chart-example-1.png" width="600px" />
+ * Additional Pie Chart examples:
+ *
+ * - [Donut Pie Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fpie-chart-donut)
+ * - [Ring Pie Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fpie-chart-ring)
+ *
  * @param props - Pie chart properties
  * @returns Pie Chart component
  * @group Charts

package/dist/pivot-table/helpers/prepare-pivot-styling-props.d.ts

@@ -0,0 +1,20 @@
+import { CompleteThemeSettings, PivotTableStyleOptions } from '../../types';
+export declare function preparePivotStylingProps(styleOptions?: PivotTableStyleOptions, themeSettings?: CompleteThemeSettings): {
+    fontFamily: string | undefined;
+    textColor: string | undefined;
+    backgroundColor: string | undefined;
+    borderColor: string;
+    fillColor: string | undefined;
+    additionalFillColor: string | undefined;
+    fillOptions: {
+        alternatingRows: boolean | undefined;
+        alternatingColumns: boolean | undefined;
+        columnsHeaders: boolean | undefined;
+        rowMembers: boolean | undefined;
+        totals: boolean | undefined;
+    };
+    rowHeight: number | undefined;
+    isAutoHeight: boolean;
+    navigationPrimaryColor: string | undefined;
+    navigationSecondaryColor: string | undefined;
+};

package/dist/pivot-table/pivot-table.d.ts

@@ -1,9 +1,7 @@
 import React from 'react';
 import { PivotTableProps } from '../props';
 /**
- * Pivot Table with pagination.
- *
- * See [Pivot Tables](https://docs.sisense.com/main/SisenseLinux/pivot.htm) for more information.
+ * Pivot table with pagination.
  *
  * @example
  * (1) Example of PivotTable from the `Sample ECommerce` data model:
@@ -35,6 +33,48 @@ import { PivotTableProps } from '../props';
  *   styleOptions={{ width: 1000, height: 600, rowsPerPage: 50 }}
  * />
  * ```
+ *
+ * (2) Example of PivotTable with the predefined sorting configuration:
+ * - Sort "Condition" row by its values in Ascending order. This is equivalent to users clicking on the "Condition" row heading and hit Sort Ascending (A-Z)
+ * - Sort "Category" row by "Total Cost" values under the "columns" values of "Female" (for Gender) and "0-18" (for AgeRange) in Descending order.
+ * This is equivalent to users clicking on the "Total Cost" value heading under "Female" (for Gender) and "0-18" (for AgeRange) and sort "Category (Subtotals)" in Descending (9-1)
+ *
+ * ```tsx
+ * <PivotTable
+ *   dataSet={DM.DataSource}
+ *   dataOptions={{
+ *     rows: [
+ *       {
+ *         column: DM.Category.Category,
+ *         includeSubTotals: true,
+ *         sortType: {
+ *           direction: 'sortDesc',
+ *           by: {
+ *             valuesIndex: 0,
+ *             columnsMembersPath: ['Female', '0-18']
+ *           }
+ *         }
+ *       },
+ *       {
+ *         column: DM.Commerce.Condition,
+ *         sortType: {
+ *           direction: 'sortAsc'
+ *         }
+ *       },
+ *     ],
+ *     columns: [
+ *       DM.Commerce.Gender,
+ *       DM.Commerce.AgeRange
+ *     ],
+ *     values: [
+ *       measureFactory.sum(DM.Commerce.Cost, 'Total Cost'),
+ *       measureFactory.sum(DM.Commerce.Quantity, 'Total Quantity'),
+ *     ],
+ *   }}
+ * />
+ * ```
+ *
+ * <img src="media://pivot-sorting-example-1.png" width="800px" />
  * @param props - Pivot Table properties
  * @returns Pivot Table component
  * @group Data Grids

package/dist/pivot-table/sorting-utils.d.ts

@@ -1,56 +1,12 @@
-/**
- * This file contain sorting functionality ported from the existing Analytics.
- * It directly works with pivot JAQL to apply sorting.
- *
- * It will be fully refactored soon by using a different approach of applying sorting on Pivot internal data options.
- */
-import { JaqlRequest, type SortingSettingsChangePayload } from '@sisense/sdk-pivot-client';
-export declare function normalizeJaqlSorting(jaql: JaqlRequest): {
-    metadata: (import("@sisense/sdk-pivot-client").JaqlPanel | {
-        jaql: {
-            sortDetails: {
-                initialized: boolean;
-                field: any;
-                dir: any;
-                measurePath: null;
-                sortingLastDimension: any;
-            };
-            title: string;
-            dim: string;
-            datatype: string;
-            sort?: string | null | undefined;
-            type?: string | undefined;
-            table?: string | undefined;
-            column?: string | undefined;
-        };
-        panel: string;
-        field?: {
-            id?: string | undefined;
-            index?: number | undefined;
-        } | undefined;
-        disabled?: boolean | undefined;
-        hierarchies?: string[] | undefined;
-        format?: {
-            subtotal?: boolean | undefined;
-            width?: number | undefined;
-            databars?: boolean | undefined;
-            color?: {
-                type: string;
-                color?: string | undefined;
-                conditions?: {
-                    color: string;
-                    operator: string;
-                    expression: string | Record<string, any>;
-                }[] | undefined;
-            } | undefined;
-        } | undefined;
-    })[];
-    datasource?: import("@sisense/sdk-pivot-client/dist/data-load/types").JaqlDatasource | undefined;
-    queryGuid?: string | undefined;
-    grandTotals?: {
-        title: string;
-        columns?: boolean | undefined;
-        rows?: boolean | undefined;
-    } | null | undefined;
+import { type SortingSettingsChangePayload } from '@sisense/sdk-pivot-client';
+import { PivotTableDataOptionsInternal } from '..';
+import type { SortDirection, PivotRowsSort } from '../types';
+export type PivotRowsSortCriteria = {
+    rowIndex: number;
+    sort: PivotRowsSort | null;
 };
-export declare function prepareSortedJaql(jaql: JaqlRequest, { type, settings, sortDetails, isSingleRowTree }: SortingSettingsChangePayload): JaqlRequest;
+export type PivotSortCriteria = {
+    rows: PivotRowsSortCriteria[];
+};
+export declare function normalizePivotSort(sortType: SortDirection | PivotRowsSort): PivotRowsSort;
+export declare function preparePivotRowsSortCriteriaList({ type, settings, sortDetails }: SortingSettingsChangePayload, dataOptionsInternal: PivotTableDataOptionsInternal): PivotRowsSortCriteria[];

package/dist/pivot-table/use-get-pivot-table-query.d.ts

@@ -1,11 +1,19 @@
-import { PivotTableProps } from '../props';
 import { type JaqlRequest } from '@sisense/sdk-pivot-client';
+import type { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
+import { ExecutePivotQueryParams } from '../query-execution';
+import { PivotTableDataOptionsInternal } from '../chart-data-options/types';
+export declare const getPivotQueryOptions: (dataOptions: PivotTableDataOptionsInternal) => Pick<ExecutePivotQueryParams, 'rows' | 'columns' | 'values' | 'grandTotals'>;
 /**
  * A hook that returns the JAQL request object from pivot table props.
  *
  * @internal
  */
-export declare const useGetPivotTableQuery: ({ dataSet, dataOptions, filters }: PivotTableProps) => {
+export declare const useGetPivotTableQuery: ({ dataSet, dataOptionsInternal, filters, refreshCounter, }: {
+    dataSet?: DataSource | undefined;
+    dataOptionsInternal: PivotTableDataOptionsInternal;
+    filters?: Filter[] | FilterRelations | undefined;
+    refreshCounter?: number | undefined;
+}) => {
     isLoading: boolean;
     isSuccess: boolean;
     isError: boolean;

package/dist/pivot-table/use-pivot-table-data-options-internal.d.ts

@@ -0,0 +1,15 @@
+import { PivotTableDataOptions, PivotTableDataOptionsInternal } from '../chart-data-options/types.js';
+import { PivotSortCriteria } from './sorting-utils.js';
+type UsePivotTableDataOptionsInternalResult = {
+    dataOptionsInternal: PivotTableDataOptionsInternal;
+    updateSort: (sortCriteria: PivotSortCriteria) => void;
+};
+/**
+ * A hook that returns the JAQL request object from pivot table props.
+ *
+ * @internal
+ */
+export declare const usePivotTableDataOptionsInternal: ({ dataOptions, }: {
+    dataOptions: PivotTableDataOptions;
+}) => UsePivotTableDataOptionsInternalResult;
+export {};

package/dist/polar-chart.d.ts

@@ -2,26 +2,23 @@
 import { PolarChartProps } from './props';
 /**
  * A React component comparing multiple categories/variables with a spacial perspective in a radial chart.
- * See [Polar Chart](https://docs.sisense.com/main/SisenseLinux/polar-chart.htm) for more information.
  *
- * @example
- * An example of using the component to visualize the `Sample ECommerce` data source:
- * ```tsx
- * <PolarChart
- *   dataSet={DM.DataSource}
- *   dataOptions={{
- *     category: [DM.Commerce.AgeRange],
- *     value: [measureFactory.sum(DM.Commerce.Revenue)],
- *     breakBy: [DM.Commerce.Gender],
- *   }}
- *   filters={[filterFactory.greaterThan(DM.Commerce.Revenue, 1000)]}
- *   onDataPointClick= {(point, nativeEvent) => {
- *     console.log('clicked', point, nativeEvent);
- *   }}
+ * ## Example
+ *
+ * Polar chart displaying total revenue per age range from the Sample ECommerce data model.
+ *
+ * <iframe
+ *  src='https://csdk-playground.sisense.com/?example=charts%2Fpolar-chart&mode=docs'
+ *  width=800
+ *  height=870
+ *  style='border:none;'
  * />
- * ```
  *
- * <img src="media://polar-chart-example-1.png" width="600px" />
+ * Additional Polar Chart examples:
+ *
+ * - [Area Polar Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fpolar-chart-area)
+ * - [Line Polar Chart](https://www.sisense.com/platform/compose-sdk/playground/?example=charts%2Fpolar-chart-line)
+ *
  * @param props - Polar chart properties
  * @returns Polar Chart component
  * @group Charts

package/dist/props.d.ts

@@ -1,5 +1,5 @@
 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, ScattermapDataPoint, PivotTableStyleOptions } from './types';
+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, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions } 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, PivotTableDataOptions } from './chart-data-options/types';
@@ -10,7 +10,13 @@ import { HookEnableParam } from './common/hooks/types';
 import { ExecuteQueryResult } from './query-execution/types';
 export type { MenuItemSection, HighchartsOptions };
 /**
- * Configurations for Sisense Context
+ * Configurations and authentication for Sisense Context.
+ *
+ * Use one of the following to authenticate:
+ *
+ * - {@link ssoEnabled}
+ * - {@link token}
+ * - {@link wat}
  */
 export interface SisenseContextProviderProps {
     /**
@@ -20,10 +26,9 @@ export interface SisenseContextProviderProps {
     /** URL of the Sisense environment the app connects to */
     url: string;
     /**
-     * [Single Sign-On](https://docs.sisense.com/main/SisenseLinux/using-single-sign-on-to-access-sisense.htm) toggle
+     * [Single Sign-On](https://docs.sisense.com/main/SisenseLinux/using-single-sign-on-to-access-sisense.htm) toggle.
      *
-     * This is used when user wants to use sso authentication. Default is false.
-     * If set to true, this will override any other authentication method.
+     * Set to `true` to use SSO authentication. When `true`, this overrides any other authentication methods. Defaults to `false`.
      *
      * @category Authentication
      */
@@ -31,16 +36,12 @@ export interface SisenseContextProviderProps {
     /**
      * Token for [bearer authentication](https://sisense.dev/guides/restApi/using-rest-api.html).
      *
-     * This is used only when basic username/password authentication is not specified.
-     *
      * @category Authentication
      */
     token?: string;
     /**
      * [Web Access Token](https://docs.sisense.com/main/SisenseLinux/using-web-access-token.htm).
      *
-     * This is used only when neither username, password, and token is specified.
-     *
      * @category Authentication
      */
     wat?: string;
@@ -111,13 +112,12 @@ export interface ExecuteQueryProps {
  *
  * Two options are supported:
  *
- * (1) `ThemeOid` -- Theme identifier as defined in the Sisense application (`Admin page` > `Look and Feel`).
- * See [Sisense documentation](https://docs.sisense.com/main/SisenseLinux/customizing-the-sisense-user-interface.htm)
- * for more details.
+ * (1) `ThemeSettings` -- Custom theme settings that override the default theme settings.
  *
  * OR
  *
- * (2) `ThemeSettings` -- Custom theme settings that override the default theme settings.
+ * (2) `ThemeOid` -- Theme identifier as defined in a Fusion Embed instance (**Admin > App Configuration > Look and Feel**).
+ * See [Customizing the Sisense User Interface](https://docs.sisense.com/main/SisenseLinux/customizing-the-sisense-user-interface.htm) for more details.
  */
 export type ThemeProviderProps = PropsWithChildren<{
     /**
@@ -958,6 +958,65 @@ export interface TableWidgetProps {
      */
     description?: string;
 }
+/**
+ * Props for the {@link PivotTableWidget} component
+ *
+ * @internal
+ */
+export interface PivotTableWidgetProps {
+    /**
+     * Data source the query is run against - e.g. `Sample ECommerce`
+     *
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
+     *
+     * @category Data
+     */
+    dataSource?: DataSource;
+    /**
+     * Filters that will slice query results
+     *
+     * @category Data
+     */
+    filters?: Filter[] | FilterRelations;
+    /**
+     * Configurations for how to interpret and present the data passed to the table
+     *
+     * @category Chart
+     */
+    dataOptions: PivotTableDataOptions;
+    /**
+     * Style options for both the table and widget including the widget header
+     *
+     * @category Widget
+     */
+    styleOptions?: PivotTableWidgetStyleOptions;
+    /**
+     * React nodes to be rendered at the top of component, before the table
+     *
+     * @category Widget
+     * @internal
+     */
+    topSlot?: ReactNode;
+    /**
+     * React nodes to be rendered at the bottom of component, after the table
+     *
+     * @category Widget
+     * @internal
+     */
+    bottomSlot?: ReactNode;
+    /**
+     * Title of the widget
+     *
+     * @category Widget
+     */
+    title?: string;
+    /**
+     *  Description of the widget
+     *
+     * @category Widget
+     */
+    description?: string;
+}
 /**
  * Props for {@link ExecuteQueryByWidgetId} component.
  *