@sisense/sdk-ui-angular 1.22.0 → 1.24.0

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

@@ -1,7 +1,7 @@
 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, CustomPluginsProvider, createClientApplication, executeQuery, executeQueryByWidgetId, getDashboardModel, getDashboardModels, getWidgetModel, getDefaultThemeSettings, getThemeSettingsByOid, MemberFilterTile, DateRangeFilterTile, CriteriaFilterTile, Chart, Table, PivotTable, TableWidget, DashboardWidget, createWrapperElementHandler, createWrapperElement, DrilldownWidget, createComponentRenderer, ChartWidget, DashboardById, Dashboard, DrilldownBreadcrumbs, ContextMenu } from '@sisense/sdk-ui-preact';
+import { ComponentAdapter, createElement, BasicMemberFilterTile, createContextProviderRenderer, CustomThemeProvider, CustomSisenseContextProvider, CustomPluginsProvider, createClientApplication, executeQuery, executeQueryByWidgetId, getDashboardModel, getDashboardModels, getWidgetModel, getHierarchyModels, getDefaultThemeSettings, getThemeSettingsByOid, MemberFilterTile, DateRangeFilterTile, RelativeDateFilterTile, CriteriaFilterTile, Chart, Table, PivotTable, TableWidget, DashboardWidget, WidgetById, createWrapperElementHandler, createWrapperElement, DrilldownWidget, createComponentRenderer, ChartWidget, DashboardById, Dashboard, DrilldownBreadcrumbs, ContextMenu } from '@sisense/sdk-ui-preact';
 export { boxWhiskerProcessResult, dashboardHelpers, dashboardModelTranslator, widgetModelTranslator } from '@sisense/sdk-ui-preact';
 import { map, BehaviorSubject } from 'rxjs';
 import { __decorate } from 'tslib';
@@ -111,13 +111,15 @@ const createSisenseContextConnector = (sisenseContextService) => {
             return {
                 app,
                 isInitialized: true,
-                showRuntimeErrors,
                 tracking: {
                     // if tracking is configured in appConfig, use it
                     // if none is set, default to true
                     enabled: appConfig?.trackingConfig?.enabled ?? true,
                     packageName: 'sdk-ui-angular',
                 },
+                errorBoundary: {
+                    showErrorBox: showRuntimeErrors ?? true,
+                },
             };
         },
         renderContextProvider: createContextProviderRenderer(CustomSisenseContextProvider),
@@ -397,6 +399,39 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 }]
         }], ctorParameters: function () { return [{ type: SisenseContextService }]; } });
 
+/**
+ * Service for working with Sisense Fusion hierarchies.
+ *
+ * @group Fusion Assets
+ * @fusionEmbed
+ */
+let HierarchyService = class HierarchyService {
+    constructor(sisenseContextService) {
+        this.sisenseContextService = sisenseContextService;
+    }
+    /**
+     * Retrieves existing hierarchy models from the Sisense instance.
+     *
+     * @param params - Parameters to identify the target hierarchy models
+     * @returns Hierarchy models array
+     */
+    async getHierarchyModels(params) {
+        const app = await this.sisenseContextService.getApp();
+        return getHierarchyModels(app.httpClient, params, app.defaultDataSource);
+    }
+};
+HierarchyService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: HierarchyService, deps: [{ token: SisenseContextService }], target: i0.ɵɵFactoryTarget.Injectable });
+HierarchyService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: HierarchyService, providedIn: 'root' });
+HierarchyService = __decorate([
+    TrackableService(['getHierarchyModels'])
+], HierarchyService);
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: HierarchyService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root',
+                }]
+        }], ctorParameters: function () { return [{ type: SisenseContextService }]; } });
+
 class DecoratorsModule {
     constructor(sisenseContextService) {
         DecoratorsModule.sisenseContextService = sisenseContextService;
@@ -413,7 +448,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 }]
         }], ctorParameters: function () { return [{ type: SisenseContextService }]; } });
 
-var packageVersion = '1.22.0';
+var packageVersion = '1.24.0';
 
 function Trackable(target, propertyKey, descriptor) {
     const originalMethod = descriptor.value;
@@ -678,7 +713,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * @example
  * ```html
  * <csdk-date-range-filter-tile
- *       title="dateRangeFilterTileProps.title"
+ *       [title]="dateRangeFilterTileProps.title"
  *       [attribute]="dateRangeFilterTileProps.attribute"
  *       [filter]="dateRangeFilterTileProps.filter"
  *       (filterChange)="dateRangeFilterTileProps.setFilter($event)"
@@ -804,6 +839,132 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 type: Output
             }] } });
 
+/**
+ * Relative Date Filter Tile Component
+ *
+ * @example
+ * ```html
+ * <csdk-relative-date-filter-tile
+ *       [title]="relativeDateFilterTileProps.title"
+ *       [arrangement]="relativeDateFilterTileProps.arrangement"
+ *       [filter]="relativeDateFilterTileProps.filter"
+ *       (filterChange)="relativeDateFilterTileProps.setFilter($event)"
+ *     />
+ * ```
+ * ```ts
+ * import { Component } from '@angular/core';
+ * import { Filter, filterFactory } from '@sisense/sdk-data';
+ * import * as DM from '../../assets/sample-healthcare-model';
+ *
+ * @Component({
+ *   selector: 'app-filters',
+ *   templateUrl: './filters.component.html',
+ *   styleUrls: ['./filters.component.scss'],
+ * })
+ * export class FiltersComponent {
+ *   DM = DM;
+ *
+ *   relativeDateFilterTileProps = {
+ *     title: 'Relative Date Filter',
+ *     arrangement: 'vertical',
+ *     filter: filterFactory.dateRelativeTo(DM.ER.Date.Days, 0, 150),
+ *     setFilter({ filter }: { filter: Filter | null }) {
+ *       console.log(filter);
+ *       if (filter) {
+ *         this.filter = filter;
+ *       }
+ *     },
+ *   };
+ * }
+ * ```
+ * <img src="media://angular-relative-date-filter-tile-example.png" width="600px" />
+ * @group Filter Tiles
+ */
+class RelativeDateFilterTileComponent {
+    /**
+     * Constructor for the `RelativeDateFilterTileComponent`.
+     *
+     * @param sisenseContextService - Sisense context service
+     * @param themeService - Theme service
+     */
+    constructor(
+    /**
+     * Sisense context service
+     *
+     * @category Constructor
+     */
+    sisenseContextService, 
+    /**
+     * Theme service
+     *
+     * @category Constructor
+     */
+    themeService) {
+        this.sisenseContextService = sisenseContextService;
+        this.themeService = themeService;
+        /**
+         * {@inheritDoc @sisense/sdk-ui!RelativeDateFilterTileProps.onUpdate}
+         */
+        this.filterChange = new EventEmitter();
+        this.componentAdapter = new ComponentAdapter(() => this.createPreactComponent(), [
+            createSisenseContextConnector(this.sisenseContextService),
+            createThemeContextConnector(this.themeService),
+        ]);
+    }
+    /**
+     * @internal
+     */
+    ngAfterViewInit() {
+        this.componentAdapter.render(this.preactRef.nativeElement);
+    }
+    /**
+     * @internal
+     */
+    ngOnChanges() {
+        if (this.preactRef) {
+            this.componentAdapter.render(this.preactRef.nativeElement);
+        }
+    }
+    createPreactComponent() {
+        const props = {
+            title: this.title,
+            filter: this.filter,
+            arrangement: this.arrangement,
+            limit: this.limit,
+            onUpdate: (...[filter]) => this.filterChange.emit({ filter }),
+        };
+        return createElement(RelativeDateFilterTile, props);
+    }
+    /**
+     * @internal
+     */
+    ngOnDestroy() {
+        this.componentAdapter.destroy();
+    }
+}
+RelativeDateFilterTileComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: RelativeDateFilterTileComponent, deps: [{ token: SisenseContextService }, { token: ThemeService }], target: i0.ɵɵFactoryTarget.Component });
+RelativeDateFilterTileComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: RelativeDateFilterTileComponent, selector: "csdk-relative-date-filter-tile", inputs: { title: "title", filter: "filter", arrangement: "arrangement", limit: "limit" }, outputs: { filterChange: "filterChange" }, 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: RelativeDateFilterTileComponent, decorators: [{
+            type: Component,
+            args: [{
+                    selector: 'csdk-relative-date-filter-tile',
+                    template,
+                }]
+        }], ctorParameters: function () { return [{ type: SisenseContextService }, { type: ThemeService }]; }, propDecorators: { preactRef: [{
+                type: ViewChild,
+                args: [rootId]
+            }], title: [{
+                type: Input
+            }], filter: [{
+                type: Input
+            }], arrangement: [{
+                type: Input
+            }], limit: [{
+                type: Input
+            }], filterChange: [{
+                type: Output
+            }] } });
+
 /**
  * Criteria Filter Tile Component
  *
@@ -3441,6 +3602,113 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 type: Input
             }] } });
 
+/**
+ * The `WidgetById` component, which is a thin wrapper on {@link ChartWidgetComponent},
+ * 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).
+ *
+ * @example
+ * ```html
+ * <csdk-widget-by-id
+ *    [widgetOid]="widgetOid"
+ *    [dashboardOid]="dashboardOid"
+ *    [includeDashboardFilters]="true"
+ * />
+ * ```
+ * ```ts
+ * import { Component } from '@angular/core';
+ *
+ * @Component({
+ *  selector: 'app-widgets',
+ *  templateUrl: './widgets.component.html',
+ *  styleUrls: ['./widgets.component.scss'],
+ * })
+ * export class WidgetsComponent {
+ *  widgetOid: string = '60f3e3e3e4b0e3e3e4b0e3e3';
+ *  dashboardOid: string = '60f3e3e3e4b0e3e3e4b0e3e3';
+ * }
+ * ```
+ * @group Fusion Assets
+ * @fusionEmbed
+ */
+class WidgetByIdComponent {
+    constructor(sisenseContextService, themeService) {
+        this.sisenseContextService = sisenseContextService;
+        this.themeService = themeService;
+        this.componentAdapter = new ComponentAdapter(() => this.createPreactComponent(), [
+            createSisenseContextConnector(this.sisenseContextService),
+            createThemeContextConnector(this.themeService),
+        ]);
+    }
+    /** @internal */
+    ngAfterViewInit() {
+        this.componentAdapter.render(this.preactRef.nativeElement);
+    }
+    /** @internal */
+    ngOnChanges() {
+        if (this.preactRef) {
+            this.componentAdapter.render(this.preactRef.nativeElement);
+        }
+    }
+    /** @internal */
+    createPreactComponent() {
+        const props = {
+            widgetOid: this.widgetOid,
+            dashboardOid: this.dashboardOid,
+            filters: this.filters,
+            highlights: this.highlights,
+            filtersMergeStrategy: this.filtersMergeStrategy,
+            includeDashboardFilters: this.includeDashboardFilters,
+            title: this.title,
+            description: this.description,
+            styleOptions: this.styleOptions,
+            highlightSelectionDisabled: this.highlightSelectionDisabled,
+            drilldownOptions: this.drilldownOptions,
+        };
+        return createElement(WidgetById, props);
+    }
+    /** @internal */
+    ngOnDestroy() {
+        this.componentAdapter.destroy();
+    }
+}
+WidgetByIdComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: WidgetByIdComponent, deps: [{ token: SisenseContextService }, { token: ThemeService }], target: i0.ɵɵFactoryTarget.Component });
+WidgetByIdComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: WidgetByIdComponent, selector: "csdk-widget-by-id", inputs: { widgetOid: "widgetOid", dashboardOid: "dashboardOid", filters: "filters", highlights: "highlights", filtersMergeStrategy: "filtersMergeStrategy", includeDashboardFilters: "includeDashboardFilters", title: "title", description: "description", styleOptions: "styleOptions", highlightSelectionDisabled: "highlightSelectionDisabled", drilldownOptions: "drilldownOptions" }, 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: WidgetByIdComponent, decorators: [{
+            type: Component,
+            args: [{
+                    selector: 'csdk-widget-by-id',
+                    template,
+                }]
+        }], ctorParameters: function () { return [{ type: SisenseContextService }, { type: ThemeService }]; }, propDecorators: { preactRef: [{
+                type: ViewChild,
+                args: [rootId]
+            }], widgetOid: [{
+                type: Input
+            }], dashboardOid: [{
+                type: Input
+            }], filters: [{
+                type: Input
+            }], highlights: [{
+                type: Input
+            }], filtersMergeStrategy: [{
+                type: Input
+            }], includeDashboardFilters: [{
+                type: Input
+            }], title: [{
+                type: Input
+            }], description: [{
+                type: Input
+            }], styleOptions: [{
+                type: Input
+            }], highlightSelectionDisabled: [{
+                type: Input
+            }], drilldownOptions: [{
+                type: Input
+            }] } });
+
 /**
  * An Angular component designed to add drilldown functionality to any type of chart.
  *
@@ -3480,7 +3748,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * drilldownResult?: CustomDrilldownResult;
  *
  * drilldown = {
- *   drilldownDimensions: [DM.Patients.Gender, DM.Admissions.Surgical_Procedure],
+ *   drilldownPaths: [DM.Patients.Gender, DM.Admissions.Surgical_Procedure],
  *   initialDimension: DM.Divisions.Divison_name,
  *   drilldownChange: (drilldownResult: CustomDrilldownResult) => {
  *     this.drilldownResult = drilldownResult;
@@ -3494,7 +3762,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
  * ```html
  * <!--Component HTML template in .component.html-->
  * <csdk-drilldown-widget
- *   [drilldownDimensions]="drilldown.drilldownDimensions"
+ *   [drilldownPaths]="drilldown.drilldownPaths"
  *   [initialDimension]="drilldown.initialDimension"
  *   (drilldownResultChange)="drilldown.drilldownChange($event)"
  * >
@@ -3560,6 +3828,7 @@ class DrilldownWidgetComponent {
     createPreactComponent() {
         const props = {
             drilldownDimensions: this.drilldownDimensions,
+            drilldownPaths: this.drilldownPaths,
             initialDimension: this.initialDimension,
             config: {
                 ...this.config,
@@ -3590,7 +3859,7 @@ class DrilldownWidgetComponent {
     }
 }
 DrilldownWidgetComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: DrilldownWidgetComponent, deps: [{ token: SisenseContextService }, { token: ThemeService }], target: i0.ɵɵFactoryTarget.Component });
-DrilldownWidgetComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: DrilldownWidgetComponent, selector: "csdk-drilldown-widget", inputs: { drilldownDimensions: "drilldownDimensions", initialDimension: "initialDimension", config: "config" }, outputs: { drilldownResultChange: "drilldownResultChange" }, viewQueries: [{ propertyName: "preactRef", first: true, predicate: ["preact"], descendants: true }, { propertyName: "preactContentRef", first: true, predicate: ["preactContent"], descendants: true }], usesOnChanges: true, ngImport: i0, template: "\n    <div #preact style=\"width: 100%; height: 100%\">\n        <div #preactContent style=\"width: 100%; height: 100%\">\n            <ng-content></ng-content>\n        </div>\n    </div>\n", isInline: true });
+DrilldownWidgetComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "15.2.10", type: DrilldownWidgetComponent, selector: "csdk-drilldown-widget", inputs: { drilldownDimensions: "drilldownDimensions", drilldownPaths: "drilldownPaths", initialDimension: "initialDimension", config: "config" }, outputs: { drilldownResultChange: "drilldownResultChange" }, viewQueries: [{ propertyName: "preactRef", first: true, predicate: ["preact"], descendants: true }, { propertyName: "preactContentRef", first: true, predicate: ["preactContent"], descendants: true }], usesOnChanges: true, ngImport: i0, template: "\n    <div #preact style=\"width: 100%; height: 100%\">\n        <div #preactContent style=\"width: 100%; height: 100%\">\n            <ng-content></ng-content>\n        </div>\n    </div>\n", isInline: true });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImport: i0, type: DrilldownWidgetComponent, decorators: [{
             type: Component,
             args: [{
@@ -3605,6 +3874,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                 args: [rootContentId]
             }], drilldownDimensions: [{
                 type: Input
+            }], drilldownPaths: [{
+                type: Input
             }], initialDimension: [{
                 type: Input
             }], config: [{
@@ -4247,9 +4518,11 @@ SdkUiModule.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "1
         SunburstChartComponent,
         TableWidgetComponent,
         DashboardWidgetComponent,
+        WidgetByIdComponent,
         MemberFilterTileComponent,
         DrilldownWidgetComponent,
         DateRangeFilterTileComponent,
+        RelativeDateFilterTileComponent,
         CriteriaFilterTileComponent,
         DrilldownBreadcrumbsComponent,
         ContextMenuComponent,
@@ -4276,9 +4549,11 @@ SdkUiModule.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "1
         SunburstChartComponent,
         TableWidgetComponent,
         DashboardWidgetComponent,
+        WidgetByIdComponent,
         MemberFilterTileComponent,
         DrilldownWidgetComponent,
         DateRangeFilterTileComponent,
+        RelativeDateFilterTileComponent,
         CriteriaFilterTileComponent,
         DrilldownBreadcrumbsComponent,
         ContextMenuComponent,
@@ -4311,9 +4586,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                         SunburstChartComponent,
                         TableWidgetComponent,
                         DashboardWidgetComponent,
+                        WidgetByIdComponent,
                         MemberFilterTileComponent,
                         DrilldownWidgetComponent,
                         DateRangeFilterTileComponent,
+                        RelativeDateFilterTileComponent,
                         CriteriaFilterTileComponent,
                         DrilldownBreadcrumbsComponent,
                         ContextMenuComponent,
@@ -4344,9 +4621,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.10", ngImpo
                         SunburstChartComponent,
                         TableWidgetComponent,
                         DashboardWidgetComponent,
+                        WidgetByIdComponent,
                         MemberFilterTileComponent,
                         DrilldownWidgetComponent,
                         DateRangeFilterTileComponent,
+                        RelativeDateFilterTileComponent,
                         CriteriaFilterTileComponent,
                         DrilldownBreadcrumbsComponent,
                         ContextMenuComponent,
@@ -4395,5 +4674,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, CriteriaFilterTileComponent, 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 };
+export { AreaChartComponent, AreaRangeChartComponent, AreamapChartComponent, BarChartComponent, BasicMemberFilterTileComponent, BoxplotChartComponent, ChartComponent, ChartWidgetComponent, ColumnChartComponent, ContextMenuComponent, CriteriaFilterTileComponent, DashboardByIdComponent, DashboardComponent, DashboardService, DashboardWidgetComponent, DateRangeFilterTileComponent, DrilldownBreadcrumbsComponent, DrilldownWidgetComponent, FunnelChartComponent, HierarchyService, IndicatorChartComponent, LineChartComponent, MemberFilterTileComponent, PieChartComponent, PivotTableComponent, PluginsService, PolarChartComponent, QueryService, RelativeDateFilterTileComponent, SISENSE_CONTEXT_CONFIG_TOKEN, ScatterChartComponent, ScattermapChartComponent, SdkUiModule, SisenseContextService, SunburstChartComponent, THEME_CONFIG_TOKEN, TableComponent, TableWidgetComponent, ThemeService, TreemapChartComponent, WidgetByIdComponent, WidgetService };
 //# sourceMappingURL=sisense-sdk-ui-angular.mjs.map