@sisense/sdk-ui 1.23.0 → 1.25.0

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

@@ -1,8 +1,8 @@
-import { DimensionalBaseMeasure, DimensionalAttribute, DimensionalCalculatedMeasure, Jaql, JaqlDataSource, Filter } from '@sisense/sdk-data';
+import { DimensionalBaseMeasure, DimensionalAttribute, DimensionalCalculatedMeasure, Jaql, JaqlDataSource } from '@sisense/sdk-data';
 import { StyledMeasureColumn, StyledColumn, Color } from '../types.js';
 import { Panel, PanelItem, WidgetType, WidgetStyle, BoxplotWidgetStyle } from './types.js';
 import { WidgetDataOptions } from '../models/index.js';
-export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): Filter | DimensionalAttribute | DimensionalCalculatedMeasure | DimensionalBaseMeasure;
+export declare function createDimensionalElementFromJaql(jaql: Jaql, format?: PanelItem['format']): import("@sisense/sdk-data").Filter | DimensionalAttribute | DimensionalCalculatedMeasure | DimensionalBaseMeasure;
 /** @internal */
 export declare function applyStatisticalModels(dataOption: StyledMeasureColumn, statisticalModels?: {
     forecast?: {

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

@@ -1,4 +1,4 @@
-import { FilterJaql, IncludeAllFilter, IncludeMembersFilter } from '@sisense/sdk-data';
+import { FilterJaql, IncludeAllFilterJaql, IncludeMembersFilterJaql } from '@sisense/sdk-data';
 import { Panel } from './types.js';
 /**
  * Extracts filter model components from a FilterJaql object.
@@ -642,17 +642,17 @@ export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
         doesntStartWith?: undefined;
         doesntEndWith?: undefined;
     } | {
-        and: (import("@sisense/sdk-data").JaqlNumericFilter | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql)[];
+        and: (import("@sisense/sdk-data").NumericFilterJaql | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql)[];
     } | {
-        or: (import("@sisense/sdk-data").JaqlNumericFilter | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql)[];
+        or: (import("@sisense/sdk-data").NumericFilterJaql | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql)[];
     };
-    backgroundFilter: (IncludeAllFilter & {
+    backgroundFilter: (IncludeAllFilterJaql & {
         level?: "string" | undefined;
-    }) | (IncludeMembersFilter & {
+    }) | (IncludeMembersFilterJaql & {
         level?: "string" | undefined;
-    }) | (import("@sisense/sdk-data").ExcludeMembersFilter & {
+    }) | (import("@sisense/sdk-data").ExcludeMembersFilterJaql & {
         level?: "string" | undefined;
-    }) | (import("@sisense/sdk-data").JaqlNumericFilter & {
+    }) | (import("@sisense/sdk-data").NumericFilterJaql & {
         level?: "string" | undefined;
     }) | (Pick<import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaqlOptions, "filter" | "custom" | "filterType" | "members" | "by" | "multiSelection" | "isNotCurrentPeriod" | "isAdvanced" | "rankingMessage" | "isBetween" | "isEmpty" | "explicit" | "isCondition"> & Required<Pick<import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaqlOptions, "endsWith">> & Partial<Record<"startsWith" | "top" | "bottom" | "contains" | "or" | "and" | "from" | "to" | "last" | "next" | "exclude" | "equals" | "doesntEqual" | "toNotEqual" | "fromNotEqual" | "doesntStartWith" | "doesntEndWith" | "doesntContain", undefined>> & {
         level?: "string" | undefined;
@@ -689,39 +689,39 @@ export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
     }) | (Pick<import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaqlOptions, "filter" | "custom" | "filterType" | "members" | "by" | "multiSelection" | "isNotCurrentPeriod" | "isAdvanced" | "rankingMessage" | "isBetween" | "isEmpty" | "explicit" | "isCondition"> & Required<Pick<import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaqlOptions, "doesntContain">> & Partial<Record<"endsWith" | "startsWith" | "top" | "bottom" | "contains" | "or" | "and" | "from" | "to" | "last" | "next" | "exclude" | "equals" | "doesntEqual" | "toNotEqual" | "fromNotEqual" | "doesntStartWith" | "doesntEndWith", undefined>> & {
         level?: "string" | undefined;
     }) | ({
-        and: (import("@sisense/sdk-data").JaqlNumericFilter | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql)[];
+        and: (import("@sisense/sdk-data").NumericFilterJaql | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql)[];
     } & {
         level?: "string" | undefined;
-    }) | (import("@sisense/sdk-data").OrFilter<import("@sisense/sdk-data").JaqlNumericFilter | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql> & {
+    }) | (import("@sisense/sdk-data").OrFilterJaql<import("@sisense/sdk-data").NumericFilterJaql | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql> & {
         level?: "string" | undefined;
-    }) | import("@sisense/sdk-data").TurnOffMembersFilter | undefined;
-    turnOffMembersFilter: import("@sisense/sdk-data").TurnOffMembersFilter | ({
+    }) | import("@sisense/sdk-data").TurnOffMembersFilterJaql | undefined;
+    turnOffMembersFilter: import("@sisense/sdk-data").TurnOffMembersFilterJaql | ({
         turnedOff?: boolean | undefined;
         exclude?: {
             members?: string[] | undefined;
         } | undefined;
-    } & IncludeAllFilter & {
+    } & IncludeAllFilterJaql & {
         level?: "string" | undefined;
     }) | ({
         turnedOff?: boolean | undefined;
         exclude?: {
             members?: string[] | undefined;
         } | undefined;
-    } & IncludeMembersFilter & {
+    } & IncludeMembersFilterJaql & {
         level?: "string" | undefined;
     }) | ({
         turnedOff?: boolean | undefined;
         exclude?: {
             members?: string[] | undefined;
         } | undefined;
-    } & import("@sisense/sdk-data").ExcludeMembersFilter & {
+    } & import("@sisense/sdk-data").ExcludeMembersFilterJaql & {
         level?: "string" | undefined;
     }) | ({
         turnedOff?: boolean | undefined;
         exclude?: {
             members?: string[] | undefined;
         } | undefined;
-    } & import("@sisense/sdk-data").JaqlNumericFilter & {
+    } & import("@sisense/sdk-data").NumericFilterJaql & {
         level?: "string" | undefined;
     }) | ({
         turnedOff?: boolean | undefined;
@@ -848,7 +848,7 @@ export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
             members?: string[] | undefined;
         } | undefined;
     } & {
-        and: (import("@sisense/sdk-data").JaqlNumericFilter | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql)[];
+        and: (import("@sisense/sdk-data").NumericFilterJaql | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql)[];
     } & {
         level?: "string" | undefined;
     }) | ({
@@ -856,7 +856,7 @@ export declare function extractFilterModelFromJaql(jaql: FilterJaql): {
         exclude?: {
             members?: string[] | undefined;
         } | undefined;
-    } & import("@sisense/sdk-data").OrFilter<import("@sisense/sdk-data").JaqlNumericFilter | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql> & {
+    } & import("@sisense/sdk-data").OrFilterJaql<import("@sisense/sdk-data").NumericFilterJaql | import("@sisense/sdk-data/dist/dimensional-model/filters/utils/types.js").ConditionFilterJaql> & {
         level?: "string" | undefined;
     }) | undefined;
 };

package/dist/packages/sdk-ui/src/widget-by-id/use-get-dashboard-model-and-widget-model.d.ts

@@ -0,0 +1,13 @@
+import { DashboardModel, WidgetModel } from '../models';
+/**
+ * Custom hook for fetching a dashboard model and a widget model.
+ * @returns
+ */
+export declare function useGetDashboardModelAndWidgetModel({ widgetOid, dashboardOid, shouldLoadFullDashboard, }: {
+    widgetOid: string;
+    dashboardOid: string;
+    shouldLoadFullDashboard?: boolean;
+}): {
+    dashboardModel: DashboardModel | null;
+    widgetModel: WidgetModel | null;
+};

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

@@ -1,9 +1,14 @@
-import { type Filter, FilterRelations, FilterRelationsModel, FilterRelationsJaql } from '@sisense/sdk-data';
+import { type Filter, FilterRelations, FilterRelationsModelNode, 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,9 +49,10 @@ 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;
+export declare function getInternalWidgetType(widgetProps: CommonWidgetProps): WidgetTypeInternal;
 /**
  * Registers new "onDataPointClick" handler for the Widget component
  *
@@ -97,7 +106,7 @@ export declare function mergeFilters(sourceFilters?: Filter[], targetFilters?: F
  * @param {FiltersMergeStrategy} [mergeStrategy] - The strategy to use for merging filters.
  * @returns {Filter[]} The merged filters based on the selected strategy.
  */
-export declare function mergeFiltersByStrategy(widgetFilters?: Filter[], codeFilters?: Filter[], mergeStrategy?: FiltersMergeStrategy): Filter[];
+export declare function mergeFiltersByStrategy(widgetFilters?: Filter[] | FilterRelations, codeFilters?: Filter[] | FilterRelations, mergeStrategy?: FiltersMergeStrategy): Filter[] | FilterRelations;
 /**
  * Replaces nodes of filter reations tree with fetched filters by instance id.
  *
@@ -113,7 +122,7 @@ export declare function getFilterRelationsFromJaql(filters: Filter[], highlights
  * @param filterRelations - Filter relations model.
  * @returns {FilterRelationsJaql} Filter relations jaql.
  */
-export declare function convertFilterRelationsModelToJaql(filterRelations: FilterRelationsModel | undefined): FilterRelationsJaql | undefined;
+export declare function convertFilterRelationsModelToJaql(filterRelations: FilterRelationsModel | FilterRelationsModelNode | undefined): FilterRelationsJaql | undefined;
 /**
  * Replaces filters for same dimensions in filter relations jaql.
  * Widget filters have higher priority than dashboard filters.

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>;