@sisense/sdk-ui-angular 1.18.1 → 1.20.0

package/dist/lib/component-wrapper-helpers/context-connectors.d.ts

@@ -1,6 +1,7 @@
-import { ContextConnector, CustomSisenseContext, CustomThemeProviderProps } from '@sisense/sdk-ui-preact';
+import { ContextConnector, CustomSisenseContext, CustomThemeProviderProps, CustomPluginsProviderProps } from '@sisense/sdk-ui-preact';
 import { SisenseContextService } from '../services/sisense-context.service';
 import { ThemeService } from '../services/theme.service';
+import { PluginsService } from '../services/plugins.service';
 /**
  * Creates theme context connector
  *
@@ -15,3 +16,10 @@ export declare const createThemeContextConnector: (themeService: ThemeService) =
  * @internal
  */
 export declare const createSisenseContextConnector: (sisenseContextService: SisenseContextService) => ContextConnector<CustomSisenseContext>;
+/**
+ * Creates plugins context connector
+ *
+ * @param pluginsService - The plugin service
+ * @internal
+ */
+export declare const createPluginsContextConnector: (pluginsService: PluginsService) => ContextConnector<CustomPluginsProviderProps['context']>;

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

@@ -2,6 +2,7 @@ import { AfterViewInit, ElementRef, OnChanges, OnDestroy } from '@angular/core';
 import { type DashboardByIdProps } from '@sisense/sdk-ui-preact';
 import { SisenseContextService } from '../../services/sisense-context.service';
 import { ThemeService } from '../../services/theme.service';
+import { PluginsService } from '../../services/plugins.service';
 import * as i0 from "@angular/core";
 /**
  * An Angular component used for easily rendering a dashboard by its ID created in a Sisense Fusion instance.
@@ -28,7 +29,7 @@ import * as i0 from "@angular/core";
  * ```
  * @group Fusion Embed
  * @fusionEmbed
- * @alpha
+ * @beta
  */
 export declare class DashboardByIdComponent implements AfterViewInit, OnChanges, OnDestroy {
     /**
@@ -43,6 +44,13 @@ export declare class DashboardByIdComponent implements AfterViewInit, OnChanges,
      * @category Constructor
      */
     themeService: ThemeService;
+    /**
+     * Plugin service
+     *
+     * @internal
+     * @category Constructor
+     */
+    pluginService: PluginsService;
     /**
      * @internal
      */
@@ -70,7 +78,14 @@ export declare class DashboardByIdComponent implements AfterViewInit, OnChanges,
      *
      * @category Constructor
      */
-    themeService: ThemeService);
+    themeService: ThemeService, 
+    /**
+     * Plugin service
+     *
+     * @internal
+     * @category Constructor
+     */
+    pluginService: PluginsService);
     /**
      * @internal
      */

package/dist/lib/components/dashboard/dashboard.component.d.ts

@@ -13,16 +13,17 @@ import * as i0 from "@angular/core";
  * <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',
@@ -31,17 +32,17 @@ import * as i0 from "@angular/core";
  * })
  * 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
  */
 export declare class DashboardComponent implements AfterViewInit, OnChanges, OnDestroy {
     /**
@@ -65,9 +66,15 @@ export declare class DashboardComponent implements AfterViewInit, OnChanges, OnD
      */
     title: DashboardProps['title'];
     /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.layout}
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.layoutOptions}
+     */
+    layoutOptions: DashboardProps['layoutOptions'];
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.config}
+     *
+     * @internal
      */
-    layout: DashboardProps['layout'];
+    config: DashboardProps['config'];
     /**
      * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
      */
@@ -81,9 +88,9 @@ export declare class DashboardComponent implements AfterViewInit, OnChanges, OnD
      */
     defaultDataSource: DashboardProps['defaultDataSource'];
     /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgetFilterOptions}
+     * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgetsOptions}
      */
-    widgetFilterOptions: DashboardProps['widgetFilterOptions'];
+    widgetsOptions: DashboardProps['widgetsOptions'];
     /**
      * {@inheritDoc @sisense/sdk-ui!DashboardProps.styleOptions}
      */
@@ -122,5 +129,5 @@ export declare class DashboardComponent implements AfterViewInit, OnChanges, OnD
      */
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DashboardComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DashboardComponent, "csdk-dashboard", never, { "title": "title"; "layout": "layout"; "widgets": "widgets"; "filters": "filters"; "defaultDataSource": "defaultDataSource"; "widgetFilterOptions": "widgetFilterOptions"; "styleOptions": "styleOptions"; }, {}, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DashboardComponent, "csdk-dashboard", never, { "title": "title"; "layoutOptions": "layoutOptions"; "config": "config"; "widgets": "widgets"; "filters": "filters"; "defaultDataSource": "defaultDataSource"; "widgetsOptions": "widgetsOptions"; "styleOptions": "styleOptions"; }, {}, never, never, false, never>;
 }

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

@@ -60,7 +60,7 @@ import * as i0 from "@angular/core";
  * ```
  * <img src="media://angular-chart-widget-example.png" width="800px" />
  *
- * @group Chart Utilities
+ * @group Dashboarding
  */
 export declare class ChartWidgetComponent implements AfterViewInit, OnChanges, OnDestroy {
     private sisenseContextService;

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

@@ -104,7 +104,7 @@ export declare class DrilldownWidgetComponent implements AfterViewInit, OnChange
      * @category Widget
      *
      */
-    drilldownDimensions: DrilldownWidgetProps['drilldownDimensions'];
+    drilldownDimensions: NonNullable<DrilldownWidgetProps['drilldownDimensions']>;
     /**
      * {@inheritDoc @sisense/sdk-ui!DrilldownWidgetProps.initialDimension}
      *

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

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

package/dist/lib/services/index.d.ts

@@ -1,5 +1,6 @@
 export * from './query.service';
 export * from './sisense-context.service';
 export * from './theme.service';
+export * from './plugins.service';
 export * from './dashboard.service';
 export * from './widget.service';

package/dist/lib/services/plugins.service.d.ts

@@ -0,0 +1,37 @@
+import { BehaviorSubject } from 'rxjs';
+import { PluginComponent } from '@sisense/sdk-ui-preact';
+import * as i0 from "@angular/core";
+/**
+ * Service for working with plugins fetched from an external environment.
+ *
+ * Provides methods for registering, retrieving, and interacting with plugins.
+ *
+ * @internal
+ * @group Contexts
+ */
+export declare class PluginsService {
+    private pluginMap$;
+    constructor();
+    /**
+     * 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: string, plugin: PluginComponent): void;
+    /**
+     * 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: string): PluginComponent | undefined;
+    /**
+     * Retrieves a complete plugin map.
+     *
+     * @returns A plugin map.
+     */
+    getPlugins(): BehaviorSubject<Map<string, PluginComponent>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PluginsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PluginsService>;
+}

package/dist/lib/services/theme.service.d.ts

@@ -1,5 +1,5 @@
 import { InjectionToken } from '@angular/core';
-import { type ThemeProviderProps as ThemeConfig } from '@sisense/sdk-ui-preact';
+import { type ThemeProviderProps as ThemeConfig, type CompleteThemeSettings } from '@sisense/sdk-ui-preact';
 import { type ThemeSettings } from '../sdk-ui-core-exports';
 import { SisenseContextService } from './sisense-context.service';
 import * as i0 from "@angular/core";
@@ -53,156 +53,7 @@ export declare class ThemeService {
     private initThemeSettings;
     private applyThemeSettings;
     /** @internal */
-    getThemeSettings(): import("rxjs").Observable<{
-        chart: {
-            textColor: string;
-            secondaryTextColor: string;
-            backgroundColor: string;
-            panelBackgroundColor: string;
-            animation: {
-                init: {
-                    duration: number | "auto";
-                };
-                redraw: {
-                    duration: number | "auto";
-                };
-            };
-        };
-        palette: {
-            variantColors: import("@sisense/sdk-ui-preact").Color[];
-        };
-        typography: {
-            fontFamily: string;
-            primaryTextColor: string;
-            secondaryTextColor: string;
-        };
-        general: {
-            brandColor: string;
-            backgroundColor: string;
-            primaryButtonTextColor: string;
-            primaryButtonHoverColor: string;
-        };
-        widget: {
-            spaceAround: import("@sisense/sdk-ui-preact").SpaceSizes;
-            cornerRadius: import("@sisense/sdk-ui-preact").RadiusSizes;
-            shadow: import("@sisense/sdk-ui-preact").ShadowsTypes;
-            border: boolean;
-            borderColor: string;
-            header: {
-                titleTextColor: string;
-                titleAlignment: import("@sisense/sdk-ui-preact").AlignmentTypes;
-                dividerLine: boolean;
-                dividerLineColor: string;
-                backgroundColor: string;
-            };
-        };
-        dashboard: {
-            backgroundColor: string;
-            dividerLineWidth: number;
-            dividerLineColor: string;
-        };
-        filter: {
-            panel: {
-                titleColor: string;
-                backgroundColor: string;
-            };
-        };
-        aiChat: {
-            backgroundColor: string;
-            primaryTextColor: string;
-            secondaryTextColor: string;
-            primaryFontSize: [fontSize: string, lineHeight: string];
-            border: string | false;
-            borderRadius: string | false;
-            body: {
-                paddingLeft: string;
-                paddingRight: string;
-                paddingTop: string;
-                paddingBottom: string;
-                gapBetweenMessages: string;
-            };
-            footer: {
-                paddingLeft: string;
-                paddingRight: string;
-                paddingTop: string;
-                paddingBottom: string;
-            };
-            userMessages: {
-                backgroundColor: string;
-            };
-            systemMessages: {
-                backgroundColor: string;
-            };
-            input: {
-                backgroundColor: string;
-                focus: {
-                    outlineColor: string;
-                };
-            };
-            header: {
-                backgroundColor: string;
-                textColor: string;
-            };
-            dropup: {
-                backgroundColor: string;
-                boxShadow: string;
-                borderRadius: string;
-                headers: {
-                    textColor: string;
-                    hover: {
-                        backgroundColor: string;
-                    };
-                };
-                items: {
-                    textColor: string;
-                    hover: {
-                        backgroundColor: string;
-                    };
-                };
-            };
-            suggestions: {
-                textColor: string;
-                backgroundColor: string;
-                border: string;
-                borderGradient: [string, string] | null;
-                borderRadius: string;
-                hover: {
-                    textColor: string;
-                    backgroundColor: string;
-                };
-                loadingGradient: [string, string];
-                gap: string;
-            };
-            clickableMessages: {
-                textColor: string;
-                backgroundColor: string;
-                border: string | false;
-                borderGradient: [string, string] | null;
-                hover: {
-                    textColor: string;
-                    backgroundColor: string;
-                };
-            };
-            dataTopics: {
-                backgroundColor: string;
-                items: {
-                    textColor: string;
-                    backgroundColor: string;
-                };
-            };
-            icons: {
-                color: string;
-                feedbackIcons: {
-                    hoverColor: string;
-                };
-            };
-            tooltips: {
-                backgroundColor: string;
-                textColor: string;
-                boxShadow: string;
-            };
-        };
-    }>;
+    getThemeSettings(): import("rxjs").Observable<CompleteThemeSettings>;
     updateThemeSettings(theme: string | ThemeSettings): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ThemeService, [null, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ThemeService>;

package/dist/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.18.1",
+  "version": "1.20.0",
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist",

package/dist/public-api.d.ts

@@ -14,6 +14,8 @@
  * 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

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.18.1";
+declare const _default: "1.20.0";
 export default _default;

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.18.1",
+  "version": "1.20.0",
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist",
@@ -45,9 +45,9 @@
     "@angular/core": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0"
   },
   "dependencies": {
-    "@sisense/sdk-data": "^1.18.1",
-    "@sisense/sdk-tracking": "^1.18.1",
-    "@sisense/sdk-ui-preact": "^1.18.1",
+    "@sisense/sdk-data": "^1.20.0",
+    "@sisense/sdk-tracking": "^1.20.0",
+    "@sisense/sdk-ui-preact": "^1.20.0",
     "rxjs": "^7.8.1",
     "ts-deepmerge": "^6.2.0",
     "tslib": "^2.3.0"