@sisense/sdk-ui 1.24.0 → 1.26.0

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/types.d.ts

@@ -1,6 +1,6 @@
 import { WidgetContainerStyleOptions } from '../types';
 import { LEGACY_DESIGN_TYPES } from '../themes/legacy-design-settings';
-import { BaseJaql, Jaql, JaqlDataSource, JaqlSortDirection } from '@sisense/sdk-data';
+import { BaseJaql, FormulaContext, FormulaJaql, Jaql, JaqlDataSource, JaqlSortDirection } from '@sisense/sdk-data';
 import { HierarchyId } from '../models/hierarchy';
 /**
  * The type of a widget on a dashboard that is a variant of Cartesian widget.
@@ -221,7 +221,7 @@ export type PanelItem = {
         width?: number;
         colorIndex?: number;
     };
-    jaql: Jaql;
+    jaql: WidgetJaql;
     disabled?: boolean;
     y2?: boolean;
     parent?: PanelItem;
@@ -238,6 +238,18 @@ export type PanelItem = {
     panel?: string;
     hierarchies?: HierarchyId[];
 };
+type WidgetJaql = Jaql | SharedFormulaJaql;
+export declare function isJaqlWithFormula(jaql: WidgetJaql): jaql is FormulaJaql | SharedFormulaJaql;
+type SharedFormulaJaql = FormulaJaql & {
+    context?: Record<string, FormulaContext | SharedFormulaReferenceContext> | undefined;
+};
+export type SharedFormulaDto = FormulaJaql & {
+    oid: string;
+};
+export type SharedFormulaReferenceContext = {
+    formulaRef: string;
+};
+export declare function isSharedFormulaReferenceContext(context: FormulaContext | SharedFormulaReferenceContext): context is SharedFormulaReferenceContext;
 export type PanelColorFormat = PanelColorFormatSingle | PanelColorFormatRange | PanelColorFormatConditional;
 export type PanelMembersFormat = Record<string, {
     color: string;

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,4 +1,4 @@
-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';
@@ -52,7 +52,7 @@ export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): wid
  * @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
  *
@@ -106,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.
  *
@@ -122,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.