@sisense/sdk-ui 1.13.0 → 1.14.0

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

@@ -2,4 +2,4 @@ import { type Column } from '@sisense/sdk-data';
 import { type PivotTableDataOptions, type StyledColumn, type AnyColumn } from '../../chart-data-options/types';
 export declare const getPivotDataOptionByJaqlIndex: (dataOptions: PivotTableDataOptions, dataOptionIndex?: number) => AnyColumn | undefined;
 export declare const getNumberFormatConfig: (dataOption?: AnyColumn) => Required<import("../..").NumberFormatConfig>;
-export declare const getDateFormatConfig: (dataOption: Column | StyledColumn) => string;
+export declare const getDateFormatConfig: (dataOption: Column | StyledColumn) => string | undefined;

package/dist/props.d.ts

@@ -388,21 +388,21 @@ export interface BaseChartProps {
      */
     dataSet?: DataSource | Data;
     /**
-     * Filters to apply to a chart’s data using one of the following options.
+     * Filters to limit (or slice) a chart’s data using one of the following options.
      *
-     * (1) Array of filters returned from filter factory functions, such as
+     * (1) Array of {@link Filter} or {@link FilterRelations} returned from filter factory functions, such as
      * {@link @sisense/sdk-data!filterFactory.greaterThan | `greaterThan()`} and {@link @sisense/sdk-data!filterFactory.members | `members()`}.
      *
      * Use this option for filters that do not require a UI to set them
-     * or for filters where you will supply your own UI using non-Sisense components.
+     * or for filters where you will supply your own UI components or use pre-built UI components. This is the most common option.
      *
      * To learn more about using filter factory functions to create filters, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-functions).
      *
-     * (2) Array of filters controlled by Sisense filter components.
+     * (2) Array of {@link Filter} controlled by filter UI components – for example {@link MemberFilterTile}.
      *
-     * Use this option for filters that you want your users to set using Sisense UI components.
+     * Use this option for filters that you want your users to set using pre-built UI components.
      *
-     * To learn more about using filter components to create filters, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-components).
+     * To learn more about using filter UI components to create filters, see the [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-components).
      *
      * @category Data
      */
@@ -410,21 +410,21 @@ 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.
+     * 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.
      *
-     * (1) Array of filters returned from filter factory functions, such as
+     * (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()`}.
      *
      * Use this option for highlights that do not require a UI to set them
-     * or for highlights where you will supply your own UI using non-Sisense components.
+     * or for highlights where you will supply your own UI components or use pre-built UI components. This is the most common option.
      *
      * To learn more about using filter factory functions to create highlights, see the
      * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-functions-for-highlighting).
      *
-     * (2) Array of filters controlled by Sisense filter components.
+     * (2) Array of {@link Filter} controlled by filter UI components – for example {@link MemberFilterTile}.
      *
-     * Use this option for highlights that you want your users to set using Sisense UI components.
+     * Use this option for highlights that you want your users to set using pre-built UI components.
      *
      * To learn more about using filter components to create highlights, see the
      * [Compose SDK Charts Guide](/guides/sdk/guides/charts/guide-compose-sdk-charts.html#filter-components-for-highlighting).

package/dist/query/query-result-date-formatting.d.ts

@@ -1,5 +1,4 @@
 import { Data } from '@sisense/sdk-data';
 import type { DateConfig } from './date-formats';
 import type { QueryResultData } from '@sisense/sdk-data';
-export declare function parseISOWithDefaultUTCOffset(dateString: string): Date;
 export declare function applyDateFormats(data: QueryResultData | Data, chartDataOptions: any, locale?: Locale, dateConfig?: DateConfig): QueryResultData | Data;

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

@@ -12,5 +12,5 @@ export declare const getTableAttributesAndMeasures: (dataOptions: TableDataOptio
     attributes: Attribute[];
     measures: Measure[];
 };
-export declare const useTableData: ({ dataSet, dataOptions, filters, filterRelations, count, offset, }: UseDataProps) => Data | null;
+export declare const useTableData: ({ dataSet, dataOptions: originalDataOptions, filters, filterRelations, count, offset, }: UseDataProps) => [Data | null, TableDataOptionsInternal | null];
 export {};

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

@@ -1,8 +1,8 @@
 import { TableProps } from '../props';
+export declare const DEFAULT_TABLE_ROWS_PER_PAGE = 25;
+/** How many pages of data will be loaded in one query */
+export declare const PAGES_BATCH_SIZE = 10;
 /**
  * Component that renders a table with aggregation and pagination.
  */
-export declare const TableComponent: ({ dataSet, dataOptions, styleOptions, filters, refreshCounter, }: TableProps) => import("react/jsx-runtime").JSX.Element | null;
-export declare const DEFAULT_TABLE_ROWS_PER_PAGE: 25;
-/** How many pages of data will be loaded in one query */
-export declare const PAGES_BATCH_SIZE = 10;
+export declare const TableComponent: ({ dataSet, dataOptions, styleOptions, filters, }: TableProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/theme-provider/theme-provider.d.ts

@@ -3,6 +3,8 @@ import { ThemeProviderProps } from '../props';
 /**
  * Theme provider, which allows you to adjust the look and feel of child components.
  *
+ * Components not wrapped in a theme provider use the current theme from the connected Fusion instance by default.
+ *
  * @example
  * Example of a theme provider, which changes the colors and font of the nested indicator chart:
  * ```tsx

package/dist/translation/resources/en.d.ts

@@ -36,6 +36,7 @@ export declare const translation: {
         unknownFilterInFilterRelations: string;
         filterRelationsNotSupported: string;
         invalidFilterType: string;
+        secondsDateTimeLevelSupportedOnlyForLive: string;
     };
     errorBoxText: string;
     chartNoData: string;

package/dist/translation/resources/index.d.ts

@@ -40,6 +40,7 @@ export declare const resources: {
             unknownFilterInFilterRelations: string;
             filterRelationsNotSupported: string;
             invalidFilterType: string;
+            secondsDateTimeLevelSupportedOnlyForLive: string;
         };
         errorBoxText: string;
         chartNoData: string;
@@ -143,6 +144,7 @@ export declare const resources: {
             unknownFilterInFilterRelations: string;
             filterRelationsNotSupported: string;
             invalidFilterType: string;
+            secondsDateTimeLevelSupportedOnlyForLive: string;
         };
         errorBoxText: string;
         chartNoData: string;

package/dist/types.d.ts

@@ -622,211 +622,223 @@ export type NumberFormatConfig = {
 export type CompleteNumberFormatConfig = Required<NumberFormatConfig>;
 /** Identifier of a theme as defined in the Sisense instance. */
 export type ThemeOid = string;
-/** Theme settings defining the look and feel of components. */
-export interface ThemeSettings {
-    /** Chart theme settings */
-    chart?: {
-        /** Text color */
-        textColor?: string;
-        /** Secondary text color - e.g., for the indicator chart's secondary value title */
-        secondaryTextColor?: string;
-        /** Background color */
-        backgroundColor?: string;
-        /** Toolbar Background color, can be used as a secondary background color */
-        panelBackgroundColor?: string;
+/**
+ * Chart theme settings
+ */
+export interface ChartThemeSettings {
+    /** Text color */
+    textColor?: string;
+    /** Secondary text color - e.g., for the indicator chart's secondary value title */
+    secondaryTextColor?: string;
+    /** Background color */
+    backgroundColor?: string;
+    /** Toolbar Background color, can be used as a secondary background color */
+    panelBackgroundColor?: string;
+}
+/**
+ * Theme settings specific to the AI Chatbot component
+ */
+export interface AiChatThemeSettings {
+    /** Background color of the chatbot */
+    backgroundColor?: string;
+    /** Text color of the chatbot */
+    primaryTextColor?: string;
+    /** Secondary text color of the chatbot */
+    secondaryTextColor?: string;
+    /** Primary font size for text in the chatbot */
+    primaryFontSize?: [fontSize: string, lineHeight: string];
+    /** Border of the chatbot */
+    border?: false | string;
+    /** Border radius of the chatbot */
+    borderRadius?: false | string;
+    /** Settings for the main chat body */
+    body?: {
+        /** Left padding of the chat body */
+        paddingLeft?: string;
+        /** Right padding of the chat body */
+        paddingRight?: string;
+        /** Top padding of the chat body */
+        paddingTop?: string;
+        /** Bottom padding of the chat body */
+        paddingBottom?: string;
+        /** Gap size between each message in the chat body */
+        gapBetweenMessages?: string;
     };
-    /** Collection of colors used to color various elements */
-    palette?: ColorPaletteTheme;
-    /** Text theme settings */
-    typography?: {
-        /** Font family name to style component text */
-        fontFamily?: string;
-        /** Primary text color */
-        primaryTextColor?: string;
-        /** Secondary text color */
-        secondaryTextColor?: string;
+    /** Settings for the chat footer */
+    footer?: {
+        /** Left padding of the chat footer */
+        paddingLeft?: string;
+        /** Right padding of the chat footer */
+        paddingRight?: string;
+        /** Top padding of the chat footer */
+        paddingTop?: string;
+        /** Bottom padding of the chat footer */
+        paddingBottom?: string;
     };
-    /** General theme settings */
-    general?: {
-        /** Main color used for various elements like primary buttons, switches, etc. */
-        brandColor?: string;
-        /** Background color used for elements like tiles, etc. */
+    /** Settings for user chat messages */
+    userMessages?: {
+        /** Background color of user chat messages */
         backgroundColor?: string;
-        /** Text color for primary buttons */
-        primaryButtonTextColor?: string;
-        /** Hover color for primary buttons */
-        primaryButtonHoverColor?: string;
     };
-    /**
-     * Theme settings specific to the AI Chatbot component
-     */
-    aiChat?: {
-        /** Background color of the chatbot */
+    /** Settings for system chat messages */
+    systemMessages?: {
+        /** Background color of system chat messages */
         backgroundColor?: string;
-        /** Text color of the chatbot */
-        primaryTextColor?: string;
-        /** Secondary text color of the chatbot */
-        secondaryTextColor?: string;
-        /** Primary font size for text in the chatbot */
-        primaryFontSize?: [fontSize: string, lineHeight: string];
-        /** Border of the chatbot */
-        border?: false | string;
-        /** Border radius of the chatbot */
-        borderRadius?: false | string;
-        /** Settings for the main chat body */
-        body?: {
-            /** Left padding of the chat body */
-            paddingLeft?: string;
-            /** Right padding of the chat body */
-            paddingRight?: string;
-            /** Top padding of the chat body */
-            paddingTop?: string;
-            /** Bottom padding of the chat body */
-            paddingBottom?: string;
-            /** Gap size between each message in the chat body */
-            gapBetweenMessages?: string;
-        };
-        /** Settings for the chat footer */
-        footer?: {
-            /** Left padding of the chat footer */
-            paddingLeft?: string;
-            /** Right padding of the chat footer */
-            paddingRight?: string;
-            /** Top padding of the chat footer */
-            paddingTop?: string;
-            /** Bottom padding of the chat footer */
-            paddingBottom?: string;
-        };
-        /** Settings for user chat messages */
-        userMessages?: {
-            /** Background color of user chat messages */
-            backgroundColor?: string;
-        };
-        /** Settings for system chat messages */
-        systemMessages?: {
-            /** Background color of system chat messages */
-            backgroundColor?: string;
-        };
-        /** Settings for the chatbot input */
-        input?: {
-            /** Background color of the input */
-            backgroundColor?: string;
-            /** Settings to be applied on input focus */
-            focus?: {
-                /** Outline color of the input */
-                outlineColor?: string;
-            };
-        };
-        /** Settings for the chatbot header */
-        header?: {
-            /** Background color of the chatbot header */
-            backgroundColor?: string;
-            /** Text color of the chatbot header */
-            textColor?: string;
-        };
-        /** Settings for chatbot dropup */
-        dropup?: {
-            /** Background color of the dropup */
-            backgroundColor?: string;
-            /** Box shadow of the dropup */
-            boxShadow?: string;
-            /** Border radius of the dropup */
-            borderRadius?: string;
-            /** Settings for the section headers of the dropup */
-            headers?: {
-                /** Text color of headers */
-                textColor?: string;
-                /** Settings to be applied on hover of the headers */
-                hover?: {
-                    /** Background color of headers on hover */
-                    backgroundColor?: string;
-                };
-            };
-            /** Settings for the dropup items */
-            items?: {
-                /** Text color of the dropup items */
-                textColor?: string;
-                /** Settings to be applied on hover of dropup items */
-                hover?: {
-                    /** Background color of dropup items on hover */
-                    backgroundColor?: string;
-                };
-            };
+    };
+    /** Settings for the chatbot input */
+    input?: {
+        /** Background color of the input */
+        backgroundColor?: string;
+        /** Settings to be applied on input focus */
+        focus?: {
+            /** Outline color of the input */
+            outlineColor?: string;
         };
-        /** Settings for the chatbot suggestions */
-        suggestions?: {
-            /** Text color of the chatbot suggestions */
+    };
+    /** Settings for the chatbot header */
+    header?: {
+        /** Background color of the chatbot header */
+        backgroundColor?: string;
+        /** Text color of the chatbot header */
+        textColor?: string;
+    };
+    /** Settings for chatbot dropup */
+    dropup?: {
+        /** Background color of the dropup */
+        backgroundColor?: string;
+        /** Box shadow of the dropup */
+        boxShadow?: string;
+        /** Border radius of the dropup */
+        borderRadius?: string;
+        /** Settings for the section headers of the dropup */
+        headers?: {
+            /** Text color of headers */
             textColor?: string;
-            /** Background color of the chatbot suggestions */
-            backgroundColor?: string;
-            /** Border of the chatbot suggestions */
-            border?: string;
-            /** 2-color gradient to be applied on the border */
-            borderGradient?: [string, string] | null;
-            /** Border radius of the chatbot suggestions */
-            borderRadius?: string;
-            /** Setting to be applied on hover */
+            /** Settings to be applied on hover of the headers */
             hover?: {
-                /** Text color of the chatbot suggestions on hover */
-                textColor?: string;
-                /** Background color of the chatbot suggestions on hover */
+                /** Background color of headers on hover */
                 backgroundColor?: string;
             };
-            /** 2-color gradient to be applied on suggestions loading animation */
-            loadingGradient?: [string, string];
-            /** Gap size between each suggestion item */
-            gap?: string;
         };
-        /** Settings for the chatbot clickable messages */
-        clickableMessages?: {
-            /** Text color of the chatbot clickable messages */
+        /** Settings for the dropup items */
+        items?: {
+            /** Text color of the dropup items */
             textColor?: string;
-            /** Background color of the chatbot clickable messages */
-            backgroundColor?: string;
-            /** Border of the chatbot clickable messages */
-            border?: false | string;
-            /** 2-color gradient to be applied on the border */
-            borderGradient?: [string, string] | null;
-            /** Setting to be applied on hover */
+            /** Settings to be applied on hover of dropup items */
             hover?: {
-                /** Text color of the chatbot clickable messages on hover */
-                textColor?: string;
-                /** Background color of the chatbot clickable messages on hover */
+                /** Background color of dropup items on hover */
                 backgroundColor?: string;
             };
         };
-        /** Settings for the data topics screen */
-        dataTopics?: {
-            /** Background color of the data topics screen */
+    };
+    /** Settings for the chatbot suggestions */
+    suggestions?: {
+        /** Text color of the chatbot suggestions */
+        textColor?: string;
+        /** Background color of the chatbot suggestions */
+        backgroundColor?: string;
+        /** Border of the chatbot suggestions */
+        border?: string;
+        /** 2-color gradient to be applied on the border */
+        borderGradient?: [string, string] | null;
+        /** Border radius of the chatbot suggestions */
+        borderRadius?: string;
+        /** Setting to be applied on hover */
+        hover?: {
+            /** Text color of the chatbot suggestions on hover */
+            textColor?: string;
+            /** Background color of the chatbot suggestions on hover */
             backgroundColor?: string;
-            /** Settings for the individual data topic items */
-            items?: {
-                /** Text color of the data topic items */
-                textColor?: string;
-                /** Background color of the data topic items */
-                backgroundColor?: string;
-            };
         };
-        /** Settings for the chatbot icons */
-        icons?: {
-            /** Color of the chatbot icons */
-            color?: string;
-            /** Settings for feedback icons */
-            feedbackIcons?: {
-                /** Background color of the feedback icons on hover */
-                hoverColor?: string;
-            };
-        };
-        /** Settings for the chatbot tooltips */
-        tooltips?: {
-            /** Background color of the tooltips */
+        /** 2-color gradient to be applied on suggestions loading animation */
+        loadingGradient?: [string, string];
+        /** Gap size between each suggestion item */
+        gap?: string;
+    };
+    /** Settings for the chatbot clickable messages */
+    clickableMessages?: {
+        /** Text color of the chatbot clickable messages */
+        textColor?: string;
+        /** Background color of the chatbot clickable messages */
+        backgroundColor?: string;
+        /** Border of the chatbot clickable messages */
+        border?: false | string;
+        /** 2-color gradient to be applied on the border */
+        borderGradient?: [string, string] | null;
+        /** Setting to be applied on hover */
+        hover?: {
+            /** Text color of the chatbot clickable messages on hover */
+            textColor?: string;
+            /** Background color of the chatbot clickable messages on hover */
             backgroundColor?: string;
-            /** Text color of the tooltips */
+        };
+    };
+    /** Settings for the data topics screen */
+    dataTopics?: {
+        /** Background color of the data topics screen */
+        backgroundColor?: string;
+        /** Settings for the individual data topic items */
+        items?: {
+            /** Text color of the data topic items */
             textColor?: string;
-            /** Box shadow of the tooltips */
-            boxShadow?: string;
+            /** Background color of the data topic items */
+            backgroundColor?: string;
+        };
+    };
+    /** Settings for the chatbot icons */
+    icons?: {
+        /** Color of the chatbot icons */
+        color?: string;
+        /** Settings for feedback icons */
+        feedbackIcons?: {
+            /** Background color of the feedback icons on hover */
+            hoverColor?: string;
         };
     };
+    /** Settings for the chatbot tooltips */
+    tooltips?: {
+        /** Background color of the tooltips */
+        backgroundColor?: string;
+        /** Text color of the tooltips */
+        textColor?: string;
+        /** Box shadow of the tooltips */
+        boxShadow?: string;
+    };
+}
+/** Text theme settings */
+export interface TypographyThemeSettings {
+    /** Font family name to style component text */
+    fontFamily?: string;
+    /** Primary text color */
+    primaryTextColor?: string;
+    /** Secondary text color */
+    secondaryTextColor?: string;
+}
+/** General theme settings */
+export interface GeneralThemeSettings {
+    /** Main color used for various elements like primary buttons, switches, etc. */
+    brandColor?: string;
+    /** Background color used for elements like tiles, etc. */
+    backgroundColor?: string;
+    /** Text color for primary buttons */
+    primaryButtonTextColor?: string;
+    /** Hover color for primary buttons */
+    primaryButtonHoverColor?: string;
+}
+/** Theme settings defining the look and feel of components. */
+export interface ThemeSettings {
+    /** Chart theme settings */
+    chart?: ChartThemeSettings;
+    /** Collection of colors used to color various elements */
+    palette?: ColorPaletteTheme;
+    /** Text theme settings */
+    typography?: TypographyThemeSettings;
+    /** General theme settings */
+    general?: GeneralThemeSettings;
+    /**
+     * Theme settings specific to the AI Chatbot component
+     */
+    aiChat?: AiChatThemeSettings;
 }
 /**
  * Complete set of theme settings defining the look and feel of components.