@sisense/sdk-ui-angular 1.32.0 → 1.34.0

package/dist/lib/utilities/widget-model-translator.d.ts

@@ -0,0 +1,289 @@
+import { type TextWidgetProps, type WidgetModel } from '@sisense/sdk-ui-preact';
+import { ChartProps, ChartWidgetProps, PivotTableProps, PivotTableWidgetProps, TableProps } from '../components';
+import { ExecutePivotQueryParams, ExecuteQueryParams } from '../services';
+/**
+ * Translates a {@link WidgetModel} to the parameters for executing a query for the widget.
+ *
+ * @example
+ * ```ts
+const widgetModel = await widgetService.getWidgetModel({
+  dashboardOid: 'your-dashboard-oid',
+  widgetOid: 'your-widget-oid'
+});
+const executeQueryParams = widgetModelTranslator.toExecuteQueryParams(widgetModel);
+const queryResult = await queryService.executeQuery(executeQueryParams);
+ * ```
+ *
+ * Note: this method is not supported for getting pivot query.
+ * Use {@link toExecutePivotQueryParams} instead for getting query parameters for the pivot widget.
+ */
+export declare const toExecuteQueryParams: (widgetModel: WidgetModel) => ExecuteQueryParams;
+/**
+ * Translates a {@link WidgetModel} to the parameters for executing a query for the pivot widget.
+ *
+ * @example
+ * ```ts
+const widgetModel = await widgetService.getWidgetModel({
+  dashboardOid: 'your-dashboard-oid',
+  widgetOid: 'your-widget-oid'
+});
+const executePivotQueryParams = widgetModelTranslator.toExecutePivotQueryParams(widgetModel);
+const queryResult = await queryService.executePivotQuery(executeQueryParams);
+ * ```
+ *
+ * Note: this method is supported only for getting pivot query.
+ * Use {@link toExecuteQueryParams} instead for getting query parameters for non-pivot widgets.
+ */
+export declare const toExecutePivotQueryParams: (widgetModel: WidgetModel) => ExecutePivotQueryParams;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a chart.
+ *
+ * @example
+ * ```html
+<csdk-chart
+  *ngIf="chartProps"
+  [chartType]="chartProps.chartType"
+  [dataSet]="chartProps.dataSet"
+  [dataOptions]="chartProps.dataOptions"
+  [filters]="chartProps.filters"
+  [highlights]="chartProps.highlights"
+  [styleOptions]="chartProps.styleOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type ChartProps
+  WidgetService,
+  widgetModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-example',
+  templateUrl: './example.component.html',
+  styleUrls: ['./example.component.scss'],
+})
+export class ExampleComponent {
+  chartProps: ChartProps | null = null;
+
+  constructor(private widgetService: WidgetService) {}
+
+  async ngOnInit(): Promise<void> {
+    const widgetModel = await widgetService.getWidgetModel({
+      dashboardOid: 'your-dashboard-oid',
+      widgetOid: 'your-widget-oid'
+    });
+    this.chartProps = widgetModelTranslator.toChartProps(widgetModel);
+  }
+}
+ * ```
+ *
+ * Note: this method is not supported for pivot widgets.
+ * Use {@link toPivotTableProps} instead for getting props for the {@link PivotTableComponent}.
+ */
+export declare function toChartProps(widgetModel: WidgetModel): ChartProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a table.
+ *
+ * @example
+ * ```html
+<csdk-table
+  *ngIf="tableProps"
+  [dataSet]="tableProps.dataSet"
+  [dataOptions]="tableProps.dataOptions"
+  [filters]="tableProps.filters"
+  [styleOptions]="tableProps.styleOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type TableProps
+  WidgetService,
+  widgetModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-example',
+  templateUrl: './example.component.html',
+  styleUrls: ['./example.component.scss'],
+})
+export class ExampleComponent {
+  tableProps: TableProps | null = null;
+
+  constructor(private widgetService: WidgetService) {}
+
+  async ngOnInit(): Promise<void> {
+    const widgetModel = await widgetService.getWidgetModel({
+      dashboardOid: 'your-dashboard-oid',
+      widgetOid: 'your-widget-oid'
+    });
+    this.tableProps = widgetModelTranslator.toTableProps(widgetModel);
+  }
+}
+ * ```
+ *
+ * Note: this method is not supported for chart and pivot widgets.
+ * Use {@link toChartProps} instead for getting props for the {@link ChartComponent}.
+ * Use {@link toPivotTableProps} instead for getting props for the {@link PivotTableComponent}.
+ */
+export declare function toTableProps(widgetModel: WidgetModel): TableProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a pivot table.
+ *
+ * @example
+ * ```html
+<csdk-pivot-table
+  *ngIf="pivotTableProps"
+  [dataSet]="pivotTableProps.dataSet"
+  [dataOptions]="pivotTableProps.dataOptions"
+  [filters]="pivotTableProps.filters"
+  [styleOptions]="pivotTableProps.styleOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type PivotTableProps
+  WidgetService,
+  widgetModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-example',
+  templateUrl: './example.component.html',
+  styleUrls: ['./example.component.scss'],
+})
+export class ExampleComponent {
+  pivotTableProps: PivotTableProps | null = null;
+
+  constructor(private widgetService: WidgetService) {}
+
+  async ngOnInit(): Promise<void> {
+    const widgetModel = await widgetService.getWidgetModel({
+      dashboardOid: 'your-dashboard-oid',
+      widgetOid: 'your-widget-oid'
+    });
+    this.pivotTableProps = widgetModelTranslator.toPivotTableProps(widgetModel);
+  }
+}
+ * ```
+ *
+ * Note: this method is not supported for chart or table widgets.
+ * Use {@link toChartProps} instead for getting props for the {@link ChartComponent}.
+ * Use {@link toTableProps} instead for getting props for the {@link TableComponent}.
+ */
+export declare function toPivotTableProps(widgetModel: WidgetModel): PivotTableProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a chart widget.
+ *
+ * @example
+ * ```html
+<csdk-chart-widget
+  *ngIf="chartWidgetProps"
+  [chartType]="chartWidgetProps.chartType"
+  [dataSource]="chartWidgetProps.dataSource"
+  [dataOptions]="chartWidgetProps.dataOptions"
+  [filters]="chartWidgetProps.filters"
+  [highlights]="chartWidgetProps.highlights"
+  [styleOptions]="chartWidgetProps.styleOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type ChartWidgetProps
+  WidgetService,
+  widgetModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-example',
+  templateUrl: './example.component.html',
+  styleUrls: ['./example.component.scss'],
+})
+export class ExampleComponent {
+  chartWidgetProps: ChartWidgetProps | null = null;
+
+  constructor(private widgetService: WidgetService) {}
+
+  async ngOnInit(): Promise<void> {
+    const widgetModel = await widgetService.getWidgetModel({
+      dashboardOid: 'your-dashboard-oid',
+      widgetOid: 'your-widget-oid'
+    });
+    this.chartWidgetProps = widgetModelTranslator.toChartWidgetProps(widgetModel);
+  }
+}
+ * ```
+ *
+ * Note: this method is not supported for pivot widgets.
+ */
+export declare function toChartWidgetProps(widgetModel: WidgetModel): ChartWidgetProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a pivot table widget.
+ *
+ * @example
+ * ```html
+<csdk-pivot-table-widget
+  *ngIf="pivotWidgetProps"
+  [dataSet]="pivotWidgetProps.dataSet"
+  [dataOptions]="pivotWidgetProps.dataOptions"
+  [filters]="pivotWidgetProps.filters"
+  [styleOptions]="pivotWidgetProps.styleOptions"
+/>
+ * ```
+ *
+ * ```ts
+import { Component } from '@angular/core';
+import {
+  type PivotTableWidgetProps
+  WidgetService,
+  widgetModelTranslator,
+} from '@sisense/sdk-ui-angular';
+
+@Component({
+  selector: 'app-example',
+  templateUrl: './example.component.html',
+  styleUrls: ['./example.component.scss'],
+})
+export class ExampleComponent {
+  pivotWidgetProps: PivotTableWidgetProps | null = null;
+
+  constructor(private widgetService: WidgetService) {}
+
+  async ngOnInit(): Promise<void> {
+    const widgetModel = await widgetService.getWidgetModel({
+      dashboardOid: 'your-dashboard-oid',
+      widgetOid: 'your-widget-oid'
+    });
+    this.pivotWidgetProps = widgetModelTranslator.toPivotTableWidgetProps(widgetModel);
+  }
+}
+ * ```
+ *
+ * Note: this method is not supported for chart or table widgets.
+ * Use {@link toChartWidgetProps} instead for getting props for the {@link ChartWidgetComponent}.
+ */
+export declare function toPivotTableWidgetProps(widgetModel: WidgetModel): PivotTableWidgetProps;
+/**
+ * Translates a {@link WidgetModel} to the props for rendering a text widget.
+ *
+ * @example
+ * ```ts
+const widgetModel = await widgetService.getWidgetModel({
+  dashboardOid: 'your-dashboard-oid',
+  widgetOid: 'your-widget-oid'
+});
+const textWidgetProps = widgetModelTranslator.toTextWidgetProps(widgetModel);
+ * ```
+ *
+ * Note: this method is not supported for chart or pivot widgets.
+ * Use {@link toChartWidgetProps} instead for getting props for the {@link ChartWidgetComponent}.
+ * Use {@link toPivotTableWidgetProps} instead for getting props for the pivot table widget.
+ */
+export declare function toTextWidgetProps(widgetModel: WidgetModel): TextWidgetProps;

package/dist/package.json

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

package/dist/public-api.d.ts

@@ -1,10 +1,11 @@
 /**
  * Public API Surface of @sisense/sdk-ui-angular
  */
-export * from './lib/sdk-ui.module';
 export * from './lib/components';
-export * from './lib/services';
+export * from './lib/sdk-ui.module';
 export * from './lib/sdk-ui-core-exports';
-export type { DataPointEvent, AreamapDataPointEvent, BoxplotDataPointEvent, ScatterDataPointEvent, ScattermapDataPointEvent, ChartDataPointEvent, DataPointsEvent, ChartDataPointsEvent, ScatterDataPointsEvent, DataPointEventHandler, ScattermapDataPointEventHandler, AreamapDataPointEventHandler, BoxplotDataPointEventHandler, DataPointsEventHandler, ScatterDataPointEventHandler, ScatterDataPointsEventHandler, } from './lib/types';
-export { createThemeContextConnector, createSisenseContextConnector, createPluginsContextConnector, } from './lib/component-wrapper-helpers';
+export * from './lib/services';
+export type { AreamapDataPointEvent, AreamapDataPointEventHandler, BoxplotDataPointEvent, BoxplotDataPointEventHandler, ChartDataPointEvent, ChartDataPointsEvent, DashboardByIdConfig, DashboardConfig, DashboardFiltersPanelConfig, DataPointEvent, DataPointEventHandler, DataPointsEvent, DataPointsEventHandler, ScatterDataPointEvent, ScatterDataPointEventHandler, ScatterDataPointsEvent, ScatterDataPointsEventHandler, ScattermapDataPointEvent, ScattermapDataPointEventHandler, } from './lib/types';
+export * from './lib/utilities';
+export { createPluginsContextConnector, createSisenseContextConnector, createThemeContextConnector, } from './lib/component-wrapper-helpers';
 export { TrackableService } from './lib/decorators';

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.32.0";
+declare const _default: "1.34.0";
 export default _default;

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.32.0",
+  "version": "1.34.0",
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "dist",
@@ -60,8 +60,8 @@
     "prebuild": "yarn sync-version && node ./scripts/generate-build-package-config.cjs",
     "postbuild": "rm ./src/package.json",
     "watch": "ng build --watch --configuration development",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
+    "lint": "eslint . --quiet",
+    "lint:fix": "run lint --fix",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "test": "TZ=utc run vitest run",
@@ -76,9 +76,9 @@
     "@angular/core": "^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
   },
   "dependencies": {
-    "@sisense/sdk-data": "^1.32.0",
-    "@sisense/sdk-tracking": "^1.32.0",
-    "@sisense/sdk-ui-preact": "^1.32.0",
+    "@sisense/sdk-data": "^1.34.0",
+    "@sisense/sdk-tracking": "^1.34.0",
+    "@sisense/sdk-ui-preact": "^1.34.0",
     "rxjs": "^7.8.1",
     "ts-deepmerge": "^6.2.0",
     "tslib": "^2.3.0"
@@ -95,7 +95,7 @@
     "ng-packagr": "^15.2.2",
     "prettier": "2.8.4",
     "typescript": "~4.9.4",
-    "vitest": "^2.1.4"
+    "vitest": "^2.1.9"
   },
   "volta": {
     "extends": "../../package.json"