@sisense/sdk-ui-angular 2.9.0 → 2.11.0

package/dist/fesm2015/sisense-sdk-ui-angular.mjs

@@ -1,9 +1,9 @@
 import * as i0 from '@angular/core';
-import { InjectionToken, Injectable, Inject, createComponent, NgModule, Optional, EventEmitter, Component, ViewChild, Input, Output } from '@angular/core';
+import { InjectionToken, Injectable, Optional, Inject, createComponent, NgModule, EventEmitter, Component, ViewChild, Input, Output } from '@angular/core';
 import { DataObserver, CustomThemeProvider, CustomSisenseContextProvider, CustomWidgetsProviderAdapter, createClientApplication, createWrapperElement, getDashboardModel, getDashboardModels, HookAdapter, useComposedDashboardInternal, createHookApiFacade, useGetFilterMembers, getHierarchyModels, executeQuery, executeQueryByWidgetId, executePivotQuery, useExecuteCsvQueryInternal, useExecuteCustomWidgetQueryInternal, getWidgetModel, getDefaultThemeSettings, getThemeSettingsByOid, ComponentAdapter, Chart, PivotTable, Table, ContextMenu, Dashboard, DashboardById, DrilldownBreadcrumbs, CriteriaFilterTile, DateRangeFilterTile, FilterTile, FiltersPanel, MemberFilterTile, RelativeDateFilterTile, ChartWidget, DrilldownWidget, createWrapperElementHandler, createComponentRenderer, PivotTableWidget, TableWidget, Widget, WidgetById, dashboardModelTranslator as dashboardModelTranslator$1, dashboardHelpers as dashboardHelpers$1, widgetModelTranslator as widgetModelTranslator$1 } from '@sisense/sdk-ui-preact';
 export { boxWhiskerProcessResult, extractDimensionsAndMeasures } from '@sisense/sdk-ui-preact';
-import { __rest, __awaiter, __decorate } from 'tslib';
-import { BehaviorSubject } from 'rxjs';
+import { __awaiter, __rest, __decorate } from 'tslib';
+import { ReplaySubject, firstValueFrom, concat, of, BehaviorSubject, skip } from 'rxjs';
 import merge from 'ts-deepmerge';
 import { trackProductEvent } from '@sisense/sdk-tracking';
 import { getFilterListAndRelationsJaql } from '@sisense/sdk-data';
@@ -38,38 +38,50 @@ const createThemeContextConnector = (themeService) => {
         providerComponent: CustomThemeProvider,
     };
 };
-/**
- * Creates Sisense context connector
- *
- * @param sisenseContextService - The Sisense context service
- * @internal
- */
-const createSisenseContextConnector = (sisenseContextService) => {
-    var _a, _b;
-    const { showRuntimeErrors, appConfig } = sisenseContextService.getConfig();
-    const defaultSisenseContext = {
-        isInitialized: true,
+function getBaseSisenseContext(sisenseContextService) {
+    var _a, _b, _c;
+    const { showRuntimeErrors, appConfig } = (_a = sisenseContextService.getConfig()) !== null && _a !== void 0 ? _a : {};
+    return {
+        isInitialized: sisenseContextService.isInitialized,
         tracking: {
             // if tracking is configured in appConfig, use it
             // if none is set, default to true
-            enabled: (_b = (_a = appConfig === null || appConfig === void 0 ? void 0 : appConfig.trackingConfig) === null || _a === void 0 ? void 0 : _a.enabled) !== null && _b !== void 0 ? _b : true,
+            enabled: (_c = (_b = appConfig === null || appConfig === void 0 ? void 0 : appConfig.trackingConfig) === null || _b === void 0 ? void 0 : _b.enabled) !== null && _c !== void 0 ? _c : true,
             packageName: 'sdk-ui-angular',
         },
         errorBoundary: {
             showErrorBox: showRuntimeErrors !== null && showRuntimeErrors !== void 0 ? showRuntimeErrors : true,
         },
     };
+}
+/**
+ * Creates Sisense context connector
+ *
+ * @param sisenseContextService - The Sisense context service
+ * @internal
+ */
+const createSisenseContextConnector = (sisenseContextService) => {
     const propsObserver = new DataObserver({
-        context: defaultSisenseContext,
+        context: getBaseSisenseContext(sisenseContextService),
+    });
+    sisenseContextService.getApp$().subscribe({
+        next: ({ app, error }) => {
+            if (error) {
+                propsObserver.setValue({
+                    error,
+                });
+                return;
+            }
+            propsObserver.setValue({
+                context: Object.assign(Object.assign({}, getBaseSisenseContext(sisenseContextService)), { app }),
+            });
+        },
+        error: (error) => {
+            propsObserver.setValue({
+                error,
+            });
+        },
     });
-    sisenseContextService
-        .getApp()
-        .then((app) => propsObserver.setValue({
-        context: Object.assign(Object.assign({}, defaultSisenseContext), { app }),
-    }))
-        .catch((error) => propsObserver.setValue({
-        error,
-    }));
     return {
         propsObserver,
         providerComponent: CustomSisenseContextProvider,
@@ -152,25 +164,114 @@ const styles = [
  */
 const SISENSE_CONTEXT_CONFIG_TOKEN = new InjectionToken('Props for connecting to Sisense instance');
 /**
- * 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
  */
 class SisenseContextService {
     constructor(sisenseContextConfig) {
-        this.appPromise = createClientApplication(sisenseContextConfig);
-        const { showRuntimeErrors } = sisenseContextConfig;
-        this.config = Object.assign(Object.assign({}, sisenseContextConfig), { showRuntimeErrors: showRuntimeErrors !== null && showRuntimeErrors !== void 0 ? showRuntimeErrors : true });
+        /**
+         * Flag indicating whether the service has been initialized with configuration.
+         *
+         * @internal
+         */
+        this.isInitialized = false;
+        // The buffer size of 1 ensures only the most recent state is cached.
+        this.app$ = new ReplaySubject(1);
+        if (sisenseContextConfig) {
+            // Auto-configure if config is provided via DI
+            void this.setConfig(sisenseContextConfig);
+        }
     }
-    /** @internal */
+    /**
+     * 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() {
-        return this.appPromise;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.isInitialized) {
+                throw new Error('Sisense context is not initialized');
+            }
+            const { app, error } = yield firstValueFrom(this.app$);
+            if (error) {
+                throw error;
+            }
+            return app;
+        });
     }
+    /**
+     * 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$() {
+        if (!this.isInitialized) {
+            return concat(of({ error: new Error('Sisense context is not initialized') }), this.app$);
+        }
+        return this.app$;
+    }
+    /**
+     * Retrieves the current {@link SisenseContextConfig} configuration object.
+     *
+     * @returns The current configuration object, or undefined if not yet configured
+     */
     getConfig() {
         return this.config;
     }
+    /**
+     * 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) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            this.config = Object.assign(Object.assign({}, config), { showRuntimeErrors: (_a = config.showRuntimeErrors) !== null && _a !== void 0 ? _a : true });
+            this.isInitialized = true;
+            try {
+                const app = yield createClientApplication(this.config);
+                this.app$.next({ app });
+            }
+            catch (error) {
+                this.app$.next({ error: error });
+            }
+        });
+    }
 }
-SisenseContextService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: SisenseContextService, deps: [{ token: SISENSE_CONTEXT_CONFIG_TOKEN }], target: i0.ɵɵFactoryTarget.Injectable });
+SisenseContextService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: SisenseContextService, deps: [{ token: SISENSE_CONTEXT_CONFIG_TOKEN, optional: true }], target: i0.ɵɵFactoryTarget.Injectable });
 SisenseContextService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: SisenseContextService, providedIn: 'root' });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: SisenseContextService, decorators: [{
             type: Injectable,
@@ -179,12 +280,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 }]
         }], ctorParameters: function () {
         return [{ type: undefined, decorators: [{
+                        type: Optional
+                    }, {
                         type: Inject,
                         args: [SISENSE_CONTEXT_CONFIG_TOKEN]
                     }] }];
     } });
 
-var packageVersion = '2.9.0';
+var packageVersion = '2.11.0';
 
 /**
  * Service for rendering components dynamically.
@@ -841,6 +944,18 @@ let ThemeService = class ThemeService {
         this.initializationPromise = Promise.resolve();
         this.themeSettings$ = new BehaviorSubject(getDefaultThemeSettings());
         this.initializationPromise = this.initThemeSettings(themeConfig === null || themeConfig === void 0 ? void 0 : themeConfig.theme);
+        this.sisenseContextService
+            .getApp$()
+            // Skip current app value
+            .pipe(skip(1))
+            // Subscribe to new app values
+            .subscribe({
+            next: ({ app }) => {
+                if (app) {
+                    this.initializationPromise = this.applyThemeSettings(app.settings.serverThemeSettings);
+                }
+            },
+        });
     }
     initThemeSettings(theme) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1720,6 +1835,136 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 type: Output
             }] } });
 
+/**
+ * A component that visualizes values over days in a calendar-like view,
+ * making it easy to identify daily patterns or anomalies
+ *
+ * @example
+ * ```html
+ *    <csdk-calendar-heatmap-chart
+ *      [dataSet]="chart.dataSet"
+ *      [dataOptions]="chart.dataOptions"
+ *      [highlights]="chart.highlights"
+ *      [styleOptions]="chart.styleOptions"
+ *    />
+ * ```
+ * ```ts
+import { Component } from '@angular/core';
+import { measureFactory, filterFactory } from '@sisense/sdk-data';
+import * as DM from '../../assets/sample-ecommerce';
+import type { CalendarHeatmapChartProps } from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-analytics',
+  templateUrl: './analytics.component.html',
+  styleUrls: ['./analytics.component.scss'],
+})
+export class AnalyticsComponent {
+  DM = DM;
+  chart = {
+    dataSet: DM.DataSource,
+    dataOptions: {
+      date: DM.Commerce.Date.Days,
+      value: measureFactory.sum(DM.Commerce.Cost),
+    },
+    highlights: [
+      filterFactory.dateRange(
+        DM.Commerce.Date.Days,
+        '2009-11-29',
+        '2009-12-15'
+      ),
+    ],
+    styleOptions: {
+      viewType: 'quarter',
+    },
+  };
+}
+ * ```
+ * <img src="media://angular-calendar-heatmap-chart-example.png" width="800px" />
+ * @group Charts
+ */
+class CalendarHeatmapChartComponent {
+    constructor() {
+        /**
+         * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataPointClick}
+         *
+         * @category Callbacks
+         */
+        this.dataPointClick = new EventEmitter();
+        /**
+         * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataPointContextMenu}
+         *
+         * @category Callbacks
+         */
+        this.dataPointContextMenu = new EventEmitter();
+        /**
+         * {@inheritDoc @sisense/sdk-ui!CalendarHeatmapChartProps.onDataPointsSelected}
+         *
+         * @category Callbacks
+         */
+        this.dataPointsSelect = new EventEmitter();
+        /** @internal */
+        this.chartType = 'calendar-heatmap';
+    }
+}
+CalendarHeatmapChartComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: CalendarHeatmapChartComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });
+CalendarHeatmapChartComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: CalendarHeatmapChartComponent, selector: "csdk-calendar-heatmap-chart", inputs: { dataSet: "dataSet", dataOptions: "dataOptions", filters: "filters", highlights: "highlights", styleOptions: "styleOptions", beforeRender: "beforeRender", dataReady: "dataReady" }, outputs: { dataPointClick: "dataPointClick", dataPointContextMenu: "dataPointContextMenu", dataPointsSelect: "dataPointsSelect" }, ngImport: i0, template: `
+    <csdk-chart
+      [chartType]="chartType"
+      [dataSet]="dataSet"
+      [dataOptions]="dataOptions"
+      [filters]="filters"
+      [highlights]="highlights"
+      [styleOptions]="styleOptions"
+      [beforeRender]="beforeRender"
+      [dataReady]="dataReady"
+      (dataPointClick)="dataPointClick.emit($any($event))"
+      (dataPointContextMenu)="dataPointContextMenu.emit($any($event))"
+      (dataPointsSelect)="dataPointsSelect.emit($any($event))"
+    />
+  `, isInline: true, dependencies: [{ kind: "component", type: ChartComponent, selector: "csdk-chart", inputs: ["chartType", "dataSet", "dataOptions", "filters", "highlights", "styleOptions", "beforeRender", "dataReady"], outputs: ["dataPointClick", "dataPointContextMenu", "dataPointsSelect"] }] });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: CalendarHeatmapChartComponent, decorators: [{
+            type: Component,
+            args: [{
+                    selector: 'csdk-calendar-heatmap-chart',
+                    template: `
+    <csdk-chart
+      [chartType]="chartType"
+      [dataSet]="dataSet"
+      [dataOptions]="dataOptions"
+      [filters]="filters"
+      [highlights]="highlights"
+      [styleOptions]="styleOptions"
+      [beforeRender]="beforeRender"
+      [dataReady]="dataReady"
+      (dataPointClick)="dataPointClick.emit($any($event))"
+      (dataPointContextMenu)="dataPointContextMenu.emit($any($event))"
+      (dataPointsSelect)="dataPointsSelect.emit($any($event))"
+    />
+  `,
+                }]
+        }], propDecorators: { dataSet: [{
+                type: Input
+            }], dataOptions: [{
+                type: Input
+            }], filters: [{
+                type: Input
+            }], highlights: [{
+                type: Input
+            }], styleOptions: [{
+                type: Input
+            }], beforeRender: [{
+                type: Input
+            }], dataReady: [{
+                type: Input
+            }], dataPointClick: [{
+                type: Output
+            }], dataPointContextMenu: [{
+                type: Output
+            }], dataPointsSelect: [{
+                type: Output
+            }] } });
+
 /**
  * A component representing categorical data with vertical rectangular bars
  * whose heights are proportional to the values that they represent.
@@ -5105,7 +5350,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * 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
@@ -5243,6 +5488,7 @@ SdkUiModule.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "1
         ColumnChartComponent,
         BarChartComponent,
         AreaChartComponent,
+        CalendarHeatmapChartComponent,
         AreaRangeChartComponent,
         LineChartComponent,
         IndicatorChartComponent,
@@ -5276,6 +5522,7 @@ SdkUiModule.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "1
         ColumnChartComponent,
         BarChartComponent,
         AreaChartComponent,
+        CalendarHeatmapChartComponent,
         AreaRangeChartComponent,
         LineChartComponent,
         IndicatorChartComponent,
@@ -5315,6 +5562,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                         ColumnChartComponent,
                         BarChartComponent,
                         AreaChartComponent,
+                        CalendarHeatmapChartComponent,
                         AreaRangeChartComponent,
                         LineChartComponent,
                         IndicatorChartComponent,
@@ -5352,6 +5600,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                         ColumnChartComponent,
                         BarChartComponent,
                         AreaChartComponent,
+                        CalendarHeatmapChartComponent,
                         AreaRangeChartComponent,
                         LineChartComponent,
                         IndicatorChartComponent,
@@ -5879,5 +6128,5 @@ var widgetModelTranslator = /*#__PURE__*/Object.freeze({
  * Generated bundle index. Do not edit.
  */
 
-export { AreaChartComponent, AreaRangeChartComponent, AreamapChartComponent, BarChartComponent, BoxplotChartComponent, ChartComponent, ChartWidgetComponent, ColumnChartComponent, ContextMenuComponent, CriteriaFilterTileComponent, CustomWidgetsService, DashboardByIdComponent, DashboardComponent, DashboardService, DateRangeFilterTileComponent, DrilldownBreadcrumbsComponent, DrilldownWidgetComponent, FilterService, FilterTileComponent, FiltersPanelComponent, FunnelChartComponent, HierarchyService, IndicatorChartComponent, LineChartComponent, MemberFilterTileComponent, PieChartComponent, PivotTableComponent, PivotTableWidgetComponent, PolarChartComponent, QueryService, RelativeDateFilterTileComponent, SISENSE_CONTEXT_CONFIG_TOKEN, ScatterChartComponent, ScattermapChartComponent, SdkUiModule, SisenseContextService, SunburstChartComponent, THEME_CONFIG_TOKEN, TableComponent, TableWidgetComponent, ThemeService, TrackableService, TreemapChartComponent, WidgetByIdComponent, WidgetComponent, WidgetService, createCustomWidgetsContextConnector, createSisenseContextConnector, createThemeContextConnector, dashboardHelpers, dashboardModelTranslator, widgetModelTranslator };
+export { AreaChartComponent, AreaRangeChartComponent, AreamapChartComponent, BarChartComponent, BoxplotChartComponent, CalendarHeatmapChartComponent, ChartComponent, ChartWidgetComponent, ColumnChartComponent, ContextMenuComponent, CriteriaFilterTileComponent, CustomWidgetsService, DashboardByIdComponent, DashboardComponent, DashboardService, DateRangeFilterTileComponent, DrilldownBreadcrumbsComponent, DrilldownWidgetComponent, FilterService, FilterTileComponent, FiltersPanelComponent, FunnelChartComponent, HierarchyService, IndicatorChartComponent, LineChartComponent, MemberFilterTileComponent, PieChartComponent, PivotTableComponent, PivotTableWidgetComponent, PolarChartComponent, QueryService, RelativeDateFilterTileComponent, SISENSE_CONTEXT_CONFIG_TOKEN, ScatterChartComponent, ScattermapChartComponent, SdkUiModule, SisenseContextService, SunburstChartComponent, THEME_CONFIG_TOKEN, TableComponent, TableWidgetComponent, ThemeService, TrackableService, TreemapChartComponent, WidgetByIdComponent, WidgetComponent, WidgetService, createCustomWidgetsContextConnector, createSisenseContextConnector, createThemeContextConnector, dashboardHelpers, dashboardModelTranslator, widgetModelTranslator };
 //# sourceMappingURL=sisense-sdk-ui-angular.mjs.map