@sisense/sdk-ui 2.8.0 → 2.10.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 +32 -32
- package/dist/ai.js +126 -125
- package/dist/analytics-composer/node.cjs +3 -0
- package/dist/analytics-composer/node.d.ts +1 -0
- package/dist/analytics-composer/node.js +1033 -0
- package/dist/analytics-composer.cjs +118 -118
- package/dist/analytics-composer.js +2211 -2906
- package/dist/derive-chart-family-B1on_xkS.cjs +170 -0
- package/dist/derive-chart-family-BllGhqsW.js +29469 -0
- package/dist/dimensions-BYqdB-Q8.cjs +1 -0
- package/dist/{dimensions-b8xRITJn.js → dimensions-D-Z9sitz.js} +3 -3
- package/dist/execute-query-CABqVn7C.cjs +1 -0
- package/dist/execute-query-CGLL9vXX.js +6428 -0
- package/dist/index.cjs +25 -26
- package/dist/index.js +9320 -8693
- package/dist/index.umd.js +389 -440
- package/dist/packages/sdk-ui/src/analytics-composer/index-node.d.ts +9 -0
- package/dist/packages/sdk-ui/src/analytics-composer/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/common.d.ts +40 -0
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/index.d.ts +2 -0
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-dimensions.d.ts +3 -0
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-filters.d.ts +44 -0
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-measures.d.ts +30 -0
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-query-to-jaql.d.ts +18 -0
- package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-query.d.ts +224 -0
- package/dist/packages/sdk-ui/src/analytics-composer/types.d.ts +40 -1
- package/dist/packages/sdk-ui/src/calendar-heatmap-chart.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/helpers/get-load-data-function.d.ts +3 -1
- package/dist/packages/sdk-ui/src/chart/helpers/use-chart-data-preparation.d.ts +3 -1
- package/dist/packages/sdk-ui/src/chart/helpers/use-translated-data-options.d.ts +1 -1
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/calendar-heatmap-chart-builder.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/constants.d.ts +87 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data-options/data-options.d.ts +54 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data-options/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/data.d.ts +33 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/design-options.d.ts +22 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/highcharts-options-builder.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/axes-options.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/chart-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/extras-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/index.d.ts +7 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/legend-options.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/plot-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/series-options/calendar-data-generator.d.ts +35 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/series-options/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/series-options/series-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/highchart-options-builder/options/tooltip-options.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-heatmap-charts-grid.d.ts +26 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-heatmap.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-pagination/calendar-pagination.d.ts +30 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-pagination/helpers.d.ts +3 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/calendar-pagination/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/helpers/data-helpers.d.ts +4 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/helpers/sizing-helpers.d.ts +25 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/helpers/view-helpers.d.ts +14 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/hooks/index.d.ts +4 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/hooks/use-calendar-heatmap-chart-options.d.ts +55 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/hooks/use-calendar-heatmap-navigation.d.ts +33 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/renderer/index.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/calendar-heatmap-chart/types.d.ts +13 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/helpers/data-options.d.ts +5 -1
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/helpers/highchart-options/axis.d.ts +5 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/helpers/highchart-options/legend.d.ts +3 -2
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/helpers/highchart-options/y-axis.d.ts +28 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/line-chart/helpers/design-options.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/line-chart/highchart-options/axes.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/line-chart/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/line-chart/line-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/polar-chart/data/index.d.ts +10 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/polar-chart/data-options/index.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/polar-chart/design-options/index.d.ts +18 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/polar-chart/highchart-options/axes.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/polar-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/polar-chart/polar-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/area-chart/area-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/area-chart/helpers/design-options.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/area-chart/highchart-options/axes.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/area-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/area-chart/highchart-options/labels-spacing.d.ts +8 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/bar-chart/highchart-options/axes.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/bar-chart/highchart-options/labels-spacing.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/column-chart/highchart-options/axes.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/column-chart/highchart-options/labels-spacing.d.ts +9 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/helpers/highchart-options/stacking.d.ts +21 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/stackable/types.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/cartesians/types.d.ts +1 -1
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/helpers/data-options.d.ts +22 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/helpers/data.d.ts +13 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/alerts/index.d.ts +5 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/data/index.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/data-options/index.d.ts +32 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/design-options/index.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/highchart-options/highcharts-options-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/pie-chart-builder.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/categoricals/pie-chart/types.d.ts +12 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/build-highchart-options.d.ts +9 -4
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/highcharts-based-chart-renderer.d.ts +2 -4
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/use-extra-config.d.ts +2 -0
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/utils.d.ts +2 -1
- package/dist/packages/sdk-ui/src/chart/restructured-charts/highchart-based-charts/types.d.ts +1 -1
- package/dist/packages/sdk-ui/src/chart/restructured-charts/types.d.ts +10 -9
- package/dist/packages/sdk-ui/src/chart/restructured-charts/utils.d.ts +5 -0
- package/dist/packages/sdk-ui/src/chart-data/data-coloring/types.d.ts +6 -0
- package/dist/packages/sdk-ui/src/chart-data/types.d.ts +2 -1
- package/dist/packages/sdk-ui/src/chart-data-options/translate-data-options.d.ts +2 -1
- package/dist/packages/sdk-ui/src/chart-data-options/types.d.ts +19 -2
- package/dist/packages/sdk-ui/src/chart-data-options/utils.d.ts +4 -4
- package/dist/packages/sdk-ui/src/chart-data-options/validate-data-options/validate-categorical-data-options.d.ts +14 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/axis/axis-builders.d.ts +155 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/axis/axis-settings.d.ts +39 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/axis/axis-transformers.d.ts +45 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/axis/axis-utils.d.ts +1 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/axis/date-utils.d.ts +27 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/axis/index.d.ts +3 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/chart-configuration.d.ts +33 -3
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/series-processor.d.ts +4 -1
- package/dist/packages/sdk-ui/src/chart-options-processor/{category-chart-options.d.ts → category-chart-options/category-chart-options.d.ts} +9 -5
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/funnel-chart-options.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/pie-chart-options.d.ts +15 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/sunburst-chart-options.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/category-chart-options/treemap-chart-options.d.ts +17 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/chart-options-service.d.ts +26 -10
- package/dist/packages/sdk-ui/src/chart-options-processor/defaults/cartesian.d.ts +4 -3
- package/dist/packages/sdk-ui/src/chart-options-processor/scatter-chart-options.d.ts +3 -3
- package/dist/packages/sdk-ui/src/chart-options-processor/style-to-design-options-translator/translate-to-highcharts-options.d.ts +1 -3
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/axis-section.d.ts +11 -12
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/design-options.d.ts +19 -5
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/legend-section.d.ts +28 -14
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/pie-series.d.ts +34 -6
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/tooltip-utils.d.ts +5 -0
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/translations-to-highcharts.d.ts +1 -1
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/types.d.ts +61 -4
- package/dist/packages/sdk-ui/src/chart-options-processor/translations/value-label-section.d.ts +2 -2
- package/dist/packages/sdk-ui/src/common/formatters/create-date-formatter.d.ts +10 -0
- package/dist/packages/sdk-ui/src/common/hooks/useDateFormatter.d.ts +7 -0
- package/dist/packages/sdk-ui/src/common/icons/double-arrow-end-icon.d.ts +6 -0
- package/dist/packages/sdk-ui/src/const.d.ts +2 -0
- package/dist/packages/sdk-ui/src/dashboard/components/editable-layout/utils.d.ts +0 -19
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/index.d.ts +1 -1
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-filters.d.ts +12 -1
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-formatters.d.ts +18 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-handlers.d.ts +23 -0
- package/dist/packages/sdk-ui/src/dashboard/hooks/jtd/jtd-widget-transforms.d.ts +29 -0
- package/dist/packages/sdk-ui/src/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-utils.d.ts +1 -0
- package/dist/packages/sdk-ui/src/pivot-table/formatters/data-cell-formatters/index.d.ts +1 -0
- package/dist/packages/sdk-ui/src/pivot-table/formatters/formatter-utils.d.ts +23 -0
- package/dist/packages/sdk-ui/src/pivot-table/formatters/header-cell-formatters/header-cell-value-formatter.d.ts +2 -1
- package/dist/packages/sdk-ui/src/pivot-table/formatters/types.d.ts +45 -3
- package/dist/packages/sdk-ui/src/pivot-table/formatters/utils.d.ts +1 -0
- package/dist/packages/sdk-ui/src/pivot-table/hooks/use-apply-pivot-table-formatting.d.ts +4 -1
- package/dist/packages/sdk-ui/src/polar-chart.d.ts +1 -1
- package/dist/packages/sdk-ui/src/props.d.ts +161 -7
- package/dist/packages/sdk-ui/src/query/date-formats/apply-date-format.d.ts +7 -6
- package/dist/packages/sdk-ui/src/query/date-formats/index.d.ts +1 -1
- package/dist/packages/sdk-ui/src/query/execute-query.d.ts +3 -1
- package/dist/packages/sdk-ui/src/query-execution/index.d.ts +1 -1
- package/dist/packages/sdk-ui/src/query-execution/types.d.ts +9 -2
- package/dist/packages/sdk-ui/src/sisense-chart/types.d.ts +2 -2
- package/dist/packages/sdk-ui/src/theme-provider/default-theme-settings.d.ts +1 -0
- package/dist/packages/sdk-ui/src/translation/resources/en.d.ts +11 -0
- package/dist/packages/sdk-ui/src/translation/resources/index.d.ts +22 -0
- package/dist/packages/sdk-ui/src/types.d.ts +254 -16
- package/dist/packages/sdk-ui/src/utils/combine-handlers.d.ts +19 -0
- package/dist/packages/sdk-ui/src/utils/utility-types/transformer.d.ts +8 -0
- package/dist/packages/sdk-ui/src/widget-by-id/translate-dashboard-filters.d.ts +1 -1
- package/dist/packages/sdk-ui/src/widget-by-id/translate-panel-color-format.d.ts +9 -0
- package/dist/packages/sdk-ui/src/widget-by-id/translate-statistical-models.d.ts +10 -0
- package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-data-options.d.ts +0 -14
- package/dist/packages/sdk-ui/src/widget-by-id/types.d.ts +10 -10
- package/dist/types-BRtWk8uC.js +80 -0
- package/dist/types-Ds0KtTJF.cjs +1 -0
- package/dist/use-common-filters-D8tEa9zb.js +91245 -0
- package/dist/use-common-filters-hw1WKPCY.cjs +844 -0
- package/dist/{widget-composer-BPlNiX_P.cjs → widget-composer-B7zeAa_D.cjs} +9 -9
- package/dist/{widget-composer-SGEFYrXY.js → widget-composer-DL0xPtlC.js} +143 -217
- package/package.json +20 -10
- package/dist/derive-chart-family-6PZA-xZh.js +0 -92092
- package/dist/derive-chart-family-DQUVKMcV.cjs +0 -656
- package/dist/dimensions-x8nnAUew.cjs +0 -1
- package/dist/packages/sdk-ui/src/chart-options-processor/cartesian/utils/axis-configuration.d.ts +0 -41
- package/dist/use-common-filters-BHBy4uv6.js +0 -32218
- package/dist/use-common-filters-Cg217teN.cjs +0 -350
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Node.js compatible exports for analytics-composer
|
|
3
|
+
*
|
|
4
|
+
* This module exports only the functions that work in Node.js environment
|
|
5
|
+
* without any browser dependencies like DOM, React components, or chart libraries.
|
|
6
|
+
*/
|
|
7
|
+
export * from './types';
|
|
8
|
+
export * from './common/custom-superjson';
|
|
9
|
+
export * from './new-nlq-translator/';
|
|
@@ -20,3 +20,4 @@ export * as dashboardComposer from './dashboard/dashboard-composer';
|
|
|
20
20
|
export * as executeQueryComposer from './execute-query/execute-query-composer';
|
|
21
21
|
export * from './common/custom-superjson';
|
|
22
22
|
export * from './widget/chart-options/get-widget-options';
|
|
23
|
+
export * from './new-nlq-translator/';
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { Filter, FilterRelations, JaqlDataSourceForDto, JSONArray, Measure } from '@sisense/sdk-data';
|
|
2
|
+
import { NormalizedTable } from '../types.js';
|
|
3
|
+
export type ParsedArg = string | number | ParsedFunctionCall | string[];
|
|
4
|
+
export type ParsedFunctionCall = {
|
|
5
|
+
function: string;
|
|
6
|
+
args: ParsedArg[];
|
|
7
|
+
};
|
|
8
|
+
export declare function isParsedFunctionCallArray(value: JSONArray): value is ParsedFunctionCall[];
|
|
9
|
+
type QueryElement = Filter | FilterRelations | Measure;
|
|
10
|
+
export declare function isFilterElement(arg: QueryElement): arg is Filter;
|
|
11
|
+
export declare function isFilterRelationsElement(arg: QueryElement): arg is FilterRelations;
|
|
12
|
+
export declare function isMeasureElement(arg: QueryElement): arg is Measure;
|
|
13
|
+
export declare function getFactoryFunctionsMap(factoryName: string, factoryObject: Record<string, any>): Record<string, (...args: any[]) => any>;
|
|
14
|
+
export declare const measureFactoryFunctionsMap: Record<string, (...args: any[]) => any>;
|
|
15
|
+
export declare const filterFactoryFunctionsMap: Record<string, (...args: any[]) => any>;
|
|
16
|
+
/**
|
|
17
|
+
* Validates if a string is likely an attribute based on the actual table schema.
|
|
18
|
+
*
|
|
19
|
+
* @param str - The string to check
|
|
20
|
+
* @param tables - The normalized tables to check against
|
|
21
|
+
* @returns True if the string matches known table/column combinations
|
|
22
|
+
*/
|
|
23
|
+
export declare function validateLikelyAttribute(str: string, tables: NormalizedTable[]): {
|
|
24
|
+
isLikelyAttribute: true;
|
|
25
|
+
suggestion: string;
|
|
26
|
+
} | {
|
|
27
|
+
isLikelyAttribute: false;
|
|
28
|
+
suggestion?: never;
|
|
29
|
+
};
|
|
30
|
+
export declare function createAttribute(attributeName: string, dataSource: JaqlDataSourceForDto, tables: NormalizedTable[]): import("@sisense/sdk-data").Attribute | import("@sisense/sdk-data").LevelAttribute;
|
|
31
|
+
/**
|
|
32
|
+
* Recursively processes a parsed JSON object to execute filterFactory and measureFactory functions.
|
|
33
|
+
*
|
|
34
|
+
* @param parsedObject - The parsed JSON object representing a function call or a nested structure.
|
|
35
|
+
* @param dataSource - The data source to use for the query.
|
|
36
|
+
* @param tables - The tables to use for the query.
|
|
37
|
+
* @returns The result of the executed function or the processed nested structure.
|
|
38
|
+
*/
|
|
39
|
+
export declare function processNode(parsedObject: ParsedFunctionCall, dataSource: JaqlDataSourceForDto, tables: NormalizedTable[]): QueryElement;
|
|
40
|
+
export {};
|
package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-dimensions.d.ts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { Attribute, JaqlDataSourceForDto, JSONArray } from '@sisense/sdk-data';
|
|
2
|
+
import { NlqTranslationResult, NormalizedTable } from '../types.js';
|
|
3
|
+
export declare const translateDimensionsJSON: (dimensionsJSON: JSONArray, dataSource: JaqlDataSourceForDto, tables: NormalizedTable[]) => NlqTranslationResult<Attribute[]>;
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { Filter, FilterRelations, JaqlDataSourceForDto, JSONArray } from '@sisense/sdk-data';
|
|
2
|
+
import { NlqTranslationResult, NormalizedTable } from '../types.js';
|
|
3
|
+
import { ParsedFunctionCall } from './common.js';
|
|
4
|
+
/**
|
|
5
|
+
* Translate an array of JSON objects to filters
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* [{
|
|
9
|
+
* "function": "filterFactory.logic.or",
|
|
10
|
+
* "args": [
|
|
11
|
+
* {
|
|
12
|
+
* "function": "filterFactory.startsWith",
|
|
13
|
+
* "args": ["DM.Country.Country", "A"]
|
|
14
|
+
* },
|
|
15
|
+
* {
|
|
16
|
+
* "function": "filterFactory.measureGreaterThan",
|
|
17
|
+
* "args": [
|
|
18
|
+
* {
|
|
19
|
+
* "function": "measureFactory.sum",
|
|
20
|
+
* "args": ["DM.Commerce.Revenue", "Total Revenue"]
|
|
21
|
+
* },
|
|
22
|
+
* 1000
|
|
23
|
+
* ]
|
|
24
|
+
* }
|
|
25
|
+
* ]
|
|
26
|
+
* }]
|
|
27
|
+
*
|
|
28
|
+
* is translated to the following Filter[] or FilterRelations object:
|
|
29
|
+
* filterFactory.logic.or([
|
|
30
|
+
* filterFactory.startsWith("DM.Country.Country", "A"),
|
|
31
|
+
* filterFactory.measureGreaterThan(
|
|
32
|
+
* measureFactory.sum("DM.Commerce.Revenue", "Total Revenue"),
|
|
33
|
+
* 1000
|
|
34
|
+
* )
|
|
35
|
+
* ])
|
|
36
|
+
* @param filtersJSON - A JSON array representing the filters
|
|
37
|
+
* @param dataSource - The data source to use for the filters
|
|
38
|
+
* @param tables - The tables to use for the filters
|
|
39
|
+
* @returns A Filter[] or FilterRelations object
|
|
40
|
+
*/
|
|
41
|
+
export declare const translateFiltersFromJSONFunctionCall: (filtersJSON: ParsedFunctionCall[], dataSource: JaqlDataSourceForDto, tables: NormalizedTable[]) => NlqTranslationResult<Filter[] | FilterRelations>;
|
|
42
|
+
export declare const translateFiltersJSON: (filtersJSON: JSONArray, dataSource: JaqlDataSourceForDto, tables: NormalizedTable[]) => NlqTranslationResult<Filter[] | FilterRelations>;
|
|
43
|
+
export declare const translateHighlightsFromJSONFunctionCall: (highlightsJSON: ParsedFunctionCall[], dataSource: JaqlDataSourceForDto, tables: NormalizedTable[]) => NlqTranslationResult<Filter[]>;
|
|
44
|
+
export declare const translateHighlightsJSON: (highlightsJSON: JSONArray, dataSource: JaqlDataSourceForDto, tables: NormalizedTable[]) => NlqTranslationResult<Filter[]>;
|
package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-measures.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { JaqlDataSourceForDto, JSONArray, Measure } from '@sisense/sdk-data';
|
|
2
|
+
import { NlqTranslationResult, NormalizedTable } from '../types.js';
|
|
3
|
+
import { ParsedFunctionCall } from './common.js';
|
|
4
|
+
/**
|
|
5
|
+
* Translate an array of JSON objects to measures
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* [
|
|
9
|
+
* {
|
|
10
|
+
* "function": "measureFactory.sum",
|
|
11
|
+
* "args": ["DM.Commerce.Revenue", "Total Revenue"]
|
|
12
|
+
* },
|
|
13
|
+
* {
|
|
14
|
+
* "function": "measureFactory.sum",
|
|
15
|
+
* "args": ["DM.Commerce.Cost", "Total Cost"]
|
|
16
|
+
* }
|
|
17
|
+
* ]
|
|
18
|
+
*
|
|
19
|
+
* is translated to the following Measure[] object:
|
|
20
|
+
* [
|
|
21
|
+
* measureFactory.sum("DM.Commerce.Revenue", "Total Revenue"),
|
|
22
|
+
* measureFactory.sum("DM.Commerce.Cost", "Total Cost")
|
|
23
|
+
* ]
|
|
24
|
+
* @param measuresJSON - A JSON array representing the measures
|
|
25
|
+
* @param dataSource - The data source to use for the measures
|
|
26
|
+
* @param tables - The tables to use for the measures
|
|
27
|
+
* @returns A Measure[] object
|
|
28
|
+
*/
|
|
29
|
+
export declare const translateMeasuresFromJSONFunctionCall: (measuresJSON: ParsedFunctionCall[], dataSource: JaqlDataSourceForDto, tables: NormalizedTable[]) => NlqTranslationResult<Measure[]>;
|
|
30
|
+
export declare const translateMeasuresJSON: (measuresJSON: JSONArray, dataSource: JaqlDataSourceForDto, tables: NormalizedTable[]) => NlqTranslationResult<Measure[]>;
|
package/dist/packages/sdk-ui/src/analytics-composer/new-nlq-translator/translate-query-to-jaql.d.ts
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { type DataSource } from '@sisense/sdk-data';
|
|
2
|
+
import type { JaqlQueryPayload } from '@sisense/sdk-query-client';
|
|
3
|
+
import { BaseQueryParams } from '../../query-execution/types.js';
|
|
4
|
+
/**
|
|
5
|
+
* Converts BaseQueryParams to JAQL payload
|
|
6
|
+
*
|
|
7
|
+
* This is a pure TypeScript function that works in Node.js environments
|
|
8
|
+
* and converts query parameters to JAQL without requiring React hooks or browser APIs.
|
|
9
|
+
*
|
|
10
|
+
* Reuses the existing query preparation logic from executeQuery to avoid duplication.
|
|
11
|
+
*
|
|
12
|
+
* @param queryParams - The base query parameters from NLQ translation
|
|
13
|
+
* @param defaultDataSource - Default data source if not specified in queryParams
|
|
14
|
+
* @param shouldSkipHighlightsWithoutAttributes - Whether to skip highlights without corresponding attributes
|
|
15
|
+
* @returns The JAQL query payload
|
|
16
|
+
* @internal
|
|
17
|
+
*/
|
|
18
|
+
export declare function translateQueryToJaql(queryParams: BaseQueryParams, defaultDataSource?: DataSource, shouldSkipHighlightsWithoutAttributes?: boolean): JaqlQueryPayload;
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
import { JaqlDataSourceForDto } from '@sisense/sdk-data';
|
|
2
|
+
import { NormalizedTable, NlqResponseJSON } from '../types.js';
|
|
3
|
+
import { BaseQueryParams } from '../../query-execution';
|
|
4
|
+
/**
|
|
5
|
+
* Translate Query JSON generated by the new NLQ API to BaseQueryParams object.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* {
|
|
9
|
+
dimensions: ['DM.Category.Category', 'DM.Brand.Brand'],
|
|
10
|
+
measures: [
|
|
11
|
+
{
|
|
12
|
+
function: 'measureFactory.sum',
|
|
13
|
+
args: ['DM.Commerce.Revenue', 'Total Revenue'],
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
function: 'measureFactory.sum',
|
|
17
|
+
args: ['DM.Commerce.Cost', 'Total Cost'],
|
|
18
|
+
},
|
|
19
|
+
],
|
|
20
|
+
filters: [
|
|
21
|
+
{
|
|
22
|
+
function: 'filterFactory.members',
|
|
23
|
+
args: ['DM.Commerce.Date.Years', ['2024-01-01T00:00:00']],
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
function: 'filterFactory.topRanking',
|
|
27
|
+
args: [
|
|
28
|
+
'DM.Brand.Brand',
|
|
29
|
+
{
|
|
30
|
+
function: 'measureFactory.sum',
|
|
31
|
+
args: ['DM.Commerce.Revenue', 'Total Revenue'],
|
|
32
|
+
},
|
|
33
|
+
5,
|
|
34
|
+
],
|
|
35
|
+
},
|
|
36
|
+
],
|
|
37
|
+
}
|
|
38
|
+
*
|
|
39
|
+
* is translated to the following Query object:
|
|
40
|
+
* {
|
|
41
|
+
"dataSource": {
|
|
42
|
+
"address": "LocalHost",
|
|
43
|
+
"id": "localhost_aSampleIAAaECommerce",
|
|
44
|
+
"title": "Sample ECommerce",
|
|
45
|
+
"type": "elasticube",
|
|
46
|
+
},
|
|
47
|
+
"dimensions": [
|
|
48
|
+
{
|
|
49
|
+
"__serializable": "DimensionalAttribute",
|
|
50
|
+
"composeCode": "DM.Category.Category",
|
|
51
|
+
"dataSource": {
|
|
52
|
+
"address": "LocalHost",
|
|
53
|
+
"id": "localhost_aSampleIAAaECommerce",
|
|
54
|
+
"live": false,
|
|
55
|
+
"title": "Sample ECommerce",
|
|
56
|
+
},
|
|
57
|
+
"description": "",
|
|
58
|
+
"expression": "[Category.Category]",
|
|
59
|
+
"name": "Category",
|
|
60
|
+
"type": "text-attribute",
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"__serializable": "DimensionalAttribute",
|
|
64
|
+
"composeCode": "DM.Brand.Brand",
|
|
65
|
+
"dataSource": {
|
|
66
|
+
"address": "LocalHost",
|
|
67
|
+
"id": "localhost_aSampleIAAaECommerce",
|
|
68
|
+
"live": false,
|
|
69
|
+
"title": "Sample ECommerce",
|
|
70
|
+
},
|
|
71
|
+
"description": "",
|
|
72
|
+
"expression": "[Brand.Brand]",
|
|
73
|
+
"name": "Brand",
|
|
74
|
+
"type": "text-attribute",
|
|
75
|
+
},
|
|
76
|
+
],
|
|
77
|
+
"filters": [
|
|
78
|
+
{
|
|
79
|
+
"__serializable": "RankingFilter",
|
|
80
|
+
"_name": "filter",
|
|
81
|
+
"attribute": {
|
|
82
|
+
"__serializable": "DimensionalAttribute",
|
|
83
|
+
"composeCode": "DM.Brand.Brand",
|
|
84
|
+
"dataSource": {
|
|
85
|
+
"address": "LocalHost",
|
|
86
|
+
"id": "localhost_aSampleIAAaECommerce",
|
|
87
|
+
"live": false,
|
|
88
|
+
"title": "Sample ECommerce",
|
|
89
|
+
},
|
|
90
|
+
"description": "",
|
|
91
|
+
"expression": "[Brand.Brand]",
|
|
92
|
+
"name": "Brand",
|
|
93
|
+
"type": "text-attribute",
|
|
94
|
+
},
|
|
95
|
+
"composeCode": "filterFactory.topRanking(DM.Brand.Brand, measureFactory.sum(DM.Commerce.Revenue, 'Total Revenue'), 5)",
|
|
96
|
+
"config": {
|
|
97
|
+
"disabled": false,
|
|
98
|
+
"locked": false,
|
|
99
|
+
},
|
|
100
|
+
"count": 5,
|
|
101
|
+
"description": "",
|
|
102
|
+
"filterType": "ranking",
|
|
103
|
+
"isScope": true,
|
|
104
|
+
"measure": {
|
|
105
|
+
"__serializable": "DimensionalBaseMeasure",
|
|
106
|
+
"aggregation": "sum",
|
|
107
|
+
"attribute": {
|
|
108
|
+
"__serializable": "DimensionalAttribute",
|
|
109
|
+
"composeCode": "DM.Commerce.Revenue",
|
|
110
|
+
"dataSource": {
|
|
111
|
+
"address": "LocalHost",
|
|
112
|
+
"id": "localhost_aSampleIAAaECommerce",
|
|
113
|
+
"live": false,
|
|
114
|
+
"title": "Sample ECommerce",
|
|
115
|
+
},
|
|
116
|
+
"description": "",
|
|
117
|
+
"expression": "[Commerce.Revenue]",
|
|
118
|
+
"name": "Revenue",
|
|
119
|
+
"type": "numeric-attribute",
|
|
120
|
+
},
|
|
121
|
+
"composeCode": "measureFactory.sum(DM.Commerce.Revenue, 'Total Revenue')",
|
|
122
|
+
"dataSource": undefined,
|
|
123
|
+
"description": "",
|
|
124
|
+
"name": "Total Revenue",
|
|
125
|
+
"sort": 0,
|
|
126
|
+
"type": "basemeasure",
|
|
127
|
+
},
|
|
128
|
+
"operator": "top",
|
|
129
|
+
"type": "filter",
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
"__serializable": "MembersFilter",
|
|
133
|
+
"_name": "filter",
|
|
134
|
+
"attribute": {
|
|
135
|
+
"__serializable": "DimensionalLevelAttribute",
|
|
136
|
+
"composeCode": "DM.Commerce.Date.Years",
|
|
137
|
+
"dataSource": {
|
|
138
|
+
"address": "LocalHost",
|
|
139
|
+
"id": "localhost_aSampleIAAaECommerce",
|
|
140
|
+
"live": false,
|
|
141
|
+
"title": "Sample ECommerce",
|
|
142
|
+
},
|
|
143
|
+
"description": "",
|
|
144
|
+
"expression": "[Commerce.Date]",
|
|
145
|
+
"format": "yyyy",
|
|
146
|
+
"granularity": "Years",
|
|
147
|
+
"name": "Date",
|
|
148
|
+
"type": "datelevel",
|
|
149
|
+
},
|
|
150
|
+
"composeCode": "filterFactory.members(DM.Commerce.Date.Years, ['2024-01-01T00:00:00'], { disabled: false, locked: false, excludeMembers: false, enableMultiSelection: true, deactivatedMembers: [] })",
|
|
151
|
+
"config": {
|
|
152
|
+
"deactivatedMembers": [],
|
|
153
|
+
"disabled": false,
|
|
154
|
+
"enableMultiSelection": true,
|
|
155
|
+
"excludeMembers": false,
|
|
156
|
+
"locked": false,
|
|
157
|
+
},
|
|
158
|
+
"description": "",
|
|
159
|
+
"filterType": "members",
|
|
160
|
+
"isScope": true,
|
|
161
|
+
"members": [
|
|
162
|
+
"2024-01-01T00:00:00",
|
|
163
|
+
],
|
|
164
|
+
"type": "filter",
|
|
165
|
+
},
|
|
166
|
+
],
|
|
167
|
+
"measures": [
|
|
168
|
+
{
|
|
169
|
+
"__serializable": "DimensionalBaseMeasure",
|
|
170
|
+
"aggregation": "sum",
|
|
171
|
+
"attribute": {
|
|
172
|
+
"__serializable": "DimensionalAttribute",
|
|
173
|
+
"composeCode": "DM.Commerce.Revenue",
|
|
174
|
+
"dataSource": {
|
|
175
|
+
"address": "LocalHost",
|
|
176
|
+
"id": "localhost_aSampleIAAaECommerce",
|
|
177
|
+
"live": false,
|
|
178
|
+
"title": "Sample ECommerce",
|
|
179
|
+
},
|
|
180
|
+
"description": "",
|
|
181
|
+
"expression": "[Commerce.Revenue]",
|
|
182
|
+
"name": "Revenue",
|
|
183
|
+
"type": "numeric-attribute",
|
|
184
|
+
},
|
|
185
|
+
"composeCode": "measureFactory.sum(DM.Commerce.Revenue, 'Total Revenue')",
|
|
186
|
+
"dataSource": undefined,
|
|
187
|
+
"description": "",
|
|
188
|
+
"name": "Total Revenue",
|
|
189
|
+
"sort": 0,
|
|
190
|
+
"type": "basemeasure",
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
"__serializable": "DimensionalBaseMeasure",
|
|
194
|
+
"aggregation": "sum",
|
|
195
|
+
"attribute": {
|
|
196
|
+
"__serializable": "DimensionalAttribute",
|
|
197
|
+
"composeCode": "DM.Commerce.Cost",
|
|
198
|
+
"dataSource": {
|
|
199
|
+
"address": "LocalHost",
|
|
200
|
+
"id": "localhost_aSampleIAAaECommerce",
|
|
201
|
+
"live": false,
|
|
202
|
+
"title": "Sample ECommerce",
|
|
203
|
+
},
|
|
204
|
+
"description": "",
|
|
205
|
+
"expression": "[Commerce.Cost]",
|
|
206
|
+
"name": "Cost",
|
|
207
|
+
"type": "numeric-attribute",
|
|
208
|
+
},
|
|
209
|
+
"composeCode": "measureFactory.sum(DM.Commerce.Cost, 'Total Cost')",
|
|
210
|
+
"dataSource": undefined,
|
|
211
|
+
"description": "",
|
|
212
|
+
"name": "Total Cost",
|
|
213
|
+
"sort": 0,
|
|
214
|
+
"type": "basemeasure",
|
|
215
|
+
},
|
|
216
|
+
],
|
|
217
|
+
}
|
|
218
|
+
* @param queryJSON - A JSON string representing the query generated by the new NLQ API
|
|
219
|
+
* @param dataSource - The data source to use for the query
|
|
220
|
+
* @param tables - The tables to use for the query
|
|
221
|
+
* @returns BaseQueryParams object
|
|
222
|
+
* @internal
|
|
223
|
+
*/
|
|
224
|
+
export declare const translateQueryJSON: (queryJSON: NlqResponseJSON, dataSource: JaqlDataSourceForDto, tables: NormalizedTable[]) => BaseQueryParams;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { WidgetProps, ChartWidgetProps, PivotTableWidgetProps } from '../props';
|
|
2
2
|
import { ChartDataOptions, ChartStyleOptions } from '../types';
|
|
3
3
|
import { ExecuteQueryParams, ExecutePivotQueryParams } from '../query-execution';
|
|
4
|
-
import { MetadataItem } from '@sisense/sdk-data';
|
|
4
|
+
import { JSONArray, MetadataItem } from '@sisense/sdk-data';
|
|
5
5
|
import { DynamicChartType } from '../chart-options-processor/translations/types.js';
|
|
6
6
|
import { AnyColumn } from '../chart-data-options/types.js';
|
|
7
7
|
import { DashboardProps } from '../dashboard/types.js';
|
|
@@ -289,4 +289,43 @@ export declare const isByIdDashboardCodeParams: (params: DashboardCodeParams) =>
|
|
|
289
289
|
* @internal
|
|
290
290
|
*/
|
|
291
291
|
export type DashboardCodeProps = Stringify<DashboardProps> & ExtraWidgetCodeProps;
|
|
292
|
+
/**
|
|
293
|
+
* @internal
|
|
294
|
+
*/
|
|
295
|
+
export type NormalizedField = {
|
|
296
|
+
name: string;
|
|
297
|
+
dataType: string;
|
|
298
|
+
expression: string;
|
|
299
|
+
description?: string;
|
|
300
|
+
};
|
|
301
|
+
/**
|
|
302
|
+
* @internal
|
|
303
|
+
*/
|
|
304
|
+
export type NormalizedTable = {
|
|
305
|
+
name: string;
|
|
306
|
+
columns: NormalizedField[];
|
|
307
|
+
};
|
|
308
|
+
/**
|
|
309
|
+
* Response JSON generated by the new NLQ API.
|
|
310
|
+
*
|
|
311
|
+
* @internal
|
|
312
|
+
*/
|
|
313
|
+
export type NlqResponseJSON = {
|
|
314
|
+
dimensions: JSONArray;
|
|
315
|
+
measures: JSONArray;
|
|
316
|
+
filters: JSONArray;
|
|
317
|
+
highlights?: JSONArray;
|
|
318
|
+
};
|
|
319
|
+
/**
|
|
320
|
+
* Represents the result of a translation operation that can either succeed with data or fail with errors.
|
|
321
|
+
*
|
|
322
|
+
* @internal
|
|
323
|
+
*/
|
|
324
|
+
export type NlqTranslationResult<T> = {
|
|
325
|
+
success: true;
|
|
326
|
+
data: T;
|
|
327
|
+
} | {
|
|
328
|
+
success: false;
|
|
329
|
+
errors: string[];
|
|
330
|
+
};
|
|
292
331
|
export {};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
import { CalendarHeatmapChartProps } from './props';
|
|
3
|
+
/**
|
|
4
|
+
* A React component representing a calendar heatmap chart.
|
|
5
|
+
*
|
|
6
|
+
* @param props - Calendar Heatmap chart properties
|
|
7
|
+
* @returns Calendar Heatmap Chart component
|
|
8
|
+
* @group Charts
|
|
9
|
+
*
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
export declare const CalendarHeatmapChart: import("react").FunctionComponent<CalendarHeatmapChartProps>;
|
|
@@ -13,4 +13,6 @@ export type LoadDataFunction = (options: {
|
|
|
13
13
|
/**
|
|
14
14
|
* Get the load data function based on the chart type
|
|
15
15
|
*/
|
|
16
|
-
export declare function getLoadDataFunction(chartType: ChartType
|
|
16
|
+
export declare function getLoadDataFunction(chartType: ChartType,
|
|
17
|
+
/** Indicates if the chart is a forecast or trend chart for temporal routing between legacy and restructured charts processing */
|
|
18
|
+
isForecastOrTrendChart: boolean): LoadDataFunction;
|
|
@@ -8,10 +8,12 @@ type UseChartDataPreparationProps = {
|
|
|
8
8
|
data: Data;
|
|
9
9
|
chartDataOptions: ChartDataOptionsInternal;
|
|
10
10
|
chartType: ChartType;
|
|
11
|
+
/** Indicates if the chart is a forecast or trend chart for temporal routing between legacy and restructured charts processing */
|
|
12
|
+
isForecastOrTrendChart: boolean;
|
|
11
13
|
attributes: Attribute[];
|
|
12
14
|
measures: Measure[];
|
|
13
15
|
dataColumnNamesMapping: DataColumnNamesMapping;
|
|
14
16
|
onDataReady?: (data: Data) => Data;
|
|
15
17
|
};
|
|
16
|
-
export declare function useChartDataPreparation({ dataSet, data, chartDataOptions, chartType, attributes, measures, dataColumnNamesMapping, onDataReady, }: UseChartDataPreparationProps): ChartData | null;
|
|
18
|
+
export declare function useChartDataPreparation({ dataSet, data, chartDataOptions, chartType, isForecastOrTrendChart, attributes, measures, dataColumnNamesMapping, onDataReady, }: UseChartDataPreparationProps): ChartData | null;
|
|
17
19
|
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ChartDataOptions, ChartType } from '../../types';
|
|
2
|
-
export declare const useTranslatedDataOptions: (chartDataOptions: ChartDataOptions, chartType: ChartType) => {
|
|
2
|
+
export declare const useTranslatedDataOptions: (chartDataOptions: ChartDataOptions, chartType: ChartType, isForecastOrTrendChart: boolean) => {
|
|
3
3
|
dataOptions: import("../..").ChartDataOptionsInternal;
|
|
4
4
|
attributes: import("@sisense/sdk-data").Attribute[];
|
|
5
5
|
measures: import("@sisense/sdk-data").Measure[];
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { ChartBuilder } from '../../../../chart/restructured-charts/types.js';
|
|
2
|
+
/**
|
|
3
|
+
* Calendar heatmap chart builder configuration
|
|
4
|
+
*
|
|
5
|
+
* Provides a complete configuration for building calendar heatmap charts,
|
|
6
|
+
* including data processing, styling, and rendering capabilities.
|
|
7
|
+
*/
|
|
8
|
+
export declare const calendarHeatmapChartBuilder: ChartBuilder<'calendar-heatmap'>;
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { ViewType } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Default calendar heatmap chart configuration constants
|
|
4
|
+
*/
|
|
5
|
+
export declare const CALENDAR_HEATMAP_DEFAULTS: {
|
|
6
|
+
/** Default cell size in pixels */
|
|
7
|
+
readonly CELL_SIZE: 50;
|
|
8
|
+
/** Default view type */
|
|
9
|
+
readonly VIEW_TYPE: ViewType.MONTH;
|
|
10
|
+
/** Default color for days without data */
|
|
11
|
+
readonly NO_DATA_COLOR: "rgb(245, 245, 245)";
|
|
12
|
+
/** Transparent color for empty calendar cells */
|
|
13
|
+
readonly EMPTY_CELL_COLOR: "transparent";
|
|
14
|
+
/** Default chart background color */
|
|
15
|
+
readonly BACKGROUND_COLOR: "white";
|
|
16
|
+
/** Default border width for cells */
|
|
17
|
+
readonly BORDER_WIDTH: 0;
|
|
18
|
+
/** Minimum cell size for showing data labels */
|
|
19
|
+
readonly MIN_CELL_SIZE_FOR_LABELS: 10;
|
|
20
|
+
/** Total cells in a full calendar grid (6 rows × 7 days) */
|
|
21
|
+
readonly TOTAL_CALENDAR_CELLS: 42;
|
|
22
|
+
/** Days in a week */
|
|
23
|
+
readonly DAYS_IN_WEEK: 7;
|
|
24
|
+
/** Maximum calendar rows */
|
|
25
|
+
readonly MAX_CALENDAR_ROWS: 6;
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* Calendar heatmap color scheme configuration
|
|
29
|
+
*/
|
|
30
|
+
export declare const CALENDAR_HEATMAP_COLORS: {
|
|
31
|
+
/** Color stops for the heatmap gradient */
|
|
32
|
+
readonly GRADIENT_STOPS: readonly [[number, string], [number, string], [number, string]];
|
|
33
|
+
/** Default text color */
|
|
34
|
+
readonly TEXT_COLOR: "#333";
|
|
35
|
+
/** Border color for tooltips */
|
|
36
|
+
readonly TOOLTIP_BORDER_COLOR: "#c0c0c0";
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Calendar layout configuration
|
|
40
|
+
*/
|
|
41
|
+
export declare const CALENDAR_LAYOUT: {
|
|
42
|
+
/** Weekday abbreviations for calendar header */
|
|
43
|
+
readonly WEEKDAY_LABELS: readonly ["S", "M", "T", "W", "T", "F", "S"];
|
|
44
|
+
/** Margin calculations based on cell size */
|
|
45
|
+
readonly MARGIN_RATIOS: {
|
|
46
|
+
readonly TOP: 0.8;
|
|
47
|
+
readonly BOTTOM: 0.4;
|
|
48
|
+
readonly LEFT: 0.3;
|
|
49
|
+
readonly RIGHT: 0.3;
|
|
50
|
+
};
|
|
51
|
+
/** Minimum margin values */
|
|
52
|
+
readonly MIN_MARGINS: {
|
|
53
|
+
readonly TOP: 60;
|
|
54
|
+
readonly BOTTOM: 30;
|
|
55
|
+
readonly LEFT: 20;
|
|
56
|
+
readonly RIGHT: 20;
|
|
57
|
+
};
|
|
58
|
+
};
|
|
59
|
+
/**
|
|
60
|
+
* Font size and spacing calculations
|
|
61
|
+
*/
|
|
62
|
+
export declare const CALENDAR_TYPOGRAPHY: {
|
|
63
|
+
/** Font size ratio relative to cell size */
|
|
64
|
+
readonly FONT_SIZE_RATIO: 0.2;
|
|
65
|
+
/** Minimum font size */
|
|
66
|
+
readonly MIN_FONT_SIZE: 10;
|
|
67
|
+
/** Maximum font size */
|
|
68
|
+
readonly MAX_FONT_SIZE: 24;
|
|
69
|
+
/** Label position adjustment ratio */
|
|
70
|
+
readonly LABEL_Y_OFFSET_RATIO: 0.08;
|
|
71
|
+
/** Axis label position ratio */
|
|
72
|
+
readonly AXIS_LABEL_Y_RATIO: 0.3;
|
|
73
|
+
/** Axis offset ratio */
|
|
74
|
+
readonly AXIS_OFFSET_RATIO: 0.4;
|
|
75
|
+
/** Axis label font size ratio */
|
|
76
|
+
readonly AXIS_FONT_SIZE_RATIO: 0.24;
|
|
77
|
+
/** Minimum axis font size */
|
|
78
|
+
readonly MIN_AXIS_FONT_SIZE: 12;
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
* Calendar heatmap data type
|
|
82
|
+
*/
|
|
83
|
+
export declare const CALENDAR_HEATMAP_DATA_TYPE: "calendar-heatmap";
|
|
84
|
+
/**
|
|
85
|
+
* Full month date format
|
|
86
|
+
*/
|
|
87
|
+
export declare const FULL_MONTH_DATE_FORMAT = "MMMM";
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { Attribute, Measure } from '@sisense/sdk-data';
|
|
2
|
+
import { CalendarHeatmapChartDataOptions, CalendarHeatmapChartDataOptionsInternal } from '../../../../../chart-data-options/types';
|
|
3
|
+
import { ChartDataOptions } from '../../../../../types';
|
|
4
|
+
import { ChartDataOptionsInternal } from '../../../../../chart-data-options/types';
|
|
5
|
+
/**
|
|
6
|
+
* Translates calendar heatmap chart data options from user format to internal format
|
|
7
|
+
*
|
|
8
|
+
* Converts user-provided data options to the internal format used by the chart engine,
|
|
9
|
+
* applying default date formatting and normalizing columns.
|
|
10
|
+
*
|
|
11
|
+
* @param dataOptions - User-provided calendar heatmap chart data options
|
|
12
|
+
* @returns Normalized internal data options
|
|
13
|
+
*/
|
|
14
|
+
export declare function translateCalendarHeatmapChartDataOptions(dataOptions: CalendarHeatmapChartDataOptions): CalendarHeatmapChartDataOptionsInternal;
|
|
15
|
+
/**
|
|
16
|
+
* Extracts attributes from calendar heatmap chart data options
|
|
17
|
+
*
|
|
18
|
+
* Returns an array of attributes that can be used for data queries.
|
|
19
|
+
* For calendar heatmaps, this typically includes the date attribute.
|
|
20
|
+
*
|
|
21
|
+
* @param dataOptions - Internal calendar heatmap chart data options
|
|
22
|
+
* @returns Array of attributes extracted from the data options
|
|
23
|
+
*/
|
|
24
|
+
export declare function getCalendarHeatmapAttributes(dataOptions: CalendarHeatmapChartDataOptionsInternal): Attribute[];
|
|
25
|
+
/**
|
|
26
|
+
* Extracts measures from calendar heatmap chart data options
|
|
27
|
+
*
|
|
28
|
+
* Returns an array of measures that can be used for data queries.
|
|
29
|
+
* For calendar heatmaps, this typically includes the value measure.
|
|
30
|
+
*
|
|
31
|
+
* @param dataOptions - Internal calendar heatmap chart data options
|
|
32
|
+
* @returns Array of measures extracted from the data options
|
|
33
|
+
*/
|
|
34
|
+
export declare function getCalendarHeatmapMeasures(dataOptions: CalendarHeatmapChartDataOptionsInternal): Measure[];
|
|
35
|
+
/**
|
|
36
|
+
* Type guard to check if data options are valid for calendar heatmap charts
|
|
37
|
+
*
|
|
38
|
+
* Validates that the provided data options contain the required properties
|
|
39
|
+
* for calendar heatmap charts (date and value).
|
|
40
|
+
*
|
|
41
|
+
* @param dataOptions - Data options to validate
|
|
42
|
+
* @returns True if the data options are valid for calendar heatmap charts
|
|
43
|
+
*/
|
|
44
|
+
export declare function isCalendarHeatmapChartDataOptions(dataOptions: ChartDataOptions): dataOptions is CalendarHeatmapChartDataOptions;
|
|
45
|
+
/**
|
|
46
|
+
* Type guard to check if internal data options are valid for calendar heatmap charts
|
|
47
|
+
*
|
|
48
|
+
* Validates that the provided internal data options contain the required properties
|
|
49
|
+
* and are properly structured for calendar heatmap charts.
|
|
50
|
+
*
|
|
51
|
+
* @param dataOptions - Internal data options to validate
|
|
52
|
+
* @returns True if the internal data options are valid for calendar heatmap charts
|
|
53
|
+
*/
|
|
54
|
+
export declare function isCalendarHeatmapChartDataOptionsInternal(dataOptions: ChartDataOptionsInternal): dataOptions is CalendarHeatmapChartDataOptionsInternal;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './data-options.js';
|