@sisense/sdk-ui 2.22.0 → 2.24.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 +19 -19
- package/dist/ai.js +59 -59
- package/dist/analytics-composer/node.cjs +1 -1
- package/dist/analytics-composer/node.js +2440 -1253
- package/dist/analytics-composer.cjs +47 -47
- package/dist/analytics-composer.js +135 -131
- package/dist/dimensions-C1R5YRt-.js +204 -0
- package/dist/dimensions-C7yXAoZs.cjs +1 -0
- package/dist/execute-query-0Y9Fn9Pf.cjs +1 -0
- package/dist/execute-query-b9oy2Egy.js +5869 -0
- package/dist/{index-NyouhE_A.cjs → index-Ck-0gJC9.cjs} +1 -1
- package/dist/{index-kxX21arA.js → index-r66Tjiqj.js} +39 -2
- package/dist/index.cjs +633 -616
- package/dist/index.js +18198 -17875
- package/dist/index.umd.js +1006 -949
- package/dist/packages/sdk-ui/src/domains/dashboarding/components/editable-layout/const.d.ts +1 -0
- package/dist/packages/sdk-ui/src/domains/dashboarding/components/editable-layout/smart-pointer-sensor.d.ts +17 -0
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/get-dashboard-model.d.ts +2 -1
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/types.d.ts +24 -2
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/utils.d.ts +2 -1
- package/dist/packages/sdk-ui/src/domains/dashboarding/dashboard-model/use-dashboard-model/use-dashboard-persistence.d.ts +2 -1
- package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/jtd/jtd-types.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/rename-widget/use-widget-renaming.d.ts +34 -0
- package/dist/packages/sdk-ui/src/domains/dashboarding/hooks/use-widget-csv-download.d.ts +24 -0
- package/dist/packages/sdk-ui/src/domains/dashboarding/types.d.ts +43 -1
- package/dist/packages/sdk-ui/src/domains/dashboarding/use-dashboard-theme.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/data-browser/add-filter-popover/add-filter-data-browser.d.ts +2 -1
- package/dist/packages/sdk-ui/src/domains/data-browser/data-schema-browser/data-schema-browser.d.ts +2 -1
- package/dist/packages/sdk-ui/src/domains/data-browser/dimensions-browser/types.d.ts +9 -1
- package/dist/packages/sdk-ui/src/domains/formulas/fetch-formula.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/query-execution/core/execute-query.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-execute-query-by-widget-id/use-execute-query-by-widget-id.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/query-execution/hooks/use-query-cache/use-query-cache.d.ts +2 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/components/boxplot-chart/boxplot-utils.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/helpers/get-load-data-function.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/helpers/use-translated-data-options.d.ts +12 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/helpers/data-loading.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/types.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/widgets/change-events.d.ts +73 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/chart-widget/types.d.ts +12 -2
- package/dist/packages/sdk-ui/src/domains/widgets/components/chart-widget/use-chart-widget-csv-download.d.ts +18 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/custom-widget/use-custom-widget-csv-download.d.ts +15 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/pivot-table-widget/types.d.ts +12 -2
- package/dist/packages/sdk-ui/src/domains/widgets/components/pivot-table-widget/use-pivot-widget-csv-download.d.ts +18 -0
- package/dist/packages/sdk-ui/src/domains/widgets/components/tabber-buttons-widget/types.d.ts +8 -8
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget/types.d.ts +21 -1
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-dashboard-filters.d.ts +3 -1
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-widget-data-options.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-widget-style-options/to-widget-dto-style.d.ts +11 -2
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/types.d.ts +1 -1
- package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/utils.d.ts +3 -2
- package/dist/packages/sdk-ui/src/domains/widgets/event-to-delta.d.ts +17 -0
- package/dist/packages/sdk-ui/src/domains/widgets/helpers/header-menu-utils.d.ts +14 -4
- package/dist/packages/sdk-ui/src/domains/widgets/helpers/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/domains/widgets/hooks/use-csv-query-file-loader.d.ts +16 -0
- package/dist/packages/sdk-ui/src/domains/widgets/hooks/use-title-renaming.d.ts +27 -0
- package/dist/packages/sdk-ui/src/domains/widgets/hooks/use-widget-header-management.d.ts +28 -0
- package/dist/packages/sdk-ui/src/domains/widgets/hooks/use-with-csv-download-menu-item.d.ts +22 -0
- package/dist/packages/sdk-ui/src/domains/widgets/shared/widget-container/widget-container.d.ts +3 -1
- package/dist/packages/sdk-ui/src/domains/widgets/shared/widget-header/types.d.ts +31 -0
- package/dist/packages/sdk-ui/src/domains/widgets/shared/widget-header/widget-header.d.ts +3 -1
- package/dist/packages/sdk-ui/src/domains/widgets/shared/widget-header/widget-menu-button.d.ts +1 -1
- package/dist/packages/sdk-ui/src/infra/api/rest-api.d.ts +4 -0
- package/dist/packages/sdk-ui/src/infra/api/types/dashboard-dto.d.ts +1 -1
- package/dist/packages/sdk-ui/src/infra/app/client-application.d.ts +5 -231
- package/dist/packages/sdk-ui/src/infra/app/helpers.d.ts +16 -0
- package/dist/packages/sdk-ui/src/infra/app/settings/settings.d.ts +1 -1
- package/dist/packages/sdk-ui/src/infra/app/settings/types/deployment-props.d.ts +3 -0
- package/dist/packages/sdk-ui/src/infra/app/settings/types/features.d.ts +2 -1
- package/dist/packages/sdk-ui/src/infra/app/types.d.ts +236 -0
- package/dist/packages/sdk-ui/src/infra/contexts/custom-widgets-provider/custom-widgets-provider-adapter.d.ts +2 -1
- package/dist/packages/sdk-ui/src/infra/contexts/custom-widgets-provider/use-custom-widgets.d.ts +11 -4
- package/dist/packages/sdk-ui/src/infra/contexts/sisense-context/sisense-context.d.ts +1 -1
- package/dist/packages/sdk-ui/src/infra/contexts/theme-provider/theme-context.d.ts +2 -1
- package/dist/packages/sdk-ui/src/infra/decorators/component-decorators/with-tracking/with-tracking.d.ts +1 -1
- package/dist/packages/sdk-ui/src/infra/decorators/hook-decorators/with-tracking.d.ts +1 -1
- package/dist/packages/sdk-ui/src/infra/plugins/custom-plugin-context-provider.d.ts +18 -0
- package/dist/packages/sdk-ui/src/infra/plugins/plugin-context.d.ts +29 -0
- package/dist/packages/sdk-ui/src/infra/{contexts/plugin-provider → plugins}/plugin-provider.d.ts +4 -2
- package/dist/packages/sdk-ui/src/infra/{contexts/plugin-provider → plugins}/types.d.ts +12 -4
- package/dist/packages/sdk-ui/src/infra/plugins/use-widget-plugin-registry.d.ts +7 -0
- package/dist/packages/sdk-ui/src/infra/{contexts/plugin-provider → plugins}/validate-plugins.d.ts +1 -1
- package/dist/packages/sdk-ui/src/infra/plugins/widget-plugins/types.d.ts +302 -0
- package/dist/packages/sdk-ui/src/infra/plugins/widget-plugins/widget-plugin-registry.d.ts +33 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/de-de.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/en-us.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/es-ar.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/es-es.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/fr-fr.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/it-it.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ja-jp.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ko-kr.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/nl-nl.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/pt-br.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ru-ru.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/tr-tr.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/zh-cn.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/en.d.ts +37 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/index.d.ts +74 -0
- package/dist/packages/sdk-ui/src/modules/ai/use-get-nlq-result.d.ts +1 -0
- package/dist/packages/sdk-ui/src/modules/ai/use-get-query-recommendations.d.ts +1 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/chart/helpers/axis-type-detection.d.ts +17 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/chart/helpers/chart-type-schemas.d.ts +37 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/chart/helpers/index.d.ts +9 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/chart/helpers/translate-data-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/chart/helpers/validate-chart-json.d.ts +19 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/chart/translate-chart-from-json.d.ts +42 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/chart/translate-chart-to-json.d.ts +41 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/constructs/dimensions/translate-dimensions-from-json.d.ts +11 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/constructs/dimensions/translate-dimensions-to-json.d.ts +22 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{translate-filters-from-json.d.ts → constructs/filters/translate-filters-from-json.d.ts} +2 -2
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{translate-filters-to-json.d.ts → constructs/filters/translate-filters-to-json.d.ts} +1 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{translate-measures-from-json.d.ts → constructs/measures/translate-measures-from-json.d.ts} +4 -4
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/constructs/measures/translate-measures-to-json.d.ts +22 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/index.d.ts +8 -3
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/pivot-table/helpers/index.d.ts +7 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/pivot-table/helpers/translate-data-options.d.ts +14 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/pivot-table/helpers/validate-pivot-table-json.d.ts +19 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/pivot-table/translate-pivot-table-from-json.d.ts +12 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/pivot-table/translate-pivot-table-to-json.d.ts +12 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/query/constants.d.ts +8 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{translate-query-from-json.d.ts → query/translate-query-from-json.d.ts} +3 -3
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{translate-query-to-jaql.d.ts → query/translate-query-to-jaql.d.ts} +1 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{translate-query-to-json.d.ts → query/translate-query-to-json.d.ts} +2 -2
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/data-options/adapters.d.ts +19 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/data-options/index.d.ts +9 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/data-options/translate-axis-from-json.d.ts +24 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/data-options/translate-axis-to-json.d.ts +18 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{process-function → shared/expression}/custom-formula/process-custom-formula.d.ts +1 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{process-function → shared/expression}/custom-formula/validate-custom-formula.d.ts +25 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{process-function → shared/expression}/execute-function.d.ts +1 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{process-function → shared/expression}/factory-function-processors.d.ts +1 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{process-function → shared/expression}/factory-function-schemas.d.ts +1 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{process-function → shared/expression}/filter-processors.d.ts +1 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/expression/formula-function-schemas.d.ts +41 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{process-function → shared/expression}/process-arg.d.ts +1 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/{process-function → shared/expression}/process-node.d.ts +1 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/utils/attribute-helpers.d.ts +50 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/utils/fuzzy-match.d.ts +16 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/utils/parse-compose-code.d.ts +34 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/utils/schema-index.d.ts +52 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/utils/translation-helpers.d.ts +31 -0
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/types.d.ts +115 -4
- package/dist/packages/sdk-ui/src/modules/analytics-composer/types.d.ts +6 -6
- package/dist/packages/sdk-ui/src/props.d.ts +20 -2
- package/dist/packages/sdk-ui/src/public-api/alpha.d.ts +1 -1
- package/dist/packages/sdk-ui/src/public-api/beta.d.ts +1 -1
- package/dist/packages/sdk-ui/src/public-api/internal.d.ts +10 -6
- package/dist/packages/sdk-ui/src/public-api/public.d.ts +2 -2
- package/dist/packages/sdk-ui/src/public-api/sisense-internal.d.ts +14 -5
- package/dist/packages/sdk-ui/src/shared/components/grouped-items-browser/types.d.ts +7 -1
- package/dist/packages/sdk-ui/src/shared/components/inline-text-editor/inline-text-editor.d.ts +26 -0
- package/dist/packages/sdk-ui/src/shared/components/inline-text-editor/use-blur-on-pointer-down-outside.d.ts +11 -0
- package/dist/packages/sdk-ui/src/shared/components/loading-indicator.d.ts +2 -1
- package/dist/packages/sdk-ui/src/shared/components/quota-notification/quota-notification.d.ts +2 -2
- package/dist/packages/sdk-ui/src/shared/const.d.ts +5 -0
- package/dist/packages/sdk-ui/src/shared/hooks/use-app-settings.d.ts +2 -1
- package/dist/packages/sdk-ui/src/shared/hooks/use-quota-notification.d.ts +4 -4
- package/dist/packages/sdk-ui/src/shared/hooks/use-should-load.d.ts +1 -1
- package/dist/packages/sdk-ui/src/shared/hooks/use-with-change-detection.d.ts +5 -5
- package/dist/packages/sdk-ui/src/shared/types/menu-item.d.ts +5 -1
- package/dist/packages/sdk-ui/src/shared/utils/menu-item-converters.d.ts +12 -0
- package/dist/packages/sdk-ui/src/types.d.ts +3 -3
- package/dist/quota-notification-BqRYSJ7r.cjs +713 -0
- package/dist/{quota-notification-D6oMJal8.js → quota-notification-CeKnEyQG.js} +18423 -17044
- package/dist/translations/de-de.cjs +1 -1
- package/dist/translations/de-de.js +40 -3
- package/dist/translations/en-us.cjs +1 -1
- package/dist/translations/en-us.js +1 -1
- package/dist/translations/es-ar.cjs +1 -1
- package/dist/translations/es-ar.js +40 -3
- package/dist/translations/es-es.cjs +1 -1
- package/dist/translations/es-es.js +40 -3
- package/dist/translations/fr-fr.cjs +1 -1
- package/dist/translations/fr-fr.js +40 -3
- package/dist/translations/it-it.cjs +1 -1
- package/dist/translations/it-it.js +42 -5
- package/dist/translations/ja-jp.cjs +1 -1
- package/dist/translations/ja-jp.js +42 -5
- package/dist/translations/ko-kr.cjs +1 -1
- package/dist/translations/ko-kr.js +42 -5
- package/dist/translations/nl-nl.cjs +1 -1
- package/dist/translations/nl-nl.js +42 -5
- package/dist/translations/pt-br.cjs +1 -1
- package/dist/translations/pt-br.js +40 -3
- package/dist/translations/ru-ru.cjs +1 -1
- package/dist/translations/ru-ru.js +42 -5
- package/dist/translations/tr-tr.cjs +1 -1
- package/dist/translations/tr-tr.js +40 -3
- package/dist/translations/zh-cn.cjs +1 -1
- package/dist/translations/zh-cn.js +42 -5
- package/dist/{types-CoY6F8Ma.cjs → types-C0QU2tsE.cjs} +1 -1
- package/dist/{types-ixSwJkxM.js → types-DJtC8_5_.js} +1 -1
- package/dist/{utils-BP-BglHE.js → utils-BCp2ISWh.js} +3745 -3773
- package/dist/{utils-C8YMrOdw.cjs → utils-D8O1_kl3.cjs} +33 -33
- package/dist/{widget-composer-DI4sHaNe.cjs → widget-composer-BkHZISs7.cjs} +1 -1
- package/dist/{widget-composer-CUUFoCb9.js → widget-composer-CDNL9_XF.js} +8 -8
- package/package.json +10 -8
- package/dist/dimensions-BiLyFpCg.js +0 -202
- package/dist/dimensions-X4_igtmO.cjs +0 -1
- package/dist/execute-query-BEeqqDl6.js +0 -5795
- package/dist/execute-query-DJDE0zRU.cjs +0 -1
- package/dist/packages/sdk-ui/src/infra/contexts/plugin-provider/index.d.ts +0 -5
- package/dist/packages/sdk-ui/src/infra/contexts/plugin-provider/plugin-context.d.ts +0 -15
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/common.d.ts +0 -84
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/parse-compose-code.d.ts +0 -15
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/translate-dimensions-from-json.d.ts +0 -12
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/translate-dimensions-to-json.d.ts +0 -13
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/translate-measures-to-json.d.ts +0 -13
- package/dist/quota-notification-z3dv2KoH.cjs +0 -672
|
@@ -5,7 +5,7 @@ import type { CustomWidgetProps } from '../custom-widget/types';
|
|
|
5
5
|
import type { PivotTableWidgetProps } from '../pivot-table-widget/types';
|
|
6
6
|
import type { TextWidgetProps } from '../text-widget/types';
|
|
7
7
|
/**
|
|
8
|
-
* Generic widget configuration (e.g. header menu, toolbar).
|
|
8
|
+
* Generic widget configuration (e.g. header menu, toolbar, actions).
|
|
9
9
|
* Shared across chart, pivot, text, and custom widgets.
|
|
10
10
|
*/
|
|
11
11
|
export type WidgetConfig = {
|
|
@@ -13,6 +13,26 @@ export type WidgetConfig = {
|
|
|
13
13
|
* Configurations for the widget header (e.g. toolbar menu items)
|
|
14
14
|
*/
|
|
15
15
|
header?: WidgetHeaderConfig;
|
|
16
|
+
/**
|
|
17
|
+
* Configuration for widget actions.
|
|
18
|
+
*
|
|
19
|
+
* @sisenseInternal
|
|
20
|
+
*/
|
|
21
|
+
actions?: {
|
|
22
|
+
/**
|
|
23
|
+
* Configuration for downloading a CSV file.
|
|
24
|
+
*
|
|
25
|
+
* @sisenseInternal
|
|
26
|
+
*/
|
|
27
|
+
downloadCsv?: {
|
|
28
|
+
/**
|
|
29
|
+
* Determines whether the possibility to download a CSV is enabled.
|
|
30
|
+
*
|
|
31
|
+
* If not specified, the default value is `false`.
|
|
32
|
+
*/
|
|
33
|
+
enabled?: boolean;
|
|
34
|
+
};
|
|
35
|
+
};
|
|
16
36
|
};
|
|
17
37
|
/**
|
|
18
38
|
* Type of the widget component.
|
|
@@ -8,7 +8,8 @@ import { FiltersIgnoringRules, WidgetDto } from './types.js';
|
|
|
8
8
|
* @param dashboard - The dashboard containing the filters.
|
|
9
9
|
* @param widget - The widget containing the filters.
|
|
10
10
|
* @returns An object containing an array of filters and an array of highlights.
|
|
11
|
-
*
|
|
11
|
+
*
|
|
12
|
+
* @sisenseInternal
|
|
12
13
|
*/
|
|
13
14
|
export declare function extractCombinedFilters(dashboard: DashboardDto, widget: WidgetDto): {
|
|
14
15
|
filters: import("@sisense/sdk-data").Filter[];
|
|
@@ -4788,6 +4789,7 @@ export declare function getDashboardFilters(dashboardFilters: Array<FilterDto |
|
|
|
4788
4789
|
jaql: import("@sisense/sdk-data").FilterJaql;
|
|
4789
4790
|
} | undefined;
|
|
4790
4791
|
} | undefined;
|
|
4792
|
+
indexed?: boolean | undefined;
|
|
4791
4793
|
merged?: boolean | undefined;
|
|
4792
4794
|
panel?: "rows" | "columns" | undefined;
|
|
4793
4795
|
};
|
|
@@ -5,7 +5,7 @@ import { BoxplotWidgetStyle, FusionWidgetType, Panel, PanelItem, WidgetStyle } f
|
|
|
5
5
|
export declare function createDataColumn(item: PanelItem, customPaletteColors?: Color[]): StyledColumn | StyledMeasureColumn;
|
|
6
6
|
/** @internal */
|
|
7
7
|
export declare function createPanelItem(column: StyledColumn | StyledMeasureColumn): PanelItem;
|
|
8
|
-
/** @
|
|
8
|
+
/** @sisenseInternal */
|
|
9
9
|
export declare const createDataOptionsFromPanels: (panels: Panel[], variantColors: Color[]) => {
|
|
10
10
|
[key: string]: any[];
|
|
11
11
|
};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type { AxisLabel, DataLimits, LegendOptions, LineStyleOptions, LineWidth, Markers, Navigator, SeriesLabels } from '../../../../../types.js';
|
|
2
|
-
import type { AxisStyle, CartesianWidgetStyle } from '../types.js';
|
|
1
|
+
import type { AreaStyleOptions, AxisLabel, DataLimits, LegendOptions, LineStyleOptions, LineWidth, Markers, Navigator, SeriesLabels } from '../../../../../types.js';
|
|
2
|
+
import type { AxisStyle, CartesianWidgetStyle, WidgetSubtype } from '../types.js';
|
|
3
3
|
/**
|
|
4
4
|
* Maps SDK legend options to Fusion DTO legend style.
|
|
5
5
|
*
|
|
@@ -60,4 +60,13 @@ export declare function toDataLimitsStyle(dataLimits?: DataLimits): CartesianWid
|
|
|
60
60
|
* @internal
|
|
61
61
|
*/
|
|
62
62
|
export declare function toLineWidgetStyle(styleOptions: LineStyleOptions): CartesianWidgetStyle;
|
|
63
|
+
/**
|
|
64
|
+
* Converts area chart style options to Fusion CartesianWidgetStyle DTO.
|
|
65
|
+
* Used when serializing an area chart widget back to WidgetDto.
|
|
66
|
+
*
|
|
67
|
+
* @param styleOptions - Area style options from WidgetModel.styleOptions
|
|
68
|
+
* @param widgetSubtype - Resolved Fusion widget subtype (e.g. after `area/basic` default)
|
|
69
|
+
* @returns Fusion CartesianWidgetStyle for the widget DTO
|
|
70
|
+
*/
|
|
71
|
+
export declare function toAreaWidgetStyle(styleOptions: AreaStyleOptions, widgetSubtype: WidgetSubtype): CartesianWidgetStyle;
|
|
63
72
|
export {};
|
|
@@ -44,7 +44,7 @@ export declare enum WidgetDashboardFilterMode {
|
|
|
44
44
|
* This is the (not-comprehensive) structure of the response from the
|
|
45
45
|
* `/api/v1/dashboards/${dashboardOid}/widgets/${widgetOid}` endpoint.
|
|
46
46
|
*
|
|
47
|
-
* @
|
|
47
|
+
* @sisenseInternal
|
|
48
48
|
*/
|
|
49
49
|
export interface WidgetDto {
|
|
50
50
|
oid: string;
|
|
@@ -100,7 +100,8 @@ export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widge
|
|
|
100
100
|
*
|
|
101
101
|
* @param widgetProps - The widget props to check.
|
|
102
102
|
* @returns whether the widget props is for a pivot table widget
|
|
103
|
-
*
|
|
103
|
+
*
|
|
104
|
+
* @sisenseInternal
|
|
104
105
|
*/
|
|
105
106
|
export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'>;
|
|
106
107
|
/**
|
|
@@ -116,7 +117,7 @@ export declare function isCustomWidgetProps(widgetProps: CommonWidgetProps): wid
|
|
|
116
117
|
*
|
|
117
118
|
* @param widgetProps - The widget props to check.
|
|
118
119
|
* @returns whether the widget props is for a chart widget
|
|
119
|
-
* @
|
|
120
|
+
* @sisenseInternal
|
|
120
121
|
*/
|
|
121
122
|
export declare function isChartWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<ChartWidgetProps, 'chart'>;
|
|
122
123
|
export declare function getInternalWidgetType(widgetProps: CommonWidgetProps): WidgetTypeInternal;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { WidgetChangeEvent } from './change-events';
|
|
2
|
+
import type { WidgetProps } from './components/widget/types';
|
|
3
|
+
/**
|
|
4
|
+
* Reduces a WidgetChangeEvent to a Partial<WidgetProps> delta for state merge.
|
|
5
|
+
*
|
|
6
|
+
* Pure, allocation-only; no mutation. Used by the composition layer (e.g. useComposedDashboard)
|
|
7
|
+
* to translate atomic events into prop updates.
|
|
8
|
+
*
|
|
9
|
+
* Validates that the event payload structure matches the widget type before applying.
|
|
10
|
+
* Returns empty delta when payload structure is incompatible (e.g. chart array payload
|
|
11
|
+
* for a pivot widget), avoiding silent corruption.
|
|
12
|
+
*
|
|
13
|
+
* @param event - The widget change event
|
|
14
|
+
* @param currentWidget - The current widget state
|
|
15
|
+
* @returns A partial props object to merge into the widget
|
|
16
|
+
*/
|
|
17
|
+
export declare function widgetChangeEventToDelta(event: WidgetChangeEvent, currentWidget: WidgetProps): Partial<WidgetProps>;
|
|
@@ -1,9 +1,19 @@
|
|
|
1
|
-
import { MenuItem } from '../../../shared/types/menu-item';
|
|
2
|
-
import { WidgetProps } from '../components/widget/types';
|
|
1
|
+
import type { MenuItem } from '../../../shared/types/menu-item';
|
|
2
|
+
import type { WidgetProps } from '../components/widget/types';
|
|
3
|
+
import type { WidgetHeaderConfig } from '../shared/widget-header/types';
|
|
3
4
|
/**
|
|
4
|
-
*
|
|
5
|
+
* Transformer: adds a menu item to a header config (pure, non-mutating).
|
|
6
|
+
*
|
|
7
|
+
* @param menuItem - The menu item to append to toolbar.menu.items.
|
|
8
|
+
* @returns A transformer that maps WidgetHeaderConfig to WidgetHeaderConfig with the menu item appended.
|
|
9
|
+
* @internal
|
|
10
|
+
*/
|
|
11
|
+
export declare function withMenuItemInHeaderConfig(menuItem: MenuItem): (headerConfig: WidgetHeaderConfig) => WidgetHeaderConfig;
|
|
12
|
+
/**
|
|
13
|
+
* Adds a menu item to the widget header (transforms full WidgetProps).
|
|
14
|
+
*
|
|
5
15
|
* @param menuItem - The menu item to add.
|
|
6
|
-
* @returns A
|
|
16
|
+
* @returns A transformer that maps WidgetProps to WidgetProps with the item in config.header.toolbar.menu.items.
|
|
7
17
|
* @internal
|
|
8
18
|
*/
|
|
9
19
|
export declare function withHeaderMenuItem(menuItem: MenuItem): (widget: WidgetProps) => WidgetProps;
|
|
@@ -3,5 +3,6 @@
|
|
|
3
3
|
* @internal
|
|
4
4
|
*/
|
|
5
5
|
export declare const widgetHelpers: {
|
|
6
|
+
withMenuItemInHeaderConfig(menuItem: import("../../../shared/types/menu-item").MenuItem): (headerConfig: import("../shared/widget-header/types").WidgetHeaderConfig) => import("../shared/widget-header/types").WidgetHeaderConfig;
|
|
6
7
|
withHeaderMenuItem(menuItem: import("../../../shared/types/menu-item").MenuItem): (widget: import("../components/widget").WidgetProps) => import("../components/widget").WidgetProps;
|
|
7
8
|
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { ExecuteCsvQueryParams } from '../../../domains/query-execution/types.js';
|
|
2
|
+
export type CsvExecuteParams = Omit<ExecuteCsvQueryParams, 'enabled'> & {
|
|
3
|
+
/** Filename for the downloaded CSV file. Defaults to `data.csv`. */
|
|
4
|
+
filename?: string;
|
|
5
|
+
};
|
|
6
|
+
export type UseCsvQueryLoaderResult = {
|
|
7
|
+
/** Triggers CSV query execution and browser file download with the given params. */
|
|
8
|
+
execute: (params: CsvExecuteParams) => void;
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Hook that executes a CSV query on demand and triggers a browser file download.
|
|
12
|
+
* Call `execute` with query params to start the download; no params are needed at hook initialisation.
|
|
13
|
+
*
|
|
14
|
+
* @returns `execute` callback
|
|
15
|
+
*/
|
|
16
|
+
export declare function useCsvQueryFileLoader(): UseCsvQueryLoaderResult;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { WidgetChangeEvent } from '../../../domains/widgets/change-events.js';
|
|
2
|
+
import type { TitleEditorConfig } from '../../../domains/widgets/shared/widget-header/types.js';
|
|
3
|
+
import type { MenuItem } from '../../../shared/types/menu-item.js';
|
|
4
|
+
/** Parameters for the title renaming hook. */
|
|
5
|
+
export type UseTitleRenamingParams = {
|
|
6
|
+
/** Whether inline title renaming is enabled. */
|
|
7
|
+
enabled: boolean;
|
|
8
|
+
/** Handler called when the user commits a new title. */
|
|
9
|
+
onChange?: (event: WidgetChangeEvent) => void;
|
|
10
|
+
};
|
|
11
|
+
/** Result of the title renaming hook. */
|
|
12
|
+
export type UseTitleRenamingResult = {
|
|
13
|
+
/** "Rename" menu item to inject into the header toolbar; undefined when not enabled. */
|
|
14
|
+
renameMenuItem: MenuItem | undefined;
|
|
15
|
+
/** Config for the inline title editor; undefined when not enabled. */
|
|
16
|
+
titleEditorConfig: TitleEditorConfig | undefined;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Hook that manages inline title renaming state: isEditing, start/cancel/commit
|
|
20
|
+
* callbacks, titleEditorConfig for the title editor, and a prepared "Rename" menu item.
|
|
21
|
+
* Emits title/changed on commit.
|
|
22
|
+
*
|
|
23
|
+
* @param params - Hook parameters
|
|
24
|
+
* @returns renameMenuItem and titleEditorConfig
|
|
25
|
+
* @internal
|
|
26
|
+
*/
|
|
27
|
+
export declare function useTitleRenaming(params: UseTitleRenamingParams): UseTitleRenamingResult;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { WidgetChangeEvent } from '../../../domains/widgets/change-events.js';
|
|
2
|
+
import type { TitleEditorConfig, WidgetHeaderConfig } from '../../../domains/widgets/shared/widget-header/types.js';
|
|
3
|
+
/** Parameters for the widget header management hook. */
|
|
4
|
+
export type UseWidgetHeaderManagementParams = {
|
|
5
|
+
/** Current title (from props). */
|
|
6
|
+
title?: string;
|
|
7
|
+
/** onChange handler (from props). */
|
|
8
|
+
onChange?: (event: WidgetChangeEvent) => void;
|
|
9
|
+
/** Merged config.header from props (may already have toolbar.menu.items). */
|
|
10
|
+
headerConfig?: WidgetHeaderConfig;
|
|
11
|
+
};
|
|
12
|
+
/** Result of the widget header management hook. */
|
|
13
|
+
export type UseWidgetHeaderManagementResult = {
|
|
14
|
+
/** Merged header config (e.g. rename menu in toolbar). */
|
|
15
|
+
headerConfig: WidgetHeaderConfig;
|
|
16
|
+
/** Inline title editor config when rename is enabled. Pass to WidgetContainer as separate prop. */
|
|
17
|
+
titleEditor?: TitleEditorConfig;
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* Hook that manages widget header UI for rename: adds "Rename" menu item
|
|
21
|
+
* and delegates inline title editing to useTitleRenaming.
|
|
22
|
+
* Used by ChartWidget and PivotTableWidget when config.header.title.editing.enabled is true.
|
|
23
|
+
*
|
|
24
|
+
* @param params - Hook parameters
|
|
25
|
+
* @returns Merged header config to pass to WidgetContainer
|
|
26
|
+
* @internal
|
|
27
|
+
*/
|
|
28
|
+
export declare function useWidgetHeaderManagement(params: UseWidgetHeaderManagementParams): UseWidgetHeaderManagementResult;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type { WidgetHeaderConfig } from '../../../domains/widgets/shared/widget-header/types.js';
|
|
2
|
+
export type UseWithCsvDownloadMenuParams = {
|
|
3
|
+
/** Base header config. */
|
|
4
|
+
baseHeaderConfig: WidgetHeaderConfig;
|
|
5
|
+
/** Whether the "Download CSV" menu item is enabled. */
|
|
6
|
+
enabled: boolean;
|
|
7
|
+
/** Triggers CSV query execution and browser download. */
|
|
8
|
+
onClick: () => void;
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Appends a "Download > CSV File" item to the widget header menu when enabled.
|
|
12
|
+
*
|
|
13
|
+
* If a "Download" group already exists in the menu, the "CSV File" item is added to its `items`.
|
|
14
|
+
* Otherwise a new "Download" group containing "CSV File" is appended.
|
|
15
|
+
*
|
|
16
|
+
* @param params.baseHeaderConfig - Base header config.
|
|
17
|
+
* @param params.enabled - Whether the "Download CSV" menu item is enabled.
|
|
18
|
+
* @param params.onClick - Click handler for the "CSV File" leaf item.
|
|
19
|
+
* @returns Header config to pass to {@link WidgetContainer}
|
|
20
|
+
* @internal
|
|
21
|
+
*/
|
|
22
|
+
export declare function useWithCsvDownloadMenuItem({ baseHeaderConfig, enabled, onClick, }: UseWithCsvDownloadMenuParams): WidgetHeaderConfig;
|
package/dist/packages/sdk-ui/src/domains/widgets/shared/widget-container/widget-container.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type ReactNode } from 'react';
|
|
2
2
|
import { WidgetContainerStyleOptions } from '../../../../types';
|
|
3
|
-
import { WidgetHeaderConfig } from '../widget-header/types.js';
|
|
3
|
+
import { TitleEditorConfig, WidgetHeaderConfig } from '../widget-header/types.js';
|
|
4
4
|
export interface WidgetContainerProps {
|
|
5
5
|
dataSetName?: string;
|
|
6
6
|
styleOptions?: WidgetContainerStyleOptions;
|
|
@@ -8,6 +8,8 @@ export interface WidgetContainerProps {
|
|
|
8
8
|
* Header configuration (e.g. toolbar menu items). Passed to {@link WidgetHeader} as `config`.
|
|
9
9
|
*/
|
|
10
10
|
headerConfig?: WidgetHeaderConfig;
|
|
11
|
+
/** Inline title editor config (when rename is enabled). Passed to {@link WidgetHeader}. */
|
|
12
|
+
titleEditor?: TitleEditorConfig;
|
|
11
13
|
title?: string;
|
|
12
14
|
description?: string;
|
|
13
15
|
topSlot?: ReactNode;
|
|
@@ -8,10 +8,41 @@ export type InfoButtonConfig = {
|
|
|
8
8
|
errorMessages?: string[];
|
|
9
9
|
warningMessages?: string[];
|
|
10
10
|
};
|
|
11
|
+
/**
|
|
12
|
+
* Configuration for inline title editing (e.g. rename widget).
|
|
13
|
+
*/
|
|
14
|
+
export type TitleEditorConfig = {
|
|
15
|
+
/** Whether the title is currently being edited */
|
|
16
|
+
isEditing: boolean;
|
|
17
|
+
/** Called when the user commits the new title (blur / Enter) */
|
|
18
|
+
onCommit: (newTitle: string) => void;
|
|
19
|
+
/** Called when the user cancels editing (Escape) */
|
|
20
|
+
onCancel: () => void;
|
|
21
|
+
/** Called to request entering/leaving edit mode */
|
|
22
|
+
onEditingChange: (editing: boolean) => void;
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* Configuration options for the widget title (e.g. editing enabled flag).
|
|
26
|
+
*/
|
|
27
|
+
export type WidgetHeaderTitleConfig = {
|
|
28
|
+
/**
|
|
29
|
+
* Configuration options for the widget title renaming
|
|
30
|
+
*/
|
|
31
|
+
editing?: {
|
|
32
|
+
/**
|
|
33
|
+
* Whether the widget title editing is enabled
|
|
34
|
+
*/
|
|
35
|
+
enabled?: boolean;
|
|
36
|
+
};
|
|
37
|
+
};
|
|
11
38
|
/**
|
|
12
39
|
* Configuration options for the widget header
|
|
13
40
|
*/
|
|
14
41
|
export type WidgetHeaderConfig = {
|
|
42
|
+
/**
|
|
43
|
+
* Configuration options for the widget title (e.g. editing enabled).
|
|
44
|
+
*/
|
|
45
|
+
title?: WidgetHeaderTitleConfig;
|
|
15
46
|
/**
|
|
16
47
|
* Configuration options for the toolbar
|
|
17
48
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { WidgetContainerStyleOptions } from '../../../../types';
|
|
3
|
-
import { InfoButtonConfig, WidgetHeaderConfig } from './types.js';
|
|
3
|
+
import { InfoButtonConfig, TitleEditorConfig, WidgetHeaderConfig } from './types.js';
|
|
4
4
|
export interface WidgetHeaderProps {
|
|
5
5
|
onRefresh: () => void;
|
|
6
6
|
title?: string;
|
|
@@ -10,5 +10,7 @@ export interface WidgetHeaderProps {
|
|
|
10
10
|
styleOptions?: WidgetContainerStyleOptions['header'];
|
|
11
11
|
/** Header/toolbar configuration (e.g. toolbar menu). */
|
|
12
12
|
config?: WidgetHeaderConfig;
|
|
13
|
+
/** Inline title editor config (injected at runtime when rename is enabled). */
|
|
14
|
+
titleEditor?: TitleEditorConfig;
|
|
13
15
|
}
|
|
14
16
|
export declare const WidgetHeader: React.FC<WidgetHeaderProps>;
|
|
@@ -81,6 +81,10 @@ export declare class RestApi {
|
|
|
81
81
|
* Delete widget from a dashboard
|
|
82
82
|
*/
|
|
83
83
|
deleteWidgetFromDashboard: (dashboardOid: string, widgetOid: string, sharedMode?: boolean) => Promise<void | undefined>;
|
|
84
|
+
/**
|
|
85
|
+
* Partially update a widget in a dashboard.
|
|
86
|
+
*/
|
|
87
|
+
patchWidgetInDashboard: (dashboardOid: string, widgetOid: string, patch: Partial<Pick<WidgetDto, 'title'>>, sharedMode?: boolean) => Promise<WidgetDto | undefined>;
|
|
84
88
|
/**
|
|
85
89
|
* Get shared formulas by ids
|
|
86
90
|
*
|
|
@@ -1,237 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
import { HttpClient } from '@sisense/sdk-rest-client';
|
|
5
|
-
import { TrackingEventDetails } from '@sisense/sdk-tracking';
|
|
6
|
-
import { SisenseContextProviderProps } from '../../props';
|
|
7
|
-
import { DateConfig } from '../../domains/query-execution/core/date-formats';
|
|
8
|
-
import { LoadingIndicatorConfig, TranslationConfig } from '../../types';
|
|
9
|
-
import { AppSettings } from './settings/settings';
|
|
10
|
-
/**
|
|
11
|
-
* Application configuration
|
|
12
|
-
*/
|
|
13
|
-
export type AppConfig = {
|
|
1
|
+
import { SisenseContextProviderProps } from '../../index';
|
|
2
|
+
import { type ClientApplication } from './types';
|
|
3
|
+
type ClientApplicationParams = Pick<SisenseContextProviderProps, 'appConfig' | 'defaultDataSource' | 'url' | 'token' | 'wat' | 'ssoEnabled' | 'enableSilentPreAuth' | 'useFusionAuth' | 'alternativeSsoHost' | 'ssoMaxAuthRedirectAttempts' | 'ssoRedirectAttemptsTtlMs' | 'disableFusionPalette'> & {
|
|
14
4
|
/**
|
|
15
|
-
* A [date-fns Locale](https://date-fns.org/v2.30.0/docs/Locale)
|
|
16
|
-
*/
|
|
17
|
-
locale?: Locale;
|
|
18
|
-
/**
|
|
19
|
-
* Translation Configuration
|
|
20
|
-
*/
|
|
21
|
-
translationConfig?: TranslationConfig;
|
|
22
|
-
/**
|
|
23
|
-
* Date Configurations
|
|
24
|
-
*/
|
|
25
|
-
dateConfig?: DateConfig;
|
|
26
|
-
/**
|
|
27
|
-
* Loading Indicator Configurations
|
|
28
|
-
*/
|
|
29
|
-
loadingIndicatorConfig?: LoadingIndicatorConfig;
|
|
30
|
-
/**
|
|
31
|
-
* Query Cache Configurations.
|
|
32
|
-
*
|
|
33
|
-
* See [Client query caching guide](/guides/sdk/guides/client-query-caching.html) for more details.
|
|
34
|
-
*
|
|
35
|
-
* @alpha
|
|
36
|
-
*/
|
|
37
|
-
queryCacheConfig?: {
|
|
38
|
-
/**
|
|
39
|
-
* Whether to enable client-side query caching.
|
|
40
|
-
*
|
|
41
|
-
* If not specified, the default value is `false`
|
|
42
|
-
*/
|
|
43
|
-
enabled?: boolean;
|
|
44
|
-
};
|
|
45
|
-
/**
|
|
46
|
-
* Query limit (max rows count that will be fetched in query)
|
|
47
|
-
*
|
|
48
|
-
* @default 20000
|
|
49
|
-
*/
|
|
50
|
-
queryLimit?: number;
|
|
51
|
-
/**
|
|
52
|
-
* Accessibility configuration. Set the `accessibilityConfig.enabled` property to `true` to enable accessibility features for charts built with Highcharts.
|
|
53
|
-
*
|
|
54
|
-
* Once the accessibility configuration in enabled, you can use the default descriptions or choose to create custom configurations for the descriptions of a chart, its axes, its series, and values description formatting. To create custom configurations, use the `highchartsOptions` object that is passed to the {@link BeforeRenderHandler} of the chart's `onBeforeRender` callback. Modify the object using the accessibility options as described in the [Accessibility module documentation](https://www.highcharts.com/docs/accessibility/accessibility-module).
|
|
55
|
-
*
|
|
56
|
-
* Note that enabling accessibility also causes markers to appear in charts even if they are disabled using the chart's `styleOptions`.
|
|
57
|
-
*
|
|
58
|
-
* This feature is in alpha.
|
|
59
|
-
*/
|
|
60
|
-
accessibilityConfig?: {
|
|
61
|
-
/**
|
|
62
|
-
* Whether to enable accessibility features
|
|
63
|
-
*
|
|
64
|
-
* If not specified, the default value is `false`
|
|
65
|
-
*/
|
|
66
|
-
enabled?: boolean;
|
|
67
|
-
};
|
|
68
|
-
/**
|
|
69
|
-
* Configuration of the tabber widgets feature
|
|
70
|
-
*
|
|
71
|
-
* Only tabber widgets that are configured using the Fusion UI as documented [here](https://docs.sisense.com/main/SisenseLinux/tabber.htm#Creating) are supported.
|
|
72
|
-
*/
|
|
73
|
-
tabberConfig?: {
|
|
74
|
-
/**
|
|
75
|
-
* Whether to enable tabber widget support
|
|
76
|
-
*
|
|
77
|
-
* If not specified, the default value is `true`
|
|
78
|
-
*
|
|
79
|
-
* @deprecated Tabber widgets are now supported by default and this property is no longer needed.
|
|
80
|
-
*/
|
|
81
|
-
enabled?: boolean;
|
|
82
|
-
};
|
|
83
|
-
/**
|
|
84
|
-
* Configuration of the component that is rendered in case of an error
|
|
85
|
-
*/
|
|
86
|
-
errorBoundaryConfig?: {
|
|
87
|
-
/**
|
|
88
|
-
* Whether to show error text without hovering over the error icon
|
|
89
|
-
*
|
|
90
|
-
* If not specified, the default value is `false`
|
|
91
|
-
*/
|
|
92
|
-
alwaysShowErrorText?: boolean;
|
|
93
|
-
};
|
|
94
|
-
/**
|
|
95
|
-
* Custom HTTP headers to attach to every request made by the SDK.
|
|
96
|
-
*
|
|
97
|
-
* Useful for forwarding tracking-related headers (e.g. `x-request-id`, `x-correlation-id`)
|
|
98
|
-
* so that downstream services can correlate SDK traffic.
|
|
99
|
-
*
|
|
100
|
-
* @example
|
|
101
|
-
* ```tsx
|
|
102
|
-
* appConfig={{
|
|
103
|
-
* customHttpHeaders: {
|
|
104
|
-
* 'x-correlation-id': '550e8400-e29b-41d4-a716-446655440000',
|
|
105
|
-
* },
|
|
106
|
-
* }}
|
|
107
|
-
* ```
|
|
108
5
|
* @internal
|
|
109
6
|
*/
|
|
110
|
-
|
|
111
|
-
/**
|
|
112
|
-
* Tracking configuration
|
|
113
|
-
*/
|
|
114
|
-
trackingConfig?: {
|
|
115
|
-
/**
|
|
116
|
-
* Whether to enable or disable tracking in development or test environment.
|
|
117
|
-
*
|
|
118
|
-
* If not specified, the default value is `true`
|
|
119
|
-
*
|
|
120
|
-
* In production, tracking is always enabled.
|
|
121
|
-
*
|
|
122
|
-
* @internal
|
|
123
|
-
*/
|
|
124
|
-
enabled?: boolean;
|
|
125
|
-
/**
|
|
126
|
-
* Callback to be invoked when tracking event occurs
|
|
127
|
-
*/
|
|
128
|
-
onTrackingEvent?: (payload: TrackingEventDetails) => void;
|
|
129
|
-
};
|
|
130
|
-
/**
|
|
131
|
-
* Configuration of the Jump To Dashboard feature
|
|
132
|
-
*
|
|
133
|
-
* This feature is currently in Beta.
|
|
134
|
-
*
|
|
135
|
-
* **Note:** Only widgets that are configured using the Fusion UI as documented
|
|
136
|
-
* [here](https://docs.sisense.com/main/SisenseLinux/jump-to-dashboard.htm?tocpath=Add-ons%7C_____2#ConfiguringJTDPerWidget)
|
|
137
|
-
* are supported in Compose SDK.
|
|
138
|
-
*
|
|
139
|
-
* Widgets that are configured using an older version of Jump To Dashboard, or via scripts, are not supported.
|
|
140
|
-
*
|
|
141
|
-
* Known limitations:
|
|
142
|
-
* - Jump To Dashboard is not currently supported for Pivot widgets.
|
|
143
|
-
* - Target dashboards are always opened in a popup window, options to open in new tab and new window are not supported.
|
|
144
|
-
* - Show 'Header' and 'Dashboards panel' options are not supported (only relevant to Fusion).
|
|
145
|
-
* - 'Reset filters after JTD' is not supported, since changes are never saved to the target dashboard using Compose SDK.
|
|
146
|
-
*
|
|
147
|
-
* The following Jump To Dashboard configuration is supported:
|
|
148
|
-
* - Target dashboard set by Id, with configurable display title
|
|
149
|
-
* - 'Popup window' display type ('Allow Resize' not supported)
|
|
150
|
-
* - Display filter panel on the target dashboard (true/false)
|
|
151
|
-
* - Navigation setting (Click / Right click)
|
|
152
|
-
* - Note: 'Keep changes made by user' is not supported, since changes are never saved to the target dashboard using Compose SDK.
|
|
153
|
-
* - Apply filters to the target dashboard (select)
|
|
154
|
-
* - Merge target dashboard filters (true/false)
|
|
155
|
-
*
|
|
156
|
-
*/
|
|
157
|
-
jumpToDashboardConfig?: {
|
|
158
|
-
/**
|
|
159
|
-
* Whether to enable or disable the Jump To Dashboard feature
|
|
160
|
-
*
|
|
161
|
-
* If not specified, the default value is `true`
|
|
162
|
-
*/
|
|
163
|
-
enabled?: boolean;
|
|
164
|
-
};
|
|
165
|
-
/**
|
|
166
|
-
* Global configuration for some specific aspects of data visualizations.
|
|
167
|
-
*/
|
|
168
|
-
chartConfig?: {
|
|
169
|
-
/** `Table` and `PivotTable` configuration */
|
|
170
|
-
tabular?: {
|
|
171
|
-
/** Configuration for HTML content in `Table` and `PivotTable` */
|
|
172
|
-
htmlContent?: {
|
|
173
|
-
/**
|
|
174
|
-
* If true, the contents of table and pivot table cells are rendered as HTML instead of text.
|
|
175
|
-
*
|
|
176
|
-
* **Note**: The {@link StyledColumn.isHtml} property of columns in `dataOptions` are of higher precedence, and will therefore override this setting.
|
|
177
|
-
* @default true
|
|
178
|
-
* */
|
|
179
|
-
enabled?: boolean;
|
|
180
|
-
/**
|
|
181
|
-
* Enables sanitization of HTML content before rendering to prevent XSS attacks.
|
|
182
|
-
* @default true
|
|
183
|
-
* */
|
|
184
|
-
sanitizeContents?: boolean;
|
|
185
|
-
};
|
|
186
|
-
/**
|
|
187
|
-
* Boolean flag whether to always show the results per page select
|
|
188
|
-
*
|
|
189
|
-
* If `true`, the results per page select will be shown even if there is only one page of results.
|
|
190
|
-
* Currently only supported for `PivotTable`.
|
|
191
|
-
*
|
|
192
|
-
* @default false
|
|
193
|
-
*/
|
|
194
|
-
alwaysShowResultsPerPage?: boolean;
|
|
195
|
-
};
|
|
196
|
-
};
|
|
7
|
+
packageName?: string;
|
|
197
8
|
};
|
|
198
|
-
/**
|
|
199
|
-
* Stands for a Sisense Client Application which connects to a Sisense Environment
|
|
200
|
-
*
|
|
201
|
-
* @internal
|
|
202
|
-
*/
|
|
203
|
-
export interface ClientApplication {
|
|
204
|
-
/**
|
|
205
|
-
* Gets the underlying HTTP Client
|
|
206
|
-
*/
|
|
207
|
-
readonly httpClient: HttpClient;
|
|
208
|
-
/**
|
|
209
|
-
* Gets the underlying Pivot Query Client
|
|
210
|
-
*/
|
|
211
|
-
readonly pivotQueryClient: PivotQueryClient;
|
|
212
|
-
/**
|
|
213
|
-
* Gets the underlying Query Client
|
|
214
|
-
*/
|
|
215
|
-
readonly queryClient: QueryClient;
|
|
216
|
-
/**
|
|
217
|
-
* Gets the default data source being used as default for child components with no explicitly defined data source
|
|
218
|
-
*/
|
|
219
|
-
readonly defaultDataSource?: DataSource;
|
|
220
|
-
/**
|
|
221
|
-
* Gets the application settings
|
|
222
|
-
*/
|
|
223
|
-
settings: AppSettings;
|
|
224
|
-
/**
|
|
225
|
-
* Gets the module to control query cache
|
|
226
|
-
*/
|
|
227
|
-
queryCache: {
|
|
228
|
-
/**
|
|
229
|
-
* Clears the query cache
|
|
230
|
-
*/
|
|
231
|
-
clear: () => void;
|
|
232
|
-
};
|
|
233
|
-
}
|
|
234
|
-
type ClientApplicationParams = Pick<SisenseContextProviderProps, 'appConfig' | 'defaultDataSource' | 'url' | 'token' | 'wat' | 'ssoEnabled' | 'enableSilentPreAuth' | 'useFusionAuth' | 'alternativeSsoHost' | 'disableFusionPalette'>;
|
|
235
9
|
/** @internal */
|
|
236
|
-
export declare const createClientApplication: ({ defaultDataSource, url: rawUrl, token, wat, ssoEnabled, appConfig, enableSilentPreAuth, useFusionAuth, alternativeSsoHost, disableFusionPalette, }: ClientApplicationParams) => Promise<ClientApplication>;
|
|
10
|
+
export declare const createClientApplication: ({ defaultDataSource, url: rawUrl, token, wat, ssoEnabled, appConfig, enableSilentPreAuth, useFusionAuth, alternativeSsoHost, ssoMaxAuthRedirectAttempts, ssoRedirectAttemptsTtlMs, disableFusionPalette, packageName, }: ClientApplicationParams) => Promise<ClientApplication>;
|
|
237
11
|
export {};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { AppConfig, SystemSettings } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Checks if the API Telemetry feature is enabled
|
|
4
|
+
*
|
|
5
|
+
* @param systemSettings - System settings
|
|
6
|
+
* @returns True if the API Telemetry feature is enabled, false otherwise
|
|
7
|
+
*/
|
|
8
|
+
export declare function isApiTelemetryEnabled(systemSettings?: SystemSettings): boolean;
|
|
9
|
+
/**
|
|
10
|
+
* Prepares the API Telemetry headers
|
|
11
|
+
*
|
|
12
|
+
* @param appConfig - App config
|
|
13
|
+
* @param isFusionAuth - Whether the application is using Fusion authentication
|
|
14
|
+
* @returns The API Telemetry headers
|
|
15
|
+
*/
|
|
16
|
+
export declare function prepareApiTelemetryHeaders(packageName: string, appConfig?: AppConfig, isFusionAuth?: boolean): Record<string, string>;
|