@sisense/sdk-ui 1.31.0 → 1.33.0

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

@@ -27,6 +27,10 @@ export declare const resources: {
                 filterAttributeNotFound: string;
                 highlightAttributeNotFound: string;
             };
+            optionsTranslation: {
+                invalidStyleOptions: string;
+                invalidInternalDataOptions: string;
+            };
             themeNotFound: string;
             paletteNotFound: string;
             chartTypeNotSupported: string;
@@ -84,6 +88,10 @@ export declare const resources: {
             notAMembersFilter: string;
             drilldownNoInitialDimension: string;
             otherWidgetTypesNotSupported: string;
+            dataBrowser: {
+                dimensionNotFound: string;
+                attributeNotFound: string;
+            };
         };
         errorBoxText: string;
         chartNoData: string;
@@ -267,6 +275,17 @@ export declare const resources: {
                 noAvailableDataTopics: string;
             };
         };
+        attribute: {
+            datetimeName: {
+                years: string;
+                quarters: string;
+                months: string;
+                weeks: string;
+                days: string;
+                hours: string;
+                minutes: string;
+            };
+        };
         filterEditor: {
             buttons: {
                 apply: string;
@@ -279,11 +298,13 @@ export declare const resources: {
                 allowMultiSelection: string;
                 from: string;
                 to: string;
+                includeCurrent: string;
             };
             placeholders: {
                 selectFromList: string;
                 enterEntry: string;
                 enterValue: string;
+                select: string;
             };
             conditions: {
                 exclude: string;
@@ -301,11 +322,37 @@ export declare const resources: {
                 lessThanOrEqual: string;
                 greaterThan: string;
                 greaterThanOrEqual: string;
+                isWithin: string;
             };
             validationErrors: {
                 invalidNumber: string;
                 invalidNumericRange: string;
             };
+            datetimeLevels: {
+                year: string;
+                quarter: string;
+                month: string;
+                week: string;
+                day: string;
+                aggrigatedHour: string;
+                aggrigatedMinutesRoundTo15: string;
+            };
+            relativeTypes: {
+                last: string;
+                this: string;
+                next: string;
+            };
+            datetimePositions: {
+                before: string;
+                after: string;
+            };
+        };
+        dataBrowser: {
+            addFilter: string;
+            selectField: string;
+            configureFilter: string;
+            noResults: string;
+            searchPlaceholder: string;
         };
         pivotTable: {
             grandTotal: string;
@@ -331,6 +378,10 @@ export declare const resources: {
                 filterAttributeNotFound: string;
                 highlightAttributeNotFound: string;
             };
+            optionsTranslation: {
+                invalidStyleOptions: string;
+                invalidInternalDataOptions: string;
+            };
             themeNotFound: string;
             paletteNotFound: string;
             chartTypeNotSupported: string;
@@ -388,6 +439,10 @@ export declare const resources: {
             notAMembersFilter: string;
             drilldownNoInitialDimension: string;
             otherWidgetTypesNotSupported: string;
+            dataBrowser: {
+                dimensionNotFound: string;
+                attributeNotFound: string;
+            };
         };
         errorBoxText: string;
         chartNoData: string;
@@ -571,6 +626,17 @@ export declare const resources: {
                 noAvailableDataTopics: string;
             };
         };
+        attribute: {
+            datetimeName: {
+                years: string;
+                quarters: string;
+                months: string;
+                weeks: string;
+                days: string;
+                hours: string;
+                minutes: string;
+            };
+        };
         filterEditor: {
             buttons: {
                 apply: string;
@@ -583,11 +649,13 @@ export declare const resources: {
                 allowMultiSelection: string;
                 from: string;
                 to: string;
+                includeCurrent: string;
             };
             placeholders: {
                 selectFromList: string;
                 enterEntry: string;
                 enterValue: string;
+                select: string;
             };
             conditions: {
                 exclude: string;
@@ -605,11 +673,37 @@ export declare const resources: {
                 lessThanOrEqual: string;
                 greaterThan: string;
                 greaterThanOrEqual: string;
+                isWithin: string;
             };
             validationErrors: {
                 invalidNumber: string;
                 invalidNumericRange: string;
             };
+            datetimeLevels: {
+                year: string;
+                quarter: string;
+                month: string;
+                week: string;
+                day: string;
+                aggrigatedHour: string;
+                aggrigatedMinutesRoundTo15: string;
+            };
+            relativeTypes: {
+                last: string;
+                this: string;
+                next: string;
+            };
+            datetimePositions: {
+                before: string;
+                after: string;
+            };
+        };
+        dataBrowser: {
+            addFilter: string;
+            selectField: string;
+            configureFilter: string;
+            noResults: string;
+            searchPlaceholder: string;
         };
         pivotTable: {
             grandTotal: string;

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

@@ -7,11 +7,12 @@ import { ScatterMarkerSize } from './chart-options-processor/translations/scatte
 import { CartesianChartType, ScatterChartType, CategoricalChartType, IndicatorChartType, TableType, AreamapChartType, BoxplotChartType, ScattermapChartType, RangeChartType, TableChartType } from './chart-options-processor/translations/types';
 import { DataPointsEventHandler } from './props';
 import { LegendPosition } from './chart-options-processor/translations/legend-section';
-import { GeoDataElement, RawGeoDataElement } from './chart-data/types';
 import { Coordinates } from './charts/map-charts/scattermap/types';
 import { StyledColumn, StyledMeasureColumn, Hierarchy, HierarchyId } from '.';
 import { HighchartsOptionsInternal } from './chart-options-processor/chart-options-service';
 import { CSSProperties } from 'react';
+import { GeoDataElement, RawGeoDataElement } from './chart/restructured-charts/areamap-chart/types';
+import { TabCornerRadius, TabInterval, TabSize } from './widgets/tabber-widget';
 export type { SortDirection, PivotRowsSort } from '@sisense/sdk-data';
 export type { AppConfig } from './app/client-application';
 export type { DateConfig } from './query/date-formats';
@@ -239,6 +240,8 @@ export interface BaseAxisStyleOptions {
     /** Configuration for second Y axis */
     y2Axis?: AxisLabel;
 }
+/** Style options for charts of cartesian family @internal */
+export type CartesianStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions;
 /** Configuration options that define functional style of the various elements of LineChart */
 export interface LineStyleOptions extends BaseStyleOptions, BaseAxisStyleOptions {
     /** Configuration that defines line width */
@@ -902,6 +905,18 @@ export interface GeneralThemeSettings {
     primaryButtonTextColor?: string;
     /** Hover color for primary buttons */
     primaryButtonHoverColor?: string;
+    /**
+     * Theme settings for popover
+     *
+     * @internal
+     */
+    popover?: PopoverThemeSettings;
+    /**
+     * Theme settings for buttons
+     *
+     * @internal
+     */
+    buttons?: ButtonsThemeSettings;
 }
 /** Possible sizes for spacing. */
 export type SpaceSizes = 'None' | 'Large' | 'Medium' | 'Small';
@@ -962,6 +977,145 @@ export type FilterThemeSettings = {
         backgroundColor?: string;
     };
 };
+/**
+ * @internal
+ */
+export declare enum ElementStates {
+    DEFAULT = "default",
+    HOVER = "hover",
+    FOCUS = "focus"
+}
+/**
+ * Represents state-based color settings for an element.
+ *
+ * @internal
+ */
+export type ElementStateColors = {
+    /** Default color */
+    default: string;
+    /** Hover state color */
+    hover?: string;
+    /** Focus state color */
+    focus?: string;
+};
+/**
+ * Theme settings for input elements.
+ *
+ * @internal
+ */
+export type InputThemeSettings = {
+    /** Background color */
+    backgroundColor?: string;
+    /** Text color */
+    textColor?: string;
+    /** Border color */
+    borderColor?: string | ElementStateColors;
+    /** Corner radius */
+    cornerRadius?: number;
+    /** Theme settings for dropdown list */
+    dropdownList?: {
+        /** Background color */
+        backgroundColor?: string;
+        /** Text color */
+        textColor?: string;
+        /** Border color */
+        borderColor?: string;
+        /** Corner radius */
+        cornerRadius?: number;
+        /** Shadow */
+        shadow?: string;
+        /** Theme settings for dropdown list item */
+        item?: {
+            /** Background color */
+            backgroundColor?: string | ElementStateColors;
+            /** Text color */
+            textColor?: string;
+        };
+    };
+    /** Theme settings for datepicker */
+    datepicker?: {
+        /** Background color */
+        backgroundColor?: string;
+        /** Text color */
+        textColor?: string;
+        /** Corner radius */
+        cornerRadius?: number;
+        /** Shadow */
+        shadow?: string;
+        /** Theme settings for datepicker day item */
+        item?: {
+            /** Background color */
+            backgroundColor?: string | ElementStateColors;
+            /** Text color */
+            textColor?: string | ElementStateColors;
+        };
+    };
+};
+/**
+ * Theme settings for popover
+ *
+ * @internal
+ */
+export type PopoverThemeSettings = {
+    /** Corner radius */
+    cornerRadius?: number;
+    /** Shadow */
+    shadow?: string;
+    /** Theme settings for popover header */
+    header?: {
+        /** Background color */
+        backgroundColor?: string;
+        /** Text color */
+        textColor?: string;
+    };
+    /** Theme settings for popover footer */
+    footer?: {
+        /** Background color */
+        backgroundColor?: string;
+        /** Text color */
+        textColor?: string;
+    };
+    /** Theme settings for popover content */
+    content?: {
+        /** Background color */
+        backgroundColor?: string;
+        /** Text color */
+        textColor?: string;
+        /** Theme settings for clickable list */
+        clickableList?: {
+            /** Theme settings for clickable list item */
+            item?: {
+                /** Text color */
+                textColor?: string;
+                /** Background color */
+                backgroundColor?: string;
+                /** Setting to be applied on hover */
+                hover?: {
+                    /** Text color */
+                    textColor?: string;
+                    /** Background color */
+                    backgroundColor?: string;
+                };
+            };
+        };
+    };
+    /** Theme settings for popover input */
+    input?: InputThemeSettings;
+};
+/**
+ * Theme settings for buttons
+ *
+ * @internal
+ */
+export type ButtonsThemeSettings = {
+    /** Theme settings for cancel button */
+    cancel?: {
+        /** Background color */
+        backgroundColor?: string | ElementStateColors;
+        /** Text color */
+        textColor?: string;
+    };
+};
 /** Theme settings defining the look and feel of components. */
 export interface ThemeSettings {
     /** Chart theme settings */
@@ -1499,3 +1653,51 @@ export type CustomTranslationObject = {
      */
     namespace?: string;
 };
+/**
+ * Single Tabber Widget tab object without styling
+ * @internal
+ */
+export type TabberTab = {
+    displayWidgetIds: string[];
+    title: string;
+};
+/**
+ * Tabber widget DTO style property
+ * @internal
+ */
+export type TabberDtoStyle = TabberStyleProps & {
+    activeTab: string;
+};
+/**
+ * Configuration options that define style of the various elements of the Tabber component.
+ * @internal
+ */
+export type TabberStyleOptions = {
+    descriptionColor: string;
+    selectedBkgColor: string;
+    selectedColor: string;
+    showDescription: boolean;
+    showSeparators: boolean;
+    showTitle: boolean;
+    tabCornerRadius: TabCornerRadius;
+    tabsAlignment: string;
+    tabsInterval: TabInterval;
+    tabsSize: TabSize;
+    unselectedBkgColor: string;
+    unselectedColor: string;
+    useSelectedBkg: boolean;
+    useUnselectedBkg: boolean;
+};
+/**
+ * Configuration options that defined tabber look and feel, including tabs and active tab.
+ * @internal
+ */
+export type TabberStyleProps = TabberStyleOptions & TabberConfig;
+/**
+ * Tabber business logic configuration
+ * @internal
+ */
+export type TabberConfig = {
+    tabs: TabberTab[];
+    activeTab: number;
+};

package/dist/packages/sdk-ui/src/utils/data-sources-utils.d.ts

@@ -0,0 +1,8 @@
+import { DataSource } from '@sisense/sdk-data';
+export type DataSourceObject = {
+    title: string;
+    id: string;
+};
+export declare const toDataSourceObject: (dataSource: DataSource) => DataSourceObject;
+export declare const getDataSourceId: (dataSource: DataSource) => string;
+export declare const getDataSourceTitle: (dataSource: DataSource) => string;

package/dist/packages/sdk-ui/src/utils/generate-attribute-name.d.ts

@@ -0,0 +1,2 @@
+import { TFunction } from '@sisense/sdk-common';
+export declare function generateAttributeName(t: TFunction, columnName: string, granularity?: string): string;

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

@@ -44,6 +44,10 @@ export type AnyObject = Record<string, any>;
  * Empty object with no properties
  */
 export type EmptyObject = Record<string, never>;
+/**
+ * Any array
+ */
+export type AnyArray = any[];
 /**
  * Allows you to make a property of an object required.
  *
@@ -57,4 +61,38 @@ export type EmptyObject = Record<string, never>;
  * type TRequiredB = WithRequiredProp<T, 'b'>; // { a: string; b: number; c?: boolean; }
  */
 export type WithRequiredProp<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+/**
+ * Universal generic state for hooks that fetch data from the REST API.
+ */
+export type RestApiHookState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = RestApiHookSuccessState<DataKey, SuccessDataType> | RestApiHookErrorState<DataKey> | RestApiHookLoadingState<DataKey>;
+/** Success state of the REST API hook */
+export type RestApiHookSuccessState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = {
+    isLoading: false;
+    isError: false;
+    isSuccess: true;
+    error: undefined;
+    status: 'success';
+} & {
+    [key in DataKey]: SuccessDataType;
+};
+/** Error state of the REST API hook */
+export type RestApiHookErrorState<DataKey extends string> = {
+    isLoading: false;
+    isError: true;
+    isSuccess: false;
+    error: Error;
+    status: 'error';
+} & {
+    [key in DataKey]: undefined;
+};
+/** Loading state of the REST API hook */
+export type RestApiHookLoadingState<DataKey extends string> = {
+    isLoading: true;
+    isError: false;
+    isSuccess: false;
+    error: undefined;
+    status: 'loading';
+} & {
+    [key in DataKey]: undefined;
+};
 export {};

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

@@ -4789,6 +4789,7 @@ export declare function getDashboardFilters(dashboardFilters: Array<FilterDto |
             } | undefined;
         } | undefined;
         merged?: boolean | undefined;
+        panel?: "rows" | "columns" | undefined;
     };
 }[];
 /**

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

@@ -1,13 +1,24 @@
-import { ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions, WidgetStyleOptions, TextWidgetStyleOptions } from '../types';
+import { ChartStyleOptions, TableStyleOptions, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, GaugeIndicatorStyleOptions, PivotTableStyleOptions, SpaceSizes, RadiusSizes, ShadowsTypes, AlignmentTypes, WidgetStyleOptions, TextWidgetStyleOptions } from '../types';
 import { WidgetSubtype, WidgetType, TableWidgetStyle, IndicatorWidgetStyle, PivotWidgetStyle, WidgetDesign, WidgetDto } from './types';
-/**
- * @internal
- */
-export type CartesianChartStyleOptions = LineStyleOptions | AreaStyleOptions | StackableStyleOptions;
 export declare function extractTableChartStyleOptions(widgetStyle: TableWidgetStyle): TableStyleOptions;
 export declare const getIndicatorTypeSpecificOptions: (widgetSubtype: WidgetSubtype, widgetStyle: IndicatorWidgetStyle) => NumericSimpleIndicatorStyleOptions | NumericBarIndicatorStyleOptions | GaugeIndicatorStyleOptions;
 export declare function extractPivotTableStyleOptions(widgetStyle: PivotWidgetStyle): PivotTableStyleOptions;
 export declare function extractStyleOptions<WType extends WidgetType>(widgetType: WType, widget: WidgetDto): ChartStyleOptions | TableStyleOptions | TextWidgetStyleOptions;
+export declare const getFlattenWidgetDesign: (widgetDesign: WidgetDesign) => {
+    backgroundColor: string;
+    spaceAround: SpaceSizes;
+    cornerRadius: RadiusSizes;
+    shadow: ShadowsTypes;
+    border: boolean;
+    borderColor: string;
+    header: {
+        titleTextColor: string;
+        titleAlignment: AlignmentTypes;
+        dividerLine: boolean;
+        dividerLineColor: string;
+        backgroundColor: string;
+    };
+};
 /**
  * Merges the widget style with the widget design
  *

package/dist/packages/sdk-ui/src/widgets/drilldown-widget.d.ts

@@ -29,7 +29,7 @@ import { DrilldownWidgetProps } from '../props';
  *
  * Additional drilldown examples:
  *
- * - [Detached Breadcrumbs](https://www.sisense.com/platform/compose-sdk/playground/?example=use-cases%2Fdrilldown-detached-breadcrumbs)
+ * - [Detached Breadcrumbs](https://www.sisense.com/developers/playground/?example=use-cases%2Fdrilldown-detached-breadcrumbs)
  *
  * @param props - DrilldownWidget properties
  * @returns DrilldownWidget wrapper component

package/dist/packages/sdk-ui/src/widgets/tabber-widget.d.ts

@@ -0,0 +1,35 @@
+import { TabberWidgetProps } from '../props';
+/**
+ * Tabber widget tab size
+ * @group TabberWidget
+ * @internal
+ */
+export type TabSize = 'SMALL' | 'MEDIUM' | 'LARGE';
+/**
+ * Tabber widget tab interval
+ * @group TabberWidget
+ * @internal
+ */
+export type TabInterval = 'SMALL' | 'MEDIUM' | 'LARGE';
+/**
+ * Tabber widget tab alignment
+ * @group TabberWidget
+ * @internal
+ */
+export type TabAlignment = 'LEFT' | 'CENTER' | 'RIGHT';
+/**
+ * Tabber widget tab corner radius
+ * @group TabberWidget
+ * @internal
+ */
+export type TabCornerRadius = 'SMALL' | 'MEDIUM' | 'LARGE' | 'NONE';
+/**
+ * Visual representation of a Fusion's tabber widget
+ * @param styleOptions
+ * @param description
+ * @param props
+ * @constructor
+ * @group TabberWidget
+ * @internal
+ */
+export declare const TabberWidget: ({ styleOptions, description, ...props }: TabberWidgetProps) => import("react/jsx-runtime").JSX.Element;