@sisense/sdk-ui 2.22.0 → 2.24.0

package/dist/packages/sdk-ui/src/infra/app/settings/types/features.d.ts

@@ -137,7 +137,8 @@ type AiStudioFeature = Feature<'aiStudio', {
     isUsageDisplayEnabled?: boolean;
 }>;
 type NewNavigationBetaFeature = Feature<'newNavigationBeta'>;
-export type Features = (AlertingFeature | LiveQueryFeature | NlqFeature | PivotFeature | CustomCodeFeature | CustomCodeTransformationFeature | BuildDestinationFeature | VersionHistoryFeature | EmbedCodeFeature | LiveCustomColumnFeature | ExportingEngineV2Feature | ExportingXlsxV2Feature | ExportingCsvFeature | ConnectionManagementFeature | SisenseLightFeature | WizardSqlEditorFeature | MultiTenancyFeature | BloxFeature | FunnelFeature | Cloud360Feature | BreakByToggleFeature | GitIntegrationFeature | InfusionFeature | InfusionWebClientFeature | NotebooksFeature | AdminWebClientFeature | DateTimeFiltersFeature | TextFiltersFeature | NumericFiltersFeature | FilterRelationsEnabledFeature | TimeLevelSupportEnabledFeature | SyncDashboardEventsFeature | UserProfileFeature | ScatterFeature | CustomFontsFeature | PreferWidgetImageServerExportFeature | NewAdminUIFeature | SharedFormulasFeature | SideBarFeature | InfusionTokenEndpointFeature | ExplanationsForIndicatorWidgetsFeature | ExplanationsForCategoricalWidgetsFeature | WidgetDesignStyleFeature | FiscalOnFeature | ReactAnalyticsWidgetEditorFeature | DynamicSQLFeature | NewCustomConnectorFeature | CrossTenantPerspectivesFeature | EnableDatamodelPerspectiveFeature | AlwaysDirectRelationsFeature | ModelStatisticsFeature | ExportingCsvFormattedFeature | FlexibleTooltipsFeature | DimensionalModelingFeature | CloudCDNFeature | OnboardingFeature | AiAssistantFeature | AiStudioFeature | NewNavigationBetaFeature)[];
+type ApiTelemetryFeature = Feature<'apiTelemetry'>;
+export type Features = (AlertingFeature | LiveQueryFeature | NlqFeature | PivotFeature | CustomCodeFeature | CustomCodeTransformationFeature | BuildDestinationFeature | VersionHistoryFeature | EmbedCodeFeature | LiveCustomColumnFeature | ExportingEngineV2Feature | ExportingXlsxV2Feature | ExportingCsvFeature | ConnectionManagementFeature | SisenseLightFeature | WizardSqlEditorFeature | MultiTenancyFeature | BloxFeature | FunnelFeature | Cloud360Feature | BreakByToggleFeature | GitIntegrationFeature | InfusionFeature | InfusionWebClientFeature | NotebooksFeature | AdminWebClientFeature | DateTimeFiltersFeature | TextFiltersFeature | NumericFiltersFeature | FilterRelationsEnabledFeature | TimeLevelSupportEnabledFeature | SyncDashboardEventsFeature | UserProfileFeature | ScatterFeature | CustomFontsFeature | PreferWidgetImageServerExportFeature | NewAdminUIFeature | SharedFormulasFeature | SideBarFeature | InfusionTokenEndpointFeature | ExplanationsForIndicatorWidgetsFeature | ExplanationsForCategoricalWidgetsFeature | WidgetDesignStyleFeature | FiscalOnFeature | ReactAnalyticsWidgetEditorFeature | DynamicSQLFeature | NewCustomConnectorFeature | CrossTenantPerspectivesFeature | EnableDatamodelPerspectiveFeature | AlwaysDirectRelationsFeature | ModelStatisticsFeature | ExportingCsvFormattedFeature | FlexibleTooltipsFeature | DimensionalModelingFeature | CloudCDNFeature | OnboardingFeature | AiAssistantFeature | AiStudioFeature | NewNavigationBetaFeature | ApiTelemetryFeature)[];
 export type FeatureByKey<K extends string> = Extract<Features[number], {
     key: K;
 }>;

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

@@ -0,0 +1,236 @@
+import { DataSource } from '@sisense/sdk-data';
+import { PivotQueryClient } from '@sisense/sdk-pivot-query-client';
+import { QueryClient } from '@sisense/sdk-query-client';
+import { HttpClient } from '@sisense/sdk-rest-client';
+import { TrackingEventDetails } from '@sisense/sdk-tracking';
+import { DateConfig, LoadingIndicatorConfig, TranslationConfig } from '../../types';
+import { AppSettings } from './settings/settings';
+/**
+ * Application configuration
+ */
+export type AppConfig = {
+    /**
+     * A [date-fns Locale](https://date-fns.org/v2.30.0/docs/Locale)
+     */
+    locale?: Locale;
+    /**
+     * Translation Configuration
+     */
+    translationConfig?: TranslationConfig;
+    /**
+     * Date Configurations
+     */
+    dateConfig?: DateConfig;
+    /**
+     * Loading Indicator Configurations
+     */
+    loadingIndicatorConfig?: LoadingIndicatorConfig;
+    /**
+     * Query Cache Configurations.
+     *
+     * See [Client query caching guide](/guides/sdk/guides/client-query-caching.html) for more details.
+     *
+     * @beta
+     */
+    queryCacheConfig?: {
+        /**
+         * Whether to enable client-side query caching.
+         *
+         * If not specified, the default value is `false`
+         */
+        enabled?: boolean;
+    };
+    /**
+     * Query limit (max rows count that will be fetched in query)
+     *
+     * @default 20000
+     */
+    queryLimit?: number;
+    /**
+     * Accessibility configuration. Set the `accessibilityConfig.enabled` property to `true` to enable accessibility features for charts built with Highcharts.
+     *
+     * Once the accessibility configuration in enabled, you can use the default descriptions or choose to create custom configurations for the descriptions of a chart, its axes, its series, and values description formatting. To create custom configurations, use the `highchartsOptions` object that is passed to the {@link BeforeRenderHandler} of the chart's `onBeforeRender` callback. Modify the object using the accessibility options as described in the [Accessibility module documentation](https://www.highcharts.com/docs/accessibility/accessibility-module).
+     *
+     * Note that enabling accessibility also causes markers to appear in charts even if they are disabled using the chart's `styleOptions`.
+     *
+     * This feature is in alpha.
+     */
+    accessibilityConfig?: {
+        /**
+         * Whether to enable accessibility features
+         *
+         * If not specified, the default value is `false`
+         */
+        enabled?: boolean;
+    };
+    /**
+     * Configuration of the tabber widgets feature
+     *
+     * Only tabber widgets that are configured using the Fusion UI as documented [here](https://docs.sisense.com/main/SisenseLinux/tabber.htm#Creating) are supported.
+     */
+    tabberConfig?: {
+        /**
+         * Whether to enable tabber widget support
+         *
+         * If not specified, the default value is `true`
+         *
+         * @deprecated Tabber widgets are now supported by default and this property is no longer needed.
+         */
+        enabled?: boolean;
+    };
+    /**
+     * Configuration of the component that is rendered in case of an error
+     */
+    errorBoundaryConfig?: {
+        /**
+         * Whether to show error text without hovering over the error icon
+         *
+         * If not specified, the default value is `false`
+         */
+        alwaysShowErrorText?: boolean;
+    };
+    /**
+     * API Telemetry headers to attach to every request made by the SDK.
+     * Attached only when the API Telemetry feature flag is enabled.
+     *
+     * Support only headers with the prefix 'x-sisense-'.
+     *
+     * @example
+     * ```tsx
+     * appConfig={{
+     *   apiTelemetryHeaders: {
+     *     'x-sisense-embed': 'iframe',
+     *   },
+     * }}
+     * ```
+     * @sisenseInternal
+     */
+    apiTelemetryHeaders?: Record<string, string>;
+    /**
+     * Tracking configuration
+     */
+    trackingConfig?: {
+        /**
+         * Whether to enable or disable tracking in development or test environment.
+         *
+         * If not specified, the default value is `true`
+         *
+         * In production, tracking is always enabled.
+         *
+         * @internal
+         */
+        enabled?: boolean;
+        /**
+         * Callback to be invoked when tracking event occurs
+         */
+        onTrackingEvent?: (payload: TrackingEventDetails) => void;
+    };
+    /**
+     * Configuration of the Jump To Dashboard feature
+     *
+     * This feature is currently in Beta.
+     *
+     * **Note:** Only widgets that are configured using the Fusion UI as documented
+     * [here](https://docs.sisense.com/main/SisenseLinux/jump-to-dashboard.htm?tocpath=Add-ons%7C_____2#ConfiguringJTDPerWidget)
+     * are supported in Compose SDK.
+     *
+     * Widgets that are configured using an older version of Jump To Dashboard, or via scripts, are not supported.
+     *
+     * Known limitations:
+     * - Jump To Dashboard is not currently supported for Pivot widgets.
+     * - Target dashboards are always opened in a popup window, options to open in new tab and new window are not supported.
+     * - Show 'Header' and 'Dashboards panel' options are not supported (only relevant to Fusion).
+     * - 'Reset filters after JTD' is not supported, since changes are never saved to the target dashboard using Compose SDK.
+     *
+     * The following Jump To Dashboard configuration is supported:
+     *   - Target dashboard set by Id, with configurable display title
+     *   - 'Popup window' display type ('Allow Resize' not supported)
+     *   - Display filter panel on the target dashboard (true/false)
+     *   - Navigation setting (Click / Right click)
+     *     - Note: 'Keep changes made by user' is not supported, since changes are never saved to the target dashboard using Compose SDK.
+     *   - Apply filters to the target dashboard (select)
+     *   - Merge target dashboard filters (true/false)
+     *
+     */
+    jumpToDashboardConfig?: {
+        /**
+         * Whether to enable or disable the Jump To Dashboard feature
+         *
+         * If not specified, the default value is `true`
+         */
+        enabled?: boolean;
+    };
+    /**
+     * Global configuration for some specific aspects of data visualizations.
+     */
+    chartConfig?: {
+        /** `Table` and `PivotTable` configuration */
+        tabular?: {
+            /** Configuration for HTML content in `Table` and `PivotTable` */
+            htmlContent?: {
+                /**
+                 * If true, the contents of table and pivot table cells are rendered as HTML instead of text.
+                 *
+                 * **Note**: The {@link StyledColumn.isHtml} property of columns in `dataOptions` are of higher precedence, and will therefore override this setting.
+                 * @default true
+                 * */
+                enabled?: boolean;
+                /**
+                 * Enables sanitization of HTML content before rendering to prevent XSS attacks.
+                 * @default true
+                 * */
+                sanitizeContents?: boolean;
+            };
+            /**
+             * Boolean flag whether to always show the results per page select
+             *
+             * If `true`, the results per page select will be shown even if there is only one page of results.
+             * Currently only supported for `PivotTable`.
+             *
+             * @default false
+             */
+            alwaysShowResultsPerPage?: boolean;
+        };
+    };
+};
+/**
+ * Stands for a Sisense Client Application which connects to a Sisense Environment
+ *
+ * @internal
+ */
+export interface ClientApplication {
+    /**
+     * Gets the underlying HTTP Client
+     */
+    readonly httpClient: HttpClient;
+    /**
+     * Gets the underlying Pivot Query Client
+     */
+    readonly pivotQueryClient: PivotQueryClient;
+    /**
+     * Gets the underlying Query Client
+     */
+    readonly queryClient: QueryClient;
+    /**
+     * Gets the default data source being used as default for child components with no explicitly defined data source
+     */
+    readonly defaultDataSource?: DataSource;
+    /**
+     * Gets the application settings
+     */
+    settings: AppSettings;
+    /**
+     * Gets the module to control query cache
+     */
+    queryCache: {
+        /**
+         * Clears the query cache
+         */
+        clear: () => void;
+    };
+}
+export type SystemSettings = {
+    tracking?: {
+        apiTelemetry?: boolean;
+    };
+};

package/dist/packages/sdk-ui/src/infra/contexts/custom-widgets-provider/custom-widgets-provider-adapter.d.ts

@@ -10,7 +10,8 @@ export type CustomWidgetsContextAdapter<T = CustomWidgetComponentProps> = {
 /**
  * Custom Widget Provider Adapter component that allows passing external custom widgets context.
  *
- * Note: it is designed to serve as a bridge for passing pre-initialized custom widget data between an external wrapper and child React components.
+ * Bridges pre-initialized custom widget data from an external wrapper to child React components.
+ * Syncs the widget registry with customWidgetsMap on updates and cleans up on unmount.
  *
  * @internal
  */

package/dist/packages/sdk-ui/src/infra/contexts/custom-widgets-provider/use-custom-widgets.d.ts

@@ -1,4 +1,4 @@
-import { CustomWidgetComponent } from './types';
+import { CustomWidgetComponent, CustomWidgetComponentProps } from './types';
 /**
  * Hook that provides API for configuring custom widgets.
  *
@@ -18,8 +18,15 @@ import { CustomWidgetComponent } from './types';
  *
  * @group Dashboards
  */
-export declare const useCustomWidgets: () => {
-    registerCustomWidget: <T = any>(customWidgetType: string, customWidget: CustomWidgetComponent<T>) => void;
+export declare const useCustomWidgets: () => UseCustomWidgetsResult;
+/**
+ * Result of the `useCustomWidgets` hook.
+ */
+export type UseCustomWidgetsResult = {
+    /** Registers a custom widget. */
+    registerCustomWidget: <T = CustomWidgetComponentProps>(customWidgetType: string, customWidget: CustomWidgetComponent<T>) => void;
+    /** Checks if a custom widget is registered. */
     hasCustomWidget: (customWidgetType: string) => boolean;
-    getCustomWidget: (customWidgetType: string) => CustomWidgetComponent<any> | undefined;
+    /** Gets a custom widget. */
+    getCustomWidget: (customWidgetType: string) => CustomWidgetComponent | undefined;
 };

package/dist/packages/sdk-ui/src/infra/contexts/sisense-context/sisense-context.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { TrackingEventDetails } from '@sisense/sdk-tracking';
 import { SisenseContextProviderProps } from '../../..';
-import { ClientApplication } from '../../app/client-application';
+import { type ClientApplication } from '../../app/types';
 export type SisenseContextPayload = {
     isInitialized: boolean;
     app?: ClientApplication;

package/dist/packages/sdk-ui/src/infra/contexts/theme-provider/theme-context.d.ts

@@ -8,7 +8,8 @@ export declare const ThemeContext: import("react").Context<{
  * Hook to get the current theme settings.
  *
  * @returns The current theme settings
- * @internal
+ *
+ * @sisenseInternal
  */
 export declare const useThemeContext: () => {
     themeSettings: CompleteThemeSettings;

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

@@ -16,6 +16,6 @@ export type TrackingDecoratorConfig = {
 /**
  * Adds tracking to the component
  *
- * @internal
+ * @sisenseInternal
  */
 export declare const withTracking: ComponentDecorator<TrackingDecoratorConfig>;

package/dist/packages/sdk-ui/src/infra/decorators/hook-decorators/with-tracking.d.ts

@@ -1,4 +1,4 @@
-import { ClientApplication } from '../../app/client-application';
+import { ClientApplication } from '../../app/types';
 export type HookDecorator<DecoratorConfig> = (decoratorConfig: DecoratorConfig) => <HookArgs extends any[], HookResult>(hook: (...args: HookArgs) => HookResult) => (...args: HookArgs) => HookResult;
 /**
  * Tracks the hook event and sends it to the server.

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

@@ -0,0 +1,18 @@
+import { type PropsWithChildren } from 'react';
+import { CustomContextProviderProps } from '../../types';
+import type { Plugin } from './types.js';
+/** @internal */
+export type CustomPluginContextProviderContext = {
+    plugins: Plugin[];
+};
+/** @internal */
+export type CustomPluginContextProviderProps = CustomContextProviderProps<CustomPluginContextProviderContext>;
+/**
+ * Custom Plugin Context Provider component that allows passing external plugin context.
+ *
+ * Specifically designed to serve as a bridge for passing plugin context between an
+ * external framework wrapper and child React components.
+ *
+ * @internal
+ */
+export declare const CustomPluginContextProvider: React.FC<PropsWithChildren<CustomPluginContextProviderProps>>;

package/dist/packages/sdk-ui/src/infra/plugins/plugin-context.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="react" />
+import { WidgetPlugin } from './widget-plugins/types.js';
+import type { WidgetPluginRegistry } from './widget-plugins/widget-plugin-registry.js';
+/**
+ * Context for accessing registered plugins
+ *
+ * @internal
+ */
+export interface PluginContextValue {
+    /**
+     * Validated widget plugin declarations (metadata)
+     */
+    widgetPlugins: readonly WidgetPlugin[];
+    /**
+     * Central widget component registry (used for lookup and legacy bridge)
+     */
+    widgetRegistry: WidgetPluginRegistry;
+}
+/**
+ * Error message when a plugin hook/component is used outside PluginProvider.
+ * @internal
+ */
+export declare const PLUGIN_CONTEXT_MISSING_MESSAGE = "PluginContext is missing. Ensure PluginProvider (or a compatible provider) is an ancestor.";
+/**
+ * React context for plugin management.
+ * Default is null to avoid a shared WidgetPluginRegistry at module load (cross-test/consumer pollution).
+ * PluginProvider supplies a real value; consumers must check for null and throw if missing.
+ */
+export declare const PluginContext: import("react").Context<PluginContextValue | null>;

package/dist/packages/sdk-ui/src/infra/{contexts/plugin-provider → plugins}/plugin-provider.d.ts

@@ -1,9 +1,9 @@
 import { type ReactNode } from 'react';
-import { Plugin } from './types';
+import { Plugin } from './types.js';
 /**
  * Props for PluginProvider component
  *
- * @internal
+ * @sisenseInternal
  */
 export interface PluginProviderProps {
     /**
@@ -17,5 +17,7 @@ export interface PluginProviderProps {
 }
 /**
  * Plugin Provider component that validates and provides access to plugins
+ *
+ * @sisenseInternal
  */
 export declare const PluginProvider: React.FC<PluginProviderProps>;

package/dist/packages/sdk-ui/src/infra/{contexts/plugin-provider → plugins}/types.d.ts

@@ -1,9 +1,10 @@
+import type { WidgetPlugin } from './widget-plugins/types.js';
 /**
- * Plugin with metadata information
+ * Base plugin information
  *
- * @internal
+ * @sisenseInternal
  */
-export interface Plugin {
+export interface BasePluginInfo {
     /**
      * Unique name identifier for the plugin
      */
@@ -32,7 +33,7 @@ export interface Plugin {
 /**
  * Result of plugin validation
  *
- * @internal
+ * @sisenseInternal
  */
 export interface PluginValidationResult {
     /**
@@ -48,3 +49,10 @@ export interface PluginValidationResult {
      */
     reason?: string;
 }
+/**
+ * Plugin declaration.
+ * Currently only widget plugins are supported.
+ *
+ * @sisenseInternal
+ */
+export type Plugin = WidgetPlugin;

package/dist/packages/sdk-ui/src/infra/plugins/use-widget-plugin-registry.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Hook for accessing the widget plugin registry.
+ * Used internally by the CustomWidget renderer to look up components.
+ *
+ * @internal
+ */
+export declare const useWidgetPluginRegistry: () => import("./widget-plugins/widget-plugin-registry.js").WidgetPluginRegistry;

package/dist/packages/sdk-ui/src/infra/{contexts/plugin-provider → plugins}/validate-plugins.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from './types';
+import { Plugin } from './types.js';
 /**
  * Validates and returns only valid plugins.
  *