@sisense/sdk-ui 2.22.0 → 2.23.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 +17 -17
- package/dist/ai.js +57 -57
- package/dist/analytics-composer/node.cjs +1 -1
- package/dist/analytics-composer/node.js +2177 -1176
- package/dist/analytics-composer.cjs +47 -47
- package/dist/analytics-composer.js +135 -131
- package/dist/dimensions-2t18RSZC.cjs +1 -0
- package/dist/dimensions-C0BmtTH2.js +204 -0
- package/dist/execute-query-CHYTupEo.js +5866 -0
- package/dist/execute-query-DmAyVFF5.cjs +1 -0
- package/dist/{index-kxX21arA.js → index-DCAC0mJe.js} +18 -1
- package/dist/{index-NyouhE_A.cjs → index-Dx6wvLd3.cjs} +1 -1
- package/dist/index.cjs +335 -322
- package/dist/index.js +15230 -15097
- package/dist/index.umd.js +687 -634
- 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/types.d.ts +23 -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/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/pivot-table-widget/types.d.ts +12 -2
- 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/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-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/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/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/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/translation/resources/__external__/de-de.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/en-us.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/es-ar.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/es-es.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/fr-fr.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/it-it.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ja-jp.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ko-kr.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/nl-nl.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/pt-br.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ru-ru.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/tr-tr.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/zh-cn.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/en.d.ts +17 -0
- package/dist/packages/sdk-ui/src/infra/translation/resources/index.d.ts +34 -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 +13 -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 +25 -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/{parse-compose-code.d.ts → shared/utils/parse-compose-code.d.ts} +1 -1
- package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/utils/schema-index.d.ts +49 -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 +1 -1
- 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 +8 -6
- package/dist/packages/sdk-ui/src/public-api/public.d.ts +1 -1
- package/dist/packages/sdk-ui/src/public-api/sisense-internal.d.ts +12 -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/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/types.d.ts +3 -3
- package/dist/{quota-notification-D6oMJal8.js → quota-notification-CVl0isIV.js} +17901 -16770
- package/dist/quota-notification-RAaHp-eO.cjs +713 -0
- package/dist/translations/de-de.cjs +1 -1
- package/dist/translations/de-de.js +19 -2
- 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 +19 -2
- package/dist/translations/es-es.cjs +1 -1
- package/dist/translations/es-es.js +19 -2
- package/dist/translations/fr-fr.cjs +1 -1
- package/dist/translations/fr-fr.js +19 -2
- package/dist/translations/it-it.cjs +1 -1
- package/dist/translations/it-it.js +19 -2
- package/dist/translations/ja-jp.cjs +1 -1
- package/dist/translations/ja-jp.js +19 -2
- package/dist/translations/ko-kr.cjs +1 -1
- package/dist/translations/ko-kr.js +19 -2
- package/dist/translations/nl-nl.cjs +1 -1
- package/dist/translations/nl-nl.js +19 -2
- package/dist/translations/pt-br.cjs +1 -1
- package/dist/translations/pt-br.js +19 -2
- package/dist/translations/ru-ru.cjs +1 -1
- package/dist/translations/ru-ru.js +19 -2
- package/dist/translations/tr-tr.cjs +1 -1
- package/dist/translations/tr-tr.js +19 -2
- package/dist/translations/zh-cn.cjs +1 -1
- package/dist/translations/zh-cn.js +19 -2
- package/dist/{types-ixSwJkxM.js → types-B96nVbgX.js} +1 -1
- package/dist/{types-CoY6F8Ma.cjs → types-DZ4vWh8j.cjs} +1 -1
- package/dist/{utils-C8YMrOdw.cjs → utils-CgV-jWWQ.cjs} +33 -33
- package/dist/{utils-BP-BglHE.js → utils-ChqSLRbz.js} +3742 -3774
- package/dist/{widget-composer-DI4sHaNe.cjs → widget-composer-Blul90Zb.cjs} +1 -1
- package/dist/{widget-composer-CUUFoCb9.js → widget-composer-Cf_CN3Ux.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/modules/analytics-composer/nlq-v3-translator/common.d.ts +0 -84
- 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
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' | '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, 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>;
|
|
@@ -137,7 +137,8 @@ type AiStudioFeature = Feature<'aiStudio', {
|
|
|
137
137
|
isUsageDisplayEnabled?: boolean;
|
|
138
138
|
}>;
|
|
139
139
|
type NewNavigationBetaFeature = Feature<'newNavigationBeta'>;
|
|
140
|
-
|
|
140
|
+
type ApiTelemetryFeature = Feature<'apiTelemetry'>;
|
|
141
|
+
export type Features = (AlertingFeature | LiveQueryFeature | NlqFeature | PivotFeature | CustomCodeFeature | CustomCodeTransformationFeature | BuildDestinationFeature | VersionHistoryFeature | EmbedCodeFeature | LiveCustomColumnFeature | ExportingEngineV2Feature | ExportingXlsxV2Feature | ExportingCsvFeature | ConnectionManagementFeature | SisenseLightFeature | WizardSqlEditorFeature | MultiTenancyFeature | BloxFeature | FunnelFeature | Cloud360Feature | BreakByToggleFeature | GitIntegrationFeature | InfusionFeature | InfusionWebClientFeature | NotebooksFeature | AdminWebClientFeature | DateTimeFiltersFeature | TextFiltersFeature | NumericFiltersFeature | FilterRelationsEnabledFeature | TimeLevelSupportEnabledFeature | SyncDashboardEventsFeature | UserProfileFeature | ScatterFeature | CustomFontsFeature | PreferWidgetImageServerExportFeature | NewAdminUIFeature | SharedFormulasFeature | SideBarFeature | InfusionTokenEndpointFeature | ExplanationsForIndicatorWidgetsFeature | ExplanationsForCategoricalWidgetsFeature | WidgetDesignStyleFeature | FiscalOnFeature | ReactAnalyticsWidgetEditorFeature | DynamicSQLFeature | NewCustomConnectorFeature | CrossTenantPerspectivesFeature | EnableDatamodelPerspectiveFeature | AlwaysDirectRelationsFeature | ModelStatisticsFeature | ExportingCsvFormattedFeature | FlexibleTooltipsFeature | DimensionalModelingFeature | CloudCDNFeature | OnboardingFeature | AiAssistantFeature | AiStudioFeature | NewNavigationBetaFeature | ApiTelemetryFeature)[];
|
|
141
142
|
export type FeatureByKey<K extends string> = Extract<Features[number], {
|
|
142
143
|
key: K;
|
|
143
144
|
}>;
|
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
import { DataSource } from '@sisense/sdk-data';
|
|
2
|
+
import { PivotQueryClient } from '@sisense/sdk-pivot-query-client';
|
|
3
|
+
import { QueryClient } from '@sisense/sdk-query-client';
|
|
4
|
+
import { HttpClient } from '@sisense/sdk-rest-client';
|
|
5
|
+
import { TrackingEventDetails } from '@sisense/sdk-tracking';
|
|
6
|
+
import { DateConfig, LoadingIndicatorConfig, TranslationConfig } from '../../types';
|
|
7
|
+
import { AppSettings } from './settings/settings';
|
|
8
|
+
/**
|
|
9
|
+
* Application configuration
|
|
10
|
+
*/
|
|
11
|
+
export type AppConfig = {
|
|
12
|
+
/**
|
|
13
|
+
* A [date-fns Locale](https://date-fns.org/v2.30.0/docs/Locale)
|
|
14
|
+
*/
|
|
15
|
+
locale?: Locale;
|
|
16
|
+
/**
|
|
17
|
+
* Translation Configuration
|
|
18
|
+
*/
|
|
19
|
+
translationConfig?: TranslationConfig;
|
|
20
|
+
/**
|
|
21
|
+
* Date Configurations
|
|
22
|
+
*/
|
|
23
|
+
dateConfig?: DateConfig;
|
|
24
|
+
/**
|
|
25
|
+
* Loading Indicator Configurations
|
|
26
|
+
*/
|
|
27
|
+
loadingIndicatorConfig?: LoadingIndicatorConfig;
|
|
28
|
+
/**
|
|
29
|
+
* Query Cache Configurations.
|
|
30
|
+
*
|
|
31
|
+
* See [Client query caching guide](/guides/sdk/guides/client-query-caching.html) for more details.
|
|
32
|
+
*
|
|
33
|
+
* @beta
|
|
34
|
+
*/
|
|
35
|
+
queryCacheConfig?: {
|
|
36
|
+
/**
|
|
37
|
+
* Whether to enable client-side query caching.
|
|
38
|
+
*
|
|
39
|
+
* If not specified, the default value is `false`
|
|
40
|
+
*/
|
|
41
|
+
enabled?: boolean;
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* Query limit (max rows count that will be fetched in query)
|
|
45
|
+
*
|
|
46
|
+
* @default 20000
|
|
47
|
+
*/
|
|
48
|
+
queryLimit?: number;
|
|
49
|
+
/**
|
|
50
|
+
* Accessibility configuration. Set the `accessibilityConfig.enabled` property to `true` to enable accessibility features for charts built with Highcharts.
|
|
51
|
+
*
|
|
52
|
+
* 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).
|
|
53
|
+
*
|
|
54
|
+
* Note that enabling accessibility also causes markers to appear in charts even if they are disabled using the chart's `styleOptions`.
|
|
55
|
+
*
|
|
56
|
+
* This feature is in alpha.
|
|
57
|
+
*/
|
|
58
|
+
accessibilityConfig?: {
|
|
59
|
+
/**
|
|
60
|
+
* Whether to enable accessibility features
|
|
61
|
+
*
|
|
62
|
+
* If not specified, the default value is `false`
|
|
63
|
+
*/
|
|
64
|
+
enabled?: boolean;
|
|
65
|
+
};
|
|
66
|
+
/**
|
|
67
|
+
* Configuration of the tabber widgets feature
|
|
68
|
+
*
|
|
69
|
+
* Only tabber widgets that are configured using the Fusion UI as documented [here](https://docs.sisense.com/main/SisenseLinux/tabber.htm#Creating) are supported.
|
|
70
|
+
*/
|
|
71
|
+
tabberConfig?: {
|
|
72
|
+
/**
|
|
73
|
+
* Whether to enable tabber widget support
|
|
74
|
+
*
|
|
75
|
+
* If not specified, the default value is `true`
|
|
76
|
+
*
|
|
77
|
+
* @deprecated Tabber widgets are now supported by default and this property is no longer needed.
|
|
78
|
+
*/
|
|
79
|
+
enabled?: boolean;
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* Configuration of the component that is rendered in case of an error
|
|
83
|
+
*/
|
|
84
|
+
errorBoundaryConfig?: {
|
|
85
|
+
/**
|
|
86
|
+
* Whether to show error text without hovering over the error icon
|
|
87
|
+
*
|
|
88
|
+
* If not specified, the default value is `false`
|
|
89
|
+
*/
|
|
90
|
+
alwaysShowErrorText?: boolean;
|
|
91
|
+
};
|
|
92
|
+
/**
|
|
93
|
+
* API Telemetry headers to attach to every request made by the SDK.
|
|
94
|
+
* Attached only when the API Telemetry feature flag is enabled.
|
|
95
|
+
*
|
|
96
|
+
* Support only headers with the prefix 'x-sisense-'.
|
|
97
|
+
*
|
|
98
|
+
* @example
|
|
99
|
+
* ```tsx
|
|
100
|
+
* appConfig={{
|
|
101
|
+
* apiTelemetryHeaders: {
|
|
102
|
+
* 'x-sisense-embed': 'iframe',
|
|
103
|
+
* },
|
|
104
|
+
* }}
|
|
105
|
+
* ```
|
|
106
|
+
* @sisenseInternal
|
|
107
|
+
*/
|
|
108
|
+
apiTelemetryHeaders?: Record<string, string>;
|
|
109
|
+
/**
|
|
110
|
+
* Tracking configuration
|
|
111
|
+
*/
|
|
112
|
+
trackingConfig?: {
|
|
113
|
+
/**
|
|
114
|
+
* Whether to enable or disable tracking in development or test environment.
|
|
115
|
+
*
|
|
116
|
+
* If not specified, the default value is `true`
|
|
117
|
+
*
|
|
118
|
+
* In production, tracking is always enabled.
|
|
119
|
+
*
|
|
120
|
+
* @internal
|
|
121
|
+
*/
|
|
122
|
+
enabled?: boolean;
|
|
123
|
+
/**
|
|
124
|
+
* Callback to be invoked when tracking event occurs
|
|
125
|
+
*/
|
|
126
|
+
onTrackingEvent?: (payload: TrackingEventDetails) => void;
|
|
127
|
+
};
|
|
128
|
+
/**
|
|
129
|
+
* Configuration of the Jump To Dashboard feature
|
|
130
|
+
*
|
|
131
|
+
* This feature is currently in Beta.
|
|
132
|
+
*
|
|
133
|
+
* **Note:** Only widgets that are configured using the Fusion UI as documented
|
|
134
|
+
* [here](https://docs.sisense.com/main/SisenseLinux/jump-to-dashboard.htm?tocpath=Add-ons%7C_____2#ConfiguringJTDPerWidget)
|
|
135
|
+
* are supported in Compose SDK.
|
|
136
|
+
*
|
|
137
|
+
* Widgets that are configured using an older version of Jump To Dashboard, or via scripts, are not supported.
|
|
138
|
+
*
|
|
139
|
+
* Known limitations:
|
|
140
|
+
* - Jump To Dashboard is not currently supported for Pivot widgets.
|
|
141
|
+
* - Target dashboards are always opened in a popup window, options to open in new tab and new window are not supported.
|
|
142
|
+
* - Show 'Header' and 'Dashboards panel' options are not supported (only relevant to Fusion).
|
|
143
|
+
* - 'Reset filters after JTD' is not supported, since changes are never saved to the target dashboard using Compose SDK.
|
|
144
|
+
*
|
|
145
|
+
* The following Jump To Dashboard configuration is supported:
|
|
146
|
+
* - Target dashboard set by Id, with configurable display title
|
|
147
|
+
* - 'Popup window' display type ('Allow Resize' not supported)
|
|
148
|
+
* - Display filter panel on the target dashboard (true/false)
|
|
149
|
+
* - Navigation setting (Click / Right click)
|
|
150
|
+
* - Note: 'Keep changes made by user' is not supported, since changes are never saved to the target dashboard using Compose SDK.
|
|
151
|
+
* - Apply filters to the target dashboard (select)
|
|
152
|
+
* - Merge target dashboard filters (true/false)
|
|
153
|
+
*
|
|
154
|
+
*/
|
|
155
|
+
jumpToDashboardConfig?: {
|
|
156
|
+
/**
|
|
157
|
+
* Whether to enable or disable the Jump To Dashboard feature
|
|
158
|
+
*
|
|
159
|
+
* If not specified, the default value is `true`
|
|
160
|
+
*/
|
|
161
|
+
enabled?: boolean;
|
|
162
|
+
};
|
|
163
|
+
/**
|
|
164
|
+
* Global configuration for some specific aspects of data visualizations.
|
|
165
|
+
*/
|
|
166
|
+
chartConfig?: {
|
|
167
|
+
/** `Table` and `PivotTable` configuration */
|
|
168
|
+
tabular?: {
|
|
169
|
+
/** Configuration for HTML content in `Table` and `PivotTable` */
|
|
170
|
+
htmlContent?: {
|
|
171
|
+
/**
|
|
172
|
+
* If true, the contents of table and pivot table cells are rendered as HTML instead of text.
|
|
173
|
+
*
|
|
174
|
+
* **Note**: The {@link StyledColumn.isHtml} property of columns in `dataOptions` are of higher precedence, and will therefore override this setting.
|
|
175
|
+
* @default true
|
|
176
|
+
* */
|
|
177
|
+
enabled?: boolean;
|
|
178
|
+
/**
|
|
179
|
+
* Enables sanitization of HTML content before rendering to prevent XSS attacks.
|
|
180
|
+
* @default true
|
|
181
|
+
* */
|
|
182
|
+
sanitizeContents?: boolean;
|
|
183
|
+
};
|
|
184
|
+
/**
|
|
185
|
+
* Boolean flag whether to always show the results per page select
|
|
186
|
+
*
|
|
187
|
+
* If `true`, the results per page select will be shown even if there is only one page of results.
|
|
188
|
+
* Currently only supported for `PivotTable`.
|
|
189
|
+
*
|
|
190
|
+
* @default false
|
|
191
|
+
*/
|
|
192
|
+
alwaysShowResultsPerPage?: boolean;
|
|
193
|
+
};
|
|
194
|
+
};
|
|
195
|
+
};
|
|
196
|
+
/**
|
|
197
|
+
* Stands for a Sisense Client Application which connects to a Sisense Environment
|
|
198
|
+
*
|
|
199
|
+
* @internal
|
|
200
|
+
*/
|
|
201
|
+
export interface ClientApplication {
|
|
202
|
+
/**
|
|
203
|
+
* Gets the underlying HTTP Client
|
|
204
|
+
*/
|
|
205
|
+
readonly httpClient: HttpClient;
|
|
206
|
+
/**
|
|
207
|
+
* Gets the underlying Pivot Query Client
|
|
208
|
+
*/
|
|
209
|
+
readonly pivotQueryClient: PivotQueryClient;
|
|
210
|
+
/**
|
|
211
|
+
* Gets the underlying Query Client
|
|
212
|
+
*/
|
|
213
|
+
readonly queryClient: QueryClient;
|
|
214
|
+
/**
|
|
215
|
+
* Gets the default data source being used as default for child components with no explicitly defined data source
|
|
216
|
+
*/
|
|
217
|
+
readonly defaultDataSource?: DataSource;
|
|
218
|
+
/**
|
|
219
|
+
* Gets the application settings
|
|
220
|
+
*/
|
|
221
|
+
settings: AppSettings;
|
|
222
|
+
/**
|
|
223
|
+
* Gets the module to control query cache
|
|
224
|
+
*/
|
|
225
|
+
queryCache: {
|
|
226
|
+
/**
|
|
227
|
+
* Clears the query cache
|
|
228
|
+
*/
|
|
229
|
+
clear: () => void;
|
|
230
|
+
};
|
|
231
|
+
}
|
|
232
|
+
export type SystemSettings = {
|
|
233
|
+
tracking?: {
|
|
234
|
+
apiTelemetry?: boolean;
|
|
235
|
+
};
|
|
236
|
+
};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { TrackingEventDetails } from '@sisense/sdk-tracking';
|
|
3
3
|
import { SisenseContextProviderProps } from '../../..';
|
|
4
|
-
import { ClientApplication } from '../../app/
|
|
4
|
+
import { type ClientApplication } from '../../app/types';
|
|
5
5
|
export type SisenseContextPayload = {
|
|
6
6
|
isInitialized: boolean;
|
|
7
7
|
app?: ClientApplication;
|
|
@@ -8,7 +8,8 @@ export declare const ThemeContext: import("react").Context<{
|
|
|
8
8
|
* Hook to get the current theme settings.
|
|
9
9
|
*
|
|
10
10
|
* @returns The current theme settings
|
|
11
|
-
*
|
|
11
|
+
*
|
|
12
|
+
* @sisenseInternal
|
|
12
13
|
*/
|
|
13
14
|
export declare const useThemeContext: () => {
|
|
14
15
|
themeSettings: CompleteThemeSettings;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ClientApplication } from '../../app/
|
|
1
|
+
import { ClientApplication } from '../../app/types';
|
|
2
2
|
export type HookDecorator<DecoratorConfig> = (decoratorConfig: DecoratorConfig) => <HookArgs extends any[], HookResult>(hook: (...args: HookArgs) => HookResult) => (...args: HookArgs) => HookResult;
|
|
3
3
|
/**
|
|
4
4
|
* Tracks the hook event and sends it to the server.
|