@sisense/sdk-ui 1.19.0 → 1.21.0

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

@@ -2,15 +2,71 @@ import { type Filter, JaqlSortDirection, FilterRelations, FilterRelationsModel,
 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 { WidgetTypeInternal } from '../models/widget/types';
 export declare function getChartType(widgetType: WidgetType): ChartType;
 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 isPivotWidget(widgetType: WidgetTypeOrString): boolean;
+export declare function isPivotTableWidget(widgetType: WidgetTypeOrString): boolean;
 export declare function isTextWidget(widgetType: WidgetTypeOrString): boolean;
 export declare function isTextWidgetDtoStyle(widgetStyle: WidgetStyle): widgetStyle is TextWidgetDtoStyle;
+export declare function isPluginWidget(widgetType: WidgetTypeOrString): boolean;
 export declare function isChartWidget(widgetType: WidgetTypeOrString): boolean;
+/**
+ * Type guard for checking if the widget props is for a text widget.
+ *
+ * @param widgetProps - The widget props to check.
+ * @returns whether the widget props is for a text widget
+ */
+export declare function isTextWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<TextWidgetProps, 'text'>;
+/**
+ * Type guard for checking if the widget props is for a pivot table widget.
+ *
+ * @param widgetProps - The widget props to check.
+ * @returns whether the widget props is for a pivot table widget
+ */
+export declare function isPivotTableWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<PivotTableWidgetProps, 'pivot'>;
+/**
+ * Type guard for checking if the widget props is for a plugin widget
+ *
+ * @param widgetProps - The widget props to check.
+ * @returns whether the widget props is for a plugin widget
+ */
+export declare function isPluginWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<PluginWidgetProps, 'plugin'>;
+/**
+ * Type guard for checking if the widget props is for a chart widget
+ *
+ * @param widgetProps - The widget props to check.
+ * @returns whether the widget props is for a chart widget
+ */
+export declare function isChartWidgetProps(widgetProps: CommonWidgetProps): widgetProps is WithWidgetType<ChartWidgetProps, 'chart'>;
+export declare function translateWidgetTypeInternal(widgetProps: CommonWidgetProps): WidgetTypeInternal;
+/**
+ * Registers new "onDataPointClick" handler for the Widget component
+ *
+ * @internal
+ */
+export declare function registerDataPointClickHandler(widgetProps: WidgetProps, handler: NonNullable<ChartProps['onDataPointClick']>): void;
+/**
+ * Registers new "onDataPointContextMenu" handler for the Widget component
+ *
+ * @internal
+ */
+export declare function registerDataPointContextMenuHandler(widgetProps: WidgetProps, handler: NonNullable<ChartProps['onDataPointContextMenu']>): void;
+/**
+ * Registers new "onDataPointsSelected" handler for the Widget component
+ *
+ * @internal
+ */
+export declare function registerDataPointsSelectedHandler(widgetProps: WidgetProps, handler: NonNullable<ChartProps['onDataPointsSelected']>): void;
+/**
+ * Registers new "renderToolbar" handler for the constructed component
+ *
+ * @internal
+ */
+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;
 /**

package/dist/{decorators → packages/sdk-ui/src/decorators}/component-decorators/as-sisense-component.d.ts

@@ -15,6 +15,8 @@ export type SisenseComponentConfig = {
     };
     /** If set, the error message for wrong SisenseContext will be overridden with the provided key */
     customContextErrorMessageKey?: string;
+    /** If set, the component will have a standalone menu root, allowing the menu to be opened even when the component is used outside of the SisenseContextProvider */
+    shouldHaveOwnMenuRoot?: boolean;
 };
 export type ComponentDecorator<DecoratorConfig> = (decoratorConfig: DecoratorConfig) => <ComponentProps extends Record<string, any>>(Component: FunctionComponent<ComponentProps>) => FunctionComponent<ComponentProps>;
 /**

package/dist/packages/sdk-ui/src/decorators/component-decorators/with-menu.d.ts

@@ -0,0 +1,6 @@
+import { ComponentDecorator } from './as-sisense-component';
+type MenuConfig = {
+    shouldHaveOwnMenuRoot?: boolean;
+};
+export declare const withMenu: ComponentDecorator<MenuConfig>;
+export {};

package/dist/{decorators → packages/sdk-ui/src/decorators}/hook-decorators/with-tracking.d.ts

@@ -1,12 +1,12 @@
 import { ClientApplication } from '../../app/client-application';
 export type HookDecorator<DecoratorConfig> = (decoratorConfig: DecoratorConfig) => <HookArgs extends any[], HookResult>(hook: (...args: HookArgs) => HookResult) => (...args: HookArgs) => HookResult;
 /**
- * @internal
- * @description This is a function that tracks the hook event and sends it to the server.
+ * Tracks the hook event and sends it to the server.
  * @param hookName - The name of the hook
  * @param packageName - The name of the package
  * @param app - The client application
  * @param onFinally - The function to call after the tracking is done
+ * @internal
  */
 export declare const trackHook: (hookName: string, packageName: string, app: ClientApplication, onFinally: () => void) => void;
 export declare const withTracking: HookDecorator<string>;

package/dist/{filters → packages/sdk-ui/src/filters}/components/common/basic-input.d.ts

@@ -1,7 +1,10 @@
-import { type FunctionComponent, type InputHTMLAttributes } from 'react';
+import { type FunctionComponent, type InputHTMLAttributes, CSSProperties } from 'react';
 type BasicInputProps = {
     label?: string;
     callback: (value: string) => void;
+    containerStyle?: CSSProperties;
+    labelStyle?: CSSProperties;
+    inputStyle?: CSSProperties;
 } & InputHTMLAttributes<HTMLInputElement>;
 export declare const BasicInput: FunctionComponent<BasicInputProps>;
 export {};

package/dist/{filters → packages/sdk-ui/src/filters}/components/criteria-filter-tile/criteria-filter-operations.d.ts

@@ -11,14 +11,14 @@ export declare const FilterOption: {
     TOP: string;
     BOTTOM: string;
     BETWEEN: string;
-    EQUALS: string;
-    NOT_EQUALS: string;
+    EQUALS_NUMERIC: string;
+    NOT_EQUALS_NUMERIC: string;
     LESS_THAN: string;
     LESS_THAN_OR_EQUAL: string;
     GREATER_THAN: string;
     GREATER_THAN_OR_EQUAL: string;
-    IS: string;
-    IS_NOT: string;
+    EQUALS_TEXT: string;
+    NOT_EQUALS_TEXT: string;
     CONTAINS: string;
     NOT_CONTAIN: string;
     STARTS_WITH: string;

package/dist/{filters → packages/sdk-ui/src/filters}/components/criteria-filter-tile/criteria-filter-tile.d.ts

@@ -26,7 +26,7 @@ export interface CriteriaFilterTileProps {
 export type CriteriaFilterType = NumericFilter | TextFilter | RankingFilter | ExcludeFilter;
 /**
  * UI component that allows the user to filter numeric or text attributes according to
- * a number of built-in operations defined in the {@link NumericFilter}, {@link TextFilter}, or {@link RankingFilter}.
+ * a number of built-in operations defined in the numeric filter, text filter, or ranking filter.
  *
  * The arrangement prop determines whether the filter is rendered vertically or horizontally, with the latter intended for toolbar use and omitting title, enable/disable, and collapse/expand functionality.
  *

package/dist/packages/sdk-ui/src/filters/components/unsupported-filter-tile.d.ts

@@ -0,0 +1,12 @@
+import { FilterTileDesignOptions } from '../../filters/components/filter-tile';
+import { Filter } from '@sisense/sdk-data';
+export type UnsupportedFilterTileProps = {
+    filter: Filter;
+    design?: FilterTileDesignOptions;
+};
+/**
+ * Filter tile component that renders an unsupported filter (which is not recognized by the JAQL to Filter translation)
+ *
+ * @internal
+ */
+export declare const UnsupportedFilterTile: ({ filter, design }: UnsupportedFilterTileProps) => import("react/jsx-runtime").JSX.Element;

package/dist/{formulas → packages/sdk-ui/src/formulas}/use-get-shared-formula.d.ts

@@ -83,8 +83,6 @@ export type SharedFormulaSuccessState = {
     ```tsx
     const { formula, isLoading, isError } = useGetSharedFormula({ name: 'My Shared Formula', datasource: DM.DataSource })
     ```
- * @param params - {@link UseGetSharedFormulaParams}
- * @param dataSource - Data source in Sisense instance
  * @returns Formula load state that contains the status of the execution, the result formula, or the error if any
  * @group Fusion Embed
  * @fusionEmbed
@@ -93,6 +91,7 @@ export declare const useGetSharedFormula: (params: UseGetSharedFormulaParams) =>
 /**
  * {@link useGetSharedFormula} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - {@link UseGetSharedFormulaParams}
  * @internal
  */
 export declare function useGetSharedFormulaInternal(params: UseGetSharedFormulaParams): SharedFormulaState;

package/dist/packages/sdk-ui/src/highcharts-overrides.d.ts

@@ -0,0 +1 @@
+export declare const applyHighchartOverrides: () => void;

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

@@ -0,0 +1,77 @@
+export { ClientApplication, createClientApplication } from './app/client-application';
+export * from './chart-data-options/types';
+export { Chart } from './chart';
+export { ThemeProvider } from './theme-provider';
+export * from './dashboard';
+export { DashboardWidget } from './dashboard-widget/dashboard-widget';
+export { getSortType } from './dashboard-widget/utils';
+export { type WidgetType, type CartesianWidgetType, type CategoricalWidgetType, type TabularWidgetType, type TextWidgetType, } from './dashboard-widget/types';
+export * from './query-execution';
+export { executeQuery } from './query/execute-query';
+export { SisenseContextProvider } from './sisense-context/sisense-context-provider';
+export { DrilldownWidget } from './widgets/drilldown-widget';
+export { processDrilldownSelections } from './widgets/common/use-drilldown';
+export { ChartWidget } from './widgets/chart-widget';
+export { TableWidget } from './widgets/table-widget';
+export { PivotTableWidget } from './widgets/pivot-table-widget';
+export { TextWidget } from './widgets/text-widget';
+export { ContextMenu } from './common/components/menu/context-menu/context-menu';
+export { DrilldownBreadcrumbs } from './widgets/common/drilldown-breadcrumbs';
+export * from './line-chart';
+export * from './column-chart';
+export * from './area-chart';
+export * from './pie-chart';
+export * from './bar-chart';
+export * from './funnel-chart';
+export * from './polar-chart';
+export * from './scatter-chart';
+export * from './indicator-chart';
+export * from './table';
+export * from './pivot-table';
+export * from './treemap-chart';
+export * from './sunburst-chart';
+export * from './boxplot-chart';
+export * from './scattermap-chart';
+export * from './areamap-chart';
+export * from './area-range-chart';
+export * from './sisense-context/custom-sisense-context-provider';
+export * from './theme-provider/custom-theme-provider';
+export * from './plugins-provider/custom-plugins-provider';
+export * from './plugins-provider/types';
+export { usePlugins } from './plugins-provider/plugins-provider';
+export { extractDimensionsAndMeasures, useExecutePluginQuery, } from './plugins-provider/use-execute-plugin-query';
+export { getThemeSettingsByOid } from './themes/theme-loader';
+export { getDefaultThemeSettings } from './theme-provider/default-theme-settings';
+export { useGetDashboardModel, useGetDashboardModels, getDashboardModel, getDashboardModels, useGetWidgetModel, getWidgetModel, translateToDashboardResponse, translateToDashboardsResponse, useGetHierarchyModels, getHierarchyModels, type DashboardModel, type GetDashboardModelParams, type GetDashboardModelsParams, type DashboardModelState, type DashboardModelLoadingState, type DashboardModelSuccessState, type DashboardModelErrorState, type DashboardModelsState, type DashboardModelsLoadingState, type DashboardModelsSuccessState, type DashboardModelsErrorState, type WidgetModel, type WidgetDataOptions, type WidgetModelState, type WidgetModelLoadingState, type WidgetModelErrorState, type WidgetModelSuccessState, type GetWidgetModelParams, type GetDashboardModelOptions, type GetDashboardModelsOptions, type WidgetsPanelColumnLayout as WidgetsPanelColumnLayout, type WidgetsPanelLayout as WidgetsPanelLayout, type WidgetId, type WidgetsOptions, type CommonFiltersOptions, type CommonFiltersApplyMode, type FiltersIgnoringRules, type HierarchyModel, type Hierarchy, type HierarchyId, type GetHierarchiesParams, type HierarchyModelsState, type HierarchyModelsLoadingState, type HierarchyModelsErrorState, type HierarchyModelsSuccessState, } from './models';
+/**
+ * Utility functions to translate between widget abstractions of models and UI props.
+ *
+ * @group Fusion Embed
+ * @fusionEmbed
+ */
+export * as widgetModelTranslator from './models/widget/widget-model-translator';
+/**
+ * Utility functions to translate between dashboard abstractions of models and UI props.
+ *
+ * @group Fusion Embed
+ * @fusionEmbed
+ */
+export * as dashboardModelTranslator from './models/dashboard/dashboard-model-translator';
+export type { AutoZoomNavigatorScrollerLocation } from './dashboard-widget/types';
+export { boxWhiskerProcessResult } from './boxplot-utils';
+export { queryStateReducer } from './query-execution/query-state-reducer';
+export * from './props';
+export * from './types';
+export * from './filters';
+export * from './formulas';
+export { trackHook } from './decorators/hook-decorators';
+export * from './common/hooks/data-load-state-reducer';
+export { createDataOptionsFromPanels } from './dashboard-widget/translate-widget-data-options';
+export { type DashboardDto } from './api/types/dashboard-dto';
+export { type WidgetDto } from './dashboard-widget/types';
+export { extractCombinedFilters } from './dashboard-widget/translate-dashboard-filters';
+export { useThemeContext } from './theme-provider';
+export { LoadingIndicator } from './common/components/loading-indicator';
+export { LoadingOverlay } from './common/components/loading-overlay';
+export { useFetch, type RequestConfig, type UseQueryResult } from './common/hooks/use-fetch';
+export type { EmptyObject } from './utils/utility-types';

package/dist/packages/sdk-ui/src/models/dashboard/dashboard-model-translator.d.ts

@@ -0,0 +1,25 @@
+import { DashboardProps } from '../../dashboard';
+import { DashboardModel } from './dashboard-model.js';
+import { DashboardDto } from '../../api/types/dashboard-dto.js';
+import { CompleteThemeSettings } from '../../types.js';
+import { AppSettings } from '../../app/settings/settings.js';
+/**
+ * Translates {@link DashboardModel} to {@link DashboardProps}.
+ *
+ * @example
+ * ```tsx
+ * <Dashboard {...dashboardModelTranslator.toDashboardProps(dashboardModel)} />
+ * ```
+ * @group Fusion Embed
+ * @fusionEmbed
+ */
+export declare function toDashboardProps(dashboardModel: DashboardModel): Required<DashboardProps>;
+/**
+ * Creates a new dashboard model from a dashboard DTO.
+ *
+ * @param dashboardDto - The dashboard DTO to be converted to a dashboard model
+ * @param themeSettings - Optional theme settings
+ * @param appSettings - Optional application settings
+ * @internal
+ */
+export declare function fromDashboardDto(dashboardDto: DashboardDto, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): DashboardModel;

package/dist/packages/sdk-ui/src/models/dashboard/dashboard-model.d.ts

@@ -0,0 +1,52 @@
+import { DataSource, Filter } from '@sisense/sdk-data';
+import { DashboardStyleOptions, WidgetModel } from '../../models';
+import { type WidgetsOptions } from './types';
+import { DashboardLayoutOptions } from '../../dashboard';
+/**
+ * Model of Sisense Fusion dashboard defined in the abstractions of Compose SDK.
+ *
+ * @group Fusion Embed
+ * @fusionEmbed
+ */
+export interface DashboardModel {
+    /**
+     * Unique identifier of the dashboard.
+     */
+    oid: string;
+    /**
+     * Dashboard title.
+     */
+    title: string;
+    /**
+     * Dashboard data source details.
+     */
+    dataSource: DataSource;
+    /**
+     * Dashboard widget models.
+     */
+    widgets: WidgetModel[];
+    /**
+     * Dashboard layout options.
+     *
+     * @internal
+     */
+    layoutOptions: DashboardLayoutOptions;
+    /**
+     * Dashboard style options.
+     *
+     * @internal
+     */
+    styleOptions: DashboardStyleOptions;
+    /**
+     * Dashboard filters.
+     *
+     * @internal
+     */
+    filters: Filter[];
+    /**
+     * Dashboard options for each of the widgets.
+     *
+     * @internal
+     */
+    widgetsOptions: WidgetsOptions;
+}

package/dist/{models → packages/sdk-ui/src/models}/dashboard/get-dashboard-model.d.ts

@@ -1,5 +1,4 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
-import { DashboardModel } from '../../models/dashboard/dashboard-model';
 import { CompleteThemeSettings } from '../../types';
 import { AppSettings } from '../../app/settings/settings';
 export interface GetDashboardModelOptions {
@@ -13,8 +12,6 @@ export interface GetDashboardModelOptions {
      * Boolean flag whether to include filters in the dashboard model
      *
      * If not specified, the default value is `false`
-     *
-     * @internal
      */
     includeFilters?: boolean;
 }
@@ -29,4 +26,4 @@ export interface GetDashboardModelOptions {
  * @returns The dashboard model
  * @internal
  */
-export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): Promise<DashboardModel>;
+export declare function getDashboardModel(http: HttpClient, dashboardOid: string, options?: GetDashboardModelOptions, themeSettings?: CompleteThemeSettings, appSettings?: AppSettings): Promise<import('../../models/dashboard').DashboardModel>;

package/dist/{models → packages/sdk-ui/src/models}/dashboard/get-dashboard-models.d.ts

@@ -1,5 +1,4 @@
 import { HttpClient } from '@sisense/sdk-rest-client';
-import { DashboardModel } from '../../models/dashboard/dashboard-model';
 export interface GetDashboardModelsOptions {
     /**
      * Dashboard title to search by
@@ -13,4 +12,4 @@ export interface GetDashboardModelsOptions {
     includeWidgets?: boolean;
 }
 /** @internal */
-export declare function getDashboardModels(http: HttpClient, options?: GetDashboardModelsOptions): Promise<DashboardModel[]>;
+export declare function getDashboardModels(http: HttpClient, options?: GetDashboardModelsOptions): Promise<import('../../models').DashboardModel[]>;

package/dist/{models → packages/sdk-ui/src/models}/dashboard/index.d.ts

@@ -4,3 +4,4 @@ export * from './get-dashboard-models';
 export * from './use-get-dashboard-model';
 export * from './use-get-dashboard-models';
 export * from './dashboard-model';
+export * as dashboardModelTranslator from './dashboard-model-translator';

package/dist/packages/sdk-ui/src/models/dashboard/translate-dashboard-utils.d.ts

@@ -0,0 +1,7 @@
+import { type LayoutDto, type FilterDto, type CascadingFilterDto } from '../../api/types/dashboard-dto';
+import type { WidgetsPanelColumnLayout, WidgetsOptions } from './types';
+import { Filter } from '@sisense/sdk-data';
+import { WidgetDto } from '../../dashboard-widget/types';
+export declare const translateLayout: (layout: LayoutDto) => WidgetsPanelColumnLayout;
+export declare function extractDashboardFilters(dashboardFilters: Array<FilterDto | CascadingFilterDto>): Filter[];
+export declare function translateWidgetsOptions(widgets?: WidgetDto[]): WidgetsOptions;

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

@@ -2,24 +2,39 @@ import { CommonFiltersOptions } from '../../common-filters/types';
 import { ColorPaletteTheme } from '../../types';
 export type { CommonFiltersOptions, CommonFiltersApplyMode, FiltersIgnoringRules, } from '../../common-filters/types';
 /**
- * Layout of a dashboard.
+ * Column layout of dashboard widgets
  */
-export interface Layout {
+export interface WidgetsPanelColumnLayout {
     columns: {
         widthPercentage: number;
         rows: {
             cells: {
                 widthPercentage: number;
-                height: number | string;
+                /**
+                 * @privateRemarks
+                 * This value appears to be overwritten by the widget's height property.
+                 * Marking as optional and internal for now.
+                 * @internal
+                 */
+                height?: number | string;
                 widgetId: string;
             }[];
         }[];
     }[];
 }
 /**
- * Options for how common filters defined at the dashboard level should be applied to widgets.
+ * Layout of dashboard widgets panel, which is a union of different layout algorithms
  */
-export type WidgetFilterOptions = Record<string, CommonFiltersOptions>;
+export type WidgetsPanelLayout = WidgetsPanelColumnLayout;
+export type WidgetId = string;
+/**
+ * Options for widgets in a dashboard
+ *
+ * For example, how common filters defined at the dashboard level should be applied to widgets.
+ */
+export type WidgetsOptions = Record<WidgetId, {
+    filtersOptions?: CommonFiltersOptions;
+}>;
 /**
  * Style options for the dashboard.
  */

package/dist/{models → packages/sdk-ui/src/models}/dashboard/use-get-dashboard-model.d.ts

@@ -96,7 +96,6 @@ export type DashboardModelSuccessState = {
   }
   return null;
  ```
- * @param params - Parameters of the dashboard to be retrieved
  * @returns Dashboard load state that contains the status of the execution, the result dashboard model, or the error if any
  * @group Fusion Embed
  * @fusionEmbed
@@ -105,6 +104,8 @@ export declare const useGetDashboardModel: (params: GetDashboardModelParams) =>
 /**
  * {@link useGetDashboardModel} without tracking to be used inside other hooks or components in Compose SDK.
  *
+ * @param params - Parameters of the dashboard to be retrieved
+ *
  * @internal
  */
 export declare function useGetDashboardModelInternal(params: GetDashboardModelParams): DashboardModelState;

package/dist/packages/sdk-ui/src/models/hierarchy/get-hierarchy-models.d.ts

@@ -0,0 +1,5 @@
+import { HttpClient } from '@sisense/sdk-rest-client';
+import { DataSource } from '@sisense/sdk-data';
+import { GetHierarchiesOptions } from './types.js';
+/** @internal */
+export declare function getHierarchyModels(http: HttpClient, options: GetHierarchiesOptions, defaultDataSource?: DataSource): Promise<import('../../models').HierarchyModel[]>;

package/dist/packages/sdk-ui/src/models/hierarchy/hierarchy-model-translator.d.ts

@@ -0,0 +1,9 @@
+import { type HierarchyDto } from '../../dashboard-widget/types';
+import { type HierarchyModel } from './hierarchy-model';
+/**
+ * Creates a new hierarchy model from a hierarchy DTO.
+ *
+ * @param hierarchyDto - The hierarchy DTO to be converted to a hierarchy model
+ * @internal
+ */
+export declare function fromHierarchyDto(hierarchyDto: HierarchyDto): HierarchyModel;

package/dist/packages/sdk-ui/src/models/hierarchy/hierarchy-model.d.ts

@@ -0,0 +1,21 @@
+import { type Attribute } from '@sisense/sdk-data';
+/**
+ * A unique identifier representing a hierarchy.
+ */
+export type HierarchyId = string;
+/**
+ * Hierarchy with a title and associated levels.
+ */
+export interface Hierarchy {
+    /** Hierarchy title. */
+    title: string;
+    /** Hierarchy levels. */
+    levels: Attribute[];
+}
+/**
+ * Model of Sisense hierarchy defined in the abstractions of Compose SDK.
+ */
+export interface HierarchyModel extends Hierarchy {
+    /** Unique identifier of the hierarchy. */
+    id: HierarchyId;
+}

package/dist/packages/sdk-ui/src/models/hierarchy/index.d.ts

@@ -0,0 +1,5 @@
+export * from './hierarchy-model';
+export * as hierarchyModelTranslator from './hierarchy-model-translator';
+export * from './use-get-hierarchy-models';
+export * from './types';
+export * from './get-hierarchy-models';

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

@@ -0,0 +1,28 @@
+import type { Attribute, DataSource } from '@sisense/sdk-data';
+/**
+ * Options for retrieving hierarchies.
+ */
+export type GetHierarchiesOptions = {
+    /**
+     * The dimension for which to retrieve the hierarchies.
+     */
+    dimension: Attribute;
+    /**
+     * The data source from which to retrieve the hierarchies - e.g. `Sample ECommerce`.
+     *
+     * If not specified, the query will use the `defaultDataSource` specified in the parent Sisense Context.
+     */
+    dataSource?: DataSource;
+    /**
+     * A list of hierarchy IDs to retrieve specific hierarchies.
+     */
+    ids?: string[];
+    /**
+     * A flag indicating whether to filter the retrieved hierarchies based on the `alwaysIncluded` field.
+     *
+     * When set to true, only hierarchies with `alwaysIncluded: true` will be returned.
+     * When set to false, only hierarchies with `alwaysIncluded: false` will be returned.
+     * If not specified, all hierarchies will be returned.
+     */
+    alwaysIncluded?: boolean;
+};

package/dist/packages/sdk-ui/src/models/hierarchy/use-get-hierarchy-models.d.ts

@@ -0,0 +1,97 @@
+import { HookEnableParam } from '../../common/hooks/types.js';
+import { HierarchyModel } from '../../models/hierarchy/hierarchy-model';
+import { GetHierarchiesOptions } from './types.js';
+/**
+ * Parameters for {@link useGetHierarchyModels} hook.
+ */
+export interface GetHierarchiesParams extends GetHierarchiesOptions, HookEnableParam {
+}
+/**
+ * States of hierarchy models load.
+ */
+export type HierarchyModelsState = HierarchyModelsLoadingState | HierarchyModelsErrorState | HierarchyModelsSuccessState;
+/**
+ * State of hierarchy models that is loading.
+ */
+export type HierarchyModelsLoadingState = {
+    /** Whether the hierarchy models is loading */
+    isLoading: true;
+    /** Whether the hierarchy models load has failed */
+    isError: false;
+    /** Whether the hierarchy models load has succeeded */
+    isSuccess: false;
+    /** Error, if one occurred */
+    error: undefined;
+    /** Hierarchy models, if the load succeeded */
+    hierarchies: HierarchyModel[] | undefined;
+    /** Loading status */
+    status: 'loading';
+};
+/**
+ * State of a hierarchy models load that has failed.
+ */
+export type HierarchyModelsErrorState = {
+    /** Whether the hierarchy models is loading */
+    isLoading: false;
+    /** Whether the hierarchy models load has failed */
+    isError: true;
+    /** Whether the hierarchy models load has succeeded */
+    isSuccess: false;
+    /** Error, if one occurred */
+    error: Error;
+    /** Hierarchy models, if the load succeeded */
+    hierarchies: undefined;
+    /** Loading status */
+    status: 'error';
+};
+/**
+ * State of a hierarchy models load that has succeeded.
+ */
+export type HierarchyModelsSuccessState = {
+    /** Whether the hierarchy models is loading */
+    isLoading: false;
+    /** Whether the hierarchy models load has failed */
+    isError: false;
+    /** Whether the hierarchy models load has succeeded */
+    isSuccess: true;
+    /** Error, if one occurred */
+    error: undefined;
+    /** Hierarchy models, if the load succeeded */
+    hierarchies: HierarchyModel[];
+    /** Loading status */
+    status: 'success';
+};
+/**
+ * React hook that retrieves existing hierarchy models from a Fusion Embed instance.
+ *
+ * @example
+ * Retrieve the hierarchy models and render their counts.
+ ```tsx
+  const { hierarchies, isLoading, isError } = useGetHierarchyModels({
+    dataSource: DM.DataSource,
+    dimension: DM.Commerce.AgeRange,
+  });
+
+  if (isLoading) {
+    return <div>Loading...</div>;
+  }
+  if (isError) {
+    return <div>Error</div>;
+  }
+  if (hierarchies) {
+    return <div>{`Total Hierarchies: ${hierarchies.length}`}</div>;
+  }
+  return null;
+ ```
+ * @returns Load state that contains the status of the execution, the result hierarchy models, or the error if one has occurred
+ * @group Fusion Embed
+ * @fusionEmbed
+ */
+export declare const useGetHierarchyModels: (params: GetHierarchiesParams) => HierarchyModelsState;
+/**
+ * {@link useGetHierarchyModels} without tracking to be used inside other hooks or components in Compose SDK.
+ *
+ * @param params - Parameters of the hierarchies to be retrieved
+ * @internal
+ */
+export declare function useGetHierarchyModelsInternal(params: GetHierarchiesParams): HierarchyModelsState;

package/dist/{models → packages/sdk-ui/src/models}/index.d.ts

@@ -1,2 +1,3 @@
 export * from './dashboard';
 export * from './widget';
+export * from './hierarchy';

package/dist/{models → packages/sdk-ui/src/models}/widget/index.d.ts

@@ -1,4 +1,4 @@
-export * from './translate-widget';
 export * from './widget-model';
 export * from './get-widget-model';
 export * from './use-get-widget-model';
+export * as widgetModelTranslator from './widget-model-translator';

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

@@ -6,4 +6,4 @@ import { ChartType } from '../../index';
  *
  * @internal
  */
-export type WidgetTypeInternal = ChartType | 'pivot' | 'plugin';
+export type WidgetTypeInternal = ChartType | 'pivot' | 'plugin' | 'text';