@sisense/sdk-ui 2.23.0 → 2.25.0

package/dist/packages/sdk-ui/src/modules/ai/use-get-nlg-insights.d.ts

@@ -1,27 +1,7 @@
-import { Attribute, DataSource, Filter, FilterRelations, Measure } from '@sisense/sdk-data';
-import { GetNlgInsightsRequest } from './api/types.js';
-import { GetNlgInsightsProps } from './get-nlg-insights.js';
-/**
- * Parameters for {@link useGetNlgInsights} hook.
- */
-export interface UseGetNlgInsightsParams {
-    /** The data source that the query targets - e.g. `Sample ECommerce` */
-    dataSource: DataSource;
-    /** Dimensions of the query */
-    dimensions?: Attribute[];
-    /** Measures of the query */
-    measures?: Measure[];
-    /** Filters of the query */
-    filters?: Filter[] | FilterRelations;
-    /**
-     * Boolean flag to enable/disable API call by default
-     *
-     * If not specified, the default value is `true`
-     */
-    enabled?: boolean;
-    /** The verbosity of the NLG summarization */
-    verbosity?: 'Low' | 'High';
-}
+import { prepareGetNlgInsightsPayload, type UseGetNlgInsightsParams } from '../../domains/narrative/core/build-narrative-request.js';
+import type { GetNlgInsightsRequest } from '../../infra/api/narrative/narrative-api-types.js';
+import type { GetNlgInsightsProps } from './get-nlg-insights.js';
+export { prepareGetNlgInsightsPayload, type UseGetNlgInsightsParams };
 /**
  * State for {@link useGetNlgInsights} hook.
  */
@@ -39,8 +19,6 @@ export interface UseGetNlgInsightsState {
     /** Callback to trigger a refetch of the data */
     refetch: () => void;
 }
-/** @internal */
-export declare function prepareGetNlgInsightsPayload(params: UseGetNlgInsightsParams | GetNlgInsightsRequest): GetNlgInsightsRequest;
 /**
  *
  * @param params - {@link UseGetNlgInsightsParams}

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/expression/custom-formula/validate-custom-formula.d.ts

@@ -15,7 +15,7 @@ export interface FormulaValidationOptions {
     allowEmptyFormula?: boolean;
     /** Custom error message prefix for better context */
     errorPrefix?: string;
-    /** When provided, time-diff args are validated as datetime dimensions and level-matched */
+    /** When provided, xdiff args are validated as datetime dimensions and level-matched */
     schemaIndex?: SchemaIndex;
 }
 export interface TimeDiffCall {
@@ -24,10 +24,22 @@ export interface TimeDiffCall {
     ref2: string;
 }
 /**
- * Extracts time-diff (or other two-arg bracket) calls from a formula string.
+ * Extracts xdiff (or other two-arg bracket) calls from a formula string.
  * Matches FUNC([ref1], [ref2]) for each function name in the set (case-insensitive).
  */
-export declare function parseTimeDiffCalls(formula: string, functionNames: readonly string[]): TimeDiffCall[];
+export declare function parseXDiffCalls(formula: string, functionNames: readonly string[]): TimeDiffCall[];
+export interface FormulaParenCall {
+    readonly name: string;
+    readonly argCount: number;
+}
+/**
+ * Finds all `IDENT(` calls in a formula, outside quoted strings, with comma-separated arg counts
+ * (nesting-aware, same rules as {@link splitAtDepthZero}). Recurses into argument lists so nested
+ * calls (e.g. `SUM(MAX([a]))`) are included.
+ *
+ * @internal Exported for unit tests
+ */
+export declare function extractParenFunctionCalls(formula: string): FormulaParenCall[];
 /**
  * Validates that all bracket references in a custom formula exist in the provided context
  * and provides helpful error messages for debugging.

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/expression/formula-function-schemas.d.ts

@@ -1,25 +1,41 @@
 /** Category of formula function for validation and translation. */
-export type FormulaFunctionCategory = 'time-diff' | 'aggregative' | 'math' | 'growth' | 'date';
+export type FormulaFunctionCategory = 'xdiff' | 'aggregative' | 'math' | 'growth' | 'date' | 'window' | 'string' | 'scalar';
 /** Metadata for a formula function (e.g. DDIFF, SUM). */
 export interface FormulaFunctionMeta {
     category: FormulaFunctionCategory;
-    argCount: number;
-    /** Required date level for time-diff functions (e.g. DateLevels.Days for DDIFF). */
+    /** Inclusive minimum number of parenthesized arguments. */
+    minArgs: number;
+    /** Inclusive maximum number of parenthesized arguments; use Infinity for unbounded (e.g. concat). */
+    maxArgs: number;
+    /** Required date level for xdiff functions (e.g. DateLevels.Days for DDIFF). */
     requiredDateLevel?: string;
     /** Argument type constraint; 'datetime' means args must be datetime dimensions. */
     argType?: 'datetime';
 }
+/**
+ * Formula functions explicitly not supported in custom formulas (engine may expose them elsewhere).
+ * Keys are uppercase for lookup.
+ */
+export declare const UNSUPPORTED_FORMULA_FUNCTIONS: ReadonlySet<string>;
 /** Registry keyed by formula function name (uppercase). */
 export declare const FORMULA_FUNCTION_SCHEMAS: Record<string, FormulaFunctionMeta>;
 /**
- * Returns formula function names that are time-diff (SDIFF, MNDIFF, HDIFF, DDIFF, MDIFF, QDIFF, YDIFF).
+ * Returns inclusive arg bounds for a known formula function, or undefined if not in the registry.
+ */
+export declare function getFormulaFunctionArgBounds(formulaFunctionName: string): Pick<FormulaFunctionMeta, 'minArgs' | 'maxArgs'> | undefined;
+/**
+ * Returns formula function names that are xdiff (SDIFF, MNDIFF, HDIFF, DDIFF, MDIFF, QDIFF, YDIFF).
  */
-export declare function getTimeDiffFormulaFunctions(): readonly string[];
+export declare function getXDiffFormulaFunctions(): readonly string[];
 /**
- * Returns the required date level for a time-diff function, or undefined if not a time-diff function.
+ * Returns the required date level for an xdiff function, or undefined if not an xdiff function.
  */
 export declare function getRequiredDateLevel(formulaFunctionName: string): string | undefined;
 /**
  * Returns formula function names for a given category.
  */
 export declare function getFormulaFunctionsByCategory(category: FormulaFunctionCategory): readonly string[];
+/**
+ * Human-readable arity text for validation errors (e.g. "1 or 2 parameters", "at least 2 parameters").
+ */
+export declare function formatFormulaFunctionArityMessage(minArgs: number, maxArgs: number): string;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/shared/utils/schema-index.d.ts

@@ -28,7 +28,10 @@ export interface SchemaIndex {
  */
 export declare function createSchemaIndex(tables: NormalizedTable[]): SchemaIndex;
 /**
- * Parses a dimensional name using schema-aware greedy matching to handle dots in table/column names
+ * Parses a dimensional name using schema-aware greedy matching to handle dots in table/column names.
+ * Table and column segments are matched case-insensitively against the schema; returned table/column
+ * objects keep canonical names and expressions. Date level suffixes are case-sensitive.
+ * If two tables share the same name ignoring case, the first match in {@link SchemaIndex.sortedTables} wins.
  *
  * @param dimensionalName - The dimensional name (e.g., "DM.Brand.io.Brand" or "DM.Commerce.Date.Years")
  * @param schemaIndex - The schema index for efficient matching
@@ -42,7 +45,7 @@ export declare function parseDimensionalName(dimensionalName: string, schemaInde
 };
 /** Options for {@link createAttributeFromName} when translating custom formula context. */
 export interface CreateAttributeFromNameOptions {
-    /** When the dimensional name has no date level, use this level for datetime columns (e.g. from time-diff function). */
+    /** When the dimensional name has no date level, use this level for datetime columns (e.g. from xdiff function). */
     inferredDateLevel?: string;
 }
 export declare function createAttributeFromName(attributeName: string, dataSource: JaqlDataSourceForDto, schemaIndex: SchemaIndex, options?: CreateAttributeFromNameOptions): import("@sisense/sdk-data").Attribute | import("@sisense/sdk-data").LevelAttribute;

package/dist/packages/sdk-ui/src/modules/analytics-composer/nlq-v3-translator/types.d.ts

@@ -1,4 +1,4 @@
-import { Attribute, Filter, FilterRelations, JaqlDataSourceForDto, JSONArray, Measure, PivotGrandTotals } from '@sisense/sdk-data';
+import { type Arg, type ArgValue, Attribute, Filter, FilterRelations, type FunctionCall, JaqlDataSourceForDto, JSONArray, Measure, PivotGrandTotals } from '@sisense/sdk-data';
 import { CategoryStyle, SeriesStyle, ValueStyle } from '../../../public-api/index.js';
 import type { PivotTableStyleOptions } from '../../../types.js';
 import { DataSchemaContext, NlqTranslationInput } from '../types.js';
@@ -16,20 +16,16 @@ export interface InternalDataSchemaContext {
     chartType?: string;
 }
 export declare const DIMENSIONAL_NAME_PREFIX = "DM.";
+/** Re-exported from `@sisense/sdk-data` (compose-code parse tree). */
+export type { Arg, ArgValue, FunctionCall };
 export type ArgType = 'string' | 'string[]' | 'number' | 'number[]' | 'boolean' | 'Attribute' | 'Attribute[]' | 'Measure' | 'BaseMeasure' | 'Measure[]' | 'Filter' | 'Filter[]' | 'FilterRelationsNode' | 'DateDimension' | 'LevelAttribute' | 'Measure | number' | 'Date | string' | 'string | number' | 'BaseFilterConfig' | 'MembersFilterConfig' | 'CustomFormulaContext' | 'any';
 export interface ArgSchema {
     type: ArgType;
     required: boolean;
 }
-export type ArgValue = string | number | boolean | FunctionCall | string[];
-export type Arg = ArgValue | Record<string, ArgValue>;
 export type ProcessedArg = unknown;
 export type QueryElement = Filter | FilterRelations | Measure;
 export type FactoryFunction = (...args: unknown[]) => QueryElement;
-export type FunctionCall = {
-    function: string;
-    args: Arg[];
-};
 /**
  * Context object passed to all custom processors containing runtime information
  * needed for processing.

package/dist/packages/sdk-ui/src/props.d.ts

@@ -9,7 +9,7 @@ import { HighchartsOptions } from './domains/visualizations/core/chart-options-p
 import type { ChartWidgetProps } from './domains/widgets/components/chart-widget/types';
 import { FiltersMergeStrategy } from './domains/widgets/components/widget-by-id/types';
 import { type AppConfig } from './infra/app/types';
-import type { Plugin } from './infra/contexts/plugin-provider/types';
+import type { Plugin } from './infra/plugins/types';
 import { AreamapDataPoint, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, BoxplotDataPoint, BoxplotStyleOptions, CalendarHeatmapDataPoint, CalendarHeatmapStyleOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ChartDataOptions, ChartDataPoints, ChartStyleOptions, ChartType, CustomDrilldownResult, DataPoint, DrilldownOptions, DrilldownSelection, FunnelStyleOptions, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, LineStyleOptions, MenuAlignment, MenuItemSection, MenuPosition, PieStyleOptions, PivotTableDataPoint, PivotTableDrilldownOptions, PivotTableStyleOptions, PolarStyleOptions, RegularChartStyleOptions, RegularChartType, ScatterDataPoint, ScattermapDataPoint, ScattermapStyleOptions, ScatterStyleOptions, StackableStyleOptions, StreamgraphStyleOptions, SunburstStyleOptions, TableStyleOptions, TabularChartStyleOptions, TextWidgetDataPoint, ThemeConfig, ThemeOid, ThemeSettings, TreemapStyleOptions, WidgetByIdStyleOptions } from './types';
 export type { TabberButtonsWidgetProps } from './domains/widgets/components/tabber-buttons-widget/types';
 export type { WidgetProps, WidgetType, WithCommonWidgetProps, } from './domains/widgets/components/widget/types';
@@ -126,6 +126,24 @@ export interface SisenseContextProviderProps {
      * @internal
      */
     alternativeSsoHost?: string;
+    /**
+     * Maximum number of SSO redirect attempts before stopping.
+     * Prevents infinite refresh loops when auth cookies fail to land (e.g. third-party
+     * cookie restrictions, SSO configuration issues, browser privacy settings).
+     * Redirect attempts are tracked in localStorage per Sisense URL and reset on successful auth.
+     * If not specified, the default value is `3`.
+     *
+     * @category Sisense Authentication
+     * @alpha
+     */
+    ssoMaxAuthRedirectAttempts?: number;
+    /**
+     * Milliseconds after the latest redirect timestamp before the counter resets. Use `0` to disable expiry (counter only resets on successful auth). Default is `5000` (5 seconds).
+     *
+     * @category Sisense Authentication
+     * @alpha
+     */
+    ssoRedirectAttemptsTtlMs?: number;
     /**
      * Boolean flag to use the default palette from Compose SDK.
      * Set to true in case of WAT authentication causing errors for the `/api/palettes` endpoint on older versions of Fusion (pre 2024.3)
@@ -207,7 +225,7 @@ export type ThemeProviderProps = PropsWithChildren<{
      * @internal
      */
     skipTracking?: boolean;
-    /** @internal */
+    /** @alpha */
     config?: ThemeConfig;
 }>;
 /**

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

@@ -20,6 +20,8 @@ export { processDrilldownSelections } from '../domains/drilldown/hooks/use-drill
 export { CommonWidget, type CommonWidgetProps } from '../domains/widgets/components/common-widget';
 export { TableWidget, type TableWidgetProps } from '../domains/widgets/components/table-widget';
 export { CustomWidgetsProviderAdapter, type CustomWidgetsContextAdapter, type CustomWidgetsProviderAdapterProps, } from '../infra/contexts/custom-widgets-provider/custom-widgets-provider-adapter';
+export { CustomPluginContextProvider } from '../infra/plugins/custom-plugin-context-provider.js';
+export type { CustomPluginContextProviderProps, CustomPluginContextProviderContext, } from '../infra/plugins/custom-plugin-context-provider.js';
 export { useGetSharedFormulaInternal } from '../domains/formulas/use-get-shared-formula';
 export { translateColumnToAttribute } from '../domains/visualizations/core/chart-data-options/utils';
 export { isSameAttribute } from '../shared/utils/filters';

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

@@ -49,7 +49,7 @@ export { type CustomWidgetProps } from '../domains/widgets/components/custom-wid
 export { TabberButtonsWidget } from '../domains/widgets/components/tabber-buttons-widget';
 export { DrilldownBreadcrumbs } from '../domains/drilldown/components/drilldown-breadcrumbs';
 export * from '../infra/contexts/custom-widgets-provider/types';
-export { useCustomWidgets } from '../infra/contexts/custom-widgets-provider';
+export { useCustomWidgets, type UseCustomWidgetsResult, } from '../infra/contexts/custom-widgets-provider';
 export { useGetDashboardModel, useGetDashboardModels, useDashboardModel, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type GetDashboardModelOptions, type GetDashboardModelsOptions, type WidgetsPanelColumnLayout, type WidgetsPanelLayout, type WidgetsPanelColumn, type WidgetsPanelRow, type WidgetsPanelCell, type WidgetId, type DashboardId, type WidgetsOptions, type SpecificWidgetOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, } from '../domains/dashboarding/dashboard-model';
 export { useGetWidgetModel, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, } from '../domains/widgets/widget-model';
 export { useGetHierarchyModels, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchyModelsParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, } from '../domains/drilldown/hierarchy-model';

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

@@ -4,7 +4,6 @@
  * Such APIs are for in-company usage only.
  * These APIs may change for in-company needs and are not part of the public contract.
  */
-export { useDashboardPersistence } from '../domains/dashboarding/dashboard-model';
 export { translateFiltersAndRelationsToDto } from '../domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/utils.js';
 export { UseDashboardModelActionType } from '../domains/dashboarding/dashboard-model/use-dashboard-model/dashboard-model-reducer/types.js';
 export { type DashboardDto } from '../infra/api/types/dashboard-dto';
@@ -20,9 +19,18 @@ export { QuotaNotification } from '../shared/components/quota-notification/quota
 export type { QuotaNotificationProps } from '../shared/components/quota-notification/quota-notification.js';
 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 { 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';
+export { useGetWidgetNarrative, type UseGetWidgetNarrativeOptions, type UseGetWidgetNarrativeParams, type UseGetWidgetNarrativeResult, } from '../domains/narrative/hooks/use-get-widget-narrative.js';
+export { WidgetNarrative, type WidgetNarrativeProps, } from '../domains/narrative/components/widget-narrative.js';
 export type { NlqChartWidgetStyleOptions } from '../types';
 export type { RenderTitleHandler } from '../types';
 export { isChartWidgetProps } from '../domains/widgets/components/widget-by-id/utils.js';
 export { isPivotTableWidgetProps } from '../domains/widgets/components/widget-by-id/utils.js';
+export { useDashboardPersistence } from '../domains/dashboarding/dashboard-model';
+export { createDashboardPersistenceManager } from '../domains/dashboarding/persistence/persistence-manager.js';
+export type { DashboardPersistenceManager } from '../domains/dashboarding/persistence/types.js';
+export { QueryDefinition, type QueryDefinitionProps, type QueryPillCategory, type QueryPillItem, type QueryDefinitionViewModel, } from '../domains/visualizations/core/query-definition';

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

@@ -5,3 +5,8 @@ export declare const DEFAULT_BACKGROUND_COLOR = "#F4F4F8";
 export declare const ERROR_COLOR = "#FA5656";
 export declare const NOT_AVAILABLE_DATA_VALUE = "N\\A";
 export declare const NOT_AVAILABLE_TEXT = "N/A";
+/** WCAG 2.5.8 Target Size (Minimum) — minimum 24×24 CSS pixels for interactive controls. */
+export declare const MIN_TOUCH_TARGET_SIZE: {
+    readonly minWidth: "24px";
+    readonly minHeight: "24px";
+};

package/dist/packages/sdk-ui/src/shared/types/menu-item.d.ts

@@ -10,8 +10,12 @@ export type MenuItem = {
      * Caption of the menu item
      */
     caption: string;
+    /**
+     * Sub items of the menu item
+     */
+    items?: MenuItem[];
     /**
      * Handler function to be called when the menu item is clicked
      */
-    onClick: () => void;
+    onClick?: () => void;
 };

package/dist/packages/sdk-ui/src/shared/utils/menu-item-converters.d.ts

@@ -0,0 +1,12 @@
+import type { MenuItemSection } from '../../types';
+import type { MenuItem } from '../types/menu-item.js';
+type SectionItem = NonNullable<MenuItemSection['items']>[number];
+/**
+ * Recursively converts a {@link MenuItem} into
+ * the item within the `MenuItemSection` expected by the context-menu infrastructure.
+ *
+ * @param menuItem - The menu item to convert.
+ * @returns The equivalent context-menu section item.
+ */
+export declare function convertMenuItemToLegacySectionItem(menuItem: MenuItem): SectionItem;
+export {};

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

@@ -1964,7 +1964,7 @@ export type CompleteThemeSettings = DeepRequired<Omit<ThemeSettings, 'typography
         fontsLoader?: FontsLoaderSettings;
     };
 };
-/** @internal */
+/** @alpha */
 export type ThemeConfig = {
     cssSelectorPrefix?: {
         enabled?: boolean;