@sisense/sdk-ui 1.22.0 → 1.24.0

package/dist/packages/sdk-ui/src/{dashboard-widget → widget-by-id}/types.d.ts

@@ -1,5 +1,5 @@
 import { WidgetContainerStyleOptions } from '../types';
-import { LEGACY_DESIGN_TYPES } from './../themes/legacy-design-settings';
+import { LEGACY_DESIGN_TYPES } from '../themes/legacy-design-settings';
 import { BaseJaql, Jaql, JaqlDataSource, JaqlSortDirection } from '@sisense/sdk-data';
 import { HierarchyId } from '../models/hierarchy';
 /**

package/dist/packages/sdk-ui/src/{dashboard-widget → widget-by-id}/use-fetch-widget-dto-model.d.ts

@@ -1,6 +1,6 @@
-import { RestApi } from '../api/rest-api';
-import { DashboardDto } from '../api/types/dashboard-dto';
-import { WidgetDto } from './types';
+import { RestApi } from '../api/rest-api.js';
+import { DashboardDto } from '../api/types/dashboard-dto.js';
+import { WidgetDto } from './types.js';
 /**
  * Fetches a Widget DTO model and, optionally, a Dashboard DTO model.
  *

package/dist/packages/sdk-ui/src/{dashboard-widget → widget-by-id}/utils.d.ts

@@ -1,9 +1,14 @@
-import { type Filter, JaqlSortDirection, FilterRelations, FilterRelationsModel, FilterRelationsJaql } from '@sisense/sdk-data';
-import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options';
-import { ChartType, type SortDirection } from '../types';
-import { FiltersMergeStrategy, Panel, PanelItem, TextWidgetDtoStyle, WidgetStyle, WidgetSubtype, WidgetType } from './types';
-import { ChartProps, ChartWidgetProps, PivotTableWidgetProps, PluginWidgetProps, RenderToolbarHandler, TextWidgetProps, CommonWidgetProps, WithWidgetType, WidgetProps } from '..';
+import { type Filter, FilterRelations, FilterRelationsModel, FilterRelationsJaql } from '@sisense/sdk-data';
+import { ChartSubtype } from '../chart-options-processor/subtype-to-design-options.js';
+import { ChartType } from '../types.js';
+import { FiltersMergeStrategy, Panel, PanelItem, TextWidgetDtoStyle, WidgetStyle, WidgetSubtype, WidgetType } from './types.js';
+import { ChartProps, ChartWidgetProps, PivotTableWidgetProps, PluginWidgetProps, RenderToolbarHandler, TextWidgetProps, CommonWidgetProps, WithWidgetType, WidgetProps } from '../index.js';
 import { WidgetTypeInternal } from '../models/widget/types';
+/**
+ * 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 getChartSubtype(widgetSubtype: WidgetSubtype): ChartSubtype | undefined;
@@ -20,6 +25,7 @@ export declare function isChartWidget(widgetType: WidgetTypeOrString): boolean;
  *
  * @param widgetProps - The widget props to check.
  * @returns whether the widget props is for a text widget
+ * @internal
  */
 export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<TextWidgetProps, 'text'>;
 /**
@@ -27,6 +33,7 @@ export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widge
  *
  * @param widgetProps - The widget props to check.
  * @returns whether the widget props is for a pivot table widget
+ * @internal
  */
 export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<PivotTableWidgetProps, 'pivot'>;
 /**
@@ -34,6 +41,7 @@ export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps):
  *
  * @param widgetProps - The widget props to check.
  * @returns whether the widget props is for a plugin widget
+ * @internal
  */
 export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<PluginWidgetProps, 'plugin'>;
 /**
@@ -41,6 +49,7 @@ export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): wid
  *
  * @param widgetProps - The widget props to check.
  * @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 translateWidgetTypeInternal(widgetProps: CommonWidgetProps): WidgetTypeInternal;
@@ -70,14 +79,6 @@ export declare function registerDataPointsSelectedHandler(widgetProps: WidgetPro
 export declare function registerRenderToolbarHandler(widgetProps: WidgetProps, handler: RenderToolbarHandler): void;
 export declare function getEnabledPanelItems(panels: Panel[], panelName: string): PanelItem[];
 export declare function getRootPanelItem(item: PanelItem): PanelItem;
-/**
- * Gets the sort type based on the jaql sort direction.
- *
- * @param jaqlSort - The jaql sort direction.
- * @returns  The sort direction.
- * @internal
- */
-export declare function getSortType(jaqlSort: `${JaqlSortDirection}` | undefined): SortDirection;
 /**
  * Gets a unique identifier for a filter, combining its attribute expression and granularity if available.
  *

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

@@ -0,0 +1,26 @@
+import { type FunctionComponent } from 'react';
+import { WidgetByIdProps } from '../props.js';
+/**
+ * The WidgetById component, which is a thin wrapper on the {@link ChartWidget} component,
+ * is used to render a widget created in a Sisense Fusion instance.
+ *
+ * To learn more about using Sisense Fusion Widgets in Compose SDK,
+ * see [Sisense Fusion Widgets](/guides/sdk/guides/charts/guide-fusion-widgets.html).
+ *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
+ * ## Example
+ *
+ * Display two dashboard widgets from a Fusion instance.
+ *
+ * <iframe
+ *  src='https://csdk-playground.sisense.com/?example=fusion-assets%2Ffusion-widgets&mode=docs'
+ *  width=800
+ *  height=870
+ *  style='border:none;'
+ * />
+ *
+ * @group Fusion Assets
+ * @fusionEmbed
+ */
+export declare const WidgetById: FunctionComponent<WidgetByIdProps>;

package/dist/packages/sdk-ui/src/widgets/common/use-drilldown-core.d.ts

@@ -18,6 +18,13 @@ export declare const useDrilldownCore: (params: UseDrilldownCoreParams) => {
     sliceDrilldownSelections: (i: number) => void;
     clearDrilldownSelections: () => void;
 };
+/**
+ * Updates the drilldown selections based on the current selections, the next data points,
+ * and the specified hierarchy level.
+ *
+ * @internal
+ */
+export declare const updateDrilldownSelections: (currentSelections: DrilldownSelection[], points: DataPoint[], nextDimension: Attribute, hierarchy?: Hierarchy) => DrilldownSelection[];
 /**
  * @internal
  */

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

@@ -12,4 +12,6 @@ interface WidgetContainerProps {
 }
 /** @internal */
 export declare const WidgetContainer: React.FC<WidgetContainerProps>;
+/** @internal */
+export declare const RawWidgetContainer: React.FC<WidgetContainerProps>;
 export {};

package/dist/packages/sdk-ui/src/widgets/common/widget-errors-and-warnings-context.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+interface WidgetErrorsAndWarnings {
+    errors: string[];
+    warnings: string[];
+    setErrors: React.Dispatch<React.SetStateAction<string[]>>;
+    setWarnings: React.Dispatch<React.SetStateAction<string[]>>;
+    clearError: () => void;
+    clearWarning: () => void;
+}
+export declare const WidgetErrorsAndWarningsProvider: React.FC<{
+    children: React.ReactNode;
+}>;
+export declare const useWidgetErrorsAndWarnings: () => WidgetErrorsAndWarnings;
+export {};

package/dist/packages/sdk-ui/src/widgets/common/widget-header-info-button.d.ts

@@ -1,7 +1,9 @@
 import { WidgetContainerStyleOptions } from '../../types';
-export default function WidgetHeaderInfoButton({ title, description, styleOptions, onRefresh, }: {
+export default function WidgetHeaderInfoButton({ title, description, errorMessages, styleOptions, onRefresh, }: {
     title?: string;
     description?: string;
     styleOptions?: WidgetContainerStyleOptions['header'];
+    errorMessages?: string[];
+    warningMessages?: string[];
     onRefresh: () => void;
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -5,6 +5,8 @@ interface WidgetHeaderProps {
     title?: string;
     description?: string;
     dataSetName?: string;
+    errorMessages?: string[];
+    warningMessages?: string[];
     styleOptions?: WidgetContainerStyleOptions['header'];
 }
 export declare const WidgetHeader: React.FC<WidgetHeaderProps>;

package/dist/packages/sdk-ui/src/widgets/hooks/use-drilldown.d.ts

@@ -20,6 +20,8 @@ export declare const useDrilldown: ({ initialDimension, drilldownPaths, drilldow
     breadcrumbs: import("react/jsx-runtime").JSX.Element;
     openDrilldownMenu: (position: MenuPosition, points: DataPoint[]) => void;
 };
+/** @internal */
 export declare function getSelectionTitleMenuItem(points: DataPoint[], drilldownDimension: Attribute): MenuItemSection;
+/** @internal */
 export declare function getDrilldownMenuItems(availableDrilldownPaths: (Attribute | Hierarchy)[], drilldownDimension: Attribute, selectFn: (nextDimension: Attribute, hierarchy?: Hierarchy) => void, translate: TFunction): MenuItemSection;
 export {};