@sisense/sdk-ui 1.34.0 → 2.0.0

package/dist/packages/sdk-ui/src/utils/utility-types/rest-api-hook-state.d.ts

@@ -0,0 +1,35 @@
+import { AnyArray, AnyObject } from './basic-utility-types';
+/**
+ * Universal generic state for hooks that fetch data from the REST API.
+ */
+export type RestApiHookState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = RestApiHookSuccessState<DataKey, SuccessDataType> | RestApiHookErrorState<DataKey> | RestApiHookLoadingState<DataKey>;
+/** Success state of the REST API hook */
+export type RestApiHookSuccessState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = {
+    isLoading: false;
+    isError: false;
+    isSuccess: true;
+    error: undefined;
+    status: 'success';
+} & {
+    [key in DataKey]: SuccessDataType;
+};
+/** Error state of the REST API hook */
+export type RestApiHookErrorState<DataKey extends string> = {
+    isLoading: false;
+    isError: true;
+    isSuccess: false;
+    error: Error;
+    status: 'error';
+} & {
+    [key in DataKey]: undefined;
+};
+/** Loading state of the REST API hook */
+export type RestApiHookLoadingState<DataKey extends string> = {
+    isLoading: true;
+    isError: false;
+    isSuccess: false;
+    error: undefined;
+    status: 'loading';
+} & {
+    [key in DataKey]: undefined;
+};

package/dist/packages/sdk-ui/src/utils/utility-types/soft-union.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Gets all unique keys from a union of object types.
+ *
+ * @template T - The union of object types.
+ * @returns A union of all keys present in the types in `T`.
+ *
+ * @example
+ * type Type1 = { a: number; b: string };
+ * type Type2 = { b: string; c?: boolean };
+ * type AllKeys = KeysOfUnion<Type1 | Type2>; // Evaluates to "a" | "b" | "c"
+ */
+type KeysOfUnion<T> = T extends unknown ? keyof T : never;
+/**
+ * Creates a "soft union" type from a union of object types. A soft union
+ * combines the properties of all types in the union, making properties
+ * optional with `undefined` if they are not present in a specific type
+ * within the union.
+ *
+ * @template T - The union of object types.
+ * @returns A type that represents the soft union of the types in `T`.
+ * Each constituent type in the union `T` is augmented with the missing
+ * properties from other types in `T`, typed as optional `undefined`.
+ *
+ * @example
+ * type Type1 = { bar: string };
+ * type Type2 = { agg: number };
+ * type SoftUnionType = SoftUnion<Type1 | Type2>;
+ * // Evaluates to:
+ * // | { bar: string; agg?: undefined }
+ * // | { bar?: undefined; agg: number; }
+ *
+ * @internal
+ */
+export type SoftUnion<T, K extends PropertyKey = KeysOfUnion<T>> = T extends unknown ? T & Partial<Record<Exclude<K, keyof T>, undefined>> : never;
+export {};

package/dist/packages/sdk-ui/src/widget-by-id/translate-dashboard-filters.d.ts

@@ -4785,13 +4785,6 @@ export declare function getDashboardFilters(dashboardFilters: Array<FilterDto |
         sort?: "desc" | "asc" | undefined;
         in?: {
             selected?: {
-                /**
-                 * Checks if a highlight filter is applicable to a widget.
-                 *
-                 * @param {FilterDto} filter - The filter to be checked.
-                 * @param {WidgetDto} widget - The widget that filters are applied to.
-                 * @returns {boolean} `true` if the filter is applicable; otherwise, `false`.
-                 */
                 jaql: import("@sisense/sdk-data").FilterJaql;
             } | undefined;
         } | undefined;

package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-data-options.d.ts

@@ -1,6 +1,6 @@
 import { JaqlDataSource } from '@sisense/sdk-data';
 import { StyledMeasureColumn, StyledColumn, Color } from '../types.js';
-import { Panel, PanelItem, WidgetType, WidgetStyle, BoxplotWidgetStyle } from './types.js';
+import { Panel, PanelItem, FusionWidgetType, WidgetStyle, BoxplotWidgetStyle } from './types.js';
 import { WidgetDataOptions } from '../models/index.js';
 /** @internal */
 export declare function applyStatisticalModels(dataOption: StyledMeasureColumn, statisticalModels?: {
@@ -38,4 +38,4 @@ export declare function extractBoxplotBoxType(style: BoxplotWidgetStyle): "iqr"
  * This is to support multi-source dashboards.
  */
 export declare function attachDataSourceToPanels(panels: Panel[], dataSource: JaqlDataSource): Panel[];
-export declare function extractDataOptions(widgetType: WidgetType, panels: Panel[], style: WidgetStyle, customPaletteColors?: Color[]): WidgetDataOptions;
+export declare function extractDataOptions(fusionWidgetType: FusionWidgetType, panels: Panel[], style: WidgetStyle, customPaletteColors?: Color[]): WidgetDataOptions;

package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-drilldown-options.d.ts

@@ -1,3 +1,3 @@
-import { Panel, PanelItem, WidgetType } from './types.js';
+import { Panel, PanelItem, FusionWidgetType } from './types.js';
 import { DrilldownOptions } from '../types.js';
-export declare const extractDrilldownOptions: (widgetType: WidgetType, panels: Panel[], drillHistory?: PanelItem[], enableDrillToAnywhere?: boolean) => DrilldownOptions;
+export declare const extractDrilldownOptions: (widgetType: FusionWidgetType, panels: Panel[], drillHistory?: PanelItem[], enableDrillToAnywhere?: boolean) => DrilldownOptions;

package/dist/packages/sdk-ui/src/widget-by-id/translate-widget-style-options.d.ts

@@ -1,9 +1,9 @@
 import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions, SpaceSizes, RadiusSizes, ShadowsTypes, AlignmentTypes, WidgetStyleOptions, TextWidgetStyleOptions } from '../types';
-import { WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle, WidgetDesign, WidgetDto } from './types';
+import { WidgetSubtype, FusionWidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle, WidgetDesign, WidgetDto } from './types';
 export declare function extractTableChartStyleOptions(widgetStyle: TableWidgetStyle): TableStyleOptions;
 export declare const getIndicatorTypeSpecificOptions: (widgetSubtype: WidgetSubtype, widgetStyle: IndicatorWidgetStyle) => NumericSimpleIndicatorStyleOptions | NumericBarIndicatorStyleOptions | GaugeIndicatorStyleOptions;
 export declare function extractPivotTableStyleOptions(widgetStyle: PivotWidgetStyle): PivotTableStyleOptions;
-export declare function extractStyleOptions<WType extends WidgetType>(widgetType: WType, widget: WidgetDto): ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions;
+export declare function extractStyleOptions<WType extends FusionWidgetType>(widgetType: WType, widget: WidgetDto): ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions;
 export declare const getFlattenWidgetDesign: (widgetDesign: WidgetDesign) => {
     backgroundColor: string;
     spaceAround: SpaceSizes;

package/dist/packages/sdk-ui/src/widget-by-id/types.d.ts

@@ -21,7 +21,7 @@ export type TextWidgetType = 'richtexteditor';
 /**
  * The type of a widget on a dashboard.
  */
-export type WidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area' | TextWidgetType | 'plugin';
+export type FusionWidgetType = CartesianWidgetType | CategoricalWidgetType | 'chart/scatter' | 'indicator' | TabularWidgetType | 'chart/boxplot' | 'map/scatter' | 'map/area' | TextWidgetType | 'plugin';
 export type WidgetSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'area/spline' | 'area/stackedspline' | 'area/stackedspline100' | 'bar/classic' | 'bar/stacked' | 'bar/stacked100' | 'column/classic' | 'column/stackedcolumn' | 'column/stackedcolumn100' | 'line/basic' | 'line/spline' | 'pie/classic' | 'pie/donut' | 'pie/ring' | 'column/polar' | 'area/polar' | 'line/polar' | 'indicator/numeric' | 'indicator/gauge' | 'bubble/scatter' | 'treemap' | 'sunburst' | 'boxplot/full' | 'boxplot/hollow' | 'map/scatter' | 'areamap/world' | 'areamap/usa' | 'richtexteditor';
 export declare enum WidgetDashboardFilterMode {
     FILTER = "filter",
@@ -37,7 +37,7 @@ export declare enum WidgetDashboardFilterMode {
  */
 export interface WidgetDto {
     oid: string;
-    type: WidgetType | string;
+    type: FusionWidgetType;
     subtype: WidgetSubtype | string;
     datasource: JaqlDataSource;
     metadata: {

package/dist/packages/sdk-ui/src/widget-by-id/utils.d.ts

@@ -1,25 +1,32 @@
 import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options.js';
-import { ChartType } from '../types.js';
-import { Panel, PanelItem, TextWidgetDtoStyle, WidgetStyle, WidgetSubtype, WidgetType } from './types.js';
-import { ChartProps, ChartWidgetProps, PivotTableWidgetProps, PluginWidgetProps, RenderToolbarHandler, TextWidgetProps, CommonWidgetProps, WithWidgetType, WidgetProps } from '../index.js';
+import { ChartType, RenderToolbarHandler } from '../types.js';
+import { Panel, PanelItem, TextWidgetDtoStyle, WidgetStyle, WidgetSubtype, FusionWidgetType } from './types.js';
+import { ChartProps, ChartWidgetProps, PivotTableWidgetProps, PluginWidgetProps, TextWidgetProps, CommonWidgetProps, WithCommonWidgetProps, WidgetProps, WidgetType } from '../props';
 import { WidgetTypeInternal } from '../models/widget/types';
+import { WidgetModel } from '../models';
 export { mergeFilters, getFilterRelationsFromJaql, convertFilterRelationsModelToJaql, getFilterCompareId, } from '@sisense/sdk-data';
 /**
  * Returns the corresponding chart type for a given widget type
  *
  * @internal
  */
-export declare function getChartType(widgetType: WidgetType): ChartType;
-export declare function getWidgetTypeFromChartType(chartType: ChartType): WidgetType;
+export declare function getChartType(fusionWidgetType: FusionWidgetType): ChartType;
+export declare function getFusionWidgetTypeFromChartType(chartType: ChartType): FusionWidgetType;
+export declare function getFusionWidgetType(widgetType: WidgetType, chartType?: ChartType): FusionWidgetType;
+export declare function getWidgetType(fusionWidgetType: FusionWidgetType): WidgetType;
 export declare function getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
-type WidgetTypeOrString = string | WidgetType;
-export declare function isSupportedWidgetType(widgetType: WidgetTypeOrString): widgetType is WidgetType;
-export declare function isTableWidget(widgetType: WidgetTypeOrString): boolean;
-export declare function isPivotTableWidget(widgetType: WidgetTypeOrString): boolean;
-export declare function isTextWidget(widgetType: WidgetTypeOrString): boolean;
+export declare function isSupportedWidgetType(fusionWidgetType: FusionWidgetType): fusionWidgetType is FusionWidgetType;
+export declare function isTableFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isTableWidgetModel(widgetModel: WidgetModel): boolean;
+export declare function isPivotTableFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isPivotWidget(widgetType: WidgetType): boolean;
+export declare function isTextFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isTextWidget(widgetType: WidgetType): boolean;
 export declare function isTextWidgetDtoStyle(widgetStyle: WidgetStyle): widgetStyle is TextWidgetDtoStyle;
-export declare function isPluginWidget(widgetType: WidgetTypeOrString): boolean;
-export declare function isChartWidget(widgetType: WidgetTypeOrString): boolean;
+export declare function isPluginFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isPluginWidget(widgetType: WidgetType): boolean;
+export declare function isChartFusionWidget(fusionWidgetType: FusionWidgetType): boolean;
+export declare function isChartWidget(widgetType: WidgetType): boolean;
 /**
  * Type guard for checking if the widget props is for a text widget.
  *
@@ -27,7 +34,7 @@ export declare function isChartWidget(widgetType: WidgetTypeOrString): boolean;
  * @returns whether the widget props is for a text widget
  * @internal
  */
-export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<TextWidgetProps, 'text'>;
+export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<TextWidgetProps, 'text'>;
 /**
  * Type guard for checking if the widget props is for a pivot table widget.
  *
@@ -35,7 +42,7 @@ export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widge
  * @returns whether the widget props is for a pivot table widget
  * @internal
  */
-export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<PivotTableWidgetProps, 'pivot'>;
+export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<PivotTableWidgetProps, 'pivot'>;
 /**
  * Type guard for checking if the widget props is for a plugin widget
  *
@@ -43,7 +50,7 @@ export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps):
  * @returns whether the widget props is for a plugin widget
  * @internal
  */
-export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<PluginWidgetProps, 'plugin'>;
+export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<PluginWidgetProps, 'plugin'>;
 /**
  * Type guard for checking if the widget props is for a chart widget
  *
@@ -51,7 +58,7 @@ export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): wid
  * @returns whether the widget props is for a chart widget
  * @internal
  */
-export declare function isChartWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<ChartWidgetProps, 'chart'>;
+export declare function isChartWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithCommonWidgetProps<ChartWidgetProps, 'chart'>;
 export declare function getInternalWidgetType(widgetProps: CommonWidgetProps): WidgetTypeInternal;
 /**
  * Registers new "onDataPointClick" handler for the Widget component

package/dist/packages/sdk-ui/src/widgets/widget.d.ts

@@ -4,6 +4,5 @@ import { WidgetProps } from '..';
  * Facade component that renders a widget within a dashboard based on the widget type.
  *
  * @group Dashboards
- * @alpha
  */
 export declare const Widget: React.FC<WidgetProps>;