@sisense/sdk-ui-vue 1.15.0 → 1.16.0

package/dist/src/components/widgets/dashboard-widget.d.ts

@@ -4,6 +4,8 @@ import type { PropType } from 'vue';
  * The Dashboard Widget component, which is a thin wrapper on the {@link ChartWidget} component,
  * used to render a widget created in the Sisense instance.
  *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @example
  * Here's how you can use the DashboardWidget component in a Vue application:
  * ```vue
@@ -24,51 +26,199 @@ import type { PropType } from 'vue';
  * @fusionEmbed
  */
 export declare const DashboardWidget: import("vue").DefineComponent<{
+    /** @internal */
     bottomSlot: PropType<import("react").ReactNode>;
+    /** @internal */
     contextMenuItems: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.dashboardOid}
+     *
+     * @category Widget
+     */
     dashboardOid: PropType<string>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.description}
+     *
+     * @category Widget
+     */
     description: PropType<string | undefined>;
+    /** @internal */
     drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.filters}
+     *
+     * @category Data
+     */
     filters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
-    /** {@inheritDoc ExecuteQueryByWidgetIdParams.filtersMergeStrategy} */
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.filtersMergeStrategy}
+     *
+     * @category Data
+     */
     filtersMergeStrategy: PropType<"widgetFirst" | "codeFirst" | "codeOnly" | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.highlightSelectionDisabled}
+     *
+     * @category Widget
+     */
     highlightSelectionDisabled: PropType<boolean | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.highlights}
+     *
+     * @category Data
+     */
     highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
-    /** {@inheritDoc ExecuteQueryByWidgetIdParams.includeDashboardFilters} */
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.includeDashboardFilters}
+     *
+     * @category Data
+     */
     includeDashboardFilters: PropType<boolean | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onBeforeRender}
+     *
+     * @category Callbacks
+     */
     onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    /** @internal */
     onContextMenuClose: PropType<(() => void) | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
     onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
     onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointsSelected}
+     *
+     * @category Callbacks
+     */
     onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.styleOptions}
+     *
+     * @category Widget
+     */
     styleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardWidgetStyleOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.title}
+     *
+     * @category Widget
+     */
     title: PropType<string | undefined>;
+    /** @internal */
     topSlot: PropType<import("react").ReactNode>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.widgetOid}
+     *
+     * @category Widget
+     */
     widgetOid: PropType<string>;
+    /** @internal */
     widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardWidgetStyleOptions | 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<{
+    /** @internal */
     bottomSlot: PropType<import("react").ReactNode>;
+    /** @internal */
     contextMenuItems: PropType<import("@sisense/sdk-ui-preact").MenuItemSection[] | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.dashboardOid}
+     *
+     * @category Widget
+     */
     dashboardOid: PropType<string>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.description}
+     *
+     * @category Widget
+     */
     description: PropType<string | undefined>;
+    /** @internal */
     drilldownOptions: PropType<import("@sisense/sdk-ui-preact").DrilldownOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.filters}
+     *
+     * @category Data
+     */
     filters: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
-    /** {@inheritDoc ExecuteQueryByWidgetIdParams.filtersMergeStrategy} */
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.filtersMergeStrategy}
+     *
+     * @category Data
+     */
     filtersMergeStrategy: PropType<"widgetFirst" | "codeFirst" | "codeOnly" | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.highlightSelectionDisabled}
+     *
+     * @category Widget
+     */
     highlightSelectionDisabled: PropType<boolean | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.highlights}
+     *
+     * @category Data
+     */
     highlights: PropType<import("@sisense/sdk-data").Filter[] | undefined>;
-    /** {@inheritDoc ExecuteQueryByWidgetIdParams.includeDashboardFilters} */
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.includeDashboardFilters}
+     *
+     * @category Data
+     */
     includeDashboardFilters: PropType<boolean | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onBeforeRender}
+     *
+     * @category Callbacks
+     */
     onBeforeRender: PropType<import("@sisense/sdk-ui-preact").BeforeRenderHandler | undefined>;
+    /** @internal */
     onContextMenuClose: PropType<(() => void) | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointClick}
+     *
+     * @category Callbacks
+     */
     onDataPointClick: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").AreamapDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").ScattermapDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointContextMenu}
+     *
+     * @category Callbacks
+     */
     onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.onDataPointsSelected}
+     *
+     * @category Callbacks
+     */
     onDataPointsSelected: PropType<import("@sisense/sdk-ui-preact").DataPointsEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointsEventHandler | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.styleOptions}
+     *
+     * @category Widget
+     */
     styleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardWidgetStyleOptions | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.title}
+     *
+     * @category Widget
+     */
     title: PropType<string | undefined>;
+    /** @internal */
     topSlot: PropType<import("react").ReactNode>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardWidgetProps.widgetOid}
+     *
+     * @category Widget
+     */
     widgetOid: PropType<string>;
+    /** @internal */
     widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardWidgetStyleOptions | undefined>;
 }>>, {}, {}>;

package/dist/src/composables/use-execute-query-by-widget-id.d.ts

@@ -7,6 +7,8 @@ import type { MaybeRefOrWithRefs } from '../types';
  * the query's loading, success, and error states. This composable integrates with the Sisense application context
  * to perform queries and handle their results within Vue components.
  *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @param {ExecuteQueryByWidgetIdParams} params - Parameters for executing the query, including widget ID, filters,
  * and other relevant query options. The `filters` parameter allows for specifying dynamic filters for the query.
  *
@@ -34,7 +36,8 @@ import type { MaybeRefOrWithRefs } from '../types';
  * - `isError`: A boolean indicating if an error occurred during the query execution.
  * - `isSuccess`: A boolean indicating if the query executed successfully.
  * - `error`: An Error object containing the error details if an error occurred.
- * - `query`: The query object returned by the SDK, useful for debugging or advanced handling.
+ * - `query`: The query object returned for chart widget, useful for debugging or advanced handling.
+ * - `pivotQuery`: The pivot query object returned for pivot widget, useful for debugging or advanced handling.
  *
  * Utilizing this composable allows for declarative and reactive handling of widget-specific queries within Vue applications,
  * facilitating easier data fetching and state management with the Sisense SDK.

package/dist/src/composables/use-get-dashboard-model.d.ts

@@ -7,6 +7,8 @@ import type { GetDashboardModelParams } from '@sisense/sdk-ui-preact';
  * for Vue applications that need to integrate Sisense dashboard analytics, providing a reactive way to fetch
  * and display dashboard data.
  *
+ * **Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @param {GetDashboardModelParams} params - The parameters for fetching the dashboard model, including the
  * dashboard OID and an option to include widgets within the dashboard. Supports dynamic parameter values through
  * Vue refs, allowing for reactive dashboard loading based on user interactions or other application states.

package/dist/src/composables/use-get-dashboard-models.d.ts

@@ -6,6 +6,8 @@ import type { MaybeRefOrWithRefs } from '../types';
  * dashboard models from Sisense. It provides a reactive interface to handle loading, success, and error states,
  * making it easier to integrate Sisense analytics within Vue applications.
  *
+ * **Note:** Dashboard extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @param {GetDashboardModelsParams} params - Parameters for fetching the dashboard models, which can include filters,
  * sorting options, and pagination settings to customize the fetch operation. The parameters allow for precise control
  * over which dashboards are retrieved and in what order.

package/dist/src/composables/use-get-widget-model.d.ts

@@ -6,6 +6,8 @@ import type { MaybeRefOrWithRefs } from '../types';
  * success, and error states of the fetch operation. This composable is particularly useful for Vue applications that
  * require detailed information about a Sisense widget for data visualization or analytics purposes.
  *
+ * **Note:** Widget extensions based on JS scripts and add-ons in Fusion are not supported.
+ *
  * @param {GetWidgetModelParams} params - The parameters for fetching the widget model, including the `dashboardOid`
  * (the OID of the dashboard containing the widget) and the `widgetOid` (the OID of the widget to fetch). This allows for
  * precise and dynamic fetching of widget models based on application needs.

package/dist/src/providers/sisense-context-provider.d.ts

@@ -62,11 +62,41 @@ export declare const createSisenseContextConnector: (context: CustomSisenseConte
  * @group Contexts
  */
 export declare const SisenseContextProvider: import("vue").DefineComponent<{
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.defaultDataSource}
+     *
+     * @category Sisense App
+     */
     defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.url}
+     *
+     * @category Sisense App
+     */
     url: PropType<string>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
+     *
+     * @category Sisense Authentication
+     */
     ssoEnabled: PropType<boolean | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.token}
+     *
+     * @category Sisense Authentication
+     */
     token: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.wat}
+     *
+     * @category Sisense Authentication
+     */
     wat: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.appConfig}
+     *
+     * @category Sisense App
+     */
     appConfig: PropType<import("@sisense/sdk-ui-preact").AppConfig | undefined>;
     /**
      * @internal
@@ -85,11 +115,41 @@ export declare const SisenseContextProvider: import("vue").DefineComponent<{
 }, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
 }>[] | undefined, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.defaultDataSource}
+     *
+     * @category Sisense App
+     */
     defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.url}
+     *
+     * @category Sisense App
+     */
     url: PropType<string>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
+     *
+     * @category Sisense Authentication
+     */
     ssoEnabled: PropType<boolean | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.token}
+     *
+     * @category Sisense Authentication
+     */
     token: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.wat}
+     *
+     * @category Sisense Authentication
+     */
     wat: PropType<string | undefined>;
+    /**
+     * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.appConfig}
+     *
+     * @category Sisense App
+     */
     appConfig: PropType<import("@sisense/sdk-ui-preact").AppConfig | undefined>;
     /**
      * @internal

package/dist/src/providers/theme-provider.d.ts

@@ -24,6 +24,20 @@ export declare const getThemeContext: () => Ref<{
         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;
+        };
+    };
     aiChat: {
         backgroundColor: string;
         primaryTextColor: string;
@@ -147,6 +161,20 @@ export declare const createThemeContextConnector: (themeSettings?: CompleteTheme
                 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;
+                };
+            };
             aiChat: {
                 backgroundColor: string;
                 primaryTextColor: string;
@@ -267,6 +295,20 @@ export declare const createThemeContextConnector: (themeSettings?: CompleteTheme
                 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;
+                };
+            };
             aiChat: {
                 backgroundColor: string;
                 primaryTextColor: string;

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.15.0",
+  "version": "1.16.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -42,7 +42,7 @@
     "format:check": "prettier --check ."
   },
   "dependencies": {
-    "@sisense/sdk-ui-preact": "^1.15.0",
+    "@sisense/sdk-ui-preact": "^1.16.0",
     "deepmerge": "^4.3.1",
     "lodash": "^4.17.21",
     "vue": "^3.3.2"