@sisense/sdk-ui 1.31.0 → 1.32.0

package/dist/packages/sdk-ui/src/ai/api/chat-rest-api.d.ts

@@ -1,7 +1,7 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import type { Chat, ChatRequest, ChatResponse, ChatWithoutHistory, ChatContext, GetNlgInsightsRequest, GetNlgInsightsResponse, LlmConfig, QueryRecommendationConfig, QueryRecommendationResponse, SendFeedbackRequest, GetNlqResultRequest, NlqResult } from './types';
-import { DataSourceField } from '@sisense/sdk-data';
 import { ChatContextDetails } from '../../ai/api/types';
+/** @internal */
 export declare class ChatRestApi {
     private readonly volatile;
     private httpClient;
@@ -17,14 +17,12 @@ export declare class ChatRestApi {
     private postChat;
     private deleteChatHistory;
     private sendFeedback;
-    private getDataSourceFields;
     ai: {
         getNlgInsights: (request: GetNlgInsightsRequest) => Promise<GetNlgInsightsResponse | undefined>;
         getNlqResult: (contextTitle: string, request: GetNlqResultRequest) => Promise<NlqResult | undefined>;
         getQueryRecommendations: (contextTitle: string, config: QueryRecommendationConfig) => Promise<QueryRecommendationResponse | undefined>;
         setLlmConfig: (config: LlmConfig) => Promise<unknown>;
         sendFeedback: (request: SendFeedbackRequest) => Promise<unknown>;
-        getDataSourceFields: (dataSource: string) => Promise<DataSourceField[] | undefined>;
         chat: {
             getAll: () => Promise<never[] | ChatWithoutHistory[] | undefined>;
             getById: (chatId: string) => Promise<Chat | undefined>;

package/dist/packages/sdk-ui/src/ai/api/types.d.ts

@@ -89,6 +89,7 @@ export interface GetNlgInsightsRequest {
     jaql: Pick<JaqlQueryPayload, 'datasource' | 'metadata' | 'filterRelations'>;
     verbosity?: 'Low' | 'High';
 }
+/** @internal */
 export interface GetNlgInsightsResponse {
     data?: {
         answer: string;

package/dist/packages/sdk-ui/src/ai/chatbot.d.ts

@@ -3,7 +3,7 @@ import { ChatConfig } from './chat-config';
 /**
  * Props for {@link Chatbot} component.
  */
-export type ChatbotProps = {
+export interface ChatbotProps {
     /**
      * Total width of the chatbot
      *
@@ -20,7 +20,7 @@ export type ChatbotProps = {
      * Various configuration options for the chatbot
      */
     config?: Partial<ChatConfig>;
-};
+}
 /**
  * React component that renders a chatbot with data topic selection. You can optionally provide `width` and/or `height`.
  *

package/dist/packages/sdk-ui/src/ai/custom-ai-context-provider.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+import { type ChatRestApi } from './api/chat-rest-api';
+/** @internal */
+export type CustomAiContext = {
+    api: ChatRestApi;
+};
+/** @internal */
+export type CustomAiContextProviderProps = {
+    context?: CustomAiContext;
+    children: ReactNode;
+};
+/** @internal */
+export declare function CustomAiContextProvider({ children, context }: CustomAiContextProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/ai/index.d.ts

@@ -1,12 +1,15 @@
 export { default as AiContextProvider, type AiContextProviderProps } from './ai-context-provider';
 export { type ChatConfig } from './chat-config';
 export { useGetNlgInsights, type UseGetNlgInsightsParams, type UseGetNlgInsightsState, useGetNlgQueryResult, } from './use-get-nlg-insights';
-export { useGetNlqResult, type UseGetNlqResultParams, type UseGetNlqResultState, } from './use-get-nlq-result';
-export { useGetQueryRecommendations, type UseGetQueryRecommendationsParams, type UseGetQueryRecommendationsState, } from './use-get-query-recommendations';
+export { useGetNlqResult, prepareGetNlqResultPayload, type UseGetNlqResultParams, type UseGetNlqResultState, type GetNlqResultParams, } from './use-get-nlq-result';
+export { useGetQueryRecommendations, type UseGetQueryRecommendationsParams, type GetQueryRecommendationsParams, type UseGetQueryRecommendationsState, DEFAULT_RECOMMENDATIONS_COUNT, } from './use-get-query-recommendations';
 export { useChatSession, type UseChatSessionResult } from './use-chat-session';
 export { useLastNlqResponse } from './use-last-nlq-response';
-export { useGetDataSourceFields } from './use-get-data-source-fields';
-export type { GetNlgInsightsRequest, QueryRecommendationResponse, QueryRecommendation, NlqResponseData, NlqResult, NLQ_RESULT_CHART_TYPES, NlqResultChartType, } from './api/types';
+export type { GetNlgInsightsRequest, GetNlgInsightsResponse, QueryRecommendationResponse, QueryRecommendation, NlqResponseData, NlqResult, NLQ_RESULT_CHART_TYPES, NlqResultChartType, } from './api/types';
 export { Chatbot, type ChatbotProps } from './chatbot';
 export { default as GetNlgInsights, type GetNlgInsightsProps, GetNlgQueryResult, type GetNlgQueryResultProps, } from './get-nlg-insights';
 export { NlqChartWidget, type NlqChartWidgetProps } from './chart/nlq-chart-widget';
+export { ChatRestApi } from './api/chat-rest-api';
+export { CustomAiContextProvider, type CustomAiContext } from './custom-ai-context-provider';
+export { prepareGetNlgInsightsPayload } from './use-get-nlg-insights';
+export { widgetComposer } from '../analytics-composer';

package/dist/packages/sdk-ui/src/ai/use-get-nlg-insights.d.ts

@@ -39,6 +39,8 @@ export interface UseGetNlgInsightsState {
     /** Callback to trigger a refetch of the data */
     refetch: () => void;
 }
+/** @internal */
+export declare function prepareGetNlgInsightsPayload(params: UseGetNlgInsightsParams | GetNlgInsightsRequest): GetNlgInsightsRequest;
 /**
  *
  * @param params - {@link UseGetNlgInsightsParams}

package/dist/packages/sdk-ui/src/ai/use-get-nlq-result.d.ts

@@ -1,11 +1,8 @@
 import { WidgetProps } from '../props';
 import { DataSource } from '@sisense/sdk-data';
 import { HookEnableParam } from '../common/hooks/types';
-import { NlqResultChartType } from './api/types';
-/**
- * Parameters for {@link useGetNlqResult} hook.
- */
-export interface UseGetNlqResultParams extends HookEnableParam {
+import { GetNlqResultRequest, NlqResultChartType } from './api/types';
+export interface GetNlqResultParams {
     /** Data source for queries to run against */
     dataSource: DataSource;
     /** Text containing the natural language query */
@@ -20,6 +17,16 @@ export interface UseGetNlqResultParams extends HookEnableParam {
      */
     enableAxisTitlesInWidgetProps?: boolean;
 }
+/** @internal */
+export declare function prepareGetNlqResultPayload(params: GetNlqResultParams): {
+    contextTitle: string;
+    request: GetNlqResultRequest;
+};
+/**
+ * Parameters for {@link useGetNlqResult} hook.
+ */
+export interface UseGetNlqResultParams extends GetNlqResultParams, HookEnableParam {
+}
 /**
  * State for {@link useGetNlqResult} hook.
  */

package/dist/packages/sdk-ui/src/ai/use-get-query-recommendations.d.ts

@@ -1,9 +1,8 @@
 import { QueryRecommendation } from './api/types';
 import { HookEnableParam } from '../common/hooks/types';
-/**
- * Parameters for {@link useGetQueryRecommendations} hook.
- */
-export interface UseGetQueryRecommendationsParams extends HookEnableParam {
+/** @internal */
+export declare const DEFAULT_RECOMMENDATIONS_COUNT = 4;
+export interface GetQueryRecommendationsParams {
     /** Data model title or perspective title */
     contextTitle: string;
     /**
@@ -20,6 +19,11 @@ export interface UseGetQueryRecommendationsParams extends HookEnableParam {
      */
     enableAxisTitlesInWidgetProps?: boolean;
 }
+/**
+ * Parameters for {@link useGetQueryRecommendations} hook.
+ */
+export interface UseGetQueryRecommendationsParams extends GetQueryRecommendationsParams, HookEnableParam {
+}
 /**
  * State for {@link useGetQueryRecommendations} hook.
  */

package/dist/packages/sdk-ui/src/analytics-composer/common/constants.d.ts

@@ -0,0 +1 @@
+export declare const CODE_TEMPLATES_INDENT = 6;

package/dist/packages/sdk-ui/src/api/rest-api.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { FeatureCollection as GeoJsonFeatureCollection } from 'geojson';
-import { type DataSource } from '@sisense/sdk-data';
+import { DataSourceField, type DataSource } from '@sisense/sdk-data';
 import { HierarchyDto, SharedFormulaDto, WidgetDto } from '../widget-by-id/types';
 import type { DashboardDto } from './types/dashboard-dto';
 import { TranslatableError } from '../translation/translatable-error';
@@ -82,6 +82,16 @@ export declare class RestApi {
      * @returns A shared formula
      */
     getSharedFormula: (sharedFormulaId: string) => Promise<SharedFormulaDto | undefined>;
+    /**
+     * Get datasource fields
+     * @param dataSource - A datasource name
+     * @param options - An object with offset and count
+     * @returns A list of datasource fields
+     */
+    getDataSourceFields: (dataSource: string, options?: {
+        offset: number;
+        count: number;
+    }) => Promise<DataSourceField[] | undefined>;
 }
 export declare const useRestApi: () => {
     restApi: RestApi | undefined;

package/dist/packages/sdk-ui/src/app/client-application.d.ts

@@ -115,6 +115,21 @@ export type AppConfig = {
          */
         enabled?: boolean;
     };
+    /**
+     * Configuration of the tabber widget
+     *
+     * Set the `tabberConfig.enabled` property to `true` to enable the tabber widget support. Otherwise, the tabber widget will be treated as 'unkwon plugin type'.
+     *
+     * @internal
+     */
+    tabberConfig?: {
+        /**
+         * Whether to enable tabber widget support
+         *
+         * If not specified, the default value is `false`
+         */
+        enabled?: boolean;
+    };
     /**
      * Configuration of the component that is rendered in case of an error
      */

package/dist/packages/sdk-ui/src/chart/helpers/get-load-data-function.d.ts

@@ -0,0 +1,16 @@
+import { ClientApplication } from '../../app/client-application';
+import { QueryDescription } from '../../query/execute-query';
+import { ChartType } from '../../types';
+import { QueryResultData } from '@sisense/sdk-data';
+import { QueryExecutionConfig } from '@sisense/sdk-query-client';
+import { ChartDataOptionsInternal } from '../../chart-data-options/types';
+export type LoadDataFunction = (options: {
+    app: ClientApplication;
+    chartDataOptionsInternal?: ChartDataOptionsInternal;
+    queryDescription: QueryDescription;
+    executionConfig?: QueryExecutionConfig;
+}) => Promise<QueryResultData>;
+/**
+ * Get the load data function based on the chart type
+ */
+export declare function getLoadDataFunction(chartType: ChartType): LoadDataFunction;

package/dist/packages/sdk-ui/src/chart/helpers/use-chart-data-preparation.d.ts

@@ -0,0 +1,17 @@
+import { Attribute, Data, DataSource, Measure } from '@sisense/sdk-data';
+import { ChartDataOptionsInternal } from '../../chart-data-options/types';
+import { DataColumnNamesMapping } from '../../chart-data-options/validate-data-options';
+import { ChartData } from '../../chart-data/types';
+import { ChartType } from '../../types';
+type UseChartDataPreparationProps = {
+    dataSet: DataSource | Data | undefined;
+    data: Data;
+    chartDataOptions: ChartDataOptionsInternal;
+    chartType: ChartType;
+    attributes: Attribute[];
+    measures: Measure[];
+    dataColumnNamesMapping: DataColumnNamesMapping;
+    onDataReady?: (data: Data) => Data;
+};
+export declare function useChartDataPreparation({ dataSet, data, chartDataOptions, chartType, attributes, measures, dataColumnNamesMapping, onDataReady, }: UseChartDataPreparationProps): ChartData | null;
+export {};

package/dist/packages/sdk-ui/src/chart/helpers/use-synced-data.d.ts

@@ -3,6 +3,7 @@ import { Dispatch, SetStateAction } from 'react';
 import { ChartDataOptionsInternal } from '../../chart-data-options/types';
 import { ChartType } from '../../types';
 import { DataColumnNamesMapping } from '../../chart-data-options/validate-data-options';
+import { LoadDataFunction } from './get-load-data-function';
 type DataSet = DataSource | Data | undefined;
 type UseSyncedDataProps = {
     dataSet: DataSet;
@@ -16,6 +17,7 @@ type UseSyncedDataProps = {
     refreshCounter?: number;
     setIsLoading?: Dispatch<SetStateAction<boolean>>;
     enabled?: boolean;
+    loadData: LoadDataFunction;
 };
-export declare const useSyncedData: ({ dataSet, chartDataOptions, chartType, attributes, measures, dataColumnNamesMapping, filters, highlights, refreshCounter, setIsLoading, enabled, }: UseSyncedDataProps) => [Data, ChartDataOptionsInternal];
+export declare const useSyncedData: ({ dataSet, chartDataOptions, chartType, attributes, measures, dataColumnNamesMapping, filters, highlights, refreshCounter, setIsLoading, enabled, loadData, }: UseSyncedDataProps) => [Data, ChartDataOptionsInternal];
 export {};

package/dist/packages/sdk-ui/src/chart/index.d.ts

@@ -1 +1,2 @@
 export * from './chart';
+export * from './types';

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/areamap-chart-builder.d.ts

@@ -0,0 +1,2 @@
+import { ChartBuilder } from '../types.js';
+export declare const areamapChartBuilder: ChartBuilder<'areamap'>;

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/data/areamap-data.d.ts

@@ -0,0 +1,4 @@
+import { AreamapChartDataOptionsInternal } from '../../../../chart-data-options/types.js';
+import { DataTable } from '../../../../chart-data-processor/table-processor';
+import { AreamapData } from '../types';
+export declare const getAreamapData: (dataOptions: AreamapChartDataOptionsInternal, dataTable: DataTable) => AreamapData;

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/data/geo-data-coloring-function.d.ts

@@ -0,0 +1,2 @@
+import { GeoDataElement, RawGeoDataElement } from '../types';
+export declare const geoDataColoringFunction: import('../../../../chart-data/data-coloring/create-data-coloring-function').ColoringFunction<RawGeoDataElement, GeoDataElement>;

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/data/index.d.ts

@@ -0,0 +1,2 @@
+import { ChartBuilder } from '../../types.js';
+export declare const areamapDataTranslators: ChartBuilder<'areamap'>['data'];

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/data-options/data-options.d.ts

@@ -0,0 +1,2 @@
+import { ChartBuilder } from '../../types.js';
+export declare const dataOptionsTranslators: ChartBuilder<'areamap'>['dataOptions'];

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/data-options/index.d.ts

@@ -0,0 +1 @@
+export * from './data-options';

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/design-options/design-options.d.ts

@@ -0,0 +1,2 @@
+import { ChartBuilder } from '../../types';
+export declare const areamapDesignOptionsTranslators: ChartBuilder<'areamap'>['designOptions'];

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/design-options/index.d.ts

@@ -0,0 +1 @@
+export * from './design-options';

package/dist/packages/sdk-ui/src/{charts/map-charts/areamap → chart/restructured-charts/areamap-chart/renderer}/areamap-map.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { FeatureCollection as GeoJsonFeatureCollection } from 'geojson';
-import { GeoDataElement } from '../../../chart-data/types.js';
-import { AreamapType } from '../../../types.js';
+import { AreamapType } from '../../../../types.js';
+import { GeoDataElement } from '../types.js';
 export type AreamapProps = {
     geoJson: GeoJsonFeatureCollection;
     geoData: GeoDataElement[];

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/renderer/areamap-utils.d.ts

@@ -0,0 +1,12 @@
+import { AreamapChartDataOptionsInternal } from '../../../../chart-data-options/types';
+import { GeoDataElement } from '../types';
+export declare function getAreamapDataPoint(geoDataElement: GeoDataElement, dataOptions: AreamapChartDataOptionsInternal): {
+    entries: {
+        geo: import('../../../../types').DataPointEntry[];
+        color: import('../../../../types').DataPointEntry[];
+    };
+    geoName: string;
+    originalValue: number;
+    formattedOriginalValue: string;
+    color?: import('../../../../types').Color | undefined;
+};

package/dist/packages/sdk-ui/src/{charts/map-charts/areamap → chart/restructured-charts/areamap-chart/renderer}/areamap.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="react" />
-import { AreamapChartDataOptionsInternal } from '../../../chart-data-options/types.js';
-import { AreamapData, ChartData } from '../../../chart-data/types.js';
-import { AreamapChartDesignOptions } from '../../../chart-options-processor/translations/design-options.js';
-import { AreamapDataPointEventHandler } from '../../../props';
-import { ChartRendererProps } from '../../../chart/types.js';
+import { AreamapChartDataOptionsInternal } from '../../../../chart-data-options/types.js';
+import { ChartData } from '../../../../chart-data/types.js';
+import { AreamapDataPointEventHandler } from '../../../../props.js';
+import { ChartRendererProps } from '../../../../chart/types.js';
+import { AreamapChartDesignOptions, AreamapData } from '../types.js';
 export type AreamapProps = {
     chartData: AreamapData;
     dataOptions: AreamapChartDataOptionsInternal;

package/dist/packages/sdk-ui/src/{charts/map-charts/areamap → chart/restructured-charts/areamap-chart/renderer}/feature-styles-dictionary.d.ts

@@ -1,7 +1,7 @@
 import { Feature as GeoJsonFeature } from 'geojson';
 import { PathOptions } from 'leaflet';
-import { GeoDataElement } from '../../../chart-data/types.js';
-import { AreamapType } from '../../../types.js';
+import { AreamapType } from '../../../../types.js';
+import { GeoDataElement } from '../types.js';
 export type FeatureId = GeoJsonFeature['id'] & string;
 export type FeatureInfo = {
     /** Corresponding GeoDataElement from GeoData */

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/renderer/index.d.ts

@@ -0,0 +1 @@
+export * from './areamap.js';

package/dist/packages/sdk-ui/src/{charts/map-charts/areamap → chart/restructured-charts/areamap-chart/renderer}/use-geo-json.d.ts

@@ -1,5 +1,5 @@
 import { FeatureCollection as GeoJsonFeatureCollection } from 'geojson';
-import { AreamapType } from '../../../types';
+import { AreamapType } from '../../../../types.js';
 /**
  * Hook to get geoJson from API or cache (LocalStorage)
  */

package/dist/packages/sdk-ui/src/chart/restructured-charts/areamap-chart/types.d.ts

@@ -0,0 +1,35 @@
+import { BaseDesignOptionsType } from '../../../chart-options-processor/translations/design-options';
+import { AreamapChartType, AreamapType, Color } from '../../../types';
+/**
+ * Fact final data that will be passed to Areamap-component to render
+ *
+ * @internal
+ */
+export type AreamapData = {
+    type: AreamapChartType;
+    geoData: GeoDataElement[];
+};
+/**
+ * Raw GeoDataElement from data
+ */
+export type RawGeoDataElement = {
+    /** Name of geo-element (country or state) */
+    geoName: string;
+    /** Original numeric measure value for this geo-element */
+    originalValue: number;
+    /** Formatted measure value for this geo-element to display*/
+    formattedOriginalValue: string;
+};
+/**
+ * GeoDataElement with color property, calculated from `originalValue`
+ */
+export type GeoDataElement = RawGeoDataElement & {
+    /** Calculated color for this geo-element */
+    color?: Color;
+};
+/**
+ * Configuration for Areamap design options
+ */
+export type AreamapChartDesignOptions = BaseDesignOptionsType & {
+    mapType: AreamapType;
+};

package/dist/packages/sdk-ui/src/chart/restructured-charts/bar-chart/bar-chart-builder.d.ts

@@ -0,0 +1,2 @@
+import { ChartBuilder } from '../types.js';
+export declare const barChartBuilder: ChartBuilder<'bar'>;

package/dist/packages/sdk-ui/src/chart/restructured-charts/chart-builder-factory.d.ts

@@ -0,0 +1,3 @@
+import type { ChartBuilder, SupportedChartType } from './types.js';
+export declare const chartBuildersMap: Record<SupportedChartType, ChartBuilder<SupportedChartType>>;
+export declare function getChartBuilder<CT extends SupportedChartType>(chartType: CT): ChartBuilder<CT>;

package/dist/packages/sdk-ui/src/chart/restructured-charts/column-chart/column-chart-builder.d.ts

@@ -0,0 +1,2 @@
+import { ChartBuilder } from '../types.js';
+export declare const columnChartBuilder: ChartBuilder<'column'>;

package/dist/packages/sdk-ui/src/chart/restructured-charts/helpers/cartesians/data-options.d.ts

@@ -0,0 +1,27 @@
+import { CartesianChartDataOptionsInternal, ChartDataOptions, ChartDataOptionsInternal } from '../../../../chart-data-options/types';
+import { CartesianChartDataOptions } from '../../../../types';
+import { Attribute, Measure } from '@sisense/sdk-data';
+/**
+ * Translates the data options for cartesian charts to internal format.
+ */
+export declare const translateCartesianChartDataOptions: (dataOptions: CartesianChartDataOptions) => CartesianChartDataOptionsInternal;
+/**
+ * Returns the attributes from the internal data options for cartesian charts.
+ */
+export declare function getCartesianAttributes(internalDataOptions: CartesianChartDataOptionsInternal): Attribute[];
+/**
+ * Returns the measures from the internal data options for cartesian charts.
+ */
+export declare function getCartesianMeasures(internalDataOptions: CartesianChartDataOptionsInternal): Measure[];
+/**
+ * Checks if the data options are correct for cartesian charts.
+ */
+export declare function isCartesianChartDataOptions(dataOptions: ChartDataOptions): dataOptions is CartesianChartDataOptions;
+/**
+ * Checks if the internal data options are correct for cartesian charts.
+ */
+export declare function isCartesianChartDataOptionsInternal(dataOptions: ChartDataOptionsInternal): dataOptions is CartesianChartDataOptionsInternal;
+/**
+ * Checks if the chart should have Y2 axis.
+ */
+export declare function shouldHaveY2Axis(dataOptions: CartesianChartDataOptionsInternal): boolean;

package/dist/packages/sdk-ui/src/chart/restructured-charts/helpers/cartesians/data.d.ts

@@ -0,0 +1,4 @@
+import { CartesianChartDataOptionsInternal } from '../../../../chart-data-options/types';
+import { DataTable } from '../../../../chart-data-processor/table-processor';
+import { CartesianChartData } from '../../../../chart-data/types';
+export declare function getCartesianChartData(chartDataOptions: CartesianChartDataOptionsInternal, dataTable: DataTable): CartesianChartData;

package/dist/packages/sdk-ui/src/chart/restructured-charts/helpers/cartesians/stackable/design-options.d.ts

@@ -0,0 +1,5 @@
+import { CartesianChartDataOptionsInternal } from '../../../../../chart-data-options/types';
+import { StackableChartDesignOptions } from '../../../../../chart-options-processor/translations/design-options';
+import { ChartStyleOptions, StackableStyleOptions } from '../../../../../types';
+export declare function translateStackableStyleOptionsToDesignOptions(chartType: 'bar' | 'column', styleOptions: StackableStyleOptions, dataOptionsInternal: CartesianChartDataOptionsInternal): StackableChartDesignOptions;
+export declare function isStackableStyleOptions(styleOptions: ChartStyleOptions): styleOptions is StackableStyleOptions;

package/dist/packages/sdk-ui/src/chart/restructured-charts/helpers/data-loading.d.ts

@@ -0,0 +1,12 @@
+import { ClientApplication } from '../../../app/client-application';
+import { QueryDescription } from '../../../query/execute-query';
+import { QueryResultData } from '@sisense/sdk-data';
+import { QueryExecutionConfig } from '@sisense/sdk-query-client';
+/**
+ * Load data by a regular single query execution.
+ */
+export declare function loadDataBySingleQuery(options: {
+    app: ClientApplication;
+    queryDescription: QueryDescription;
+    executionConfig?: QueryExecutionConfig | undefined;
+}): Promise<QueryResultData>;

package/dist/packages/sdk-ui/src/chart/restructured-charts/types.d.ts

@@ -0,0 +1,100 @@
+/// <reference types="react" />
+import { Attribute, Measure, QueryResultData } from '@sisense/sdk-data';
+import { QueryDescription, QueryExecutionConfig } from '@sisense/sdk-query-client';
+import type { AreamapStyleOptions, ChartDataOptions, ChartStyleOptions, ScattermapStyleOptions, StackableStyleOptions } from '../../types';
+import type { SisenseChartProps } from '../../sisense-chart';
+import type { ChartRendererProps } from '../../chart';
+import type { CartesianChartData, ScattermapChartData } from '../../chart-data/types';
+import { AreamapChartDataOptions, AreamapChartDataOptionsInternal, CartesianChartDataOptions, CartesianChartDataOptionsInternal, ChartDataOptionsInternal, ScattermapChartDataOptions, ScattermapChartDataOptionsInternal } from '../../chart-data-options/types';
+import { DesignOptions } from '../../chart-options-processor/translations/types';
+import { DataTable } from '../../chart-data-processor/table-processor';
+import { ClientApplication } from '../../app/client-application';
+import { AreamapProps } from '../../chart/restructured-charts/areamap-chart/renderer';
+import { ScattermapProps } from '../../charts/map-charts/scattermap/scattermap';
+import { AreamapData } from './areamap-chart/types';
+export type SupportedChartType = 'areamap' | 'column' | 'bar';
+export type TypedChartDataOptions<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapChartDataOptions : CT extends 'scattermap' ? ScattermapChartDataOptions : CT extends 'column' | 'bar' ? CartesianChartDataOptions : never;
+export type TypedDataOptionsInternal<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapChartDataOptionsInternal : CT extends 'scattermap' ? ScattermapChartDataOptionsInternal : CT extends 'column' | 'bar' ? CartesianChartDataOptionsInternal : never;
+export type TypedChartStyleOptions<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapStyleOptions : CT extends 'scattermap' ? ScattermapStyleOptions : CT extends 'column' | 'bar' ? StackableStyleOptions : never;
+export type TypedDesignOptions<CT extends SupportedChartType> = DesignOptions<CT>;
+export type TypedChartData<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapData : CT extends 'scattermap' ? ScattermapChartData : CT extends 'column' | 'bar' ? CartesianChartData : never;
+export type TypedLoadDataFunction<CT extends SupportedChartType> = (options: {
+    app: ClientApplication;
+    chartDataOptionsInternal: TypedDataOptionsInternal<CT>;
+    queryDescription: QueryDescription;
+    executionConfig?: QueryExecutionConfig;
+}) => Promise<QueryResultData>;
+export type TypedChartRendererProps<CT extends SupportedChartType> = CT extends 'areamap' ? AreamapProps : CT extends 'scattermap' ? ScattermapProps : CT extends 'column' | 'bar' ? SisenseChartProps : never;
+/**
+ * Chart builder interface.
+ */
+export interface ChartBuilder<CT extends SupportedChartType = SupportedChartType> {
+    /**
+     * Data options translation utils.
+     */
+    dataOptions: {
+        /**
+         * Translates the data options to the internal format.
+         */
+        translateDataOptionsToInternal: (dataOptions: TypedChartDataOptions<CT>) => TypedDataOptionsInternal<CT>;
+        /**
+         * Returns the attributes from the internal data options.
+         */
+        getAttributes: (internalDataOptions: TypedDataOptionsInternal<CT>) => Attribute[];
+        /**
+         * Returns the measures from the internal data options.
+         */
+        getMeasures: (internalDataOptions: TypedDataOptionsInternal<CT>) => Measure[];
+        /**
+         * Validates and cleans the data options if needed.
+         */
+        validateAndCleanDataOptions?: (dataOptions: TypedChartDataOptions<CT>) => TypedChartDataOptions<CT>;
+        /**
+         * Checks if the data options are correct for the current chart type.
+         */
+        isCorrectDataOptions: (dataOptions: ChartDataOptions) => dataOptions is TypedChartDataOptions<CT>;
+        /**
+         * Checks if the data options are correct for the internal format.
+         */
+        isCorrectDataOptionsInternal: (dataOptions: ChartDataOptionsInternal) => dataOptions is TypedDataOptionsInternal<CT>;
+    };
+    /**
+     * Data retrieving and translation utils.
+     */
+    data: {
+        /**
+         * Loads the data from backend.
+         */
+        loadData: TypedLoadDataFunction<CT>;
+        /**
+         * Translates the data table to the chart data.
+         */
+        getChartData: (chartDataOptions: TypedDataOptionsInternal<CT>, dataTable: DataTable) => TypedChartData<CT>;
+    };
+    /**
+     * Design options translation utils.
+     */
+    designOptions: {
+        /**
+         * Translates the style options to the design options.
+         */
+        translateStyleOptionsToDesignOptions: (styleOptions: TypedChartStyleOptions<CT>, dataOptionsInternal: TypedDataOptionsInternal<CT>) => TypedDesignOptions<CT>;
+        /**
+         * Checks if the style options are correct for the current chart type.
+         */
+        isCorrectStyleOptions: (styleOptions: ChartStyleOptions) => styleOptions is TypedChartStyleOptions<CT>;
+    };
+    /**
+     * Chart renderer component and related utils
+     */
+    renderer: {
+        /**
+         * Chart renderer component.
+         */
+        ChartRendererComponent: React.ComponentType<TypedChartRendererProps<CT>>;
+        /**
+         * Type guard for the chart renderer props.
+         */
+        isCorrectRendererProps: (props: ChartRendererProps) => props is TypedChartRendererProps<CT>;
+    };
+}

package/dist/packages/sdk-ui/src/chart/restructured-charts/utils.d.ts

@@ -0,0 +1,3 @@
+import { ChartType } from '../../index';
+import { SupportedChartType } from './types.js';
+export declare function isRestructuredChartType(chartType: ChartType): chartType is SupportedChartType;

package/dist/packages/sdk-ui/src/chart-data/types.d.ts

@@ -1,7 +1,8 @@
-import { Color, NumberFormatConfig } from '../types';
-import { AreamapChartType, IndicatorChartType } from '../chart-options-processor/translations/types';
+import { NumberFormatConfig } from '../types';
+import { IndicatorChartType } from '../chart-options-processor/translations/types';
 import { ComparableData, Value } from '../chart-data-processor/table-processor';
 import { Coordinates } from '../charts/map-charts/scattermap/types';
+import { AreamapData } from '../chart/restructured-charts/areamap-chart/types';
 export type CategoricalXValues = {
     key: string;
     xValues: string[];
@@ -124,33 +125,6 @@ export type IndicatorChartData = {
     min?: number;
     max?: number;
 };
-/**
- * Raw GeoDataElement from data
- */
-export type RawGeoDataElement = {
-    /** Name of geo-element (country or state) */
-    geoName: string;
-    /** Original numeric measure value for this geo-element */
-    originalValue: number;
-    /** Formatted measure value for this geo-element to display*/
-    formattedOriginalValue: string;
-};
-/**
- * GeoDataElement with color property, calculated from `originalValue`
- */
-export type GeoDataElement = RawGeoDataElement & {
-    /** Calculated color for this geo-element */
-    color?: Color;
-};
-/**
- * Fact final data that will be passed to Areamap-component to render
- *
- * @internal
- */
-export type AreamapData = {
-    type: AreamapChartType;
-    geoData: GeoDataElement[];
-};
 /**
  * Fact final data that will be passed to chart-component to render
  *