@sisense/sdk-ui-vue 1.18.1 → 1.20.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-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/index.d.ts

@@ -1,2 +1,3 @@
 export { SisenseContextProvider, createSisenseContextConnector, getSisenseContext, } from './sisense-context-provider';
 export { ThemeProvider, createThemeContextConnector } from './theme-provider';
+export { PluginsProvider, createPluginsContextConnector } from './plugins-provider';

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

@@ -0,0 +1,33 @@
+import type { Ref } from 'vue';
+import type { CustomPluginsContext } from '@sisense/sdk-ui-preact';
+/**
+ * Gets Plugins context
+ *
+ * @group Contexts
+ */
+export declare const getPluginsContext: () => Ref<{
+    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
+ *
+ * @group Contexts
+ * @internal
+ */
+export declare const createPluginsContextConnector: (context: CustomPluginsContext) => {
+    prepareContext(): Promise<CustomPluginsContext>;
+    renderContextProvider: (contextData: CustomPluginsContext, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
+};
+/**
+ * Provider for working with plugins fetched from an external environment.
+ *
+ * Provides methods for registering, retrieving, and interacting with plugins.
+ *
+ * @internal
+ * @group Contexts
+ */
+export declare const PluginsProvider: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>[] | undefined, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;

package/dist/packages/sdk-ui-vue/src/providers/theme-provider.d.ts

@@ -0,0 +1,97 @@
+import type { PropType, Ref } from 'vue';
+import type { CompleteThemeSettings } from '@sisense/sdk-ui-preact';
+/**
+ * Gets Theme context
+ */
+export declare const getThemeContext: () => Ref<CompleteThemeSettings> | undefined;
+/**
+ * Creates theme context connector
+ * @internal
+ */
+export declare const createThemeContextConnector: (themeSettings?: CompleteThemeSettings) => {
+    prepareContext(): Promise<{
+        themeSettings: CompleteThemeSettings;
+        skipTracking: boolean;
+    }>;
+    renderContextProvider: (contextData: {
+        themeSettings: CompleteThemeSettings;
+        skipTracking?: boolean | undefined;
+    }, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
+};
+/**
+ * Theme provider, which allows you to adjust the look and feel of child components.
+ *
+ * Components not wrapped in a theme provider use the current theme from the connected Fusion instance by default.
+ *
+ * @example
+ * Example of a theme provider, which changes the colors and font of the nested indicator chart:
+ * ```vue
+ * <template>
+ *   <ThemeProvider :theme="customTheme">
+ *     <IndicatorChart .... />
+ *   </ThemeProvider>
+ * </template>
+ *
+ * <script>
+ * import { ref } from 'vue';
+ * import ThemeProvider from './ThemeProvider.vue';
+ *
+ * export default {
+ *   components: { ThemeProvider },
+ *   setup() {
+ *     const customTheme = ref({
+         chart: {
+           backgroundColor: '#333333',
+           textColor: 'orange',
+           secondaryTextColor: 'purple',
+         },
+         typography: {
+           fontFamily: 'impact',
+         },
+ *     });
+ *
+ *     return { customTheme };
+ *   }
+ * };
+ * </script>
+ * ```
+ *
+ * Alternatively, to fetch theme settings based on a theme ID:
+ * ```vue
+ * <template>
+ *   <ThemeProvider :theme="'theme_id_string'">
+ *     <!-- Components that will use the fetched theme settings -->
+ *   </ThemeProvider>
+ * </template>
+ * ```
+ *
+ * Indicator chart with custom theme settings:
+ *
+ * <img src="media://indicator-chart-example-2.png" width="400px" />
+ *
+ *
+ * For comparison, indicator chart with default theme settings:
+ *
+ * <img src="media://indicator-chart-example-1.png" width="400px" />
+ *
+ * @see {@link ThemeSettings} and {@link IndicatorChart}
+ * @param props - Theme provider props
+ * @returns A Theme Provider component * @prop {Object | String} theme - Theme settings object for custom themes or a string identifier to fetch theme settings. When provided as an object, it merges with the default theme settings. When provided as a string, it attempts to fetch theme settings using the provided ID.
+ * @prop {Boolean} skipTracking [internal] - Specifies whether to skip tracking of theme usage. Intended for internal use and debugging purposes.
+ * @group Contexts
+ */
+export declare const ThemeProvider: import("vue").DefineComponent<{
+    theme: PropType<string | import("@sisense/sdk-ui-preact").ThemeSettings | undefined>;
+    /**
+     * @internal
+     */
+    skipTracking: PropType<boolean | undefined>;
+}, () => 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<{
+    theme: PropType<string | import("@sisense/sdk-ui-preact").ThemeSettings | undefined>;
+    /**
+     * @internal
+     */
+    skipTracking: PropType<boolean | undefined>;
+}>>, {}, {}>;

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, 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/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.18.1",
+  "version": "1.20.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.18.1",
+    "@sisense/sdk-ui-preact": "^1.20.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-custom-drilldown.d.ts

@@ -1,121 +0,0 @@
-import type { Attribute, Column } from '@sisense/sdk-data';
-import { type DataPoint, type StyledColumn } from '@sisense/sdk-ui-preact';
-import { type Ref } from 'vue';
-/**
- * @internal
- */
-export declare const useCustomDrilldown: ({ drilldownDimensions, initialDimension, }: {
-    drilldownDimensions: Ref<Attribute[]>;
-    initialDimension: Column | StyledColumn;
-}) => {
-    selectDrilldown: (points: DataPoint[], nextDimension: Attribute) => void;
-    sliceDrilldownSelections: (i: number) => void;
-    clearDrilldownSelections: () => void;
-    drilldownSelections: Ref<{
-        points: ({
-            value?: string | number | undefined;
-            categoryValue?: string | number | undefined;
-            categoryDisplayValue?: string | undefined;
-            seriesValue?: string | number | undefined;
-        } | {
-            x?: string | number | undefined;
-            y?: string | number | undefined;
-            size?: number | undefined;
-            breakByPoint?: string | undefined;
-            breakByColor?: string | undefined;
-        } | {
-            boxMin: number;
-            boxMedian: number;
-            boxMax: number;
-            whiskerMin: number;
-            whiskerMax: number;
-            categoryValue?: string | number | undefined;
-            categoryDisplayValue?: string | undefined;
-        } | {
-            geoName: string;
-            originalValue: number;
-            formattedOriginalValue: string;
-            color?: import("@sisense/sdk-ui-preact").Color | undefined;
-        })[];
-        nextDimension: {
-            readonly expression: string;
-            getSort: () => import("@sisense/sdk-data").Sort;
-            sort: (sort: import("@sisense/sdk-data").Sort) => Attribute;
-            name: string;
-            readonly type: string;
-            readonly description: string;
-            readonly id: string;
-            serializable: () => any;
-            toJSON: () => any;
-            jaql: (nested?: boolean | undefined) => any;
-            skipValidation?: boolean | undefined;
-            composeCode?: string | undefined;
-        };
-    }[]>;
-    availableDrilldowns: import("vue").ComputedRef<Attribute[]>;
-    drilldownDimension: Ref<Attribute | undefined>;
-    drilldownFilters: Ref<{
-        readonly members: any[];
-        excludeMembers: boolean;
-        deactivatedMembers: any[];
-        backgroundFilter?: {
-            readonly guid: string;
-            readonly attribute: {
-                readonly expression: string;
-                getSort: () => import("@sisense/sdk-data").Sort;
-                sort: (sort: import("@sisense/sdk-data").Sort) => Attribute;
-                name: string;
-                readonly type: string;
-                readonly description: string;
-                readonly id: string;
-                serializable: () => any;
-                toJSON: () => any;
-                jaql: (nested?: boolean | undefined) => any;
-                skipValidation?: boolean | undefined;
-                composeCode?: string | undefined;
-            };
-            isScope: boolean;
-            disabled: boolean;
-            locked: boolean;
-            filterJaql: () => any;
-            name: string;
-            readonly type: string;
-            readonly description: string;
-            readonly id: string;
-            serializable: () => any;
-            toJSON: () => any;
-            jaql: (nested?: boolean | undefined) => any;
-            skipValidation?: boolean | undefined;
-            composeCode?: string | undefined;
-        } | undefined;
-        readonly id: string;
-        serializable: () => any;
-        filterJaql: () => any;
-        readonly attribute: {
-            readonly expression: string;
-            getSort: () => import("@sisense/sdk-data").Sort;
-            sort: (sort: import("@sisense/sdk-data").Sort) => Attribute;
-            name: string;
-            readonly type: string;
-            readonly description: string;
-            readonly id: string;
-            serializable: () => any;
-            toJSON: () => any;
-            jaql: (nested?: boolean | undefined) => any;
-            skipValidation?: boolean | undefined;
-            composeCode?: string | undefined;
-        };
-        readonly filterType: string;
-        readonly guid: string;
-        disabled: boolean;
-        locked: boolean;
-        readonly name: string;
-        isScope: boolean;
-        jaql: (nested?: boolean | undefined) => any;
-        readonly description: string;
-        readonly type: string;
-        toJSON: () => any;
-        toString: () => string;
-    }[]>;
-    drilldownFiltersDisplayValues: Ref<string[][]>;
-};