@sisense/sdk-ui-angular 2.9.0 → 2.10.0

package/dist/lib/components/widgets/widget-by-id.component.d.ts

@@ -14,7 +14,7 @@ export interface WidgetByIdProps extends WithoutPreactChartEventProps<WidgetById
  * is used to render a widget created in a Sisense Fusion instance.
  *
  * To learn more about using Sisense Fusion Widgets in Compose SDK, see
- * [Sisense Fusion Widgets](https://sisense.dev/guides/sdk/guides/charts/guide-fusion-widgets.html).
+ * [Sisense Fusion Widgets](https://developer.sisense.com/guides/sdk/guides/charts/guide-fusion-widgets.html).
  *
  * @example
  * ```html

package/dist/lib/sdk-ui-core-exports.d.ts

@@ -1,2 +1,2 @@
 export { boxWhiskerProcessResult, extractDimensionsAndMeasures } from '@sisense/sdk-ui-preact';
-export type { AppConfig, AreamapChartDataOptions, AreamapChartType, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, AreaSubtype, AxisLabel, BeforeRenderHandler, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, BoxplotChartType, BoxplotDataPoint, BoxplotStyleOptions, BoxplotSubtype, BoxWhiskerType, CartesianChartDataOptions, CartesianChartType, CartesianWidgetType, CategoricalChartDataOptions, CategoricalChartType, CategoricalWidgetType, ChartDataOptions, ChartStyleOptions, ChartType, ChartWidgetStyleOptions, Color, ColorPaletteTheme, CommonWidgetProps, ConditionalDataColorOptions, Convolution, DashboardLayoutOptions, DashboardModel, DataColorCondition, DataColorOptions, DataLimits, DataPoint, DateConfig, DateLevel, DayOfWeek, DecimalScale, DrilldownOptions, DrilldownSelection, FilterVariant, FunnelStyleOptions, GaugeIndicatorStyleOptions, GetDashboardModelOptions, GetDashboardModelsOptions, Hierarchy, HierarchyModel, HighchartsOptions, IndicatorBeforeRenderHandler, IndicatorChartDataOptions, IndicatorChartType, IndicatorComponents, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, Labels, Legend, LineStyleOptions, LineSubtype, LineWidth, Markers, Member, MenuItemSection, MenuPosition, MonthOfYear, MultiColumnValueToColorMap, Navigator, NumberFormatConfig, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, PieStyleOptions, PieSubtype, PivotRowsSort, PivotTableDataOptions, PivotTableStyleOptions, PivotTableWidgetStyleOptions, PolarStyleOptions, PolarSubtype, RangeChartDataOptions, RangeChartType, RangeDataColorOptions, ScatterChartDataOptions, ScatterChartType, ScatterDataPoint, ScattermapChartDataOptions, ScattermapChartType, ScattermapLocationLevel, ScattermapMarkers, ScattermapStyleOptions, ScatterMarkerSize, ScatterStyleOptions, SeriesChartType, SeriesLabels, SortDirection, StackableStyleOptions, StackableSubtype, StyledColumn, StyledMeasureColumn, SunburstStyleOptions, TableDataOptions, TableStyleOptions, TableType, TabularWidgetType, ThemeOid, ThemeSettings, TranslationConfig, TreemapStyleOptions, UniformDataColorOptions, ValueToColorMap, WidgetByIdStyleOptions, WidgetDataOptions, WidgetId, WidgetModel, WidgetsOptions, WidgetsPanelColumnLayout, WidgetsPanelLayout, WidgetStyleOptions, WidgetType, X2Title, } from '@sisense/sdk-ui-preact';
+export type { AppConfig, AreamapChartDataOptions, AreamapChartType, AreamapStyleOptions, AreaRangeStyleOptions, AreaStyleOptions, AreaSubtype, AxisLabel, BeforeRenderHandler, BoxplotChartCustomDataOptions, BoxplotChartDataOptions, BoxplotChartType, BoxplotDataPoint, BoxplotStyleOptions, BoxplotSubtype, BoxWhiskerType, CartesianChartDataOptions, CartesianChartType, CartesianWidgetType, CategoricalChartDataOptions, CategoricalChartType, CategoricalWidgetType, ChartDataOptions, ChartStyleOptions, ChartType, ChartWidgetStyleOptions, Color, ColorPaletteTheme, CommonWidgetProps, ConditionalDataColorOptions, Convolution, DashboardLayoutOptions, DashboardModel, DashStyle, DataColorCondition, DataColorOptions, DataLimits, DataPoint, DateConfig, DateLevel, DayOfWeek, DecimalScale, DrilldownOptions, DrilldownSelection, EndCapType, FilterVariant, FunnelStyleOptions, GaugeIndicatorStyleOptions, GetDashboardModelOptions, GetDashboardModelsOptions, Hierarchy, HierarchyModel, HighchartsOptions, IndicatorBeforeRenderHandler, IndicatorChartDataOptions, IndicatorChartType, IndicatorComponents, IndicatorDataPoint, IndicatorRenderOptions, IndicatorStyleOptions, Labels, Legend, LineOptions, LineStyleOptions, LineSubtype, LineWidth, Markers, Member, MenuItemSection, MenuPosition, MonthOfYear, MultiColumnValueToColorMap, Navigator, NumberFormatConfig, NumericBarIndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, PieStyleOptions, PieSubtype, PivotRowsSort, PivotTableDataOptions, PivotTableStyleOptions, PivotTableWidgetStyleOptions, PolarStyleOptions, PolarSubtype, RangeChartDataOptions, RangeChartType, RangeDataColorOptions, ScatterChartDataOptions, ScatterChartType, ScatterDataPoint, ScattermapChartDataOptions, ScattermapChartType, ScattermapLocationLevel, ScattermapMarkers, ScattermapStyleOptions, ScatterMarkerSize, ScatterStyleOptions, SeriesChartType, SeriesLabels, SortDirection, StackableStyleOptions, StackableSubtype, StyledColumn, StyledMeasureColumn, SunburstStyleOptions, TableDataOptions, TableStyleOptions, TableType, TabularWidgetType, ThemeOid, ThemeSettings, TranslationConfig, TreemapStyleOptions, UniformDataColorOptions, ValueToColorMap, WidgetByIdStyleOptions, WidgetDataOptions, WidgetId, WidgetModel, WidgetsOptions, WidgetsPanelColumnLayout, WidgetsPanelLayout, WidgetStyleOptions, WidgetType, X2Title, } from '@sisense/sdk-ui-preact';

package/dist/lib/services/sisense-context.service.d.ts

@@ -1,8 +1,21 @@
 import { InjectionToken } from '@angular/core';
 import type { SisenseContextProviderProps as SisenseContextConfig } from '@sisense/sdk-ui-preact';
 import { ClientApplication } from '@sisense/sdk-ui-preact';
+import { Observable } from 'rxjs';
 import * as i0 from "@angular/core";
 export { type SisenseContextConfig };
+/**
+ * Represents the state of the Sisense client application.
+ */
+type AppState = {
+    /** Successfully initialized client application */
+    readonly app: ClientApplication;
+    readonly error?: never;
+} | {
+    /** Error that occurred during initialization or connection */
+    readonly error: Error;
+    readonly app?: never;
+};
 /**
  * Token used to inject {@link SisenseContextConfig} into your application
  *
@@ -32,17 +45,87 @@ export { type SisenseContextConfig };
  */
 export declare const SISENSE_CONTEXT_CONFIG_TOKEN: InjectionToken<SisenseContextConfig>;
 /**
- * Service for working with Sisense Fusion context.
+ * Service for managing Sisense Fusion context and client application lifecycle.
+ *
+ * This service provides a centralized way to configure and manage the connection to a Sisense instance within Angular applications.
  *
  * @group Contexts
  */
 export declare class SisenseContextService {
-    private appPromise;
-    private config;
-    constructor(sisenseContextConfig: SisenseContextConfig);
-    /** @internal */
+    /**
+     * Reactive stream of application state changes.
+     *
+     * Uses ReplaySubject to ensure late subscribers receive the latest state.
+     */
+    private readonly app$;
+    /**
+     * Configuration object for the Sisense connection.
+     *
+     * This is set once during initialization and remains readonly thereafter
+     * to prevent accidental mutations that could lead to inconsistent state.
+     */
+    private config?;
+    /**
+     * Flag indicating whether the service has been initialized with configuration.
+     *
+     * @internal
+     */
+    isInitialized: boolean;
+    constructor(sisenseContextConfig?: SisenseContextConfig);
+    /**
+     * Retrieves the initialized Sisense client application.
+     *
+     * This method provides access to the client application instance.
+     * It waits for the latest state from the reactive stream and either returns
+     * the application or throws the error if initialization failed.
+     *
+     * @returns Promise that resolves to the ClientApplication instance
+     * @throws {Error} When the service is not initialized or when application creation failed
+     *
+     * @internal
+     */
     getApp(): Promise<ClientApplication>;
-    getConfig(): SisenseContextConfig;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SisenseContextService, never>;
+    /**
+     * Provides reactive access to the Sisense application state.
+     *
+     * This method returns an Observable that emits the current application state
+     * and all subsequent state changes. It's the preferred way to reactively
+     * handle application lifecycle events in Angular components.
+     *
+     * If the service is not initialized, it immediately emits an error state
+     * followed by any future state changes once initialization occurs.
+     *
+     * @returns Observable stream of AppState changes
+     *
+     * @internal
+     */
+    getApp$(): Observable<AppState>;
+    /**
+     * Retrieves the current {@link SisenseContextConfig} configuration object.
+     *
+     * @returns The current configuration object, or undefined if not yet configured
+     */
+    getConfig(): SisenseContextConfig | undefined;
+    /**
+     * Configures and initializes the Sisense context with the provided settings.
+     *
+     * This method allows to establish a connection to a Sisense instance.
+     * It could be used as runtime alternative to {@link SISENSE_CONTEXT_CONFIG_TOKEN} based configuration.
+     *
+     * @param config - Configuration object
+     * @returns Promise that resolves when configuration is complete (success or failure)
+     *
+     * @example
+     * Basic configuration:
+     * ```ts
+     * await SisenseContextService.setConfig({
+     *   url: 'https://your-sisense-instance.com',
+     *   token: 'your-api-token',
+     *   defaultDataSource: 'Sample ECommerce'
+     * });
+     * ```
+     */
+    setConfig(config: SisenseContextConfig): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SisenseContextService, [{ optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SisenseContextService>;
 }

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-ui-angular",
-  "homepage": "https://sisense.dev/guides/sdk/",
+  "homepage": "https://developer.sisense.com/guides/sdk/",
   "description": "Compose SDK package containing general UI elements and related logic tailored for Angular development",
   "repository": {
     "type": "git",
@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "2.9.0",
+  "version": "2.10.0",
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist",

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "2.9.0";
+declare const _default: "2.10.0";
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-ui-angular",
-  "homepage": "https://sisense.dev/guides/sdk/",
+  "homepage": "https://developer.sisense.com/guides/sdk/",
   "description": "Compose SDK package containing general UI elements and related logic tailored for Angular development",
   "repository": {
     "type": "git",
@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "2.9.0",
+  "version": "2.10.0",
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist",
@@ -76,9 +76,9 @@
     "@angular/core": "^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0"
   },
   "dependencies": {
-    "@sisense/sdk-data": "2.9.0",
-    "@sisense/sdk-tracking": "2.9.0",
-    "@sisense/sdk-ui-preact": "2.9.0",
+    "@sisense/sdk-data": "2.10.0",
+    "@sisense/sdk-tracking": "2.10.0",
+    "@sisense/sdk-ui-preact": "2.10.0",
     "rxjs": "^7.8.1",
     "ts-deepmerge": "^6.2.0",
     "tslib": "^2.3.0"