@sisense/sdk-ui-vue 1.32.0 → 1.34.0

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

@@ -93,13 +93,13 @@ export declare const WidgetById: import("vue").DefineComponent<{
      *
      * @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>;
+    onDataPointClick: PropType<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 | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointContextMenu}
      *
      * @category Callbacks
      */
-    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointsSelected}
      *
@@ -192,13 +192,13 @@ export declare const WidgetById: import("vue").DefineComponent<{
      *
      * @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>;
+    onDataPointClick: PropType<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 | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointContextMenu}
      *
      * @category Callbacks
      */
-    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | undefined>;
+    onDataPointContextMenu: PropType<import("@sisense/sdk-ui-preact").DataPointEventHandler | import("@sisense/sdk-ui-preact").ScatterDataPointEventHandler | import("@sisense/sdk-ui-preact").BoxplotDataPointEventHandler | undefined>;
     /**
      * {@inheritDoc @sisense/sdk-ui!WidgetByIdProps.onDataPointsSelected}
      *

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

@@ -1,5 +1,6 @@
 export { useExecuteQuery } from './use-execute-query.js';
 export { useExecuteQueryByWidgetId } from './use-execute-query-by-widget-id.js';
+export { useExecuteCsvQuery } from './use-execute-csv-query.js';
 export { useGetDashboardModel } from './use-get-dashboard-model.js';
 export { useGetDashboardModels } from './use-get-dashboard-models.js';
 export { useGetSharedFormula } from './use-get-shared-formula.js';

package/dist/packages/sdk-ui-vue/src/composables/use-execute-csv-query.d.ts

@@ -0,0 +1,43 @@
+import { type ExecuteCsvQueryParams, type CsvQueryState } from '@sisense/sdk-ui-preact';
+import type { MaybeRefOrWithRefs } from '../types';
+/**
+ * A Vue composable function `useExecuteCsvQuery` that executes a CSV data query.
+
+ * @param {MaybeRefOrWithRefs<ExecuteQueryParams>} params - The parameters for the query, supporting reactive Vue refs.
+ * Includes details such as `dataSource`, `dimensions`, `measures`, `filters`, and more, allowing for comprehensive
+ * query configuration. The `filters` parameter supports dynamic filtering based on user interaction or other application
+ * state changes.
+ *
+ * @example
+ * How to use `useExecuteCsvQuery` within a Vue component:
+ * ```vue
+ * <script setup>
+ * import { ref } from 'vue';
+ * import { useExecuteCsvQuery } from '@sisense/sdk-ui-vue';
+ *
+ * const dataSource = ref('your_data_source_id');
+ * // Set up other query parameters as needed (dimensions, measures, filters, etc.)
+ *
+ * const { data, isLoading, isError, isSuccess, error } = useExecuteCsvQuery({
+ *   dataSource,
+ *   dimensions: [...],
+ *   measures: [...],
+ *   filters: [...],
+ *   config: { asDataStream: false },
+ *   // Additional query parameters
+ * });
+ * </script>
+ * ```
+ *
+ * The composable returns an object with the following reactive properties to manage the query state:
+ * - `data`: The CSV data (string or Blob) returned from the query. It remains `undefined` until the query completes successfully.
+ * - `isLoading`: Indicates if the query is in progress.
+ * - `isError`: Indicates if an error occurred during query execution.
+ * - `isSuccess`: Indicates if the query executed successfully without errors.
+ * - `error`: Contains the error object if an error occurred during the query.
+ *
+ * This composable facilitates integrating Sisense data fetching into Vue applications, enabling developers
+ * to easily manage query states and dynamically adjust query parameters based on application needs.
+ * @group Queries
+ */
+export declare const useExecuteCsvQuery: (params: MaybeRefOrWithRefs<ExecuteCsvQueryParams>) => import("vue").ToRefs<CsvQueryState>;

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

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

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

@@ -1,40 +1,40 @@
 /**
- * A Vue composable function `useTracking` designed to track the usage of hooks within Vue applications
- * using the Sisense SDK. It sends tracking information to the server whenever a specified hook is used,
+ * A Vue composable function `useTracking` designed to track the usage of composables within Vue applications
+ * using the Sisense SDK. It sends tracking information to the server whenever a specified composable is used,
  * helping in the analysis and optimization of application performance and usage patterns. This composable
- * is intended for internal use and aids in monitoring the integration and efficiency of Sisense SDK hooks.
+ * is intended for internal use and aids in monitoring the integration and efficiency of Sisense SDK composables.
  *
- * @param {string} hookName - The name of the hook being tracked. This identifier is used to log the hook
- * event uniquely, facilitating the collection of usage data for specific hooks within the application.
+ * @param {string} composableName - The name of the composable being tracked. This identifier is used to log the composable
+ * event uniquely, facilitating the collection of usage data for specific composables within the application.
  *
  * @example
- * How to use `useTracking` to track the usage of a custom hook:
+ * How to use `useTracking` to track the usage of a custom composable:
  * ```javascript
  * import { useTracking } from '@sisense/sdk-ui-vue';
  *
- * // Example hook that utilizes useTracking for monitoring its usage
- * export const useCustomHook = () => {
- *   const { hasTrackedRef } = useTracking('useCustomHook');
+ * // Example composable that utilizes useTracking for monitoring its usage
+ * export const useCustomComposable = () => {
+ *   const { hasTrackedRef } = useTracking('useCustomComposable');
  *
- *   // Hook implementation...
+ *   // composable implementation...
  *
  *   return {
- *     // Return values of your custom hook
+ *     // Return values of your custom composable
  *   };
  * };
  * ```
  *
  * The composable returns an object containing:
- * - `hasTrackedRef`: A Vue ref that indicates whether the tracking for the hook has been successfully
+ * - `hasTrackedRef`: A Vue ref that indicates whether the tracking for the composable has been successfully
  *   sent to the server. It starts as `false` and is set to `true` once tracking is completed, preventing
  *   duplicate tracking events.
  *
- * This internal utility composable is essential for maintaining insights into the usage of custom hooks
+ * This internal utility composable is essential for maintaining insights into the usage of custom composables
  * within applications leveraging the Sisense SDK, enabling developers and analysts to understand and optimize
- * hook interactions and performance.
+ * composable interactions and performance.
  *
  * @internal
  */
-export declare const useTracking: (hookName: string) => {
+export declare const useTracking: (composableName: string) => {
     hasTrackedRef: import("vue").Ref<boolean>;
 };

package/dist/packages/sdk-ui-vue/src/helpers/context-connectors/index.d.ts

@@ -0,0 +1,3 @@
+export * from './sisense-context-connector';
+export * from './theme-context-connector';
+export * from './plugins-context-connector';

package/dist/packages/sdk-ui-vue/src/helpers/context-connectors/plugins-context-connector.d.ts

@@ -0,0 +1,8 @@
+import type { ContextConnector, CustomPluginsProviderProps } from '@sisense/sdk-ui-preact';
+/**
+ * Creates plugins context connector
+ *
+ * @group Contexts
+ * @internal
+ */
+export declare const createPluginsContextConnector: () => ContextConnector<CustomPluginsProviderProps>;

package/dist/packages/sdk-ui-vue/src/helpers/context-connectors/sisense-context-connector.d.ts

@@ -0,0 +1,6 @@
+import type { ContextConnector, CustomSisenseContextProviderProps } from '@sisense/sdk-ui-preact';
+/**
+ * Creates Sisense context connector
+ * @internal
+ */
+export declare const createSisenseContextConnector: () => ContextConnector<CustomSisenseContextProviderProps>;

package/dist/packages/sdk-ui-vue/src/helpers/context-connectors/theme-context-connector.d.ts

@@ -0,0 +1,6 @@
+import type { ContextConnector, CustomThemeProviderProps } from '@sisense/sdk-ui-preact';
+/**
+ * Creates theme context connector
+ * @internal
+ */
+export declare const createThemeContextConnector: () => ContextConnector<CustomThemeProviderProps>;

package/dist/packages/sdk-ui-vue/src/helpers/setup-helper.d.ts

@@ -0,0 +1,21 @@
+import { type Slots } from 'vue';
+import { type ContextConnector, type AnyComponentFunction } from '@sisense/sdk-ui-preact';
+export declare function createDefaultContextConnectors(): (ContextConnector<import("@sisense/sdk-ui-preact").CustomSisenseContextProviderProps> | ContextConnector<import("@sisense/sdk-ui-preact").CustomThemeProviderProps> | ContextConnector<import("@sisense/sdk-ui-preact").CustomPluginsProviderProps>)[];
+export declare function getRawData<T>(data: T): T;
+export declare function toDeepRaw<T>(data: T): T;
+/**
+ * Renders a component without children.
+ *
+ * @internal
+ */
+export declare const setupHelper: <C extends AnyComponentFunction>(component: C, props: Parameters<C>[0], contextConnectors?: ContextConnector<any>[]) => (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>) | null;
+/**
+ * Renders a component with children.
+ *
+ * @internal
+ */
+export declare const setupHelperWithChildren: <C extends AnyComponentFunction>(component: C, props: Parameters<C>[0], slots: Slots, contextConnectors?: ContextConnector<any>[]) => () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>[];

package/dist/packages/sdk-ui-vue/src/helpers/use-reducer.d.ts

@@ -1,4 +1,4 @@
-import { type Ref } from 'vue';
+import type { Ref } from 'vue';
 type State = Record<string, unknown>;
 type Action = {
     type: string;

package/dist/packages/sdk-ui-vue/src/helpers/use-ref-state.d.ts

@@ -0,0 +1,5 @@
+import { type Ref } from 'vue';
+type AnyObject = Record<string, any>;
+export declare function updateRefObject<T extends AnyObject>(targetRef: Ref<T>, updateObj: Partial<T>): void;
+export declare function useRefState<T>(initialValue?: T): [Ref<T>, (value: T) => void];
+export {};

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

@@ -1,7 +1,7 @@
 export { DrilldownBreadcrumbs, type DrilldownBreadcrumbsProps, } from './components/drilldown-breadcrumbs';
 export * from './components/charts';
 export * from './components/filters';
-export * from './providers';
+export { SisenseContextProvider, type SisenseContextProviderProps, ThemeProvider, type ThemeProviderProps, PluginsProvider, } from './providers';
 export * from './composables';
 export * from './components/context-menu';
 export * from './types';
@@ -10,3 +10,4 @@ export { type DrilldownWidgetProps } from './components/drilldown-widget';
 export * from './sdk-ui-core-exports';
 export * from './components/widgets';
 export * from './components/dashboard';
+export * from './utilities';

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

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

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

@@ -0,0 +1,2 @@
+export * from './plugins-provider';
+export * from './plugins-context';

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

@@ -0,0 +1,10 @@
+import type { InjectionKey, Ref } from 'vue';
+import type { CustomPluginsContext } from '@sisense/sdk-ui-preact';
+export declare const defaultPluginsContext: CustomPluginsContext;
+export declare const pluginsContextKey: InjectionKey<Ref<CustomPluginsContext>>;
+/**
+ * Gets Plugins context
+ *
+ * @group Contexts
+ */
+export declare const getPluginsContext: () => Ref<CustomPluginsContext>;

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

@@ -0,0 +1,11 @@
+/**
+ * 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/sisense-context-provider/index.d.ts

@@ -0,0 +1,2 @@
+export * from './sisense-context-provider';
+export * from './sisense-context';

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

@@ -1,6 +1,5 @@
-import type { PropType, Ref } from 'vue';
+import type { PropType } from 'vue';
 import type { SisenseContextProviderProps as SisenseContextProviderPropsPreact } from '@sisense/sdk-ui-preact';
-import { type CustomSisenseContext } from '@sisense/sdk-ui-preact';
 /**
  * Configurations and authentication for Sisense Context.
  *
@@ -12,19 +11,6 @@ import { type CustomSisenseContext } from '@sisense/sdk-ui-preact';
  */
 export interface SisenseContextProviderProps extends SisenseContextProviderPropsPreact {
 }
-/**
- * Gets Sisense application
- * @internal
- */
-export declare const getSisenseContext: () => Ref<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/sisense-context/sisense-context").SisenseContextPayload>;
-/**
- * Creates Sisense context connector
- * @internal
- */
-export declare const createSisenseContextConnector: (context: CustomSisenseContext) => {
-    prepareContext(): Promise<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/sisense-context/sisense-context").SisenseContextPayload>;
-    renderContextProvider: (contextData: import("@sisense/sdk-ui/dist/packages/sdk-ui/src/sisense-context/sisense-context").SisenseContextPayload | undefined, children: import("preact").VNode<{}>, error?: Error | undefined) => import("preact").VNode<{}>;
-};
 /**
  * Sisense Context Provider Component allowing you to connect to
  * a Sisense instance and provide that context
@@ -115,9 +101,7 @@ export declare const SisenseContextProvider: import("vue").DefineComponent<{
         type: PropType<boolean | undefined>;
         default: boolean;
     };
-}, () => 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<{
+}, () => import("vue/jsx-runtime").JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /**
      * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.defaultDataSource}
      *

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

@@ -0,0 +1,9 @@
+import type { InjectionKey, Ref } from 'vue';
+import type { CustomSisenseContext } from '@sisense/sdk-ui-preact';
+export declare const defaultSisenseContext: CustomSisenseContext;
+export declare const sisenseContextKey: InjectionKey<Ref<import("@sisense/sdk-ui/dist/packages/sdk-ui/src/sisense-context/sisense-context").SisenseContextPayload>>;
+/**
+ * Gets sisense context
+ * @internal
+ */
+export declare const getSisenseContext: () => Ref<CustomSisenseContext>;

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

@@ -0,0 +1,2 @@
+export * from './theme-provider';
+export * from './theme-context';

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

@@ -0,0 +1,7 @@
+import type { InjectionKey, Ref } from 'vue';
+import { type CompleteThemeSettings } from '@sisense/sdk-ui-preact';
+export declare const themeContextConfigKey: InjectionKey<Ref<CompleteThemeSettings>>;
+/**
+ * Gets Theme context
+ */
+export declare const getThemeContext: () => Ref<CompleteThemeSettings>;

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

@@ -1,28 +1,10 @@
-import type { PropType, Ref } from 'vue';
-import type { CompleteThemeSettings, ThemeProviderProps as ThemeProviderPropsPreact } from '@sisense/sdk-ui-preact';
+import type { PropType } from 'vue';
+import type { ThemeProviderProps as ThemeProviderPropsPreact, ThemeSettings } from '@sisense/sdk-ui-preact';
 /**
  * {@inheritDoc @sisense/sdk-ui!ThemeProviderProps}
  */
 export interface ThemeProviderProps extends Omit<ThemeProviderPropsPreact, 'children'> {
 }
-/**
- * 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.
  *
@@ -86,7 +68,7 @@ export declare const createThemeContextConnector: (themeSettings?: CompleteTheme
  * @group Contexts
  */
 export declare const ThemeProvider: import("vue").DefineComponent<{
-    theme: PropType<string | import("@sisense/sdk-ui-preact").ThemeSettings | undefined>;
+    theme: PropType<string | ThemeSettings | undefined>;
     /**
      * @internal
      */
@@ -94,7 +76,7 @@ export declare const ThemeProvider: 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<{
-    theme: PropType<string | import("@sisense/sdk-ui-preact").ThemeSettings | undefined>;
+    theme: PropType<string | ThemeSettings | undefined>;
     /**
      * @internal
      */

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

@@ -1,2 +1,2 @@
-export { boxWhiskerProcessResult, widgetModelTranslator, dashboardModelTranslator, dashboardHelpers, } 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, CommonWidgetProps, WidgetProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, 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, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, DashboardConfig, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, Member, FilterVariant, CriteriaFilterType, } from '@sisense/sdk-ui-preact';
+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, CommonWidgetProps, WidgetProps, ExecuteQueryByWidgetIdParams, ExecuteQueryParams, GetWidgetModelParams, GetSharedFormulaParams, GetDashboardModelParams, UseGetSharedFormulaParams, GetDashboardModelsParams, GetHierarchyModelsParams, 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, WidgetByIdStyleOptions, TableStyleOptions, PivotTableStyleOptions, AreaRangeStyleOptions, DataLimits, Legend, Markers, Labels, IndicatorComponents, ScatterMarkerSize, LineWidth, AxisLabel, Convolution, SeriesLabels, X2Title, ScattermapMarkers, WidgetModel, DashboardModel, BeforeRenderHandler, DataPoint, ScatterDataPoint, HighchartsOptions, BoxplotDataPoint, IndicatorBeforeRenderHandler, IndicatorRenderOptions, DashboardLayoutOptions, WidgetsPanelLayout, WidgetsPanelColumnLayout, WidgetId, WidgetsOptions, AppConfig, DateConfig, MenuItemSection, MonthOfYear, DayOfWeek, DateLevel, ThemeOid, GetDashboardModelOptions, GetDashboardModelsOptions, SeriesChartType, MenuPosition, ThemeSettings, Color, ColorPaletteTheme, Navigator, DrilldownOptions, DrilldownSelection, Member, FilterVariant, CriteriaFilterType, } from '@sisense/sdk-ui-preact';

package/dist/packages/sdk-ui-vue/src/types/dashboard-config.d.ts

@@ -0,0 +1,24 @@
+import type { DashboardConfig as DashboardConfigPreact, DashboardByIdConfig as DashboardByIdConfigPreact, DashboardFiltersPanelConfig as DashboardFiltersPanelConfigPreact } from '@sisense/sdk-ui-preact';
+/**
+ * {@inheritDoc @sisense/sdk-ui!DashboardFiltersPanelConfig}
+ */
+export interface DashboardFiltersPanelConfig extends Omit<DashboardFiltersPanelConfigPreact, 'actions'> {
+}
+/**
+ * {@inheritDoc @sisense/sdk-ui!DashboardConfig}
+ */
+export interface DashboardConfig extends Omit<DashboardConfigPreact, 'filtersPanel'> {
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardConfig.filtersPanel}
+     */
+    filtersPanel?: DashboardFiltersPanelConfig;
+}
+/**
+ * {@inheritDoc @sisense/sdk-ui!DashboardByIdConfig}
+ */
+export interface DashboardByIdConfig extends Omit<DashboardByIdConfigPreact, 'filtersPanel'> {
+    /**
+     * {@inheritDoc @sisense/sdk-ui!DashboardByIdConfig.filtersPanel}
+     */
+    filtersPanel?: DashboardFiltersPanelConfig;
+}

package/dist/packages/sdk-ui-vue/src/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './maybe-ref';
+export * from './dashboard-config';

package/dist/packages/sdk-ui-vue/src/types/maybe-ref.d.ts

@@ -0,0 +1,14 @@
+import type { Ref } from 'vue';
+export type MaybeRef<T> = Ref<T> | T;
+export type MaybeWithRefs<T extends object> = {
+    [Property in keyof T]: MaybeRef<T[Property]>;
+};
+export type MaybeRefOrWithRefs<T extends Object> = MaybeRef<T> | MaybeWithRefs<T>;
+/**
+ * Converts all non-function properties of `T` into Vue refs while keeping function properties specified by `Fns` unchanged.
+ *
+ * @internal
+ */
+export type ToRefsExceptFns<T, Fns extends keyof T> = {
+    [K in keyof Omit<T, Fns>]: Ref<T[K]>;
+} & Pick<T, Fns>;

package/dist/packages/sdk-ui-vue/src/utilities/dashboard-helpers.d.ts

@@ -0,0 +1,105 @@
+import type { Filter, FilterRelations } from '@sisense/sdk-data';
+import type { DashboardProps } from '../components/dashboard';
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.replaceFilters}
+ *
+ * @example
+ * Replace all filters on a dashboard with a new set of filters.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...}
+ * const newFilters: Filter[] = [{...}, {...}, ...];
+ * const updatedDashboard = dashboardHelpers.replaceFilters(existingDashboard, newFilters);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) whose filters are to be replaced.
+ * @param newFilters - An array of new filters or filter relations to set on the dashboard.
+ * @returns A new dashboard instance with the updated filters.
+ */
+export declare const replaceFilters: (dashboard: DashboardProps, newFilters: Filter[] | FilterRelations) => DashboardProps;
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.addFilter}
+ *
+ * @example
+ * Add a new filter to a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const newFilter: Filter = {...};
+ * const updatedDashboard = dashboardHelpers.addFilter(existingDashboard, newFilter);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) to which the filter will be added.
+ * @param newFilter - The filter to add to the dashboard.
+ * @returns A new dashboard instance with the new filter added.
+ */
+export declare const addFilter: (dashboard: DashboardProps, newFilter: Filter) => DashboardProps;
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.addFilters}
+ *
+ * @example
+ * Add multiple new filters to a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const newFilters: Filter[] = [{...}, {...}, ...];
+ * const updatedDashboard = dashboardHelpers.addFilters(existingDashboard, newFilters);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) to which the filters will be added.
+ * @param newFilters - An array of filters to add to the dashboard.
+ * @returns A new dashboard instance with the new filters added.
+ */
+export declare const addFilters: (dashboard: DashboardProps, newFilters: Filter[]) => DashboardProps;
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.replaceFilter}
+ *
+ * @example
+ * Replace a filter in a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const filterToReplace: Filter = {...};
+ * const newFilter: Filter = {...};
+ * const updatedDashboard = dashboardHelpers.replaceFilter(existingDashboard, filterToReplace, newFilter);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) containing the filter to be replaced.
+ * @param filterToReplace - The existing filter to be replaced.
+ * @param newFilter - The new filter to replace the existing one.
+ * @returns A new dashboard instance with the specified filter replaced.
+ */
+export declare const replaceFilter: (dashboard: DashboardProps, filterToReplace: Filter, newFilter: Filter) => DashboardProps;
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.modifyFilter}
+ *
+ * @deprecated Use {@link replaceFilter} instead
+ *
+ * @param dashboard - The original dashboard (`DashboardProps`) containing the filter to modify.
+ * @param filterToModify - The existing filter to be modified.
+ * @param newFilter - The new filter to replace the existing one.
+ * @returns A new dashboard instance with the specified filter modified.
+ */
+export declare const modifyFilter: (dashboard: DashboardProps, filterToModify: Filter, newFilter: Filter) => DashboardProps;
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.removeFilter}
+ *
+ * @example
+ * Remove a filter from a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const filterToRemove: Filter = {...};
+ * const updatedDashboard = dashboardHelpers.removeFilter(existingDashboard, filterToRemove);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) from which to remove the filter.
+ * @param filterToRemove - The filter to be removed.
+ * @returns A new dashboard instance with the specified filter removed.
+ */
+export declare const removeFilter: (dashboard: DashboardProps, filterToRemove: Filter) => DashboardProps;
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers.removeFilters}
+ *
+ * @example
+ * Remove multiple filters from a dashboard.
+ * ```ts
+ * const existingDashboard: DashboardProps = {...};
+ * const filtersToRemove: Filter[] = [{...}, {...}, ...];
+ * const updatedDashboard = dashboardHelpers.removeFilters(existingDashboard, filtersToRemove);
+ * ```
+ * @param dashboard - The original dashboard (`DashboardProps`) from which the specified filters are removed.
+ * @param filtersToRemove - An array of filters to remove.
+ * @returns A new dashboard instance with the specified filters removed.
+ */
+export declare const removeFilters: (dashboard: DashboardProps, filtersToRemove: Filter[]) => DashboardProps;

package/dist/packages/sdk-ui-vue/src/utilities/dashboard-model-translator.d.ts

@@ -0,0 +1,37 @@
+import { type DashboardModel } from '@sisense/sdk-ui-preact';
+import type { DashboardProps } from '../components/dashboard';
+/**
+ * Translates {@link DashboardModel} to {@link DashboardProps}.
+ *
+ * @example
+ * ```vue
+<script setup lang="ts">
+import { dashboardModelTranslator, useGetDashboardModel, Dashboard } from '@sisense/sdk-ui-vue';
+import { computed } from 'vue';
+
+const { dashboard } = useGetDashboardModel({
+  dashboardOid: 'your-dashboard-oid',
+  includeWidgets: true,
+  includeFilters: true,
+});
+
+const dashboardProps = computed(() =>
+  dashboard.value ? dashboardModelTranslator.toDashboardProps(dashboard.value) : null,
+);
+</script>
+
+<template>
+  <Dashboard
+    v-if="dashboardProps"
+    :title="dashboardProps.title"
+    :layoutOptions="dashboardProps.layoutOptions"
+    :widgets="dashboardProps.widgets"
+    :filters="dashboardProps.filters"
+    :defaultDataSource="dashboardProps.defaultDataSource"
+    :widgetsOptions="dashboardProps.widgetsOptions"
+    :styleOptions="dashboardProps.styleOptions"
+  />
+</template>
+ * ```
+ */
+export declare function toDashboardProps(dashboardModel: DashboardModel): DashboardProps;

package/dist/packages/sdk-ui-vue/src/utilities/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardModelTranslator}
+ *
+ * @group Fusion Assets
+ * @fusionEmbed
+ * @shortDescription Utility functions to translate a Fusion dashboard model from and to other dashboard data structures
+ */
+export * as dashboardModelTranslator from './dashboard-model-translator';
+/**
+ * {@inheritDoc @sisense/sdk-ui!dashboardHelpers}
+ *
+ * @group Dashboards
+ * @shortDescription Utility functions to manipulate dashboard elements
+ */
+export * as dashboardHelpers from './dashboard-helpers';
+/**
+ * {@inheritDoc @sisense/sdk-ui!widgetModelTranslator}
+ *
+ * @group Fusion Assets
+ * @fusionEmbed
+ * @shortDescription Utility functions to translate a Fusion widget model from and to other widget data structures
+ */
+export * as widgetModelTranslator from './widget-model-translator';