@sisense/sdk-ui 2.31.1 → 2.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (149) hide show
  1. package/dist/ai.cjs +2 -2
  2. package/dist/ai.js +9 -9
  3. package/dist/analytics-composer/node.cjs +1 -1
  4. package/dist/analytics-composer/node.js +5 -5
  5. package/dist/analytics-composer.cjs +1 -1
  6. package/dist/analytics-composer.js +6 -6
  7. package/dist/apply-styled-options-to-query-CE3WQwRs.cjs +1 -0
  8. package/dist/{apply-styled-options-to-query-lFlufwrB.js → apply-styled-options-to-query-TW3CqofD.js} +209 -207
  9. package/dist/{flow-DHowZLKN.cjs → const-BLmTd3gM.cjs} +1 -1
  10. package/dist/{flow-Cs53Uv2Y.js → const-vJfedJf9.js} +15 -15
  11. package/dist/execute-query-CZOWu-Fh.cjs +1 -0
  12. package/dist/{execute-query-4_76L7Ax.js → execute-query-D-gXk-LI.js} +908 -906
  13. package/dist/index-Boixy7N4.cjs +1 -0
  14. package/dist/{index-C2A2EHoh.cjs → index-C6ytYe3A.cjs} +1 -1
  15. package/dist/{index-eIOG6LP6.js → index-Ct7mA7YB.js} +1 -1
  16. package/dist/{index-CyVSfJ-B.js → index-D3DsBxkp.js} +22 -22
  17. package/dist/{index-DCYw3JUB.js → index-DrI_xqvr.js} +14 -0
  18. package/dist/{index-DTvxJdqZ.cjs → index-UssOwVVX.cjs} +1 -1
  19. package/dist/index.cjs +340 -340
  20. package/dist/index.js +12477 -12340
  21. package/dist/index.umd.js +805 -690
  22. package/dist/packages/sdk-ui/src/domains/dashboarding/common-filters/utils.d.ts +1 -1
  23. package/dist/packages/sdk-ui/src/domains/dashboarding/types.d.ts +22 -6
  24. package/dist/packages/sdk-ui/src/domains/query-execution/types.d.ts +2 -0
  25. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/components/regular-chart/has-no-results.d.ts +12 -0
  26. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/components/sisense-chart/sisense-chart.d.ts +1 -1
  27. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/components/sisense-chart/types.d.ts +8 -0
  28. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/helpers/use-chart-on-ready.d.ts +38 -0
  29. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/helpers/use-chart-renderer-props.d.ts +1 -0
  30. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/highcharts-based-chart-renderer.d.ts +8 -0
  31. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/helpers/on-ready-state.d.ts +17 -0
  32. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/sankey-chart-builder.d.ts +8 -1
  33. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data/comparison.d.ts +22 -0
  34. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data/data.d.ts +17 -0
  35. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data/index.d.ts +4 -0
  36. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data/load-data.d.ts +64 -0
  37. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data/value-colors.d.ts +27 -0
  38. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data-options/data-options.d.ts +30 -0
  39. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data-options/index.d.ts +1 -0
  40. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/design-options/design-options.d.ts +31 -0
  41. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/design-options/index.d.ts +1 -0
  42. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/kpi-chart-builder.d.ts +9 -0
  43. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/helpers.d.ts +139 -0
  44. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/index.d.ts +1 -0
  45. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/kpi-card-styles.d.ts +154 -0
  46. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/kpi-card.d.ts +41 -0
  47. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/kpi-chart-renderer.d.ts +46 -0
  48. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/kpi-comparison.d.ts +60 -0
  49. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/kpi-sparkline.d.ts +23 -0
  50. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/kpi-title.d.ts +28 -0
  51. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/kpi-value.d.ts +55 -0
  52. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/on-color.d.ts +70 -0
  53. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/sparkline-options.d.ts +51 -0
  54. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/use-auto-fit-font-size.d.ts +98 -0
  55. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/use-element-size.d.ts +26 -0
  56. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/use-size-tier.d.ts +19 -0
  57. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/types.d.ts +62 -0
  58. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/types.d.ts +47 -9
  59. package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/types.d.ts +9 -0
  60. package/dist/packages/sdk-ui/src/domains/visualizations/components/kpi-chart.d.ts +23 -0
  61. package/dist/packages/sdk-ui/src/domains/visualizations/core/apply-on-ready-to-highcharts-options.d.ts +11 -0
  62. package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-data/types.d.ts +2 -1
  63. package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-data-options/types.d.ts +108 -2
  64. package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/chart-options-service.d.ts +1 -0
  65. package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/design-options.d.ts +41 -1
  66. package/dist/packages/sdk-ui/src/domains/visualizations/core/chart-options-processor/translations/types.d.ts +17 -3
  67. package/dist/packages/sdk-ui/src/domains/visualizations/core/highcharts-renderer.d.ts +7 -1
  68. package/dist/packages/sdk-ui/src/domains/visualizations/core/query-definition/query-definition-style-constants.d.ts +1 -1
  69. package/dist/packages/sdk-ui/src/domains/widgets/components/chart-widget/types.d.ts +1 -2
  70. package/dist/packages/sdk-ui/src/domains/widgets/components/chart-widget/use-chart-widget-excel-download.d.ts +1 -1
  71. package/dist/packages/sdk-ui/src/domains/widgets/components/custom-widget/types.d.ts +1 -2
  72. package/dist/packages/sdk-ui/src/domains/widgets/components/filter-widget/filter-widget-dropdown.d.ts +16 -0
  73. package/dist/packages/sdk-ui/src/domains/widgets/components/filter-widget/types.d.ts +17 -23
  74. package/dist/packages/sdk-ui/src/domains/widgets/components/pivot-table-widget/types.d.ts +1 -2
  75. package/dist/packages/sdk-ui/src/domains/widgets/components/widget/types.d.ts +18 -4
  76. package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-dashboard-filters.d.ts +447 -447
  77. package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-panel-color-format.d.ts +8 -0
  78. package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-widget-filters.d.ts +56 -56
  79. package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-widget-style-options/categorical-labels-style.d.ts +3 -3
  80. package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-widget-style-options/series-label-affix-style.d.ts +1 -1
  81. package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/translate-widget-style-options/to-widget-dto-style.d.ts +11 -2
  82. package/dist/packages/sdk-ui/src/domains/widgets/components/widget-by-id/types.d.ts +28 -5
  83. package/dist/packages/sdk-ui/src/domains/widgets/hooks/use-fire-on-ready.d.ts +14 -0
  84. package/dist/packages/sdk-ui/src/domains/widgets/widget-model/widget-model-translator/to-widget-dto-panels.d.ts +11 -1
  85. package/dist/packages/sdk-ui/src/infra/api/rest-api.d.ts +9 -2
  86. package/dist/packages/sdk-ui/src/infra/app/helpers.d.ts +23 -2
  87. package/dist/packages/sdk-ui/src/infra/app/settings/settings.d.ts +6 -3
  88. package/dist/packages/sdk-ui/src/infra/app/types.d.ts +14 -1
  89. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/de-de.d.ts +14 -0
  90. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/en-us.d.ts +14 -0
  91. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/es-ar.d.ts +14 -0
  92. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/es-es.d.ts +14 -0
  93. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/fr-fr.d.ts +14 -0
  94. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/it-it.d.ts +14 -0
  95. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ja-jp.d.ts +14 -0
  96. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ko-kr.d.ts +14 -0
  97. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/nl-nl.d.ts +14 -0
  98. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/pt-br.d.ts +14 -0
  99. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/ru-ru.d.ts +14 -0
  100. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/tr-tr.d.ts +14 -0
  101. package/dist/packages/sdk-ui/src/infra/translation/resources/__external__/zh-cn.d.ts +14 -0
  102. package/dist/packages/sdk-ui/src/infra/translation/resources/en.d.ts +14 -0
  103. package/dist/packages/sdk-ui/src/infra/translation/resources/index.d.ts +28 -0
  104. package/dist/packages/sdk-ui/src/props.d.ts +77 -5
  105. package/dist/packages/sdk-ui/src/public-api/beta.d.ts +4 -0
  106. package/dist/packages/sdk-ui/src/types.d.ts +296 -5
  107. package/dist/query.cjs +1 -1
  108. package/dist/query.js +3 -3
  109. package/dist/quota-notification-CdcItYEO.cjs +665 -0
  110. package/dist/{quota-notification-mCXOSF0U.js → quota-notification-DJPs09UQ.js} +17392 -15866
  111. package/dist/translations/de-de.cjs +1 -1
  112. package/dist/translations/de-de.js +15 -1
  113. package/dist/translations/en-us.cjs +1 -1
  114. package/dist/translations/en-us.js +1 -1
  115. package/dist/translations/es-ar.cjs +1 -1
  116. package/dist/translations/es-ar.js +15 -1
  117. package/dist/translations/es-es.cjs +1 -1
  118. package/dist/translations/es-es.js +15 -1
  119. package/dist/translations/fr-fr.cjs +1 -1
  120. package/dist/translations/fr-fr.js +17 -3
  121. package/dist/translations/it-it.cjs +1 -1
  122. package/dist/translations/it-it.js +15 -1
  123. package/dist/translations/ja-jp.cjs +1 -1
  124. package/dist/translations/ja-jp.js +15 -1
  125. package/dist/translations/ko-kr.cjs +1 -1
  126. package/dist/translations/ko-kr.js +15 -1
  127. package/dist/translations/nl-nl.cjs +1 -1
  128. package/dist/translations/nl-nl.js +15 -1
  129. package/dist/translations/pt-br.cjs +1 -1
  130. package/dist/translations/pt-br.js +15 -1
  131. package/dist/translations/ru-ru.cjs +1 -1
  132. package/dist/translations/ru-ru.js +15 -1
  133. package/dist/translations/tr-tr.cjs +1 -1
  134. package/dist/translations/tr-tr.js +15 -1
  135. package/dist/translations/zh-cn.cjs +1 -1
  136. package/dist/translations/zh-cn.js +15 -1
  137. package/dist/{types-CzQiy3kx.js → types-B60QjE1r.js} +1 -1
  138. package/dist/{types-pkCiWY_S.cjs → types-BAIldf5u.cjs} +1 -1
  139. package/dist/{use-execute-csv-query-DnTVUxCj.cjs → use-execute-csv-query-DAJqBzR5.cjs} +2 -2
  140. package/dist/{use-execute-csv-query-LtQrd2A4.js → use-execute-csv-query-tLJmsnwg.js} +6 -6
  141. package/dist/{utils-Bqaxp0gq.cjs → utils-BIAAcoFt.cjs} +12 -12
  142. package/dist/{utils-DHLPgrHF.js → utils-D2c9kOce.js} +1544 -1541
  143. package/dist/{widget-composer-CSkR-kBh.js → widget-composer-VWvON_Hi.js} +4 -4
  144. package/dist/{widget-composer-BUq7QhlK.cjs → widget-composer-srdW7lV4.cjs} +1 -1
  145. package/package.json +8 -8
  146. package/dist/apply-styled-options-to-query-siyJXPed.cjs +0 -1
  147. package/dist/execute-query-9rwu12er.cjs +0 -1
  148. package/dist/index-BGVJyEgp.cjs +0 -1
  149. package/dist/quota-notification-C49kSTz5.cjs +0 -550
@@ -1,8 +1,8 @@
1
1
  import type { PivotGrandTotals } from '@sisense/sdk-data';
2
2
  import type { BoxWhiskerType } from '../../../../../domains/visualizations/core/chart-data-options/types.js';
3
3
  import { AppSettings } from '../../../../../infra/app/settings/settings.js';
4
- import type { AreamapType, AreaStyleOptions, AxisLabel, BoxplotStyleOptions, CalendarHeatmapStyleOptions, CompleteThemeSettingsInternal, DataLimits, FunnelStyleOptions, IndicatorStyleOptions, LegendOptions, LineOptions, LineStyleOptions, LineWidth, Markers, Navigator, PieStyleOptions, PivotTableWidgetStyleOptions, PolarStyleOptions, ScattermapStyleOptions, ScatterStyleOptions, SeriesLabels, StackableStyleOptions, SunburstStyleOptions, TableStyleOptions, TreemapStyleOptions, WidgetStyleOptions } from '../../../../../types.js';
5
- import type { AxisStyle, BoxplotWidgetStyle, CalendarHeatmapWidgetStyle, CartesianWidgetStyle, FunnelWidgetStyle, PivotWidgetStyle, PolarWidgetStyle, ScattermapWidgetStyle, ScatterWidgetStyle, SunburstWidgetStyle, TableWidgetStyle, TreemapWidgetStyle, WidgetDesign, WidgetStyle, WidgetSubtype } from '../types.js';
4
+ import type { AreamapType, AreaStyleOptions, AxisLabel, BoxplotStyleOptions, CalendarHeatmapStyleOptions, CompleteThemeSettingsInternal, DataLimits, FunnelStyleOptions, IndicatorStyleOptions, LegendOptions, LineOptions, LineStyleOptions, LineWidth, Markers, Navigator, PieStyleOptions, PivotTableWidgetStyleOptions, PolarStyleOptions, SankeyStyleOptions, ScattermapStyleOptions, ScatterStyleOptions, SeriesLabels, StackableStyleOptions, SunburstStyleOptions, TableStyleOptions, TreemapStyleOptions, WidgetStyleOptions } from '../../../../../types.js';
5
+ import type { AxisStyle, BoxplotWidgetStyle, CalendarHeatmapWidgetStyle, CartesianWidgetStyle, FunnelWidgetStyle, PivotWidgetStyle, PolarWidgetStyle, SankeyWidgetStyle, ScattermapWidgetStyle, ScatterWidgetStyle, SunburstWidgetStyle, TableWidgetStyle, TreemapWidgetStyle, WidgetDesign, WidgetStyle, WidgetSubtype } from '../types.js';
6
6
  /**
7
7
  * Maps SDK legend options to Fusion DTO legend style.
8
8
  *
@@ -140,6 +140,15 @@ export declare function toAreaWidgetStyle(styleOptions: AreaStyleOptions, widget
140
140
  * @internal
141
141
  */
142
142
  export declare function toFunnelWidgetStyle(styleOptions: FunnelStyleOptions): FunnelWidgetStyle;
143
+ /**
144
+ * Converts sankey chart style options to Fusion SankeyWidgetStyle DTO.
145
+ * Inverse of {@link extractSankeyChartStyleOptions}.
146
+ *
147
+ * @param styleOptions - Sankey style options from WidgetModel.styleOptions
148
+ * @returns Fusion SankeyWidgetStyle for the widget DTO
149
+ * @internal
150
+ */
151
+ export declare function toSankeyWidgetStyle(styleOptions: SankeyStyleOptions): SankeyWidgetStyle;
143
152
  /**
144
153
  * Converts treemap chart style options to Fusion TreemapWidgetStyle DTO.
145
154
  * Inverse of {@link extractTreemapChartStyleOptions}.
@@ -282,8 +282,30 @@ export type SharedFormulaReferenceContext = {
282
282
  };
283
283
  export declare function isSharedFormulaReferenceContext(context: FormulaContext | SharedFormulaReferenceContext): context is SharedFormulaReferenceContext;
284
284
  export type PanelColorFormat = PanelColorFormatSingle | PanelColorFormatRange | PanelColorFormatConditional;
285
+ /**
286
+ * Per-member color formatting stored on Fusion panel items (`format.members`).
287
+ *
288
+ * Used when translating Fusion DTOs into chart `seriesToColorMap` entries.
289
+ */
285
290
  export type PanelMembersFormat = Record<string, {
291
+ /** Resolved member color (hex or CSS color string). */
286
292
  color: string;
293
+ /**
294
+ * Fusion flag that the member carries an explicit color value.
295
+ * Distinct from `isHandPickedColor`: a member can be colored from the
296
+ * auto palette without being user-picked.
297
+ */
298
+ colored?: boolean;
299
+ /**
300
+ * `true` when the user hand-picked the color in Fusion; `false` when it was
301
+ * auto-assigned from the dashboard palette. Only hand-picked entries are
302
+ * lifted into Sankey `seriesToColorMap`.
303
+ */
304
+ isHandPickedColor?: boolean;
305
+ /** Whether this member is present in the current query result set. */
306
+ inResultset?: boolean;
307
+ /** Display title for the member value (may differ from the map key). */
308
+ title?: string;
287
309
  }>;
288
310
  export type PanelColorFormatSingle = {
289
311
  type: 'color';
@@ -333,7 +355,7 @@ type LabelsStyle = {
333
355
  /** Font size of each value label in pixels. */
334
356
  fontSize?: number | null;
335
357
  /** Font style of each value label. */
336
- fontStyle?: 'normal' | 'italic' | null;
358
+ fontStyle?: 'normal' | 'italic';
337
359
  /** Background color behind each value label. */
338
360
  backgroundColor?: string | null;
339
361
  /** Padding in pixels around value label text when background color is set. */
@@ -390,7 +412,7 @@ type BaseWidgetStyle = {
390
412
  /** Font size of legend items in pixels. */
391
413
  fontSize?: number | null;
392
414
  /** Font style of legend items. */
393
- fontStyle?: 'normal' | 'italic' | null;
415
+ fontStyle?: 'normal' | 'italic';
394
416
  };
395
417
  navigator: {
396
418
  enabled: boolean;
@@ -463,7 +485,7 @@ export type FunnelWidgetStyle = BaseWidgetStyle & WidgetContainerStyleOptions &
463
485
  /** Text color of categorical value labels. */
464
486
  labelColor?: string | null;
465
487
  fontSize?: number | null;
466
- fontStyle?: 'normal' | 'italic' | null;
488
+ fontStyle?: 'normal' | 'italic';
467
489
  backgroundColor?: string | null;
468
490
  backgroundPadding?: number | null;
469
491
  borderColor?: string | null;
@@ -487,7 +509,7 @@ export type PieWidgetStyle = BaseWidgetStyle & WidgetContainerStyleOptions & {
487
509
  /** Text color of categorical value labels. */
488
510
  labelColor?: string | null;
489
511
  fontSize?: number | null;
490
- fontStyle?: 'normal' | 'italic' | null;
512
+ fontStyle?: 'normal' | 'italic';
491
513
  backgroundColor?: string | null;
492
514
  backgroundPadding?: number | null;
493
515
  borderColor?: string | null;
@@ -614,6 +636,7 @@ export type SankeyWidgetStyle = {
614
636
  linkOpacity?: number;
615
637
  nodeWidth?: number;
616
638
  nodePadding?: number;
639
+ minLinkWidth?: number;
617
640
  };
618
641
  export type BoxplotWidgetStyle = WidgetContainerStyleOptions & {
619
642
  seriesLabels?: LabelsStyle;
@@ -699,7 +722,7 @@ export type WidgetDtoNarration = {
699
722
  export type WidgetStyle = {
700
723
  widgetDesign?: WidgetDesign;
701
724
  narration?: WidgetDtoNarration;
702
- } & (CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | PieWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle | BoxplotWidgetStyle | ScattermapWidgetStyle | AreamapWidgetStyle | PivotWidgetStyle | CalendarHeatmapWidgetStyle | TextWidgetDtoStyle | TabberWidgetDtoStyle | FilterWidgetDtoStyle);
725
+ } & (CartesianWidgetStyle | PolarWidgetStyle | FunnelWidgetStyle | PieWidgetStyle | ScatterWidgetStyle | TableWidgetStyle | IndicatorWidgetStyle | TreemapWidgetStyle | SunburstWidgetStyle | SankeyWidgetStyle | BoxplotWidgetStyle | ScattermapWidgetStyle | AreamapWidgetStyle | PivotWidgetStyle | CalendarHeatmapWidgetStyle | TextWidgetDtoStyle | TabberWidgetDtoStyle | FilterWidgetDtoStyle);
703
726
  /**
704
727
  * The DTO style of a filter widget (`type: 'filter'`).
705
728
  *
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Invokes `callback` on every rising edge of `isReady` — each time it becomes
3
+ * `true` after being `false`, including the initial render if `isReady` starts
4
+ * `true`. Meant to power `onRender`-style widget lifecycle props: a widget wires
5
+ * up its own "ready" signal (e.g. `!isLoading`, a Highcharts render event) and
6
+ * the hook fires the consumer callback exactly once per readiness cycle.
7
+ *
8
+ * The latest `callback` identity is captured via a ref, so re-creating the
9
+ * callback between renders never itself refires — only a rising edge of
10
+ * `isReady` does.
11
+ *
12
+ * @internal
13
+ */
14
+ export declare function useFireOnReady(isReady: boolean, callback: (() => void) | undefined): void;
@@ -1,4 +1,4 @@
1
- import { AreamapChartDataOptions, BoxplotChartDataOptions, CalendarHeatmapChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, IndicatorChartDataOptions, PivotTableDataOptions, ScatterChartDataOptions, ScattermapChartDataOptions, TableDataOptionsInternal } from '../../../../domains/visualizations/core/chart-data-options/types.js';
1
+ import { AreamapChartDataOptions, BoxplotChartDataOptions, CalendarHeatmapChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, IndicatorChartDataOptions, PivotTableDataOptions, SankeyChartDataOptions, ScatterChartDataOptions, ScattermapChartDataOptions, TableDataOptionsInternal } from '../../../../domains/visualizations/core/chart-data-options/types.js';
2
2
  import { Panel } from '../../../../domains/widgets/components/widget-by-id/types.js';
3
3
  import type { GenericDataOptions } from '../../../../types.js';
4
4
  import { ScattermapStyleOptions } from '../../../../types.js';
@@ -181,6 +181,16 @@ export declare function toAreamapPanels(dataOptions: AreamapChartDataOptions): P
181
181
  * @internal
182
182
  */
183
183
  export declare function toBoxplotPanels(dataOptions: BoxplotChartDataOptions): Panel[];
184
+ /**
185
+ * Builds DTO panels for a sankey chart widget. The Fusion sankey manifest declares
186
+ * `category` (2+ attributes) and `value` (single measure) panels — both are always
187
+ * emitted, matching the inverse read in {@link extractSankeyChartDataOptions}.
188
+ *
189
+ * @param dataOptions - Sankey chart data options from the WidgetModel
190
+ * @returns Fusion panels in fixed order: category, value
191
+ * @internal
192
+ */
193
+ export declare function toSankeyPanels(dataOptions: SankeyChartDataOptions): Panel[];
184
194
  /**
185
195
  * Builds DTO panels for a calendar-heatmap widget. The Fusion `heatmap` manifest declares
186
196
  * `date` (single attribute) and `color` (single measure) panels — both are always emitted,
@@ -1,4 +1,5 @@
1
1
  import { type DataSource, DataSourceField } from '@sisense/sdk-data';
2
+ import { type DisplayNameConfig } from '@sisense/sdk-query-client/dispatcher';
2
3
  import { HttpClient } from '@sisense/sdk-rest-client';
3
4
  import { FeatureCollection as GeoJsonFeatureCollection } from 'geojson';
4
5
  import { GetHierarchiesOptions } from '../../domains/drilldown/hierarchy-model/types';
@@ -30,6 +31,7 @@ type GetDashboardOptions = {
30
31
  export declare class RestApi {
31
32
  private httpClient;
32
33
  private defaultDataSource?;
34
+ private readonly queryApi;
33
35
  constructor(httpClient: HttpClient | undefined, defaultDataSource?: DataSource);
34
36
  /**
35
37
  * Get all dashboards
@@ -113,16 +115,21 @@ export declare class RestApi {
113
115
  */
114
116
  getSharedFormula: (sharedFormulaId: string) => Promise<SharedFormulaDto | undefined>;
115
117
  /**
116
- * Get legacy Fusion datasource fields
118
+ * Gets legacy Fusion datasource fields.
119
+ *
120
+ * Delegates to {@link QueryApiDispatcher}. Pass `displayNameConfig` from
121
+ * app settings (`AppSettings.displayNameConfig`) at the call site when available.
117
122
  *
118
123
  * @param dataSource - A datasource name
119
- * @param options - An object with offset and count
124
+ * @param options - Paging, search term, and optional live / displayNameConfig
120
125
  * @returns A list of datasource fields
121
126
  */
122
127
  getDataSourceFields: (dataSource: string, options?: {
123
128
  offset?: number;
124
129
  count?: number;
125
130
  searchValue?: string;
131
+ live?: boolean;
132
+ displayNameConfig?: DisplayNameConfig;
126
133
  }) => Promise<DataSourceField[] | undefined>;
127
134
  /**
128
135
  * Export JAQL query results as an XLSX file (binary response).
@@ -1,11 +1,32 @@
1
+ import type { DisplayNameConfig } from '@sisense/sdk-query-client/dispatcher';
1
2
  import { AppConfig, SystemSettings } from './types';
3
+ /**
4
+ * Raw JSON shape of `GET api/v1/settings/system` (Fusion wire key is `displayName`).
5
+ *
6
+ * @internal
7
+ */
8
+ export type SystemSettingsWire = {
9
+ tracking?: SystemSettings['tracking'];
10
+ displayName?: DisplayNameConfig;
11
+ /** Already-normalized payloads are accepted for convenience. */
12
+ displayNameConfig?: DisplayNameConfig;
13
+ };
14
+ /**
15
+ * Maps Fusion system-settings JSON to {@link SystemSettings}.
16
+ * Wire key `displayName` becomes CSDK `displayNameConfig`.
17
+ *
18
+ * @param wire - Raw API response (or already-normalized settings)
19
+ * @returns Normalized system settings
20
+ * @internal
21
+ */
22
+ export declare function normalizeSystemSettings(wire: SystemSettingsWire | null | undefined): SystemSettings | undefined;
2
23
  /**
3
24
  * Checks if the API Telemetry feature is enabled
4
25
  *
5
- * @param systemSettings - System settings
26
+ * @param systemSettings - System settings from `api/v1/settings/system`
6
27
  * @returns True if the API Telemetry feature is enabled, false otherwise
7
28
  */
8
- export declare function isApiTelemetryEnabled(systemSettings?: SystemSettings): boolean;
29
+ export declare function isApiTelemetryEnabled(systemSettings?: Pick<SystemSettings, 'tracking'>): boolean;
9
30
  /**
10
31
  * Prepares the API Telemetry headers
11
32
  *
@@ -1,6 +1,7 @@
1
1
  import { HttpClient } from '@sisense/sdk-rest-client';
2
2
  import { AppConfig, ThemeSettings } from '../../../types';
3
3
  import { LegacyDesignSettings } from '../../themes/legacy-design-settings.js';
4
+ import type { SystemSettings } from '../types';
4
5
  import { FeatureMap } from './types/features.js';
5
6
  /**
6
7
  * Known AI feature flags exposed on {@link AppSettings} `ai.featureFlags`.
@@ -42,7 +43,7 @@ type AiSettingsSlice = {
42
43
  *
43
44
  * @sisenseInternal
44
45
  */
45
- export type AppSettings = Required<ConfigurableAppSettings> & ServerSettings;
46
+ export type AppSettings = Required<ConfigurableAppSettings> & ServerSettings & Pick<SystemSettings, 'displayNameConfig'>;
46
47
  /**
47
48
  * Application settings that can be overridden by the user
48
49
  */
@@ -152,8 +153,10 @@ type ServerSettings = {
152
153
  *
153
154
  * @param customConfig - Custom application configuration
154
155
  * @param httpClient - Sisense REST API client
155
- * @param isWat - Whether the application is running with WAT authentication
156
+ * @param useDefaultPalette - Whether to use the default palette
157
+ * @param systemSettings - Already-fetched `api/v1/settings/system` payload (e.g. from
158
+ * bootstrap telemetry). Merged into {@link AppSettings} so callers do not re-fetch.
156
159
  * @returns - Application settings
157
160
  */
158
- export declare function getSettings(customConfig: ConfigurableAppSettings, httpClient: Pick<HttpClient, 'get' | 'url'>, useDefaultPalette?: boolean): Promise<AppSettings>;
161
+ export declare function getAppSettings(customConfig: ConfigurableAppSettings, httpClient: Pick<HttpClient, 'get' | 'url'>, useDefaultPalette?: boolean, systemSettings?: SystemSettings): Promise<AppSettings>;
159
162
  export {};
@@ -1,11 +1,12 @@
1
1
  import { DataSource } from '@sisense/sdk-data';
2
2
  import { PivotQueryClient } from '@sisense/sdk-pivot-query-client';
3
3
  import { QueryClient } from '@sisense/sdk-query-client';
4
+ import type { DisplayNameConfig } from '@sisense/sdk-query-client/dispatcher';
4
5
  import { HttpClient } from '@sisense/sdk-rest-client';
5
6
  import { TrackingEventDetails } from '@sisense/sdk-tracking';
6
7
  import type { Locale } from 'date-fns';
7
8
  import { DateConfig, LoadingIndicatorConfig, TranslationConfig } from '../../types';
8
- import { AppSettings } from './settings/settings';
9
+ import type { AppSettings } from './settings/settings';
9
10
  /**
10
11
  * Application configuration
11
12
  */
@@ -259,8 +260,20 @@ export interface ClientApplication {
259
260
  clear: () => void;
260
261
  };
261
262
  }
263
+ /**
264
+ * Normalized system settings used by CSDK (from `GET api/v1/settings/system`).
265
+ * Wire JSON uses `displayName`; normalize at fetch maps it to `displayNameConfig`.
266
+ */
262
267
  export type SystemSettings = {
263
268
  tracking?: {
264
269
  apiTelemetry?: boolean;
265
270
  };
271
+ /**
272
+ * Column display-name feature from the configuration service.
273
+ * When `enabled` and `useNewSearchByDisplayNameApi` are both true, field search
274
+ * uses `fields/searchByDisplayName?isLive=` instead of `fields/search`.
275
+ *
276
+ * @internal
277
+ */
278
+ displayNameConfig?: DisplayNameConfig;
266
279
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -439,6 +439,20 @@ declare const _default: {
439
439
  };
440
440
  };
441
441
  };
442
+ kpi: {
443
+ comparison: {
444
+ vsPriorYear: string;
445
+ vsPriorQuarter: string;
446
+ vsPriorMonth: string;
447
+ vsPriorWeek: string;
448
+ vsPriorDay: string;
449
+ vsPriorPeriod: string;
450
+ };
451
+ target: {
452
+ ofGoal: string;
453
+ toGo: string;
454
+ };
455
+ };
442
456
  loadingOverlay: {
443
457
  label: string;
444
458
  };
@@ -436,6 +436,20 @@ export declare const translation: {
436
436
  };
437
437
  };
438
438
  };
439
+ kpi: {
440
+ comparison: {
441
+ vsPriorYear: string;
442
+ vsPriorQuarter: string;
443
+ vsPriorMonth: string;
444
+ vsPriorWeek: string;
445
+ vsPriorDay: string;
446
+ vsPriorPeriod: string;
447
+ };
448
+ target: {
449
+ ofGoal: string;
450
+ toGo: string;
451
+ };
452
+ };
439
453
  loadingOverlay: {
440
454
  label: string;
441
455
  };
@@ -446,6 +446,20 @@ export declare const resources: {
446
446
  };
447
447
  };
448
448
  };
449
+ kpi: {
450
+ comparison: {
451
+ vsPriorYear: string;
452
+ vsPriorQuarter: string;
453
+ vsPriorMonth: string;
454
+ vsPriorWeek: string;
455
+ vsPriorDay: string;
456
+ vsPriorPeriod: string;
457
+ };
458
+ target: {
459
+ ofGoal: string;
460
+ toGo: string;
461
+ };
462
+ };
449
463
  loadingOverlay: {
450
464
  label: string;
451
465
  };
@@ -920,6 +934,20 @@ export declare const resources: {
920
934
  };
921
935
  };
922
936
  };
937
+ kpi: {
938
+ comparison: {
939
+ vsPriorYear: string;
940
+ vsPriorQuarter: string;
941
+ vsPriorMonth: string;
942
+ vsPriorWeek: string;
943
+ vsPriorDay: string;
944
+ vsPriorPeriod: string;
945
+ };
946
+ target: {
947
+ ofGoal: string;
948
+ toGo: string;
949
+ };
950
+ };
923
951
  loadingOverlay: {
924
952
  label: string;
925
953
  };