@sisense/sdk-ui-vue 1.19.0 → 1.21.0

package/dist/{src → packages/sdk-ui-vue/src}/composables/use-get-dashboard-model.d.ts

@@ -18,25 +18,29 @@ import type { GetDashboardModelParams } from '@sisense/sdk-ui-preact';
  * ```vue
  * <template>
  *  <Dashboard
- *    v-if="dashboard"
- *    :title="dashboard.title"
- *    :layout="dashboard.layout"
- *    :widgets="dashboard.widgets"
- *    :filters="dashboard.filters"
- *    :defaultDataSource="dashboard.dataSource"
- *    :widgetFilterOptions="dashboard.widgetFilterOptions"
- *    :styleOptions="dashboard.styleOptions"
+ *    v-if="dashboardProps"
+ *    :title="dashboardProps.title"
+ *    :layoutOptions="dashboardProps.layoutOptions"
+ *    :widgets="dashboardProps.widgets"
+ *    :filters="dashboardProps.filters"
+ *    :defaultDataSource="dashboardProps.dataSource"
+ *    :widgetsOptions="dashboardProps.widgetsOptions"
+ *    :styleOptions="dashboardProps.styleOptions"
  *  />
  * </template>
  *
  * <script setup lang="ts">
- * import { DashboardById, useGetDashboardModel } from '@sisense/sdk-ui-vue';
+ * import { dashboardModelTranslator, useGetDashboardModel } from '@sisense/sdk-ui-vue';
  *
  * const { dashboard } = useGetDashboardModel({
  *  dashboardOid: '6441e728dac1920034bce737',
  *  includeWidgets: true,
  *  includeFilters: true,
  * });
+ *
+ * const dashboardProps = computed(() =>
+ *   dashboard.value ? dashboardModelTranslator.toDashboardProps(dashboard.value) : null,
+ * );
  * </script>
  * ```
  *

package/dist/{src → packages/sdk-ui-vue/src}/composables/use-get-dashboard-models.d.ts

@@ -8,7 +8,7 @@ import type { MaybeRefOrWithRefs } from '../types';
  *
  * **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,
+ * @param 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 → packages/sdk-ui-vue/src}/composables/use-get-widget-model.d.ts

@@ -17,14 +17,14 @@ import type { MaybeRefOrWithRefs } from '../types';
  *
  * ```vue
  * <script setup lang="ts">
- * import { Chart, useGetWidgetModel } from '@sisense/sdk-ui-vue';
+ * import { Chart, useGetWidgetModel, widgetModelTranslator } from '@sisense/sdk-ui-vue';
  * const { data: widget } = useGetWidgetModel({
  *   dashboardOid: 'your_dashboard_oid',
  *   widgetOid: 'your_widget_oid',
  * });
  * </script>
  * <template>
- *   <Chart v-if="widget" v-bind="widget.getChartProps()" />
+ *   <Chart v-if="widget" v-bind="widgetModelTranslator.toChartProps(widget)" />
  * </template>
  * ```
  *

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

@@ -0,0 +1,8 @@
+/**
+ * @internal
+ */
+export declare const usePlugins: () => {
+    pluginMap: Map<string, import("@sisense/sdk-ui").PluginComponent> & Omit<Map<string, import("@sisense/sdk-ui").PluginComponent>, keyof Map<any, any>>;
+    registerPlugin: (pluginType: string, plugin: import("@sisense/sdk-ui").PluginComponent) => void;
+    getPlugin: (pluginType: string) => import("@sisense/sdk-ui").PluginComponent | undefined;
+};

package/dist/{src → packages/sdk-ui-vue/src}/providers/plugins-provider.d.ts

@@ -6,13 +6,9 @@ import type { CustomPluginsContext } from '@sisense/sdk-ui-preact';
  * @group Contexts
  */
 export declare const getPluginsContext: () => Ref<{
-    pluginMap: Map<string, {
-        name: string;
-        component: (props: any) => any;
-        createChartProps: (w: import("@sisense/sdk-ui-preact").WidgetModel, themeSettings: import("@sisense/sdk-ui-preact").CompleteThemeSettings) => {};
-    }> & Omit<Map<string, import("@sisense/sdk-ui-preact").WidgetPlugin>, keyof Map<any, any>>;
-    registerPlugin: (pluginType: string, plugin: import("@sisense/sdk-ui-preact").WidgetPlugin) => void;
-    getPlugin: (pluginType: string) => import("@sisense/sdk-ui-preact").WidgetPlugin | undefined;
+    pluginMap: Map<string, import("@sisense/sdk-ui-preact").PluginComponent> & Omit<Map<string, import("@sisense/sdk-ui-preact").PluginComponent>, keyof Map<any, any>>;
+    registerPlugin: (pluginType: string, plugin: import("@sisense/sdk-ui-preact").PluginComponent) => void;
+    getPlugin: (pluginType: string) => import("@sisense/sdk-ui-preact").PluginComponent | undefined;
 }>;
 /**
  * Creates plugins context connector

package/dist/packages/sdk-ui-vue/src/sdk-ui-core-exports.d.ts

@@ -0,0 +1,5 @@
+export { boxWhiskerProcessResult, widgetModelTranslator, dashboardModelTranslator, } from '@sisense/sdk-ui-preact';
+export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, AreaChartProps, BarChartProps, ChartProps, LineChartProps, ColumnChartProps, FunnelChartProps, PolarChartProps, ScatterChartProps, PieChartProps, TreemapChartProps, SunburstChartProps, IndicatorChartProps, AreaRangeChartProps, MemberFilterTileProps, BasicMemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, RelativeDateFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, PivotTableProps, DrilldownBreadcrumbsProps, BoxplotChartProps, AreamapChartProps, ScattermapChartProps, SisenseContextProviderProps, DashboardWidgetProps, DashboardByIdProps, DashboardProps, WidgetProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, DashboardLayoutOptions, DashboardConfig, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, CriteriaFilterType, Member, FilterVariant, } from '@sisense/sdk-ui-preact';
+import type { ContextMenuProps as ContextMenuPropsPreact, ThemeProviderProps as ThemeProviderPropsPreact } from '@sisense/sdk-ui-preact';
+export type ContextMenuProps = Omit<ContextMenuPropsPreact, 'children'>;
+export type ThemeProviderProps = Omit<ThemeProviderPropsPreact, 'children'>;

package/dist/{src → packages/sdk-ui-vue/src}/setup-helper.d.ts

@@ -2,15 +2,17 @@ import { type Slots } from 'vue';
 export declare function getRawData<T>(data: T): T;
 export declare function toDeepRaw<T>(data: T): T;
 /**
+ * Renders a component without children.
+ *
  * @internal
- * @description This is a helper function to render a component without children.
  */
 export declare const setupHelper: <P, C>(component: C, props: P) => (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
 }>) | null;
 /**
+ * Renders a component with children.
+ *
  * @internal
- * @description This is a helper function to render a component with children.
  */
 export declare const setupHelperWithChildren: <P, C>(component: C, props: P, slots: Slots, contexts?: []) => () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.19.0",
+  "version": "1.21.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.19.0",
+    "@sisense/sdk-ui-preact": "^1.21.0",
     "deepmerge": "^4.3.1",
     "lodash-es": "^4.17.21",
     "vue": "^3.3.2"

package/dist/src/components/dashboard/dashboard.d.ts

@@ -1,95 +0,0 @@
-import type { PropType } from 'vue';
-/**
- * A component used for easily rendering a dashboard.
- *
- * @example
- * Here's how you can use the Dashboard component in a Vue application:
- * ```vue
- * <template>
- *  <Dashboard
- *    v-if="dashboard"
- *    :title="dashboard.title"
- *    :layout="dashboard.layout"
- *    :widgets="dashboard.widgets"
- *    :filters="dashboard.filters"
- *    :defaultDataSource="dashboard.dataSource"
- *    :widgetFilterOptions="dashboard.widgetFilterOptions"
- *    :styleOptions="dashboard.styleOptions"
- *  />
- * </template>
- *
- * <script setup lang="ts">
- * import { DashboardById, useGetDashboardModel } from '@sisense/sdk-ui-vue';
- *
- * const { dashboard } = useGetDashboardModel({
- *  dashboardOid: '6441e728dac1920034bce737',
- *  includeWidgets: true,
- *  includeFilters: true,
- * });
- * </script>
- * ```
- * @group Fusion Embed
- * @fusionEmbed
- * @alpha
- */
-export declare const Dashboard: import("vue").DefineComponent<{
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.title}
-     */
-    title: PropType<string>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.layout}
-     */
-    layout: PropType<import("@sisense/sdk-ui-preact").Layout>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
-     */
-    widgets: PropType<import("@sisense/sdk-ui-preact").WidgetModel[]>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.filters}
-     */
-    filters: PropType<import("@sisense/sdk-data").Filter[]>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.defaultDataSource}
-     */
-    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgetFilterOptions}
-     */
-    widgetFilterOptions: PropType<import("@sisense/sdk-ui-preact").WidgetFilterOptions | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.styleOptions}
-     */
-    styleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardStyleOptions>;
-}, (() => 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<{
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.title}
-     */
-    title: PropType<string>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.layout}
-     */
-    layout: PropType<import("@sisense/sdk-ui-preact").Layout>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgets}
-     */
-    widgets: PropType<import("@sisense/sdk-ui-preact").WidgetModel[]>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.filters}
-     */
-    filters: PropType<import("@sisense/sdk-data").Filter[]>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.defaultDataSource}
-     */
-    defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.widgetFilterOptions}
-     */
-    widgetFilterOptions: PropType<import("@sisense/sdk-ui-preact").WidgetFilterOptions | undefined>;
-    /**
-     * {@inheritDoc @sisense/sdk-ui!DashboardProps.styleOptions}
-     */
-    styleOptions: PropType<import("@sisense/sdk-ui-preact").DashboardStyleOptions>;
-}>>, {}, {}>;

package/dist/src/composables/use-plugins.d.ts

@@ -1,12 +0,0 @@
-/**
- * @internal
- */
-export declare const usePlugins: () => {
-    pluginMap: Map<string, {
-        name: string;
-        component: (props: any) => any;
-        createChartProps: (w: import("@sisense/sdk-ui").WidgetModel, themeSettings: import("@sisense/sdk-ui").CompleteThemeSettings) => {};
-    }> & Omit<Map<string, import("@sisense/sdk-ui").WidgetPlugin>, keyof Map<any, any>>;
-    registerPlugin: (pluginType: string, plugin: import("@sisense/sdk-ui").WidgetPlugin) => void;
-    getPlugin: (pluginType: string) => import("@sisense/sdk-ui").WidgetPlugin | undefined;
-};

package/dist/src/sdk-ui-core-exports.d.ts

@@ -1,5 +0,0 @@
-export { boxWhiskerProcessResult } from '@sisense/sdk-ui-preact';
-export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, AreaChartProps, BarChartProps, ChartProps, LineChartProps, ColumnChartProps, FunnelChartProps, PolarChartProps, ScatterChartProps, PieChartProps, TreemapChartProps, SunburstChartProps, IndicatorChartProps, AreaRangeChartProps, MemberFilterTileProps, BasicMemberFilterTileProps, CriteriaFilterTileProps, DateRangeFilterTileProps, ChartWidgetProps, TableWidgetProps, TableProps, PivotTableProps, DrilldownBreadcrumbsProps, BoxplotChartProps, AreamapChartProps, ScattermapChartProps, SisenseContextProviderProps, DashboardWidgetProps, DashboardByIdProps, DashboardProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, ChartDataOptions, CartesianChartDataOptions, CategoricalChartDataOptions, ScatterChartDataOptions, IndicatorChartDataOptions, BoxplotChartDataOptions, BoxplotChartCustomDataOptions, ScattermapChartDataOptions, AreamapChartDataOptions, TableDataOptions, PivotTableDataOptions, WidgetDataOptions, NumberFormatConfig, DecimalScale, DataColorCondition, ConditionalDataColorOptions, DataColorOptions, RangeDataColorOptions, UniformDataColorOptions, ValueToColorMap, MultiColumnValueToColorMap, SortDirection, BoxWhiskerType, ScattermapLocationLevel, StyledColumn, StyledMeasureColumn, PivotRowsSort, ChartStyleOptions, LineStyleOptions, AreaStyleOptions, StackableStyleOptions, PieStyleOptions, FunnelStyleOptions, PolarStyleOptions, IndicatorStyleOptions, NumericSimpleIndicatorStyleOptions, NumericBarIndicatorStyleOptions, GaugeIndicatorStyleOptions, ScatterStyleOptions, TreemapStyleOptions, SunburstStyleOptions, BoxplotStyleOptions, ScattermapStyleOptions, AreamapStyleOptions, ChartWidgetStyleOptions, WidgetStyleOptions, DashboardWidgetStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, Layout, WidgetFilterOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, CriteriaFilterType, Member, FilterVariant, } from '@sisense/sdk-ui-preact';
-import type { ContextMenuProps as ContextMenuPropsPreact, ThemeProviderProps as ThemeProviderPropsPreact } from '@sisense/sdk-ui-preact';
-export type ContextMenuProps = Omit<ContextMenuPropsPreact, 'children'>;
-export type ThemeProviderProps = Omit<ThemeProviderPropsPreact, 'children'>;