@sisense/sdk-ui 1.11.0 → 1.13.0

package/dist/api/types/dashboard-dto.d.ts

@@ -5,7 +5,7 @@ import { AnyObject } from '../../utils/utility-types';
 export type Layout = {
     columns: {
         width: number;
-        cells: {
+        cells?: {
             subcells: {
                 width: number;
                 elements: {
@@ -28,6 +28,7 @@ export type CascadingFilterDto = {
     instanceid?: string;
     disabled?: boolean;
 };
+export declare const isCascadingFilterDto: (filter: FilterDto | CascadingFilterDto) => filter is CascadingFilterDto;
 export type DashboardDto = {
     oid: string;
     title: string;

package/dist/app/client-application.d.ts

@@ -43,6 +43,7 @@ export type AppConfig = {
     };
     /**
      * Query limit (max rows count that will be fetched in query)
+     *
      * @default 20000
      */
     queryLimit?: number;

package/dist/chart/helpers/use-chart-renderer-props.d.ts

@@ -19,6 +19,7 @@ type UnpreparedInternalChartProps = {
 };
 /**
  * Prepares the props for the chart renderer.
+ *
  * @param internalProps - unprepared internal chart props.
  * @returns Chart renderer props or null if the chart props is not ready yet
  * @internal

package/dist/chart/helpers/use-synced-data.d.ts

@@ -4,5 +4,5 @@ import { ChartDataOptionsInternal } from '../../chart-data-options/types';
 import { ChartType } from '../../types';
 import { DataColumnNamesMapping } from '../../chart-data-options/validate-data-options';
 type DataSet = DataSource | Data | undefined;
-export declare const useSyncedData: (dataSet: DataSet, chartDataOptions: ChartDataOptionsInternal, chartType: ChartType, attributes: Attribute[], measures: Measure[], dataColumnNamesMapping: DataColumnNamesMapping, filters?: Filter[] | FilterRelations, highlights?: Filter[], refreshCounter?: number, setIsLoading?: Dispatch<SetStateAction<boolean>>) => Data | undefined;
+export declare const useSyncedData: (dataSet: DataSet, chartDataOptions: ChartDataOptionsInternal, chartType: ChartType, attributes: Attribute[], measures: Measure[], dataColumnNamesMapping: DataColumnNamesMapping, filters?: Filter[] | FilterRelations, highlights?: Filter[], refreshCounter?: number, setIsLoading?: Dispatch<SetStateAction<boolean>>) => [Data, ChartDataOptionsInternal];
 export {};

package/dist/chart-options-processor/chart-options-service.d.ts

@@ -112,6 +112,7 @@ export type PlotOptions = {
     sunburst?: ChartPlotOptions;
     boxplot?: ChartPlotOptions;
     scatter?: ChartPlotOptions;
+    arearange?: ChartPlotOptions;
 };
 /**
  * Highcharts options internal
@@ -154,6 +155,9 @@ export type HighchartsOptionsInternal = {
     plotOptions?: PlotOptions;
     navigator?: Navigator | {
         enabled: boolean;
+        series?: {
+            type: ChartType;
+        };
     };
     tooltip?: TooltipSettings;
     boost?: {

package/dist/chart-options-processor/subtype-to-design-options.d.ts

@@ -29,6 +29,18 @@ export type LineSubtype = 'line/spline' | 'line/basic';
  *
  */
 export type AreaSubtype = 'area/basic' | 'area/stacked' | 'area/stacked100' | 'area/spline' | 'area/stackedspline' | 'area/stackedspline100';
+/**
+ * Property of {@link AreaRangeStyleOptions}
+ *
+ * Subtype of AreaRangeChart
+ *
+ * **Values**
+ *
+ * - `arearange/spline` - curved line from point to point.
+ * - `arearange/basic` - straight line from point to point.
+ *
+ */
+export type AreaRangeSubtype = 'arearange/spline' | 'arearange/basic';
 /**
  * Property of {@link StackableSubtype}
  *
@@ -92,7 +104,7 @@ export type SunburstSubtype = 'sunburst';
 export type BoxplotSubtype = 'boxplot/full' | 'boxplot/hollow';
 export type ScattermapSubtype = 'scattermap';
 export type AreamapSubtype = 'areamap/world' | 'areamap/usa';
-export type ChartSubtype = LineSubtype | AreaSubtype | StackableSubtype | PieSubtype | PolarSubtype | IndicatorSubtype | TreemapSubtype | SunburstSubtype | BoxplotSubtype | ScattermapSubtype | AreamapSubtype;
+export type ChartSubtype = LineSubtype | AreaSubtype | StackableSubtype | PieSubtype | PolarSubtype | IndicatorSubtype | TreemapSubtype | SunburstSubtype | BoxplotSubtype | ScattermapSubtype | AreamapSubtype | AreaRangeSubtype;
 export declare const chartSubtypeToDesignOptions: Readonly<Record<ChartSubtype, {
     lineType?: LineType | undefined;
     stackType?: StackType | undefined;

package/dist/chart-options-processor/translations/funnel-plot-options.d.ts

@@ -1,5 +1,6 @@
 import { PlotOptions } from '../chart-options-service';
 import { ValueLabelSettings } from './value-label-section';
+import { CompleteThemeSettings } from '../../types';
 import { FunnelChartDesignOptions } from './design-options';
 import { ChartDataOptionsInternal } from '../../chart-data-options/types';
 export declare const DefaultFunnelLabels: FunnelLabels;
@@ -50,4 +51,4 @@ export declare const DEFAULT_SHIFT = 50;
 export declare const funnelWidthPercentage: (renderTo: RenderTo | null) => number;
 export declare const funnelNeckWidth: (widthPercentage: number, funnelSize: FunnelSize) => number;
 export declare const funnelNeckHeight: (type: FunnelType) => number;
-export declare const getFunnelPlotOptions: (funnelDesignOptions: FunnelChartDesignOptions, chartDataOptions: ChartDataOptionsInternal) => PlotOptions;
+export declare const getFunnelPlotOptions: (funnelDesignOptions: FunnelChartDesignOptions, chartDataOptions: ChartDataOptionsInternal, themeSettings?: CompleteThemeSettings) => PlotOptions;

package/dist/chart-options-processor/translations/pie-plot-options.d.ts

@@ -1,6 +1,7 @@
 import { PlotOptions } from '../chart-options-service';
 import { ValueLabelSettings } from './value-label-section';
 import { ChartDataOptionsInternal } from '../../chart-data-options/types';
+import { CompleteThemeSettings } from '../../types';
 export declare const DefaultPieLabels: PieLabels;
 export type PieLabels = {
     enabled: boolean;
@@ -25,5 +26,5 @@ export type PieOptions = {
     innerSize?: InnerSize;
 };
 type InnerSize = '0%' | '40%' | '80%';
-export declare const getPiePlotOptions: (pieType: "classic" | "donut" | "ring" | undefined, pieLabels: PieLabels | undefined, chartDataOptions: ChartDataOptionsInternal) => PlotOptions;
+export declare const getPiePlotOptions: (pieType: "classic" | "donut" | "ring" | undefined, pieLabels: PieLabels | undefined, chartDataOptions: ChartDataOptionsInternal, themeSettings?: CompleteThemeSettings) => PlotOptions;
 export {};

package/dist/chart-options-processor/translations/tooltip-utils.d.ts

@@ -43,6 +43,8 @@ export type InternalSeries = {
             xDisplayValue?: string;
             xValue?: (number | string)[];
         };
+        upperPointName?: string;
+        lowerPointName?: string;
     };
     percentage?: number;
 };

package/dist/common/components/loading-indicator.d.ts

@@ -89,27 +89,40 @@ export declare const LoadingIndicator: ({ themeSettings, onCancel, }: {
                 borderGradient: [string, string] | null;
                 borderRadius: string;
                 hover: {
-                    backgroundColor: string;
                     textColor: string;
+                    backgroundColor: string;
                 };
                 loadingGradient: [string, string];
                 gap: string;
             };
             clickableMessages: {
-                backgroundColor: string;
                 textColor: string;
+                backgroundColor: string;
                 border: string | false;
+                borderGradient: [string, string] | null;
                 hover: {
                     textColor: string;
                     backgroundColor: string;
                 };
             };
+            dataTopics: {
+                backgroundColor: string;
+                items: {
+                    textColor: string;
+                    backgroundColor: string;
+                };
+            };
             icons: {
                 color: string;
-                hover: {
-                    color: string;
+                feedbackIcons: {
+                    hoverColor: string;
                 };
             };
+            tooltips: {
+                backgroundColor: string;
+                textColor: string;
+                boxShadow: string;
+            };
         };
     } | undefined;
     onCancel?: (() => void) | undefined;

package/dist/common/components/loading-overlay.d.ts

@@ -6,6 +6,7 @@ import { CompleteThemeSettings } from '../../types';
  *
  * @param isVisible - visibility of the overlay.
  * @returns Child component wrapped in dynamic overlay.
+ * @internal
  */
 export declare const LoadingOverlay: ({ isVisible, themeSettings, children, }: {
     isVisible: boolean;

package/dist/common/hooks/use-fetch.d.ts

@@ -15,8 +15,8 @@ export type RequestConfig = {
 /**
  * The result of the `useFetch` hook.
  * Return value of the `useQuery` hook from `@tanstack/react-query`.
- * @link https://tanstack.com/query/v4/docs/framework/react/reference/useQuery
  *
+ * @link https://tanstack.com/query/v4/docs/framework/react/reference/useQuery
  * @template TData - The type of the data returned by the fetch request
  * @template TError - The type of the error returned by the fetch request
  */

package/dist/common/hooks/use-has-changed.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Hook that returns if a value from the previous render has changed.
+ *
+ * @param value - Value for the current render.
+ * @param propNames - Names of keys to compare.
+ * @param [compare] - Optional comparison function
+ * @returns Has the value changed or not.
+ */
+export declare function useHasChanged<T>(value: T, propNames: Array<keyof T>, compare?: (value: T, prev: T) => boolean): boolean;

package/dist/common/hooks/use-should-load.d.ts

@@ -0,0 +1,12 @@
+import { ClientApplication } from '../../app/client-application.js';
+/**
+ * Hook that generates a function for testing whether or not load
+ *  should be performed for this render
+ *
+ * @param params - the component or hook params object
+ * @param isParamsChanged - have the params changed from previous invocation
+ * @returns generated render checking function
+ */
+export declare function useShouldLoad<T extends {
+    enabled?: boolean;
+}>({ enabled }: T, isParamsChanged: boolean): (app: ClientApplication | undefined, force?: boolean) => app is ClientApplication;

package/dist/common-filters/common-filters-connector.d.ts

@@ -0,0 +1,9 @@
+import { type Filter } from '@sisense/sdk-data';
+import { ChartDataOptions, ChartWidgetProps, PivotTableDataOptions, RenderToolbarHandler } from '../index.js';
+import { CommonFiltersOptions } from './types.js';
+import { WidgetTypeInternal } from '../models/widget/types';
+type CommonFiltersToWidgetConnectProps = Pick<ChartWidgetProps, 'filters' | 'highlights' | 'onDataPointClick' | 'onDataPointsSelected'> & {
+    renderToolbar: RenderToolbarHandler;
+};
+export declare function prepareCommonFiltersToWidgetConnectProps(filters: Filter[], setFilters: (filters: Filter[]) => void, widgetType: WidgetTypeInternal, dataOptions: ChartDataOptions | PivotTableDataOptions, options: CommonFiltersOptions): CommonFiltersToWidgetConnectProps;
+export {};

package/dist/common-filters/selection-utils.d.ts

@@ -0,0 +1,11 @@
+import { Attribute, Filter } from '@sisense/sdk-data';
+import { AreamapDataPoint, ChartDataOptions, DataPoint, PivotTableDataOptions, ScatterDataPoint, ScattermapDataPoint } from '../index.js';
+import { WidgetTypeInternal } from '../models/widget/types.js';
+type WidgetSelection = {
+    attribute: Attribute;
+    values: (string | number)[];
+};
+export declare function getWidgetSelections(widgetType: WidgetTypeInternal, dataOptions: ChartDataOptions | PivotTableDataOptions, points: Array<DataPoint | ScatterDataPoint | ScattermapDataPoint | AreamapDataPoint>, nativeEvent: MouseEvent | PointerEvent): WidgetSelection[];
+export declare function getSelectableWidgetAttributes(widgetType: WidgetTypeInternal, dataOptions: ChartDataOptions | PivotTableDataOptions): Attribute[];
+export declare function createCommonFiltersOverSelections(selections: WidgetSelection[], filters: Filter[]): Filter[];
+export {};

package/dist/common-filters/types.d.ts

@@ -0,0 +1,14 @@
+/** @internal */
+export declare enum CommonFiltersApplyMode {
+    HIGHLIGHT = "highlight",
+    FILTER = "filter"
+}
+/** @internal */
+export type CommonFiltersOptions = {
+    applyMode?: `${CommonFiltersApplyMode}`;
+    shouldAffectFilters?: boolean;
+    ignoreFilters?: {
+        all?: boolean;
+        ids?: string[];
+    };
+};

package/dist/common-filters/use-common-filters.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+import { type Filter } from '@sisense/sdk-data';
+import { WidgetModel } from '../index.js';
+import { CommonFiltersOptions } from './types.js';
+/** @internal */
+export declare const useCommonFilters: ({ initialFilters, }?: {
+    initialFilters?: Filter[] | undefined;
+}) => {
+    filters: Filter[];
+    setFilters: import("react").Dispatch<import("react").SetStateAction<Filter[]>>;
+    addFilter: (newFilter: Filter) => void;
+    connectToWidgetModel: (widget: WidgetModel, options?: CommonFiltersOptions) => WidgetModel;
+};

package/dist/common-filters/utils.d.ts

@@ -0,0 +1,9 @@
+import { Filter, Attribute } from '@sisense/sdk-data';
+import { CommonFiltersOptions } from './types.js';
+export declare function getAllowedFilters(filters: Filter[], ignoreFiltersOptions?: CommonFiltersOptions['ignoreFilters']): Filter[];
+export declare function isSameAttribute(attributeA: Attribute, attributeB: Attribute): boolean;
+export declare function getFilterByAttribute(filters: Filter[], attribute: Attribute): Filter | undefined;
+export declare function createCommonFilter(attribute: Attribute, members: (string | number)[], existingCommonFilters: Filter[]): Filter;
+export declare function isEqualMembersFilters(filterA: Filter, filterB: Filter): boolean;
+export declare function isIncludeAllFilter(filter: Filter): boolean;
+export declare function clearCommonFilter({ attribute, guid }: Filter): Filter;

package/dist/common-filters/widget-header-clear-selection-button.d.ts

@@ -0,0 +1,3 @@
+export declare const WidgetHeaderClearSelectionButton: ({ onClick }: {
+    onClick: () => void;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/components/content-panel.d.ts

@@ -0,0 +1,41 @@
+import { Layout, WidgetModel } from '../../models';
+/**
+ * Props for the {@link ContentPanel} component.
+ *
+ * @internal
+ */
+export interface ContentPanelProps {
+    /**
+     * An object defining how the widgets should be laid out.
+     */
+    layout: Layout;
+    /**
+     * A list of widget models to render.
+     */
+    widgets: WidgetModel[];
+}
+/**
+ * A React component used for rendering a layout of widgets.
+ *
+ * @example
+ * Example of using the component with the useGetDashboardModel hook:
+ * ```tsx
+ * const { dashboard, isLoading, isError } = useGetDashboardModel({
+ *   dashboardOid: 'dashboard-oid',
+ *   includeWidgets: true,
+ * });
+ *
+ * const { layout, widgets } = dashboard;
+ * if (!layout || !widgets) return null;
+ *
+ * return (
+ *   <ContentPanel
+ *     layout={layout}
+ *     widgets={widgets}
+ *   />
+ * );
+ * ```
+ * @param props - {@link ContentPanelProps}
+ * @internal
+ */
+export declare const ContentPanel: ({ layout, widgets }: ContentPanelProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/components/dashboard-container.d.ts

@@ -0,0 +1,2 @@
+import { DashboardLayoutProps } from '../../dashboard/types';
+export declare const DashboardContainer: ({ title, layout, widgets, filters, onFiltersChange, defaultDataSource, }: DashboardLayoutProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/components/dashboard-header.d.ts

@@ -0,0 +1,2 @@
+import { DashboardHeaderProps } from '../../dashboard/types';
+export declare const DashboardHeader: ({ title }: DashboardHeaderProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/components/plugin-service.d.ts

@@ -0,0 +1,21 @@
+import { WidgetModel } from '../../models';
+import { CompleteThemeSettings } from '../../types';
+/**
+ * @internal
+ */
+export type ReactWidgetPlugin<P = {}> = {
+    name: string;
+    Plugin: any;
+    createChartProps(w: WidgetModel, themeSettings: CompleteThemeSettings): P;
+};
+/**
+ * POC - singleton plugin store. A widget from a Fusion dashboard can use this
+ * store to look up and render a chart from a third-party plugin that matches its type.
+ *
+ * @internal
+ */
+export declare class PluginService {
+    static pluginMap: Map<string, ReactWidgetPlugin<{}>>;
+    static get(pluginType: string): ReactWidgetPlugin | undefined;
+    static register(pluginType: string, plugin: ReactWidgetPlugin): void;
+}

package/dist/dashboard/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const DASHBOARD_DIVIDER_COLOR = "#d5d5d5";
+export declare const DASHBOARD_DIVIDER_WIDTH = 1;

package/dist/dashboard/dashboard-by-id.d.ts

@@ -0,0 +1,7 @@
+import { DashboardByIdProps } from './types';
+/**
+ * React component that renders a dashboard created in Sisense Fusion Embed
+ *
+ * @internal
+ */
+export declare const DashboardById: ({ dashboardOid }: DashboardByIdProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/dashboard.d.ts

@@ -0,0 +1,8 @@
+import { DashboardProps } from '../dashboard/types';
+/**
+ * React component that renders a dashboard
+ * Include inside logic of applying common filters to widgets
+ *
+ * @internal
+ */
+export declare const Dashboard: ({ title, layout, widgets, filters, defaultDataSource, widgetFilterOptions, }: DashboardProps) => import("react/jsx-runtime").JSX.Element;

package/dist/dashboard/types.d.ts

@@ -0,0 +1,44 @@
+import { Layout, WidgetFilterOptions, WidgetModel } from '../models';
+import { DataSource, Filter } from '@sisense/sdk-data';
+/**
+ * Props for the DashboardById component
+ *
+ * @internal
+ */
+export interface DashboardByIdProps {
+    dashboardOid: string;
+}
+/**
+ * Props for the DashboardLayout component
+ *
+ * @internal
+ */
+export interface DashboardLayoutProps {
+    title: string;
+    layout: Layout;
+    widgets: WidgetModel[];
+    filters: Filter[];
+    onFiltersChange: (filters: Filter[]) => void;
+    defaultDataSource?: DataSource;
+}
+/**
+ * Props for the Dashboard component
+ *
+ * @internal
+ */
+export interface DashboardProps {
+    title: string;
+    layout: Layout;
+    widgets: WidgetModel[];
+    filters: Filter[];
+    defaultDataSource?: DataSource;
+    widgetFilterOptions?: WidgetFilterOptions;
+}
+/**
+ * Props for the Dashboard Header component
+ *
+ * @internal
+ */
+export interface DashboardHeaderProps {
+    title: string;
+}

package/dist/dashboard/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function isSupportedWidgetTypeByDashboard(widgetType: string): boolean;
+export declare const getDividerStyle: (color: string, width: number) => string;