@sisense/sdk-ui 1.33.0 → 2.0.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.
- package/dist/ai.cjs +9 -9
- package/dist/ai.js +566 -578
- package/dist/analytics-composer.cjs +120 -119
- package/dist/analytics-composer.js +3235 -2506
- package/dist/{derive-chart-family-nTKwlMms.js → derive-chart-family-BLaI9-3r.js} +27266 -27205
- package/dist/derive-chart-family-CxqjTyNt.cjs +758 -0
- package/dist/dimensions-C-VKss5V.cjs +1 -0
- package/dist/dimensions-Cfq9FexH.js +200 -0
- package/dist/index.cjs +31 -18
- package/dist/index.js +6117 -6185
- package/dist/packages/sdk-ui/src/ai/ai-context-provider.d.ts +13 -6
- package/dist/packages/sdk-ui/src/ai/chat-config.d.ts +4 -2
- package/dist/packages/sdk-ui/src/ai/chatbot.d.ts +17 -7
- package/dist/packages/sdk-ui/src/ai/custom-ai-context-provider.d.ts +4 -6
- package/dist/packages/sdk-ui/src/ai/get-nlg-insights.d.ts +0 -20
- package/dist/packages/sdk-ui/src/ai/index.d.ts +6 -4
- package/dist/packages/sdk-ui/src/ai/use-final-nlq-response.d.ts +20 -0
- package/dist/packages/sdk-ui/src/ai/use-get-nlg-insights.d.ts +0 -12
- package/dist/packages/sdk-ui/src/ai/use-get-nlq-result.d.ts +1 -4
- package/dist/packages/sdk-ui/src/ai/use-get-query-recommendations.d.ts +1 -4
- package/dist/packages/sdk-ui/src/analytics-composer/{common → code}/stringify-props.d.ts +10 -2
- package/dist/packages/sdk-ui/src/analytics-composer/common/custom-superjson.d.ts +16 -0
- package/dist/packages/sdk-ui/src/analytics-composer/dashboard/dashboard-composer.d.ts +8 -0
- package/dist/packages/sdk-ui/src/analytics-composer/dashboard/stringify-widgets.d.ts +3 -0
- package/dist/packages/sdk-ui/src/analytics-composer/dashboard/to-dashboard-code.d.ts +3 -0
- package/dist/packages/sdk-ui/src/analytics-composer/index.d.ts +4 -0
- package/dist/packages/sdk-ui/src/analytics-composer/query/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/analytics-composer/query/query-translator.d.ts +1 -0
- package/dist/packages/sdk-ui/src/analytics-composer/query/simplify-metadata-item.d.ts +9 -0
- package/dist/packages/sdk-ui/src/analytics-composer/types.d.ts +95 -5
- package/dist/packages/sdk-ui/src/analytics-composer/widget/chart-options/get-widget-options.d.ts +1 -1
- package/dist/packages/sdk-ui/src/analytics-composer/widget/to-widget-code.d.ts +3 -1
- package/dist/packages/sdk-ui/src/api/rest-api.d.ts +3 -0
- package/dist/packages/sdk-ui/src/app/client-application.d.ts +3 -55
- package/dist/packages/sdk-ui/src/area-range-chart.d.ts +0 -1
- package/dist/packages/sdk-ui/src/chart-data/table-data.d.ts +10 -0
- package/dist/packages/sdk-ui/src/common/components/grouped-items-browser/types.d.ts +2 -0
- package/dist/packages/sdk-ui/src/common/components/menu/types.d.ts +1 -0
- package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/hooks/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/hooks/use-data-accumulation.d.ts +1 -0
- 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
- package/dist/packages/sdk-ui/src/common/hooks/decorators/with-lazy-loading/helpers/utils/index.d.ts +0 -1
- package/dist/packages/sdk-ui/src/common/hooks/use-defaults.d.ts +1 -0
- package/dist/packages/sdk-ui/src/dashboard/components/content-panel.d.ts +1 -0
- package/dist/packages/sdk-ui/src/dashboard/dashboard-helpers.d.ts +0 -12
- package/dist/packages/sdk-ui/src/dashboard/index.d.ts +1 -1
- package/dist/packages/sdk-ui/src/dashboard/types.d.ts +9 -3
- package/dist/packages/sdk-ui/src/dashboard/use-composed-dashboard.d.ts +1 -4
- package/dist/packages/sdk-ui/src/data-browser/add-filter-popover/add-filter-data-browser.d.ts +8 -1
- package/dist/packages/sdk-ui/src/data-browser/add-filter-popover/add-filter-popover.d.ts +6 -1
- package/dist/packages/sdk-ui/src/data-browser/dimensions-browser/types.d.ts +8 -0
- package/dist/packages/sdk-ui/src/filters/components/cascading-filter-tile/cascading-filter-tile.d.ts +2 -0
- package/dist/packages/sdk-ui/src/filters/components/cascading-filter-tile/cascading-level-filter.d.ts +3 -1
- package/dist/packages/sdk-ui/src/filters/components/criteria-filter-tile/index.d.ts +0 -1
- package/dist/packages/sdk-ui/src/filters/components/date-filter/relative-date-filter-tile/relative-date-filter.d.ts +5 -1
- package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/filter-editor-context.d.ts +3 -1
- package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/filter-editor-popover.d.ts +2 -1
- package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/filter-editor.d.ts +2 -1
- package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/hooks/use-get-attribute-stats.d.ts +2 -1
- package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/sections/common/granularities.d.ts +36 -6
- package/dist/packages/sdk-ui/src/filters/components/filter-editor-popover/types.d.ts +2 -0
- package/dist/packages/sdk-ui/src/filters/components/filter-tile-container.d.ts +1 -0
- package/dist/packages/sdk-ui/src/filters/components/filter-tile.d.ts +5 -4
- package/dist/packages/sdk-ui/src/filters/components/filters-panel/hooks/use-existing-filter-editing.d.ts +1 -1
- package/dist/packages/sdk-ui/src/filters/components/filters-panel/hooks/use-new-filter-adding.d.ts +3 -1
- package/dist/packages/sdk-ui/src/filters/hooks/use-get-filter-members.d.ts +3 -3
- package/dist/packages/sdk-ui/src/index-typedoc.d.ts +4 -1
- package/dist/packages/sdk-ui/src/index.d.ts +4 -3
- package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-dto-utils.d.ts +0 -1
- package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-utils.d.ts +1 -0
- package/dist/packages/sdk-ui/src/models/dashboard/types.d.ts +1 -0
- package/dist/packages/sdk-ui/src/models/dashboard/use-dashboard-model/use-dashboard-model-reducer.d.ts +15 -1
- package/dist/packages/sdk-ui/src/models/hierarchy/types.d.ts +0 -1
- package/dist/packages/sdk-ui/src/models/widget/types.d.ts +1 -1
- package/dist/packages/sdk-ui/src/models/widget/widget-model-translator.d.ts +2 -12
- package/dist/packages/sdk-ui/src/models/widget/widget-model.d.ts +1 -125
- package/dist/packages/sdk-ui/src/plugins-provider/custom-plugins-provider.d.ts +4 -9
- package/dist/packages/sdk-ui/src/props.d.ts +27 -45
- package/dist/packages/sdk-ui/src/query-execution/index.d.ts +1 -1
- package/dist/packages/sdk-ui/src/query-execution/types.d.ts +2 -4
- package/dist/packages/sdk-ui/src/sisense-context/custom-sisense-context-provider.d.ts +2 -4
- package/dist/packages/sdk-ui/src/theme-provider/custom-theme-provider.d.ts +5 -8
- package/dist/packages/sdk-ui/src/translation/resources/en.d.ts +5 -1
- package/dist/packages/sdk-ui/src/translation/resources/index.d.ts +10 -2
- package/dist/packages/sdk-ui/src/types.d.ts +60 -40
- package/dist/packages/sdk-ui/src/utils/{utility-types.d.ts → utility-types/basic-utility-types.d.ts} +0 -34
- package/dist/packages/sdk-ui/src/utils/utility-types/distributive-omit.d.ts +24 -0
- package/dist/packages/sdk-ui/src/utils/utility-types/index.d.ts +4 -0
- package/dist/packages/sdk-ui/src/utils/utility-types/rest-api-hook-state.d.ts +35 -0
- package/dist/packages/sdk-ui/src/utils/utility-types/soft-union.d.ts +35 -0
- package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-data-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-drilldown-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-style-options.d.ts +2 -2
- package/dist/packages/sdk-ui/src/widget-by-id/types.d.ts +2 -2
- package/dist/packages/sdk-ui/src/widget-by-id/use-get-dashboard-model-and-widget-model.d.ts +1 -0
- package/dist/packages/sdk-ui/src/widget-by-id/utils.d.ts +23 -16
- package/dist/packages/sdk-ui/src/widgets/tabber-widget.d.ts +5 -0
- package/dist/packages/sdk-ui/src/widgets/widget.d.ts +0 -1
- package/dist/{use-common-filters-BNKt9a0z.cjs → use-common-filters-BGGGgJJ5.cjs} +48 -48
- package/dist/{use-common-filters--WPkVexd.js → use-common-filters-Cmyb86sc.js} +5339 -5351
- package/dist/widget-composer-BJURHrVD.cjs +428 -0
- package/dist/widget-composer-C4rwNt4P.js +959 -0
- package/package.json +14 -10
- package/dist/derive-chart-family-B4sA-ao-.cjs +0 -758
- package/dist/packages/sdk-ui/src/ai/common/beta-label.d.ts +0 -1
- package/dist/packages/sdk-ui/src/analytics-composer/widget/stringify-props.d.ts +0 -8
- package/dist/packages/sdk-ui/src/filters/components/criteria-filter-tile/types.d.ts +0 -7
- package/dist/packages/sdk-ui/src/utils/check-and-notify-about-deprecated-prop.d.ts +0 -1
- package/dist/packages/sdk-ui/src/widget-by-id/dashboard-widget.d.ts +0 -27
- package/dist/widget-composer-CobNNZ1e.js +0 -742
- package/dist/widget-composer-DPqi_qzU.cjs +0 -316
- /package/dist/packages/sdk-ui/src/analytics-composer/{widget → code}/stringify-filters.d.ts +0 -0
|
@@ -61,6 +61,20 @@ export type UseDashboardModelAddWidgetAction = {
|
|
|
61
61
|
* @internal
|
|
62
62
|
*/
|
|
63
63
|
export declare function dashboardReducer(state: UseDashboardModelState, action: UseDashboardModelInternalAction): UseDashboardModelState;
|
|
64
|
+
/**
|
|
65
|
+
* Translates filters and relations to DTOs.
|
|
66
|
+
*
|
|
67
|
+
* @param filtersOrFilterRelations - The filters or filter relations to translate
|
|
68
|
+
* @returns The translated filters and relations DTOs for Fusion
|
|
69
|
+
* @internal
|
|
70
|
+
*/
|
|
71
|
+
export declare function translateFiltersAndRelationsToDto(filtersOrFilterRelations: Filter[] | FilterRelations): {
|
|
72
|
+
filters: (import("../../../api/types/dashboard-dto").FilterDto | import("../../../api/types/dashboard-dto").CascadingFilterDto)[];
|
|
73
|
+
filterRelations: {
|
|
74
|
+
datasource: string;
|
|
75
|
+
filterRelations: import("@sisense/sdk-data").FilterRelationsModelNode;
|
|
76
|
+
}[] | undefined;
|
|
77
|
+
};
|
|
64
78
|
/**
|
|
65
79
|
* Middleware that persists the dashboard model changes to the Sisense server.
|
|
66
80
|
*
|
|
@@ -68,4 +82,4 @@ export declare function dashboardReducer(state: UseDashboardModelState, action:
|
|
|
68
82
|
* @param reducer - The dashboard model reducer
|
|
69
83
|
* @internal
|
|
70
84
|
*/
|
|
71
|
-
export declare function persistDashboardModelMiddleware(
|
|
85
|
+
export declare function persistDashboardModelMiddleware(dashboardOid: string | undefined, action: UseDashboardModelInternalAction, restApi: RestApi): Promise<UseDashboardModelInternalAction>;
|
|
@@ -2,7 +2,7 @@ import { ChartType } from '../../index';
|
|
|
2
2
|
/**
|
|
3
3
|
* Widget type
|
|
4
4
|
*
|
|
5
|
-
* todo: as a future refactoring need to replace
|
|
5
|
+
* todo: as a future refactoring need to replace this type by combination of WidgetType and ChartType
|
|
6
6
|
*
|
|
7
7
|
* @internal
|
|
8
8
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
|
|
2
2
|
import { WidgetModel } from './widget-model.js';
|
|
3
3
|
import { ChartProps, ChartWidgetProps, WidgetProps, PivotTableProps, PivotTableWidgetProps, PluginWidgetProps, TableProps, TableWidgetProps, TextWidgetProps, CommonWidgetProps } from '../../props';
|
|
4
|
-
import {
|
|
4
|
+
import { JaqlDataSourceForDto } from '@sisense/sdk-data';
|
|
5
5
|
import { CompleteThemeSettings } from '../../types.js';
|
|
6
6
|
import { WidgetDto } from '../../widget-by-id/types.js';
|
|
7
7
|
import { AppSettings } from '../../app/settings/settings.js';
|
|
@@ -160,16 +160,6 @@ export declare function fromChartWidgetProps(chartWidgetProps: ChartWidgetProps)
|
|
|
160
160
|
* @internal
|
|
161
161
|
*/
|
|
162
162
|
export declare function fromWidgetProps(widgetProps: WidgetProps): WidgetModel;
|
|
163
|
-
/**
|
|
164
|
-
* Data source as specified in the jaql
|
|
165
|
-
* but with required filelds
|
|
166
|
-
*
|
|
167
|
-
* @internal
|
|
168
|
-
*/
|
|
169
|
-
export type JaqlDataSourceForWidgetDto = JaqlDataSource & {
|
|
170
|
-
id: string;
|
|
171
|
-
address?: string;
|
|
172
|
-
};
|
|
173
163
|
/**
|
|
174
164
|
* Translates a {@link WidgetModel} to {@link WidgetDto}.
|
|
175
165
|
*
|
|
@@ -178,4 +168,4 @@ export type JaqlDataSourceForWidgetDto = JaqlDataSource & {
|
|
|
178
168
|
* @returns WidgetDto
|
|
179
169
|
* @internal
|
|
180
170
|
*/
|
|
181
|
-
export declare function toWidgetDto(widgetModel: WidgetModel, dataSource?:
|
|
171
|
+
export declare function toWidgetDto(widgetModel: WidgetModel, dataSource?: JaqlDataSourceForDto): WidgetDto;
|
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
import { DataSource, Filter } from '@sisense/sdk-data';
|
|
2
2
|
import { ChartDataOptions, PivotTableDataOptions } from '../../chart-data-options/types';
|
|
3
|
-
import { WidgetType } from '../../
|
|
4
|
-
import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps, TextWidgetProps } from '../../props';
|
|
5
|
-
import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
|
|
3
|
+
import type { WidgetType } from '../../props';
|
|
6
4
|
import { ChartType, DrilldownOptions, WidgetStyleOptions } from '../../types';
|
|
7
5
|
import { EmptyObject } from '@sisense/sdk-query-client/src/helpers/utility-types';
|
|
8
6
|
/**
|
|
@@ -34,8 +32,6 @@ export interface WidgetModel {
|
|
|
34
32
|
dataSource: DataSource;
|
|
35
33
|
/**
|
|
36
34
|
* Widget type.
|
|
37
|
-
*
|
|
38
|
-
* @deprecated Use {@link widgetModelTranslator} methods instead
|
|
39
35
|
*/
|
|
40
36
|
widgetType: WidgetType;
|
|
41
37
|
/**
|
|
@@ -68,125 +64,5 @@ export interface WidgetModel {
|
|
|
68
64
|
* Widget drilldown options.
|
|
69
65
|
*/
|
|
70
66
|
drilldownOptions: DrilldownOptions;
|
|
71
|
-
/**
|
|
72
|
-
* Returns the parameters to be used for executing a query for the widget.
|
|
73
|
-
*
|
|
74
|
-
* @example
|
|
75
|
-
* ```tsx
|
|
76
|
-
* const {data, isLoading, isError} = useExecuteQuery(widget.getExecuteQueryParams());
|
|
77
|
-
* ```
|
|
78
|
-
*
|
|
79
|
-
* Note: this method is not supported for getting pivot query.
|
|
80
|
-
* Use {@link getExecutePivotQueryParams} instead for getting query parameters for the pivot widget.
|
|
81
|
-
* @deprecated Use {@link widgetModelTranslator.toExecuteQueryParams} instead
|
|
82
|
-
*/
|
|
83
|
-
getExecuteQueryParams(): ExecuteQueryParams;
|
|
84
|
-
/**
|
|
85
|
-
* Returns the parameters to be used for executing a query for the pivot widget.
|
|
86
|
-
*
|
|
87
|
-
* @example
|
|
88
|
-
* ```tsx
|
|
89
|
-
* const {data, isLoading, isError} = useExecutePivotQuery(widget.getExecutePivotQueryParams());
|
|
90
|
-
* ```
|
|
91
|
-
*
|
|
92
|
-
* Note: this method is supported only for getting pivot query.
|
|
93
|
-
* Use {@link getExecuteQueryParams} instead for getting query parameters for non-pivot widgets.
|
|
94
|
-
* @deprecated Use {@link widgetModelTranslator.toExecutePivotQueryParams} instead
|
|
95
|
-
*/
|
|
96
|
-
getExecutePivotQueryParams(): ExecutePivotQueryParams;
|
|
97
|
-
/**
|
|
98
|
-
* Returns the props to be used for rendering a chart.
|
|
99
|
-
*
|
|
100
|
-
* @example
|
|
101
|
-
* ```tsx
|
|
102
|
-
* <Chart {...widget.getChartProps()} />
|
|
103
|
-
* ```
|
|
104
|
-
*
|
|
105
|
-
* Note: this method is not supported for pivot table widgets.
|
|
106
|
-
* Use {@link getPivotTableProps} instead for getting props for the <PivotTable> component.
|
|
107
|
-
* @deprecated Use {@link widgetModelTranslator.toChartProps} instead
|
|
108
|
-
*/
|
|
109
|
-
getChartProps(): ChartProps;
|
|
110
|
-
/**
|
|
111
|
-
* Returns the props to be used for rendering a table.
|
|
112
|
-
*
|
|
113
|
-
* @example
|
|
114
|
-
* ```tsx
|
|
115
|
-
* <Table {...widget.getTableProps()} />
|
|
116
|
-
* ```
|
|
117
|
-
*
|
|
118
|
-
* Note: this method is not supported for chart and pivot widgets.
|
|
119
|
-
* Use {@link getChartProps} instead for getting props for the <Chart> component.
|
|
120
|
-
* Use {@link getPivotTableProps} instead for getting props for the <PivotTable> component.
|
|
121
|
-
* @deprecated Use {@link widgetModelTranslator.toTableProps} instead
|
|
122
|
-
*/
|
|
123
|
-
getTableProps(): TableProps;
|
|
124
|
-
/**
|
|
125
|
-
* Returns the props to be used for rendering a pivot table.
|
|
126
|
-
*
|
|
127
|
-
* @example
|
|
128
|
-
* ```tsx
|
|
129
|
-
* <PivotTable {...widget.getPivotTableProps()} />
|
|
130
|
-
* ```
|
|
131
|
-
*
|
|
132
|
-
* Note: this method is not supported for chart or table widgets.
|
|
133
|
-
* Use {@link getChartProps} instead for getting props for the <Chart> component.
|
|
134
|
-
* Use {@link getTableProps} instead for getting props for the <Table> component.
|
|
135
|
-
* @deprecated Use {@link widgetModelTranslator.toPivotTableProps} instead
|
|
136
|
-
*/
|
|
137
|
-
getPivotTableProps(): PivotTableProps;
|
|
138
|
-
/**
|
|
139
|
-
* Returns the props to be used for rendering a chart widget.
|
|
140
|
-
*
|
|
141
|
-
* @example
|
|
142
|
-
* ```tsx
|
|
143
|
-
* <ChartWidget {...widget.getChartWidgetProps()} />
|
|
144
|
-
* ```
|
|
145
|
-
*
|
|
146
|
-
* Note: this method is not supported for pivot widgets.
|
|
147
|
-
* @deprecated Use {@link widgetModelTranslator.toChartWidgetProps} instead
|
|
148
|
-
*/
|
|
149
|
-
getChartWidgetProps(): ChartWidgetProps;
|
|
150
|
-
/**
|
|
151
|
-
* Returns the props to be used for rendering a table widget.
|
|
152
|
-
*
|
|
153
|
-
* @example
|
|
154
|
-
* ```tsx
|
|
155
|
-
* <TableWidget {...widget.getTableWidgetProps()} />
|
|
156
|
-
* ```
|
|
157
|
-
*
|
|
158
|
-
* Note: this method is not supported for chart widgets.
|
|
159
|
-
* Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
|
|
160
|
-
* @deprecated Use {@link widgetModelTranslator.toTableWidgetProps} instead
|
|
161
|
-
* @internal
|
|
162
|
-
*/
|
|
163
|
-
getTableWidgetProps(): TableWidgetProps;
|
|
164
|
-
/**
|
|
165
|
-
* Returns the props to be used for rendering a pivot table widget.
|
|
166
|
-
*
|
|
167
|
-
* @example
|
|
168
|
-
* ```tsx
|
|
169
|
-
* <PivotTableWidget {...widget.getPivotTableWidgetProps()} />
|
|
170
|
-
* ```
|
|
171
|
-
|
|
172
|
-
* Note: this method is not supported for chart or table widgets.
|
|
173
|
-
* Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
|
|
174
|
-
* @deprecated Use {@link widgetModelTranslator.toPivotTableWidgetProps} instead
|
|
175
|
-
*/
|
|
176
|
-
getPivotTableWidgetProps(): PivotTableWidgetProps;
|
|
177
|
-
/**
|
|
178
|
-
* Returns the props to be used for rendering a text widget.
|
|
179
|
-
*
|
|
180
|
-
* @example
|
|
181
|
-
* ```tsx
|
|
182
|
-
* <TextWidget {...widget.getTextWidgetProps()} />
|
|
183
|
-
* ```
|
|
184
|
-
*
|
|
185
|
-
* Note: this method is not supported for chart or pivot widgets.
|
|
186
|
-
* Use {@link getChartWidgetProps} instead for getting props for the <ChartWidget> component.
|
|
187
|
-
* Use {@link getPivotTableWidgetProps} instead for getting props for the <PivotTableWidget> component.
|
|
188
|
-
* @deprecated Use {@link widgetModelTranslator.toTextWidgetProps} instead
|
|
189
|
-
*/
|
|
190
|
-
getTextWidgetProps(): TextWidgetProps;
|
|
191
67
|
}
|
|
192
68
|
export declare const isWidgetModel: (widget: any) => widget is WidgetModel;
|
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { PropsWithChildren } from 'react';
|
|
2
2
|
import { PluginComponent, PluginComponentProps } from './types';
|
|
3
|
+
import { CustomContextProviderProps } from '../types';
|
|
3
4
|
/** @internal */
|
|
4
|
-
export type CustomPluginsProviderProps
|
|
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>>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Attribute, Filter, Measure, DataSource, Data, QueryResultData, FilterRelations } from '@sisense/sdk-data';
|
|
2
|
-
import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions,
|
|
2
|
+
import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, IndicatorRenderOptions, TabberStyleProps } from './types';
|
|
3
3
|
import { HighchartsOptions } from './chart-options-processor/chart-options-service';
|
|
4
4
|
import { ComponentType, PropsWithChildren, ReactNode } from 'react';
|
|
5
5
|
import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions } from './chart-data-options/types';
|
|
@@ -10,6 +10,7 @@ import { HookEnableParam } from './common/hooks/types';
|
|
|
10
10
|
import { ExecuteQueryResult } from './query-execution/types';
|
|
11
11
|
import { Hierarchy } from './models';
|
|
12
12
|
import { BeforeMenuOpenHandler } from './common/components/menu/types';
|
|
13
|
+
import { DistributiveOmit } from './utils/utility-types/distributive-omit';
|
|
13
14
|
export type { MenuItemSection, HighchartsOptions };
|
|
14
15
|
/**
|
|
15
16
|
* Configurations and authentication for Sisense Context.
|
|
@@ -106,7 +107,8 @@ export interface SisenseContextProviderProps {
|
|
|
106
107
|
* Used only with SSO authentication.
|
|
107
108
|
* If not specified, the default value is `false`.
|
|
108
109
|
*
|
|
109
|
-
* @
|
|
110
|
+
* @category Sisense Authentication
|
|
111
|
+
*
|
|
110
112
|
*/
|
|
111
113
|
enableSilentPreAuth?: boolean;
|
|
112
114
|
}
|
|
@@ -133,11 +135,7 @@ export interface ExecuteQueryProps {
|
|
|
133
135
|
count?: number;
|
|
134
136
|
/** {@inheritDoc ExecuteQueryParams.offset} */
|
|
135
137
|
offset?: number;
|
|
136
|
-
/**
|
|
137
|
-
* {@inheritDoc ExecuteQueryParams.ungroup}
|
|
138
|
-
*
|
|
139
|
-
* @internal
|
|
140
|
-
*/
|
|
138
|
+
/** {@inheritDoc ExecuteQueryParams.ungroup} */
|
|
141
139
|
ungroup?: boolean;
|
|
142
140
|
/** Function as child component that is called to render the query results */
|
|
143
141
|
children?: (queryResult: ExecuteQueryResult) => ReactNode;
|
|
@@ -299,7 +297,6 @@ interface BaseChartEventProps {
|
|
|
299
297
|
* Can be used to inject modification of queried data.
|
|
300
298
|
*
|
|
301
299
|
* @category Callbacks
|
|
302
|
-
* @internal
|
|
303
300
|
*/
|
|
304
301
|
onDataReady?: (data: Data) => Data;
|
|
305
302
|
}
|
|
@@ -920,19 +917,6 @@ export interface WidgetByIdProps extends Omit<ChartWidgetProps, 'dataSource' | '
|
|
|
920
917
|
*/
|
|
921
918
|
drilldownOptions?: DrilldownOptions;
|
|
922
919
|
}
|
|
923
|
-
/**
|
|
924
|
-
* Props for the {@link DashboardWidget} component
|
|
925
|
-
*
|
|
926
|
-
* @deprecated Use {@link WidgetById} and {@link WidgetByIdProps} instead
|
|
927
|
-
*/
|
|
928
|
-
export interface DashboardWidgetProps extends WidgetByIdProps {
|
|
929
|
-
/**
|
|
930
|
-
* Style options for the widget including the widget container and the chart or table inside.
|
|
931
|
-
*
|
|
932
|
-
* @category Widget
|
|
933
|
-
*/
|
|
934
|
-
styleOptions?: DashboardWidgetStyleOptions;
|
|
935
|
-
}
|
|
936
920
|
/**
|
|
937
921
|
* Props for the {@link ChartWidget} component
|
|
938
922
|
*
|
|
@@ -1222,20 +1206,19 @@ export interface PluginWidgetProps {
|
|
|
1222
1206
|
description?: string;
|
|
1223
1207
|
}
|
|
1224
1208
|
/**
|
|
1225
|
-
* A utility type that combines widget-specific properties (`
|
|
1226
|
-
*
|
|
1227
|
-
* This is used to extend the props of a widget with its respective widget type.
|
|
1209
|
+
* A utility type that combines widget-specific properties (`BaseWidget`)
|
|
1210
|
+
* with a common widget props including corresponding widget type (`Type`).
|
|
1228
1211
|
*/
|
|
1229
|
-
export type
|
|
1212
|
+
export type WithCommonWidgetProps<BaseWidget, Type extends WidgetType> = BaseWidget & {
|
|
1213
|
+
/**
|
|
1214
|
+
* Unique identifier of the widget within the container component (dashboard)
|
|
1215
|
+
*
|
|
1216
|
+
*/
|
|
1217
|
+
readonly id: string;
|
|
1230
1218
|
/**
|
|
1231
1219
|
* Widget type
|
|
1232
1220
|
*/
|
|
1233
|
-
widgetType:
|
|
1234
|
-
};
|
|
1235
|
-
/**
|
|
1236
|
-
* Props for the facade widget component.
|
|
1237
|
-
*/
|
|
1238
|
-
export type CommonWidgetProps = (WithWidgetType<ChartWidgetProps, 'chart'> | WithWidgetType<PivotTableWidgetProps, 'pivot'> | WithWidgetType<TextWidgetProps, 'text'> | WithWidgetType<PluginWidgetProps, 'plugin'>) & {
|
|
1221
|
+
widgetType: Type;
|
|
1239
1222
|
/**
|
|
1240
1223
|
* Optional handler function to process menu options before opening the context menu.
|
|
1241
1224
|
*
|
|
@@ -1243,16 +1226,20 @@ export type CommonWidgetProps = (WithWidgetType<ChartWidgetProps, 'chart'> | Wit
|
|
|
1243
1226
|
*/
|
|
1244
1227
|
onBeforeMenuOpen?: BeforeMenuOpenHandler;
|
|
1245
1228
|
};
|
|
1229
|
+
/**
|
|
1230
|
+
* Type of the widget component.
|
|
1231
|
+
*/
|
|
1232
|
+
export type WidgetType = 'chart' | 'pivot' | 'text' | 'plugin';
|
|
1246
1233
|
/**
|
|
1247
1234
|
* Props for the widget component within a container component like dashboard.
|
|
1248
1235
|
*/
|
|
1249
|
-
export type WidgetProps =
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1236
|
+
export type WidgetProps = WithCommonWidgetProps<ChartWidgetProps, 'chart'> | WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'> | WithCommonWidgetProps<TextWidgetProps, 'text'> | WithCommonWidgetProps<PluginWidgetProps, 'plugin'>;
|
|
1237
|
+
/**
|
|
1238
|
+
* Props for the facade widget component.
|
|
1239
|
+
*
|
|
1240
|
+
* @internal
|
|
1241
|
+
*/
|
|
1242
|
+
export type CommonWidgetProps = DistributiveOmit<WidgetProps, 'id'>;
|
|
1256
1243
|
/**
|
|
1257
1244
|
* Props for {@link ExecuteQueryByWidgetId} component.
|
|
1258
1245
|
*
|
|
@@ -1476,13 +1463,6 @@ export type DrilldownWidgetConfig = {
|
|
|
1476
1463
|
* Props for the {@link DrilldownWidget} component
|
|
1477
1464
|
*/
|
|
1478
1465
|
export interface DrilldownWidgetProps {
|
|
1479
|
-
/**
|
|
1480
|
-
* List of dimensions to allow drilldowns on
|
|
1481
|
-
*
|
|
1482
|
-
* @category Widget
|
|
1483
|
-
* @deprecated Use {@link DrilldownWidgetProps.drilldownPaths} instead
|
|
1484
|
-
*/
|
|
1485
|
-
drilldownDimensions?: Attribute[];
|
|
1486
1466
|
/**
|
|
1487
1467
|
* Dimensions and hierarchies available for drilldown on.
|
|
1488
1468
|
*
|
|
@@ -1520,6 +1500,7 @@ export interface DrilldownWidgetProps {
|
|
|
1520
1500
|
}
|
|
1521
1501
|
/**
|
|
1522
1502
|
* Tabber widget props designed to be a current state and is provided by use-tabber hook
|
|
1503
|
+
*
|
|
1523
1504
|
* @internal
|
|
1524
1505
|
*/
|
|
1525
1506
|
export type TabberWidgetExtraProps = {
|
|
@@ -1528,6 +1509,7 @@ export type TabberWidgetExtraProps = {
|
|
|
1528
1509
|
};
|
|
1529
1510
|
/**
|
|
1530
1511
|
* Tabber widget props
|
|
1512
|
+
*
|
|
1531
1513
|
* @internal
|
|
1532
1514
|
*/
|
|
1533
1515
|
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';
|
|
@@ -209,11 +209,9 @@ export interface ExecuteQueryParams {
|
|
|
209
209
|
/**
|
|
210
210
|
* Boolean flag whether to include `ungroup: true` in non-aggregated JAQL queries.
|
|
211
211
|
*
|
|
212
|
-
* This improves computation and performance of querying
|
|
212
|
+
* This improves computation and performance of querying tables when no aggregation is needed
|
|
213
213
|
*
|
|
214
214
|
* If not specified, the default value is `false`
|
|
215
|
-
*
|
|
216
|
-
* @internal
|
|
217
215
|
*/
|
|
218
216
|
ungroup?: boolean;
|
|
219
217
|
/**
|
|
@@ -239,7 +237,7 @@ export type ExecuteQueryResult = QueryState & {
|
|
|
239
237
|
* Function to load more data rows
|
|
240
238
|
*
|
|
241
239
|
* @internal
|
|
242
|
-
|
|
240
|
+
*/
|
|
243
241
|
loadMore: (count: number) => void;
|
|
244
242
|
};
|
|
245
243
|
/** 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
|
-
|
|
6
|
-
|
|
7
|
-
|
|
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
|
*
|
|
@@ -41,6 +41,8 @@ export declare const translation: {
|
|
|
41
41
|
onlyPivotWidgetSupported: string;
|
|
42
42
|
onlyTextWidgetSupported: string;
|
|
43
43
|
onlyPluginWidgetSupported: string;
|
|
44
|
+
unsupportedWidgetType: string;
|
|
45
|
+
unsupportedFusionWidgetType: string;
|
|
44
46
|
};
|
|
45
47
|
unknownFilterInFilterRelations: string;
|
|
46
48
|
filterRelationsNotSupported: string;
|
|
@@ -82,6 +84,9 @@ export declare const translation: {
|
|
|
82
84
|
dimensionNotFound: string;
|
|
83
85
|
attributeNotFound: string;
|
|
84
86
|
};
|
|
87
|
+
addFilterPopover: {
|
|
88
|
+
noDataSources: string;
|
|
89
|
+
};
|
|
85
90
|
};
|
|
86
91
|
errorBoxText: string;
|
|
87
92
|
chartNoData: string;
|
|
@@ -223,7 +228,6 @@ export declare const translation: {
|
|
|
223
228
|
dataTopics: string;
|
|
224
229
|
chatbotDescription: string;
|
|
225
230
|
topicSelectPrompt: string;
|
|
226
|
-
betaLabel: string;
|
|
227
231
|
preview: string;
|
|
228
232
|
clearHistoryPrompt: string;
|
|
229
233
|
config: {
|
|
@@ -51,6 +51,8 @@ export declare const resources: {
|
|
|
51
51
|
onlyPivotWidgetSupported: string;
|
|
52
52
|
onlyTextWidgetSupported: string;
|
|
53
53
|
onlyPluginWidgetSupported: string;
|
|
54
|
+
unsupportedWidgetType: string;
|
|
55
|
+
unsupportedFusionWidgetType: string;
|
|
54
56
|
};
|
|
55
57
|
unknownFilterInFilterRelations: string;
|
|
56
58
|
filterRelationsNotSupported: string;
|
|
@@ -92,6 +94,9 @@ export declare const resources: {
|
|
|
92
94
|
dimensionNotFound: string;
|
|
93
95
|
attributeNotFound: string;
|
|
94
96
|
};
|
|
97
|
+
addFilterPopover: {
|
|
98
|
+
noDataSources: string;
|
|
99
|
+
};
|
|
95
100
|
};
|
|
96
101
|
errorBoxText: string;
|
|
97
102
|
chartNoData: string;
|
|
@@ -233,7 +238,6 @@ export declare const resources: {
|
|
|
233
238
|
dataTopics: string;
|
|
234
239
|
chatbotDescription: string;
|
|
235
240
|
topicSelectPrompt: string;
|
|
236
|
-
betaLabel: string;
|
|
237
241
|
preview: string;
|
|
238
242
|
clearHistoryPrompt: string;
|
|
239
243
|
config: {
|
|
@@ -402,6 +406,8 @@ export declare const resources: {
|
|
|
402
406
|
onlyPivotWidgetSupported: string;
|
|
403
407
|
onlyTextWidgetSupported: string;
|
|
404
408
|
onlyPluginWidgetSupported: string;
|
|
409
|
+
unsupportedWidgetType: string;
|
|
410
|
+
unsupportedFusionWidgetType: string;
|
|
405
411
|
};
|
|
406
412
|
unknownFilterInFilterRelations: string;
|
|
407
413
|
filterRelationsNotSupported: string;
|
|
@@ -443,6 +449,9 @@ export declare const resources: {
|
|
|
443
449
|
dimensionNotFound: string;
|
|
444
450
|
attributeNotFound: string;
|
|
445
451
|
};
|
|
452
|
+
addFilterPopover: {
|
|
453
|
+
noDataSources: string;
|
|
454
|
+
};
|
|
446
455
|
};
|
|
447
456
|
errorBoxText: string;
|
|
448
457
|
chartNoData: string;
|
|
@@ -584,7 +593,6 @@ export declare const resources: {
|
|
|
584
593
|
dataTopics: string;
|
|
585
594
|
chatbotDescription: string;
|
|
586
595
|
topicSelectPrompt: string;
|
|
587
|
-
betaLabel: string;
|
|
588
596
|
preview: string;
|
|
589
597
|
clearHistoryPrompt: string;
|
|
590
598
|
config: {
|