@sisense/sdk-ui 2.28.0 → 2.29.0

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

@@ -94,7 +94,9 @@ export * as dashboardModelTranslator from '../domains/dashboarding/dashboard-mod
 export * as dashboardHelpers from '../domains/dashboarding/dashboard-helpers';
 export type { EmptyObject } from '../shared/utils/utility-types';
 export { useFetch, type RequestConfig, type UseQueryResult } from '../shared/hooks/use-fetch';
-export type { StyledColumn, SeriesStyleOptions, StyledMeasureColumn, CartesianChartDataOptions, CategoricalChartDataOptions, IndicatorChartDataOptions, ScatterChartDataOptions, AreamapChartDataOptions, CalendarHeatmapChartDataOptions, TableDataOptions, TabularChartDataOptions, PivotTableDataOptions, ScattermapLocationLevel, ScattermapChartDataOptions, BoxWhiskerType, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, AreaRangeMeasureColumn, RangeChartDataOptions, ChartDataOptions, RegularChartDataOptions, } from '../domains/visualizations/core/chart-data-options/types';
+export type { StyledColumn, SeriesStyleOptions, StyledMeasureColumn, CartesianChartDataOptions, CategoricalChartDataOptions, IndicatorChartDataOptions, ScatterChartDataOptions, AreamapChartDataOptions, CalendarHeatmapChartDataOptions, TableDataOptions, TabularChartDataOptions, PivotTableDataOptions, ScattermapLocationLevel, ScattermapChartDataOptions, BoxWhiskerType, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, AreaRangeMeasureColumn, RangeChartDataOptions, ChartDataOptions, RegularChartDataOptions, CommonDataOptions, } from '../domains/visualizations/core/chart-data-options/types';
+export { formatNumber, formatDate, getDefaultDateFormat, formatDataSet } from '../infra/formatting';
+export type { FormatDateOptions, FormatDataSetOptions } from '../infra/formatting';
 export type { TabberButtonsWidgetProps, SisenseContextProviderProps, ExecuteQueryProps, ThemeProviderProps, BeforeRenderHandler, IndicatorBeforeRenderHandler, ChartDataPointsEventHandler, DataPointsEventHandler, DataPointEventHandler, ScatterDataPointEventHandler, ScatterDataPointsEventHandler, AreamapDataPointEventHandler, ScattermapDataPointEventHandler, BoxplotDataPointEventHandler, IndicatorDataPointEventHandler, CalendarHeatmapDataPointEventHandler, CalendarHeatmapDataPointsEventHandler, PivotTableDataPointEventHandler, ChartEventProps, ChartProps, AreaChartProps, StreamgraphChartProps, BarChartProps, ColumnChartProps, FunnelChartProps, LineChartProps, PieChartProps, PolarChartProps, IndicatorChartProps, TableProps, PivotTableProps, ScatterChartProps, WidgetByIdProps, ExecuteQueryByWidgetIdProps, TreemapChartProps, SunburstChartProps, BoxplotChartProps, ScattermapChartProps, AreamapChartProps, AreaRangeChartProps, ContextMenuProps, DrilldownBreadcrumbsProps, DrilldownWidgetConfig, DrilldownWidgetProps, CalendarHeatmapChartProps, } from '../props';
 export type { AutoZoomNavigatorScrollerLocation } from '../domains/widgets/components/widget-by-id/types';
 export type { SortDirection, PivotRowsSort, AppConfig, DateConfig, CalendarDayOfWeek, IndicatorComponents, ScatterMarkerSize, LegendPosition, Coordinates, TableColorOptions, IndicatorRenderOptions, GeoDataElement, RawGeoDataElement, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, CalendarHeatmapChartType, TableType, TableChartType, RangeChartType, TextStyle, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, AreaSubtype, AreaRangeSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, MonthOfYear, DayOfWeek, DateLevel, TabberButtonsWidgetStyleOptions, TabberButtonsWidgetCustomOptions, Color, ColorPaletteTheme, Navigator, LineWidth, DashStyle, EndCapType, LineOptions, Markers, X2Title, SeriesLabelsTextStyle, SeriesLabelsBase, SeriesLabelsAligning, SeriesLabels, TotalLabelsTextStyle, TotalLabels, LegendTitleOptions, LegendItemsOptions, LegendSymbolsOptions, LegendOptions, Legend, Labels, AxisLabel, Convolution, DataLimits, LineStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, StreamgraphStyleOptions, StackableStyleOptions, PiePercentageLabels, PieSeriesLabels, PieStyleOptions, FunnelSeriesLabels, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, TableStyleOptions, TabularChartStyleOptions, PivotTableStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterSeriesLabels, ScatterStyleOptions, TreemapSeriesLabels, TreemapStyleOptions, SunburstSeriesLabelsBase, SunburstSeriesLabels, SunburstStyleOptions, BoxplotStyleOptions, AreamapType, AreamapStyleOptions, ScattermapMarkers, ScattermapStyleOptions, CalendarHeatmapCellLabels, CalendarHeatmapSubtype, CalendarHeatmapStyleOptions, CalendarHeatmapViewType, ChartStyleOptions, RegularChartStyleOptions, ValueToColorMap, MultiColumnValueToColorMap, ChartType, RegularChartType, SeriesChartType, DecimalScale, NumberFormatConfig, ThemeOid, ChartThemeSettings, AiChatThemeSettings, ThemeSettingsFontSource, ThemeSettingsFont, FontsLoaderSettings, TypographyThemeSettings, GeneralThemeSettings, SpaceSizes, RadiusSizes, ShadowsTypes, AlignmentTypes, WidgetThemeSettings, FilterThemeSettings, ThemeSettings, WidgetStyleOptions, WidgetContainerStyleOptions, WidgetByIdStyleOptions, ChartWidgetStyleOptions, PivotTableWidgetStyleOptions, TextWidgetStyleOptions, CustomWidgetStyleOptions, DrilldownOptions, PivotTableDrilldownOptions, PivotTableSelectableDrilldownOptions, PivotTableNonSelectableDrilldownOptions, DrilldownSelection, DataOptionLocation, ChartDataPoints, ChartDataPoint, DataPoint, DataPointEntry, BasicDataPointEntry, AttributeDataPointEntry, MeasureDataPointEntry, ScatterDataPoint, BoxplotDataPoint, IndicatorDataPoint, CalendarHeatmapDataPoint, PivotTableDataPoint, AreamapDataPoint, ScattermapDataPoint, CustomWidgetDataPoint, CustomWidgetDataPointEventHandler, CustomWidgetDataPointContextMenuHandler, CustomWidgetDataPointsEventHandler, CustomWidgetEventProps, AbstractDataPointWithEntries, MenuPosition, MenuItemSection, CustomDrilldownResult, LoadingIndicatorConfig, GenericDataOptions, NestedTranslationResources, CustomTranslationObject, TranslationConfig, } from '../types';

package/dist/packages/sdk-ui/src/public-api/sisense-internal.d.ts

@@ -20,7 +20,7 @@ export type { QuotaNotificationProps } from '../shared/components/quota-notifica
 export { useQuotaNotification } from '../shared/hooks/use-quota-notification.js';
 export type { QuotaNotificationOptions, QuotaApiResponse, QuotaState, } from '../shared/hooks/use-quota-notification.js';
 export type { Plugin } from '../infra/plugins/types.js';
-export type { WidgetPlugin, CustomVisualization, CustomVisualizationProps, CustomVisualizationStyleOptions, CustomVisualizationEventProps, CustomVisualizationDataPoint, CustomVisualizationDataPointEventHandler, CustomVisualizationDataPointContextMenuHandler, CustomVisualizationDataPointsEventHandler, DesignPanelProps, DesignPanel, } from '../infra/plugins/widget-plugins/types.js';
+export type { WidgetPlugin, CustomVisualization, CustomVisualizationProps, VisualizationStateUpdate, CustomVisualizationStyleOptions, CustomVisualizationEventProps, CustomVisualizationDataPoint, CustomVisualizationDataPointEventHandler, CustomVisualizationDataPointContextMenuHandler, CustomVisualizationDataPointsEventHandler, DesignPanelProps, DesignPanel, } from '../infra/plugins/widget-plugins/types.js';
 export { LoadingIndicator } from '../shared/components/loading-indicator.js';
 export { DataSchemaBrowser } from '../domains/data-browser/data-schema-browser/data-schema-browser.js';
 export { type NarrativeQueryParams } from '../domains/narrative/core/build-narrative-request.js';

package/dist/packages/sdk-ui/src/shared/components/loading-overlay.d.ts

@@ -25,5 +25,6 @@ export type LoadingOverlayProps = {
  *   <Chart {...chartOptions} />
  * </LoadingOverlay>
  * ```
+ * @group Primitives
  */
 export declare const LoadingOverlay: ({ isVisible, children }: LoadingOverlayProps) => import("react/jsx-runtime").JSX.Element;

package/dist/packages/sdk-ui/src/shared/hooks/use-element-height.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Observes an HTML element's height via `ResizeObserver` and reports the latest
+ * measured height in CSS pixels.
+ *
+ * Returns a callback ref to attach to the target element and the current height.
+ * Height is `0` while no element is attached. The observer is re-bound when the
+ * attached node changes and disconnected on unmount.
+ *
+ * @example
+ * ```tsx
+ * const { ref, height } = useElementHeight<HTMLDivElement>();
+ * return <div ref={ref}>{height}px</div>;
+ * ```
+ * @internal
+ */
+export declare function useElementHeight<T extends HTMLElement = HTMLElement>(): {
+    ref: (node: T | null) => void;
+    height: number;
+};

package/dist/packages/sdk-ui/src/shared/hooks/use-synced-state.d.ts

@@ -1,5 +1,10 @@
 import { Dispatch, SetStateAction } from 'react';
-type UseSyncedStateOptions<T> = {
+/**
+ * Options for {@link useSyncedState}.
+ *
+ * @alpha
+ */
+export type UseSyncedStateOptions<T> = {
     /**
      * A callback function that is triggered when the state is updated via the local setter,
      * but not through synchronization with `syncValue`.
@@ -14,6 +19,22 @@ type UseSyncedStateOptions<T> = {
 /**
  * A custom React hook that behaves like the regular `useState`, but also synchronizes the state
  * with an external `syncValue`.
+ *
+ * @param syncValue - The external value to synchronize with. When this value changes (as
+ *   determined by `syncCompareFn`), the local state is updated to match it.
+ * @param options - Optional configuration object.
+ * @param options.onLocalStateChange - Callback invoked whenever the local state is updated via
+ *   the returned setter (not triggered by external `syncValue` synchronization).
+ * @param options.syncCompareFn - Custom equality function used to detect changes in `syncValue`.
+ *   Defaults to a deep equality check via `isEqual` from lodash-es. See {@link UseSyncedStateOptions}.
+ * @returns A tuple of `[localState, setState]` — the current local state and a setter that
+ *   both updates state and fires `onLocalStateChange`.
+ * @example
+ * ```tsx
+ * const [localState, setLocalState] = useSyncedState(externalValue, {
+ *   onLocalStateChange: (s) => console.log('local update', s),
+ * });
+ * ```
+ * @alpha
  */
 export declare function useSyncedState<T>(syncValue: T, { onLocalStateChange, syncCompareFn }?: UseSyncedStateOptions<T>): [T, Dispatch<SetStateAction<T>>];
-export {};

package/dist/packages/sdk-ui/src/shared/utils/filter-relations.d.ts

@@ -9,6 +9,14 @@ export declare enum FiltersMergeStrategyEnum {
     CODE_ONLY = "codeOnly"
 }
 export type FiltersMergeStrategy = `${FiltersMergeStrategyEnum}`;
+/**
+ * Returns true if any node in the filter-relations tree uses an OR operator.
+ * Used to decide whether to show the AND/OR Formula tile — AND-only trees are the default
+ * behavior and don't warrant a visible indicator.
+ *
+ * @internal
+ */
+export declare function hasOrOperator(relations: FilterRelationsRules): boolean;
 /**
  * Textual representation of filter relations for debugging purposes.
  * Returns string like "(([Gender] AND [Country]) OR [Condition])".

package/dist/packages/sdk-ui/src/shared/utils/gradient.d.ts

@@ -178,6 +178,7 @@ export type GradientColor = LinearGradientColor | RadialGradientColor;
  *
  * @param value - The value to check
  * @returns True if the value is a linear gradient
+ * @group Styling
  */
 export declare const isLinearGradient: (value: any) => value is LinearGradientColor;
 /**
@@ -185,6 +186,7 @@ export declare const isLinearGradient: (value: any) => value is LinearGradientCo
  *
  * @param value - The value to check
  * @returns True if the value is a radial gradient
+ * @group Styling
  */
 export declare const isRadialGradient: (value: any) => value is RadialGradientColor;
 /**
@@ -192,6 +194,7 @@ export declare const isRadialGradient: (value: any) => value is RadialGradientCo
  *
  * @param value - The value to check
  * @returns True if the value is a gradient
+ * @group Styling
  */
 export declare const isGradient: (value: any) => value is GradientColor;
 /**
@@ -315,6 +318,7 @@ export declare const RadialGradientPresets: {
  *   ]
  * );
  * ```
+ * @group Styling
  */
 export declare const createLinearGradient: (direction: LinearGradientDirection, stops: readonly GradientStop[]) => LinearGradientColor;
 /**
@@ -334,6 +338,7 @@ export declare const createLinearGradient: (direction: LinearGradientDirection,
  *   ]
  * );
  * ```
+ * @group Styling
  */
 export declare const createRadialGradient: (center: RadialGradientConfig, stops: readonly GradientStop[]) => RadialGradientColor;
 /**

package/dist/types-7YG0uOzO.js

@@ -0,0 +1,74 @@
+import { c as i, g as l, a as n, b as o, D as d, d as u, M as s } from "./apply-styled-options-to-query-CaP4IMrQ.js";
+class c extends d {
+  constructor(a, t) {
+    var r;
+    super((r = a.jaql.title) !== null && r !== void 0 ? r : "", t), this.__serializable = "JaqlElement", this.expression = a.jaql.dim || a.jaql.formula, this.metadataItem = a, a.jaql.agg ? this.aggregation = a.jaql.agg : delete this.aggregation, a.jaql.formula ? this.formula = a.jaql.formula : delete this.formula, a.jaql.sort ? this.sortType = u(a.jaql.sort) : delete this.sortType, this.skipValidation = !0;
+  }
+  get id() {
+    return this.expression;
+  }
+  jaql(a) {
+    return a === !0 ? this.metadataItem.jaql : this.metadataItem;
+  }
+  /**
+   * Gets a serializable representation of the element
+   */
+  serialize() {
+    const a = super.serialize();
+    return a.metadataItem = this.metadataItem, a.type = this.type, a;
+  }
+}
+const m = {
+  text: s.TextAttribute,
+  numeric: s.NumericAttribute,
+  datetime: s.DateLevel
+}, y = (e) => e && e.__serializable === "JaqlElement";
+function p(e) {
+  var a;
+  return new c(e, (a = m[e.jaql.datatype]) !== null && a !== void 0 ? a : "numeric");
+}
+function h(e) {
+  const { jaql: a } = e;
+  if (a.formula)
+    return i(a);
+  const t = l(a);
+  return "agg" in a && a.dim && a.datatype ? n({
+    expression: a.dim,
+    dataType: a.datatype,
+    agg: a.agg || "",
+    granularity: t,
+    format: void 0,
+    sort: a.sort,
+    title: a.title,
+    dataSource: a.datasource
+  }) : a.dim && a.datatype ? o({
+    expression: a.dim,
+    dataType: a.datatype,
+    granularity: t,
+    sort: a.sort,
+    title: a.title,
+    panel: e.panel,
+    dataSource: a.datasource
+  }) : p(e);
+}
+const q = {
+  jaql: { datasource: { title: "", type: "elasticube" }, metadata: [] },
+  queryTitle: "",
+  chartRecommendations: {}
+}, f = {
+  model: "",
+  metadata: [],
+  chart: {},
+  queryTitle: ""
+}, E = (e) => "widgetProps" in e, j = (e) => "dashboardOid" in e && "widgetOid" in e, b = (e) => "dashboardProps" in e, T = (e) => "dashboardOid" in e;
+export {
+  f as E,
+  c as J,
+  T as a,
+  q as b,
+  h as c,
+  E as d,
+  b as e,
+  y as f,
+  j as i
+};

package/dist/{types-CzgBH2kL.cjs → types-DlYJ_DZ0.cjs}

@@ -1 +1 @@
-"use strict";const a=require("./apply-styled-options-to-query-23D9br-S.cjs");class s extends a.DimensionalElement{constructor(e,r){var i;super((i=e.jaql.title)!==null&&i!==void 0?i:"",r),this.__serializable="JaqlElement",this.expression=e.jaql.dim||e.jaql.formula,this.metadataItem=e,e.jaql.agg?this.aggregation=e.jaql.agg:delete this.aggregation,e.jaql.formula?this.formula=e.jaql.formula:delete this.formula,e.jaql.sort?this.sortType=a.getSortType(e.jaql.sort):delete this.sortType,this.skipValidation=!0}get id(){return this.expression}jaql(e){return e===!0?this.metadataItem.jaql:this.metadataItem}serialize(){const e=super.serialize();return e.metadataItem=this.metadataItem,e.type=this.type,e}}const l={text:a.MetadataTypes.TextAttribute,numeric:a.MetadataTypes.NumericAttribute,datetime:a.MetadataTypes.DateLevel},d=t=>t&&t.__serializable==="JaqlElement";function n(t){var e;return new s(t,(e=l[t.jaql.datatype])!==null&&e!==void 0?e:"numeric")}function o(t){const{jaql:e}=t;if(e.formula)return a.createCalculatedMeasureHelper(e);const r=a.getGranularityFromJaql(e);return"agg"in e&&e.dim&&e.datatype?a.createMeasureHelper({expression:e.dim,dataType:e.datatype,agg:e.agg||"",granularity:r,format:void 0,sort:e.sort,title:e.title,dataSource:e.datasource}):e.dim&&e.datatype?a.createAttributeHelper({expression:e.dim,dataType:e.datatype,granularity:r,sort:e.sort,title:e.title,panel:t.panel,dataSource:e.datasource}):n(t)}const u={jaql:{datasource:{title:"",type:"elasticube"},metadata:[]},queryTitle:"",chartRecommendations:{}},m={model:"",metadata:[],chart:{},queryTitle:""},c=t=>"widgetProps"in t,p=t=>"dashboardOid"in t&&"widgetOid"in t,y=t=>"dashboardProps"in t,g=t=>"dashboardOid"in t;exports.EMPTY_EXPANDED_QUERY_MODEL=u;exports.EMPTY_SIMPLE_QUERY_MODEL=m;exports.JaqlElement=s;exports.createDimensionalElementFromMetadataItem=o;exports.isByIdDashboardCodeParams=g;exports.isByIdWidgetCodeParams=p;exports.isClientSideDashboardCodeParams=y;exports.isClientSideWidgetCodeParams=c;exports.isJaqlElement=d;
+"use strict";const a=require("./apply-styled-options-to-query-D5D8pRl2.cjs");class s extends a.DimensionalElement{constructor(e,r){var i;super((i=e.jaql.title)!==null&&i!==void 0?i:"",r),this.__serializable="JaqlElement",this.expression=e.jaql.dim||e.jaql.formula,this.metadataItem=e,e.jaql.agg?this.aggregation=e.jaql.agg:delete this.aggregation,e.jaql.formula?this.formula=e.jaql.formula:delete this.formula,e.jaql.sort?this.sortType=a.getSortType(e.jaql.sort):delete this.sortType,this.skipValidation=!0}get id(){return this.expression}jaql(e){return e===!0?this.metadataItem.jaql:this.metadataItem}serialize(){const e=super.serialize();return e.metadataItem=this.metadataItem,e.type=this.type,e}}const l={text:a.MetadataTypes.TextAttribute,numeric:a.MetadataTypes.NumericAttribute,datetime:a.MetadataTypes.DateLevel},d=t=>t&&t.__serializable==="JaqlElement";function n(t){var e;return new s(t,(e=l[t.jaql.datatype])!==null&&e!==void 0?e:"numeric")}function o(t){const{jaql:e}=t;if(e.formula)return a.createCalculatedMeasureHelper(e);const r=a.getGranularityFromJaql(e);return"agg"in e&&e.dim&&e.datatype?a.createMeasureHelper({expression:e.dim,dataType:e.datatype,agg:e.agg||"",granularity:r,format:void 0,sort:e.sort,title:e.title,dataSource:e.datasource}):e.dim&&e.datatype?a.createAttributeHelper({expression:e.dim,dataType:e.datatype,granularity:r,sort:e.sort,title:e.title,panel:t.panel,dataSource:e.datasource}):n(t)}const u={jaql:{datasource:{title:"",type:"elasticube"},metadata:[]},queryTitle:"",chartRecommendations:{}},m={model:"",metadata:[],chart:{},queryTitle:""},c=t=>"widgetProps"in t,p=t=>"dashboardOid"in t&&"widgetOid"in t,y=t=>"dashboardProps"in t,g=t=>"dashboardOid"in t;exports.EMPTY_EXPANDED_QUERY_MODEL=u;exports.EMPTY_SIMPLE_QUERY_MODEL=m;exports.JaqlElement=s;exports.createDimensionalElementFromMetadataItem=o;exports.isByIdDashboardCodeParams=g;exports.isByIdWidgetCodeParams=p;exports.isClientSideDashboardCodeParams=y;exports.isClientSideWidgetCodeParams=c;exports.isJaqlElement=d;