@sisense/sdk-ui 1.10.1 → 1.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. package/dist/ai/ai-context-provider.d.ts +1 -1
  2. package/dist/ai/buttons/thumbs-down-button.d.ts +2 -1
  3. package/dist/ai/buttons/thumbs-up-button.d.ts +2 -1
  4. package/dist/ai/chat-config.d.ts +10 -0
  5. package/dist/ai/chat-dropup.d.ts +2 -1
  6. package/dist/ai/chat-input.d.ts +3 -1
  7. package/dist/ai/chatbot.d.ts +1 -1
  8. package/dist/ai/common/beta-label.d.ts +1 -0
  9. package/dist/ai/common/icon-button.d.ts +2 -3
  10. package/dist/ai/get-nlg-query-result.d.ts +1 -1
  11. package/dist/ai/icons/light-bulb-icon.d.ts +1 -3
  12. package/dist/ai/index.d.ts +1 -0
  13. package/dist/ai/messages/clickable-message.d.ts +2 -1
  14. package/dist/ai/messages/feedback-wrapper.d.ts +2 -2
  15. package/dist/ai/messages/get-widget-options.d.ts +6 -1
  16. package/dist/ai/messages/text-message.d.ts +5 -0
  17. package/dist/ai/use-get-nlg-query-result.d.ts +1 -1
  18. package/dist/ai/use-get-query-recommendations.d.ts +1 -1
  19. package/dist/ai/use-last-nlq-response.d.ts +19 -0
  20. package/dist/ai.cjs +454 -0
  21. package/dist/ai.js +1142 -1095
  22. package/dist/api/types/dashboard-dto.d.ts +5 -4
  23. package/dist/app/client-application.d.ts +1 -0
  24. package/dist/area-range-chart.d.ts +67 -0
  25. package/dist/areamap-chart.d.ts +0 -1
  26. package/dist/boxplot-chart.d.ts +0 -1
  27. package/dist/chart/chart.d.ts +0 -2
  28. package/dist/chart/helpers/should-skip-sisense-context-waiting.d.ts +3 -0
  29. package/dist/chart/helpers/use-chart-renderer-props.d.ts +28 -0
  30. package/dist/chart/regular-chart.d.ts +7 -0
  31. package/dist/chart/types.d.ts +21 -0
  32. package/dist/chart-data/range-data.d.ts +11 -0
  33. package/dist/chart-data/types.d.ts +15 -1
  34. package/dist/chart-data-options/translate-range-data-options.d.ts +2 -0
  35. package/dist/chart-data-options/types.d.ts +56 -4
  36. package/dist/chart-data-processor/data-table-date-period.d.ts +0 -1
  37. package/dist/chart-options-processor/chart-options-service.d.ts +5 -0
  38. package/dist/chart-options-processor/range-chart-options.d.ts +17 -0
  39. package/dist/chart-options-processor/translations/design-options.d.ts +55 -7
  40. package/dist/chart-options-processor/translations/funnel-plot-options.d.ts +2 -1
  41. package/dist/chart-options-processor/translations/pie-plot-options.d.ts +2 -1
  42. package/dist/chart-options-processor/translations/range/tooltip-range.d.ts +4 -0
  43. package/dist/chart-options-processor/translations/tooltip-utils.d.ts +3 -0
  44. package/dist/chart-options-processor/translations/types.d.ts +12 -6
  45. package/dist/charts/map-charts/areamap/areamap.d.ts +2 -3
  46. package/dist/charts/map-charts/scattermap/scattermap.d.ts +2 -1
  47. package/dist/charts/table/helpers/calc-column-widths.d.ts +1 -0
  48. package/dist/charts/table/styles/style-constants.d.ts +1 -0
  49. package/dist/charts/table/types.d.ts +13 -4
  50. package/dist/common/components/loading-indicator.d.ts +17 -4
  51. package/dist/common/hooks/use-fetch.d.ts +1 -1
  52. package/dist/common/hooks/use-has-changed.d.ts +9 -0
  53. package/dist/common/hooks/use-should-load.d.ts +12 -0
  54. package/dist/dashboard/components/content-panel.d.ts +41 -0
  55. package/dist/dashboard/components/dashboard-container.d.ts +2 -0
  56. package/dist/dashboard/components/dashboard-header.d.ts +2 -0
  57. package/dist/dashboard/components/plugin-service.d.ts +21 -0
  58. package/dist/dashboard/constants.d.ts +2 -0
  59. package/dist/dashboard/dashboard-by-id.d.ts +7 -0
  60. package/dist/dashboard/dashboard.d.ts +8 -0
  61. package/dist/dashboard/types.d.ts +41 -0
  62. package/dist/dashboard/utils.d.ts +5 -0
  63. package/dist/dashboard-widget/translate-widget-filters.d.ts +664 -4
  64. package/dist/dashboard-widget/use-fetch-widget-dto-model.d.ts +1 -1
  65. package/dist/dashboard-widget/utils.d.ts +2 -2
  66. package/dist/decorators/component-decorators/as-sisense-component.d.ts +6 -2
  67. package/dist/decorators/component-decorators/with-tracking/use-track-component-init.d.ts +2 -1
  68. package/dist/decorators/component-decorators/with-tracking/with-tracking.d.ts +4 -1
  69. package/dist/dynamic-size-container/dynamic-size-container.d.ts +8 -0
  70. package/dist/filters/components/common/basic-input.d.ts +0 -1
  71. package/dist/filters/components/common/date-range-field-button.d.ts +3 -6
  72. package/dist/filters/components/date-filter/date-filter/date-filter.d.ts +15 -0
  73. package/dist/filters/components/date-filter/date-range-filter-tile/date-range-filter-display.d.ts +6 -0
  74. package/dist/filters/components/date-filter/date-range-filter-tile/date-range-filter-tile.d.ts +6 -0
  75. package/dist/filters/components/date-filter/date-range-filter-tile/editable-date-range-filter.d.ts +14 -0
  76. package/dist/filters/components/date-filter/date-range-filter-tile/use-date-limits.d.ts +1 -2
  77. package/dist/filters/components/date-filter/relative-date-filter-tile/relative-date-filter.d.ts +2 -2
  78. package/dist/filters/components/filters-panel/filters-panel-tile.d.ts +18 -0
  79. package/dist/filters/components/filters-panel/filters-panel.d.ts +18 -0
  80. package/dist/filters/components/filters-panel/index.d.ts +2 -0
  81. package/dist/filters/components/icons/arrow-icon.d.ts +6 -0
  82. package/dist/filters/components/icons/double-arrow-icon.d.ts +6 -0
  83. package/dist/filters/components/member-filter-tile/basic-member-filter-tile.d.ts +3 -1
  84. package/dist/filters/components/member-filter-tile/use-members.d.ts +1 -1
  85. package/dist/filters/index.d.ts +1 -0
  86. package/dist/highcharts-memorized.d.ts +1 -1
  87. package/dist/index.cjs +784 -0
  88. package/dist/index.d.ts +2 -0
  89. package/dist/index.js +17694 -18881
  90. package/dist/indicator-canvas.d.ts +2 -3
  91. package/dist/models/dashboard/dashboard-model.d.ts +62 -0
  92. package/dist/models/dashboard/get-dashboard-model.d.ts +10 -1
  93. package/dist/models/dashboard/get-dashboard-models.d.ts +2 -1
  94. package/dist/models/dashboard/index.d.ts +1 -1
  95. package/dist/models/dashboard/translate-dashboard-utils.d.ts +5 -0
  96. package/dist/models/dashboard/types.d.ts +2 -12
  97. package/dist/models/dashboard/use-get-dashboard-model.d.ts +1 -1
  98. package/dist/models/dashboard/use-get-dashboard-models.d.ts +1 -1
  99. package/dist/models/widget/widget-model.d.ts +3 -3
  100. package/dist/pivot-table/formatters/header-cell-formatters/header-cell-highlight-formatter.d.ts +2 -0
  101. package/dist/pivot-table/formatters/types.d.ts +2 -2
  102. package/dist/pivot-table/helpers/prepare-pivot-styling-props.d.ts +1 -0
  103. package/dist/pivot-table/pivot-table.d.ts +1 -1
  104. package/dist/pivot-table/use-get-pivot-table-query.d.ts +2 -1
  105. package/dist/props.d.ts +57 -2
  106. package/dist/query/date-formats/apply-date-format.d.ts +0 -1
  107. package/dist/query/query-result-date-formatting.d.ts +0 -1
  108. package/dist/query-execution/query-params-comparator.d.ts +1 -7
  109. package/dist/query-execution/types.d.ts +11 -1
  110. package/dist/query-execution/use-execute-pivot-query.d.ts +3 -6
  111. package/dist/query-execution/use-execute-query-by-widget-id.d.ts +3 -4
  112. package/dist/scattermap-chart.d.ts +0 -1
  113. package/dist/sisense-chart/sisense-chart.d.ts +8 -5
  114. package/dist/table/table-component.d.ts +8 -0
  115. package/dist/table/table.d.ts +2 -2
  116. package/dist/table/translations/design-options.d.ts +3 -0
  117. package/dist/translation/resources/en.d.ts +12 -1
  118. package/dist/translation/resources/index.d.ts +24 -2
  119. package/dist/types.d.ts +103 -17
  120. package/dist/{debounce-CVvJ1016.js → useQuery-0UWck_2A.js} +33927 -33705
  121. package/dist/useQuery-DVHD0kJ-.cjs +603 -0
  122. package/dist/utils/check-and-notify-about-deprecated-prop.d.ts +1 -0
  123. package/dist/utils/create-cache.d.ts +0 -1
  124. package/dist/utils/utility-types.d.ts +1 -0
  125. package/dist/widgets/common/drilldown-breadcrumbs/styled-buttons.d.ts +2 -2
  126. package/dist/widgets/drilldown-widget.d.ts +2 -1
  127. package/package.json +13 -9
  128. package/dist/ai/icons/thumbs-down-hovered-icon.d.ts +0 -2
  129. package/dist/ai/icons/thumbs-up-hovered-icon.d.ts +0 -2
  130. package/dist/ai/messages/clear-history-success-message.d.ts +0 -1
  131. package/dist/filters/components/icons/arrow-right-icon.d.ts +0 -2
  132. package/dist/filters/components/icons/double-arrow-right-icon.d.ts +0 -2
  133. package/dist/models/dashboard/translate-dashboard.d.ts +0 -4
@@ -6,7 +6,7 @@ export type AiContextProviderProps = {
6
6
  * React component that wraps all generative AI components and hooks.
7
7
  *
8
8
  * ::: warning Note
9
- * This component is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
9
+ * This component is currently under beta release for selected customers and is subject to change as we make fixes and improvements.
10
10
  * :::
11
11
  *
12
12
  * @example
@@ -1,5 +1,6 @@
1
1
  type ThumbsDownButtonProps = {
2
2
  onClick?: () => void;
3
+ disabled?: boolean;
3
4
  };
4
- export default function ThumbsDownButton({ onClick }: ThumbsDownButtonProps): import("react/jsx-runtime").JSX.Element;
5
+ export default function ThumbsDownButton({ onClick, disabled }: ThumbsDownButtonProps): import("react/jsx-runtime").JSX.Element;
5
6
  export {};
@@ -1,5 +1,6 @@
1
1
  type ThumbsUpButtonProps = {
2
2
  onClick?: () => void;
3
+ disabled?: boolean;
3
4
  };
4
- export default function ThumbsUpButton({ onClick }: ThumbsUpButtonProps): import("react/jsx-runtime").JSX.Element;
5
+ export default function ThumbsUpButton({ onClick, disabled }: ThumbsUpButtonProps): import("react/jsx-runtime").JSX.Element;
5
6
  export {};
@@ -37,8 +37,18 @@ export interface ChatConfig {
37
37
  * The welcome text to show at the top of a chat session.
38
38
  *
39
39
  * A value of `false` will hide the welcome text.
40
+ *
41
+ * If not specified, a default message will be displayed.
40
42
  */
41
43
  welcomeText?: string | false;
44
+ /**
45
+ * The message text to show above the initial suggested questions in a chat session.
46
+ *
47
+ * A value of `false` will hide the text.
48
+ *
49
+ * If not specified, a default message will be displayed.
50
+ */
51
+ suggestionsWelcomeText?: string | false;
42
52
  /**
43
53
  * Boolean flag to show or hide the header in a chat session.
44
54
  *
@@ -6,6 +6,7 @@ interface ChatDropupProps {
6
6
  onSelection: (q: string) => void;
7
7
  anchorEl: HTMLElement | null;
8
8
  text: string;
9
+ recommendationsError: boolean;
9
10
  }
10
- export default function ChatDropup({ recentPrompts, suggestions, isLoading, onSelection, anchorEl, text, }: ChatDropupProps): import("react/jsx-runtime").JSX.Element;
11
+ export default function ChatDropup({ recentPrompts, suggestions, isLoading, onSelection, anchorEl, text, recommendationsError, }: ChatDropupProps): import("react/jsx-runtime").JSX.Element;
11
12
  export {};
@@ -5,5 +5,7 @@ export type ChatInputProps = {
5
5
  recentPrompts: string[];
6
6
  suggestions: string[];
7
7
  isLoading: boolean;
8
+ recommendationsError: boolean;
9
+ onChange?: (text: string) => void;
8
10
  };
9
- export default function ChatInput({ onSendMessage, onClearHistoryClick, disabled, recentPrompts, suggestions, isLoading, }: ChatInputProps): import("react/jsx-runtime").JSX.Element;
11
+ export default function ChatInput({ onSendMessage, onClearHistoryClick, disabled, recentPrompts, suggestions, isLoading, recommendationsError, onChange, }: ChatInputProps): import("react/jsx-runtime").JSX.Element;
@@ -25,7 +25,7 @@ export type ChatbotProps = {
25
25
  * React component that renders a chatbot with data topic selection. You can optionally provide `width` and/or `height`.
26
26
  *
27
27
  * ::: warning Note
28
- * This component is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
28
+ * This component is currently under beta release for selected customers and is subject to change as we make fixes and improvements.
29
29
  * :::
30
30
  *
31
31
  * @example
@@ -0,0 +1 @@
1
+ export declare const BetaLabel: () => import("react/jsx-runtime").JSX.Element;
@@ -1,12 +1,11 @@
1
1
  /// <reference types="react" />
2
2
  import { type IconButtonProps as MuiIconButtonProps } from '@mui/material/IconButton';
3
- import { CompleteThemeSettings } from '../../types';
4
3
  interface IconButtonProps extends MuiIconButtonProps {
5
- $themeSettings?: CompleteThemeSettings;
4
+ $hoverColor?: string;
6
5
  }
7
6
  declare const IconButton: import("@emotion/styled").StyledComponent<import("@mui/material/IconButton").IconButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
8
7
  ref?: ((instance: HTMLButtonElement | null) => void) | import("react").RefObject<HTMLButtonElement> | null | undefined;
9
- }, "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "action" | "classes" | "sx" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
8
+ }, "children" | "style" | "disabled" | "size" | "className" | "tabIndex" | "color" | "sx" | "classes" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "edge"> & {
10
9
  theme?: import("@emotion/react").Theme | undefined;
11
10
  } & IconButtonProps, {}, {}>;
12
11
  export default IconButton;
@@ -10,7 +10,7 @@ export interface GetNlgQueryResultProps extends Omit<UseGetNlgQueryResultParams,
10
10
  * Specifying a query is similar to providing parameters to a {@link useExecuteQuery} hook, using dimensions, measures, and filters.
11
11
  *
12
12
  * ::: warning Note
13
- * This component is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
13
+ * This component is currently under beta release for selected customers and is subject to change as we make fixes and improvements.
14
14
  * :::
15
15
  *
16
16
  * @example
@@ -1,3 +1 @@
1
- export default function LightBulbIcon({ hover }: {
2
- hover?: boolean;
3
- }): import("react/jsx-runtime").JSX.Element;
1
+ export default function LightBulbIcon(): import("react/jsx-runtime").JSX.Element;
@@ -3,6 +3,7 @@ export { type ChatConfig } from './chat-config';
3
3
  export { useGetNlgQueryResult, type UseGetNlgQueryResultParams, type UseGetNlgQueryResultState, } from './use-get-nlg-query-result';
4
4
  export { useGetQueryRecommendations, type UseGetQueryRecommendationsParams, type UseGetQueryRecommendationsState, } from './use-get-query-recommendations';
5
5
  export { useChatSession, type UseChatSessionResult } from './use-chat-session';
6
+ export { useLastNlqResponse } from './use-last-nlq-response';
6
7
  export { useGetDataSourceFields } from './use-get-data-source-fields';
7
8
  export type { GetNlgQueryResultRequest, QueryRecommendationResponse, QueryRecommendation, NlqResponseData, ChartRecommendations, AxesMapping, AxesMappingKey, AllPossibleChartOptionKeys, KeysOfUnion, } from './api/types';
8
9
  export { Chatbot, type ChatbotProps } from './chatbot';
@@ -6,6 +6,7 @@ type Props = {
6
6
  disabled?: boolean;
7
7
  onMouseEnter?: () => void;
8
8
  onMouseLeave?: () => void;
9
+ accessibleName?: string;
9
10
  };
10
- export default function ClickableMessage({ children, align, onClick, onMouseEnter, onMouseLeave, }: Props): import("react/jsx-runtime").JSX.Element;
11
+ export default function ClickableMessage({ children, align, onClick, onMouseEnter, onMouseLeave, accessibleName, }: Props): import("react/jsx-runtime").JSX.Element;
11
12
  export {};
@@ -4,7 +4,7 @@ type FeedbackWrapperProps = {
4
4
  data: object;
5
5
  type: string;
6
6
  buttonVisibility?: 'onHover' | 'always' | 'never';
7
- children: ReactNode;
7
+ renderContent: (buttonRow: JSX.Element) => ReactNode;
8
8
  };
9
- export default function FeedbackWrapper({ sourceId, data, type, buttonVisibility, children, }: FeedbackWrapperProps): import("react/jsx-runtime").JSX.Element;
9
+ export default function FeedbackWrapper({ sourceId, data, type, buttonVisibility, renderContent, }: FeedbackWrapperProps): import("react/jsx-runtime").JSX.Element;
10
10
  export {};
@@ -11,9 +11,14 @@ export declare const getTableOptions: (jaql: MetadataItem[]) => {
11
11
  };
12
12
  };
13
13
  /**
14
+ * Get chart options for the chart widget.
15
+ *
16
+ * @param jaql - metadata items
17
+ * @param chartRecommendations - chart recommendations
18
+ * @param useCustomizedStyleOptions - whether to use customized style. Charts as inline response messages use customized style. Charts for Query Composer use default style.
14
19
  * @internal
15
20
  */
16
- export declare const getChartOptions: (jaql: MetadataItem[], chartRecommendations: ChartRecommendations) => {
21
+ export declare const getChartOptions: (jaql: MetadataItem[], chartRecommendations: ChartRecommendations, useCustomizedStyleOptions?: boolean) => {
17
22
  dataOptions: ChartDataOptions;
18
23
  chartStyleOptions: ChartStyleOptions;
19
24
  expandedChartStyleOptions: ChartStyleOptions;
@@ -1,6 +1,11 @@
1
+ import { Themable } from '../../theme-provider/types';
1
2
  import { FC, PropsWithChildren } from 'react';
2
3
  type Alignable = {
3
4
  align: 'left' | 'right' | 'full';
4
5
  };
6
+ export declare const MessageContainer: import("@emotion/styled").StyledComponent<{
7
+ theme?: import("@emotion/react").Theme | undefined;
8
+ as?: import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> | undefined;
9
+ } & Themable & Alignable, import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {}>;
5
10
  declare const TextMessage: FC<PropsWithChildren<Alignable>>;
6
11
  export default TextMessage;
@@ -46,7 +46,7 @@ export declare const useGetNlgQueryResultInternal: (params: GetNlgQueryResultPro
46
46
  * Specifying a query is similar to providing parameters to a {@link useExecuteQuery} hook, using dimensions, measures, and filters.
47
47
  *
48
48
  * ::: warning Note
49
- * This hook is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
49
+ * This hook is currently under beta release for selected customers and is subject to change as we make fixes and improvements.
50
50
  * :::
51
51
  *
52
52
  * @example
@@ -36,7 +36,7 @@ export declare const useGetQueryRecommendationsInternal: (params: UseGetQueryRec
36
36
  * This hook includes the same code that fetches the initial suggested questions in the chatbot.
37
37
  *
38
38
  * ::: warning Note
39
- * This hook is currently under private beta for selected customers and is subject to change as we make fixes and improvements.
39
+ * This hook is currently under beta release for selected customers and is subject to change as we make fixes and improvements.
40
40
  * :::
41
41
  *
42
42
  * @example
@@ -0,0 +1,19 @@
1
+ import type { NlqResponseData } from './api/types';
2
+ /**
3
+ * Parameters for the useLastNlqResponse hook.
4
+ *
5
+ * @internal
6
+ */
7
+ interface UseLastNlqResponseParams {
8
+ /** The title of the data model or perspective */
9
+ contextTitle: string;
10
+ }
11
+ /**
12
+ * React hook that returns the last NLQ response for the chat that corresponds
13
+ * to the given data model or perspective.
14
+ *
15
+ * @param params - Parameters for the hook
16
+ * @internal
17
+ */
18
+ export declare const useLastNlqResponse: ({ contextTitle, }: UseLastNlqResponseParams) => NlqResponseData | null;
19
+ export {};