@sisense/sdk-ui 1.22.0 → 1.23.0

package/dist/packages/sdk-ui/src/models/widget/widget-model.d.ts

@@ -1,6 +1,6 @@
 import { DataSource, Filter } from '@sisense/sdk-data';
 import { ChartDataOptions, PivotTableDataOptions } from '../../chart-data-options/types';
-import { WidgetType } from '../../dashboard-widget/types';
+import { WidgetType } from '../../widget-by-id/types';
 import { ChartProps, ChartWidgetProps, PivotTableProps, TableProps, TableWidgetProps, PivotTableWidgetProps, TextWidgetProps } from '../../props';
 import { ExecutePivotQueryParams, ExecuteQueryParams } from '../../query-execution';
 import { ChartType, DrilldownOptions, WidgetStyleOptions } from '../../types';

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

@@ -1,11 +1,11 @@
 import { Attribute, Filter, Measure, DataSource, Data, QueryResultData, FilterRelations } from '@sisense/sdk-data';
-import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, DashboardWidgetStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, CustomTranslationObject } from './types';
+import { ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ThemeSettings, PolarStyleOptions, PieStyleOptions, StackableStyleOptions, LineStyleOptions, AreaStyleOptions, FunnelStyleOptions, ScatterStyleOptions, ChartStyleOptions, ChartType, IndicatorStyleOptions, DrilldownOptions, ThemeOid, TreemapStyleOptions, CustomDrilldownResult, MenuPosition, MenuItemSection, SunburstStyleOptions, ChartWidgetStyleOptions, TableWidgetStyleOptions, WidgetByIdStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, DataPoint, ScatterDataPoint, AreamapDataPoint, BoxplotDataPoint, ChartDataPoints, ScattermapDataPoint, PivotTableStyleOptions, PivotTableWidgetStyleOptions, RegularChartType, RegularChartStyleOptions, TabularChartStyleOptions, TableStyleOptions, AreaRangeStyleOptions, DrilldownSelection, TextWidgetStyleOptions, GenericDataOptions, DashboardWidgetStyleOptions } from './types';
 import { HighchartsOptions } from './chart-options-processor/chart-options-service';
 import { ComponentType, PropsWithChildren, ReactNode } from 'react';
 import { IndicatorChartDataOptions, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, ScatterChartDataOptions, TableDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, PivotTableDataOptions, RegularChartDataOptions, TabularChartDataOptions, RangeChartDataOptions } from './chart-data-options/types';
 import { AppConfig } from './app/client-application';
 import { ExecuteQueryParams, QueryByWidgetIdState } from './query-execution';
-import { FiltersMergeStrategy } from './dashboard-widget/types';
+import { FiltersMergeStrategy } from './widget-by-id/types';
 import { HookEnableParam } from './common/hooks/types';
 import { ExecuteQueryResult } from './query-execution/types';
 import { Hierarchy } from './models';
@@ -797,9 +797,9 @@ export interface ScatterChartProps extends BaseChartProps, ScatterChartEventProp
     styleOptions?: ScatterStyleOptions;
 }
 /**
- * Props for the {@link DashboardWidget} component
+ * Props for the {@link WidgetById} component
  */
-export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource' | 'dataOptions' | 'chartType' | 'styleOptions'> {
+export interface WidgetByIdProps extends Omit<ChartWidgetProps, 'dataSource' | 'dataOptions' | 'chartType' | 'styleOptions'> {
     /**
      * Identifier of the widget
      *
@@ -859,7 +859,7 @@ export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource
      *
      * @category Widget
      */
-    styleOptions?: DashboardWidgetStyleOptions;
+    styleOptions?: WidgetByIdStyleOptions;
     /**
      * {@inheritDoc ChartWidgetProps.drilldownOptions}
      *
@@ -868,6 +868,19 @@ export interface DashboardWidgetProps extends Omit<ChartWidgetProps, 'dataSource
      */
     drilldownOptions?: DrilldownOptions;
 }
+/**
+ * Props for the {@link DashboardWidget} component
+ *
+ * @deprecated Use {@link WidgetById} and {@link WidgetByIdProps} instead
+ */
+export interface DashboardWidgetProps extends WidgetByIdProps {
+    /**
+     * Style options for the widget including the widget container and the chart or table inside.
+     *
+     * @category Widget
+     */
+    styleOptions?: DashboardWidgetStyleOptions;
+}
 /**
  * Props for the {@link ChartWidget} component
  *
@@ -1469,12 +1482,3 @@ export interface UseGetSharedFormulaParams extends HookEnableParam {
      */
     dataSource?: DataSource;
 }
-/**
- * Params of the {@link CustomTranslationsLoader} component
- *
- * @internal
- */
-export interface CustomTranslationsLoaderProps {
-    customTranslations?: CustomTranslationObject[];
-    children?: React.ReactNode;
-}

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

@@ -1,6 +1,6 @@
 import { Attribute, DataSource, Filter, FilterRelations, Measure, PivotAttribute, PivotGrandTotals, PivotMeasure, PivotQueryResultData, QueryResultData } from '@sisense/sdk-data';
 import { DataLoadAction } from '../common/hooks/data-load-state-reducer';
-import { FiltersMergeStrategy } from '../dashboard-widget/types';
+import { FiltersMergeStrategy } from '../widget-by-id/types';
 /**
  * State of a query execution.
  */

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

@@ -1,9 +1,7 @@
 import { PropsWithChildren, type FunctionComponent } from 'react';
 import { SisenseContextPayload } from './sisense-context';
 /** @internal */
-export type CustomSisenseContext = SisenseContextPayload & {
-    showRuntimeErrors: boolean;
-};
+export type CustomSisenseContext = SisenseContextPayload;
 /** @internal */
 export type CustomSisenseContextProviderProps = {
     context?: CustomSisenseContext;

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

@@ -9,6 +9,9 @@ export type SisenseContextPayload = {
         packageName: string;
         onTrackingEvent?: (payload: TrackingEventDetails) => void;
     };
+    errorBoundary: {
+        showErrorBox: boolean;
+    };
 };
 export declare const SisenseContext: import("react").Context<SisenseContextPayload>;
 export declare const useSisenseContext: () => SisenseContextPayload;

package/dist/packages/sdk-ui/src/translation/i18n-provider.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="react" />
+import { CustomTranslationObject } from '../types';
 type I18nProviderProps = {
     children: React.ReactNode;
     userLanguage?: string;
+    customTranslations?: CustomTranslationObject[];
 };
-export declare const I18nProvider: ({ children, userLanguage }: I18nProviderProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const I18nProvider: ({ children, userLanguage, customTranslations, }: I18nProviderProps) => import("react/jsx-runtime").JSX.Element | null;
 export {};

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

@@ -4,8 +4,8 @@ export declare const translation: {
         componentRenderError: string;
         sisenseContextNoAuthentication: string;
         chartNoSisenseContext: string;
-        dashboardWidgetNoSisenseContext: string;
-        dashboardWidgetInvalidIdentifiers: string;
+        widgetByIdNoSisenseContext: string;
+        widgetByIdInvalidIdentifier: string;
         dashboardWidgetsInvalidIdentifiers: string;
         executeQueryNoSisenseContext: string;
         executeQueryNoDataSource: string;
@@ -69,6 +69,7 @@ export declare const translation: {
         unexpectedCacheValue: string;
         notAMembersFilter: string;
         drilldownNoInitialDimension: string;
+        otherWidgetTypesNotSupported: string;
     };
     errorBoxText: string;
     chartNoData: string;
@@ -226,4 +227,18 @@ export declare const translation: {
         };
     };
 };
+/**
+ * A reference type containing all currently used translation keys.
+ * This type serves as a complete resource for creating custom translations,
+ * ensuring that all required keys are present and included.
+ * It can also be used as Partial to make sure custom translation does not contain any typos.
+ *
+ * @example
+ * ```typescript
+ * import { TranslationDictionary } from '@sisense/sdk-ui';
+ *
+ * const customTranslationResources: Partial<TranslationDictionary> = {
+ * ```
+ * @internal
+ */
 export type TranslationDictionary = typeof translation;

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

@@ -1,5 +1,11 @@
 import { TranslationDictionary } from './en.js';
 export type { TranslationDictionary };
+/**
+ * A reference to the namespace of the translation resources.
+ * This namespace is used to access the translation resources in the i18next instance.
+ *
+ * @internal
+ */
 export declare const PACKAGE_NAMESPACE: "sdkUi";
 export declare const resources: {
     en: {
@@ -8,8 +14,8 @@ export declare const resources: {
             componentRenderError: string;
             sisenseContextNoAuthentication: string;
             chartNoSisenseContext: string;
-            dashboardWidgetNoSisenseContext: string;
-            dashboardWidgetInvalidIdentifiers: string;
+            widgetByIdNoSisenseContext: string;
+            widgetByIdInvalidIdentifier: string;
             dashboardWidgetsInvalidIdentifiers: string;
             executeQueryNoSisenseContext: string;
             executeQueryNoDataSource: string;
@@ -73,6 +79,7 @@ export declare const resources: {
             unexpectedCacheValue: string;
             notAMembersFilter: string;
             drilldownNoInitialDimension: string;
+            otherWidgetTypesNotSupported: string;
         };
         errorBoxText: string;
         chartNoData: string;
@@ -236,8 +243,8 @@ export declare const resources: {
             componentRenderError: string;
             sisenseContextNoAuthentication: string;
             chartNoSisenseContext: string;
-            dashboardWidgetNoSisenseContext: string;
-            dashboardWidgetInvalidIdentifiers: string;
+            widgetByIdNoSisenseContext: string;
+            widgetByIdInvalidIdentifier: string;
             dashboardWidgetsInvalidIdentifiers: string;
             executeQueryNoSisenseContext: string;
             executeQueryNoDataSource: string;
@@ -301,6 +308,7 @@ export declare const resources: {
             unexpectedCacheValue: string;
             notAMembersFilter: string;
             drilldownNoInitialDimension: string;
+            otherWidgetTypesNotSupported: string;
         };
         errorBoxText: string;
         chartNoData: string;

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

@@ -1019,8 +1019,8 @@ export interface WidgetContainerStyleOptions {
 }
 /** @internal */
 export type RenderToolbarHandler = (onRefresh: () => void, defaultToolbar: JSX.Element) => JSX.Element | null;
-/** Style settings defining the look and feel of DashboardWidget */
-export interface DashboardWidgetStyleOptions extends WidgetContainerStyleOptions {
+/** Style settings defining the look and feel of the widget created in Fusion */
+export interface WidgetByIdStyleOptions extends WidgetContainerStyleOptions {
     /**
      * Total width of the component, which is considered in the following order of priority:
      *
@@ -1039,6 +1039,13 @@ export interface DashboardWidgetStyleOptions extends WidgetContainerStyleOptions
      */
     height?: number;
 }
+/**
+ * Style settings defining the look and feel of DashboardWidget
+ *
+ * @deprecated Use {@link WidgetByIdStyleOptions} instead
+ */
+export interface DashboardWidgetStyleOptions extends WidgetByIdStyleOptions {
+}
 /** Style settings defining the look and feel of ChartWidget */
 export type ChartWidgetStyleOptions = ChartStyleOptions & WidgetContainerStyleOptions;
 /**
@@ -1451,8 +1458,8 @@ export type CustomTranslationObject = {
      */
     resources: NestedTranslationResources;
     /**
-     * The package name of the translations.
-     * Default value is `sdkUi`.
+     * The translation namespace (usually a package name in camelCase). It identifies the specific context in which the translation is being registered.
+     * If not specified, the default value is `sdkUi`.
      */
-    packageName?: string;
+    namespace?: string;
 };

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

@@ -9,4 +9,5 @@ export declare const cloneFilter: <TFilter extends Filter>(filter: TFilter) => T
 export declare function clearMembersFilter(filter: Filter): Filter;
 export declare function isIncludeAllFilter(filter: Filter): boolean;
 export declare function haveSameAttribute(filterA: Filter, filterB: Filter): boolean;
+/** @internal */
 export declare function isSameAttribute(attributeA: Attribute, attributeB: Attribute): boolean;

package/dist/packages/sdk-ui/src/{dashboard-widget → widget-by-id}/dashboard-widget.d.ts

@@ -1,5 +1,5 @@
 import { type FunctionComponent } from 'react';
-import { DashboardWidgetProps } from '../props';
+import { DashboardWidgetProps } from '../props.js';
 /**
  * The Dashboard Widget component, which is a thin wrapper on the {@link ChartWidget} component,
  * is used to render a widget created in a Sisense Fusion instance.
@@ -22,5 +22,6 @@ import { DashboardWidgetProps } from '../props';
  *
  * @group Fusion Assets
  * @fusionEmbed
+ * @deprecated Use {@link WidgetById} instead.
  */
 export declare const DashboardWidget: FunctionComponent<DashboardWidgetProps>;