@sisense/sdk-ui 1.32.0 → 1.34.0

package/dist/packages/sdk-ui/src/theme-provider/custom-theme-provider.d.ts

@@ -1,13 +1,10 @@
 import { PropsWithChildren } from 'react';
-import { CompleteThemeSettings } from '../types';
+import { CompleteThemeSettings, CustomContextProviderProps } from '../types';
 /** @internal */
-export type CustomThemeProviderProps = {
-    context: {
-        themeSettings: CompleteThemeSettings;
-        skipTracking?: boolean;
-    };
-    error?: Error;
-};
+export type CustomThemeProviderProps = CustomContextProviderProps<{
+    themeSettings: CompleteThemeSettings;
+    skipTracking?: boolean;
+}>;
 /**
  * Custom Theme Provider component that allows passing external theme context.
  *

package/dist/packages/sdk-ui/src/theme-provider/use-theme-settings.d.ts

@@ -1,4 +1,4 @@
-import { ThemeOid, ThemeSettings, CompleteThemeSettings } from '../types';
+import { CompleteThemeSettings, ThemeOid, ThemeSettings } from '../types';
 /**
  * Returns the theme settings for the given theme OID or theme settings and error if it happened.
  *

package/dist/packages/sdk-ui/src/theme-provider/utils.d.ts

@@ -0,0 +1,5 @@
+import { ElementStateColors, ElementStates } from '../types';
+/**
+ * @internal
+ */
+export declare const getElementStateColor: (value: string | ElementStateColors, state: ElementStates) => string;

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

@@ -82,6 +82,9 @@ export declare const translation: {
             dimensionNotFound: string;
             attributeNotFound: string;
         };
+        addFilterPopover: {
+            noDataSources: string;
+        };
     };
     errorBoxText: string;
     chartNoData: string;
@@ -337,6 +340,13 @@ export declare const translation: {
             after: string;
         };
     };
+    dataBrowser: {
+        addFilter: string;
+        selectField: string;
+        configureFilter: string;
+        noResults: string;
+        searchPlaceholder: string;
+    };
     pivotTable: {
         grandTotal: string;
         subTotal: string;

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

@@ -92,6 +92,9 @@ export declare const resources: {
                 dimensionNotFound: string;
                 attributeNotFound: string;
             };
+            addFilterPopover: {
+                noDataSources: string;
+            };
         };
         errorBoxText: string;
         chartNoData: string;
@@ -347,6 +350,13 @@ export declare const resources: {
                 after: string;
             };
         };
+        dataBrowser: {
+            addFilter: string;
+            selectField: string;
+            configureFilter: string;
+            noResults: string;
+            searchPlaceholder: string;
+        };
         pivotTable: {
             grandTotal: string;
             subTotal: string;
@@ -436,6 +446,9 @@ export declare const resources: {
                 dimensionNotFound: string;
                 attributeNotFound: string;
             };
+            addFilterPopover: {
+                noDataSources: string;
+            };
         };
         errorBoxText: string;
         chartNoData: string;
@@ -691,6 +704,13 @@ export declare const resources: {
                 after: string;
             };
         };
+        dataBrowser: {
+            addFilter: string;
+            selectField: string;
+            configureFilter: string;
+            noResults: string;
+            searchPlaceholder: string;
+        };
         pivotTable: {
             grandTotal: string;
             subTotal: string;

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

@@ -70,12 +70,12 @@ export type SeriesLabels = {
     /**
      * Boolean flag that defines if value should be shown in series labels
      * (if not specified, value will be shown by default)
-     * */
+     */
     showValue?: boolean;
     /**
      * Boolean flag that defines if percentage should be shown in series labels
      * (only applicable for subtypes that support percentage, like "stacked100")
-     * */
+     */
     showPercentage?: boolean;
 };
 /**
@@ -905,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';
@@ -965,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 */
@@ -1050,7 +1201,7 @@ export interface WidgetContainerStyleOptions {
  * Configuration options that define functional style of the various elements of the Nlq Chart Widget
  *
  * @internal
- * */
+ */
 export type NlqChartWidgetStyleOptions = {
     header?: {
         hidden?: boolean;
@@ -1504,6 +1655,7 @@ export type CustomTranslationObject = {
 };
 /**
  * Single Tabber Widget tab object without styling
+ *
  * @internal
  */
 export type TabberTab = {
@@ -1512,6 +1664,7 @@ export type TabberTab = {
 };
 /**
  * Tabber widget DTO style property
+ *
  * @internal
  */
 export type TabberDtoStyle = TabberStyleProps & {
@@ -1519,6 +1672,7 @@ export type TabberDtoStyle = TabberStyleProps & {
 };
 /**
  * Configuration options that define style of the various elements of the Tabber component.
+ *
  * @internal
  */
 export type TabberStyleOptions = {
@@ -1539,14 +1693,24 @@ export type TabberStyleOptions = {
 };
 /**
  * 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;
 };
+/** @internal */
+export type CustomContextProviderProps<P> = {
+    context: P;
+    error?: undefined;
+} | {
+    context?: undefined;
+    error: Error;
+};

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/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.
  *
@@ -60,9 +64,9 @@ export type WithRequiredProp<T, K extends keyof T> = Omit<T, K> & Required<Pick<
 /**
  * Universal generic state for hooks that fetch data from the REST API.
  */
-export type RestApiHookState<DataKey extends string, SuccessDataType extends AnyObject> = RestApiHookSuccessState<DataKey, SuccessDataType> | RestApiHookErrorState<DataKey> | RestApiHookLoadingState<DataKey>;
+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> = {
+export type RestApiHookSuccessState<DataKey extends string, SuccessDataType extends AnyObject | AnyArray> = {
     isLoading: false;
     isError: false;
     isSuccess: true;

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

@@ -4785,6 +4785,13 @@ export declare function getDashboardFilters(dashboardFilters: Array<FilterDto |
         sort?: "desc" | "asc" | undefined;
         in?: {
             selected?: {
+                /**
+                 * Checks if a highlight filter is applicable to a widget.
+                 *
+                 * @param {FilterDto} filter - The filter to be checked.
+                 * @param {WidgetDto} widget - The widget that filters are applied to.
+                 * @returns {boolean} `true` if the filter is applicable; otherwise, `false`.
+                 */
                 jaql: import("@sisense/sdk-data").FilterJaql;
             } | undefined;
         } | undefined;

package/dist/packages/sdk-ui/src/widget-by-id/use-get-dashboard-model-and-widget-model.d.ts

@@ -1,6 +1,7 @@
 import { DashboardModel, WidgetModel } from '../models';
 /**
  * Custom hook for fetching a dashboard model and a widget model.
+ *
  * @returns
  */
 export declare function useGetDashboardModelAndWidgetModel({ widgetOid, dashboardOid, shouldLoadFullDashboard, }: {

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

@@ -1,30 +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