@sisense/sdk-ui-vue 2.20.0 → 2.21.0

package/dist/packages/sdk-ui-vue/src/components/widgets/chart-widget.d.ts

@@ -75,13 +75,6 @@ export declare const ChartWidget: import("vue").DefineComponent<{
         type: PropType<import("@sisense/sdk-ui-preact").ChartType>;
         required: true;
     };
-    /**
-     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.contextMenuItems}
-     *
-     * @category Widget
-     * @internal
-     */
-    contextMenuItems: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataOptions}
      *
@@ -134,13 +127,6 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      * @category Callbacks
      */
     onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenuClose}
-     *
-     * @category Callbacks
-     * @internal
-     */
-    onContextMenuClose: PropType<(() => void) | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointClick}
      *
@@ -209,13 +195,6 @@ export declare const ChartWidget: import("vue").DefineComponent<{
         type: PropType<import("@sisense/sdk-ui-preact").ChartType>;
         required: true;
     };
-    /**
-     * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.contextMenuItems}
-     *
-     * @category Widget
-     * @internal
-     */
-    contextMenuItems: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.dataOptions}
      *
@@ -268,13 +247,6 @@ export declare const ChartWidget: import("vue").DefineComponent<{
      * @category Callbacks
      */
     onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointContextMenuClose}
-     *
-     * @category Callbacks
-     * @internal
-     */
-    onContextMenuClose: PropType<(() => void) | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartProps.onDataPointClick}
      *

package/dist/packages/sdk-ui-vue/src/components/widgets/widget-by-id.d.ts

@@ -34,8 +34,6 @@ export interface WidgetByIdProps extends WidgetByIdPropsPreact {
 export declare const WidgetById: import("vue").DefineComponent<{
     /** @internal */
     bottomSlot: PropType<import("react").ReactNode>;
-    /** @internal */
-    contextMenuItems: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.dashboardOid}
      *
@@ -89,8 +87,6 @@ export declare const WidgetById: import("vue").DefineComponent<{
      * @category Callbacks
      */
     onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
-    /** @internal */
-    onContextMenuClose: PropType<(() => void) | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointClick}
      *
@@ -145,8 +141,6 @@ export declare const WidgetById: import("vue").DefineComponent<{
 }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /** @internal */
     bottomSlot: PropType<import("react").ReactNode>;
-    /** @internal */
-    contextMenuItems: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.dashboardOid}
      *
@@ -200,8 +194,6 @@ export declare const WidgetById: import("vue").DefineComponent<{
      * @category Callbacks
      */
     onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | import("@sisense/sdk-ui-preact").IndicatorBeforeRenderHandler | undefined>;
-    /** @internal */
-    onContextMenuClose: PropType<(() => void) | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointClick}
      *

package/dist/packages/sdk-ui-vue/src/components/widgets/widget.d.ts

@@ -157,19 +157,19 @@ export declare const Widget: import("vue").DefineComponent<{
      *
      * @category Callbacks
      */
-    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").TextWidgetDataPointEventHandler | undefined>;
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | import("@sisense/sdk-ui-preact").CustomWidgetDataPointEventHandler<import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").TextWidgetDataPointEventHandler | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
      *
      * @category Callbacks
      */
-    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | import("@sisense/sdk-ui-preact").CustomWidgetDataPointContextMenuHandler<import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointsSelected}
      *
      * @category Callbacks
      */
-    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointsEventHandler | undefined>;
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").CustomWidgetDataPointsEventHandler<import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> | import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointsEventHandler | undefined>;
 }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
 }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -282,17 +282,17 @@ export declare const Widget: import("vue").DefineComponent<{
      *
      * @category Callbacks
      */
-    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").TextWidgetDataPointEventHandler | undefined>;
+    onDataPointClick: PropType<import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | import("@sisense/sdk-ui-preact").CustomWidgetDataPointEventHandler<import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | import("@sisense/sdk-ui-preact").IndicatorDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | import("@sisense/sdk-ui-preact").TextWidgetDataPointEventHandler | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointContextMenu}
      *
      * @category Callbacks
      */
-    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").PivotTableDataPointEventHandler | import("@sisense/sdk-ui-preact").CustomWidgetDataPointContextMenuHandler<import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> | import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointEventHandler | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!ChartWidgetProps.onDataPointsSelected}
      *
      * @category Callbacks
      */
-    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointsEventHandler | undefined>;
+    onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").CustomWidgetDataPointsEventHandler<import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> | import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | import("@sisense/sdk-ui-preact").CalendarHeatmapDataPointsEventHandler | undefined>;
 }>>, {}, {}>;

package/dist/packages/sdk-ui-vue/src/composables/use-custom-widgets.d.ts

@@ -35,7 +35,7 @@ export declare const useCustomWidgets: () => {
      * @param customWidgetType - The unique identifier for the custom widget type.
      * @param customWidget - The custom widget component to register.
      */
-    registerCustomWidget: <Props extends CustomWidgetComponentProps<GenericDataOptions, any> = CustomWidgetComponentProps<GenericDataOptions, any>>(customWidgetType: string, customWidget: CustomWidgetComponent<Props>) => void;
+    registerCustomWidget: <Props extends CustomWidgetComponentProps<GenericDataOptions, import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions, import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries> = CustomWidgetComponentProps<GenericDataOptions, import("@sisense/sdk-ui-preact").CustomWidgetStyleOptions, import("@sisense/sdk-ui-preact").AbstractDataPointWithEntries>>(customWidgetType: string, customWidget: CustomWidgetComponent<Props>) => void;
     /**
      * Checks if a custom widget is registered.
      *

package/dist/packages/sdk-ui-vue/src/helpers/vue-component-adapter.d.ts

@@ -0,0 +1,54 @@
+import type { CompleteThemeSettings, CustomSisenseContext } from '@sisense/sdk-ui-preact';
+import type { ExternalComponentAdapter } from '@sisense/sdk-ui-preact';
+import { type Component, type DefineComponent, type Ref } from 'vue';
+type AnyObject = Record<string, any>;
+/**
+ * Adapter class that manages the lifecycle of a Vue component
+ * rendered within a Preact context. This provides efficient updates
+ * by reusing the component instance instead of recreating it on every
+ * props change.
+ *
+ * Implements ExternalComponentAdapter interface to be compatible with
+ * the ExternalComponentAdapterElement in sdk-ui-preact.
+ *
+ * @internal
+ */
+export declare class VueComponentAdapter<Props extends AnyObject> implements ExternalComponentAdapter<Props> {
+    private componentClass;
+    private contexts;
+    private app;
+    private container;
+    private isDestroyed;
+    private propsRef;
+    constructor(componentClass: Component<Props> | DefineComponent<Props>, contexts: {
+        sisenseContext: Ref<CustomSisenseContext>;
+        themeContext: Ref<CompleteThemeSettings>;
+        customWidgetsContext: Ref<any>;
+    });
+    /**
+     * Mounts the Vue component into the container element.
+     * This should only be called once when the Preact wrapper mounts.
+     *
+     * @param container - The DOM element to mount the Vue component into
+     * @param props - Initial props to pass to the component
+     */
+    mount(container: HTMLElement, props: Props): void;
+    /**
+     * Updates the props on the existing Vue component instance.
+     * This triggers Vue's reactivity system to re-render the component
+     * without destroying and recreating it.
+     *
+     * @param props - New props to apply to the component
+     */
+    update(props: Props): void;
+    /**
+     * Destroys the Vue 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;
+}
+export {};