@sisense/sdk-ui-angular 2.20.0 → 2.22.0

package/dist/lib/helpers/chart-props-preact-translator.d.ts

@@ -0,0 +1,5 @@
+import type { ChartProps as ChartPropsPreact, PivotTableProps as PivotTablePropsPreact, TableProps as TablePropsPreact } from '@sisense/sdk-ui-preact';
+import type { ChartProps, PivotTableProps, TableProps } from '../components';
+export declare function toChartProps(preactProps: ChartPropsPreact): ChartProps;
+export declare function toTableProps(preactProps: TablePropsPreact): TableProps;
+export declare function toPivotTableProps(preactProps: PivotTablePropsPreact): PivotTableProps;

package/dist/lib/helpers/dashboard-props-preact-translator.d.ts

@@ -1,4 +1,4 @@
 import { DashboardProps as DashboardPropsPreact } from '@sisense/sdk-ui-preact';
 import type { DashboardProps } from '../components/dashboard';
-export declare function translateToPreactDashboardProps(dashboardProps: DashboardProps): DashboardPropsPreact;
-export declare function translateFromPreactDashboardProps(dashboardProps: DashboardPropsPreact): DashboardProps;
+export declare function toPreactDashboardProps(angularProps: DashboardProps): DashboardPropsPreact;
+export declare function toDashboardProps(preactProps: DashboardPropsPreact): DashboardProps;

package/dist/lib/helpers/widget-props-preact-translator.d.ts

@@ -1,4 +1,7 @@
-import { WidgetProps as WidgetPropsPreact } from '@sisense/sdk-ui-preact';
-import type { WidgetProps } from '../components/widgets';
-export declare function translateToPreactWidgetProps(widgetProps: WidgetProps): WidgetPropsPreact;
-export declare function translateFromPreactWidgetProps(widgetProps: WidgetPropsPreact): WidgetProps;
+import type { ChartWidgetProps as ChartWidgetPropsPreact, PivotTableWidgetProps as PivotTableWidgetPropsPreact, TextWidgetProps as TextWidgetPropsPreact, WidgetProps as WidgetPropsPreact } from '@sisense/sdk-ui-preact';
+import type { ChartWidgetProps, PivotTableWidgetProps, TextWidgetProps, WidgetProps } from '../components/widgets';
+export declare function toPreactWidgetProps(angularProps: WidgetProps): WidgetPropsPreact;
+export declare function toWidgetProps(preactProps: WidgetPropsPreact): WidgetProps;
+export declare function toChartWidgetProps(preactProps: ChartWidgetPropsPreact): ChartWidgetProps;
+export declare function toPivotTableWidgetProps(preactProps: PivotTableWidgetPropsPreact): PivotTableWidgetProps;
+export declare function toTextWidgetProps(preactProps: TextWidgetPropsPreact): TextWidgetProps;

package/dist/lib/services/angular-component-adapter.d.ts

@@ -0,0 +1,55 @@
+import { Type } from '@angular/core';
+import { type ExternalComponentAdapter } from '@sisense/sdk-ui-preact';
+import { DynamicRenderer } from './dynamic-renderer.service';
+/**
+ * Adapter class that manages the lifecycle of an Angular component
+ * rendered within a Preact context. This provides efficient updates
+ * by reusing the component instance instead of recreating it on every
+ * props change.
+ *
+ * This pattern mirrors how `ComponentAdapter` works for regular Preact
+ * components, ensuring consistent behavior between regular widgets
+ * and custom Angular widgets.
+ *
+ * Implements ExternalComponentAdapter interface to be compatible with
+ * the ExternalComponentAdapterElement in sdk-ui-preact.
+ *
+ * @internal
+ */
+export declare class AngularComponentAdapter<Props> implements ExternalComponentAdapter<Props> {
+    private dynamicRenderer;
+    private componentClass;
+    private componentRef;
+    private element;
+    private isDestroyed;
+    /** Set of property names declared as @Input() on the component */
+    private inputNames;
+    constructor(dynamicRenderer: DynamicRenderer, componentClass: Type<Props>);
+    /**
+     * Mounts the Angular component into the container element.
+     * This should only be called once when the Preact wrapper mounts.
+     *
+     * @param container - The DOM element to mount the Angular component into
+     * @param props - Initial props to pass to the component
+     */
+    mount(container: HTMLElement, props: Props): void;
+    /**
+     * Updates the props on the existing Angular component instance.
+     * Uses ComponentRef.setInput() for @Input properties to ensure proper
+     * change detection, OnPush component marking, and ngOnChanges lifecycle
+     * hook execution. Uses direct assignment for non-input properties
+     * (e.g., event callbacks).
+     *
+     * @param props - New props to apply to the component
+     */
+    update(props: Props): void;
+    /**
+     * Destroys the Angular component and cleans up resources.
+     * This should be called when the Preact wrapper unmounts.
+     */
+    destroy(): void;
+    /**
+     * Returns whether the adapter has an active component instance.
+     */
+    isActive(): boolean;
+}

package/dist/lib/services/custom-widgets.service.d.ts

@@ -1,6 +1,7 @@
 import { Type } from '@angular/core';
-import { type CustomWidgetComponent as CustomWidgetComponentPreact, type CustomWidgetComponentProps, type GenericDataOptions } from '@sisense/sdk-ui-preact';
+import { type CustomWidgetComponent as CustomWidgetComponentPreact, type GenericDataOptions } from '@sisense/sdk-ui-preact';
 import { BehaviorSubject } from 'rxjs';
+import type { CustomWidgetComponentProps } from '../types';
 import { DynamicRenderer } from './dynamic-renderer.service';
 import * as i0 from "@angular/core";
 /** Re-export related types */

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

@@ -0,0 +1,73 @@
+import type { CalculatedMeasure } from '@sisense/sdk-data';
+import { type UseGetSharedFormulaParams as UseGetSharedFormulaParamsPreact } from '@sisense/sdk-ui-preact';
+import { SisenseContextService } from './sisense-context.service';
+import * as i0 from "@angular/core";
+/**
+ * Parameters for retrieving a shared formula.
+ */
+export interface GetSharedFormulaParams extends Omit<UseGetSharedFormulaParamsPreact, 'enabled'> {
+}
+/**
+ * Service for working with shared formulas.
+ *
+ * @group Fusion Assets
+ * @fusionEmbed
+ */
+export declare class FormulaService {
+    private sisenseContextService;
+    constructor(sisenseContextService: SisenseContextService);
+    /**
+     * Fetch a [shared formula](https://docs.sisense.com/main/SisenseLinux/shared-formulas.htm) from a Fusion instance.
+     *
+     * The formula can be identified either by `oid` or by `name` and `dataSource` pair.
+     *
+     * When the retrieval is successful but the shared formula is not found, the result is `null`. When the retrieval is not successful, the promise is rejected with an error.
+     *
+     * ## Example
+     *
+     * Retrieve a shared formula by oid:
+     *
+     * ```ts
+     * try {
+     *   const formula = await formulaService.getSharedFormula({
+     *     oid: 'd61c337b-fabc-4e9e-b4cc-a30116857153',
+     *   });
+     *
+     *   if (formula) {
+     *     console.log('Formula found:', formula);
+     *   } else {
+     *     console.log('Formula not found');
+     *   }
+     * } catch (error) {
+     *   console.error('Error:', error);
+     * }
+     * ```
+     *
+     * ## Example
+     *
+     * Retrieve a shared formula by name and data source:
+     *
+     * ```ts
+     * try {
+     *   const formula = await formulaService.getSharedFormula({
+     *     name: 'My Shared Formula',
+     *     dataSource: DM.DataSource,
+     *   });
+     *
+     *   if (formula) {
+     *     console.log('Formula found:', formula);
+     *   } else {
+     *     console.log('Formula not found');
+     *   }
+     * } catch (error) {
+     *   console.error('Error:', error);
+     * }
+     * ```
+     *
+     * @param params - Parameters for retrieving the shared formula. Must include either `oid` or both `name` and `dataSource`.
+     * @returns Promise that resolves to the shared formula, or `null` if not found
+     */
+    getSharedFormula(params: GetSharedFormulaParams): Promise<CalculatedMeasure | null>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormulaService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FormulaService>;
+}

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

@@ -1,6 +1,7 @@
 export * from './custom-widgets.service';
 export * from './dashboard.service';
 export * from './filter.service';
+export * from './formula.service';
 export * from './hierarchy.service';
 export * from './query.service';
 export * from './sisense-context.service';

package/dist/lib/types/custom-widget-component-props.d.ts

@@ -0,0 +1,73 @@
+import type { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
+import type { AbstractDataPointWithEntries, CustomWidgetEventProps, CustomWidgetStyleOptions, GenericDataOptions } from '@sisense/sdk-ui-preact';
+/**
+ * Props passed to a user-defined custom widget component.
+ *
+ * @typeParam DataOptions - The shape of data options for this custom widget
+ * @typeParam StyleOptions - The shape of style options for this custom widget
+ * @typeParam DataPoint - The shape of data points for event handlers
+ *
+ * @example
+ * ```ts
+ * import { Component, Input } from '@angular/core';
+ * import {
+ *   CustomWidgetComponentProps,
+ *   CustomWidgetsService,
+ *   GenericDataOptions,
+ *   AbstractDataPointWithEntries,
+ *   DataPointEntry,
+ *   StyledColumn,
+ *   StyledMeasureColumn,
+ * } from '@sisense/sdk-ui-angular';
+ * import type { DataSource, Filter, FilterRelations } from '@sisense/sdk-data';
+ *
+ * interface MyDataOptions extends GenericDataOptions {
+ *   category: StyledColumn[];
+ *   value: StyledMeasureColumn[];
+ * }
+ *
+ * interface MyDataPoint extends AbstractDataPointWithEntries {
+ *   entries: {
+ *     category: DataPointEntry[];
+ *     value: DataPointEntry[];
+ *   };
+ * }
+ *
+ * type MyWidgetProps = CustomWidgetComponentProps<MyDataOptions, object, MyDataPoint>;
+ *
+ * @Component({
+ *   selector: 'app-my-widget',
+ *   template: `<div>My Custom Widget</div>`,
+ * })
+ * export class MyWidgetComponent implements MyWidgetProps {
+ *   @Input() dataOptions!: MyDataOptions;
+ *   @Input() dataSource?: DataSource;
+ *   @Input() styleOptions?: object;
+ *   @Input() filters?: Filter[] | FilterRelations;
+ *   @Input() highlights?: Filter[];
+ *   @Input() description?: string;
+ *   @Input() onDataPointClick?: (point: MyDataPoint, nativeEvent: MouseEvent) => void;
+ *   @Input() onDataPointContextMenu?: (point: MyDataPoint, nativeEvent: MouseEvent) => void;
+ *   @Input() onDataPointsSelected?: (points: MyDataPoint[], nativeEvent: MouseEvent) => void;
+ * }
+ *
+ * // In AppModule or a component, register the custom widget:
+ * constructor(private customWidgets: CustomWidgetsService) {
+ *   this.customWidgets.registerCustomWidget('my-widget', MyWidgetComponent);
+ * }
+ * ```
+ */
+export interface CustomWidgetComponentProps<DataOptions = GenericDataOptions, StyleOptions = CustomWidgetStyleOptions, DataPoint extends AbstractDataPointWithEntries = AbstractDataPointWithEntries> extends CustomWidgetEventProps<DataPoint> {
+    /** Data source for the custom widget */
+    dataSource?: DataSource;
+    /** Data options defining what data to display */
+    dataOptions: DataOptions;
+    /** Style options for customizing appearance */
+    styleOptions?: StyleOptions;
+    /** Filters to apply to the data */
+    filters?: Filter[] | FilterRelations;
+    /** Highlight filters for interactive highlighting */
+    highlights?: Filter[];
+    /** Description of the widget */
+    description?: string;
+}

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

@@ -1,4 +1,5 @@
 export * from './chart-event-props';
+export * from './custom-widget-component-props';
 export * from './data-point';
 export * from './filter-event-props';
 export * from './utility-types';

package/dist/package.json

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

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "2.20.0";
+declare const _default: "2.22.0";
 export default _default;

package/package.json

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