@sisense/sdk-ui-angular 1.18.1 → 1.20.0

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

@@ -1,8 +1,8 @@
 import * as i0 from '@angular/core';
 import { EventEmitter, Component, ViewChild, Input, Output, InjectionToken, Injectable, Inject, NgModule, Optional } from '@angular/core';
 import { CommonModule } from '@angular/common';
-import { ComponentAdapter, createElement, BasicMemberFilterTile, createContextProviderRenderer, CustomThemeProvider, CustomSisenseContextProvider, createClientApplication, executeQuery, executeQueryByWidgetId, getDashboardModel, getDashboardModels, getWidgetModel, getDefaultThemeSettings, getThemeSettingsByOid, MemberFilterTile, DateRangeFilterTile, Chart, Table, PivotTable, TableWidget, DashboardWidget, createWrapperElementHandler, createWrapperElement, DrilldownWidget, createComponentRenderer, ChartWidget, DashboardById, Dashboard, DrilldownBreadcrumbs, ContextMenu } from '@sisense/sdk-ui-preact';
-export { boxWhiskerProcessResult } from '@sisense/sdk-ui-preact';
+import { ComponentAdapter, createElement, BasicMemberFilterTile, createContextProviderRenderer, CustomThemeProvider, CustomSisenseContextProvider, CustomPluginsProvider, createClientApplication, executeQuery, executeQueryByWidgetId, getDashboardModel, getDashboardModels, getWidgetModel, getDefaultThemeSettings, getThemeSettingsByOid, MemberFilterTile, DateRangeFilterTile, Chart, Table, PivotTable, TableWidget, DashboardWidget, createWrapperElementHandler, createWrapperElement, DrilldownWidget, createComponentRenderer, ChartWidget, DashboardById, Dashboard, DrilldownBreadcrumbs, ContextMenu } from '@sisense/sdk-ui-preact';
+export { boxWhiskerProcessResult, dashboardModelTranslator, widgetModelTranslator } from '@sisense/sdk-ui-preact';
 import { map, BehaviorSubject } from 'rxjs';
 import { __decorate } from 'tslib';
 import merge from 'ts-deepmerge';
@@ -125,6 +125,24 @@ const createSisenseContextConnector = (sisenseContextService) => {
         renderContextProvider: createContextProviderRenderer(CustomSisenseContextProvider),
     };
 };
+/**
+ * Creates plugins context connector
+ *
+ * @param pluginsService - The plugin service
+ * @internal
+ */
+const createPluginsContextConnector = (pluginsService) => {
+    return {
+        prepareContext() {
+            return {
+                pluginMap: pluginsService.getPlugins().value,
+                registerPlugin: pluginsService.registerPlugin.bind(pluginsService),
+                getPlugin: pluginsService.getPlugin.bind(pluginsService),
+            };
+        },
+        renderContextProvider: createContextProviderRenderer(CustomPluginsProvider),
+    };
+};
 
 /**
  * Token used to inject {@link SisenseContextConfig} into your application
@@ -249,6 +267,58 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 }]
         }], ctorParameters: function () { return [{ type: SisenseContextService }]; } });
 
+/**
+ * Service for working with plugins fetched from an external environment.
+ *
+ * Provides methods for registering, retrieving, and interacting with plugins.
+ *
+ * @internal
+ * @group Contexts
+ */
+class PluginsService {
+    constructor() {
+        this.pluginMap$ = new BehaviorSubject(new Map());
+    }
+    /**
+     * Registers a new plugin into the plugin map.
+     *
+     * @param pluginType - The unique identifier for the plugin type.
+     * @param plugin - The plugin instance to register.
+     */
+    registerPlugin(pluginType, plugin) {
+        const pluginMap = this.pluginMap$.value;
+        if (!pluginMap.has(pluginType)) {
+            pluginMap.set(pluginType, plugin);
+            this.pluginMap$.next(pluginMap);
+        }
+    }
+    /**
+     * Retrieves a plugin by its type.
+     *
+     * @param pluginType - The unique identifier for the plugin type.
+     * @returns The plugin instance if found, otherwise undefined.
+     */
+    getPlugin(pluginType) {
+        return this.pluginMap$.value.get(pluginType);
+    }
+    /**
+     * Retrieves a complete plugin map.
+     *
+     * @returns A plugin map.
+     */
+    getPlugins() {
+        return this.pluginMap$;
+    }
+}
+PluginsService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: PluginsService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+PluginsService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: PluginsService, providedIn: 'root' });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: PluginsService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root',
+                }]
+        }], ctorParameters: function () { return []; } });
+
 /**
  * Service for working with Sisense Fusion dashboards.
  *
@@ -345,7 +415,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 }]
         }], ctorParameters: function () { return [{ type: SisenseContextService }]; } });
 
-var packageVersion = '1.18.1';
+var packageVersion = '1.20.0';
 
 function Trackable(target, propertyKey, descriptor) {
     const originalMethod = descriptor.value;
@@ -3449,7 +3519,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * ```
  * <img src="media://angular-chart-widget-example.png" width="800px" />
  *
- * @group Chart Utilities
+ * @group Dashboarding
  */
 class ChartWidgetComponent {
     constructor(sisenseContextService, themeService) {
@@ -3578,7 +3648,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * ```
  * @group Fusion Embed
  * @fusionEmbed
- * @alpha
+ * @beta
  */
 class DashboardByIdComponent {
     /**
@@ -3599,12 +3669,21 @@ class DashboardByIdComponent {
      *
      * @category Constructor
      */
-    themeService) {
+    themeService, 
+    /**
+     * Plugin service
+     *
+     * @internal
+     * @category Constructor
+     */
+    pluginService) {
         this.sisenseContextService = sisenseContextService;
         this.themeService = themeService;
+        this.pluginService = pluginService;
         this.componentAdapter = new ComponentAdapter(() => this.createPreactComponent(), [
             createSisenseContextConnector(this.sisenseContextService),
             createThemeContextConnector(this.themeService),
+            createPluginsContextConnector(this.pluginService),
         ]);
     }
     /**
@@ -3634,7 +3713,7 @@ class DashboardByIdComponent {
         this.componentAdapter.destroy();
     }
 }
-DashboardByIdComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: DashboardByIdComponent, deps: [{ token: SisenseContextService }, { token: ThemeService }], target: i0.ɵɵFactoryTarget.Component });
+DashboardByIdComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: DashboardByIdComponent, deps: [{ token: SisenseContextService }, { token: ThemeService }, { token: PluginsService }], target: i0.ɵɵFactoryTarget.Component });
 DashboardByIdComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: DashboardByIdComponent, selector: "csdk-dashboard-by-id", inputs: { dashboardOid: "dashboardOid" }, viewQueries: [{ propertyName: "preactRef", first: true, predicate: ["preact"], descendants: true }], usesOnChanges: true, ngImport: i0, template: "\n    <div #preact style=\"width: 100%; height: 100%\"></div>\n", isInline: true });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: DashboardByIdComponent, decorators: [{
             type: Component,
@@ -3642,7 +3721,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                     selector: 'csdk-dashboard-by-id',
                     template,
                 }]
-        }], ctorParameters: function () { return [{ type: SisenseContextService }, { type: ThemeService }]; }, propDecorators: { preactRef: [{
+        }], ctorParameters: function () { return [{ type: SisenseContextService }, { type: ThemeService }, { type: PluginsService }]; }, propDecorators: { preactRef: [{
                 type: ViewChild,
                 args: [rootId]
             }], dashboardOid: [{
@@ -3659,16 +3738,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * <csdk-dashboard
  *  *ngIf="dashboard"
  *  [title]="dashboard!.title"
- *  [layout]="dashboard!.layout"
+ *  [layoutOptions]="dashboard!.layoutOptions"
  *  [widgets]="dashboard!.widgets"
  *  [filters]="dashboard!.filters"
  *  [defaultDataSource]="dashboard!.dataSource"
- *  [widgetFilterOptions]="dashboard!.widgetFilterOptions"
+ *  [widgetsOptions]="dashboard!.widgetsOptions"
  * />
  * ```
+ *
  * ```ts
  * import { Component } from '@angular/core';
- * import { type DashboardModel, DashboardService } from '@sisense/sdk-ui-angular';
+ * import { type DashboardProps, DashboardService } from '@sisense/sdk-ui-angular';
  *
  * @Component({
  *  selector: 'app-dashboard',
@@ -3677,17 +3757,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * })
  * export class DashboardComponent {
  *
- *  dashboard: DashboardModel | null = null;
+ *  dashboard: DashboardProps | null = null;
  *
  *  constructor(private dashboardService: DashboardService) {}
  *
  *  async ngOnInit(): Promise<void> {
- *    this.dashboard = await this.dashboardService.getDashboardModel('60f3e3e3e4b0e3e3e4b0e3e3', { includeWidgets: true, includeFilters: true });
+ *    const dashboardModel = await this.dashboardService.getDashboardModel('60f3e3e3e4b0e3e3e4b0e3e3', { includeWidgets: true, includeFilters: true });
+ *    this.dashboardProps = dashboardModelTranslator.toDashboardProps(dashboardModel);
  *  }
  * ```
- * @group Fusion Embed
- * @fusionEmbed
- * @alpha
+ * @group Dashboarding
+ * @beta
  */
 class DashboardComponent {
     /**
@@ -3733,11 +3813,12 @@ class DashboardComponent {
     createPreactComponent() {
         const props = {
             title: this.title,
-            layout: this.layout,
+            layoutOptions: this.layoutOptions,
+            config: this.config,
             widgets: this.widgets,
             filters: this.filters,
             defaultDataSource: this.defaultDataSource,
-            widgetFilterOptions: this.widgetFilterOptions,
+            widgetsOptions: this.widgetsOptions,
             styleOptions: this.styleOptions,
         };
         return createElement(Dashboard, props);
@@ -3750,7 +3831,7 @@ class DashboardComponent {
     }
 }
 DashboardComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: DashboardComponent, deps: [{ token: SisenseContextService }, { token: ThemeService }], target: i0.ɵɵFactoryTarget.Component });
-DashboardComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: DashboardComponent, selector: "csdk-dashboard", inputs: { title: "title", layout: "layout", widgets: "widgets", filters: "filters", defaultDataSource: "defaultDataSource", widgetFilterOptions: "widgetFilterOptions", styleOptions: "styleOptions" }, viewQueries: [{ propertyName: "preactRef", first: true, predicate: ["preact"], descendants: true }], usesOnChanges: true, ngImport: i0, template: "\n    <div #preact style=\"width: 100%; height: 100%\"></div>\n", isInline: true });
+DashboardComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: DashboardComponent, selector: "csdk-dashboard", inputs: { title: "title", layoutOptions: "layoutOptions", config: "config", widgets: "widgets", filters: "filters", defaultDataSource: "defaultDataSource", widgetsOptions: "widgetsOptions", styleOptions: "styleOptions" }, viewQueries: [{ propertyName: "preactRef", first: true, predicate: ["preact"], descendants: true }], usesOnChanges: true, ngImport: i0, template: "\n    <div #preact style=\"width: 100%; height: 100%\"></div>\n", isInline: true });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: DashboardComponent, decorators: [{
             type: Component,
             args: [{
@@ -3762,7 +3843,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 args: [rootId]
             }], title: [{
                 type: Input
-            }], layout: [{
+            }], layoutOptions: [{
+                type: Input
+            }], config: [{
                 type: Input
             }], widgets: [{
                 type: Input
@@ -3770,7 +3853,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 type: Input
             }], defaultDataSource: [{
                 type: Input
-            }], widgetFilterOptions: [{
+            }], widgetsOptions: [{
                 type: Input
             }], styleOptions: [{
                 type: Input
@@ -4139,6 +4222,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * Angular context modules, services, and variables
  * @groupDescription Queries
  * Angular query service
+ * @groupDescription Dashboarding
+ * Angular modules, services, and components for composing dashboards
  * @groupDescription Fusion Embed
  * Angular modules, services, and components for working with Fusion Embed dashboards, widgets, queries, and formulas
  * @groupDescription Interfaces
@@ -4151,5 +4236,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * Generated bundle index. Do not edit.
  */
 
-export { AreaChartComponent, AreaRangeChartComponent, AreamapChartComponent, BarChartComponent, BasicMemberFilterTileComponent, BoxplotChartComponent, ChartComponent, ChartWidgetComponent, ColumnChartComponent, ContextMenuComponent, DashboardByIdComponent, DashboardComponent, DashboardService, DashboardWidgetComponent, DateRangeFilterTileComponent, DrilldownBreadcrumbsComponent, DrilldownWidgetComponent, FunnelChartComponent, IndicatorChartComponent, LineChartComponent, MemberFilterTileComponent, PieChartComponent, PivotTableComponent, PolarChartComponent, QueryService, SISENSE_CONTEXT_CONFIG_TOKEN, ScatterChartComponent, ScattermapChartComponent, SdkUiModule, SisenseContextService, SunburstChartComponent, THEME_CONFIG_TOKEN, TableComponent, TableWidgetComponent, ThemeService, TreemapChartComponent, WidgetService };
+export { AreaChartComponent, AreaRangeChartComponent, AreamapChartComponent, BarChartComponent, BasicMemberFilterTileComponent, BoxplotChartComponent, ChartComponent, ChartWidgetComponent, ColumnChartComponent, ContextMenuComponent, DashboardByIdComponent, DashboardComponent, DashboardService, DashboardWidgetComponent, DateRangeFilterTileComponent, DrilldownBreadcrumbsComponent, DrilldownWidgetComponent, FunnelChartComponent, IndicatorChartComponent, LineChartComponent, MemberFilterTileComponent, PieChartComponent, PivotTableComponent, PluginsService, PolarChartComponent, QueryService, SISENSE_CONTEXT_CONFIG_TOKEN, ScatterChartComponent, ScattermapChartComponent, SdkUiModule, SisenseContextService, SunburstChartComponent, THEME_CONFIG_TOKEN, TableComponent, TableWidgetComponent, ThemeService, TreemapChartComponent, WidgetService };
 //# sourceMappingURL=sisense-sdk-ui-angular.mjs.map