@sisense/sdk-ui 1.33.0 → 1.35.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 (66) hide show
  1. package/dist/ai.cjs +8 -8
  2. package/dist/ai.js +151 -138
  3. package/dist/analytics-composer.cjs +1 -1
  4. package/dist/analytics-composer.js +3 -3
  5. package/dist/{derive-chart-family-nTKwlMms.js → derive-chart-family-5CbFzbpu.js} +18669 -18745
  6. package/dist/{derive-chart-family-B4sA-ao-.cjs → derive-chart-family-C3FH49ux.cjs} +173 -173
  7. package/dist/index.cjs +20 -11
  8. package/dist/index.js +6484 -6356
  9. package/dist/packages/sdk-ui/src/ai/custom-ai-context-provider.d.ts +4 -6
  10. package/dist/packages/sdk-ui/src/ai/get-nlg-insights.d.ts +1 -0
  11. package/dist/packages/sdk-ui/src/ai/index.d.ts +2 -1
  12. package/dist/packages/sdk-ui/src/ai/use-final-nlq-response.d.ts +20 -0
  13. package/dist/packages/sdk-ui/src/ai/use-get-nlq-result.d.ts +1 -0
  14. package/dist/packages/sdk-ui/src/ai/use-get-query-recommendations.d.ts +1 -0
  15. package/dist/packages/sdk-ui/src/analytics-composer/index.d.ts +3 -0
  16. package/dist/packages/sdk-ui/src/analytics-composer/types.d.ts +17 -1
  17. package/dist/packages/sdk-ui/src/api/rest-api.d.ts +3 -0
  18. package/dist/packages/sdk-ui/src/chart-data/table-data.d.ts +10 -0
  19. package/dist/packages/sdk-ui/src/common/components/grouped-items-browser/types.d.ts +2 -0
  20. package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/hooks/index.d.ts +1 -0
  21. package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/hooks/use-data-accumulation.d.ts +1 -0
  22. package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/{utils/get-hook-state-result.d.ts → hooks/use-get-hook-state-result.d.ts} +3 -2
  23. package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/utils/index.d.ts +0 -1
  24. package/dist/packages/sdk-ui/src/common/hooks/use-defaults.d.ts +1 -0
  25. package/dist/packages/sdk-ui/src/dashboard/components/content-panel.d.ts +1 -0
  26. package/dist/packages/sdk-ui/src/dashboard/dashboard-helpers.d.ts +0 -1
  27. package/dist/packages/sdk-ui/src/dashboard/types.d.ts +3 -1
  28. package/dist/packages/sdk-ui/src/data-browser/add-filter-popover/add-filter-data-browser.d.ts +8 -1
  29. package/dist/packages/sdk-ui/src/data-browser/add-filter-popover/add-filter-popover.d.ts +6 -1
  30. package/dist/packages/sdk-ui/src/data-browser/dimensions-browser/types.d.ts +8 -0
  31. package/dist/packages/sdk-ui/src/filters/components/cascading-filter-tile/cascading-filter-tile.d.ts +2 -0
  32. package/dist/packages/sdk-ui/src/filters/components/cascading-filter-tile/cascading-level-filter.d.ts +3 -1
  33. package/dist/packages/sdk-ui/src/filters/components/criteria-filter-tile/types.d.ts +1 -0
  34. package/dist/packages/sdk-ui/src/filters/components/date-filter/relative-date-filter-tile/relative-date-filter.d.ts +5 -1
  35. package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/filter-editor-context.d.ts +3 -1
  36. package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/filter-editor-popover.d.ts +2 -1
  37. package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/filter-editor.d.ts +2 -1
  38. package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/hooks/use-get-attribute-stats.d.ts +2 -1
  39. package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/sections/common/granularities.d.ts +36 -6
  40. package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/types.d.ts +2 -0
  41. package/dist/packages/sdk-ui/src/filters/components/filter-tile-container.d.ts +1 -0
  42. package/dist/packages/sdk-ui/src/filters/components/filter-tile.d.ts +5 -3
  43. package/dist/packages/sdk-ui/src/filters/components/filters-panel/hooks/use-existing-filter-editing.d.ts +1 -1
  44. package/dist/packages/sdk-ui/src/filters/components/filters-panel/hooks/use-new-filter-adding.d.ts +3 -1
  45. package/dist/packages/sdk-ui/src/filters/hooks/use-get-filter-members.d.ts +3 -3
  46. package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-dto-utils.d.ts +0 -1
  47. package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-utils.d.ts +1 -0
  48. package/dist/packages/sdk-ui/src/models/dashboard/types.d.ts +1 -0
  49. package/dist/packages/sdk-ui/src/models/hierarchy/types.d.ts +0 -1
  50. package/dist/packages/sdk-ui/src/plugins-provider/custom-plugins-provider.d.ts +4 -9
  51. package/dist/packages/sdk-ui/src/props.d.ts +2 -0
  52. package/dist/packages/sdk-ui/src/query-execution/index.d.ts +1 -1
  53. package/dist/packages/sdk-ui/src/query-execution/types.d.ts +1 -1
  54. package/dist/packages/sdk-ui/src/sisense-context/custom-sisense-context-provider.d.ts +2 -4
  55. package/dist/packages/sdk-ui/src/theme-provider/custom-theme-provider.d.ts +5 -8
  56. package/dist/packages/sdk-ui/src/translation/resources/en.d.ts +3 -0
  57. package/dist/packages/sdk-ui/src/translation/resources/index.d.ts +6 -0
  58. package/dist/packages/sdk-ui/src/types.d.ts +16 -3
  59. package/dist/packages/sdk-ui/src/widget-by-id/translate-dashboard-filters.d.ts +7 -0
  60. package/dist/packages/sdk-ui/src/widget-by-id/use-get-dashboard-model-and-widget-model.d.ts +1 -0
  61. package/dist/packages/sdk-ui/src/widgets/tabber-widget.d.ts +5 -0
  62. package/dist/{use-common-filters--WPkVexd.js → use-common-filters-CRL16HJ4.js} +3190 -3183
  63. package/dist/{use-common-filters-BNKt9a0z.cjs → use-common-filters-Dx4AeUoy.cjs} +48 -48
  64. package/dist/{widget-composer-CobNNZ1e.js → widget-composer-C5_iIuZN.js} +14 -14
  65. package/dist/{widget-composer-DPqi_qzU.cjs → widget-composer-D5_iKTui.cjs} +1 -1
  66. package/package.json +9 -8
@@ -27,7 +27,7 @@ export interface GetFilterMembersSuccess {
27
27
  * Function to load more data rows
28
28
  *
29
29
  * @internal
30
- * */
30
+ */
31
31
  loadMore: (count: number) => void;
32
32
  /** Whether the data fetching has failed */
33
33
  isError: false;
@@ -55,7 +55,7 @@ export interface GetFilterMembersError {
55
55
  * Function to load more data rows
56
56
  *
57
57
  * @internal
58
- * */
58
+ */
59
59
  loadMore: (count: number) => void;
60
60
  }
61
61
  /**
@@ -74,7 +74,7 @@ export declare const useGetFilterMembersInternal: ({ filter, defaultDataSource,
74
74
  *
75
75
  * Those members can be used to display a list of members in a third-party filter component such as Material UI Select.
76
76
  *
77
- * * ## Example
77
+ * ## Example
78
78
  *
79
79
  * Retrieve selected members from a Filter on Country of the Sample ECommerce data model.
80
80
  *
@@ -5,7 +5,6 @@ import { CascadingFilterDto, FilterDto } from '../../api/types/dashboard-dto';
5
5
  *
6
6
  * @param filter - The filter to translate.
7
7
  * @returns FilterDto
8
- *
9
8
  * @internal
10
9
  */
11
10
  export declare function filterToFilterDto(filter: Filter): FilterDto | CascadingFilterDto;
@@ -9,6 +9,7 @@ export declare function translateWidgetsOptions(widgets?: WidgetDto[]): WidgetsO
9
9
  export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersOptions;
10
10
  /**
11
11
  * Replace all shared formulas, which defined by id references, in the dashboard with their actual values.
12
+ *
12
13
  * @param dashboard - The dashboard DTO to replace shared formulas in
13
14
  * @param api - The REST API instance
14
15
  * @returns The dashboard DTO with shared formulas, defined by id references, replaced
@@ -43,6 +43,7 @@ export type WidgetsOptions = Record<WidgetId, {
43
43
  *
44
44
  * This property actually moves responsibility on the layout management from the tabber widgets to the dashboard,
45
45
  * storing all the tabbers configs in the single place
46
+ *
46
47
  * @internal
47
48
  */
48
49
  export type TabbersOptions = Record<WidgetId, TabberConfig>;
@@ -3,7 +3,6 @@ import type { Attribute, DataSource } from '@sisense/sdk-data';
3
3
  * Options for retrieving hierarchies.
4
4
  *
5
5
  * @internal
6
- *
7
6
  */
8
7
  export type GetHierarchiesOptions = {
9
8
  /**
@@ -1,10 +1,8 @@
1
- import { ReactNode } from 'react';
1
+ import { PropsWithChildren } from 'react';
2
2
  import { PluginComponent, PluginComponentProps } from './types';
3
+ import { CustomContextProviderProps } from '../types';
3
4
  /** @internal */
4
- export type CustomPluginsProviderProps<T = PluginComponentProps> = {
5
- context: CustomPluginsContext<T>;
6
- error?: Error;
7
- };
5
+ export type CustomPluginsProviderProps = CustomContextProviderProps<CustomPluginsContext<PluginComponentProps>>;
8
6
  /** @internal */
9
7
  export type CustomPluginsContext<T = PluginComponentProps> = {
10
8
  pluginMap: Map<string, PluginComponent<T>>;
@@ -18,7 +16,4 @@ export type CustomPluginsContext<T = PluginComponentProps> = {
18
16
  *
19
17
  * @internal
20
18
  */
21
- export declare const CustomPluginsProvider: React.FC<{
22
- context: CustomPluginsContext<any>;
23
- children: ReactNode;
24
- }>;
19
+ export declare const CustomPluginsProvider: React.FC<PropsWithChildren<CustomPluginsProviderProps>>;
@@ -1520,6 +1520,7 @@ export interface DrilldownWidgetProps {
1520
1520
  }
1521
1521
  /**
1522
1522
  * Tabber widget props designed to be a current state and is provided by use-tabber hook
1523
+ *
1523
1524
  * @internal
1524
1525
  */
1525
1526
  export type TabberWidgetExtraProps = {
@@ -1528,6 +1529,7 @@ export type TabberWidgetExtraProps = {
1528
1529
  };
1529
1530
  /**
1530
1531
  * Tabber widget props
1532
+ *
1531
1533
  * @internal
1532
1534
  */
1533
1535
  export type TabberWidgetProps = {
@@ -1,6 +1,6 @@
1
1
  export { ExecuteQuery } from './execute-query';
2
2
  export { useExecuteQuery } from './use-execute-query';
3
- export { useExecuteCsvQuery } from './use-execute-csv-query';
3
+ export { useExecuteCsvQuery, useExecuteCsvQueryInternal } from './use-execute-csv-query';
4
4
  export { ExecuteQueryByWidgetId } from './execute-query-by-widget-id';
5
5
  export { useExecuteQueryByWidgetId, executeQueryByWidgetId, } from './use-execute-query-by-widget-id';
6
6
  export { useExecutePivotQuery } from './use-execute-pivot-query';
@@ -239,7 +239,7 @@ export type ExecuteQueryResult = QueryState & {
239
239
  * Function to load more data rows
240
240
  *
241
241
  * @internal
242
- * */
242
+ */
243
243
  loadMore: (count: number) => void;
244
244
  };
245
245
  /** Configuration for {@link useExecuteCsvQuery} hook. */
@@ -1,12 +1,10 @@
1
1
  import { PropsWithChildren, type FunctionComponent } from 'react';
2
2
  import { SisenseContextPayload } from './sisense-context';
3
+ import { CustomContextProviderProps } from '../types';
3
4
  /** @internal */
4
5
  export type CustomSisenseContext = SisenseContextPayload;
5
6
  /** @internal */
6
- export type CustomSisenseContextProviderProps = {
7
- context?: CustomSisenseContext;
8
- error?: Error;
9
- };
7
+ export type CustomSisenseContextProviderProps = CustomContextProviderProps<CustomSisenseContext>;
10
8
  /**
11
9
  * Custom Sisense Context Provider component that allows passing external context.
12
10
  *
@@ -1,13 +1,10 @@
1
1
  import { PropsWithChildren } from 'react';
2
- import { CompleteThemeSettings } from '../types';
2
+ import { CompleteThemeSettings, CustomContextProviderProps } from '../types';
3
3
  /** @internal */
4
- export type CustomThemeProviderProps = {
5
- context: {
6
- themeSettings: CompleteThemeSettings;
7
- skipTracking?: boolean;
8
- };
9
- error?: Error;
10
- };
4
+ export type CustomThemeProviderProps = CustomContextProviderProps<{
5
+ themeSettings: CompleteThemeSettings;
6
+ skipTracking?: boolean;
7
+ }>;
11
8
  /**
12
9
  * Custom Theme Provider component that allows passing external theme context.
13
10
  *
@@ -82,6 +82,9 @@ export declare const translation: {
82
82
  dimensionNotFound: string;
83
83
  attributeNotFound: string;
84
84
  };
85
+ addFilterPopover: {
86
+ noDataSources: string;
87
+ };
85
88
  };
86
89
  errorBoxText: string;
87
90
  chartNoData: string;
@@ -92,6 +92,9 @@ export declare const resources: {
92
92
  dimensionNotFound: string;
93
93
  attributeNotFound: string;
94
94
  };
95
+ addFilterPopover: {
96
+ noDataSources: string;
97
+ };
95
98
  };
96
99
  errorBoxText: string;
97
100
  chartNoData: string;
@@ -443,6 +446,9 @@ export declare const resources: {
443
446
  dimensionNotFound: string;
444
447
  attributeNotFound: string;
445
448
  };
449
+ addFilterPopover: {
450
+ noDataSources: string;
451
+ };
446
452
  };
447
453
  errorBoxText: string;
448
454
  chartNoData: string;
@@ -70,12 +70,12 @@ export type SeriesLabels = {
70
70
  /**
71
71
  * Boolean flag that defines if value should be shown in series labels
72
72
  * (if not specified, value will be shown by default)
73
- * */
73
+ */
74
74
  showValue?: boolean;
75
75
  /**
76
76
  * Boolean flag that defines if percentage should be shown in series labels
77
77
  * (only applicable for subtypes that support percentage, like "stacked100")
78
- * */
78
+ */
79
79
  showPercentage?: boolean;
80
80
  };
81
81
  /**
@@ -1201,7 +1201,7 @@ export interface WidgetContainerStyleOptions {
1201
1201
  * Configuration options that define functional style of the various elements of the Nlq Chart Widget
1202
1202
  *
1203
1203
  * @internal
1204
- * */
1204
+ */
1205
1205
  export type NlqChartWidgetStyleOptions = {
1206
1206
  header?: {
1207
1207
  hidden?: boolean;
@@ -1655,6 +1655,7 @@ export type CustomTranslationObject = {
1655
1655
  };
1656
1656
  /**
1657
1657
  * Single Tabber Widget tab object without styling
1658
+ *
1658
1659
  * @internal
1659
1660
  */
1660
1661
  export type TabberTab = {
@@ -1663,6 +1664,7 @@ export type TabberTab = {
1663
1664
  };
1664
1665
  /**
1665
1666
  * Tabber widget DTO style property
1667
+ *
1666
1668
  * @internal
1667
1669
  */
1668
1670
  export type TabberDtoStyle = TabberStyleProps & {
@@ -1670,6 +1672,7 @@ export type TabberDtoStyle = TabberStyleProps & {
1670
1672
  };
1671
1673
  /**
1672
1674
  * Configuration options that define style of the various elements of the Tabber component.
1675
+ *
1673
1676
  * @internal
1674
1677
  */
1675
1678
  export type TabberStyleOptions = {
@@ -1690,14 +1693,24 @@ export type TabberStyleOptions = {
1690
1693
  };
1691
1694
  /**
1692
1695
  * Configuration options that defined tabber look and feel, including tabs and active tab.
1696
+ *
1693
1697
  * @internal
1694
1698
  */
1695
1699
  export type TabberStyleProps = TabberStyleOptions & TabberConfig;
1696
1700
  /**
1697
1701
  * Tabber business logic configuration
1702
+ *
1698
1703
  * @internal
1699
1704
  */
1700
1705
  export type TabberConfig = {
1701
1706
  tabs: TabberTab[];
1702
1707
  activeTab: number;
1703
1708
  };
1709
+ /** @internal */
1710
+ export type CustomContextProviderProps<P> = {
1711
+ context: P;
1712
+ error?: undefined;
1713
+ } | {
1714
+ context?: undefined;
1715
+ error: Error;
1716
+ };
@@ -4785,6 +4785,13 @@ export declare function getDashboardFilters(dashboardFilters: Array<FilterDto |
4785
4785
  sort?: "desc" | "asc" | undefined;
4786
4786
  in?: {
4787
4787
  selected?: {
4788
+ /**
4789
+ * Checks if a highlight filter is applicable to a widget.
4790
+ *
4791
+ * @param {FilterDto} filter - The filter to be checked.
4792
+ * @param {WidgetDto} widget - The widget that filters are applied to.
4793
+ * @returns {boolean} `true` if the filter is applicable; otherwise, `false`.
4794
+ */
4788
4795
  jaql: import("@sisense/sdk-data").FilterJaql;
4789
4796
  } | undefined;
4790
4797
  } | undefined;
@@ -1,6 +1,7 @@
1
1
  import { DashboardModel, WidgetModel } from '../models';
2
2
  /**
3
3
  * Custom hook for fetching a dashboard model and a widget model.
4
+ *
4
5
  * @returns
5
6
  */
6
7
  export declare function useGetDashboardModelAndWidgetModel({ widgetOid, dashboardOid, shouldLoadFullDashboard, }: {
@@ -1,30 +1,35 @@
1
1
  import { TabberWidgetProps } from '../props';
2
2
  /**
3
3
  * Tabber widget tab size
4
+ *
4
5
  * @group TabberWidget
5
6
  * @internal
6
7
  */
7
8
  export type TabSize = 'SMALL' | 'MEDIUM' | 'LARGE';
8
9
  /**
9
10
  * Tabber widget tab interval
11
+ *
10
12
  * @group TabberWidget
11
13
  * @internal
12
14
  */
13
15
  export type TabInterval = 'SMALL' | 'MEDIUM' | 'LARGE';
14
16
  /**
15
17
  * Tabber widget tab alignment
18
+ *
16
19
  * @group TabberWidget
17
20
  * @internal
18
21
  */
19
22
  export type TabAlignment = 'LEFT' | 'CENTER' | 'RIGHT';
20
23
  /**
21
24
  * Tabber widget tab corner radius
25
+ *
22
26
  * @group TabberWidget
23
27
  * @internal
24
28
  */
25
29
  export type TabCornerRadius = 'SMALL' | 'MEDIUM' | 'LARGE' | 'NONE';
26
30
  /**
27
31
  * Visual representation of a Fusion's tabber widget
32
+ *
28
33
  * @param styleOptions
29
34
  * @param description
30
35
  * @param props