@sisense/sdk-ui 2.8.0 → 2.10.0

package/dist/packages/sdk-ui/src/pivot-table/hooks/use-apply-pivot-table-formatting.d.ts

@@ -1,11 +1,14 @@
 import { type DataService } from '@sisense/sdk-pivot-client';
 import { type PivotTableDataOptionsInternal } from '../../chart-data-options/types';
+import { type CustomDataCellFormatter, type CustomHeaderCellFormatter } from '../../pivot-table/formatters/types';
 /**
  * A hook that applies formatting over pivot table cells.
  *
  * @internal
  */
-export declare const useApplyPivotTableFormatting: ({ dataService, dataOptions, }: {
+export declare const useApplyPivotTableFormatting: ({ dataService, dataOptions, onDataCellFormat, onHeaderCellFormat, }: {
     dataService: DataService;
     dataOptions: PivotTableDataOptionsInternal;
+    onDataCellFormat?: CustomDataCellFormatter | undefined;
+    onHeaderCellFormat?: CustomHeaderCellFormatter | undefined;
 }) => void;

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { PolarChartProps } from './props';
 /**
- * A React component comparing multiple categories/variables with a spacial perspective in a radial chart.
+ * A React component comparing multiple categories/variables with a spatial perspective in a radial chart.
  *
  * ## Example
  *

package/dist/packages/sdk-ui/src/props.d.ts

@@ -1,8 +1,9 @@
 import { Attribute, Filter, Measure, DataSource, Data, QueryResultData, FilterRelations } from '@sisense/sdk-data';
-import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuAlignment, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, IndicatorRenderOptions, TabberStyleProps, IndicatorDataPoint, TextWidgetDataPoint, CustomWidgetStyleOptions, PivotTableDataPoint } from './types';
+import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuAlignment, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, IndicatorRenderOptions, TabberStyleProps, IndicatorDataPoint, TextWidgetDataPoint, CustomWidgetStyleOptions, PivotTableDataPoint, CalendarHeatmapStyleOptions, CalendarHeatmapDataPoint } from './types';
+import { type CustomDataCellFormatter, type CustomHeaderCellFormatter } from './pivot-table/formatters/types';
 import { HighchartsOptions } from './chart-options-processor/chart-options-service';
 import { ComponentType, PropsWithChildren, ReactNode } from 'react';
-import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions } from './chart-data-options/types';
+import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions, CalendarHeatmapChartDataOptions } from './chart-data-options/types';
 import { AppConfig } from './app/client-application';
 import { ExecuteQueryParams, QueryByWidgetIdState } from './query-execution';
 import { FiltersMergeStrategy } from './widget-by-id/types';
@@ -43,7 +44,7 @@ export interface SisenseContextProviderProps {
      */
     ssoEnabled?: boolean;
     /**
-     * Token for [bearer authentication](https://sisense.dev/guides/restApi/using-rest-api.html).
+     * Token for [bearer authentication](https://developer.sisense.com/guides/restApi/using-rest-api.html).
      *
      * To signify that the token is pending (e.g., being generated), set the value to `null`. This is supported for React and Vue only.
      *
@@ -296,6 +297,26 @@ export type IndicatorDataPointEventHandler = (
 point: IndicatorDataPoint, 
 /** Native MouseEvent */
 nativeEvent: MouseEvent) => void;
+/**
+ * Click handler for when a calendar-heatmap data point is clicked
+ *
+ * @alpha
+ */
+export type CalendarHeatmapDataPointEventHandler = (
+/** Data point that was clicked */
+point: CalendarHeatmapDataPoint, 
+/** Native PointerEvent */
+nativeEvent: PointerEvent) => void;
+/**
+ * Click handler for when multiple calendar-heatmap data points are selected.
+ *
+ * @alpha
+ */
+export type CalendarHeatmapDataPointsEventHandler = (
+/** Data points that were selected */
+points: CalendarHeatmapDataPoint[], 
+/** Native MouseEvent */
+nativeEvent: MouseEvent) => void;
 /**
  * Click handler for when text widget is clicked.
  *
@@ -457,6 +478,32 @@ interface IndicatorChartEventProps extends BaseChartEventProps {
      */
     onDataPointClick?: IndicatorDataPointEventHandler;
 }
+/**
+ * Event props for CalendarHeatmap chart which uses CalendarHeatmapDataPoint type
+ * to describe data points for events.
+ *
+ * @internal
+ */
+export interface CalendarHeatmapChartEventProps extends BaseChartEventProps, HighchartsBasedChartEventProps {
+    /**
+     * Click handler callback for a data point
+     *
+     * @category Callbacks
+     */
+    onDataPointClick?: CalendarHeatmapDataPointEventHandler;
+    /**
+     * Context menu handler callback for a data point
+     *
+     * @category Callbacks
+     */
+    onDataPointContextMenu?: CalendarHeatmapDataPointEventHandler;
+    /**
+     * Handler callback for selection of multiple data points
+     *
+     * @category Callbacks
+     */
+    onDataPointsSelected?: CalendarHeatmapDataPointsEventHandler;
+}
 /**
  * Base Chart Props to be extended by {@link ChartProps}
  *
@@ -471,7 +518,7 @@ export interface BaseChartProps extends BaseChartEventProps {
      *
      * (1) Sisense data source name as a string. For example, `'Sample ECommerce'`. Typically, you
      * retrieve the data source name from a data model you create using the `get-data-model`
-     * {@link https://sisense.dev/guides/sdk/guides/cli.html | command} of the Compose SDK CLI. Under the hood, the chart
+     * {@link https://developer.sisense.com/guides/sdk/guides/cli.html | command} of the Compose SDK CLI. The chart
      * connects to the data source, executes a query, and loads the data as specified in
      * `dataOptions`, `filters`, and `highlights`.
      *
@@ -564,19 +611,19 @@ interface ChartEventProps extends BaseChartEventProps {
      *
      * @category Callbacks
      */
-    onDataPointClick?: DataPointEventHandler | ScatterDataPointEventHandler | AreamapDataPointEventHandler | BoxplotDataPointEventHandler | ScattermapDataPointEventHandler | IndicatorDataPointEventHandler;
+    onDataPointClick?: DataPointEventHandler | ScatterDataPointEventHandler | AreamapDataPointEventHandler | BoxplotDataPointEventHandler | ScattermapDataPointEventHandler | IndicatorDataPointEventHandler | CalendarHeatmapDataPointEventHandler;
     /**
      * Context menu handler callback for a data point
      *
      * @category Callbacks
      */
-    onDataPointContextMenu?: DataPointEventHandler | ScatterDataPointEventHandler | BoxplotDataPointEventHandler;
+    onDataPointContextMenu?: DataPointEventHandler | ScatterDataPointEventHandler | BoxplotDataPointEventHandler | CalendarHeatmapDataPointEventHandler;
     /**
      * Handler callback for selection of multiple data points
      *
      * @category Callbacks
      */
-    onDataPointsSelected?: DataPointsEventHandler | ScatterDataPointsEventHandler;
+    onDataPointsSelected?: DataPointsEventHandler | ScatterDataPointsEventHandler | CalendarHeatmapDataPointsEventHandler;
     /**
      * A callback that allows you to customize the underlying chart element before it is rendered. The returned options are then used when rendering the chart.
      *
@@ -891,6 +938,50 @@ export interface PivotTableProps {
      * @internal
      */
     onDataPointContextMenu?: PivotTableDataPointEventHandler;
+    /**
+     * Applies custom styling and behavior to pivot table data cells.
+     *
+     * This formatter function returns formatting objects instead of mutating parameters,
+     * following functional programming principles. Use this single callback to combine
+     * multiple handlers and control the call sequence from outside the pivot.
+     *
+     * @example
+     * ```typescript
+     * const customDataFormatter: CustomDataCellFormatter = (cell, jaqlPanelItem, dataOption, id) => {
+     *   if (cell.value > 1000) {
+     *     return {
+     *       style: { backgroundColor: 'lightgreen' },
+     *       content: `${cell.value} (High)`
+     *     };
+     *   }
+     * };
+     * ```
+     *
+     * @internal
+     */
+    onDataCellFormat?: CustomDataCellFormatter;
+    /**
+     * Applies custom styling and behavior to pivot table row and column headers.
+     *
+     * This formatter function returns formatting objects instead of mutating parameters,
+     * following functional programming principles. Use this single callback to combine
+     * multiple handlers and control the call sequence from outside the pivot.
+     *
+     * @example
+     * ```typescript
+     * const customHeaderFormatter: CustomHeaderCellFormatter = (cell, jaqlPanelItem, dataOption, id) => {
+     *   if (cell.content === 'Total') {
+     *     return {
+     *       style: { fontWeight: 'bold', color: 'blue' },
+     *       className: 'total-header'
+     *     };
+     *   }
+     * };
+     * ```
+     *
+     * @internal
+     */
+    onHeaderCellFormat?: CustomHeaderCellFormatter;
 }
 /**
  * Props of the {@link ScatterChart} component.
@@ -1214,6 +1305,50 @@ export interface PivotTableWidgetProps {
      * @internal
      */
     onDataPointContextMenu?: PivotTableDataPointEventHandler;
+    /**
+     * Applies custom styling and behavior to pivot table data cells.
+     *
+     * This formatter function returns formatting objects instead of mutating parameters,
+     * following functional programming principles. Use this single callback to combine
+     * multiple handlers and control the call sequence from outside the pivot.
+     *
+     * @example
+     * ```typescript
+     * const customDataFormatter: CustomDataCellFormatter = (cell, jaqlPanelItem, dataOption, id) => {
+     *   if (cell.value > 1000) {
+     *     return {
+     *       style: { backgroundColor: 'lightgreen' },
+     *       content: `${cell.value} (High)`
+     *     };
+     *   }
+     * };
+     * ```
+     *
+     * @internal
+     */
+    onDataCellFormat?: CustomDataCellFormatter;
+    /**
+     * Applies custom styling and behavior to pivot table row and column headers.
+     *
+     * This formatter function returns formatting objects instead of mutating parameters,
+     * following functional programming principles. Use this single callback to combine
+     * multiple handlers and control the call sequence from outside the pivot.
+     *
+     * @example
+     * ```typescript
+     * const customHeaderFormatter: CustomHeaderCellFormatter = (cell, jaqlPanelItem, dataOption, id) => {
+     *   if (cell.content === 'Total') {
+     *     return {
+     *       style: { fontWeight: 'bold', color: 'blue' },
+     *       className: 'total-header'
+     *     };
+     *   }
+     * };
+     * ```
+     *
+     * @internal
+     */
+    onHeaderCellFormat?: CustomHeaderCellFormatter;
 }
 /**
  * Props for the `TextWidget` component.
@@ -1628,3 +1763,22 @@ export interface UseGetSharedFormulaParams extends HookEnableParam {
      */
     dataSource?: DataSource;
 }
+/**
+ * Props of the {@link CalendarHeatmapChart} component.
+ *
+ * @internal
+ */
+export interface CalendarHeatmapChartProps extends BaseChartProps, CalendarHeatmapChartEventProps {
+    /**
+     * Configurations for how to interpret and present the data passed to the chart
+     *
+     * @category Chart
+     */
+    dataOptions: CalendarHeatmapChartDataOptions;
+    /**
+     * Configurations for how to style and present a chart's data.
+     *
+     * @category Chart
+     */
+    styleOptions?: CalendarHeatmapStyleOptions;
+}

package/dist/packages/sdk-ui/src/query/date-formats/apply-date-format.d.ts

@@ -53,13 +53,14 @@ export type DateConfig = {
 };
 export declare const defaultDateConfig: DateConfig;
 /**
- * Returns a formatted date, according to the provided date format string.
+ * Safely formats a date value, handling special cases like 'N\A'
  *
- * @param date -
- * @param format -
- * @param locale -
- * @param cfg -
+ * @param value - The date value to format, can be a Date object, ISO string, or special value like 'N\A'
+ * @param format - The date format to apply
+ * @param locale - Optional locale for formatting
+ * @param cfg - Optional date configuration
+ * @returns Formatted date string or the original value for special cases
  */
-export declare function applyDateFormat(date: Date, format: DateFormat, locale?: Locale, cfg?: DateConfig): string;
+export declare function formatDateValue(value: Date | string, format: DateFormat, locale?: Locale, cfg?: DateConfig): string;
 export declare function getDefaultDateMask(granularity?: string): "HH:mm:ss" | "yyyy" | "MM/yyyy" | "ww yyyy" | "HH:mm" | "Q yyyy" | "shortDate" | "fullDate";
 export {};

package/dist/packages/sdk-ui/src/query/date-formats/index.d.ts

@@ -1,2 +1,2 @@
 export type { DateFormat, DateConfig } from './apply-date-format';
-export { applyDateFormat, defaultDateConfig } from './apply-date-format';
+export { formatDateValue, defaultDateConfig } from './apply-date-format';

package/dist/packages/sdk-ui/src/query/execute-query.d.ts

@@ -1,5 +1,5 @@
 import { CreateCacheKeyFn } from '../utils/create-cache';
-import { Attribute, Measure, PivotAttribute, PivotMeasure, PivotQueryResultData, QueryResultData } from '@sisense/sdk-data';
+import { Attribute, DataSource, Measure, PivotAttribute, PivotMeasure, PivotQueryResultData, QueryResultData } from '@sisense/sdk-data';
 import type { QueryDescription as InternalQueryDescription, PivotQueryDescription as InternalPivotQueryDescription, QueryExecutionConfig } from '@sisense/sdk-query-client';
 import { ClientApplication } from '../app/client-application';
 /**
@@ -26,6 +26,8 @@ export type PivotQueryDescription = Partial<Omit<InternalPivotQueryDescription,
     values?: (Measure | PivotMeasure)[];
 };
 /** @internal */
+export declare const prepareQueryParams: (queryDescription: QueryDescription, defaultDataSource?: DataSource) => InternalQueryDescription;
+/** @internal */
 export declare function executeQuery(queryDescription: QueryDescription, app: ClientApplication, executionConfig?: QueryExecutionConfig): Promise<QueryResultData>;
 /** @internal */
 export declare const executeCsvQuery: (queryDescription: QueryDescription, app: ClientApplication, executionConfig?: QueryExecutionConfig) => Promise<Blob>;

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

@@ -5,4 +5,4 @@ export { ExecuteQueryByWidgetId } from './execute-query-by-widget-id';
 export { useExecuteQueryByWidgetId, executeQueryByWidgetId, } from './use-execute-query-by-widget-id';
 export { useExecutePivotQuery } from './use-execute-pivot-query';
 export { useQueryCache } from './use-query-cache';
-export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, PivotQueryState, PivotQueryLoadingState, PivotQuerySuccessState, PivotQueryErrorState, ExecuteQueryParams, ExecuteQueryResult, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, QueryByWidgetIdQueryParams, ExecutePivotQueryParams, } from './types';
+export type { QueryState, QueryLoadingState, QuerySuccessState, QueryErrorState, CsvQueryState, CsvQueryLoadingState, CsvQuerySuccessState, CsvQueryErrorState, PivotQueryState, PivotQueryLoadingState, PivotQuerySuccessState, PivotQueryErrorState, BaseQueryParams, ExecuteQueryParams, ExecuteQueryResult, ExecuteCsvQueryParams, ExecuteCSVQueryConfig, ExecuteQueryByWidgetIdParams, QueryByWidgetIdState, QueryByWidgetIdQueryParams, ExecutePivotQueryParams, } from './types';

package/dist/packages/sdk-ui/src/query-execution/types.d.ts

@@ -171,9 +171,11 @@ export type QueryByWidgetIdQueryParams = {
  */
 export type QueryByWidgetIdState = QueryState & QueryByWidgetIdQueryParams;
 /**
- * Parameters for {@link useExecuteQuery} hook.
+ * Base query parameters
+ *
+ * @internal
  */
-export interface ExecuteQueryParams {
+export interface BaseQueryParams {
     /**
      * Data source the query is run against - e.g. `Sample ECommerce`
      *
@@ -188,6 +190,11 @@ export interface ExecuteQueryParams {
     filters?: Filter[] | FilterRelations;
     /** Highlight filters that will highlight results that pass filter criteria */
     highlights?: Filter[];
+}
+/**
+ * Parameters for {@link useExecuteQuery} hook.
+ */
+export interface ExecuteQueryParams extends BaseQueryParams {
     /**
      * Number of rows to return in the query result
      *

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

@@ -2,9 +2,9 @@ import { ChartDataOptionsInternal } from '../chart-data-options/types';
 import { ChartData } from '../chart-data/types.js';
 import { ChartDesignOptions } from '../chart-options-processor/translations/types.js';
 import { BeforeRenderHandler } from '../props.js';
-import { BoxplotChartType, BoxplotDataPoint, CartesianChartType, CategoricalChartType, DataPoint, ScatterChartType, ScatterDataPoint } from '../types.js';
+import { BoxplotChartType, BoxplotDataPoint, CalendarHeatmapDataPoint, CartesianChartType, CategoricalChartType, DataPoint, ScatterChartType, ScatterDataPoint } from '../types.js';
 export type SisenseChartDataPointsEventHandler = (points: SisenseChartDataPoint[], nativeEvent: MouseEvent) => void;
-export type SisenseChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint;
+export type SisenseChartDataPoint = DataPoint | ScatterDataPoint | BoxplotDataPoint | CalendarHeatmapDataPoint;
 export type SisenseChartDataPointEventHandler = (point: SisenseChartDataPoint, nativeEvent: PointerEvent) => void;
 export interface SisenseChartProps {
     chartType: SisenseChartType;

package/dist/packages/sdk-ui/src/theme-provider/default-theme-settings.d.ts

@@ -10,6 +10,7 @@ export declare const DEFAULT_FILTER_PANEL_DIVIDER_LINE_WIDTH = 1;
 export declare const DEFAULT_FILTER_PANEL_BORDER_COLOR = "#DADADA";
 export declare const DEFAULT_FILTER_PANEL_BORDER_WIDTH = 1;
 export declare const DEFAULT_TITLE_FONT_SIZE = 15;
+export declare const DEFAULT_HYPERLINK_COLOR = "#1FAFF3";
 /**
  * Returns default theme settings, which can be used as base for custom theme options.
  *

package/dist/packages/sdk-ui/src/translation/resources/en.d.ts

@@ -373,6 +373,17 @@ export declare const translation: {
     jumpToDashboard: {
         defaultCaption: string;
         jumpableTooltip: string;
+        noDrillTargets: string;
+    };
+    calendarHeatmap: {
+        navigation: {
+            firstMonth: string;
+            lastMonth: string;
+            previousMonth: string;
+            nextMonth: string;
+            previousGroup: string;
+            nextGroup: string;
+        };
     };
 };
 /**

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

@@ -383,6 +383,17 @@ export declare const resources: {
         jumpToDashboard: {
             defaultCaption: string;
             jumpableTooltip: string;
+            noDrillTargets: string;
+        };
+        calendarHeatmap: {
+            navigation: {
+                firstMonth: string;
+                lastMonth: string;
+                previousMonth: string;
+                nextMonth: string;
+                previousGroup: string;
+                nextGroup: string;
+            };
         };
     };
     uk: {
@@ -760,6 +771,17 @@ export declare const resources: {
         jumpToDashboard: {
             defaultCaption: string;
             jumpableTooltip: string;
+            noDrillTargets: string;
+        };
+        calendarHeatmap: {
+            navigation: {
+                firstMonth: string;
+                lastMonth: string;
+                previousMonth: string;
+                nextMonth: string;
+                previousGroup: string;
+                nextGroup: string;
+            };
         };
     };
 };