@sisense/sdk-ui-vue 1.33.0 → 2.0.0

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/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';

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 { ContextConnector, SisenseContextProviderProps as SisenseContextProviderPropsPreact } from '@sisense/sdk-ui-preact';
-import { type CustomSisenseContext } from '@sisense/sdk-ui-preact';
+import type { PropType } from 'vue';
+import type { SisenseContextProviderProps as SisenseContextProviderPropsPreact } from '@sisense/sdk-ui-preact';
 /**
  * Configurations and authentication for Sisense Context.
  *
@@ -12,16 +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: () => ContextConnector<CustomSisenseContext>;
 /**
  * Sisense Context Provider Component allowing you to connect to
  * a Sisense instance and provide that context
@@ -80,7 +69,10 @@ export declare const SisenseContextProvider: import("vue").DefineComponent<{
      *
      * @category Sisense App
      */
-    url: PropType<string>;
+    url: {
+        type: PropType<string>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
      *
@@ -112,9 +104,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}
      *
@@ -126,7 +116,10 @@ export declare const SisenseContextProvider: import("vue").DefineComponent<{
      *
      * @category Sisense App
      */
-    url: PropType<string>;
+    url: {
+        type: PropType<string>;
+        required: true;
+    };
     /**
      * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
      *

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,19 +1,10 @@
-import type { PropType, Ref } from 'vue';
-import type { CompleteThemeSettings, ContextConnector, CustomThemeProviderProps, 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: () => ContextConnector<CustomThemeProviderProps['context']>;
 /**
  * Theme provider, which allows you to adjust the look and feel of child components.
  *
@@ -77,7 +68,7 @@ export declare const createThemeContextConnector: () => ContextConnector<CustomT
  * @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
      */
@@ -85,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 } 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';
+export type { ChartType, CartesianChartType, CategoricalChartType, ScatterChartType, IndicatorChartType, BoxplotChartType, ScattermapChartType, AreamapChartType, TableType, AreaSubtype, LineSubtype, PieSubtype, PolarSubtype, StackableSubtype, BoxplotSubtype, WidgetType, CartesianWidgetType, CategoricalWidgetType, TabularWidgetType, 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, 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, TranslationConfig, } from '@sisense/sdk-ui-preact';

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

@@ -62,17 +62,6 @@ export declare const addFilters: (dashboard: DashboardProps, newFilters: Filter[
  * @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}
  *