@sisense/sdk-ui 1.33.0 → 1.34.0

package/dist/packages/sdk-ui/src/filters/hooks/use-get-filter-members.d.ts

@@ -27,7 +27,7 @@ export interface GetFilterMembersSuccess {
      * Function to load more data rows
      *
      * @internal
-     * */
+     */
     loadMore: (count: number) => void;
     /** Whether the data fetching has failed */
     isError: false;
@@ -55,7 +55,7 @@ export interface GetFilterMembersError {
      * Function to load more data rows
      *
      * @internal
-     * */
+     */
     loadMore: (count: number) => void;
 }
 /**
@@ -74,7 +74,7 @@ export declare const useGetFilterMembersInternal: ({ filter, defaultDataSource,
  *
  * Those members can be used to display a list of members in a third-party filter component such as Material UI Select.
  *
- * * ## Example
+ * ## Example
  *
  * Retrieve selected members from a Filter on Country of the Sample ECommerce data model.
  *

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

@@ -5,7 +5,6 @@ import { CascadingFilterDto, FilterDto } from '../../api/types/dashboard-dto';
  *
  * @param filter - The filter to translate.
  * @returns FilterDto
- *
  * @internal
  */
 export declare function filterToFilterDto(filter: Filter): FilterDto | CascadingFilterDto;

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

@@ -9,6 +9,7 @@ export declare function translateWidgetsOptions(widgets?: WidgetDto[]): WidgetsO
 export declare function translateTabbersOptions(widgets?: WidgetDto[]): TabbersOptions;
 /**
  * Replace all shared formulas, which defined by id references, in the dashboard with their actual values.
+ *
  * @param dashboard - The dashboard DTO to replace shared formulas in
  * @param api - The REST API instance
  * @returns The dashboard DTO with shared formulas, defined by id references, replaced

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

@@ -43,6 +43,7 @@ export type WidgetsOptions = Record<WidgetId, {
  *
  * This property actually moves responsibility on the layout management from the tabber widgets to the dashboard,
  * storing all the tabbers configs in the single place
+ *
  * @internal
  */
 export type TabbersOptions = Record<WidgetId, TabberConfig>;

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

@@ -3,7 +3,6 @@ import type { Attribute, DataSource } from '@sisense/sdk-data';
  * Options for retrieving hierarchies.
  *
  * @internal
- *
  */
 export type GetHierarchiesOptions = {
     /**

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

@@ -1,10 +1,8 @@
-import { ReactNode } from 'react';
+import { PropsWithChildren } from 'react';
 import { PluginComponent, PluginComponentProps } from './types';
+import { CustomContextProviderProps } from '../types';
 /** @internal */
-export type CustomPluginsProviderProps<T = PluginComponentProps> = {
-    context: CustomPluginsContext<T>;
-    error?: Error;
-};
+export type CustomPluginsProviderProps = CustomContextProviderProps<CustomPluginsContext<PluginComponentProps>>;
 /** @internal */
 export type CustomPluginsContext<T = PluginComponentProps> = {
     pluginMap: Map<string, PluginComponent<T>>;
@@ -18,7 +16,4 @@ export type CustomPluginsContext<T = PluginComponentProps> = {
  *
  * @internal
  */
-export declare const CustomPluginsProvider: React.FC<{
-    context: CustomPluginsContext<any>;
-    children: ReactNode;
-}>;
+export declare const CustomPluginsProvider: React.FC<PropsWithChildren<CustomPluginsProviderProps>>;

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

@@ -1520,6 +1520,7 @@ export interface DrilldownWidgetProps {
 }
 /**
  * Tabber widget props designed to be a current state and is provided by use-tabber hook
+ *
  * @internal
  */
 export type TabberWidgetExtraProps = {
@@ -1528,6 +1529,7 @@ export type TabberWidgetExtraProps = {
 };
 /**
  * Tabber widget props
+ *
  * @internal
  */
 export type TabberWidgetProps = {

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

@@ -1,6 +1,6 @@
 export { ExecuteQuery } from './execute-query';
 export { useExecuteQuery } from './use-execute-query';
-export { useExecuteCsvQuery } from './use-execute-csv-query';
+export { useExecuteCsvQuery, useExecuteCsvQueryInternal } from './use-execute-csv-query';
 export { ExecuteQueryByWidgetId } from './execute-query-by-widget-id';
 export { useExecuteQueryByWidgetId, executeQueryByWidgetId, } from './use-execute-query-by-widget-id';
 export { useExecutePivotQuery } from './use-execute-pivot-query';

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

@@ -239,7 +239,7 @@ export type ExecuteQueryResult = QueryState & {
      * Function to load more data rows
      *
      * @internal
-     * */
+     */
     loadMore: (count: number) => void;
 };
 /** Configuration for {@link useExecuteCsvQuery} hook. */

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

@@ -1,12 +1,10 @@
 import { PropsWithChildren, type FunctionComponent } from 'react';
 import { SisenseContextPayload } from './sisense-context';
+import { CustomContextProviderProps } from '../types';
 /** @internal */
 export type CustomSisenseContext = SisenseContextPayload;
 /** @internal */
-export type CustomSisenseContextProviderProps = {
-    context?: CustomSisenseContext;
-    error?: Error;
-};
+export type CustomSisenseContextProviderProps = CustomContextProviderProps<CustomSisenseContext>;
 /**
  * Custom Sisense Context Provider component that allows passing external context.
  *

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/translation/resources/en.d.ts

@@ -82,6 +82,9 @@ export declare const translation: {
             dimensionNotFound: string;
             attributeNotFound: string;
         };
+        addFilterPopover: {
+            noDataSources: string;
+        };
     };
     errorBoxText: string;
     chartNoData: 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;
@@ -443,6 +446,9 @@ export declare const resources: {
                 dimensionNotFound: string;
                 attributeNotFound: string;
             };
+            addFilterPopover: {
+                noDataSources: string;
+            };
         };
         errorBoxText: string;
         chartNoData: 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;
 };
 /**
@@ -1201,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;
@@ -1655,6 +1655,7 @@ export type CustomTranslationObject = {
 };
 /**
  * Single Tabber Widget tab object without styling
+ *
  * @internal
  */
 export type TabberTab = {
@@ -1663,6 +1664,7 @@ export type TabberTab = {
 };
 /**
  * Tabber widget DTO style property
+ *
  * @internal
  */
 export type TabberDtoStyle = TabberStyleProps & {
@@ -1670,6 +1672,7 @@ export type TabberDtoStyle = TabberStyleProps & {
 };
 /**
  * Configuration options that define style of the various elements of the Tabber component.
+ *
  * @internal
  */
 export type TabberStyleOptions = {
@@ -1690,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/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/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